Skip to main content
GET
Get Products
Subtotal Connector tool: list_products Your brand catalog: every active product of your brands, including co-branded ones, whether or not consumers have bought it yet. These are the same products as the Products page in the dashboard. Pass group_id (from List product groups) for the products in one of your groups, like the dashboard’s group filter. Call it with your API key, or with an OAuth access token that includes purchases:brand_products (which partner apps are granted). A token without it receives 403 insufficient_scope.

Headers

authorization
string | null
x-api-key
string | null

Query Parameters

search
string | null

Only products whose description, short description or UPC contains this

Maximum string length: 256
limit
integer
default:25

The maximum number of products to return

Required range: 1 <= x <= 100
starting_after
string | null

The product id of the last product you processed. The next one returned follows it.

Example:

"01J51S0JYV6N7K1030CV1ZKPR1"

group_id
string | null

Only products in this product group, a product_group_id from GET /product-groups. A group that isn't yours matches no products.

Response

Successful Response

has_more
boolean
required

Whether more products match after this page

Example:

false

products
ProductDetail · object[]
required

Matching products, ordered by product_id