Cancel shipment
Cancels a shipment. Use the cancel payload to mark the shipment as unscheduled so it can be re-shipped via another carrier or a manual method. Use the cancel-and-refund payload to cancel and simultaneously initiate a refund to the original payment instrument or a customer bank account. A cancel-and-refund refunds no more than the order’s payments have left: one asking for more fails with a 400 (refund_amount). It fails with a 409, changing nothing, while refunds are briefly unavailable or the order’s payment is held for an admin’s review. A refund of a cash or other offline payment in the original mode is manual: done at once when the store marks that payment method paid, else pending until an admin marks it paid or forfeits it.
Authorizations
Body
- CancelShipment
- CancelAndRefundShipment
Cancel payload used when no refund is required. The shipment is marked as unscheduled and can be rescheduled with another carrier or fulfilled manually.