Get Order by ID
GET
https://api.zid.sa/v1v1/managers/store/orders/{order-id}/view
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.Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://api.zid.sa/v1v1/managers/store/orders//view' \
--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;'
Response Response Example
{
"status": "object",
"order": {
"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": "new"
},
"currency_code": "KWD",
"is_marketplace_order": false,
"customer": {
"id": "2083543",
"name": "Osama",
"email": "example.user@email.com",
"mobile": "+966501234567",
"note": "\" \"",
"verified": "1",
"type": "individual"
},
"shipping": {
"method": {
"id": "SHM-123456",
"name": "Express Delivery",
"code": "EXP_DEL",
"estimated_delivery_time": "3-5 Business Days",
"icon": "https://cdn.example.com/icons/shipping/express_delivery.png",
"is_system_option": false,
"waybill": "WB-12345678",
"had_errors_while_fetching_waybill": false,
"waybill_tracking_id": "TRACK-12345678",
"has_waybill_and_packing_list": false,
"tracking": {
"number": "TRACK-12345678",
"status": "In Transit",
"url": "https://example.com/track?number=TRACK-12345678"
},
"order_shipping_status": null,
"inventory_address": [
"[]"
],
"courier": "FedEx",
"return_shipment": "RET-12345678"
},
"address": {
"street": "Masked Street",
"district": "Masked District",
"formatted_address": "Masked Address",
"city": {
"name": "Other",
"id": 1,
"national_id": 3,
"priority": 10,
"country_id": 184,
"country_name": "السعودية",
"country_code": "SA",
"ar_name": "الرياض",
"en_name": "Riyadh"
},
"lat": "24.7136",
"lng": "46.6753",
"short_address": null,
"meta": {
"buyer": {
"name": "Ahmed Al-Saud",
"type": "individual",
"email": "ahmed@example.sa",
"telephone": "966501234567"
}
},
"country": {
"id": 184,
"name": "السعودية",
"code": "SA",
"country_code": "SAU",
"flag": "https://media.zid.store/static/sa.svg"
}
}
},
"products": {
"is_external_product": true,
"id": null,
"parent_id": null,
"parent_name": "سماعات بلوتوث",
"sku": "Z.3.1726750799757576",
"barcode": null,
"custom_fields": [
"[]"
],
"quantity": "2",
"weight": "150",
"net_price_with_additions": "50",
"price_with_additions": "55",
"net_sale_price": null,
"gross_sale_price": null,
"price_before": null,
"total_before": null,
"gross_additions_price": null,
"tax_percentage": "0.12",
"tax_amount_string_per_item": "0.000 KWD",
"images": [
"string"
]
},
"has_different_consignee": false,
"is_guest_customer": false,
"is_gift_order": false,
"gift_card_details": {
"card_design": "Birthday Theme",
"gift_message": "Happy Birthday, Ahmed! Wishing you all the best.",
"media_link": "https://example.com/gift_card_image.jpg",
"receiver_name": "Ahmed Al-Salem",
"sender_name": "Fatima Al-Rashed"
},
"is_quick_checkout_order": false,
"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",
"is_potential_fraud": false,
"payment_status_change": {
"old": "paid",
"new": "paid"
},
"source": "Mazeed",
"source_code": "pos",
"is_reseller_transaction": false,
"created_at": "2023-07-04 09:12:36",
"updated_at": "2023-07-04 09:14:28",
"is_on_demand": false,
"tags": [
"string"
],
"requires_shipping": true,
"should_merchant_set_shipping_method": false,
"payment": {
"method": {
"id": 1,
"enabled": true,
"code": "zid_cod",
"fees": 5,
"fees_string": "5.00 SAR",
"type": "zid_cod",
"cart_payment_request_token": null,
"payment_network": "visa",
"name": {
"en": "Cash on Delivery",
"ar": "الدفع عند الاستلام"
},
"icon": "https://example.com/payment-icon.png"
},
"invoice": [
{
"code": "sub_totals",
"value": "30.00000000000000",
"value_string": "30.00 SAR",
"title": "قيمة المنتجات"
}
]
},
"cod_confirmed": false,
"reverse_order_label_request": null,
"customer_note": "أحتاج تغليف هدية",
"gift_message": "كل عام وأنتم بخير",
"payment_link": "https://payment.example.sa/order/123456",
"weight": 500,
"weight_cost_details": {
"weight_total": 150,
"weight_total_string": "150 gm",
"cost": "1.000 KWD",
"cost_string": "1 KWD"
},
"currency": {
"order_currency": {
"id": 4,
"code": "SAR",
"exchange_rate": 1
},
"order_store_currency": {
"id": 4,
"code": "SAR",
"exchange_rate": null
}
},
"options": [
"[]"
],
"coupon": "SUMMER20",
"products_count": 1,
"products_sum_total_string": "30.00 SAR",
"language": "ar",
"histories": [
{
"order_status_id": 1,
"order_status_name": "جديد",
"changed_by_id": 37,
"changed_by_type": "عميل",
"changed_by_details": {
"action": "تم إنشاء الطلب .",
"by": "Ahmed Al-Saud",
"comment": "Manually created after size-change request. Check inventory."
},
"comment": "تم إنشاء الطلب .",
"created_at": "2023-07-04 09:12:36",
"humanized_created_at": "منذ شهر"
}
],
"is_reactivated": false,
"return_policy": "Returns are accepted within 14 days of receipt.",
"packages_count": 1,
"inventory_address": "123 King Fahd Road, Al Olaya, Riyadh 12212, Saudi Arabia",
"expected_shipping_method_type": null,
"reseller_meta": null,
"zidship_ticket_number": null,
"edits_count": "0",
"delivered_at": null,
"invoice_link": "https://zid-testing-907587157081.s3-accelerate.amazonaws.com/pdf/order_44834593.pdf",
"previous_order": 23874634,
"next_order": null,
"invoice_settings": {
"is_order_notifications_enabled": true
},
"comment": "This is a VIP customer. Handle with extra care."
},
"message": {
"type": "object",
"code": "200",
"name": "Success",
"description": "Order details retrieved successfully."
}
}
Request
Path Params
order-id
number
required
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