API Reference

Search product variants

get
https://api.twoboxes.io/api/v1/product-variants

Returns a paginated list of product variants matching the provided filters.
Before executing the search, merchant IDs are pre-filtered against the caller's
read permissions via the identity provider. Supports filtering by merchant,
product type, lifecycle status, barcode (UPC/EAN), variant display name, SKU,
and storefront variant ID. Results are cursor-paginated using the next_page token
returned in each response.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
merchant_ids
array of strings

Filter by merchant IDs (UUIDs). Pre-filtered to IDs the caller has read access to.

merchant_ids
string

Filter by barcode (e.g. UPC/EAN) assigned to the variant by the merchant.

string

Filter by variant-level display name (e.g. 'Blue Jeans / Large').

string

Filter by stock-keeping unit identifier assigned by the merchant.

string

Filter by the variant-specific identifier from the originating storefront (e.g. Shopify variant ID).

string

Cursor token from a previous response's next_page field for pagination.

integer

Number of results per page.

Responses

Updated 2 months ago

Did this page help you?
Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 2 months ago

Did this page help you?