Change some fields of a product
Needs the scope products:write
Change only the fields you send. null clears a field you own. The same ownership rules apply as for POST /api/v1/products: a change to dimensionsCm or source3dUrl after modelling has started becomes a change request.
article*stringYour article number.
^[A-Za-z0-9][A-Za-z0-9._\-]{0,63}$application/json- body
Any subset of the product fields. A field left out keeps its value; null clears it.
externalId?|Your system's own id for the item. Stored next to the article number, never instead of it. Left out keeps the value we hold; null clears it; an empty string counts as left out.
gtin?|GTIN-8, 12, 13 or 14. The check digit is validated. Used for GS1 file names.
name?stringThe product name.
1 <= length <= 300category?|Category. Furniture/Chairs is read as category Furniture, subcategory Chairs when you send no subcategory. Left out keeps the value we hold; null clears it; an empty string counts as left out.
subcategory?|Subcategory. Left out keeps the value we hold; null clears it; an empty string counts as left out.
dimensionsCm?|Width, height and depth in centimetres. Decimals are allowed. For a round product, send the diameter as both w and d. Left out keeps the value we hold; null clears it. Once modelling has started, a change waits for our team (change_request).
variants?array<>Variants of the product. Only ever added, never removed.
items <= 50referenceImages?array<>Photos our 3D team models from. Only ever added; a link we fetched before is not fetched again, and a picture we already hold under another link is not stored twice.
items <= 10source3dUrl?|An https link to a 3D or CAD file of the product, if you have one. Our 3D team uses it as a starting point. Left out keeps the value we hold; null clears it; an empty string counts as left out. Once modelling has started, a change waits for our team (change_request).
productLink?|The product's page in your shop. Left out keeps the value we hold; null clears it; an empty string counts as left out.
attributes?|Up to 50 key and value pairs of your own, such as a collection or a season. Available as tokens in file names.
releaseAt?|Keeps the product's files private until this time. Until then its links are signed and expire hourly; from then on they are permanent.
active?booleanfalse marks the product as discontinued in your system. We record it; nothing already made is removed. true brings it back. Leave it out to keep the value we hold.
OK
application/json- response
articleId*string|nullresult*string"created""updated""unchanged""change_request""exists_delivered""refused"status?stringWhere the product is. Build your logic on this value.
"received""in_production""in_review""approved""delivered""cancelled"statusDetail?stringorderId?stringThe order (intake batch) the product landed in. From slice S4.
uuidpendingChanges?array<>|Changes held for our production team (result change_request).
variantsCreated?array<string>Variant article numbers that became their own products.
warnings?array<string>For example a reference image we could not fetch. The product itself was saved.
error?Only when result is refused.
curl -sS -X PATCH https://platform.charpstar.co/api/v1/products/CH-1001 \ -H "Authorization: Bearer $CHARPSTAR_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "name": "Oslo lounge chair, oak", "productLink": null }'{ "articleId": "CH-1001", "result": "updated", "status": "in_production", "orderId": "4d3c2b1a-0000-4000-8000-000000000011"}Read one product GET
The product as we hold it: your fields, its status, the order it belongs to, and any change waiting for our production team.
Cancel a product before modelling starts POST
Stop a product before modelling starts. Its status becomes cancelled, it leaves our production queue, and status.changed is sent. A product that has started answers 409 not_cancellable; talk to your CharpstAR contact instead.