Get Order by ID - Zid Docs

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

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Single Order

application/json

Body

Example

{
    "status": "object",
    "order": {
        "id": 44834593,
        "code": "dyV6hS0VZi",
        "store_id": 3,
        "order_url": "https://osama.zid.store/o/dyV6hS0VZi/inv",
        "store_name": "Elite Backpacks",
        "shipping_method_code": "zid_app_market.2159",
        "store_url": "https://osama.zid.store/",
        "order_status": {
            "name": "جديد",
            "code": "new"
        },
        "currency_code": "KWD",
        "customer": {
            "id": 2083543,
            "name": "AbdulrhmanEssa",
            "email": "abdulrhmanaissa@hotmail.com",
            "mobile": "966550448447",
            "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": "0.00000000000000",
        "order_total_string": "0.000 KWD",
        "has_different_transaction_currency": true,
        "transaction_reference": null,
        "transaction_amount": 0,
        "transaction_amount_string": "0.00 SAR",
        "issue_date": "05-12-2024 | 03:27 م",
        "payment_status": "paid",
        "is_potential_fraud": false,
        "source": "المتجر الإلكتروني",
        "source_code": "catalog",
        "is_reseller_transaction": false,
        "created_at": "2024-12-05 12:27:15",
        "updated_at": "2024-12-05 12:27:22",
        "is_on_demand": false,
        "tags": [],
        "requires_shipping": true,
        "should_merchant_set_shipping_method": false,
        "shipping": {
            "method": {
                "id": 613287,
                "name": "أرابيكسا",
                "code": "zid_app_market",
                "estimated_delivery_time": "",
                "icon": "https://media.zid.store/apps/f19ab38d-8f5c-48b2-9124-5577803b9ae7.jpg",
                "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
            },
            "address": {
                "formatted_address": "N/A",
                "street": "",
                "district": "fgf",
                "lat": null,
                "lng": null,
                "short_address": null,
                "meta": null,
                "city": {
                    "id": 365,
                    "name": "أبرق خيطان"
                },
                "country": {
                    "id": 114,
                    "name": "الكويت"
                }
            }
        },
        "payment": {
            "method": {
                "name": "بطاقة مدى البنكية",
                "code": "zidpay",
                "type": "cc",
                "cart_payment_request_token": null,
                "payment_network": "Visa"
            },
            "invoice": [
                {
                    "code": "sub_totals_before_vat",
                    "value": "0.00000000000000",
                    "value_string": "0.000 KWD",
                    "title": "المجموع غير شامل الضريبة"
                },
                {
                    "code": "taxable_amount",
                    "value": "0.00000000000000",
                    "value_string": "0.000 KWD",
                    "title": "المبلغ الخاضع للضريبة"
                },
                {
                    "code": "vat",
                    "value": "0.00000000000000",
                    "value_string": "0.000 KWD",
                    "title": "ضريبة القيمة المضافة (12%)"
                },
                {
                    "code": "sub_totals_after_vat",
                    "value": "0.00000000000000",
                    "value_string": "0.000 KWD",
                    "title": "مجموع المنتجات شامل ضريبة القيمة المضافة"
                },
                {
                    "code": "total",
                    "value": "0.00000000000000",
                    "value_string": "0.000 KWD",
                    "title": "المجموع الكلي"
                }
            ]
        },
        "cod_confirmed": false,
        "reverse_order_label_request": null,
        "customer_note": "",
        "gift_message": null,
        "payment_link": null,
        "weight": 0,
        "weight_cost_details": [],
        "currency": {
            "order_currency": {
                "id": 5,
                "code": "KWD",
                "exchange_rate": 0.307533
            },
            "order_store_currency": {
                "id": 4,
                "code": "SAR",
                "exchange_rate": 3.757626
            }
        },
        "coupon": null,
        "products": [
            {
                "id": "ea9f6732-81fe-488a-b8ac-2dbbcba505ca",
                "parent_id": null,
                "parent_name": null,
                "product_class": null,
                "name": "hh",
                "short_description": null,
                "sku": "Z.3.1726750799757576",
                "barcode": null,
                "custom_fields": [],
                "quantity": 1,
                "weight": null,
                "is_taxable": true,
                "is_discounted": false,
                "meta": null,
                "is_external_product": false,
                "net_price_with_additions": 0,
                "net_price_with_additions_string": "0.000 KWD",
                "price_with_additions": 0,
                "price_with_additions_string": "0.000 KWD",
                "net_price": 0,
                "net_price_string": "0.000 KWD",
                "net_sale_price": null,
                "net_sale_price_string": null,
                "net_additions_price": 0,
                "net_additions_price_string": null,
                "gross_price": 0,
                "gross_price_string": "0.000 KWD",
                "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,
                "tax_percentage": 0.12,
                "tax_amount": "0.00000000000000",
                "tax_amount_string": "0.000 KWD",
                "tax_amount_string_per_item": "0.000 KWD",
                "price": 0,
                "price_string": "0.000 KWD",
                "additions_price": 0,
                "additions_price_string": "0.000 KWD",
                "total": 0,
                "total_string": "0.000 KWD",
                "images": [
                    {
                        "id": "static",
                        "origin": "https://media.zid.store/static/missing_image.png",
                        "thumbs": {
                            "fullSize": "https://media.zid.store/static/missing_image.png",
                            "thumbnail": "https://media.zid.store/static/missing_image.png",
                            "small": "https://media.zid.store/static/missing_image.png",
                            "medium": "https://media.zid.store/static/missing_image.png",
                            "large": "https://media.zid.store/static/missing_image.png"
                        }
                    }
                ],
                "options": []
            }
        ],
        "products_count": 1,
        "products_sum_total_string": "0.000 KWD",
        "language": "ar",
        "histories": [
            {
                "order_status_id": 1,
                "order_status_name": "جديد",
                "changed_by_id": 2083543,
                "changed_by_type": "عميل",
                "changed_by_details": {
                    "action": "تم إنشاء الطلب .",
                    "by": "AbdulrhmanEssa",
                    "comment": ""
                },
                "comment": "تم إنشاء الطلب .",
                "created_at": "2024-12-05 12:27:15",
                "humanized_created_at": "منذ يومين"
            }
        ],
        "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": 0,
        "delivered_at": null,
        "is_marketplace_order": false,
        "invoice_link": "https://zid-testing-907587157081.s3-accelerate.amazonaws.com/pdf/order_44834593.pdf",
        "previous_order": 44827595,
        "next_order": null,
        "invoice_settings": {
            "is_order_notifications_enabled": true
        }
    },
    "message": {
        "type": "object",
        "code": null,
        "name": null,
        "description": null
    }
}