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
- Abandoned Carts
- Products
- Inventories
- Shipping
- Marketing
- Gift Cards
- Coupons
- Bundle Offers
- Loyalty Program
- Calculate Loyalty Points for Order
- Retrieve Store Loyalty Status
- Activate Loyalty Program
- Retrieve Loyalty Program Status
- Set Points Expiration Rules
- Update Cashback Rule
- Update Cashback Rule Status
- Create Points Redemption Method
- Update Points Redemption Method
- Delete Points Redemption Method
- Update Redemption Method Status
- Retrieve Customer Loyalty Summary
- List Loyalty Data
- List Customer Points History
- Retrieve Manager Loyalty Info Page
- Update Loyalty Info Page
- Adjust Customer Points
- Customers
- Store Settings
- Countries and Cities
- Webhook
- Orders
- Store Events
Create Order
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",
"coupon_code": null,
"customer": {
"full_name": "John Doe",
"mobile_country_code": "966",
"mobile_number": "500000005",
"email": "john.doe@example.com"
},
"consignee": {
"contact": {
"full_name": "John Doe",
"mobile_country_code": "966",
"mobile_number": "500000005",
"email": "john.doe@example.com"
},
"address": {
"line_1": "King Fahd Road",
"line_2": "Building 12",
"city_name": "Riyadh",
"country_code": "SA",
"lat": null,
"lng": null,
"meta": {
"postcode": "89846-6258",
"building_number": "86",
"additional_number": "21",
"city_name": "Riyad"
}
}
},
"is_gift": false,
"is_gifted_consignee_notifiable": true,
"products": [
{
"sku": "Z.217795.169603646831188",
"quantity": 1
}
],
"shipping_method": {
"type": "delivery",
"id": 432480
},
"payment_method": {
"id": 555224
},
"customer_comment": null
}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: {{Autherization}}' \
--header 'X-MANAGER-TOKEN: {{Access-Token}}' \
--header 'Accept: application/json' \
--header 'Accept-Language: en' \
--header 'Content-Type: application/json' \
--data-raw '{
"currency_code": "SAR",
"coupon_code": null,
"customer": {
"full_name": "John Doe",
"mobile_country_code": "966",
"mobile_number": "500000005",
"email": "john.doe@example.com"
},
"consignee": {
"contact": {
"full_name": "John Doe",
"mobile_country_code": "966",
"mobile_number": "500000005",
"email": "john.doe@example.com"
},
"address": {
"line_1": "King Fahd Road",
"line_2": "Building 12",
"city_name": "Riyadh",
"country_code": "SA",
"lat": null,
"lng": null,
"meta": {
"postcode": "89846-6258",
"building_number": "86",
"additional_number": "21",
"city_name": "Riyad"
}
}
},
"is_gift": false,
"is_gifted_consignee_notifiable": true,
"products": [
{
"sku": "Z.217795.169603646831188",
"quantity": 1
}
],
"shipping_method": {
"type": "delivery",
"id": 432480
},
"payment_method": {
"id": 555224
},
"customer_comment": null
}'Responses
🟢200OK
application/json
Body
Examples
{
"status": "object",
"order": {
"id": 63954736,
"invoice_number": 63954736,
"code": "IoJNoPm1JS",
"store_id": 3,
"order_url": "https://osama.zid.store/o/IoJNoPm1JS/inv",
"store_name": "متجر أسامة.",
"shipping_method_code": "custom",
"store_url": "https://osama.zid.store/",
"order_status": {
"name": "جديد",
"code": "new"
},
"display_status": {
"id": 1,
"code": "new",
"color": "#3498db",
"name": "جديد"
},
"currency_code": "SAR",
"customer": {
"id": 15141670,
"name": "Zid Test Customer",
"email": "a.alkallas@zid.sa",
"mobile": "966500000005",
"note": "This is a demo order for the purpose of testing the system. Please cancel this order.",
"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": "201.85999896568000",
"order_total_string": "201.86 SAR",
"has_different_transaction_currency": false,
"transaction_reference": null,
"transaction_amount": 201.85999896568,
"transaction_amount_string": "201.86 SAR",
"issue_date": "26-01-2026 | 06:28 م",
"payment_status": "pending",
"is_potential_fraud": false,
"source": "طلب خارجي API",
"source_code": "api",
"is_reseller_transaction": false,
"created_at": "2026-01-26 15:28:23",
"updated_at": "2026-01-26 15:28:24",
"is_on_demand": false,
"import_id": null,
"tags": [],
"requires_shipping": true,
"should_merchant_set_shipping_method": false,
"shipping": {
"method": {
"id": 432480,
"name": "ارامكس",
"code": "custom",
"estimated_delivery_time": "",
"icon": "https://media.zid.store/d297fb8b-c322-412e-a2f4-ffa96dc57022/85355931-facb-493f-92c5-b81dfca94a9f.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": [],
"courier": null,
"return_shipment": null,
"packages_count": null
},
"address": {
"formatted_address": "N/A",
"street": "King Fahd Road",
"district": "Building 12",
"lat": null,
"lng": null,
"short_address": null,
"meta": null,
"city": {
"id": 1,
"name": "الرياض"
},
"country": {
"id": 184,
"name": "السعودية"
}
}
},
"payment": {
"method": {
"name": "Cash on Delivery",
"code": "zid_cod",
"type": "zid_cod"
},
"invoice": [
{
"code": "sub_totals_before_vat",
"value": "173.53043388320000",
"value_string": "173.53 SAR",
"title": "Total without VAT"
},
{
"code": "shipping",
"value": "2.00000000000000",
"value_string": "2.00 SAR",
"title": "Shipping"
},
{
"code": "taxable_amount",
"value": "175.53043388320000",
"value_string": "175.53 SAR",
"title": "Taxable amount"
},
{
"code": "vat",
"value": "26.32956508248000",
"value_string": "26.33 SAR",
"title": "VAT (%15)"
},
{
"code": "sub_totals_after_vat",
"value": "201.85999896568000",
"value_string": "201.86 SAR",
"title": "Total Inc. VAT"
},
{
"code": "total",
"value": "201.85999896568000",
"value_string": "201.86 SAR",
"title": "Total"
}
]
},
"cod_confirmed": false,
"reverse_order_label_request": null,
"reverse_order_label_requests": [],
"customer_note": "This is a demo order for the purpose of testing the system. Please cancel this order.",
"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": "003140e2-9d8e-462d-b823-373407746871",
"order_product_id": 109895667,
"parent_id": null,
"parent_name": null,
"product_class": null,
"name": "طقم سفر للحواجب سوبرستار من بنفت",
"short_description": {
"ar": "",
"en": ""
},
"sku": "Z.217795.169603646831188",
"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": 173.5304338832,
"net_price_with_additions_string": "173.53 SAR",
"price_with_additions": 199.55999896568,
"price_with_additions_string": "199.56 SAR",
"net_price": 173.5304338832,
"net_price_string": "173.53 SAR",
"net_sale_price": null,
"net_sale_price_string": null,
"net_additions_price": 0,
"net_additions_price_string": null,
"gross_price": 199.55999896568,
"gross_price_string": "199.56 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,
"discount_percentage": 0,
"tax_percentage": 0.15,
"tax_amount": "26.02956508248000",
"tax_amount_string": "26.03 SAR",
"tax_amount_string_per_item": "26.02 SAR",
"discounted_tax_amount": 26.02956508248,
"discounted_tax_amount_string": "26.03 SAR",
"discounted_tax_amount_string_per_item": "26.03 SAR",
"price": 199.55999896568,
"price_string": "199.56 SAR",
"additions_price": 0,
"additions_price_string": "0.00 SAR",
"total": 199.55999896568,
"total_string": "199.56 SAR",
"discounted_total": 199.55999896568,
"discounted_total_string": "199.56 SAR",
"images": [
{
"id": "88e42c96-ad48-4519-9ea9-1e4632eec3c7",
"origin": "https://media.zid.store/thumbs/d297fb8b-c322-412e-a2f4-ffa96dc57022/88e42c96-ad48-4519-9ea9-1e4632eec3c7-thumbnail-500x500-70.jpg",
"thumbs": {
"fullSize": "https://media.zid.store/d297fb8b-c322-412e-a2f4-ffa96dc57022/88e42c96-ad48-4519-9ea9-1e4632eec3c7.jpg",
"thumbnail": "https://media.zid.store/thumbs/d297fb8b-c322-412e-a2f4-ffa96dc57022/88e42c96-ad48-4519-9ea9-1e4632eec3c7-thumbnail-370x370-70.jpg",
"small": "https://media.zid.store/thumbs/d297fb8b-c322-412e-a2f4-ffa96dc57022/88e42c96-ad48-4519-9ea9-1e4632eec3c7-thumbnail-500x500-70.jpg",
"medium": "https://media.zid.store/thumbs/d297fb8b-c322-412e-a2f4-ffa96dc57022/88e42c96-ad48-4519-9ea9-1e4632eec3c7-thumbnail-770x770-70.jpg",
"large": "https://media.zid.store/thumbs/d297fb8b-c322-412e-a2f4-ffa96dc57022/88e42c96-ad48-4519-9ea9-1e4632eec3c7-thumbnail-1000x1000-70.jpg"
}
}
],
"options": []
}
],
"products_count": 1,
"products_sum_total_string": "199.56 SAR",
"language": "en",
"histories": [
{
"order_status_id": 1,
"order_status_name": "New",
"changed_by_id": 3,
"changed_by_type": "Merchant",
"changed_by_details": {
"action": "Order has been created.",
"by": "Osama",
"comment": ""
},
"comment": "Order has been created.",
"created_at": "2026-01-26 15:28:25",
"humanized_created_at": "1 second ago"
}
],
"is_reactivated": false,
"return_policy": "ojghwriojgbwriojgwergiou",
"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/3/orders/invoices/order_confirmation_63954736.pdf",
"payment_network": null
},
"message": {
"type": "object",
"code": null,
"name": null,
"description": null
}
}🟠401Unauthorized
🟠422Validation Errors
🟠404Coupon not found
Modified at 2026-01-28 17:24:20