Skip to Content

Create or update products

Needs the scope products:write

Create or update products by article number: one product, or { products: [...] } with up to 50.

  • A new article lands in our production team's intake and in your open order.
  • A known article is updated by the ownership rules. Before modelling starts, every field you own is applied. After that, name, category, links, attributes and active still update, and a change to dimensionsCm or source3dUrl becomes a change request.
  • A field you leave out keeps its value.
  • Sending the same product again is safe: it answers unchanged and writes nothing.

Request Body

application/json
  1. body

One product.

articleId*string

Your article number: the same one you use in your shop and on your product page. 1 to 64 characters: letters, digits, '.', '_' and '-', starting with a letter or digit. No spaces or slashes: it becomes the file name of your model and the data-articleid on your page. Unique within your account.

Match^[A-Za-z0-9][A-Za-z0-9._\-]{0,63}$
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.

source?string

Where the product comes from. Leave it out (it is api), unless your CharpstAR contact gives you another value.

Default"api"
Value in"dynamics365""akeneo""api"
name*string

The product name.

Length1 <= length <= 300
category?|

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.

referenceImages?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.

source3dUrl?|

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.

active?|

false 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.

gtin?|

GTIN-8, 12, 13 or 14. The check digit is validated. Used for GS1 file names.

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.

Response Body

OK

application/json
  1. response
articleId*string|null
result*string
Value in"created""updated""unchanged""change_request""exists_delivered""refused"
status?string

Where the product is. Build your logic on this value.

Value in"received""in_production""in_review""approved""delivered""cancelled"
statusDetail?string
orderId?string

The order (intake batch) the product landed in. From slice S4.

Formatuuid
pendingChanges?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.

Example Request
curl -sS https://platform.charpstar.co/api/v1/products \  -H "Authorization: Bearer $CHARPSTAR_API_KEY" \  -H "Content-Type: application/json" \  -d '{ "products": [    { "articleId": "CH-1001", "name": "Oslo lounge chair" },    { "articleId": "CH-1002", "name": "Oslo side table" }  ] }'
Example Response
{  "articleId": "CH-1001",  "result": "unchanged",  "status": "received"}