Read and change products
List and read the products we hold for you, change some of their fields, cancel one before modelling starts, and check how much of your range has 3D.
These calls work on products you have already sent, or that were ordered in your CharpstAR account. Each product is addressed by its article number.
List your products
GET/api/v1/productsproducts:readThis returns your products as we hold them, newest first, with their status and order: the products you sent or ordered, and the models we delivered to you by other ways. Filter by status, by whether a model exists (has3d), by category, or by changes since a time (since).
limit sets the items per page, from 1 to 100; the default is the same. While nextCursor is not null, call again with cursor set to it.
With since, the list is oldest change first, like the asset feed, and its cursor is that feed's. A change is any field, a cancel or a delivery.
curl -sS "https://platform.charpstar.co/api/v1/products?status=received&limit=50" \
-H "Authorization: Bearer $CHARPSTAR_API_KEY"Read one product
GET/api/v1/products/{article}products:readThis returns the product as we hold it: your fields, its status, the order it belongs to, and any change waiting for our production team. The reference page lists every field.
curl -sS https://platform.charpstar.co/api/v1/products/CH-1001 \
-H "Authorization: Bearer $CHARPSTAR_API_KEY"Change some fields of a product
PATCH/api/v1/products/{article}products:writeThis changes only the fields you send. null clears a field you own. The same ownership rules apply as for sending products: a change to dimensionsCm or source3dUrl after modelling has started becomes a change request. See Product data rules.
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 }'Cancel a product before modelling starts
POST/api/v1/products/{article}/cancelproducts:writeThis stops 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.
curl -sS -X POST https://platform.charpstar.co/api/v1/products/CH-1001/cancel \
-H "Authorization: Bearer $CHARPSTAR_API_KEY"See how much of your range has 3D
GET/api/v1/coverageproducts:readThis returns how much of your range has a 3D model: counts in total and per category, and the article numbers without one. The answer has:
total,with3d(products with a delivered model),inProduction(products being made, in review or approved) andwithout3d(products we hold that have no model and no order in progress);byCategory, the same counts for each category;missing, the article numbers without a model, up to 500. UseGET /api/v1/products?has3d=falsefor all of them.
curl -sS https://platform.charpstar.co/api/v1/coverage \
-H "Authorization: Bearer $CHARPSTAR_API_KEY"