Versioning and Support
Keep track of changes and updates to the StockX API
The API version you’re on controls the API behavior you see. Your version is selected per request to the StockX API. When breaking changes are introduced, a new API version will be released. To avoid breaking your integration, we will never change your version, and we will announce a date ahead of time before deprecating any API versions.
When StockX releases a new version of the API, we are announcing that the current version is immediately deprecated and we will no longer support it 12 months after the release. We might make exceptions to this policy.
When an API is marked as deprecated, we strongly suggest that you migrate to the latest version as soon as possible. New applications will have to start using the new APIs a short time after the older APIs are deprecated. Only active applications that currently use the deprecated APIs can continue to use them.
StockX considers the following changes to be backwards-compatible:
- Adding optional request parameters to existing API methods.
- Adding new or additional properties/fields to existing API responses.
- Changing the order of properties/fields in existing API responses.
- Adding new or additional API resources.
- Changing the length or format of human-readable strings.
Upgrading your API version
StockX updates the version of our API when a non-backwards-compatible change is made.
Selecting an API version is as simple as changing the version component of the path. For example, from "v1" to "v2". However, developers should make this change cautiously, with sufficient testing, and an expectation that it will likely require other client-side coding changes.
Changelog and release notes
- New Basic Market Data API replaces the
variantId. You can now look up basic market data for any product variant you want, without needing an active listing to do so. Find it under our Catalog APIs!
- The existing Basic Market Data API (
/v2/sellings/listings/listingId/market-data) will be deprecated one year from now, on March 25, 2024.
- StockX APIs no longer support the following currencies: CNY, SEK, NOK, TWD, CLP, MYR, PHP, THB, IDR, BRL, KWD, ILS, PEN, VND, MOP, and AED. Please visit the API reference to find a list of supported currencies.
- A new attribute has been introduced to the Get all listings and Get single listing APIs called
inventoryType. This is currently an unsupported, read-only attribute.
- StockX V2 APIs are far more feature-rich and most importantly work at scale meeting the demand required for our largest partners that require batch operations and those that frequently send high rates of requests.
What's New in V2?
- Batch operations - We now offer a suite of APIs that allow API partners to interact with their listings in bulk with a maximum of 100 batch operations per entry. To view more be sure to check out our batch-create, batch-update, and batch-delete APIs.
- Active and inactive inventory - For sellers that have a fleet of inventory ready to go, but first want to test the waters, simply mark your inventory as inactive and only place it in our marketplace when you're ready. Check out our activate and deactivate listing APIs for more information.
- Order history - Whether it's to review payout information on past orders in preparation for tax season, or verify a past purchase to compare it on your end, we now offer a new order history API that tracks all completed sales on the StockX Platform.
Batch APIs enable users to create, update, and delete listings in bulk. Batch APIs are asynchronous in nature and we provide mechanisms to poll the API so that you can keep track of the batch completion. Once a batch is successfully completed, you can view the status of each individual listing. We track each individual listing inside a batch separately so you can have scenarios where some listings succeed and some fail in a single batch.
- We are introducing a new attribute called a
listingId, which is intended to replace
askIdin the near future. For now, you need to store both the
askIdwhen you interact with the batch APIs.
- We are introducing a new attribute called a
- Enhanced “Get Active Orders API” as well as “Get Single Order API” by adding a new attribute called
shipmentobject, which will now point to the new Shipping Document API which includes a field for the singular shipping label and another for the entire StockX shipping document.
- The new shipping document API will retrieve the StockX Shipping Document as a PDF. The API requires a shipping document number and to make it easy for the user, the shipping document URL for each order is embedded in the order API responses.