Themes built on the Twig templating engine are now deprecated and require migration to Vitrin to ensure continued support and compatibility with Zid.
- Start Here 🚀
- Overview to Zid Apps
- Authorization
- Responses
- Webhooks
- Rate Limiting
- APIs
- Orders
- Reverse Orders
- Abandoned Carts
- Products
- Inventories
- Shipping
- Marketing
- Gift Cards
- Coupons
- Bundle Offers
- Loyalty Program
- Calculate Loyalty Points for Order
- Retrieve Store Loyalty Status
- Activate Loyalty Program
- Retrieve Loyalty Program Status
- Set Points Expiration Rules
- Update Cashback Rule
- Update Cashback Rule Status
- Create Points Redemption Method
- Update Points Redemption Method
- Delete Points Redemption Method
- Update Redemption Method Status
- Retrieve Customer Loyalty Summary
- List Loyalty Data
- List Customer Points History
- Retrieve Manager Loyalty Info Page
- Update Loyalty Info Page
- Adjust Customer Points
- Customers
- Store Settings
- Countries and Cities
- Webhook
- Orders
- Store Events
Change Order Status
POST
https://api.zid.sa/v1/managers/store/orders/{order-id}/change-order-status
inventory_address_id value with your request, hence shipping companies need to know which pickup point to get the package from. To get a list of your current inventory addresses along with their ids, please check the inventory addresses API endpoint.
accepts a custom status code in addition to predefined codes.🔑 Scopes
orders.read_write - Orders Read & Write🔑 Permission
can:orders.status.changeRequest
Path Params
Header Params
Body Params multipart/form-data
Request Code Samples
Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api.zid.sa/v1/managers/store/orders/64086815/change-order-status' \
--header 'Authorization: {{Autherization}}' \
--header 'Accept: application/json' \
--header 'Accept-Language: en' \
--header 'X-MANAGER-TOKEN: {{Access-Token}}' \
--form 'order_status="new"' \
--form 'inventory_address_id=""' \
--form 'tracking_number=""' \
--form 'tracking_url=""' \
--form 'waybill_url=""'Responses
🟢200OK
application/json
Body
Example
{
"status": "object",
"order": {
"id": 59214748,
"invoice_number": 59214748,
"code": "AIajhbzS7h",
"store_id": 3,
"order_url": "https://osama.zid.store/o/AIajhbzS7h/inv",
"store_name": "Mohammed Zayan",
"shipping_method_code": "zid_app_market.2323",
"store_url": "https://osama.zid.store/",
"order_status": {
"name": "New",
"code": "new"
},
"display_status": {
"id": 1,
"code": "new",
"color": "#3498db",
"name": "New"
},
"currency_code": "SAR",
"customer": {
"id": 37,
"name": "Osama Khaled",
"email": "osamakhaled2010@gmail.com",
"mobile": "966503187421",
"note": "",
"verified": 1,
"type": "individual"
},
"has_different_consignee": 0,
"is_guest_customer": 0,
"is_gift_order": 0,
"gift_card_details": null,
"is_quick_checkout_order": false,
"order_total": "211.44999892193000",
"order_total_string": "211.45 SAR",
"has_different_transaction_currency": false,
"transaction_reference": null,
"transaction_amount": 211.44999892193,
"transaction_amount_string": "211.45 SAR",
"issue_date": "13-10-2025 | 10:53 ص",
"payment_status": "paid",
"is_potential_fraud": false,
"source": "Store",
"source_code": "catalog",
"is_reseller_transaction": false,
"created_at": "2025-10-13 07:53:13",
"updated_at": "2026-01-21 19:42:31",
"is_on_demand": false,
"import_id": null,
"tags": [],
"requires_shipping": true,
"should_merchant_set_shipping_method": false,
"shipping": {
"method": {
"id": 574614,
"name": "3rd Partner",
"code": "zid_app_market",
"estimated_delivery_time": "",
"icon": "https://media.zid.store/apps/91f12581-2275-481e-9437-da14f6633f4d.png",
"is_system_option": true,
"waybill": null,
"had_errors_while_fetching_waybill": false,
"waybill_tracking_id": null,
"has_waybill_and_packing_list": false,
"tracking": {
"number": null,
"status": "N/A",
"url": null
},
"order_shipping_status": null,
"inventory_address": [],
"courier": null,
"return_shipment": null,
"packages_count": null
},
"address": {
"formatted_address": "N/A",
"street": "معسكر",
"district": "حي قرطبة",
"lat": 24.689511223385,
"lng": 46.747750939148,
"short_address": "",
"meta": {
"building_number": "73829",
"postcode": "",
"additional_number": "",
"city_name": ""
},
"city": {
"id": 1,
"name": "Riyadh"
},
"country": {
"id": 184,
"name": "Saudi Arabia"
}
}
},
"payment": {
"method": {
"name": "Bank Transfer",
"code": "zid_bank_transfer",
"type": "zid_bank_transfer",
"transaction_status": "transfered",
"transaction_status_name": "Confirmed",
"transaction_bank": null,
"transaction_slip": null,
"transaction_sender_name": null,
"updated_at": "2026-01-21 14:59:24"
},
"invoice": [
{
"code": "sub_totals_before_vat",
"value": "180.86956427994000",
"value_string": "180.87 SAR",
"title": "Total without VAT"
},
{
"code": "shipping",
"value": "3.00000000000000",
"value_string": "3.00 SAR",
"title": "Shipping"
},
{
"code": "taxable_amount",
"value": "183.86956427994000",
"value_string": "183.87 SAR",
"title": "Taxable amount"
},
{
"code": "vat",
"value": "27.58043464199100",
"value_string": "27.58 SAR",
"title": "VAT (%15)"
},
{
"code": "sub_totals_after_vat",
"value": "211.44999892193000",
"value_string": "211.45 SAR",
"title": "Total Inc. VAT"
},
{
"code": "total",
"value": "211.44999892193000",
"value_string": "211.45 SAR",
"title": "Total"
}
]
},
"cod_confirmed": false,
"reverse_order_label_request": null,
"reverse_order_label_requests": [],
"customer_note": "",
"gift_message": null,
"payment_link": null,
"weight": 0,
"weight_cost_details": [],
"currency": {
"order_currency": {
"id": 4,
"code": "SAR",
"exchange_rate": 1
},
"order_store_currency": {
"id": 4,
"code": "SAR",
"exchange_rate": null
}
},
"coupon": null,
"products": [
{
"id": "f28e9f26-4a9e-4159-bc50-d128ebe41d34",
"order_product_id": 109627161,
"parent_id": null,
"parent_name": null,
"product_class": null,
"name": "ايلف - برايمر ومرطب للوجه 24مل",
"short_description": {
"ar": "برايمر ايلف جل لتحضير البشرة قبل المكياج",
"en": "برايمر ايلف جل لتحضير البشرة قبل المكياج"
},
"sku": "glow12",
"barcode": null,
"custom_fields": [],
"quantity": 1,
"weight": null,
"is_taxable": true,
"is_discounted": false,
"meta": null,
"is_external_product": false,
"discounts": [],
"net_price_with_additions": 52.17391277306,
"net_price_with_additions_string": "52.17 SAR",
"price_with_additions": 59.999999689019,
"price_with_additions_string": "60.00 SAR",
"net_price": 52.17391277306,
"net_price_string": "52.17 SAR",
"net_sale_price": null,
"net_sale_price_string": null,
"net_additions_price": 0,
"net_additions_price_string": null,
"gross_price": 59.999999689019,
"gross_price_string": "60.00 SAR",
"gross_sale_price": null,
"gross_sale_price_string": null,
"price_before": null,
"price_before_string": null,
"total_before": null,
"total_before_string": null,
"gross_additions_price": 0,
"gross_additions_price_string": null,
"discount_percentage": 0,
"tax_percentage": 0.15,
"tax_amount": "7.82608691595900",
"tax_amount_string": "7.83 SAR",
"tax_amount_string_per_item": "7.82 SAR",
"discounted_tax_amount": 7.826086915959,
"discounted_tax_amount_string": "7.83 SAR",
"discounted_tax_amount_string_per_item": "7.83 SAR",
"price": 59.999999689019,
"price_string": "60.00 SAR",
"additions_price": 0,
"additions_price_string": "0.00 SAR",
"total": 59.999999689019,
"total_string": "60.00 SAR",
"discounted_total": 59.999999689019006,
"discounted_total_string": "60.00 SAR",
"images": [
{
"id": "29cde990-c04a-4fb0-a69c-7b132cd9f843",
"origin": "https://media.zid.store/thumbs/d297fb8b-c322-412e-a2f4-ffa96dc57022/29cde990-c04a-4fb0-a69c-7b132cd9f843-thumbnail-500x500-70.jpg",
"thumbs": {
"fullSize": "https://media.zid.store/d297fb8b-c322-412e-a2f4-ffa96dc57022/29cde990-c04a-4fb0-a69c-7b132cd9f843.jpg",
"thumbnail": "https://media.zid.store/thumbs/d297fb8b-c322-412e-a2f4-ffa96dc57022/29cde990-c04a-4fb0-a69c-7b132cd9f843-thumbnail-370x370-70.jpg",
"small": "https://media.zid.store/thumbs/d297fb8b-c322-412e-a2f4-ffa96dc57022/29cde990-c04a-4fb0-a69c-7b132cd9f843-thumbnail-500x500-70.jpg",
"medium": "https://media.zid.store/thumbs/d297fb8b-c322-412e-a2f4-ffa96dc57022/29cde990-c04a-4fb0-a69c-7b132cd9f843-thumbnail-770x770-70.jpg",
"large": "https://media.zid.store/thumbs/d297fb8b-c322-412e-a2f4-ffa96dc57022/29cde990-c04a-4fb0-a69c-7b132cd9f843-thumbnail-1000x1000-70.jpg"
}
}
],
"options": []
},
{
"id": "b655986a-777d-4875-9560-63fe7367ddee",
"order_product_id": 109627162,
"parent_id": null,
"parent_name": null,
"product_class": null,
"name": "زيت رغوي لتنظيف البشرة ليف 77 من انوا 200مل",
"short_description": {
"ar": "زيت لتنظيف البشرة والمسام من انوا.....",
"en": "زيت لتنظيف البشرة والمسام من انوا....."
},
"sku": "Glow.1023",
"barcode": null,
"custom_fields": [],
"quantity": 1,
"weight": null,
"is_taxable": true,
"is_discounted": false,
"meta": null,
"is_external_product": false,
"discounts": [],
"net_price_with_additions": 69.565217030747,
"net_price_with_additions_string": "69.57 SAR",
"price_with_additions": 79.999999585359,
"price_with_additions_string": "80.00 SAR",
"net_price": 69.565217030747,
"net_price_string": "69.57 SAR",
"net_sale_price": null,
"net_sale_price_string": null,
"net_additions_price": 0,
"net_additions_price_string": null,
"gross_price": 79.999999585359,
"gross_price_string": "80.00 SAR",
"gross_sale_price": null,
"gross_sale_price_string": null,
"price_before": null,
"price_before_string": null,
"total_before": null,
"total_before_string": null,
"gross_additions_price": 0,
"gross_additions_price_string": null,
"discount_percentage": 0,
"tax_percentage": 0.15,
"tax_amount": "10.43478255461200",
"tax_amount_string": "10.43 SAR",
"tax_amount_string_per_item": "10.43 SAR",
"discounted_tax_amount": 10.434782554612049,
"discounted_tax_amount_string": "10.43 SAR",
"discounted_tax_amount_string_per_item": "10.43 SAR",
"price": 79.999999585359,
"price_string": "80.00 SAR",
"additions_price": 0,
"additions_price_string": "0.00 SAR",
"total": 79.999999585359,
"total_string": "80.00 SAR",
"discounted_total": 79.99999958535903,
"discounted_total_string": "80.00 SAR",
"images": [
{
"id": "9e083823-24b9-4096-a93d-b4060dc2ff83",
"origin": "https://media.zid.store/thumbs/d297fb8b-c322-412e-a2f4-ffa96dc57022/9e083823-24b9-4096-a93d-b4060dc2ff83-thumbnail-500x500.png",
"thumbs": {
"fullSize": "https://media.zid.store/d297fb8b-c322-412e-a2f4-ffa96dc57022/9e083823-24b9-4096-a93d-b4060dc2ff83.png",
"thumbnail": "https://media.zid.store/thumbs/d297fb8b-c322-412e-a2f4-ffa96dc57022/9e083823-24b9-4096-a93d-b4060dc2ff83-thumbnail-370x370.png",
"small": "https://media.zid.store/thumbs/d297fb8b-c322-412e-a2f4-ffa96dc57022/9e083823-24b9-4096-a93d-b4060dc2ff83-thumbnail-500x500.png",
"medium": "https://media.zid.store/thumbs/d297fb8b-c322-412e-a2f4-ffa96dc57022/9e083823-24b9-4096-a93d-b4060dc2ff83-thumbnail-770x770.png",
"large": "https://media.zid.store/thumbs/d297fb8b-c322-412e-a2f4-ffa96dc57022/9e083823-24b9-4096-a93d-b4060dc2ff83-thumbnail-1000x1000.png"
}
}
],
"options": []
},
{
"id": "2a39d7b8-8d9d-4040-b636-ab9a085b540d",
"order_product_id": 109627163,
"parent_id": null,
"parent_name": null,
"product_class": null,
"name": "ماء تونر جينسينغ من بيوتي اوف جوسون",
"short_description": {
"ar": "ماء التونر الذي يحتوي على خلاصة الجينسينغ من بيوتي أو جوسون يعد منتجًا فعالًا لعناية البشرة.....",
"en": "ماء التونر الذي يحتوي على خلاصة الجينسينغ من بيوتي أو جوسون يعد منتجًا فعالًا لعناية البشرة....."
},
"sku": "glow1114",
"barcode": null,
"custom_fields": [],
"quantity": 1,
"weight": null,
"is_taxable": true,
"is_discounted": false,
"meta": null,
"is_external_product": false,
"discounts": [],
"net_price_with_additions": 59.130434476135,
"net_price_with_additions_string": "59.13 SAR",
"price_with_additions": 67.999999647555,
"price_with_additions_string": "68.00 SAR",
"net_price": 59.130434476135,
"net_price_string": "59.13 SAR",
"net_sale_price": null,
"net_sale_price_string": null,
"net_additions_price": 0,
"net_additions_price_string": null,
"gross_price": 67.999999647555,
"gross_price_string": "68.00 SAR",
"gross_sale_price": null,
"gross_sale_price_string": null,
"price_before": null,
"price_before_string": null,
"total_before": null,
"total_before_string": null,
"gross_additions_price": 0,
"gross_additions_price_string": null,
"discount_percentage": 0,
"tax_percentage": 0.15,
"tax_amount": "8.86956517142020",
"tax_amount_string": "8.87 SAR",
"tax_amount_string_per_item": "8.86 SAR",
"discounted_tax_amount": 8.86956517142025,
"discounted_tax_amount_string": "8.87 SAR",
"discounted_tax_amount_string_per_item": "8.87 SAR",
"price": 67.999999647555,
"price_string": "68.00 SAR",
"additions_price": 0,
"additions_price_string": "0.00 SAR",
"total": 67.999999647555,
"total_string": "68.00 SAR",
"discounted_total": 67.99999964755526,
"discounted_total_string": "68.00 SAR",
"images": [
{
"id": "ffe37efb-2e27-4002-9175-9f764687f9a7",
"origin": "https://media.zid.store/thumbs/d297fb8b-c322-412e-a2f4-ffa96dc57022/ffe37efb-2e27-4002-9175-9f764687f9a7-thumbnail-500x500-70.jpg",
"thumbs": {
"fullSize": "https://media.zid.store/d297fb8b-c322-412e-a2f4-ffa96dc57022/ffe37efb-2e27-4002-9175-9f764687f9a7.jpg",
"thumbnail": "https://media.zid.store/thumbs/d297fb8b-c322-412e-a2f4-ffa96dc57022/ffe37efb-2e27-4002-9175-9f764687f9a7-thumbnail-370x370-70.jpg",
"small": "https://media.zid.store/thumbs/d297fb8b-c322-412e-a2f4-ffa96dc57022/ffe37efb-2e27-4002-9175-9f764687f9a7-thumbnail-500x500-70.jpg",
"medium": "https://media.zid.store/thumbs/d297fb8b-c322-412e-a2f4-ffa96dc57022/ffe37efb-2e27-4002-9175-9f764687f9a7-thumbnail-770x770-70.jpg",
"large": "https://media.zid.store/thumbs/d297fb8b-c322-412e-a2f4-ffa96dc57022/ffe37efb-2e27-4002-9175-9f764687f9a7-thumbnail-1000x1000-70.jpg"
}
}
],
"options": []
}
],
"products_count": 3,
"products_sum_total_string": "208.00 SAR",
"language": "ar",
"histories": [
{
"order_status_id": 1,
"order_status_name": "New",
"changed_by_id": 3,
"changed_by_type": "Merchant",
"changed_by_details": {
"action": "Comment added",
"by": "Osama",
"comment": "Customer asked to delay shipment by one day"
},
"comment": "Comment added",
"created_at": "2026-01-26 09:51:50",
"humanized_created_at": "2 days ago"
},
{
"order_status_id": 1,
"order_status_name": "New",
"changed_by_id": 3,
"changed_by_type": "Merchant",
"changed_by_details": {
"action": "Comment added",
"by": "Osama",
"comment": "Customer asked to delay shipment by one day"
},
"comment": "Comment added",
"created_at": "2026-01-26 09:48:58",
"humanized_created_at": "2 days ago"
},
{
"order_status_id": 1,
"order_status_name": "New",
"changed_by_id": 3,
"changed_by_type": "Merchant",
"changed_by_details": {
"action": "Order has been updated.",
"by": "Osama",
"comment": ""
},
"comment": "تم تعديل الطلب .",
"created_at": "2026-01-21 19:42:31",
"humanized_created_at": "6 days ago"
},
{
"order_status_id": 1,
"order_status_name": "New",
"changed_by_id": 3,
"changed_by_type": "Merchant",
"changed_by_details": {
"action": "Order has been updated.",
"by": "Osama",
"comment": ""
},
"comment": "تم تعديل الطلب .",
"created_at": "2026-01-21 19:42:06",
"humanized_created_at": "6 days ago"
},
{
"order_status_id": 1,
"order_status_name": "New",
"changed_by_id": 3,
"changed_by_type": "Merchant",
"changed_by_details": {
"action": "Order has been updated.",
"by": "Osama",
"comment": ""
},
"comment": "تم تعديل الطلب .",
"created_at": "2026-01-21 19:41:16",
"humanized_created_at": "6 days ago"
},
{
"order_status_id": 1,
"order_status_name": "New",
"changed_by_id": 3,
"changed_by_type": "Merchant",
"changed_by_details": {
"action": "Order has been updated.",
"by": "Osama",
"comment": ""
},
"comment": "تم تعديل الطلب .",
"created_at": "2026-01-21 15:00:19",
"humanized_created_at": "1 week ago"
},
{
"order_status_id": 1,
"order_status_name": "New",
"changed_by_id": 3,
"changed_by_type": "Merchant",
"changed_by_details": {
"action": "Confirmation of bank transfer payment",
"by": "Osama",
"comment": ""
},
"comment": "تأكيد دفع الحواله البنكية",
"created_at": "2026-01-21 14:59:25",
"humanized_created_at": "1 week ago"
},
{
"order_status_id": 1,
"order_status_name": "New",
"changed_by_id": 3,
"changed_by_type": "Merchant",
"changed_by_details": {
"action": "Order invoice sent",
"by": "Osama",
"comment": ""
},
"comment": "تم ارسال فاتورة الطلب",
"created_at": "2026-01-21 14:59:25",
"humanized_created_at": "1 week ago"
},
{
"order_status_id": 1,
"order_status_name": "New",
"changed_by_id": 3,
"changed_by_type": "Merchant",
"changed_by_details": {
"action": "Order has been updated.",
"by": "Osama",
"comment": ""
},
"comment": "تم تعديل الطلب .",
"created_at": "2026-01-21 14:59:11",
"humanized_created_at": "1 week ago"
},
{
"order_status_id": 1,
"order_status_name": "New",
"changed_by_id": 3,
"changed_by_type": "Merchant",
"changed_by_details": {
"action": "Order has been updated.",
"by": "Osama",
"comment": ""
},
"comment": "تم تعديل الطلب .",
"created_at": "2026-01-21 14:57:12",
"humanized_created_at": "1 week ago"
},
{
"order_status_id": 1,
"order_status_name": "New",
"changed_by_id": 3,
"changed_by_type": "Merchant",
"changed_by_details": {
"action": "Order has been exported.",
"by": "Osama",
"comment": ""
},
"comment": "تم تصدير الطلب .",
"created_at": "2025-10-27 11:05:56",
"humanized_created_at": "3 months ago"
},
{
"order_status_id": 1,
"order_status_name": "New",
"changed_by_id": 3,
"changed_by_type": "Merchant",
"changed_by_details": {
"action": "Order has been exported.",
"by": "Osama",
"comment": ""
},
"comment": "تم تصدير الطلب .",
"created_at": "2025-10-27 11:05:22",
"humanized_created_at": "3 months ago"
},
{
"order_status_id": 1,
"order_status_name": "New",
"changed_by_id": 3,
"changed_by_type": "Merchant",
"changed_by_details": {
"action": "Order has been exported.",
"by": "Osama",
"comment": ""
},
"comment": "Order has been exported.",
"created_at": "2025-10-26 13:33:21",
"humanized_created_at": "3 months ago"
},
{
"order_status_id": 1,
"order_status_name": "New",
"changed_by_id": 3,
"changed_by_type": "Merchant",
"changed_by_details": {
"action": "Order has been exported.",
"by": "Osama",
"comment": ""
},
"comment": "Order has been exported.",
"created_at": "2025-10-26 13:32:37",
"humanized_created_at": "3 months ago"
},
{
"order_status_id": 1,
"order_status_name": "New",
"changed_by_id": 3,
"changed_by_type": "Merchant",
"changed_by_details": {
"action": "Order has been exported.",
"by": "Osama",
"comment": ""
},
"comment": "Order has been exported.",
"created_at": "2025-10-26 07:48:52",
"humanized_created_at": "3 months ago"
},
{
"order_status_id": 1,
"order_status_name": "New",
"changed_by_id": 3,
"changed_by_type": "Merchant",
"changed_by_details": {
"action": "Order has been exported.",
"by": "Osama",
"comment": ""
},
"comment": "Order has been exported.",
"created_at": "2025-10-26 07:46:05",
"humanized_created_at": "3 months ago"
},
{
"order_status_id": 1,
"order_status_name": "New",
"changed_by_id": 3,
"changed_by_type": "Merchant",
"changed_by_details": {
"action": "Order has been exported.",
"by": "Osama",
"comment": ""
},
"comment": "Order has been exported.",
"created_at": "2025-10-26 07:45:45",
"humanized_created_at": "3 months ago"
},
{
"order_status_id": 1,
"order_status_name": "New",
"changed_by_id": 3,
"changed_by_type": "Merchant",
"changed_by_details": {
"action": "Order has been exported.",
"by": "Osama",
"comment": ""
},
"comment": "Order has been exported.",
"created_at": "2025-10-26 07:44:39",
"humanized_created_at": "3 months ago"
},
{
"order_status_id": 1,
"order_status_name": "New",
"changed_by_id": 3,
"changed_by_type": "Merchant",
"changed_by_details": {
"action": "Order has been exported.",
"by": "Osama",
"comment": ""
},
"comment": "تم تصدير الطلب .",
"created_at": "2025-10-25 16:47:31",
"humanized_created_at": "3 months ago"
},
{
"order_status_id": 1,
"order_status_name": "New",
"changed_by_id": 37,
"changed_by_type": "Customer",
"changed_by_details": {
"action": "Order has been created.",
"by": "Osama Khaled",
"comment": ""
},
"comment": "تم إنشاء الطلب .",
"created_at": "2025-10-13 07:53:13",
"humanized_created_at": "3 months ago"
}
],
"is_reactivated": false,
"return_policy": "ojghwriojgbwriojgwergiou",
"packages_count": 1,
"inventory_address": null,
"expected_shipping_method_type": null,
"reseller_meta": null,
"zidship_ticket_number": null,
"edits_count": 7,
"delivered_at": null,
"is_marketplace_order": false,
"invoice_link": null,
"payment_network": null
},
"message": {
"type": "object",
"code": "MSG_HIDDEN",
"name": "Orders",
"description": "Order status has been changed successfully"
}
}🟠401Unauthorized
🟠403Permission Denied
🟠400Bad Request
Modified at 2026-01-28 17:14:33