API Documentation
Sign upLogin

Cancel a shipment

post
https://sandbox.api.mothership.com/beta/shipments//cancel

Attempts to cancel the shipment immediately. By default, the request only succeeds when the currently available cancellation path is free. Callers can opt in to paid cancellation by setting acceptFees and optionally supplying a limitAmountCents cap.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Reference number of the shipment to cancel

Body Params

Cancellation request including the required reason and fee acceptance controls

string
enum
required

Reason for cancellation.

Allowed:
boolean
Defaults to false

When true, cancel the shipment even if the currently available cancellation path has a fee. Defaults to false.

≥ 0

Optional maximum fee, in cents, that the caller is willing to pay when acceptFees is true.

Responses

Updated 3 months ago

Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 3 months ago