Zid Docs
Apps
ThemesPayments
Apps
ThemesPayments
Help Center
Slack
  1. Orders
  • πŸ—‚οΈ Overview
  • πŸš€ Start Here
  • Create your First App
  • Responses
  • Rate Limiting
  • Authorization
  • Embedded Apps
  • StoreFront Events
  • Zid MUI
  • Zid SDKs
  • Our custom MCP server
  • Merchant APIs
    • Account
      • Me
        • Me
        • Profile
      • Store
        • Store
        • Branding
        • Localization
        • Social
        • Operations
        • Business
        • Upload Logo Image
        • Delete Logo Image
        • Upload Icon Image
        • Delete Icon Image
        • Upload Cover Image
        • Delete Cover Image
    • Orders
      • Validate Order Request
        POST
      • Create Order
        POST
      • Change Order Status
        POST
      • Add Order Comment
        POST
      • View Order
        GET
      • List Orders
        GET
      • List Custom Order Statuses
        GET
      • List Order Credit Notes
        GET
    • Reverse Orders
      • Create Reverse Orders
      • Create Reverse Orders Waybill
      • Add Reverse Order Reasons
      • List Reverse Reasons
      • Calculate Reverse Totals
      • Create refund for reverse order
      • Upload bank transfer receipt
      • Update return products
      • Order Details – View for Return
    • Abandoned Carts
      • List Carts
      • View Cart
    • Products
      • Managing Products
        • Create Product Types
        • Create Product
        • List Products
        • View Product
        • List Product Settings
        • Update Product
        • Bulk Update Products
        • Delete Product
      • Digital Vouchers
        • List Vouchers
        • Order Vouchers
        • Create Voucher
        • Import Vouchers
        • Export Vouchers
        • Update Voucher
        • Remove Voucher
      • Product Categories
        • List Categories
        • View Category
        • Create Category
        • Create Subcategory
        • Update Category
        • Assign Product to Category
        • Bulk Assign Products to Category
        • Publish Category
        • Detach Category from All Products
        • Remove Product from Category
      • Product Badge
        • List Badges
      • Product Attributes
        • List Attributes
        • View Attribute
        • Create Attribute
        • Update Attribute
        • Delete Attribute
      • Product Attribute Presets
        • List Presets
        • Create Preset
        • Update Preset
        • Delete Preset
      • Product Variants
        • Create Variants
        • Create Custom Option
        • Update Custom Option
        • Delete Custom Option Field
        • Create Custom Input Field
        • Update Custom Input Field
        • Delete Custom Input Field
      • Product Sorting
        • Set Manual Product Order
        • Reset Manual Product Order
      • Product Images
        • List Images
        • Upload Image
        • Update Image Order
        • Delete Image
      • Product Availability Notifications
        • Notification Stats
        • Noticiation Settings
        • List Notifications
        • Create Notification
        • Update Settings
        • Send Notification Email
        • Export Notifications
      • Product Export
        • Email All Products to Store Owner
        • Import Products via CSV or xlsx File
      • Product Stock
        • Retrieve Product Stock
        • List Product Stock Records
        • Create Product Stock
        • Update Product Stock
        • Bulk Update Product Stock Records
      • Product Questions & Answers
        • Retrieve Product Question
        • Retrieve Product Answer
        • List Product Questions
        • List Answers for Question
        • Create Product Question
        • Create Product Answer
        • Update Product Question
        • Update Product Answer
        • Delete Product Question
        • Delete Product Answer
      • Product Reviews
        • List Reviews
        • Count Reviews
      • Digital Products
        • Create Downloadable Product
        • Generate Upload URL
        • Upload File to S3
        • Create Product Downloadable
        • Get Product Downloadables
        • Delete Product Downloadable
        • List Store Downloadables
        • Create Store Downloadable
        • Delete Store Downloadable
    • Inventories
      • Create Location
      • Update Location
      • Update Product Stock for Location
      • List Locations
      • View Location
    • Shipping
      • List Store Shipping Methods
    • Marketing
      • Coupons
        • List Coupons
        • View Coupon
        • Create Coupon
        • Generate Bulk Coupons
        • Duplicate Coupon
        • Duplicate Bulk Coupons
        • Update Coupon Note
        • Update Coupon
        • Update Bulk Coupons
        • Update Coupon Status
        • Update Bulk Coupons Status
        • Delete Coupon
        • Delete Bulk Coupons
      • Bundle Offers
        • List Bundle Offers
        • View Bundle Offer
      • Loyalty Program
        • Loyalty Program Status
        • Loyalty Program Details
        • Loyalty Program Info
        • Customer Loyalty Summary
        • Customer Points History
        • Activate Loyalty Program
        • Set Points Expiration Rules
        • Update Cashback Rule
        • Create Points Redemption Method
        • Update Points Redemption Method
        • Delete Points Redemption Method
        • Adjust Customer Points
      • Discount Rules
        • List Discount Rules
        • View Discount Rule
        • Create Discount Rule
        • Update Discount Rule
    • Customers
      • Customer Tags
        • List Customer Tags
        • Add Customer Tag
        • Ω’Update Customer Tag
        • Delete Customer Tag
      • List Customers
      • View Customer
      • Primary Customer List
      • FInd Customer By Phone Number
      • Customer Profile
      • Add Customer
      • Update Customer
      • Delete Customer
      • Add Bulk Customers
      • Import Customers
    • Store Settings
      • πŸ“„ User Roles and Permissions
      • Retrieve Store Manager Profile
      • Retrieve VAT Settings
      • List Payment Methods
      • List Store Operating Countries
    • Countries and Cities
      • List Countries
      • List Cities for Country
    • Blogs
      • Settings
        • Create
        • List
      • Categories
        • Create
        • List
        • Bulk Activate
        • Bulk Deactivate
        • Bulk Delete
        • Retrieve
        • Destroy
        • Partial Update
        • Bulk Add To Posts
        • Bulk Remove From Posts
      • Posts
        • Media
          • List
          • Create
          • Destroy
        • Create
        • List
        • Retrieve
        • Partial Update
        • Destroy
        • Archive
        • Publish
        • Bulk Archive
        • Bulk Publish
        • Bulk Delete
        • Export Posts
        • Import Template
        • Import Posts
      • Tags
        • Create
        • List
        • Retrieve
        • Partial Update
        • Destroy
        • Bulk Delete Tags
        • Bulk Add To Posts
        • Bulk Remove From Posts
      • Storefront
        • Posts
          • List
          • Retrieve
        • Categories
          • List
          • Retrieve
        • Tags
          • List
  • Webhooks
    • Overview
    • Webhook Health Tracking
    • Events
      • Order
      • Product
      • Abandoned Cart
      • Customer
      • Product Category
    • APIs
      • Health Summary
      • Broken Webhooks
      • Recover Broken Webhooks
      • List Webhooks
      • Create Webhook
      • Delete Webhook
      • Delete Webhook By subscriber
  • App Management
    • Events
    • APIs
      • Subscription Details
      • Update Usage-Based Charges
  1. Orders

