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

curl --location --request GET 'https://api.zid.sa/v1v1/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'

{ "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." } }

Request

Query Params

payload_type

array[string]

optional

A query parameter that specifies the type and amount of data returned in the response for the "List of Orders" endpoint. To retrieve a list of orders with essential product information (product ID, name, SKU, price, and quantity) included in the response, it is recommended to set payload_type to 'default'.

Example:

[""]

page

number

required

pagination, number of page for every call

per_page

number

required

number of records for every page with max 100 records

order_status

enum<string>

optional

Filter by one of the allowed values

Allowed values:

newpreparingreadyindeliverydeliveredcanceled

Example:

new

payment_method

enum<string>

optional

Filter by payment method

Allowed values:

zid_codzid_bank_transferzid_copzid_credit_card

Example:

zid_cod

customer_id

number

optional

Enter the customer's id to retrieve only respective orders

date_from

string

optional

example: '2020-01-01T00:00:00.000+0000'

date_to

string

optional

example: '2020-01-01T00:00:00.000+0000'

sort_by

enum<string>

optional

Sort result in a specific order

Allowed values:

ascdesc

Example:

asc

shipping_method

enum<string>

optional

The selected method for delivering the order.

Allowed values:

supports: zid_delivery.option_{id}zid_pickup.option_{id}

order_by

enum<string>

optional

Allowed value:

created_at

customer_phone

string

optional

The phone number of the customer.

Example:

503187421

status

string

optional

Filter by one or multiple of the allowed values.

Examples:

preparingnewready

search_term

string

optional

Natural language lookup through (customer phone, customer email, order code, or customer name).

Example:

966503187421

date_attribute

string

optional

created_at, or updated_at

Example:

updated_at

referer_code

array[string]

optional

Order referer code.

Example:

["","YNPN79LC,string,false,,false,"]

order_id

string

optional

The unique identifier for the order.

Example:

1096,125643,2222

customer_type

string

optional

Individual or business.

Example:

individual

source

enum<string>

optional

order source.

Allowed values:

MazeedMazeed ServicesMerchant AdminOrder ApiStoreStore AppZidPOSOthers

Example:

mazeed

payment_status

string

optional

Indicates the current payment status of the order.

Example:

pending

cashier

string

optional

Filter by cashier id.

Example:

eaef9285-4df8-4300-be1e-079fab62850a

country_code

string

optional

Filter by country code.

Example:

shipping_city

string

optional

Shipping address city id.

Example:

shipping_country

string

optional

Shipping address country id.

transaction_reference

string

optional

List order transaction references.

tags

string

optional

List of order tags ids.

Example:

02b464ec-86aa-453b-9c4e-d9e21b108c0f,string,false,,false,

coupon_id

string

optional

The ID of the applied coupon.

Example:

231

sku

string

optional

Any of the order's product sku.

Example:

ProductSku122

is_gift_order

boolean

optional

Indicates if the order is a gift.

Default:

false

Header Params

Authorization

string

required

The Authorization token is a unique key given to the third-party application (Partner) by Zid. It is used to authenticate the API requests made by the Partner application. The token verifies the partner's identity and ensures they have permission to access Zid's API but does not provide any specific user or store information. It should be included in the header of API requests when the partner application needs to access Zid's API.

Example:

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

X-Manager-Token

string

required

This token is used to authenticate and access information related to the store. It is obtained through an OAuth mechanism and is required to perform operations on the store's data. The X-Manager-Token should be included in the header of API requests that require store-related information.

Example:

eyJpdiI6Imh3L2dGbmJmRnVCOUY4WW5WQ2s3RFE9PSIsInZhbHVlIjoiZklpRnJyVGV1OWcrZUJBNk44bVp5SjZzSS92V3czcTJjbnJ2dFYvenZ3SFBtWHNSMFU3ZEMzZ0ZJNnpucVE4Ui9rNFdicUduOGpKUlg1VXdGOFFIaVUzZjZyUUZybWx3R0tNY3orUmxoUUUxQ29wSkEyVDZTVnVYb2dlUXJSVzBYVkdESjBpS0xiN05Hbndzc2wzV2N0YitGM1NEdkk4ckZZOTZsTFdEL1ZQRlJJTE5FQmttZng2elpwL1RCeXFRdUd1U3JTc0FHV1kySS80RFJaWlIyZ3gwM2FsQVRFbkt3VWtFOUQyKzdGOD0iLCJtYWMiOiJmZDQ0YzM4ODE0OWQxOWRhYWU0NDhhYmIzYzQ1MDAxMDAzODZjZGM3ZGM4NGJhMGNkMDEyYWZlM2UzYjAxMTI4IiwidGFnIjoiIn0=

Accept-Language

enum<string>

optional

Preferred language for the response. Defaults to en if not specified.

Allowed values:

enar

Example:

Role

string

optional

Role of the user.

Example:

Manager

Access-token

string

optional

Authenticates the user or app for API requests. Required for authorized access.

