List of Orders - Zid Docs

Orders can be created either by the customers from the storefronts or by the merchants from their dashboard.
Use this endpoint to retrieve a list of orders filtered by specific parameters.

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

curl --location --request GET 'https://api.zid.sa/v1/managers/store/orders?payload_type=&page=&per_page=&order_status=&payment_method=&customer_id=&date_from=&date_to=&sort_by=&shipping_method=&order_by=&customer_phone=503187421&status=&search_term=966503187421&date_attribute=updated_at&referer_code=&referer_code=YNPN79LC,string,false,,false,&order_id=1096,125643,2222&customer_type=individual&source=mazeed&payment_status=pending&cashier=eaef9285-4df8-4300-be1e-079fab62850a&country_code=sa&shipping_city=1&shipping_country=&transaction_reference=&tags=02b464ec-86aa-453b-9c4e-d9e21b108c0f,string,false,,false,&coupon_id=231&sku=ProductSku122&is_gift_order=' \
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiIxMTciLCJqdGkiOiJhMTg5ZTg3MmYxMzhkMWVhYjU5MjVkMDkyMGE5NmI0YjliNjg0Y2E2ZTdmM2M2MjljZWYxNmQ4NDJjMmJlYmVhMjI4YTdmMTA0ZWQ4NWE5NCIsImlhdCI6MTY3OTU3Njk5OS41NjY4NzcsIm5iZiI6MTY3OTU3Njk5OS41NjY4OCwiZXhwIjoxNzExMTk5Mzk5LjQ4NjE1Mywic3ViIjoiMTgyNDc1Iiwic2NvcGVzIjpbInRoaXJkLXBhcnRpZXMtYXBpcyJdfQ.i07ef09nVNXGZF-g-QXpNoS2vlFQK_zntAqAMS4Az2XD2EyMLhxLZZRL-QlR11zUPqMmXjMAl_4ooKa3M3zkfZQ6Ga6qStvamk8RnC_39VUx0lfN2A4k65ERZpqwrMy6-t3dE99zay3aicIdNvbgi0zeuMSE5Tn99u-2AtSRa8ffbfAcYPPXacHrhdmlYzdiZS_x_skovFEow1E-nDjdL1WHqO92XdZ7RfNLkiYFTjZlZmM_UruvioaR3q6TXJbqRK_ZrziivezL8ohIQ2SBosUp58I29rlKzvlw_R2j0rKKYZbdxYDaxAHOISmOFKAlO66k7dNevAHI3s4uGIjoGA6ZXHknccWPLLLiaAQ0r64HV8GowW5dg2rhZNurJGDTnLlBQ6F-ql42ptHzSAfzzi576CEoN3gMVpgXcbntUY3reETkFsTBPUjeSuMpANMioXAA0GRp3Ut-84fTnrWxqsCW1WVUIx33HvmfCGPXIdkaCCWoA6G6KXo04MtFbKXQmXkK9esQWI-rqdVnMD3zSR3g3yFHZSL1U-mZeNja03706Rav1ordsRNOtRwtLuoRRbk9KasbUpEwqq4Ao9lqZZwRIjdEw-pQtnUT8V53fhmuuRIefCLFO7eGEtGUnh9o6Uh_pgi6AB6uSlnN9GEMGgI1alqvMmTjxvC-HHt0V-Y' \
--header 'X-Manager-Token: eyJpdiI6Imh3L2dGbmJmRnVCOUY4WW5WQ2s3RFE9PSIsInZhbHVlIjoiZklpRnJyVGV1OWcrZUJBNk44bVp5SjZzSS92V3czcTJjbnJ2dFYvenZ3SFBtWHNSMFU3ZEMzZ0ZJNnpucVE4Ui9rNFdicUduOGpKUlg1VXdGOFFIaVUzZjZyUUZybWx3R0tNY3orUmxoUUUxQ29wSkEyVDZTVnVYb2dlUXJSVzBYVkdESjBpS0xiN05Hbndzc2wzV2N0YitGM1NEdkk4ckZZOTZsTFdEL1ZQRlJJTE5FQmttZng2elpwL1RCeXFRdUd1U3JTc0FHV1kySS80RFJaWlIyZ3gwM2FsQVRFbkt3VWtFOUQyKzdGOD0iLCJtYWMiOiJmZDQ0YzM4ODE0OWQxOWRhYWU0NDhhYmIzYzQ1MDAxMDAzODZjZGM3ZGM4NGJhMGNkMDEyYWZlM2UzYjAxMTI4IiwidGFnIjoiIn0=' \
--header 'Accept-Language;' \
--header 'Role: Manager' \
--header 'Access-token: yJpdiI6InBndDUxUG4xRFV6WHFZcWQ2a2ZsNGc9PSIsInZhbHVlIjoiZ1Z4VXhPMWozMVcvbUxiNUxMazNMcWgyeUtVZWRaWW1EaU5lRWg2dGEveWhRd20vWUl0bTB2alNrQ3c4dlJKcGZRcHB1Wkh2RmFFVENKaXphTWY1UGIxamMwVDJGSEgyaVlhdDQyay85UWRON0hSQ0ZQdmk0VjJ2c25mUTAvWE1FM3RYZnpHQnRtSEhmTHAycjlWVWhHS1FlWmJWVWlZbUhXYUNZeWJibkhJd0ZTb1E0U0pHT21ITm5RRTAwSWsrb2pNSm1IQUJPc0cwTlNkYWFISkx3bThKdjBTUGs5WWVPcUx2NG01MmVsTT0iLCJtYWMiOiI5OGFmNzFlYzhlMmFjMGU4ZWVjNGVhNDAxMmI1ZDc5NjcxYmJkYjBjNzc1MWU0Yjg0ODc3OWI0Yzk4ZGEwMDc0IiwidGFnIjoiIn0=' \
--header 'X-session-token: wmVsua03dQonE4gACytqKXFj6dm06vzdxkVEQypu'

