Themes built on the Twig templating engine are now deprecated and require migration to Vitrin to ensure continued support and compatibility with Zid.
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.orders.read
- Orders Readcurl --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'
{
"status": "success",
"order": {
"id": 56367672,
"invoice_number": 56367672,
"code": "IVqoTjb06Y",
"store_id": 1052373,
"order_url": "https://ahrltf.zid.store/o/IVqoTjb06Y/inv",
"store_name": "testing store v1",
"shipping_method_code": "pickup",
"store_url": "https://ahrltf.zid.store/",
"order_status": {
"name": "تجهيز",
"code": "preparing"
},
"display_status": {
"id": 2,
"code": "preparing",
"color": "#f39c12",
"name": "تجهيز"
},
"currency_code": "KWD",
"customer": {
"id": 12033548,
"name": "عميل جديد",
"email": "newcut@mail.com",
"mobile": "966554123547",
"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": "6.99552940862940",
"order_total_string": "6.996 KWD",
"has_different_transaction_currency": false,
"transaction_reference": null,
"transaction_amount": 86.25000000000033,
"transaction_amount_string": "86.25 SAR",
"issue_date": "25-08-2025 | 02:55 م",
"payment_status": "pending",
"is_potential_fraud": false,
"source": "لوحة التحكم",
"source_code": "md",
"is_reseller_transaction": false,
"created_at": "2025-08-25 11:55:46",
"updated_at": "2025-09-03 21:40:01",
"is_on_demand": false,
"import_id": null,
"tags": [],
"requires_shipping": true,
"should_merchant_set_shipping_method": false,
"shipping": {
"method": {
"id": 720481,
"name": "استلام من فرع وازن",
"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": "2614 Hisham Ibn Abd Al Malek, Al Mursilat, Riyadh 12463, Saudi Arabia",
"lat": 24.74722871149374,
"lng": 46.68292172901006
},
"courier": null,
"return_shipment": null,
"packages_count": 1
},
"address": {
"formatted_address": "N/A",
"street": "شارع 7",
"district": "حي سسسسس",
"lat": 0,
"lng": 0,
"short_address": null,
"meta": null,
"city": {
"id": 71,
"name": "جدة"
},
"country": {
"id": 184,
"name": "السعودية"
}
}
},
"payment": {
"method": {
"name": "دفع عند الاستلام",
"code": "zid_cop",
"type": "zid_cop"
},
"invoice": [
{
"code": "sub_totals_before_vat",
"value": "6.08306905098210",
"value_string": "6.083 KWD",
"title": "المجموع غير شامل الضريبة"
}
]
},
"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": 5,
"code": "KWD",
"exchange_rate": 0.30434
},
"order_store_currency": {
"id": 5,
"code": "KWD",
"exchange_rate": 0.30434
}
},
"coupon": null,
"products": [
{
"id": "3e98ba3f-3fac-446a-ab56-4b0a9a473ab2",
"order_product_id": 97203647,
"parent_id": null,
"parent_name": null,
"product_class": null,
"name": "سبكترا -رضاعة PA سعة 160مل",
"short_description": null,
"sku": "0240091TWO",
"barcode": null,
"custom_fields": [],
"quantity": 1,
"weight": null,
"is_taxable": true,
"is_discounted": false,
"meta": null,
"is_external_product": false,
"discounts": [],
"net_price_with_additions": 6.0830690509821,
"net_price_with_additions_string": "6.083 KWD",
"price_with_additions": 6.9955294086294,
"price_with_additions_string": "6.996 KWD",
"net_price": 6.0830690509821,
"net_price_string": "6.083 KWD",
"net_sale_price": null,
"net_sale_price_string": null,
"net_additions_price": 0,
"net_additions_price_string": null,
"gross_price": 6.9955294086294,
"gross_price_string": "6.996 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,
"discount_percentage": 0,
"tax_percentage": 0.15,
"tax_amount": "0.91246035764731",
"tax_amount_string": "0.912 KWD",
"tax_amount_string_per_item": "0.910 KWD",
"discounted_tax_amount": 0.912,
"discounted_tax_amount_string": "0.912 KWD",
"discounted_tax_amount_string_per_item": "0.912 KWD",
"price": 6.9955294086294,
"price_string": "6.996 KWD",
"additions_price": 0,
"additions_price_string": "0.000 KWD",
"total": 6.9955294086294,
"total_string": "6.996 KWD",
"discounted_total": 6.992,
"discounted_total_string": "6.992 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": "6.996 KWD",
"language": "ar",
"histories": [
{
"order_status_id": 2,
"order_status_name": "جاري التجهيز",
"changed_by_id": 1105039,
"changed_by_type": "تاجر",
"changed_by_details": {
"action": "تم تغيير حالة الطلب إلى \"جاري التجهيز\"",
"by": "testing store v1",
"comment": null
},
"comment": "تم تغيير حالة الطلب إلى \"جاري التجهيز\"",
"created_at": "2025-09-03 21:40:01",
"humanized_created_at": "منذ أسبوع"
}
],
"is_reactivated": false,
"return_policy": null,
"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-platform.s3-accelerate.amazonaws.com/public/pdfs/1052373/orders/invoices/order_confirmation_56367672.pdf",
"payment_network": null,
"previous_order": 56365861,
"next_order": null,
"invoice_settings": {
"is_order_notifications_enabled": true
}
},
"message": {
"type": "info",
"code": "ORDER_NOT_FOUND",
"name": null,
"description": "The requested order ID does not exist."
}
}