ship

Get pickup options

See whether a carrier can collect a bought label's package from its "from" address in a time window, and what it costs (a USPS pickup is free); free and nothing is booked -- schedule_pickup does that.

post/v1/pickups/options

Request

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

Request body

shipment_idstring required

The label to be picked up. The pickup is at that label's "from" address.

earlieststring required

Start of the pickup window, ISO with offset, e.g. "2026-09-24T09:00:00-05:00".

lateststring required

End of the window, same format. USPS picks up on the next delivery day inside it.

instructionsstring

Optional, for the carrier: where the package will be, e.g. "on the front porch".

Response

Success.

pickup_idstring required

Opaque id, "pu_...". Pass it to schedule_pickup.

expires_atstring date-time required

Changes

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