Manifest

This is an optional endpoint for the carrier. If manifesting is not supported by the carrier, then the implementation of this endpoint can be skipped.

Carriyo employs the manifest endpoint to facilitate generation of manifests for designated shipments. The shipments included in the manifest will share a common pickup location and a scheduled pickup date.

In the request, Carriyo includes essential manifest details, encompassing:

  • Shipment tracking numbers
  • Scheduled date and time slot
  • Pickup Location

In response to this request, the carrier will provide a unique pickup identifier for the manifest.

Securityapi-key or OAuth2
Request
Request Body schema: application/json
required
scheduled_from
required
string <date-time>

Date in ISO 8601 format. Example: 2020-09-03T17:07:05.000Z

scheduled_to
required
string <date-time>

Date in ISO 8601 format. Example: 2020-09-03T17:07:05.000Z

tracking_numbers
required
Array of strings
Responses
200

OK

400

Error

post/shipments/manifest
Request samples
application/json
{
  • "scheduled_from": "2019-08-24T14:15:22Z",
  • "scheduled_to": "2019-08-24T14:15:22Z",
  • "tracking_numbers": [
    ]
}
Response samples
application/json
{
  • "pickup_id": "pickup-id-1"
}