Skip to main content
PATCH
Update Product

Authorization

string
required
Bearer token for authentication. Format: Bearer qwoty_your_token

Path Parameters

string
required
UUID of the product to update

Request Body

string
Product name
string
Product description
boolean
Whether to inherit description from parent product
boolean
Whether to inherit primary image from parent product
string
Internal reference
boolean
Active status
array
Category UUIDs to link to the parent product. Replaces all existing category links.
string
Stock Keeping Unit
number
Number of units per pack
string
Ledger account code
string
External CRM ID
string
External ERP ID
string
External accounting ID
number
Shipping weight
string
Shipping weight unit (kg, lbs)
number
Shipping height
number
Shipping length
number
Shipping width
string
Shipping length unit (cm, in, etc.)
string
Country of origin for shipping
string
HS code for customs
string
UUID of the primary media to associate with this product. Set to null to remove the primary image.
Fields such as api_name are creation-only: they may appear on the resource but cannot be sent in a PATCH body (the API returns 400 with a validation detail if they are).

Examples

Response

boolean
Indicates if the request was successful
object
The updated product object with all fields, including the prices array

Error Responses