Themes built on the Twig templating engine are now deprecated and require migration to Vitrin to ensure continued support and compatibility with Zid.
- Start Here 🚀
- Overview to Zid Apps
- Authorization
- Responses
- Webhooks
- Rate Limiting
- APIs
- Orders
- Reverse Orders
- Carts
- Products
- Inventories
- Marketing
- Gift Cards
- Coupons
- Bundle Offers
- Loyalty Program
- Loyalty Program Points per Order
- Store Loyalty Status
- Info Page
- Loyalty Program Activation
- Loyalty Status
- Set Points Expiration
- Cashback Rule Method Update
- Cashback Rule Method Update Status
- Add Points Redemption Method
- Update Points Redemption Method
- Delete Points Redemption Method
- Toggle Redemption Method Status
- Show Loyalty Points Info for Specific Customer
- List Data
- Customer Points History
- Info Page - Managers
- Update Info Page
- Adjust Customer Points
- Customers
- Store Settings
- Countries and Cities
- Webhook
- Orders
- Store Events
Order Creation
POST
https://api.zid.sa/v1/managers/store/drafts
🔑Scopes
Order.create - Permission to create new ordersorders.read_write - Full read & write access to orderspayment link, the following configuration must be added:"payment_link_configs": {
"expiryDateTime": "2024-12-10T13:00:49.947Z"
}
```"
Guide#
1.
order_create scope enabled in your app via the Partner Dashboard.2.
"payment_link.zidpay":{
"id": 239951,
"enabled": true,
"code": "payment_link.zidpay",
"fees": 0,
"fees_string": "0.00 SAR",
"type": "payment_link",
"name": "إرسال رابط دفع",
"icons": ["<https://media.zid.store/static/paymentLink.svg>"]
}
id of this ZidPay option for use in the payment_method field during order creation.3.
Request
Header Params
Body Params application/json
Example
{
"currency_code": "SAR",
"created_by": "partner",
"customer": {
"full_name": "testing",
"mobile_country_code": "971",
"mobile_number": "525440982",
"email": ""
},
"consignee": {
"contact": {
"full_name": "testing",
"mobile_country_code": "971",
"mobile_number": "525440982",
"email": ""
},
"address": {
"line_1": "الكراج",
"line_2": "Building: ١, Floor: ١, Unit: ١",
"city_name": "Riyadh",
"country_code": "SA"
}
},
"is_gift": false,
"is_gifted_consignee_notifiable": false,
"products": [
{
"sku": "Z.617072.2273220000000298134",
"quantity": 1,
"custom_fields": [
{
"price_settings": "a8724cef-022b-4d3e-a913-84693fd3e341",
"group_id": "a8724cef-022b-4d3e-a913-84693fd3e341",
"name": "fieldname",
"value": "ABDELRAHMAN",
"type": "TEXT"
}
]
}
],
"shipping_method": {
"type": "delivery",
"id": 601943
},
"payment_method": {
"id": 854148
}
}Request Code Samples
Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api.zid.sa/v1/managers/store/drafts' \
--header 'Authorization: Authorization: Bearer [your token]' \
--header 'X-MANAGER-TOKEN: X-MANAGER-TOKEN: [your token]' \
--header 'Accept-Language: ar' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data-raw '{
"currency_code": "SAR",
"created_by": "partner",
"customer": {
"full_name": "testing",
"mobile_country_code": "971",
"mobile_number": "525440982",
"email": ""
},
"consignee": {
"contact": {
"full_name": "testing",
"mobile_country_code": "971",
"mobile_number": "525440982",
"email": ""
},
"address": {
"line_1": "الكراج",
"line_2": "Building: ١, Floor: ١, Unit: ١",
"city_name": "Riyadh",
"country_code": "SA"
}
},
"is_gift": false,
"is_gifted_consignee_notifiable": false,
"products": [
{
"sku": "Z.617072.2273220000000298134",
"quantity": 1,
"custom_fields": [
{
"price_settings": "a8724cef-022b-4d3e-a913-84693fd3e341",
"group_id": "a8724cef-022b-4d3e-a913-84693fd3e341",
"name": "fieldname",
"value": "ABDELRAHMAN",
"type": "TEXT"
}
]
}
],
"shipping_method": {
"type": "delivery",
"id": 601943
},
"payment_method": {
"id": 854148
}
}'Responses
🟢200Order created successfully.
application/json
Body
Example
{
"status": "object",
"order": {
"id": 44374824,
"code": "owYRx38BFx",
"store_id": 617072,
"order_url": "https://popcorntest.zid.store/o/owYRx38BFx/inv",
"store_name": "Popcorn Test",
"shipping_method_code": "zid_zidship.aramex_drop_off",
"store_url": "https://popcorntest.zid.store/",
"order_status": {
"name": "جديد",
"code": "new"
},
"currency_code": "SAR",
"customer": {
"id": 12372378,
"name": "N/A",
"verified": 1,
"email": "yousefarifagha@gmail.com",
"mobile": "971525440982",
"note": "",
"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": "34.00000000000000",
"order_total_string": "34.00 SAR",
"has_different_transaction_currency": false,
"transaction_reference": null,
"transaction_amount": 34,
"transaction_amount_string": "34.00 SAR",
"issue_date": "25-11-2024 | 02:56 م",
"payment_status": "pending",
"is_potential_fraud": false,
"source": "طلب خارجي API",
"source_code": "api",
"is_reseller_transaction": false,
"created_at": "2024-11-25 11:56:03",
"updated_at": "2024-11-25 11:56:04",
"is_on_demand": false,
"tags": [],
"requires_shipping": true,
"should_merchant_set_shipping_method": false,
"shipping": {
"method": {
"id": 601943,
"name": "زدشب",
"code": "zid_zidship",
"estimated_delivery_time": "1-7 أيام عمل",
"icon": "https://media.zidship.com/thumbs/servicelevel/9a73cbcf-73ea-4a17-94c9-056ed0b3a4a9-thumbnail-370x370.png",
"is_system_option": true,
"waybill": null,
"had_errors_while_fetching_waybill": false,
"waybill_tracking_id": null,
"has_waybill_and_packing_list": false,
"tracking": {
"number": null,
"status": "N/A",
"url": null
},
"order_shipping_status": null,
"inventory_address": [],
"courier": null,
"return_shipment": null
},
"address": {
"formatted_address": "N/A",
"street": "الكراج",
"district": "Building: ١, Floor: ١, Unit: ١",
"lat": null,
"lng": null,
"short_address": null,
"meta": null,
"city": {
"id": 1,
"name": "الرياض"
},
"country": {
"id": 184,
"name": "السعودية"
}
}
},
"payment": {
"method": {
"name": "دفع عند الاستلام",
"code": "zid_cod",
"type": "zid_cod"
},
"invoice": [
{
"code": "sub_totals",
"value": "1.00000000000000",
"value_string": "1.00 SAR",
"title": "قيمة المنتجات"
}
]
},
"cod_confirmed": false,
"reverse_order_label_request": null,
"customer_note": "",
"gift_message": null,
"payment_link": null,
"weight": 0,
"weight_cost_details": [],
"currency": {
"order_currency": {
"id": 4,
"code": "SAR",
"exchange_rate": 1
},
"order_store_currency": {
"id": 4,
"code": "SAR",
"exchange_rate": null
}
},
"coupon": null,
"products": [
{
"id": "aa7c463b-9153-4671-9871-46657378af4a",
"parent_id": "c45f0110483847dfab2bd979ae06a9b4",
"parent_name": "test ",
"product_class": null,
"name": "test - b",
"short_description": null,
"sku": "Z.617072.2273220000000298134",
"barcode": null,
"custom_fields": [
{
"price_settings": [
"a8724cef-022b-4d3e-a913-84693fd3e341"
],
"group_id": "a8724cef-022b-4d3e-a913-84693fd3e341",
"group_name": "fieldname",
"label": "fieldname",
"name": "fieldname",
"value": "ABDELRAHMAN",
"type": "TEXT",
"net_additions_price_string": "0.00 SAR",
"gross_additions_price_string": "0.00 SAR",
"additions_price_string": "0.00 SAR",
"net_additions_price": "0.0000",
"gross_additions_price": "0.0000",
"additions_price": "0.0000",
"formatted_value": "ABDELRAHMAN"
}
],
"quantity": 1,
"weight": null,
"is_taxable": true,
"is_discounted": false,
"meta": null,
"is_external_product": false,
"net_price_with_additions": 1,
"net_price_with_additions_string": "1.00 SAR",
"price_with_additions": 1,
"price_with_additions_string": "1.00 SAR",
"net_price": 1,
"net_price_string": "1.00 SAR",
"net_sale_price": null,
"net_sale_price_string": null,
"net_additions_price": 0,
"net_additions_price_string": null,
"gross_price": 1,
"gross_price_string": "1.00 SAR",
"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,
"tax_percentage": 0,
"tax_amount": "0.00000000000000",
"tax_amount_string": "0.00 SAR",
"tax_amount_string_per_item": "0.00 SAR",
"price": 1,
"price_string": "1.00 SAR",
"additions_price": 0,
"additions_price_string": "0.00 SAR",
"total": 1,
"total_string": "1.00 SAR",
"images": [
{
"id": "96425281-f941-4076-b3d9-5ae6255335d3",
"origin": "https://media.zid.store/thumbs/8bbd6329-f73d-404e-9293-4c60a0146396/96425281-f941-4076-b3d9-5ae6255335d3-thumbnail-500x500-70.jpg",
"thumbs": {
"fullSize": "https://media.zid.store/8bbd6329-f73d-404e-9293-4c60a0146396/96425281-f941-4076-b3d9-5ae6255335d3.jpg",
"thumbnail": "https://media.zid.store/thumbs/8bbd6329-f73d-404e-9293-4c60a0146396/96425281-f941-4076-b3d9-5ae6255335d3-thumbnail-370x370-70.jpg",
"small": "https://media.zid.store/thumbs/8bbd6329-f73d-404e-9293-4c60a0146396/96425281-f941-4076-b3d9-5ae6255335d3-thumbnail-500x500-70.jpg",
"medium": "https://media.zid.store/thumbs/8bbd6329-f73d-404e-9293-4c60a0146396/96425281-f941-4076-b3d9-5ae6255335d3-thumbnail-770x770-70.jpg",
"large": "https://media.zid.store/thumbs/8bbd6329-f73d-404e-9293-4c60a0146396/96425281-f941-4076-b3d9-5ae6255335d3-thumbnail-1000x1000-70.jpg"
}
}
],
"options": []
}
],
"products_count": 1,
"products_sum_total_string": "1.00 SAR",
"language": "ar",
"histories": [
{
"order_status_id": 1,
"order_status_name": "جديد",
"changed_by_id": 657596,
"changed_by_type": "تاجر",
"changed_by_details": {
"action": "تم إنشاء الطلب .",
"by": "Popcorn-Test",
"comment": ""
},
"comment": "تم إنشاء الطلب .",
"created_at": "2024-11-25 11:56:05",
"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
},
"message": {
"type": "object",
"code": null,
"name": null,
"description": null
}
}Modified at 2025-08-25 08:33:48