Atualizar rastreio de um pedido
Atualiza trackingCode, trackingUrl, trackingStatus e trackingCarrier de um pedido via API Key.
Contrato
| Item | Valor |
|---|
| Método | PATCH |
| Path | /integrations/v1/stores/:storeId/orders/:orderRef/tracking |
| Autenticação | Authorization: Bearer cvx_live_... |
| Escopo | orders:write |
Parâmetros de rota
| Parâmetro | Tipo | Descrição |
|---|
storeId | UUID | ID da loja na Corvex (deve estar em storeIds da chave) |
orderRef | string (1–80) | UUID do pedido ou external_id (ex.: PED-1001) |
Body (JSON)
| Campo | Tipo | Obrigatório | Descrição |
|---|
trackingCode | string (1–120) | Sim | Código de rastreio |
trackingUrl | string (URL, max 2048) | Não | Link de rastreamento |
trackingStatus | enum | Não | label_generated, posted, in_transit, out_for_delivery, delivered, failed, returned, unknown |
trackingCarrier | string (max 120) | Não | Transportadora (ex.: Correios) |
Exemplo
curl --request PATCH "https://apiv3.usecorvex.com.br/integrations/v1/stores/00000000-0000-4000-8000-000000000000/orders/SEU_PEDIDO/tracking" \
--header "Authorization: Bearer cvx_live_..." \
--header "Content-Type: application/json" \
--data '{
"trackingCode": "AB123456789BR",
"trackingUrl": "https://rastreamento.correios.com.br/app/index.php?objeto=AB123456789BR",
"trackingStatus": "posted",
"trackingCarrier": "Correios"
}'
Resposta 200
{
"success": true,
"message": "Código de rastreio atualizado com sucesso",
"data": {
"order": {
"id": "11111111-1111-4111-8111-111111111111",
"trackingCode": "AB123456789BR",
"trackingUrl": "https://rastreamento.correios.com.br/app/index.php?objeto=AB123456789BR",
"trackingStatus": "posted"
}
}
}
Documentação completa: Integração de rastreio