Skip to content
ShopentlyLearn

Variants and options

Maintain product variants and the option dictionaries they use.

Operations

GETList product variants/api/v1/products/{product_id}/variants

POSTCreate a product variant/api/v1/products/{product_id}/variants

DELETEDelete a product variant/api/v1/products/{product_id}/variants/{variant_id}

GETGet a product variant/api/v1/products/{product_id}/variants/{variant_id}

PATCHUpdate a product variant/api/v1/products/{product_id}/variants/{variant_id}

GETList variant options/api/v1/variant-options

POSTCreate a variant option/api/v1/variant-options

DELETEDelete a variant option/api/v1/variant-options/{identity}

GETGet a variant option/api/v1/variant-options/{identity}

PATCHUpdate a variant option/api/v1/variant-options/{identity}

GETList variant option values/api/v1/variant-options/{identity}/values

POSTCreate a variant option value/api/v1/variant-options/{identity}/values

DELETEDelete a variant option value/api/v1/variant-options/{identity}/values/{value_id}

GETGet a variant option value/api/v1/variant-options/{identity}/values/{value_id}

PATCHUpdate a variant option value/api/v1/variant-options/{identity}/values/{value_id}

How it works

A variant belongs to a product and uses values from the variant-option dictionaries. The reference includes option and value CRUD as well as product-variant reads and writes.

Variant price changes use the explicit pricing kind, amount, currency and required versions. Distinguish a base adjustment from a fixed market price. Read current product and price state before submitting a dependent update.

Examples

Guides

How to change a product variant SKU