Create Order

This endpoint allows Partners to create orders on behalf of merchants, including products with required customizable fields.

🔑Scopes

third_create_order - Full read & write access to orders

Note: If the payment method is set to a payment link, the payment_link_configs must be included inside the payment_method object:

{
...
  "payment_method": {
    "id": 636256,
    "payment_link_configs": {
      "expiryDateTime": "2026-07-29T22:00:27.901Z"
    }
  }
}

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.

curl --location '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, "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, "payment_link_configs": { "expiryDateTime": "2026-07-29T22:00:27.901Z" } }, "customer_comment": null }'

{ "status": "object", "order": { "id": 63945643, "invoice_number": 63945643, "code": "4lF4p7HluM", "store_id": 3, "order_url": "https://osama.zid.store/o/4lF4p7HluM/inv", "store_name": "متجر أسامة.", "shipping_method_code": "custom", "store_url": "https://osama.zid.store/", "currency_code": "SAR", "order_status": { "name": "جديد", "code": "new" }, "display_status": { "id": 1, "code": "new", "color": "#3498db", "name": "جديد" }, "customer": { "id": 1441, "name": "John Doe", "email": "test@mail.com", "mobile": "966123456789", "note": "", "verified": 1, "type": "individual", "business_name": "string", "tax_number": "string", "commercial_registration": "string" }, "has_different_consignee": 0, "is_guest_customer": 0, "is_gift_order": 0, "gift_card_details": {}, "consignee": { "name": "string", "email": "string", "mobile": "string" }, "is_quick_checkout_order": true, "order_total": "string", "order_total_string": "201.86 SAR", "has_different_transaction_currency": true, "transaction_reference": "string", "transaction_amount": 201.85999896568, "transaction_amount_string": "201.86 SAR", "issue_date": "string", "payment_status": "pending", "is_potential_fraud": true, "source": "string", "source_code": "string", "is_reseller_transaction": true, "created_at": "2026-01-26 10:21:08", "updated_at": "2026-01-26 10:21:08", "is_on_demand": true, "import_id": "string", "store_logo": "string", "store_uuid": "string", "tags": [ { "id": "string", "name": "string", "store_id": "string", "user_id": "string", "orders": [ "string" ] } ], "marketing_source": { "utm_id": "", "utm_source": "", "utm_medium": "", "utm_campaign": "", "utm_term": "", "utm_content": "", "referer": "organic", "platform": "unknown", "device_type": "unknown", "browser": null, "os": null, "ip": "192.168.162.93", "ip_country": null, "ip_content": null, "ip_city": null, "ip_region": null, "ip_timezone": null }, "requires_shipping": true, "should_merchant_set_shipping_method": true, "shipping": { "method": { "id": 0, "name": "string", "code": "string", "estimated_delivery_time": "string", "icon": "string", "is_system_option": true, "waybill": "string", "had_errors_while_fetching_waybill": true, "waybill_tracking_id": "string", "has_waybill_and_packing_list": true, "tracking": { "number": "string", "status": "string", "url": "string" }, "order_shipping_status": "string", "inventory_address": [ "string" ], "courier": { "name": { "ar": "string", "en": "string" }, "code": "string", "logo": "string", "identifier": "string" }, "return_shipment": [ "string" ], "packages_count": 0 }, "address": { "formatted_address": "string", "street": "string", "district": "string", "lat": 0, "lng": 0, "short_address": "string", "meta": { "building_number": "string", "postcode": "string", "additional_number": "string", "city_name": "string" }, "city": { "id": 0, "name": "string" }, "country": { "id": 0, "name": "string" } } }, "payment": { "method": { "name": "string", "code": "hyperpay", "type": "string", "cart_payment_request_token": "string", "transaction_status": "string", "transaction_status_name": "string", "transaction_bank": "string", "transaction_slip": "string", "transaction_sender_name": "string", "updated_at": "string" }, "invoice": [ { "code": "string", "value": "string", "value_string": "string", "title": "string" } ], "split_payments": [ { "name": "string", "code": "string", "amount": 0, "amount_string": "string", "near_pay_transaction_uuid": "string", "near_pay_transaction_details": "string" } ] }, "cod_confirmed": true, "reverse_order_label_request": { "id": "string", "store_id": "string", "order_id": 0, "is_partial": 0, "consignee_name": "string", "consignee_mobile": "string", "consignee_city": {}, "consignee_address_1": "string", "consignee_address_2": "string", "inventory_address_id": 0, "inventory_location_id": "string", "inventory": {}, "reason": [ "string" ], "shipping_method": "string", "waybill": {}, "products": [ {} ] }, "reverse_order_label_requests": [ { "id": "string", "store_id": "string", "order_id": 0, "is_partial": 0, "consignee_name": "string", "consignee_mobile": "string", "consignee_city": {}, "consignee_address_1": "string", "consignee_address_2": "string", "inventory_address_id": 0, "inventory_location_id": "string", "inventory": {}, "reason": [ "string" ], "shipping_method": "string", "waybill": {}, "products": [ {} ] } ], "customer_note": "string", "gift_message": "string", "payment_link": "string", "service_fee_invoice_link": "string", "weight": 0, "weight_cost_details": [ "string" ], "currency": { "order_currency": { "id": 0, "code": "string", "exchange_rate": 0 }, "order_store_currency": { "id": 0, "code": "string", "exchange_rate": 0 } }, "coupon": { "id": 0, "code": "string", "name": "string", "discount": "string", "discount_string": "string" }, "products": [ { "id": "003140e2-9d8e-462d-b823-373407746871", "order_product_id": 0, "parent_id": "string", "parent_name": "string", "product_class": "string", "name": "طقم سفر للحواجب سوبرستار من بنفت", "short_description": { "ar": "string", "en": "string" }, "sku": "Z.217795.169603646831188", "barcode": "string", "custom_fields": [ { "type": "string", "value": "string", "formatted_value": "string", "name": "string", "label": "string" } ], "quantity": 1, "weight": { "value": 1.2, "unit": "kg" }, "is_taxable": true, "is_discounted": true, "vouchers": [ { "id": "string", "product_id": "string", "status": "string", "order": 0, "serial_number": "string", "key": "string", "pin_code": "string", "expires_at": "string", "updated_at": "string", "created_at": "string", "expires_at_formatted": "string" } ], "downloadables": [ { "download_url": "string", "download_limit": 0, "download_requests_count": 0, "expiration_period": 0, "is_external": true, "display_name": "string" } ], "downloadables_zipped": [ { "download_url": "string", "download_limit": 0, "download_requests_count": 0, "expiration_period": 0, "is_external": true, "display_name": "string" } ], "meta": {}, "is_external_product": true, "discounts": [ "string" ], "net_price_with_additions": 0, "net_price_with_additions_string": "string", "price_with_additions": 0, "price_with_additions_string": "string", "net_price": "string", "net_price_string": "string", "net_sale_price": "string", "net_sale_price_string": "string", "net_additions_price": 0, "net_additions_price_string": "string", "gross_price": 0, "gross_price_string": "string", "gross_sale_price": "string", "gross_sale_price_string": "string", "price_before": 0, "price_before_string": "string", "total_before": 0, "total_before_string": "string", "gross_additions_price": 0, "gross_additions_price_string": "string", "discount_percentage": 0, "tax_percentage": 0.15, "tax_amount": "string", "tax_amount_string": "26.03 SAR", "tax_amount_string_per_item": "string", "discounted_tax_amount": 0, "discounted_tax_amount_string": "string", "discounted_tax_amount_string_per_item": "string", "price": 199.55999896568, "price_string": "199.56 SAR", "additions_price": 0, "additions_price_string": "string", "total": 0, "total_string": "string", "discounted_total": 0, "discounted_total_string": "string", "images": [ { "id": "string", "origin": "string", "thumbs": { "fullSize": "string", "thumbnail": "string", "small": "string", "medium": "string", "large": "string" } } ], "options": [ "string" ] } ], "products_count": 1, "products_sum_total_string": "string", "language": "string", "histories": [ { "order_status_id": 0, "order_status_name": "New", "changed_by_id": 0, "changed_by_type": "Admin", "changed_by_details": { "action": "string", "by": "string", "comment": "string" }, "comment": "Order has been created.", "created_at": "2026-01-26 10:21:10", "humanized_created_at": "1 second ago" } ], "product_ids": [ "string" ], "is_reactivated": true, "return_policy": "string", "packages_count": 0, "inventory_address": { "id": "string", "name": "string", "city": { "name": "Other", "id": 1, "national_id": 3, "priority": 10, "country_id": 184, "country_name": "السعودية", "country_code": "SA", "ar_name": "الرياض", "en_name": "Riyadh" }, "street": "string", "district": "string", "postal_code": "string", "coordinates": { "lat": 0, "lon": 0 }, "cop_enabled": true, "is_pickup_option": true, "is_zidship_default": true, "working_hours": [ { "day_name": "string", "time_from": "string", "time_to": "string" } ], "full_address": "string", "short_address": "string" }, "expected_shipping_method_type": "string", "reseller_meta": [ "string" ], "zidship_ticket_number": "string", "edits_count": 0, "delivered_at": "string", "is_marketplace_order": true, "marketplace_commission": { "commission_percentage": 0, "commision_amount": "string", "tax_percentage": 0, "tax_amount": "string", "total": "string" }, "pos_invoice_number": "string", "return_invoice_number": "string", "invoice_link": "string", "payment_network": "string", "digital_products_access_token": "string" }, "message": { "type": "object", "code": "string", "name": "string", "description": "string" } }

Guide

Request

Responses

Create Order

Guide#

Request

Responses

Guide