Get all listings

Documentation

Support

Get all listings

Get all listings API allows you to fetch all existing listings. Multiple filters are available.

Request

Security:

api_keyjwt

query Parameters

pageNumber	integer <int32> >= 1 Requested page number. By default the page number starts at 1 Example: pageNumber=1
pageSize	integer <int32> [ 1 .. 100 ] The number of listings to return. By default the page size starts at 1. Example: pageSize=100
productIds	string Comma separated list of ids. This field must not include array brackets `[]` or quotation marks (" " \| ' ').
variantIds	string Comma separated list of ids. This field must not include array brackets `[]` or quotation marks (" " \| ' ').
batchIds	string Comma separated list of ids. This field must not include array brackets `[]` or quotation marks (" " \| ' ').
fromDate	string Start date of the query Example: fromDate=2022-06-08
toDate	string End date of the query Example: toDate=2022-06-08
listingStatuses	string Comma separated list of listing statuses. This field must not include array brackets `[]` or quotation marks ("" \| ''). Available values: "INACTIVE", "ACTIVE", "DELETED", "CANCELED", "MATCHED", "COMPLETED" Example: listingStatuses=ACTIVE
inventoryTypes	string Comma separated list of inventory types. This field must not include array brackets `[]` or quotation marks ("" \| ''). Example: inventoryTypes=STANDARD

Responses

200

400

Bad Request

401

Unauthorized

500

Internal Server Error

get/selling/listings

Request samples

curl
JavaScript
Node.js

curl -i -X GET \
  'https://api.stockx.com/v2/selling/listings?pageNumber=1&pageSize=1&productIds=string&variantIds=string&batchIds=string&fromDate=string&toDate=string&listingStatuses=string&inventoryTypes=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Response samples

application/json

{"count": 266,
"pageSize": 10,
"pageNumber": 1,
"hasNextPage": true,
"listings": [{"listingId": "98e2e748-8000-45bf-a624-5531d6a68318",
"status": "ACTIVE",
"amount": "300",
"currencyCode": "AUD",
"inventoryType": "STANDARD",
"createdAt": "2021-11-09T12:44:31.000Z",
"updatedAt": "2021-11-09T12:44:31.000Z",
"batch": {"batchId": "86378f62-ad0e-4a06-9c8e-642731bb9140",
"taskId": "7083634e-3bc5-4747-a4f3-768093074b5e"
},
"ask": {"askId": "string",
"askCreatedAt": "2021-11-09T12:44:31.000Z",
"askUpdatedAt": "2021-11-09T12:44:31.000Z",
"askExpiresAt": "2021-11-09T12:44:31.000Z"
},
"order": {"orderNumber": "323314425-323214184",
"orderCreatedAt": "2021-11-09T12:44:31.000Z",
"orderStatus": "CREATED"
},
"product": {"productId": "bf364c53-eb77-4522-955c-6a6ce952cc6f",
"productName": "Nike Air"
},
"variant": {"variantId": "bf364c53-eb77-4522-955c-6a6ce952cc6f",
"variantName": "color",
"variantValue": "black"
}
}
]
}