Sign in

v1

latestOpenAPI 3.0.0MIT2026-08-043290199.3 KB
Batch

Batch listings creation

Create a new batch of listings

post/selling/batch/create-listing

Request body

Example request

{
  "items": [
    {
      "inventoryType": "STANDARD",
      "active": true,
      "quantity": 10,
      "currencyCode": "USD",
      "variantId": "98e2e748-8000-45bf-a624-5531d6a68318",
      "expiresAt": "2021-11-09T12:44:31.000Z",
      "amount": "79"
    }
  ]
}

Response

Ok

batchIdstring required

Unique Batch ID

statusstring required

The status of the batch

completedAtstring nullable required

When the batch fully completed

createdAtstring required

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

updatedAtstring required

When this batch was last updated in UTC. 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": "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"
  }
}