STstockx
Batch

Batch listings update - 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/update-listing/{batchId}

Request

  • Base URL
    https://api.stockx.com/v2
  • Auth
    API key in header x-api-key and HTTP bearer

Path parameters

batchIdstring required

Unique Batch ID

Response

Ok

batchIdstring required

Unique Batch ID

statusstring required

The status of the batch

completedAtstring nullable required

When this batch was completed in UTC. Represented as ISO 8601 format like 2022-01-18T20:20:39Z

createdAtstring required

When this batch was created in UTC. Represented as ISO 8601 format like 2022-01-18T20:20:39Z

updatedAtstring required

When this batch was updated in UTC. Represented as ISO 8601 format like 2022-01-18T20:20:39Z

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": "98e2e748-8000-45bf-a624-5531d6a68318",
  "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 operation across all 2 revisions of this API.