productImports

Requires permission products:import:read.

Imports for the org, most recent first. limit/offset take one page; the history list reads productImportsCount for its pager.

Errors: a failed call returns a GraphQL errors entry, not a field on the result, and data may be null or partial. Read the entry's extensions.code and message; every shape and code is in the Error reference.

Example:

GraphQL

query ProductImports {
  productImports {
    id
    status
    createdAt
    chunkCheckpoint
    createCount
    errorRows
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query ProductImports {\n  productImports {\n    id\n    status\n    createdAt\n    chunkCheckpoint\n    createCount\n    errorRows\n  }\n}"
}
EOF

Response:

{
  "data": {
    "productImports": [
      {
        "id": "string",
        "status": "COMMITTING",
        "createdAt": "2025-01-15T00:00:00Z",
        "chunkCheckpoint": 0,
        "createCount": 0,
        "errorRows": 0
      }
    ]
  }
}

productImports(
  limit: Int
  offset: Int
): [ProductImportEntity!]!

Arguments

productImports.limit ● Int scalar

Maximum number of records to return.

productImports.offset ● Int scalar

Number of records to skip before the first one returned.

Type

ProductImportEntity object

A product import and how far it has got.