View Order

Get a specific order by ID. Optionally, when source is provided, the previous_order and next_order fields will be computed among only those orders whose source matches one of the values.

Currency Handling for Orders

When the store currency, order currency, and the currency of the shipping address (for cash on delivery) are different, partners must convert the order total to the appropriate currency. The order details already provide both the currency type and the conversion rate, making it easy to apply the conversion when necessary. This ensures that the correct amount is processed smoothly, even when multiple currencies are involved.

Data Masking for Marketplace Orders
When is_marketplace_order is true, the order is from an external provider, and certain customer information, such as customer.name, customer.email, and customer.phone, will be masked for privacy. For example, names like "John Doe" become "J*** D***", emails are masked as "t***@.", and phone numbers as "***00". Masked data may not follow proper syntax. Additionally, for marketplace orders, customer.phone may be null if not provided.

🔑Scopes

orders.read - Orders Read

curl --location 'https://api.zid.sa/v1/managers/store/orders/68340125/view?source=undefined' \ --header 'Authorization: {{Autherization}}' \ --header 'X-Manager-Token: {{Access-Token}}' \ --header 'Accept-Language: en'

{ "status": "object", "order": { "id": 68340124, "invoice_number": 68340124, "code": "rEXuB20myr", "store_id": 3, "order_url": "https://osama.zid.store/o/rEXuB20myr/inv", "store_name": "متجر أسامة.", "shipping_method_code": "pickup", "store_url": "https://osama.zid.store/", "order_status": { "name": "New", "code": "new" }, "display_status": { "id": 1, "code": "new", "color": "#3498db", "name": "New" }, "currency_code": "EGP", "customer": { "id": 31504, "name": "test user", "email": "test@gmail.com", "mobile": "966333333333", "note": "", "verified": 0, "type": null }, "has_different_consignee": 0, "is_guest_customer": 1, "is_gift_order": 0, "gift_card_details": null, "is_quick_checkout_order": false, "order_total": "6954.63998402370000", "order_total_string": "6,954.64 ج.م", "has_different_transaction_currency": false, "transaction_reference": null, "transaction_amount": 504.0000000000008, "transaction_amount_string": "504.00 SAR", "issue_date": "21-04-2026 | 06:12 م", "payment_status": "pending", "is_potential_fraud": false, "source": "Store", "source_code": "catalog", "is_reseller_transaction": false, "created_at": "2026-04-21 15:12:07", "updated_at": "2026-04-21 15:12:23", "is_on_demand": false, "import_id": null, "tags": [], "requires_shipping": true, "should_merchant_set_shipping_method": false, "shipping": { "method": { "id": 432533, "name": "mall", "code": "pickup", "estimated_delivery_time": null, "icon": "https://media.zid.store/static/delivery.png", "is_system_option": false, "waybill": null, "had_errors_while_fetching_waybill": false, "waybill_tracking_id": null, "has_waybill_and_packing_list": false, "tracking": { "number": null, "status": null, "url": null }, "order_shipping_status": null, "inventory_address": { "street": "RQYA7651, 7651 Wadi Bish, 2339، حي السلي، Riyadh 14263, Saudi Arabia", "lat": 24.66667439068546, "lng": 46.80931091308594 }, "courier": null, "return_shipment": null, "packages_count": null }, "address": { "formatted_address": "RQYA7651, 7651 Wadi Bish, 2339، حي السلي، Riyadh 14263, Saudi Arabia", "street": "RQYA7651, 7651 Wadi Bish, 2339، حي السلي، Riyadh 14263, Saudi Arabia", "district": "", "lat": 24.666674390685, "lng": 46.809310913086, "short_address": "ABCD1234", "meta": { "building_number": "", "postcode": "", "additional_number": "", "city_name": "" }, "city": { "id": 1, "name": "Riyadh" }, "country": { "id": 184, "name": "Saudi Arabia" } } }, "payment": { "method": { "name": "Cash on Pickup", "code": "zid_cop", "type": "zid_cop" }, "invoice": [ { "code": "sub_totals_before_vat", "value": "5795.53332001970000", "value_string": "5,795.53 ج.م", "title": "Total without VAT" }, { "code": "coupon", "value": "-1159.10666400390000", "value_string": "-1,159.11 ج.م", "title": "Coupon" }, { "code": "sub_totals_after_coupon_discount", "value": "4636.42665601580000", "value_string": "4,636.43 ج.م", "title": "Sub Totals after Coupon Discount" }, { "code": "taxable_amount", "value": "4636.42665601580000", "value_string": "4,636.43 ج.م", "title": "Taxable amount" }, { "code": "vat", "value": "2318.21332800790000", "value_string": "2,318.21 ج.م", "title": "VAT (%50)" }, { "code": "sub_totals_after_vat", "value": "6954.63998402370000", "value_string": "6,954.64 ج.م", "title": "Total Inc. VAT" }, { "code": "total", "value": "6954.63998402370000", "value_string": "6,954.64 ج.م", "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": 21, "code": "EGP", "exchange_rate": 51.753464 }, "order_store_currency": { "id": 4, "code": "SAR", "exchange_rate": 3.750553 } }, "coupon": { "code": "3US1YJ", "name": "Discount on specific products - 21/04/2026 17:07", "id": 6204362, "discount": "-1159.1067", "discount_string": "-1,159.11 ج.م" }, "products": [ { "id": "1696a85e-419e-4092-a54d-d4afac8289d6", "order_product_id": 117402431, "parent_id": null, "parent_name": null, "product_class": null, "name": "عطر برادا لا فيم انتنس النسائي - 100 مل", "short_description": { "ar": "استمتعي بلمسة من الجمال والأناقة الخالدة مع عطر برادا لافيم انتنس المركز ، الذي يجسد الأنوثة والتفرد بأسلوبه الراقي.يأتي هذا العطر بتركيبة استثنائية تجمع بين الزهور الرائعة والمكونات الدافئة لتقديم تجربة عطرية مثالية.", "en": "" }, "sku": "Z.217795.16883190964075553", "barcode": null, "custom_fields": [], "quantity": 1, "weight": null, "is_taxable": true, "is_discounted": false, "meta": null, "is_external_product": false, "discounts": { "coupon": { "amount": 1159.107, "percentage": 20.00000579750013, "unit_amount": 1159.107 } }, "net_price_with_additions": 5795.5333200197, "net_price_with_additions_string": "5,795.53 ج.م", "price_with_additions": 6664.8633180227, "price_with_additions_string": "6,664.86 ج.م", "net_price": 6218.6992449736, "net_price_string": "6,218.70 ج.م", "net_sale_price": "5795.53332001970000", "net_sale_price_string": "5,795.53 ج.م", "net_additions_price": 0, "net_additions_price_string": null, "gross_price": 7151.5041317196, "gross_price_string": "7,151.50 ج.م", "gross_sale_price": "6664.86331802270000", "gross_sale_price_string": "6,664.86 ج.م", "price_before": 7151.5041317196, "price_before_string": "7,151.50 ج.م", "total_before": 7151.5041317196, "total_before_string": "7,151.50 ج.م", "gross_additions_price": 0, "gross_additions_price_string": null, "discount_percentage": 0.20000005797499998, "tax_percentage": 0.15, "tax_amount": "869.32999800296000", "tax_amount_string": "869.33 ج.م", "tax_amount_string_per_item": "869.32 ج.م", "discounted_tax_amount": 695.463948002955, "discounted_tax_amount_string": "695.46 ج.م", "discounted_tax_amount_string_per_item": "695.46 ج.م", "price": 6664.8633180227, "price_string": "6,664.86 ج.م", "additions_price": 0, "additions_price_string": "0.00 ج.م", "total": 6664.8633180227, "total_string": "6,664.86 ج.م", "discounted_total": 5331.890268022655, "discounted_total_string": "5,331.89 ج.م", "images": [ { "id": "00af21a4-f2b7-4602-badb-09f8ef79282f", "origin": "https://media.zid.store/thumbs/d297fb8b-c322-412e-a2f4-ffa96dc57022/00af21a4-f2b7-4602-badb-09f8ef79282f-thumbnail-500x500-70.webp", "thumbs": { "fullSize": "https://media.zid.store/d297fb8b-c322-412e-a2f4-ffa96dc57022/00af21a4-f2b7-4602-badb-09f8ef79282f.webp", "thumbnail": "https://media.zid.store/thumbs/d297fb8b-c322-412e-a2f4-ffa96dc57022/00af21a4-f2b7-4602-badb-09f8ef79282f-thumbnail-370x370-70.webp", "small": "https://media.zid.store/thumbs/d297fb8b-c322-412e-a2f4-ffa96dc57022/00af21a4-f2b7-4602-badb-09f8ef79282f-thumbnail-500x500-70.webp", "medium": "https://media.zid.store/thumbs/d297fb8b-c322-412e-a2f4-ffa96dc57022/00af21a4-f2b7-4602-badb-09f8ef79282f-thumbnail-770x770-70.webp", "large": "https://media.zid.store/thumbs/d297fb8b-c322-412e-a2f4-ffa96dc57022/00af21a4-f2b7-4602-badb-09f8ef79282f-thumbnail-1000x1000-70.webp" } } ], "options": [], "inventory_allocations": [] } ], "products_count": 1, "products_sum_total_string": "6,664.86 ج.م", "is_preorder": false, "is_preorder_allocated": true, "language": "ar", "histories": [ { "order_status_id": 1, "order_status_name": "New", "changed_by_id": 8878912, "changed_by_type": "Customer", "changed_by_details": { "action": "Order has been created.", "by": "Guest", "comment": "" }, "comment": "تم إنشاء الطلب .", "created_at": "2026-04-21 15:12:07", "humanized_created_at": "4 days ago" } ], "is_reactivated": false, "return_policy": "ojghwriojgbwriojgwergiou", "packages_count": 1, "inventory_address": { "id": "0bf616e8a3f5491c97b3746ab100eb8c", "name": "مخزون جدة", "city": { "id": 71, "national_id": 18, "name": "Jeddah", "priority": 9, "country_id": 184, "country_name": "Saudi Arabia", "country_code": "SA", "ar_name": "جدة", "en_name": "Jeddah" }, "full_address": "JCHA3867, 3867 Al Hilam, 6825, Al Hamra District, Jeddah 23324, Saudi Arabia", "street": "JCHA3867, 3867 Al Hilam, 6825, Al Hamra District, Jeddah 23324, Saudi Arabia", "short_address": null, "district": "", "postal_code": null, "coordinates": { "lat": 21.53040203157045, "lon": 39.17084954081419 }, "cop_enabled": true, "is_pickup_option": true, "is_zidship_default": false, "working_hours": [] }, "expected_shipping_method_type": null, "reseller_meta": null, "zidship_ticket_number": null, "edits_count": 0, "can_request_order_due_payment": false, "payments": [ { "name": "دفع عند الاستلام", "code": "zid_cop", "type": "checkout", "status": "pending", "amount": 6954.64, "amount_string": "6,954.64 ج.م", "transaction_reference": null, "payment_link": null, "created_at": "2026-04-21 15:12:07" } ], "payment_summary": { "is_multi_payment": false, "total": 6954.6399840237, "total_string": "6,954.64 ج.م", "paid_amount": 0, "paid_amount_string": "0.00 ج.م", "remaining_amount": 6954.6399840237, "remaining_amount_string": "6,954.64 ج.م" }, "delivered_at": null, "is_marketplace_order": false, "invoice_link": "https://zid-platform.s3-accelerate.amazonaws.com/public/pdfs/3/orders/invoices/order_confirmation_68340124.pdf", "payment_network": null, "preorder_campaign": null, "previous_order": 68272057, "next_order": null, "invoice_settings": { "is_order_notifications_enabled": true, "is_zid_invoice_generation_enabled": true } }, "message": { "type": "object", "code": null, "name": null, "description": null } }

Request

Responses