parcels

Update a parcel by ID.

Update editable fields of an existing parcel. The set of fields that can be modified depends on the parcel's current state:

All fields can be updated when the parcel is in one of these states: ready, pickupfailed, requestercancel, or returned.

Instructions only (pickup_info.instr, dropoff_info.instr) can be updated in all other active states.

put/v1/parcels/{parcel_id}

Request

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

Path parameters

parcel_idstring uuid required

UUID of the parcel to update.

Request body

external_idstring

Your own identifier for this parcel. Must be unique across all your parcels.

delivery_fromstring date-time

Start of the requested delivery time window, formatted according to RFC 3339, section 5.6. The parcel will not be delivered before this time.

delivery_tostring date-time

End of the requested delivery time window, formatted according to RFC 3339, section 5.6. The parcel should be delivered before this time.

Example request

{
  "external_id": "parcel_001",
  "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
  },
  "delivery_from": "2021-12-02T10:12:07.753Z",
  "delivery_to": "2021-12-02T10:12:07.753Z",
  "price": {
    "declared_value": 630,
    "collected_value": 630,
    "currency": "EUR"
  }
}

Response

Parcel updated successfully.

idstring uuid

System-generated UUID for this parcel.

external_idstring

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

client_idstring

The account that owns the parcel.

statestring

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

failure_reasonstring

If present, why the shipment request was rejected. Same values as failure_reason in the status endpoint.

delivery_fromstring date-time

Start of the delivery window, if the parcel has one, formatted according to RFC 3339, section 5.6.

delivery_tostring date-time

End of the delivery window, if the parcel has one, formatted according to RFC 3339, section 5.6.

Example response

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

Changes

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