CHcheckout
Inventory

Get an ingestion job's results

Returns the per-item results report for a terminal ingestion job. By default only the rejected rows are listed, so you can fix and re-submit them; pass include=all to list every row. Returns 409 results_not_ready until the job is terminal.

Requires the agentic:inventory scope. A job owned by another merchant returns 404.

get/inventory/ingestions/{id}/results

Request

Path parameters

idstring required

The ingestion identifier.

Query parameters

include'all'

Set to all to include accepted items as well as rejected ones. Defaults to rejected only.

Response

The per-item results report.

ingestion_idstring

The ingestion identifier the report belongs to.

Example response

{
  "ingestion_id": "ing_01hzy8q2m4n6p8r0s2t4v6w8x0",
  "counts": {
    "received": 500,
    "accepted": 498,
    "rejected": 2
  },
  "items": [
    {
      "index": 1,
      "variant_id": "var_123",
      "status": "rejected",
      "error_codes": [
        "on_hand_negative"
      ]
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.