API atual/Referência completa/Frete e entrega

Rastreio público

Mostra o andamento de um pacote por token do pedido ou código da transportadora, sem login.

É a página "Onde está meu pedido?". Para não vazar dados pessoais, a resposta traz apenas o primeiro nome do destinatário, a cidade e o estado de destino e os itens sem preço; nunca o endereço completo nem o pagamento.

GET/api/v1/storefront/tracking/{token}Pública

Rastreio público de um pedido

Mostra o andamento de um pacote para quem recebeu o link de rastreio, sem login. Aceita dois tipos de identificador no mesmo lugar do caminho: o token de rastreio do pedido (um UUID enviado ao cliente por e-mail) ou o código de rastreio da transportadora.

Parâmetros de caminho

tokenstringobrigatório

Token de rastreio do pedido (UUID) ou código de rastreio da transportadora. Um valor que não é UUID é tratado como código.

Exemplo de requisição

bash

curl "$BASE_URL/api/v1/storefront/tracking/AB123456789BR"

Resposta

200Pacote encontrado

json

{
  "found": true,
  "order_number": "PEDIDO-20261010-0004",
  "carrier": "Correios SEDEX",
  "tracking_code": "AB123456789BR",
  "recipient_first_name": "Maria",
  "events": [
    {
      "event_type": "in_transit",
      "description": "Objeto em trânsito, por favor aguarde",
      "location": "São Paulo, SP",
      "occurred_at": "2026-10-10T18:20:00Z"
    }
  ],
  "items": [
    { "product_name": "Tênis Run Branco", "product_image": "https://cdn.example.com/tenis.jpg", "quantity": 1 }
  ],
  "destination_city": "Rio de Janeiro",
  "destination_state": "RJ"
}

200Não encontrado (também é 200)

json

{
  "found": false,
  "order_number": "",
  "carrier": "",
  "tracking_code": "",
  "events": [],
  "items": [],
  "destination_city": "",
  "destination_state": ""
}

Campos da resposta

foundboolean

false quando nada corresponde ao identificador. Teste este campo, não o status HTTP.

order_numberstring

Número do pedido mostrado ao cliente.

carrierstring

Nome da transportadora.

tracking_codestring

Código de rastreio.

recipient_first_namestring

Primeiro nome do destinatário. Ausente quando não há.

eventsobject[]

Linha do tempo do pacote. [] quando ainda não há eventos.

events[].event_typestring

Tipo do evento, como o fornecedor de rastreio o classifica.

events[].descriptionstring

Texto do evento.

events[].locationstring

Onde ocorreu.

events[].occurred_atstring

RFC 3339, UTC.

itemsobject[]

Itens do pacote, sem preço.

items[].product_namestring

Nome do produto.

items[].product_imagestring

Imagem. Ausente se não houver.

items[].quantitynumber

Quantidade (pode ter até 3 casas, para produtos vendidos a peso).

destination_citystring

Cidade de destino.

destination_statestring

UF de destino.

Erros

Status	Quando	Corpo
500	Falha ao consultar o rastreio.	`{"error":"tracking_failed","detail":"..."}`

Veja também

Rastreio público

Mostra o andamento de um pacote por token do pedido ou código da transportadora, sem login.

GET/api/v1/storefront/tracking/{token}Pública

Rastreio público de um pedido

Parâmetros de caminho

tokenstringobrigatório

Token de rastreio do pedido (UUID) ou código de rastreio da transportadora. Um valor que não é UUID é tratado como código.

Exemplo de requisição

bash

curl "$BASE_URL/api/v1/storefront/tracking/AB123456789BR"

Resposta

200Pacote encontrado

json

{
  "found": true,
  "order_number": "PEDIDO-20261010-0004",
  "carrier": "Correios SEDEX",
  "tracking_code": "AB123456789BR",
  "recipient_first_name": "Maria",
  "events": [
    {
      "event_type": "in_transit",
      "description": "Objeto em trânsito, por favor aguarde",
      "location": "São Paulo, SP",
      "occurred_at": "2026-10-10T18:20:00Z"
    }
  ],
  "items": [
    { "product_name": "Tênis Run Branco", "product_image": "https://cdn.example.com/tenis.jpg", "quantity": 1 }
  ],
  "destination_city": "Rio de Janeiro",
  "destination_state": "RJ"
}

200Não encontrado (também é 200)

json

{
  "found": false,
  "order_number": "",
  "carrier": "",
  "tracking_code": "",
  "events": [],
  "items": [],
  "destination_city": "",
  "destination_state": ""
}

Campos da resposta

foundboolean

false quando nada corresponde ao identificador. Teste este campo, não o status HTTP.

order_numberstring

Número do pedido mostrado ao cliente.

carrierstring

Nome da transportadora.

tracking_codestring

Código de rastreio.

recipient_first_namestring

Primeiro nome do destinatário. Ausente quando não há.

eventsobject[]

Linha do tempo do pacote. [] quando ainda não há eventos.

events[].event_typestring

Tipo do evento, como o fornecedor de rastreio o classifica.

events[].descriptionstring

Texto do evento.

events[].locationstring

Onde ocorreu.

events[].occurred_atstring

RFC 3339, UTC.

itemsobject[]

Itens do pacote, sem preço.

items[].product_namestring

Nome do produto.

items[].product_imagestring

Imagem. Ausente se não houver.

items[].quantitynumber

Quantidade (pode ter até 3 casas, para produtos vendidos a peso).

destination_citystring

Cidade de destino.

destination_statestring

UF de destino.

Erros

Status	Quando	Corpo
500	Falha ao consultar o rastreio.	`{"error":"tracking_failed","detail":"..."}`