Create Order

POST /api/v1/orders

Create an order and send a WhatsApp confirmation message to the customer.

Request Body

{
  "externalOrderId": "EO-12345",
  "customerName": "Ahmed Mohamed",
  "customerPhone": "201234567890",
  "customerAddress": "15 Tahrir St, Cairo",
  "subtotal": 150,
  "shippingCost": 25,
  "totalCost": 175,
  "currency": "EGP",
  "note": "Gift wrap",
  "items": [
    {
      "productName": "iPhone Case",
      "variantName": "Black / Large",
      "quantity": 2,
      "unitPrice": 75,
      "totalPrice": 150
    }
  ]
}

Body Parameters

Field	Type	Required	Description
externalOrderId	string	Yes	Your unique order identifier
customerName	string	Yes	Customer's full name
customerPhone	string	Yes	Customer's phone number (with country code, no +)
customerAddress	string	No	Delivery address
subtotal	number	Yes	Subtotal before shipping
shippingCost	number	Yes	Shipping cost
totalCost	number	Yes	Total order cost
currency	string	Yes	Currency code (e.g., EGP)
note	string	No	Additional notes
items	array	Yes	Order items (see below)

Item Fields

Field	Type	Required	Description
productName	string	Yes	Product name
variantName	string	No	Variant description
quantity	number	Yes	Quantity ordered
unitPrice	number	Yes	Price per unit
totalPrice	number	Yes	Total price for this item

Headers

Header	Required	Description
X-API-Key	Yes	Your API key (starts with ek_)
Content-Type	Yes	application/json
Accept-Language	No	en (default) or ar

Response

201 — Order created and WhatsApp confirmation sent

{
  "id": "ord_abc123",
  "externalOrderId": "EO-12345",
  "customerName": "Ahmed Mohamed",
  "customerPhone": "201234567890",
  "customerAddress": "15 Tahrir St, Cairo",
  "subtotal": 150,
  "shippingCost": 25,
  "totalCost": 175,
  "currency": "EGP",
  "status": "pending",
  "customerAction": "approved",
  "deliveryStatus": "sent",
  "items": [
    {
      "id": "item_xyz789",
      "productName": "iPhone Case",
      "variantName": "Black / Large",
      "quantity": 2,
      "unitPrice": 75,
      "totalPrice": 150
    }
  ],
  "createdAt": "2026-04-20T10:23:52.772Z",
  "updatedAt": "2026-04-20T10:23:52.772Z"
}

Try It

POSThttps://api.easyconfirm.net/api/v1/orders

X-API-Key *

{ "externalOrderId": "EO-12345", "customerName": "Ahmed Mohamed", "customerPhone": "201234567890", "customerAddress": "15 Tahrir St, Cairo", "subtotal": 150, "shippingCost": 25, "totalCost": 175, "currency": "EGP", "note": "Gift wrap", "items": [ { "productName": "iPhone Case", "variantName": "Black / Large", "quantity": 2, "unitPrice": 75, "totalPrice": 150 } ] }

Example

curl -X POST https://api.easyconfirm.net/api/v1/orders \
  -H "Content-Type: application/json" \
  -H "X-API-Key: ek_your_api_key_here" \
  -d '{
    "externalOrderId": "EO-12345",
    "customerName": "Ahmed Mohamed",
    "customerPhone": "201234567890",
    "customerAddress": "15 Tahrir St, Cairo",
    "subtotal": 150,
    "shippingCost": 25,
    "totalCost": 175,
    "currency": "EGP",
    "items": [
      {
        "productName": "iPhone Case",
        "variantName": "Black / Large",
        "quantity": 2,
        "unitPrice": 75,
        "totalPrice": 150
      }
    ]
  }'