CAcabify
shipment

Ship the specified parcels.

Marks the given parcels as ready to ship using the specified shipping type.

The available shipping types for your account and location can be retrieved from the GET /v1/shipping_types/available endpoint.

post/v1/parcels/ship

Request

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

Request body

parcel_idsstring[] required

IDs of the parcels to ship.

shipping_type_idstring required

Identifier of the shipping type to use, as returned for the pickup location by GET /v1/shipping_types/available. Opaque and environment-dependent: send it back exactly as it was returned.

pickup_timestring date-time

Desired pickup time. Only applicable for the express modality. Formatted according to RFC 3339, section 5.6.

with_returnboolean

Request a return leg: after the delivery, the rider goes back to the pickup point in the same journey. Returns must be enabled for the shipping type; asking for one on a shipping type without it fails with shipping type not enabled for return.

Example request

{
  "shipping_type_id": "express_default",
  "pickup_time": "2021-12-02T10:12:07.753Z"
}

Response

The shipment was created. The response carries the parcel ids and their tracking URLs. Dispatch happens afterwards: a driver has not been assigned yet, so follow the parcel state to know how the delivery progresses.

shipping_type_idstring required

Identifier of the shipping type used for this shipment.

Example response

{
  "parcels": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "tracking_url": "https://logistics.follow.cabify.com/abcdefghi/e"
    }
  ],
  "shipping_type_id": "express_default"
}

Changes

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