Get historical orders

Documentation

Support

Get historical orders

Get all historical orders. Multiple filters are available.

Request

Security:

api_keyjwt

query Parameters

fromDate	string The start date of when the orders were created. Format is YYYY-MM-DD.
toDate	string The end date of when the orders were created. Format is YYYY-MM-DD.
pageNumber	integer <int32> >= 1 The requested page number. By default the page number is 1 Example: pageNumber=1
pageSize	integer <int32> [ 1 .. 100 ] The number of orders to be returned. By default the number is 10 Example: pageSize=100
orderStatus	string To filter your Orders by a given order status Available values: "AUTHFAILED", "DIDNOTSHIP", "CANCELED", "COMPLETED", "RETURNED" Example: orderStatus=CANCELED
productId	string Unique StockX product ID
variantId	string Unique StockX variant ID

Responses

200

400

Bad Request

401

Unauthorized

500

Internal Server Error

get/selling/orders/history

Request samples

curl
JavaScript
Node.js

curl -i -X GET \
  'https://api.stockx.com/v2/selling/orders/history?fromDate=string&toDate=string&pageNumber=1&pageSize=1&orderStatus=string&productId=string&variantId=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,
"orders": [{"orderNumber": "323314425-323214184",
"listingId": "35d76ac8-a112-4d75-b44f-c8ef04a87c93",
"askId": "13658831621304650018",
"amount": "140",
"currencyCode": "USD",
"status": "CREATED",
"createdAt": "2021-08-25T13:51:47.000Z",
"updatedAt": "2021-08-25T13:51:47.000Z",
"product": {"productId": "bf364c53-eb77-4522-955c-6a6ce952cc6f",
"productName": "Gucci Duchessa Boston Bag"
},
"variant": {"variantId": "string",
"variantName": "Auston-Matthews-2016-Upper-Deck-Series-1-Young-Guns-Rookie-201:0",
"variantValue": "PSA 10"
}
}
]
}