Products

Returns a paginated list of products. Soft-deleted products are never returned. Each item includes variantsCount, totalInventory, primaryImage (its gallery's first image), and variants array.

Creates a product. SKU rules: simple products (hasVariants=false, the default) must include sku. Variant products (hasVariants=true) must omit sku here — set it on each variant instead. Returns the full product record including empty variants and images arrays.

Returns all images for a product ordered by position.

Attaches an uploaded image to a product by its Media Key. Upload it first: POST /api/media/uploads, send the file as the ticket says, then POST /api/media/uploads/{id}/complete.

Sets the display order of a product's images. Send the complete ordered array of image IDs — every existing image ID must be included exactly once. The server assigns position 1, 2, 3… based on the array order. Returns the full reordered image list.

Removes the image from the product; its file is deleted once nothing else shows it. Variants that showed the image are left without one.

Dedicated endpoint for status-only updates. Setting ACTIVE auto-sets publishedAt.

Returns full product detail including category, variants, and images.

Partial update — only include fields you want to change. Setting status to ACTIVE auto-sets publishedAt. Send variantOptions: null to clear all variant options when converting a variant product to simple.

Removes the product for good — even one that orders hold — and frees its handle and SKU. Its variants, images, reviews, stock history, offers and landing pages go with it, and its image files once nothing else shows them. Order lines that sold it keep what was sold (name, variant label, SKU, price) and lose only the link; orders a landing page of it brought lose only that attribution. GET /products/{id}/removal says all of it beforehand.

What DELETE /products/{id} would take with it and what stays — read before asking the merchant to confirm.

Returns variants ordered by position, with parsed variations objects.

Partial update — only include fields you want to change.

Permanently deletes the variant. Any order line items referencing this variant will have their variantId set to null — order history is fully preserved.

The translatable fields in the store's primary language and every stored translation, each flagged outdated when its source text changed after it was written.

A JSON Merge Patch (RFC 7396) of one language: a string sets a field, null removes its translation, other fields are untouched. The language must be one the store has added, and not its primary — the resource's own fields hold that.