Skip to main content
Use POST /api/v1/orders quando seu checkout ou backend criar um pedido.

​
Headers

Authorization: Bearer <api_token>
Content-Type: application/json
Idempotency-Key: order_001_create

​
Payload mínimo

{
  "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"
  }
}

​
Campos opcionais úteis

  • 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.

​
Exemplo curl

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"
    }
  }'

​
Resposta

{
  "order": {
    "id": "clx_internal_id",
    "externalId": "order_001",
    "status": "pending",
    "isTest": false
  }
}

​
Erros comuns

CódigoQuando acontece
MALFORMED_JSONJSON inválido.
VALIDATION_FAILEDCampo obrigatório ausente, tipo inválido ou data sem timezone.
UNAUTHORIZEDToken ausente ou inválido.
TOKEN_REVOKEDToken revogado.
DUPLICATE_EXTERNAL_IDJá existe pedido com o mesmo externalId.
RATE_LIMIT_EXCEEDEDLimite por token atingido.