Get active orders

Documentation

Support

Get active orders

Get all active orders API allows you to view all their active orders in the StockX marketplace. An order is considered active from the time it was created to the time the product was received and authenticated by StockX and the seller is paid out.

Request

Security:

api_keyjwt

query Parameters

pageNumber	integer <int32> >= 1 The number of page
pageSize	integer <int32> [ 1 .. 100 ] Requested page number. Starts at 1
orderStatus	string To filter your Orders by a given order status Available values: "CREATED", "CCAUTHORIZATIONFAILED", "SHIPPED", "RECEIVED", "AUTHENTICATING", "AUTHENTICATED", "PAYOUTPENDING", "PAYOUTCOMPLETED", "SYSTEMFULFILLED", "PAYOUTFAILED", "SUSPENDED" Example: orderStatus=CREATED
productId	string Unique identifier for a product
variantId	string Unique identifier for a products variant
sortOrder	string The field by which the results are sorted. Defaults to "CREATEDAT" and can also accept "SHIPBYDATE".

Responses

200

400

Bad Request

401

Unauthorized

500

Internal Server Error

get/selling/orders/active

Request samples

curl
JavaScript
Node.js

curl -i -X GET \
  'https://api.stockx.com/v2/selling/orders/active?pageNumber=1&pageSize=1&orderStatus=string&productId=string&variantId=string&sortOrder=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"
}
}
]
}