refresh_label

Refresh the shipping label for a shipment.

The right tool when the label is missing, expired, or needs to be regenerated — for example, after a parcel-dimension change, or when the original label URL has expired.

Parameters

Name	Type	Required	Description
tenantId	string	Yes	The tenant.
shipment_id	string	Yes	Carriyo shipment ID or partner_shipment_reference.

When to use

• The label URL returned at confirm time has expired.
• The label is missing entirely (carrier-side glitch).
• Parcel dimensions or weights changed and a new label is needed.
• Diagnosing whether label generation works after a carrier-side fix (re-trigger and check).

Example agent prompts

"The label for SHP-12345 won't open — refresh it."

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

The response includes the new label URL.

Related tools

• get_shipment — fetch the current label URL after refresh.
• reprocess_shipment — if label generation keeps failing, the shipment may need resubmitting entirely.

Notes

• Some carriers re-charge for label regeneration. Others don't. Check carrier-specific behaviour if cost matters.
• Label URLs typically expire after a configurable window (per tenant settings). Refreshing extends that window.