Skip to main content
The Products API lets you manage your entire product catalog programmatically. Use it to sync products from a PIM, build bulk import tools, automate pricing updates, or publish new products to your storefront without touching the admin UI.
Use the expand query parameter to include nested resources — expand=variants,images — and retrieve a full product object in a single request rather than making separate calls.

The Product Object

string
Unique identifier for the product (e.g. prod_01HXYZ999).
string
The product name displayed on the storefront.
string
Full product description. May contain plain text or Markdown.
string
Publication status. One of draft, active, or archived.
string
ISO 8601 timestamp of when the product was created.
array
The purchasable variants of this product (e.g. size/color combinations).
array
Product images attached to this product.

List Products

Retrieve a paginated list of products. Filter by status or collection to narrow results. GET /products
string
Filter by publication status. One of draft, active, archived.
string
Return only products belonging to this collection ID.
string
Comma-separated list of resources to expand inline. Supported values: variants, images.
integer
Number of products per page. Defaults to 20. Maximum is 100.
integer
Page number to retrieve. Defaults to 1.
Response

Get a Product

Retrieve a single product by its ID. Expand variants and images to get the full product detail in one call. GET /products/:id
string
required
The unique ID of the product to retrieve.
string
Comma-separated list of sub-resources to include: variants, images.
Response

Create a Product

Create a new product in your catalog. New products are created with draft status by default and are not visible on the storefront until you set them to active. POST /products
string
required
The product name.
string
Full product description. Plain text or Markdown is accepted.
string
Initial publication status. One of draft, active. Defaults to draft.
array
One or more variant objects to create alongside the product. Each variant must include at least a price.
Response

Update a Product

Update the fields of an existing product. Send only the fields you want to change — all others remain unchanged. PATCH /products/:id
string
required
The unique ID of the product to update.
string
New product title.
string
Updated product description.
string
New publication status. One of draft, active, archived.
Response

Delete a Product

Permanently delete a product and all its variants. This action cannot be undone. Consider setting the product to archived status instead if you want to hide it without losing its data. DELETE /products/:id
string
required
The unique ID of the product to delete.
Response

Error Handling

The Products API uses standard HTTP status codes. All error responses include a JSON body with a code field and a human-readable message.