Validate Order Request

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

Obtain Necessary Scope: Ensure you have the order_create scope enabled in your app via the Partner Dashboard.

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.

Create the Order: Follow the instructions below to use the Create Order endpoint.

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,
      "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
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Validate Order Request

Guide#

Request

Request Code Samples

Responses

Guide