reprocess_shipment

Updated May 19, 20261 min read

Reprocess a shipment in error, cancelled, or returned status. Fetches the current shipment data, deep-merges any provided overrides, and resubmits it.

The right tool when something went wrong and you want to retry with edits — bad address, wrong carrier, missing reference — without having to cancel-and-re-create from scratch.

Parameters

NameTypeRequiredDescription
tenantIdstringYesThe tenant.
shipment_idstringYesCarriyo shipment ID or partner_shipment_reference.
overridesobjectNoShipment fields to override before reprocessing. Deep-merged with the fetched shipment.

When to use vs confirm_shipment vs reassign_shipment

ToolUse when
confirm_shipmentThe shipment is a draft (or recoverable error) and you want to book it as-is or with light edits.
reprocess_shipmentThe shipment failed, was cancelled, or was returned, and you want to resubmit it — possibly with edits. The deep-merge of overrides makes targeted fixes easy.
reassign_shipmentThe carrier is the problem — you want to keep the shipment but route it through a different carrier account.

Example agent prompts

"SHP-12345 errored — the postcode was wrong. Fix it and retry."

reprocess_shipment(
  tenantId="…",
  shipment_id="SHP-12345",
  overrides={ "dropoff": { "postcode": "11564" } }
)

"Reprocess SHP-12345 as-is — Aramex was down earlier, should work now."

reprocess_shipment(
  tenantId="…",
  shipment_id="SHP-12345"
)

Common chain

Diagnose a stuck shipment — the canonical multi-tool flow that often ends in reprocess_shipment.