Validate Order Request

POST
https://api.zid.sa/v1/managers/store/drafts/validate
This endpoint allows Partners to validate an order request details before submitting the order to the create order endpoint.
πŸ”‘Scopes
third_create_order - Full read & write access to orders
Note: Please note that if the payment method is set to a payment link, the following configuration must be added:
"payment_link_configs": {
   "expiryDateTime": "2024-12-10T13:00:49.947Z"
}
This guide provides a complete process for setting up orders with the correct payment methods and adding customizable fields like text inputs, dropdowns, and checkboxes.

Guide#

1.
Obtain Necessary Scope: Ensure you have the order_create scope enabled in your app via the Partner Dashboard.
2.
Retrieve Payment Methods: Use the List of Payment Methods endpoint to identify available payment methods.
Locate the payment method with the code "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>"]
}
Copy the id of this ZidPay option for use in the payment_method field during order creation.
3.
Create the Order: Follow the instructions below to use the Create Order endpoint.

Request

Header Params

Body Params application/json

Examples

Responses

🟒200OK
application/json
Bodyapplication/json

🟠401Unauthorized
🟠422Validation Errors
πŸ”΄500Internal Server error
Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://api.zid.sa/v1/managers/store/drafts/validate' \
--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,
      "short_address": 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
}'
Response Response Example
200 - Success
{
    "code": "SUCCESS_WITHOUT_PAYLOAD",
    "message": "This Request is valid"
}
Modified atΒ 2026-06-15 09:13:05
Previous
Orders
Next
Create Order
Built with