schedule_collection

Set or revise the shipment collection schedule.

The right tool when the carrier needs to know when to pick up — or when the merchant / warehouse wants to change the pickup window.

Parameters

Name	Type	Required	Description
tenantId	string	Yes	The tenant.
shipment_id	string	Yes	Carriyo shipment ID or partner_shipment_reference.
scheduled_date	string	No	Date-only collection schedule.
scheduled_from	string	No	ISO 8601 collection window start.
scheduled_to	string	No	ISO 8601 collection window end.

Schedule fields

Pass at least one schedule field. Two forms supported:

// Single date
{ "scheduled_date": "2026-05-09" }

// Time window
{
  "scheduled_from": "2026-05-09T13:00:00+04:00",
  "scheduled_to":   "2026-05-09T17:00:00+04:00"
}

Which form to use depends on the carrier — most accept either, but some require a window. Test once with the target carrier to confirm.

Example agent prompts

"Schedule collection for SHP-12345 on Saturday."

schedule_collection(
  tenantId="…",
  shipment_id="SHP-12345",
  scheduled_date="2026-05-09"
)

"Push collection to Saturday afternoon, 1pm–5pm UAE time."

schedule_collection(
  tenantId="…",
  shipment_id="SHP-12345",
  scheduled_from="2026-05-09T13:00:00+04:00",
  scheduled_to="2026-05-09T17:00:00+04:00"
)

Related tools

• schedule_delivery — the delivery-side counterpart.
• get_shipment — confirm the shipment is in a state where collection is still being scheduled (not already picked up).