The result of every row
Needs the scope products:read
One line per product, NDJSON, with the same fields as a POST /api/v1/products result plus the row number. Available once the import has finished.
importId*stringThe import id.
uuidapplication/x-ndjson, one ImportResultLine per line
application/x-ndjson- 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.
row*integerThe line number in the file, counting from 1.
httpStatus*integercurl -sS https://platform.charpstar.co/api/v1/imports/$IMPORT_ID/results \ -H "Authorization: Bearer $CHARPSTAR_API_KEY"{ "articleId": "string", "result": "created", "status": "received", "statusDetail": "waiting_for_information", "orderId": "b3e1eced-f2bd-4d8c-9765-fbc9d1d222d5", "pendingChanges": [ { "field": "dimensionsCm", "from": null, "to": null, "requestedAt": "2019-08-24T14:15:22Z" } ], "variantsCreated": [ "string" ], "warnings": [ "string" ], "error": { "code": "validation_failed", "message": "string", "details": { "property1": null, "property2": null } }, "row": 0, "httpStatus": 0}How an import is going GET
Its status, how many rows it has processed and a count for each result.
Read one article GET
Everything we deliver for one article: its status, the 3D files, the viewer and AR links, the embed snippet, images and variants. Links are null until the product is delivered. glbUrl and usdzUrl never change for an article; when a model is updated the file behind them changes, and the CDN serves ETag and Last-Modified so you can tell.