Skip to main content
Use this endpoint to retrieve the complete details of a single pickup by its pickupNumber. The response includes the full pickup object along with the selectedPickupAddress block, giving you the exact address the courier will visit. You receive the pickupNumber in the response of POST /pickups.

Authentication

All requests require a valid API key. Company account keys must also include the X-Merchant-Id header.
X-Merchant-Id accepts your businessAccountCode (8-digit), externalMerchantId, or MongoDB _id. Single-business keys do not require this header.

Path parameter

string
required
The 6-digit pickup number returned when the pickup was created (e.g. 482917).

Example request

Response

A successful request returns HTTP 200 with the full pickup object and the linked address details.
boolean
true on success.
object

Error responses