Rastreio de Grupo de Pedido
/orders/groups/{orderGroupId}/tracking
Consulta o rastreio ao vivo de todas as remessas de um grupo de pedido junto às transportadoras responsáveis.
Descrição
Consulta o rastreio em tempo real de todas as remessas de um grupo de pedido. Cada remessa é consultada de forma concorrente percorrendo a canalização completa: store.uappi → integration.uappi → external.uappi → API da transportadora.
O acesso exige o escopo de permissão ORDER_READ.
A resposta é sempre um array — uma entrada por remessa do grupo. Remessas com falha de rastreio são incluídas com o campo error preenchido, permitindo visualização parcial do grupo sem interromper as demais consultas.
Parâmetros
Headers Obrigatórios
| Header | Valor | Descrição |
|---|---|---|
Authorization | Bearer {token} | Token de autenticação |
Parâmetros de URL
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
orderGroupId | integer | Sim | ID do grupo de pedido |
Exemplo de Requisição
1curl --request GET \2 --url https://sua-loja-uappi.com.br/api/v3/orders/groups/456/tracking \3 --header "Authorization: Bearer SEU_TOKEN_AQUI"✅ Resposta de Sucesso
HTTP Status: 200 OK
1[2 {3 "orderId": 123,4 "trackingCode": "AA123456789BR",5 "trackingUrl": "https://correios.com.br/rastreio/AA123456789BR",6 "status": "em_transito",7 "events": [8 {9 "date": "2026-05-01T10:30:00",10 "description": "Objeto em trânsito",11 "location": "São Paulo / SP"12 }13 ],14 "invoiceNumber": "000123",15 "invoiceKey": "35260412345678901234550010001234561234567890",16 "invoiceSerie": "1",17 "error": null18 },19 {20 "orderId": 124,21 "trackingCode": null,22 "trackingUrl": null,23 "status": null,24 "events": [],25 "invoiceNumber": null,26 "invoiceKey": null,27 "invoiceSerie": null,28 "error": "MISSING_TRACKING_CODE"29 }30]⚠️ Possíveis Erros
Atenção: a seguir estão destacados os principais erros que podem ocorrer neste endpoint.
Os cenários descritos representam os erros mais relevantes do contexto atual, servindo como referência para entendimento e tratamento das falhas.
Erros de domínio por remessa são retornados com HTTP 200 — o campo error de cada item indica a falha específica.
| Código Interno | HTTP | Descrição |
|---|---|---|
ORDER_SHIPPING_NOT_FOUND | 200 | Remessa não possui registro de frete. Verifique o campo error do item correspondente. |
MISSING_SHIPPING_INTEGRATION | 200 | Remessa não possui integração de frete configurada. Verifique o campo error do item correspondente. |
MISSING_TRACKING_CODE | 200 | Remessa ainda não possui código de rastreio emitido pela transportadora. Verifique o campo error do item correspondente. |
TRACKING_NOT_SUPPORTED | 200 | A integração de frete configurada não oferece recurso de rastreio. Verifique o campo error do item correspondente. |
UAPPI_STORE_ORDER_GROUP_NOT_FOUND | 404 | O grupo de pedido solicitado não foi localizado no sistema. |