Skip to main content
PATCH
Update a product

Authorizations

Authorization
string
header
required

An app access token from POST /apps/oauth/token, valid 1 hour. An offline token acts as the app; an online token acts as the app on behalf of one dashboard user (the intersection of both permission sets).

Headers

Idempotency-Key
string

Makes a write safe to retry: the same key with the same method, path, query and body within 24 hours answers the stored result (Idempotent-Replayed: true) without running the write again. Only a successful answer is stored, so a retry after a failure runs. A key reused for a different request is 422 IDEMPOTENCY_KEY_REUSED; one whose first request still runs is 409 IDEMPOTENCY_KEY_IN_USE.

Required string length: 1 - 255
Pattern: ^[\x21-\x7E]+$

Path Parameters

id
string
required

A resource id. One this installation cannot read, or a malformed one, is 404 NOT_FOUND.

Minimum string length: 1

Query Parameters

fields
string

Return only these top-level fields, separated by commas; the id is always kept. The response schema describes the whole resource. An unknown name is 400 INVALID_FIELDS. Fields: id, storeId, name, slug, description, type, active, visible, currency, price, compareAtPrice, sku, barcode, image, images, weightKg, dimensionsCm, tracksInventory, allowOutOfStockOrders, collectionIds, brandId, options, variants, createdAt, updatedAt.

Maximum string length: 1000

Body

application/json
name
string
Required string length: 1 - 255
price
string

A decimal amount as a string, e.g. "2500.00" (at most two decimals).

Pattern: ^(0|[1-9]\d{0,8})(\.\d{1,2})?$
image
string
Required string length: 1 - 2048
description
string | null
Maximum string length: 200000
slug
string
Required string length: 1 - 120
compareAtPrice
string | null

A decimal amount as a string, e.g. "2500.00" (at most two decimals).

Pattern: ^(0|[1-9]\d{0,8})(\.\d{1,2})?$
sku
string | null
Maximum string length: 100
barcode
string | null
Maximum string length: 100
images
string[]
Maximum array length: 50
Required string length: 1 - 2048
weightKg
number | null
Required range: 0 <= x <= 10000
dimensionsCm
object | null
active
boolean
visible
boolean
allowOutOfStockOrders
boolean
brandId
string | null

An id (a string of digits).

Pattern: ^\d{1,24}$
options
object[]
Maximum array length: 3
variants
object[]
Maximum array length: 200

Response

The product as it is now.

data
object
required

A product (API 2026-10).