Products

Products

Products

Images of the product

Product options

Option values

Product variants

List all products

GET /api/v1/products

Query parameters

NameTypeDescription
limitintegerDefault: 1000
offsetintegerDefault: 0
category_idstring-
idsstringComma-separated list of product ids
skustringComma-separated list of product SKU
on_saleboolean-
stock_statusstringavailable, out_of_stock, preorder, backorder, discontinued
price_fromfloat-
price_tofloat-
tagsstringComma-separated list of product tags
attributes.<name>stringExample: attributes.color=white
enabledboolean-
discontinuedboolean-
fieldsstringComma-separated list of fields. Example id,parent_id,name

Create a product

POST /api/v1/products

Request body

NameTypeDescription
namestring-
descriptionstring-
meta_descriptionstring-
meta_titlestring-
tagsarray of string-
attributesarray of object-
enabledboolean-
discontinuedboolean-
slugstring-
skustring-
codestring-
tax_classstring-
related_product_idsarray of string-
pricesarray-
cost_pricefloat-
regular_pricefloat-
sale_pricefloat-
quantity_incinteger-
quantity_mininteger-
weightfloat-
stock_quantityinteger-
positioninteger-
date_stock_expecteddate-
date_sale_fromdate-
date_sale_todate-
stock_trackingboolean-
stock_preorderboolean-
stock_backorderboolean-
category_idstring-
dimensionsobjectProperties: 'length', 'width', 'height'

Retrieve a product

GET /api/v1/products/{product_id}

Update a product

PUT /api/v1/products/{product_id}

Delete a product

DELETE /api/v1/products/{product_id}

List all images of the product

GET /api/v1/products/{product_id}/images

Upload images to the product

POST /api/v1/products/{product_id}/images

Update an image

PUT /api/v1/products/{product_id}/images/{image_id}

Delete an image

DELETE /api/v1/products/{product_id}/images/{image_id}

List all product options

GET /api/v1/products/{product_id}/options

Retrieve an option

GET /api/v1/products/{product_id}/options/{option_id}

Create an option

POST /api/v1/products/{product_id}/options

Update an option

PUT /api/v1/products/{product_id}/options/{option_id}

Delete an option

DELETE /api/v1/products/{product_id}/options/{option_id}

List all values of the product option

GET /api/v1/products/{product_id}/options/{option_id}/values

Retrieve a value

GET /api/v1/products/{product_id}/options/{option_id}/values/{value_id}

Create a value

POST /api/v1/products/{product_id}/options/{option_id}/values

Update a value

PUT /api/v1/products/{product_id}/options/{option_id}/values/{value_id}

Delete a value

DELETE /api/v1/products/{product_id}/options/{option_id}/values/{value_id}

List all product variants

GET /api/v1/products/{product_id}/variants

Create a variant

POST /api/v1/products/{product_id}/variants

Update a variant

PUT /api/v1/products/{product_id}/variants/{variant_id}

Delete a variant

DELETE /api/v1/products/{product_id}/variants/{variant_id}

Set an option value to the product variant

PUT /api/v1/products/{product_id}/variants/{variant_id}/options