Skip to Content

How an import is going

Needs the scope products:read

Its status, how many rows it has processed and a count for each result.

Path Parameters

importId*string

The import id.

Formatuuid

Response Body

OK

application/json
  1. response
id*string
Formatuuid
status*string
Value in"queued""running""completed""failed"
dryRun*boolean
orderId*|

The order the imported products landed in (null for a dry run).

rows*|

Rows in the file, once read.

processed*integer
counts*

How many rows ended in each result so far.

error*|

Why the import failed, when it did.

createdAt*string
Formatdate-time
finishedAt*|null
Example Request
curl -sS https://platform.charpstar.co/api/v1/imports/$IMPORT_ID \  -H "Authorization: Bearer $CHARPSTAR_API_KEY"
Example Response
{  "id": "7a6b5c4d-0000-4000-8000-000000000022",  "status": "running",  "dryRun": false,  "orderId": "4d3c2b1a-0000-4000-8000-000000000011",  "rows": 1200,  "processed": 350,  "counts": {    "created": 300,    "updated": 40,    "unchanged": 8,    "change_request": 0,    "exists_delivered": 0,    "refused": 2  },  "error": null,  "createdAt": "2026-10-20T09:31:00.000Z",  "finishedAt": null}