Orders

Create an order

POST/api/v1/orders

Send each order as soon as it is placed. Yudoo stores it and fires the store's order automations: the confirmation for its payment method first. Sending the same id again updates the order instead of creating a second one, so a retry is always safe.

curl -X POST https://app.yudoo.io/api/v1/orders \
  -H "Authorization: Bearer wp_live_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "1042",
    "number": "1042",
    "status": "pending",
    "customer": { "name": "Mohamed Ali", "phone": "201001234567", "email": "mohamed@example.com" },
    "currency": "EGP",
    "total": 540,
    "shipping_total": 40,
    "payment_method": "cod",
    "shipping_address": { "address1": "12 Tahrir St", "city": "Cairo", "province": "Cairo", "country": "EG" },
    "items": [
      { "name": "Cotton T-shirt", "variant": "White / L", "quantity": 1, "price": 250, "sku": "TS-WH-L" },
      { "name": "Sport socks", "quantity": 2, "price": 125 }
    ],
    "note": "Please deliver after 5 pm"
  }'
FieldTypeDescription
idstringRequired. Your platform's own order id. Sending the same id again updates that order.
customer.phonestringRequired. International format with the country code, digits only (201001234567). The WhatsApp messages go here.
customer.namestringThe customer's name ({{customer_first_name}} in the messages).
customer.emailstringOptional.
numberstringThe number the customer knows ("1042" → #1042). Defaults to #id.
statusstringpending (default), processing, shipped, delivered, cancelled… See Order statuses.
payment_methodstringcod, bank_transfer, instapay, vodafone_cash, card… It picks the confirmation the order gets. See Payment methods.
currencystring3-letter ISO code: EGP, SAR, AED, USD…
totalnumberThe order's total, shipping included.
shipping_totalnumberThe shipping fee.
items[]arrayUp to 200 lines: name (required), quantity, price, variant, sku, product_id, image_url (https).
shipping_addressobjectaddress1, address2, city, province, postal_code, country (ISO-2 or name).
notestringThe customer's order note.
trackingobjectnumber, url, carrier — when the order already shipped.
placed_atstringISO 8601 date. Defaults to the moment Yudoo received the order.

The answer is 201 Created with the order (200 when the id was sent before):

json
{
  "order": {
    "id": "1042",
    "number": "#1042",
    "status": "pending",
    "confirmation": { "status": "pending", "at": null, "cancel_reason": null },
    "customer": { "name": "Mohamed Ali", "phone": "201001234567", "email": "mohamed@example.com" },
    "currency": "EGP",
    "total": 540,
    "payment_method": "cod",
    "items": [
      { "name": "Cotton T-shirt", "variant": "White / L", "quantity": 1, "price": 250, "sku": "TS-WH-L", "product_id": null },
      { "name": "Sport socks", "variant": null, "quantity": 2, "price": 125, "sku": null, "product_id": null }
    ],
    "tracking": null,
    "created_at": "2026-11-04T10:00:00.000Z",
    "updated_at": "2026-11-04T10:00:00.000Z"
  }
}

Stuck, or need a field we don't have yet? Our team answers on WhatsApp.

Ask us on WhatsAppOpen the Yudoo app