How to create a product
This guide will walk you through the process of creating and publishing a product, from gathering required metadata to submitting it via the "Upsert Product" endpoint.
Determine available countries and locales
Use the List countries endpoint to get the countries and locales your merchant account has been linked to.
Countries determine:
Where the product will be published.
Which prices must be defined.
Locales determine:
Which languages are available for product descriptions.
Determine product metadata
Before creating a product, gather the necessary information and identifiers from the API.
Find the product category
Use the List Categories endpoint to search available product categories and retrieve the category ID.
Get the required attributes
Once the category is selected:
Call
List Attribute Groupswith thecategory_idto get:Required attributes
Suggested default attributes via
is_defaultAvailable colors
Sizes
Brands
Material groups (e.g. "Lining", "Shell") and materials
Some attribute groups (currently material_group_name in the material composition flow) return is_default: true on attributes that we suggest as defaults for the category. The field is omitted when false.
Creating the product
Drafting the product
Now that you've gathered all the necessary metadata, you're ready to draft your product.
Material compositions
Depending on the product category, you'll need to provide either a textile or non-textile material composition.
The composition is a mapping of:
Cluster (e.g.,
Lining,Shell) frommaterial_group→ to Materials (e.g.,
Cotton,Leather) frommaterial
Textile materials require a
fractionfield for each component.
Example: Lining made of Cotton, Material made of Leather
Putting everything together
Use the Upsert Product endpoint to create or update your product.
Example Payload
Publishing the draft product
After creating or updating a draft, set its status to published. Use Update Product Status (and Publish).
Example Payload
The product then moves to pending_approval. Once approved, it moves through pending_active to active. Products previously approved skip review when republished.
Check the asynchronous request outcome with Get Product Status Update Batch Results.
Last updated
Was this helpful?