Schedule Collection

This endpoint is considered optional for carriers. If the carrier does not support collection scheduling, you may choose to skip implementing this endpoint.

Carriyo employs the schedule collection endpoint to facilitate carrier pick-up arrangements for a designated shipment.

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

  • Shipment tracking number
  • Scheduled date and time slot

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

The carrier will respond with a unique pickup id.

Securityapi-key or OAuth2
Request
path Parameters
tracking-number
required
string
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

Responses
200

OK

400

Error

post/shipments/{tracking-number}/schedule-collection
Request samples
application/json
{
  • "scheduled_from": "2019-08-24T14:15:22Z",
  • "scheduled_to": "2019-08-24T14:15:22Z"
}
Response samples
application/json
{
  • "pickup_id": "pickup-id-1"
}