跳到主要内容

通过卡片密钥查询配送信息

Request​

ENDPOINT
/card/CARD_KEY/tracking
MÉTODO
GET

路径参数​

字段类型描述字符数
CARD_KEY *string卡片识别密钥。uuid

Response​

STATUS
200
Response Body
{
  "card_key": "92b4e2bd-4a6f-4c56-859e-17c729e1f0c8",
  "tracking_code": "4F68A72B902317",
  "status": "posted",
  "recipient": "João Silva",
  "address": {
    "zip_code": "1234567",
    "street": "Rua das Flores",
    "number": 123,
    "complement": "Bloco A",
    "neighborhood": "Centro",
    "city": "Cidade Exemplo",
    "state": "SP"
  },
  "event": [
    {
      "created_at": "2024-02-27T08:30:00Z",
      "old_status": "pending",
      "new_status": "posted",
      "description": "Pedido recebido e postado",
      "place": "SAO PAULO"
    }
  ]
}

DeliveryStatus 枚举值​

枚举值说明
pending待处理
posted已寄出
prepared已备货
in_transfer转运中
in_delivery_unit在配送网点
on_route派送中
attempt_failed尝试失败
awaiting_withdrawal等待自提
returning退回中
delivered已送达
returned已退回
canceled已取消
failed失败
resend重新发送

错误​

STATUS
4XX
Response Body
{
  "title": "Not Found",
  "description": "It was not possible to fetch the Tracking for the card_key f6bf148a-30b6-4a07-8c5b-3383a98ea32b.",
  "translation": "Not Found",
  "code": "TRACK000011"
}
CodeStatus code描述
TRACK000011404It was not possible to fetch the Tracking for the card_key {card_key}.
TRACK000016400We're sorry, but the tracking could not be fetch. Please try again later.