Create Order

POST /v1/nextrestaurant/orders

Place an order

Creates an ordinary order: it routes to kitchen stations by your routing rules, depletes stock at the status you configured, settles into the payments ledger, and appears in reports with its channel recorded.

Orders arrive unpaid — this endpoint records an order, it does not take payment.

Needs orders:write and the Orders app. Open in demo mode, like the storefront. Send an Idempotency-Key so a retry after a timeout cannot create a second order. Also limited to 60 orders per 5 minutes per address.

Request

POST https://your-site.example/api/index.php/v1/nextrestaurant/orders

Parameters

Request body

Content type: application/json

{
    "location_id": 2,
    "channel": "web",
    "service_mode": "takeaway",
    "notes": "Ring the bell at the side door",
    "customer": {
        "name": "Dana Whitfield",
        "phone": "+1 555 0142",
        "email": "[email protected]"
    },
    "items": [
        {
            "item_id": 16,
            "variation_id": 2,
            "qty": 1,
            "notes": "Well done",
            "modifiers": [
                {
                    "modifier_id": 5,
                    "qty": 1
                }
            ]
        },
        {
            "item_id": 1,
            "qty": 2
        }
    ]
}

Responses

201 — The order was created.

{
    "data": {
        "id": 591,
        "order_number": "ORD-000591",
        "location_id": 2,
        "channel": "web",
        "status": "placed",
        "fulfillment_status": "in_kitchen",
        "subtotal": 18.5,
        "discount_total": 0,
        "tax_total": 1.53,
        "service_charge": 0,
        "delivery_fee": 0,
        "grand_total": 20.03,
        "currency": null,
        "notes": null,
        "placed_at": "2026-09-07 21:20:26",
        "updated_at": "2026-09-07 21:20:26",
        "payments": [],
        "items": [
            {
                "id": 1300,
                "item_id": 16,
                "variation_id": 2,
                "name_snapshot": "Margherita Pizza (Large)",
                "qty": 1,
                "unit_price": 17,
                "modifiers_total": 1.5,
                "line_total": 18.5,
                "notes": null
            }
        ]
    }
}

Errors

Examples

curl

curl -s -X POST "https://your-site.example/api/index.php/v1/nextrestaurant/orders" \
  -H "Authorization: Bearer $API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"location_id":2,"channel":"web","service_mode":"takeaway","notes":"Ring the bell at the side door","customer":{"name":"Dana Whitfield","phone":"+1 555 0142","email":"[email protected]"},"items":[{"item_id":16,"variation_id":2,"qty":1,"notes":"Well done","modifiers":[{"modifier_id":5,"qty":1}]},{"item_id":1,"qty":2}]}'

PHP

<?php
$ch = curl_init('https://your-site.example/api/index.php/v1/nextrestaurant/orders');

curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST  => 'POST',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER     => [
        'Authorization: Bearer ' . getenv('API_TOKEN'),
        'Content-Type: application/json',
    ],
    CURLOPT_POSTFIELDS     => '{"location_id":2,"channel":"web","service_mode":"takeaway","notes":"Ring the bell at the side door","customer":{"name":"Dana Whitfield","phone":"+1 555 0142","email":"[email protected]"},"items":[{"item_id":16,"variation_id":2,"qty":1,"notes":"Well done","modifiers":[{"modifier_id":5,"qty":1}]},{"item_id":1,"qty":2}]}',
]);

$response = json_decode(curl_exec($ch), true);
curl_close($ch);

JavaScript

const API_TOKEN = process.env.API_TOKEN;

const response = await fetch("https://your-site.example/api/index.php/v1/nextrestaurant/orders", {
  method: 'POST',
  headers: {
    "Authorization": `Bearer ${API_TOKEN}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "location_id": 2,
    "channel": "web",
    "service_mode": "takeaway",
    "notes": "Ring the bell at the side door",
    "customer": {
      "name": "Dana Whitfield",
      "phone": "+1 555 0142",
      "email": "[email protected]"
    },
    "items": [
      {
        "item_id": 16,
        "variation_id": 2,
        "qty": 1,
        "notes": "Well done",
        "modifiers": [
          {
            "modifier_id": 5,
            "qty": 1
          }
        ]
      },
      {
        "item_id": 1,
        "qty": 2
      }
    ]
  }),
});
const data = await response.json();