List of Orders
GET
https://api.zid.sa/v1/managers/store/orders
Orders
Use this endpoint to retrieve a list of orders filtered by specific parameters.
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.Request
Query Params
payload_type
array[string]
optional
Example:
[""]
page
number
required
per_page
number
required
order_status
enum<string>
optional
Allowed values:
newpreparingreadyindeliverydeliveredcanceled
Example:
new
payment_method
enum<string>
optional
Allowed values:
zid_codzid_bank_transferzid_copzid_credit_card
Example:
zid_cod
customer_id
number
optional
date_from
string
optional
date_to
string
optional
sort_by
enum<string>
optional
Allowed values:
ascdesc
Example:
asc
shipping_method
enum<string>
optional
Allowed values:
supports: zid_delivery.option_{id}zid_pickup.option_{id}
order_by
enum<string>
optional
Allowed value:
created_at
customer_phone
string
optional
Example:
503187421
status
string
optional
Examples:
preparingnewready
search_term
string
optional
Example:
966503187421
date_attribute
string
optional
Example:
updated_at
referer_code
array[string]
optional
Example:
["","YNPN79LC,string,false,,false,"]
order_id
string
optional
Example:
1096,125643,2222
customer_type
string
optional
Example:
individual
source
enum<string>
optional
Allowed values:
MazeedMazeed ServicesMerchant AdminOrder ApiStoreStore AppZidPOSOthers
Example:
mazeed
payment_status
string
optional
Example:
pending
cashier
string
optional
Example:
eaef9285-4df8-4300-be1e-079fab62850a
country_code
string
optional
Example:
sa
shipping_city
string
optional
Example:
1
shipping_country
string
optional
transaction_reference
string
optional
tags
string
optional
Example:
02b464ec-86aa-453b-9c4e-d9e21b108c0f,string,false,,false,
coupon_id
string
optional
Example:
231
sku
string
optional
Example:
ProductSku122
is_gift_order
boolean
optional
Default:
false
Header Params
Authorization
string
required
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
X-Manager-Token
should be included in the header of API requests that require store-related information.Example:
eyJpdiI6Imh3L2dGbmJmRnVCOUY4WW5WQ2s3RFE9PSIsInZhbHVlIjoiZklpRnJyVGV1OWcrZUJBNk44bVp5SjZzSS92V3czcTJjbnJ2dFYvenZ3SFBtWHNSMFU3ZEMzZ0ZJNnpucVE4Ui9rNFdicUduOGpKUlg1VXdGOFFIaVUzZjZyUUZybWx3R0tNY3orUmxoUUUxQ29wSkEyVDZTVnVYb2dlUXJSVzBYVkdESjBpS0xiN05Hbndzc2wzV2N0YitGM1NEdkk4ckZZOTZsTFdEL1ZQRlJJTE5FQmttZng2elpwL1RCeXFRdUd1U3JTc0FHV1kySS80RFJaWlIyZ3gwM2FsQVRFbkt3VWtFOUQyKzdGOD0iLCJtYWMiOiJmZDQ0YzM4ODE0OWQxOWRhYWU0NDhhYmIzYzQ1MDAxMDAzODZjZGM3ZGM4NGJhMGNkMDEyYWZlM2UzYjAxMTI4IiwidGFnIjoiIn0=
Accept-Language
enum<string>
optional
en
if not specified.Allowed values:
enar
Example:
en
Role
string
optional
Example:
Manager
Access-token
string
optional
Example:
yJpdiI6InBndDUxUG4xRFV6WHFZcWQ2a2ZsNGc9PSIsInZhbHVlIjoiZ1Z4VXhPMWozMVcvbUxiNUxMazNMcWgyeUtVZWRaWW1EaU5lRWg2dGEveWhRd20vWUl0bTB2alNrQ3c4dlJKcGZRcHB1Wkh2RmFFVENKaXphTWY1UGIxamMwVDJGSEgyaVlhdDQyay85UWRON0hSQ0ZQdmk0VjJ2c25mUTAvWE1FM3RYZnpHQnRtSEhmTHAycjlWVWhHS1FlWmJWVWlZbUhXYUNZeWJibkhJd0ZTb1E0U0pHT21ITm5RRTAwSWsrb2pNSm1IQUJPc0cwTlNkYWFISkx3bThKdjBTUGs5WWVPcUx2NG01MmVsTT0iLCJtYWMiOiI5OGFmNzFlYzhlMmFjMGU4ZWVjNGVhNDAxMmI1ZDc5NjcxYmJkYjBjNzc1MWU0Yjg0ODc3OWI0Yzk4ZGEwMDc0IiwidGFnIjoiIn0=
X-session-token
string
optional
Example:
wmVsua03dQonE4gACytqKXFj6dm06vzdxkVEQypu
Request samples
Responses
Modified at 2025-02-18 09:13:57