Choose your path
Single Business — You operate one store and your API key belongs directly to that business. No merchant routing is needed. Company Integrator — You run a multi-tenant platform (e.g. an e-commerce SaaS) where multiple merchants ship through your integration. One API key serves all merchants; you identify each one per-request withX-Merchant-Id.
API keys are shown once. When a Now Shipping admin creates your API key, the full
nsk_live_... string is displayed one time only. Copy it to a secrets manager immediately — it cannot be recovered after you close the creation dialog. If you lose it, you must revoke the old key and issue a new one.Company integrators: your single
nsk_live_... API key serves all merchants on your platform. Include the X-Merchant-Id header on every order and pickup request to route it to the correct merchant. Omitting it on a company key returns 400 MERCHANT_REQUIRED.Single Business
If your account is a standard single-business account, the workflow is straightforward:GET /delivery-zones— Fetch the zone catalog and build your address picker fromgovernorates[].areas[].valuePOST /fees/calculate— Optionally preview the shipping fee before creating the orderPOST /orders— Create the order; the response contains the server-computedorderFeesGET /orders/{orderNumber}/awb— Download the AWB shipping label PDF (A4 or A5)POST /pickups— Schedule a courier pickup at your address
X-Merchant-Id on any of these requests.
Company Integrator (Multi-Tenant)
This is the primary path for platform integrators. Your API key operates on behalf of many merchant sub-accounts. IncludeX-Merchant-Id on every order and pickup request to route it to the correct merchant.
Next steps
Now that you have a working flow, explore the full reference documentation to handle edge cases and advanced scenarios:
- Authentication — key rotation, scopes, and the
/pinghealth check - Multi-Tenant Model — deeper explanation of
X-Merchant-Idrouting, accepted identifier formats, and company account architecture - Error Reference — all error codes, HTTP statuses, and a troubleshooting checklist for the most common failures
