Track card delivery by key

Request

ENDPOINT

/card/CARD_KEY/tracking

METHOD

GET

Path params

Field	Type	Description	Characters
CARD_KEY *	string	Card identification key	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"
    }
  ]
}

Enumerator DeliveryStatus

Enumerator
pending
posted
prepared
in_transfer
in_delivery_unit
on_route
attempt_failed
awaiting_withdrawal
returning
delivered
returned
canceled
failed
resend

Errors

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"
}

Code	Status code	Description
TRACK000011	404	It was not possible to fetch the Tracking for the card_key {card_key}.
TRACK000016	400	We're sorry, but the tracking could not be fetch. Please try again later.