Responses

🟢200list of orders (Filtered as per requested parameters)

application/json

Body

Example

{
    "status": "object",
    "orders": [
        {
            "id": 25304285,
            "code": "8OVNEhyqcf",
            "store_id": 251073,
            "order_url": "https://zid.store/osama/o/6IJWXOYLuR/inv",
            "store_name": "Osama's Store",
            "shipping_method_code": "custom",
            "store_url": "https://zid.store/osama/",
            "order_status": {
                "name": "Delivery in progress",
                "code": "delivered"
            },
            "currency_code": "KWD",
            "is_marketplace_order": false,
            "customer": {
                "id": 0,
                "name": "osama",
                "email": "example.user@email.com",
                "mobile": "+966501234567",
                "verified": 0,
                "note": "string",
                "type": "string"
            },
            "has_different_consignee": false,
            "is_guest_customer": false,
            "is_gift_order": false,
            "gift_card_details": null,
            "is_quick_checkout_order": true,
            "order_total": "6.00000000000000",
            "order_total_string": "6.00 KWD",
            "has_different_transaction_currency": true,
            "transaction_reference": "TRN-123456",
            "transaction_amount": 60,
            "transaction_amount_string": "60.00 SAR",
            "issue_date": "04-07-2023 | 12:12 م",
            "payment_status": "paid",
            "source": "Mazeed",
            "source_code": "catalog",
            "is_reseller_transaction": false,
            "created_at": "2023-07-04 09:12:36",
            "updated_at": "2023-07-04 09:14:28",
            "tags": [
                {}
            ],
            "requires_shipping": true,
            "shipping": {
                "method": {
                    "id": 1,
                    "name": "string",
                    "code": "zid_cod",
                    "estimated_delivery_time": "string",
                    "icon": "string",
                    "is_system_option": true,
                    "waybill": null,
                    "had_errors_while_fetching_waybill": true,
                    "waybill_tracking_id": null,
                    "has_waybill_and_packing_list": true,
                    "tracking": {
                        "number": null,
                        "status": null,
                        "url": null
                    },
                    "order_shipping_status": null,
                    "inventory_address": [
                        {}
                    ],
                    "courier": null,
                    "return_shipment": null,
                    "address": {
                        "street": "king Abdulaziz Road",
                        "district": "Al Olaya District",
                        "formatted_address": "King Abdulaziz Road, Al Olaya District, Riyadh, Saudi Arabia",
                        "city": {
                            "id": "1",
                            "national_id": "3",
                            "name": "other",
                            "priority": "10",
                            "country_id": "184",
                            "country_name": "Saudi Arabia",
                            "country_code": "SA"
                        }
                    }
                }
            },
            "payment": {
                "method": {
                    "name": "string",
                    "code": "zid_cod",
                    "type": "zid_cod",
                    "transaction_status": "string",
                    "transaction_status_name": "string",
                    "payment_network": "visa"
                }
            },
            "cod_confirmed": true,
            "reverse_order_label_request": null
        }
    ],
    "total_order_count": 887,
    "total_order_count_per_status": {
        "new": 323,
        "preparing": 21,
        "indelivery": 88,
        "delivered": 178,
        "cancelled": 135,
        "reversed": 1,
        "ready": 138,
        "reverse_in_progress": 6,
        "partially_reversed": 3,
        "initial": 0
    },
    "tax_settings": [
        {}
    ],
    "storeColors": {
        "btn_default_background_color": "#b053ac",
        "btn_default_text_color": "#ffffff",
        "btn_default_border_color": "#a04b9c",
        "btn_hover_background_color": "#bf5abb",
        "btn_pressed_background_color": "#a04b9c",
        "btn_pressed_text_color": "#ffffff",
        "btn_pressed_border_color": "#a04b9c"
    },
    "printed_invoice_settings": {
        "is_tax_number_active": true,
        "is_return_policy_active": true,
        "is_products_weight_active": true,
        "is_barcode_active": true,
        "is_qr_code_active": true,
        "is_expected_time_active": true,
        "is_store_address_active": true,
        "is_vat_settings_active": true,
        "is_sku_active": true,
        "is_thanks_msg_active": true,
        "is_order_status_active": true,
        "is_discount_coupon_active": true,
        "config_logo": "https://example.com/logo-200x.png",
        "store_business_address": "Example Address, Riyadh, Saudi Arabia",
        "store_business_name": "ExampleStore",
        "store_business_type": "establishment",
        "commercial_number": "1234567890",
        "is_payment_stamp_active": true,
        "is_order_notifications_enabled": true,
        "is_product_description_active": false
    },
    "orders_list_view_settings": {
        "order_number_column": true,
        "customer_column": 0,
        "created_at_column": 1,
        "updated_at_column": 1,
        "source_column": 1,
        "shipping_method_column": 1,
        "payment_method_column": 1,
        "customer_note_column": 1,
        "tags_column": 1,
        "order_status_column": 1,
        "payment_status_column": 1,
        "totals_column": 1,
        "action_buttons": true,
        "all_columns": 0,
        "order_number": 10
    },
    "message": {
        "type": "object",
        "code": "200",
        "name": "Success",
        "description": "Order details retrieved successfully."
    }
}