The store API: read one order with all its fields
The reference for the single-order address of the ArabyBot store API: every order field, a full example response, and the refusals.
On this page 7
The short answer
A GET request to the orders address followed by the order number returns the whole order: its status, the payment method and payment status, the amounts from subtotal, discount, shipping and VAT to the total, the customer and their phone, the shipping address, the tracking details, the order's source, and the items with each line's price and quantity. It is the same shape that arrives in the store's webhooks.
Also asked as: «اجيب بيانات طلب معين من المتجر بالكود» · «get one order via store api»
The address and authentication
GET https://app.arabybot.com/store_api/v1/orders/{number} Send the store key in the header Authorization: Bearer abst_… or X-Api-Key. You create the key in the store settings; it is shown once and sees only its own store. This address accepts a read key or a write key.
The fields
number(required) The order number at the end of the address, as the customer sees it.
An example request
cURL
curl https://app.arabybot.com/store_api/v1/orders/1042 \ -H "Authorization: Bearer abst_YOUR_STORE_KEY"
PHP
$ch = curl_init('https://app.arabybot.com/store_api/v1/orders/1042');
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => ['Authorization: Bearer abst_YOUR_STORE_KEY'],
]);
$answer = json_decode(curl_exec($ch), true);
$status = curl_getinfo($ch, CURLINFO_RESPONSE_CODE);
curl_close($ch); Python
import requests
r = requests.get(
'https://app.arabybot.com/store_api/v1/orders/1042',
headers={
"Authorization": "Bearer abst_YOUR_STORE_KEY",
},
timeout=30,
)
print(r.status_code, r.json()) Node.js
// Node.js 18+
const r = await fetch('https://app.arabybot.com/store_api/v1/orders/1042', {
headers: {"Authorization": "Bearer abst_YOUR_STORE_KEY"},
});
console.log(r.status, await r.json());
The response
200
{ "ok": true, "order": {
"id": 9041, "number": "1042", "status": "confirmed", "cancel_reason": null,
"payment_method": "cod", "payment_status": "…", "currency": "EGP",
"subtotal": 480.0, "discount": 0.0, "shipping": 50.0, "fee": 0.0, "vat": 0.0,
"total": 530.0, "refunded": 0.0, "coupon": null, "note": null, "tags": null,
"customer": { "name": "…", "phone": "+2010XXXXXXXX" },
"shipping_address": { "country": "EG", "region": "…", "city": "…", "address": "…", "pickup": false },
"gift": null, "delivery_slot": null,
"tracking": { "carrier": null, "number": null, "url": null },
"source": { "utm_source": null, "utm_campaign": null, "ref": null },
"items": [ { "product_id": 88, "variant_id": 301, "name": "…", "variant": "…", "sku": "…",
"qty": 2, "returned_qty": 0, "unit_price": 240.0, "line_total": 480.0, "uploads": [] } ],
"created_at": "2026-11-16 18:04:10", "confirmed_at": "2026-11-16 18:20:02",
"shipped_at": null, "delivered_at": null
} } - Money is always a decimal number, and the currency is in
currency. statusis one of: new, confirmed, preparing, shipped, delivered, returned, cancelled.- The customer's phone is in international format with a leading +, and
itemsholds each line with its price, its quantity and what was returned of it. - The same shape arrives in the store's webhooks, so you write its parsing once.
The refusals
Every refusal comes back as JSON with "ok": false and the code in error:
- 404
not_found: No order with this number in this store. - 401
unauthorized: The key is missing, wrong or revoked. - 402
store_plan_closed: The store plan has ended; renew it. - 429: More than 120 requests in a minute.
- 500
server_error: A failure on our side; try again.
The limits
120 requests a minute from one IP address; passing that returns status 429. A store can have up to five keys. A key sees only its own store, and the store's plan must be active.
All store API addresses · All APIs for developers
Frequently asked questions
Do the customer's phone and address come back?
Yes, because the key is your own store's key. So guard it as you guard your customers' data, and revoke any key you no longer use.
Which number do I ask with: the internal id or the visible number?
With the number the customer sees, the number field. The id field is an internal number returned for reference only.
Read next
Try the agent before you pay anything
The agent that will answer your customers is the one answering you now: ask it from the chat button here or on WhatsApp. Your account is free with no credit card, and the free trial on your own number or page is activated after you contact our team on customer-service WhatsApp.