mark_ready_to_ship

Move a shipment into the ready-to-ship workflow. This is a business action, not a generic manual status update — it may trigger carrier or collection processing.

The right tool when warehouse / fulfillment has finished prep and the shipment is now physically ready for the carrier to collect.

Parameters

Name	Type	Required	Description
tenantId	string	Yes	The tenant.
shipment_id	string	Yes	Carriyo shipment ID or partner_shipment_reference.
ready_to_ship_date	string	Yes	ISO 8601 date-time when the shipment became ready to ship.
suppress_communication	boolean	No	Suppress customer communication triggered by this transition.
collection	object	No	Optional collection schedule override.
parcels	array	No	Optional parcel overrides to send with the ready-to-ship request.

Update fields

Pass update fields at the top level. Typical optional fields:

• Reference numbers from the warehouse system.
• Final parcel dimensions / weights once measured.
• Pickup-window adjustments.

For your tenant's exact shape, inspect the schema once via a test call or check the Dashboard's "Mark ready to ship" form.

Example agent prompts

"Warehouse has finished SHP-12345 — mark it ready to ship."

mark_ready_to_ship(
  tenantId="…",
  shipment_id="SHP-12345",
  ready_to_ship_date="2026-05-29T10:00:00+04:00",
  parcels=[{ "description": "Box 1" }]
)

Why not update_shipment_status?

update_shipment_status is an administrative override and bypasses the workflow. mark_ready_to_ship is the business action — it triggers the right carrier-side processing, notifications, and rule evaluation that the lifecycle expects. Always prefer this tool over manual status manipulation.

Related tools

• update_shipment_status — the override; only use when this tool can't.
• schedule_collection — often follows mark-ready, especially for on-demand carriers.
• refresh_label — useful if parcel dimensions change at this point and the label needs to be regenerated.