Products
List products
selectkey<token>
API key para requisições autenticadas. Envie sua chave no cabeçalho selectkey (sandbox sk_test_…, produção sk_live_…).
In: header
Query Parameters
limit?integer
offset?integer
sort?string
Sort expression, e.g. "-createdAt"
daterange?|
daterangegt?string
daterangegte?string
daterangelt?string
daterangelte?string
id?string
Public identifier (prd_/pro_…)
slug?string
name?string
language?string
category?string
enabled?boolean
externalreference?string
Response Body
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/v1/products"{
"offset": 0,
"limit": 0,
"total": 5000,
"page": {
"offset": {
"first": 0,
"prev": 0,
"next": 0,
"last": 0
},
"current": 0,
"total": 5000
},
"data": [
{
"id": "prd_0a1b2c3d4e5f60718293",
"name": "Acme Ltda",
"slug": "string",
"salesPage": "string",
"description": "string",
"language": "string",
"enabled": true,
"salesQty": 0,
"type": "physical",
"category": "string",
"externalReference": "string",
"warrantyDays": 0,
"images": [
"string"
],
"createdAt": "string",
"updatedAt": "string",
"variants": [
{
"id": "var_0a1b2c3d4e5f60718293",
"productId": "prd_0a1b2c3d4e5f60718293",
"name": "Acme Ltda",
"slug": "string",
"description": "string",
"sku": "string",
"primary": true,
"enabled": true,
"pricing": {
"oldPrice": 5000,
"unitPrice": 5000,
"costPerItem": 0,
"currency": "BRL",
"schema": "unit",
"type": "oneTime",
"daysTrial": 0,
"billingType": "string",
"billingFrequency": "string",
"billingFrequencyCount": 0,
"billingExactDay": 0,
"cycles": 0,
"trialInterval": "string",
"trialIntervalCount": 0,
"tiersMode": "string",
"usageType": "string",
"usageAggregation": "string",
"meterEventName": "string"
},
"images": [
"string"
],
"metadata": {},
"attributes": {},
"externalReference": "string",
"checkoutUrl": "string",
"createdAt": "string",
"updatedAt": "string"
}
]
}
],
"hasMore": true
}{
"error": {
"status": "Unauthorized",
"statusCode": 401,
"category": "authentication",
"code": "unauthorized",
"message": "Authentication is required to access this resource.",
"resource": "server"
}
}{
"error": {
"status": "Forbidden",
"statusCode": 403,
"category": "authorization",
"code": "forbidden",
"message": "You do not have permission to perform this action.",
"resource": "server"
}
}{
"error": {
"status": "Internal Server Error",
"statusCode": 500,
"category": "server",
"code": "serverError",
"message": "An unexpected error occurred. Please try again later.",
"resource": "server",
"details": "If the problem persists, contact support with the correlationId from the response headers."
}
}