Product variants
AI agents: read /llms.txt; add .md to any page URL. This page as Markdown: /reference/product-variants.md. Index of every page and the rules for every call: /llms.txt. Guides and concepts in one file: /llms-full.txt. OpenAPI: /openapi.json.
The size and color combinations of a variant product. Each has its own id, price, stock and sale state (on sale or phased out).
9 operations
- POSTAdd a variant to a product
/Adds one size and color combination to a variant product, returns it, and updates the product'sv1/ api/ store/ {team_slug}/ product/ {hash_id}/ variant size_dataandcolor_data. - GETList a product's variants
/Lists the live variants (size and color combinations) of a variant product, paged.v1/ api/ store/ {team_slug}/ product/ {hash_id}/ variant - GETGet a variant
/Returns one live variant by its id, with its own sale state (v1/ api/ store/ {team_slug}/ product/ {hash_id}/ variant/ {id} phased_out,phased_out_at,phased_out_by). - POSTCheck whether variants can be deleted
/Read-only.v1/ api/ store/ {team_slug}/ product/ {hash_id}/ variant/ delete_check - PUTUpdate a variant
/Changes one variant's price, pricing group prices, weight, supplier code and vendor, and returns it.v1/ api/ store/ {team_slug}/ product/ {hash_id}/ variant/ {id} - POSTPhase out variants (stop selling them)
/Phased-out variants can no longer be added to new sales order or quote lines (422v1/ api/ store/ {team_slug}/ product/ {hash_id}/ variant/ phase_out variant_phased_out). - POSTRename sizes and colors of a product
/Each size or color keeps its id and takes the new label, and a color may take a new hex, on every variant of the product, deleted copies included.v1/ api/ store/ {team_slug}/ product/ {hash_id}/ variant/ rename_options - POSTPut phased-out variants back on sale
/New sales order and quote lines can use them again.v1/ api/ store/ {team_slug}/ product/ {hash_id}/ variant/ resume - DELETEDelete a variant
/Deletes one variant unless it is in use, hides its stock rows and updates the product'sv1/ api/ store/ {team_slug}/ product/ {hash_id}/ variant/ {id} size_dataandcolor_data.