Skip to Content

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.

Path Parameters

importId*string

The import id.

Formatuuid

Response Body

application/x-ndjson, one ImportResultLine per line

application/x-ndjson
  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.

row*integer

The line number in the file, counting from 1.

httpStatus*integer
Example Request
curl -sS https://platform.charpstar.co/api/v1/imports/$IMPORT_ID/results \  -H "Authorization: Bearer $CHARPSTAR_API_KEY"
Example Response
{  "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}