v2

OpenAPI 3.0.3Proprietary2026-07-263483431.1 MB

Business Products

List business products

Requires the product:list scope. Retrieves a paginated list of products with optional filtering. The data is sorted by id in descending order and cannot be changed. Uses cursor-based pagination with default page size of 25 and maximum of 25.

get/v3/products

Query parameters

page_sizeinteger

Example:25

Number of items per page (default: 25, max: 25)

next_cursorstring

Opaque cursor for the next page.

previous_cursorstring

Opaque cursor for the previous page.

searchstring

Search term to filter products by name (case-insensitive, partial match)

is_inventoryboolean

Filter products by inventory tracking status (true or false)

is_product_sharingboolean

Filter products by product sharing status (true or false)

warehouse_idinteger

Filter products associated with a specific warehouse ID

qty_type'available_qty'

Type of quantity to filter by. Options are 'available_qty' (only products with variants that have available quantity > 0)

store_idstring

One or more comma-separated positive numeric store IDs or store_... unique references. Every value is resolved within the authenticated business, then deduplicated before filtering products.

is_checkedboolean

Show variants in products where is_checked is true or false

is_ownedboolean

Filter products by ownership. 'true' returns products owned by the business, 'false' returns shared products

item_type'physical' | 'digital' | 'course' | 'license' | 'subscription'

Type of the product item

Filter products by item type (physical, digital, course, license, subscription)

labelstring

Filter products associated with a specific label name

pricing_type'one_time' | 'recurring'

Filter products by pricing type (one_time or recurring)

Response

Products list

is_paginatedtrue required

has_nextboolean

has_previousboolean

next_cursorstring nullable

previous_cursorstring nullable

page_sizeinteger

Example response

{
  "is_paginated": true,
  "page_size": 25
}