Documentação da API

Cria um rastreio. Dois modos: gerar o código (omita trackingCode — a plataforma emite o código, monta a linha do tempo e cobra o valor por rastreio do seu plano) ou acompanhar um código existente da transportadora (informe trackingCode). Em ambos, a plataforma dispara notificações/webhooks a cada mudança.

• trackingCode string
  Opcional. 8 a 30 caracteres alfanuméricos (normalizado para maiúsculas). Omita para a plataforma gerar o código e devolvê-lo na resposta.
• durationDays int 1–20
  Prazo do rastreio gerado (padrão 10 dias). Ignorado quando trackingCode é informado.
• carrier enum
  `correios` (padrão), `jadlog`, `loggi`, `total_express`, `azul_cargo`, `other`.
• orderId uuid
  ID de um pedido já criado em /v1/orders.
• externalOrderId string ≤60
  Seu identificador do pedido (ex.: número na loja).
• customerName string ≤120
  Nome do destinatário (o primeiro nome aparece na página pública).
• customerEmail email
  Recebe as notificações automáticas, se ativadas.
• customerPhone string
  Somente dígitos com DDI opcional, 10–14 dígitos (ex.: 5511999998888).
• metadata object
  Chave/valor livre, devolvido nas respostas e webhooks.

curl -X POST https://api.meurastreiio.com/v1/trackings \
  -H "Authorization: Bearer mr_live_SUA_CHAVE" \
  -H "Content-Type: application/json" \
  -d '{
    "externalOrderId": "PED-1042",
    "durationDays": 10,
    "customerName": "Maria Silva",
    "customerEmail": "maria@exemplo.com",
    "metadata": { "canal": "loja-virtual" }
  }'

{
  "id": "5b1c…",
  "trackingCode": "AA123456789BR",
  "carrier": "correios",
  "status": "pending",
  "statusDescription": null,
  "orderId": null,
  "customer": { "name": "Maria Silva", "email": "maria@exemplo.com", "phone": null },
  "postedAt": null,
  "deliveredAt": null,
  "lastEventAt": null,
  "metadata": { "canal": "loja-virtual" },
  "createdAt": "2026-09-18T20:00:00.000Z",
  "updatedAt": "2026-09-18T20:00:00.000Z"
}

Cadastra vários códigos de uma vez. Corpo: { "trackings": [ …mesmos campos do POST /v1/trackings ] } (1 a 1000 itens, limitado pelo batchLimit do seu plano — excedeu, retorna 403).

Resposta: { "results": [ { "trackingCode", "ok": true, "id" } | { "trackingCode", "ok": false, "error" } ] } — itens com erro não interrompem o lote.

Lista paginada. Query: page (≥1), limit (1–100, padrão 20), status, carrier, from/to (ISO, filtra por createdAt).

curl "https://api.meurastreiio.com/v1/trackings?status=in_transit&limit=50" \
  -H "Authorization: Bearer mr_live_SUA_CHAVE"

Detalhe com histórico. Aceita o id interno ou o próprio código de rastreio. Inclui events[] com status, description, location, occurredAt.

Status possíveis: pending, posted, in_transit, out_for_delivery, delivered, exception, returned, cancelled, not_found.

• externalId string ≤60
  Seu ID do pedido.
• customerName / customerEmail / customerPhone string
  Dados do comprador.
• customerDocument string ≤20
  CPF/CNPJ (opcional).
• totalCents int
  Total do pedido em centavos.
• source string ≤40
  Origem (ex.: shopify, nuvemshop).
• shippingAddress object
  Endereço livre (chave/valor).
• items object[]
  Itens do pedido (livre).
• trackingCode + carrier string
  Se informados, o rastreio é criado e vinculado ao pedido.

curl -X POST https://api.meurastreiio.com/v1/orders \
  -H "Authorization: Bearer mr_live_SUA_CHAVE" \
  -H "Content-Type: application/json" \
  -d '{
    "externalId": "PED-1042",
    "customerName": "Maria Silva",
    "customerEmail": "maria@exemplo.com",
    "totalCents": 18990,
    "source": "nuvemshop",
    "trackingCode": "AA123456789BR",
    "carrier": "correios"
  }'

Corpo: { "name"?: string, "url": "https://…", "events": ["tracking.updated", …] }. A resposta traz o secret (whsec_…) uma única vez — guarde-o para validar assinaturas.

curl -X POST https://api.meurastreiio.com/v1/webhooks \
  -H "Authorization: Bearer mr_live_SUA_CHAVE" \
  -H "Content-Type: application/json" \
  -d '{ "url": "https://minhaloja.com.br/hooks/hq", "events": ["tracking.updated", "tracking.delivered"] }'