Sign in
Batch

Batch listings creation - Get Batch Status

Once you are able to create a batch successfully, you need to poll the get batch status API to track the progress of the batch. This polling is necessary because all batch operations are asynchronous in nature.

get/selling/batch/create-listing/{batchId}

Path parameters

batchIdstring required

Unique Batch ID

Response

Ok

batchIdstring required

Stringified UUIDv4. See RFC 4112

statusstring required

The status of this batch

completedAtstring nullable required

When this batch fully completed. Represented as ISO 8601 format like 2021-11-09T12:44:31.000Z

createdAtstring required

When this batch was created. Represented as ISO 8601 format like 2021-11-09T12:44:31.000Z

updatedAtstring required

When this batch was last updated. Represented as ISO 8601 format like 2021-11-09T12:44:31.000Z

totalItemsnumber double required

Total number of items in this batch

itemStatusesBatchStatusCounts required

The number of items in this batch grouped by their statuses. This is a short-hand way to quickly introspect how many items are still enqued, how many succeeded or how many failed in a batch.

Example response

{
  "batchId": "bf364c53-eb77-4522-955c-6a6ce952cc6f",
  "status": "QUEUED",
  "completedAt": "2021-11-09T12:44:31.000Z",
  "createdAt": "2021-11-09T12:44:31.000Z",
  "updatedAt": "2021-11-09T12:44:31.000Z",
  "totalItems": 10,
  "itemStatuses": {
    "queued": "20",
    "failed": "1"
  }
}

Changes

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