Sign in

v1

latestOpenAPI 3.0.0Cabify Api support2026-07-264588127.9 KB
status

Get the current status of a parcel.

Returns the current state and tracking information for the specified parcel.

get/v1/parcels/{parcel_id}/status

Path parameters

parcel_idstring uuid required

UUID of the parcel to track.

Response

Parcel status retrieved successfully.

idstring uuid

System-generated UUID for this parcel.

external_idstring

Your own identifier for this parcel, as provided when the parcel was created.

state'ready' | 'qualifiedforpickup' | 'pickingup' | 'intransit' | 'delivering' | 'delivered' | 'returning' | 'returned' | 'incident' | 'requestercancel' | 'internalcancel' | 'pickupfailed' | 'onroutetopickup' | 'readytopickup' | 'onroutetofinalhub' | 'receivedonfinalhub' | 'readytodispatch' | 'onroutetodelivery' | 'undelivered' | 'onroutetoreturn' | 'returnrejected'

The current lifecycle state of the parcel. See parcel states for a full description of each value.

failure_reason'unknown' | 'payment_method_declined' | 'no_payment_methods' | 'requester_not_found_or_unauthorized' | 'product_does_not_exist' | 'invalid_pick_up_location' | 'delivery_already_exist'

If present, indicates why the delivery was rejected. See failure reasons for a description of each value.

Example response

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "external_id": "parcel_001",
  "delivery_attempt": {
    "id_proof_of_delivery": {
      "recipient_name": "Francisco",
      "recipient_id_number": "11111111T"
    },
    "photo_proof_of_delivery": {
      "photo_url": "https://s3.amazon.com/photo.jpg"
    },
    "comment_proof_of_delivery": {
      "comment": "El paquete se ha dejado en la puerta"
    }
  },
  "tracking": {
    "eta_to_accept": 90,
    "location": {
      "lat": 40.4489254,
      "lon": -3.6730293
    },
    "routes": {
      "pick_up": {
        "eta": 120,
        "path": "fhdsa98fha87sdfhas76dgf8a"
      },
      "drop_off": {
        "eta": 120,
        "path": "fhdsa98fha87sdfhas76dgf8a"
      }
    }
  },
  "asset": {
    "reg_plate": "1111AAA",
    "name": "Audi A3",
    "color": "black"
  },
  "driver": {
    "photo_url": "https://s3.amazon.com/photo.jpg",
    "name": "Pepe",
    "phone": "+34658478854"
  },
  "pickup_failed": {
    "reason": "address_wrong",
    "failed_at": "2021-12-02T10:12:07.753Z",
    "driver_comments": "can't find the address"
  },
  "shipping_type": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "Same day default",
    "modality": "same_day"
  }
}