POST /pickups or PUT /pickups/{pickupNumber}.
Authentication
All requests require a valid API key. Company account keys must also include theX-Merchant-Id header on every pickup request.
X-Merchant-Id accepts your businessAccountCode (8-digit), externalMerchantId, or MongoDB _id. Single-business keys do not require this header.Request body
number
Expected order count for the pickup. Affects the fee calculation — provide an accurate estimate for the best result.
string
Your merchant pickup address ID. When omitted, the fee is calculated against your default pickup address.
Example request
Response
A successful request returns HTTP200 with a fee in EGP and a reminder note.
boolean
true on success.object
