Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
Como usar POST /api/v1/orders com headers, payload mínimo, resposta e erros comuns.
POST /api/v1/orders quando seu checkout ou backend criar um pedido.
Authorization: Bearer <api_token>
Content-Type: application/json
Idempotency-Key: order_001_create
{
"externalId": "order_001",
"platform": "checkout",
"paymentMethod": "credit_card",
"status": "pending",
"createdAt": "2026-05-10T15:34:14Z",
"isTest": false,
"amounts": {
"currency": "BRL",
"grossCents": 20000,
"netToSellerCents": 17000
},
"products": [
{
"externalId": "prod_001",
"sku": "SKU-001",
"name": "Produto exemplo",
"quantity": 1,
"unitPriceCents": 20000
}
],
"tracking": {
"utmSource": "facebook",
"utmMedium": "cpc",
"utmCampaign": "lancamento"
}
}
customer: dados do cliente.fees: taxas do gateway.metadata: objeto livre para dados operacionais não sensíveis.trackingExtras: parâmetros adicionais de tracking.paidAt, refundedAt, chargedbackAt: datas do ciclo de pagamento.amounts.discountCents, shippingCents, taxesCents, totalFeesCents: assumem 0 quando omitidos.curl -X POST "https://app.atriby.com/api/v1/orders" \
-H "Authorization: Bearer <TOKEN>" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: order_001_create" \
-d '{
"externalId": "order_001",
"platform": "checkout",
"paymentMethod": "credit_card",
"status": "pending",
"createdAt": "2026-05-10T15:34:14Z",
"isTest": false,
"amounts": {
"currency": "BRL",
"grossCents": 20000,
"netToSellerCents": 17000
},
"products": [
{ "name": "Produto exemplo", "quantity": 1, "unitPriceCents": 20000 }
],
"tracking": {
"utmSource": "facebook",
"utmMedium": "cpc",
"utmCampaign": "lancamento"
}
}'
{
"order": {
"id": "clx_internal_id",
"externalId": "order_001",
"status": "pending",
"isTest": false
}
}
| Código | Quando acontece |
|---|---|
MALFORMED_JSON | JSON inválido. |
VALIDATION_FAILED | Campo obrigatório ausente, tipo inválido ou data sem timezone. |
UNAUTHORIZED | Token ausente ou inválido. |
TOKEN_REVOKED | Token revogado. |
DUPLICATE_EXTERNAL_ID | Já existe pedido com o mesmo externalId. |
RATE_LIMIT_EXCEEDED | Limite por token atingido. |