Skip to main content
GET
/
products
List products with filters and cursor pagination
curl --request GET \
  --url https://api.example.com/products
{
  "data": [
    {
      "id": "cffbca85-da89-4b2a-aecf-31422abcb34a",
      "sku": "PROD-123",
      "commercialName": "Cabo USB-C",
      "type": "SIMPLE",
      "status": "APPROVED",
      "price": 150.00
    }
  ],
  "total": 1,
  "page": 1,
  "limit": 10
}

​
Query Parameters

​
page
number
default:"1"
Paginação usando cursores.
​
limit
number
default:"10"
Limite de itens retornáveis.
​
category
string
Busca pela taxonomia.
​
status
string
Status do produto (ex: APPROVED).

​
Response

{
  "data": [
    {
      "id": "cffbca85-da89-4b2a-aecf-31422abcb34a",
      "sku": "PROD-123",
      "commercialName": "Cabo USB-C",
      "type": "SIMPLE",
      "status": "APPROVED",
      "price": 150.00
    }
  ],
  "total": 1,
  "page": 1,
  "limit": 10
}

Query Parameters

​
search
string

Search term for name or SKU

​
category
string

Filter by category

​
status
enum<string>

Filter by status

Available options:
ACTIVE,
INACTIVE
​
companyId
string

Filter by company ID

​
channel
string

Filter by channel

​
onlyTemplates
boolean

Return only variation templates

​
onlySellable
boolean

Return only sellable products (excludes templates)

​
excludeTemplates
boolean

Explicitly exclude templates

​
cursor
number

Cursor for pagination (next page starts after this seqId)

​
limit
number
default:50

Number of items per page

Response

200

Return list of products and metadata.