ship

Cancel a pickup

Cancel a scheduled pickup with confirm true, and refund it in full if it was paid; irreversible, and the driver will not come. Free. Sensitive write: it requires the human's approval to cancel.

post/v1/pickups/{pickup_id}/cancel

Request

  • Base URL: https://api.noerrands.com/c/ship
  • URL: https://api.noerrands.com/c/ship/v1/pickups/{pickup_id}/cancel
  • Auth: HTTP bearer

Path parameters

pickup_idstring required

Request body

pickup_idstring required
confirmtrue required

Must be true. Set it only after the human approved this exact action and price.

Response

Success.

pickup_idstring required
shipment_idstring required
status'quoted' | 'scheduled' | 'cancelled' required
carrierstring
servicestring
confirmationstring

The carrier's confirmation number. Give it to the human.

earlieststring required
lateststring required
credits_charged_centsinteger required
balance_centsinteger required

General credit left.

Changes

No recorded changes to this operation across all 1 revision of this API.