Sign in

v1

latestOpenAPI 3.0.0MIT2026-08-043290199.3 KB
Listings

Get all listings

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

get/selling/listings

Query parameters

pageNumberinteger

Requested page number. By default the page number starts at 1

pageSizeinteger

The number of listings to return. By default the page size starts at 1.

productIdsstring

Comma separated list of ids. This field must not include array brackets [] or quotation marks (" " | ' ').

variantIdsstring

Comma separated list of ids. This field must not include array brackets [] or quotation marks (" " | ' ').

batchIdsstring

Comma separated list of ids. This field must not include array brackets [] or quotation marks (" " | ' ').

fromDatestring

Start date of the query

toDatestring

End date of the query

listingStatusesstring

Comma separated list of listing statuses. This field must not include array brackets [] or quotation marks ("" | '').<br><br>Available values: "INACTIVE", "ACTIVE", "CANCELED", "MATCHED", "COMPLETED"

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 listing. Note: This is the same ID generated when a Flex inbound list is created in StockX Pro.

isExpiredboolean

Whether to include expired listings in the results. Defaults to false.

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,
  "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": {
        "askCreatedAt": "2021-11-09T12:44:31.000Z",
        "askUpdatedAt": "2021-11-09T12:44:31.000Z",
        "askExpiresAt": "2021-11-09T12:44:31.000Z"
      },
      "order": {
        "orderCreatedAt": "2021-11-09T12:44:31.000Z",
        "orderStatus": "CREATED"
      },
      "product": {
        "productId": "bf364c53-eb77-4522-955c-6a6ce952cc6f",
        "productName": "Nike Air",
        "styleId": "FV5029-006"
      },
      "variant": {
        "variantId": "bf364c53-eb77-4522-955c-6a6ce952cc6f",
        "variantName": "color",
        "variantValue": "black"
      },
      "condition": "Used",
      "conditionDescription": "Brand new, never worn"
    }
  ]
}