Recall shipment from carrier

POST /openapi/Shipment/RecallShipment — TMS API · Shipment Update and Cancellation

Recalls a shipment that has been delivered to the carrier (assigned) but not yet dispatched. Use CancelShipmentOnCarrier to delete the shipment record from the carrier.

İstek gövdesi

• clientCode (string, zorunlu): Organization code.
• accountCode (string, zorunlu): Account code.
• shipmentKey (string, zorunlu): ShipmentKey of the shipment to be recalled.

Yanıtlar

• 200: Carrier recall response
• 400: Shipment not found or could not be recalled
• 401: No token, invalid, or expired (empty response).

200 yanıt alanları

• carrierCode (string): Carrier code.
• recallShipmentInfos (object[]): Recall result per shipment.
  • recallShipmentInfos.message (string): Carrier message.
  • recallShipmentInfos.isSuccess (boolean): Was the recall successful.
  • recallShipmentInfos.shipmentId (integer): TMS shipment ID.
  • recallShipmentInfos.trackingNumber (string): Tracking number.