STstockx
Order

Get historical orders

Get historical orders from the last six months. Multiple filters are available. Date ranges are limited to the six months ending on the current date. If no date range is supplied, the complete six-month window is returned. A fromDate earlier than the available window is adjusted to the six-month cutoff, and a toDate after the current date is adjusted to the current date.

get/selling/orders/history

Request

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

Query parameters

fromDatestring

The start date of when the orders were created. Defaults to six months ago. Dates earlier than six months ago are adjusted to the six-month cutoff. Format is YYYY-MM-DD.

toDatestring

The end date of when the orders were created. Defaults to the current date. Later dates are adjusted to the current date. Format is YYYY-MM-DD.

pageNumberinteger

The requested page number. By default the page number is 1

pageSizeinteger

The number of orders to be returned. By default the number is 10

orderStatusstring

To filter your Orders by a given order status<br><br>Available values: "AUTHFAILED", "DIDNOTSHIP", "CANCELED", "COMPLETED", "RETURNED"

productIdstring

Unique StockX product ID

variantIdstring

Unique StockX variant ID

inventoryTypesstring

Comma-separated list of inventory type(s). This field must not include array brackets [] or quotation marks ("| ''). The inventory types are STANDARD, FLEX or DIRECT.

initiatedShipmentDisplayIdsstring

The shipment's unique display id associated with the order. Note: This is the same ID generated when a Flex inbound list is created in StockX Pro.

Response

Ok

countnumber double required

Total number of items present

pageSizenumber double required

Total number of items in the current page

pageNumbernumber double required

Requested page number. Starts at 1.

hasNextPageboolean required

Returns true if there are elements in the next page.

Example response

{
  "count": 266,
  "pageSize": 10,
  "pageNumber": 1,
  "hasNextPage": true,
  "orders": [
    {
      "listingId": "35d76ac8-a112-4d75-b44f-c8ef04a87c93",
      "askId": "13658831621304650018",
      "amount": "140",
      "currencyCode": "USD",
      "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": {
        "variantName": "Auston-Matthews-2016-Upper-Deck-Series-1-Young-Guns-Rookie-201:0",
        "variantValue": "PSA 10"
      },
      "payout": {
        "adjustments": [
          {
            "adjustmentType": "Shipping Fee (10%)"
          }
        ]
      },
      "condition": "Used",
      "conditionDescription": "Brand new, never worn"
    }
  ]
}

Changes

No recorded changes to this operation across all 2 revisions of this API.