Create Normal Orders

Request

Method: POST

Endpoint: orders/integration

Content-Type: application/json

Request Body

Field Name	Required	Type	Description
`customer`	Yes	`object`	An object containing the customer's details as per the Customer Details table.
`products`	Yes	`array` of `objects`	An array of product objects, each structured as per the Product Details table.
`notes`	No	`string`	Any additional notes or special instructions for the order.
`total`	Yes	`number`	The total price to be collected for the order (including shipping) - COD.

For prepaid orders, send a total of 0.

Customer Details

Field Name	Required	Type	Description
`first_name`	Yes	`string`	The customer's first name.
`last_name`	Yes	`string`	The customer's last name.
`phone`	Yes	`string`	The customer's phone number.
`address`	Yes	`string`	The customer's full address.
`governorate`	Yes	`string`	The customer's governorate (check Governorate Details list).

Valid Governorate Syntaxes

The following values are valid governorate strings in the system:

6th of October
Alexandria
Aswan
Asyut
Beheira
Beni Suef
Cairo
Dakahlia
Damietta
Fayed
Fayoum
Gharbeya
Giza
Helwan
Ismailia
Kafr El Sheikh
Luxor
Matrouh
Menoufia
Minya
New Valley
North Sinai
Port Said
Qalyubia
Qena
Red Sea
Sharkeya
Sohag
South Sinai
Suez

Product Details

Field Name	Required	Type	Description
`id`	Yes	`string`	The unique identifier for the product.
`name`	Yes	`string`	The name of the product.
`quantity`	Yes	`number`	The quantity of the product ordered (must be at least 1).
`price`	Yes	`string`	The price of a single unit of the product in EGP.
`discount`	No	`string`	The discount applied to the product, if any, in EGP.
`variant`	Yes	`string`	The specific variant of the product (e.g., color and/or size).
`variant_id`	No	`string`	The unique identifier for the product variant.
`weight`	Yes	`number`	The weight of a single unit of the product, in KG.
`properties`	No	`string[]`	An array of additional properties for the product.

Example Payload

{
  "customer": {
    "first_name": "Ahmed",
    "last_name": "Kamal",
    "phone": "01012345678",
    "address": "15 El-Nasr St., Maadi",
    "governorate": "Cairo"
  },
  "products": [
    {
      "id": "prod_abc123",
      "name": "Smartwatch X Pro",
      "quantity": 1,
      "price": "2500.00",
      "discount": "100.00",
      "variant": "Black",
      "variant_id": "var_xyz789",
      "weight": 0.25,
      "properties": ["Water Resistant", "Heart Rate Monitor"]
    },
    {
      "id": "prod_def456",
      "name": "Wireless Earbuds",
      "quantity": 2,
      "price": "750.00",
      "variant": "White",
      "weight": 0.1,
      "properties": []
    }
  ],
  "notes": "Please ensure safe packaging. Customer prefers evening delivery.",
  "total": 3300.00,
}

Response

✅ 201 Created

The order was successfully created.

Response Body

{
  "OID": "1002540015842"
}

❌ 400 Bad Request

The request was invalid (e.g., missing required fields).

Example Error

{
  "error": "Validation failed: 'products' field is required."
}

Create Normal Orders

On this page