The store API: add the carrier and tracking number to an order
The reference for the tracking address of the ArabyBot store API: the three fields, the response, and the refusals.
On this page 7
The short answer
With a POST request to the tracking address under the order number, carrying the carrier's name, the tracking number and the tracking link if there is one, with a key that has write access. The tracking is saved on the order and the response returns the updated order. The tracking link must start with http or https.
Also asked as: «اضيف رقم التتبع للطلب من شركة الشحن بالكود» · «add tracking number to order api»
The address and authentication
POST https://app.arabybot.com/store_api/v1/orders/{number}/tracking Send the store key in the header Authorization: Bearer abst_… or X-Api-Key. This address changes data, so it needs a key with write access; a read key is refused with status 403. You create the key in the store settings.
The fields
carrier(optional) The carrier's name.number(optional) The tracking or waybill number.url(optional) The link of the tracking page, starting with http or https.
An example request
cURL
curl -X POST https://app.arabybot.com/store_api/v1/orders/1042/tracking \
-H "Authorization: Bearer abst_YOUR_WRITE_KEY" \
-H "Content-Type: application/json" \
-d '{ "carrier": "Aramex", "number": "AWB123456789", "url": "https://example.com/track/AWB123456789" }' PHP
$ch = curl_init('https://app.arabybot.com/store_api/v1/orders/1042/tracking');
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_POST => true,
CURLOPT_HTTPHEADER => ['Authorization: Bearer abst_YOUR_WRITE_KEY', 'Content-Type: application/json'],
CURLOPT_POSTFIELDS => json_encode([
'carrier' => 'Aramex',
'number' => 'AWB123456789',
'url' => 'https://example.com/track/AWB123456789',
]),
]);
$answer = json_decode(curl_exec($ch), true);
$status = curl_getinfo($ch, CURLINFO_RESPONSE_CODE);
curl_close($ch); Python
import requests
r = requests.post(
'https://app.arabybot.com/store_api/v1/orders/1042/tracking',
headers={
"Authorization": "Bearer abst_YOUR_WRITE_KEY",
},
json={
"carrier": "Aramex",
"number": "AWB123456789",
"url": "https://example.com/track/AWB123456789",
},
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/tracking', {
method: 'POST',
headers: {"Authorization": "Bearer abst_YOUR_WRITE_KEY", "Content-Type": "application/json"},
body: JSON.stringify({
"carrier": "Aramex",
"number": "AWB123456789",
"url": "https://example.com/track/AWB123456789"
}),
});
console.log(r.status, await r.json());
The response
200
{ "ok": true, "order": { "number": "1042", "status": "shipped",
"tracking": { "carrier": "Aramex", "number": "AWB123456789", "url": "https://example.com/track/AWB123456789" }, "…": "…" } } - This address only saves the tracking details; changing the status to shipped has its own address.
The refusals
Every refusal comes back as JSON with "ok": false and the code in error:
- 403
read_only_key: The key can read only; create a key with write access in the store settings. - 422
bad_url: The tracking link is not a valid address starting with http or https. - 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
Does adding tracking change the order's status to shipped?
No. This address only saves the carrier, the number and the link. Change the status with the order status address.
Are all three fields required?
No. Send what you have of them. The link, if sent, must be a valid address.
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.