pickupNumber you use in all subsequent get, update, cancel, and delete requests.
Authentication
All requests require a valid API key. Company account keys must also include theX-Merchant-Id header.
X-Merchant-Id accepts your businessAccountCode (8-digit), externalMerchantId, or MongoDB _id. Single-business keys do not require this header.Request body
number
required
Expected order count for this pickup. Used to compute the pickup fee — provide your best estimate.
string
required
Scheduled pickup date in
YYYY-MM-DD format. Must be a valid future date per the Now Shipping pickup date policy.string
required
Contact phone number for the courier. Must be an 11-digit Egyptian mobile number (e.g.
01012345678).boolean
Set to
true if any items in this pickup are fragile. Defaults to false.boolean
Set to
true if any items are large or oversized. Defaults to false.string
Free-text notes passed to the courier (e.g.
"Call before arrival", "Ring doorbell twice").string
Override the pickup location text displayed to the courier. Defaults to your registered address.
string
Your merchant pickup address ID. When omitted, the pickup defaults to your main registered address.
Example request
Response
A successful request returns HTTP201 with the full pickup object.
boolean
true on success.object