Example:

yJpdiI6InBndDUxUG4xRFV6WHFZcWQ2a2ZsNGc9PSIsInZhbHVlIjoiZ1Z4VXhPMWozMVcvbUxiNUxMazNMcWgyeUtVZWRaWW1EaU5lRWg2dGEveWhRd20vWUl0bTB2alNrQ3c4dlJKcGZRcHB1Wkh2RmFFVENKaXphTWY1UGIxamMwVDJGSEgyaVlhdDQyay85UWRON0hSQ0ZQdmk0VjJ2c25mUTAvWE1FM3RYZnpHQnRtSEhmTHAycjlWVWhHS1FlWmJWVWlZbUhXYUNZeWJibkhJd0ZTb1E0U0pHT21ITm5RRTAwSWsrb2pNSm1IQUJPc0cwTlNkYWFISkx3bThKdjBTUGs5WWVPcUx2NG01MmVsTT0iLCJtYWMiOiI5OGFmNzFlYzhlMmFjMGU4ZWVjNGVhNDAxMmI1ZDc5NjcxYmJkYjBjNzc1MWU0Yjg0ODc3OWI0Yzk4ZGEwMDc0IiwidGFnIjoiIn0=

X-session-token

string

optional

Tracks and validates the user’s current session with the API.

Example:

wmVsua03dQonE4gACytqKXFj6dm06vzdxkVEQypu

Responses

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

application/json

Body

status

string

optional

The status of the response.

Example:

object

orders

array [object {35}]

optional

A list of orders.

integer

optional

The unique identifier for the order.

Example:

25304285

code

string

optional

The code associated with the order.

Example:

8OVNEhyqcf

store_id

integer

optional

The unique identifier for the store where the order was placed.

Example:

251073

order_url

string

optional

The URL link to the order's invoice.

Example:

https://zid.store/osama/o/6IJWXOYLuR/inv

store_name

string

optional

The name of the store.

Example:

Osama's Store

shipping_method_code

string

optional

The code representing the shipping method used for the order.

Example:

custom

store_url

string

optional

The URL link to the store.

Example:

https://zid.store/osama/

order_status

object

optional

Status of the order.

currency_code

string

optional

The code representing the currency used for the order.

Example:

KWD

is_marketplace_order

boolean

optional

The is_marketplace_order property indicates whether the order originates from a marketplace. When set to true, it signifies that the order was placed through a third-party marketplace platform rather than directly through the store's website.

Default:

false

customer

object

optional

has_different_consignee

boolean

optional

Indicates if the consignee is different from the customer.

Default:

false

is_guest_customer

boolean

optional

Indicates if the order was placed by a guest customer.

Default:

false

is_gift_order

boolean

optional

Indicates if the order is a gift.

Default:

false

gift_card_details

null

optional

Details of any gift card associated with the order.

is_quick_checkout_order

boolean

optional

order_total

string

optional

The total amount of the order.

Example:

6.00000000000000

order_total_string

string

optional

The total amount of the order in a human-readable format.

Example:

6.00 KWD

has_different_transaction_currency

boolean

optional

Indicates if the transaction currency is different from the order currency.

Default:

true

transaction_reference

string | null

optional

The reference number for the transaction.

Example:

TRN-123456

transaction_amount

integer

optional

The amount of the transaction.

Example:

transaction_amount_string

string

optional

The amount of the transaction in a human-readable format.

Example:

60.00 SAR

issue_date

string

optional

The date and time when the order was issued.

Example:

04-07-2023 | 12:12 م

payment_status

string

optional

The payment status of the order.

paid: Payment has successfully completed.

pending: Payment is still pending or hasn't been made yet.

refunded: Payment has been refunded to the Customer.

voided: Payment has been voided or canceled.

Example:

paid

source

enum<string>

optional

The human-readable name indicating the source where the order was created. This field is localized and provides a description of the sale channel, e.g., "Store" or "المتجر الإلكتروني".

Allowed values:

MazeedMazeed ServicesMerchant AdminOrder ApiStoreStore AppZidPOSOthers

Example:

Store

source_code

string

optional

The code indicating the source or channel of the order. This can be one of several predefined values:

pos: Point of Sale (typically used in physical stores).

catalog: Order was made through a product catalog or online storefront.

md. Order was made from the Merchant Dashboard.

mazeed_marketplace: Order was made through Mazeed.

mazeed: Order was made at the Merchant's Store, but the Customer was redirected from Mazeed to the Merchant's Store.

mobile_app: Order was made through the store's mobile application.

api: Order was made through an API call, typically from third-party integrations or apps.

Example:

catalog

is_reseller_transaction

boolean

optional

Indicates if the order was made by a reseller intending to sell the products to end consumers, rather than for personal use.

Default:

false

created_at

string

optional

The date and time when the order was created.

Example:

2023-07-04 09:12:36

updated_at

string

optional

The date and time when the order was last updated.

Example:

2023-07-04 09:14:28