CHcheckout
Inventory

Get an ingestion job

Returns an ingestion job and its current state and counts. Poll this until state is either:

  • completed
  • completed_with_errors, or
  • failed

Then read the per-item report at /inventory/ingestions/{id}/results.

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

get/inventory/ingestions/{id}

Request

Path parameters

idstring required

The ingestion identifier.

Response

The ingestion job.

idstring

The ingestion identifier, in the ing_{base32-encoded GUID} format.

state'awaiting_upload' | 'accepted' | 'processing' | 'completed' | 'completed_with_errors' | 'failed'

The current state of the job. awaiting_upload is only used by the CSV flow, between requesting an upload slot and starting processing. completed, completed_with_errors and failed are terminal.

mode'upsert'

The update semantics for the batch. Only upsert is available in this version.

upload_urlstring

A short-lived, PUT-only presigned URL to upload the CSV file to. Present only on the response to a CSV upload-slot request.

created_onstring date-time

The date and time the job was created.

modified_onstring date-time

The date and time the job was last updated.

Example response

{
  "id": "ing_01hzy8q2m4n6p8r0s2t4v6w8x0",
  "state": "accepted",
  "mode": "upsert",
  "counts": {
    "received": 500,
    "accepted": 498,
    "rejected": 2
  },
  "failure_reason": {
    "code": "file_unreadable",
    "message": "The uploaded file could not be read as CSV."
  },
  "upload_url": "https://inventory-ingestions.s3.eu-west-1.amazonaws.com/ingestions/mer_1/ing_.../payload.csv?X-Amz-Signature=...",
  "created_on": "2026-09-24T15:04:05.0000000+00:00",
  "modified_on": "2026-09-24T15:04:11.0000000+00:00",
  "_links": {
    "self": {
      "href": "https://api.checkout.com/inventory/var_123",
      "actions": [
        "GET"
      ],
      "types": [
        "application/json"
      ]
    },
    "results": {
      "href": "https://api.checkout.com/inventory/var_123",
      "actions": [
        "GET"
      ],
      "types": [
        "application/json"
      ]
    },
    "start": {
      "href": "https://api.checkout.com/inventory/var_123",
      "actions": [
        "GET"
      ],
      "types": [
        "application/json"
      ]
    }
  }
}

Changes

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