ship

Schedule a pickup

Book the carrier pickup for one pickup_id and service, with confirm true; CONSEQUENTIAL -- a driver is sent to the address -- and charged only if that option's price_cents is above zero (USPS pickups are free). Sensitive write: it requires the human's approval of the window, address and price. Returns the carrier's confirmation number.

post/v1/pickups

Request

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

Request body

pickup_idstring required
servicestring required

One service from get_pickup_options.

confirmtrue required

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

idempotency_keystring

Use one key per human request. Replays within 24 hours return the original result instead of buying twice.

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.