Products
This section covers all the endpoints for working with products.
IDs and SKUs
Product SKUs and Variant SKUs are the unique identifiers for products and variants generated by the merchant himself.
-
Each Product SKU must be unique among all merchant’s Product SKUs.
-
Each Variant SKU must be unique among all merchant’s Variant SKUs.
-
A Product SKU may coincide with a Variant SKU.
Example: if there is just one variant in a product, you may want to give them similar SKUs.
Joom Product IDs and Joom Variant IDs are the unique identifiers of products and variants generated by Joom. (They are shown to you just for information.)
All the actions with products and variants can be performed by using SKUs only. But you may prefer to use Joom IDs, it’s up to you.
Please note:
Joom Store IDs are also important.
You must specify a Joom Store ID when creating a new product.
Product States
Each product exists in two versions: current version reflecting the most recent changes (a kind of a draft) and approved (published) version. Only the published version may be visible to customers.
The field hasActiveVersion reflects whether the product has a version that is currently available to customers. The field state reflects the state of the current version.
| State | Meaning |
|---|---|
| active | This version of the product is approved and active (available to customers). |
| warning | This version of the product is active, but may require merchant’s attention. |
| pending | This version of the product is not active, it is awaiting verification from Joom. No action from the merchant is required. An older approved version might be active. |
| rejected | This version of the product is not active. The merchant is expected to fix the problems. An older approved version might be active. |
| disabledByJoom | The product is completely disabled by Joom and is not available to customers. This happens when the product’s store is disabled by Joom. |
| disabledByMerchant | The product is completely disabled by the merchant and is not available to customers. This also happens when the product’s store is disabled by the merchant. |
| locked | All changes to the product will be postponed until it is unlocked. This happens when the product participates in a promotion. An older approved version might be active. |
| archived | The product is removed. Normally, removed products are not visible to merchants, but due to technical delays they may still appear in the API, so you’re advised to support this state. Products in this state may be ignored as non-existing. |
Overview of Endpoints
In basic scenarios using this API documentation merchants are able to:
- create and update their products
- retrieve specific products by Joom ID or merchant’s SKU
- retrieve batches of products by update timestamp.
- There are also advanced operations, like removing products and removing variants.
- Some ERPs are presenting the lists of Joom colors and categories to their users, there are endpoints for these cases as well.
Learn more details on Product Requirements and Category Product Requirements in Joom Help Center.