Update a parcel by ID.

put

https://logistics.api.cabify-sandbox.com/v1/parcels/{parcel_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 returnedtoorigin.

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

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

parcel_id

uuid

required

UUID of the parcel to update.

Body Params

Fields of the parcel you want to update. Only the provided fields will be changed.

Fields that can be updated on an existing parcel. Only fields included in the request will be modified.

external_id

string

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

pickup_info

object

Information about the pickup point. You must provide at least one of the following location fields: loc (coordinates), addr (address string), or hub_external_id (reference to a registered hub). They may be combined; when loc is present the coordinates are used and addr is kept as informational only.

dropoff_info

object

Information about the drop-off (destination) point. You must provide at least one of the following location fields: loc (coordinates), addr (address string), or hub_external_id (reference to a registered hub). They may be combined; when loc is present the coordinates are used and addr is kept as informational only.

dimensions

object

Physical dimensions of the parcel.

weight

object

Weight of the parcel.

delivery_from

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_to

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.

price

object

Price information for the parcel, used in cash-on-delivery scenarios.

Responses

401

Unauthorized. Missing or invalid authentication token.

429

Too many requests. This API is rate limited per account and per endpoint. A 429 is an expected condition rather than a failed request: back off and retry it. The limits are not the same for every endpoint and can change, so handle the status instead of hard-coding a rate. See the Limits and reliability guide.

200Parcel updated successfully.

400Bad request. One or more fields failed validation.

403This parcel does not belong to your account.

409The parcel cannot be updated in its current state.

422Unprocessable entity. The request is well-formed but contains semantic errors.