CAcabify
parcels

List parcels filtered by state.

Returns a paginated list of parcels that match the specified states.

get/v1/parcels

Request

  • Base URL
    https://logistics.api.cabify-sandbox.com
  • URL
    https://logistics.api.cabify-sandbox.com/v1/parcels
  • Auth
    HTTP bearer

Query parameters

statesstring[] required

Filter results by one or more parcel states. Repeat the parameter for each state (states=ready&states=delivered). See parcel states for a description of each value.

pagenumber required

Page number to retrieve (0-based).

Response

Success

pagenumber required

The current page number returned.

page_sizenumber required

The number of parcels returned per page.

more_pagesboolean required

Whether additional pages of results are available.

Example response

{
  "parcels": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "external_id": "parcel_001",
      "state": "delivered",
      "pickup_info": {
        "addr": "Calle de Pradillo, 42, Madrid",
        "contact": {
          "name": "John",
          "phone": "+34666000000"
        },
        "instr": "Knock the door three times",
        "loc": {
          "lat": 40.4489254,
          "lon": -3.6730293
        },
        "code": "ABC123",
        "hub_external_id": "magic_store_santa_fe"
      },
      "dropoff_info": {
        "addr": "Calle de Pradillo, 42, Madrid",
        "contact": {
          "name": "John",
          "phone": "+34666000000"
        },
        "instr": "Knock the door three times",
        "loc": {
          "lat": 40.4489254,
          "lon": -3.6730293
        },
        "hub_external_id": "magic_store_santa_fe"
      },
      "dimensions": {
        "height": 10,
        "length": 10,
        "width": 10
      },
      "weight": {
        "value": 1500
      },
      "price": {
        "declared_value": 630,
        "collected_value": 630,
        "currency": "EUR"
      },
      "delivery_from": "2021-12-02T10:00:00Z",
      "delivery_to": "2021-12-02T14:00:00Z"
    }
  ],
  "page": 2,
  "page_size": 20,
  "more_pages": true
}

Changes

No recorded changes to this operation across all 1 revision of this API.