Create order

Create a new order. Order items cannot be changed - if they need to be updated, the order should be canceled and a new one placed.

post/orders

Security

This operation accepts the following authorization requirements.

Required credentials

One credential is required.

OAuth2oauth2

OAuth2 authorization for API access.

orders:write

Request

Body

idstring:ulid

Order ID. Unique identifier prefixed with ord_.

objectstring

Allowed values:"order"

Entity name.

customerNamestringrequired

Name of the customer who placed the order. Must start and end with a letter, and can contain letters, spaces, hyphens, and apostrophes (e.g., “John Doe”, “Mary-Jane”, “O’Brien”).

statusstring

Allowed values:"placed""preparing""completed""canceled"

totalPriceinteger

Total order price in cents.

createdAtstring:date-time

Created date.

updatedAtstring:date-time

Updated date.

orderItemsobject[]required

List of items to include in the order.

Item properties (4)

menuItemIdstring:ulidrequired

ID of the menu item to add to the order.

quantityintegerrequired

Quantity of the menu item.

discountinteger

Discount amount in cents (absolute value).

commentstring

Optional comment for the order item (e.g., “No sugar”).

Response

Order placed successfully.

idstring:ulid

Order ID. Unique identifier prefixed with ord_.

objectstring

Allowed values:"order"

Entity name.

customerNamestringrequired

Name of the customer who placed the order. Must start and end with a letter, and can contain letters, spaces, hyphens, and apostrophes (e.g., “John Doe”, “Mary-Jane”, “O’Brien”).

statusstring

Allowed values:"placed""preparing""completed""canceled"

totalPriceinteger

Total order price in cents.

createdAtstring:date-time

Created date.

updatedAtstring:date-time

Updated date.

orderItemsobject[]required

List of items to include in the order.

Item properties (4)

menuItemIdstring:ulidrequired

ID of the menu item to add to the order.

quantityintegerrequired

Quantity of the menu item.

discountinteger

Discount amount in cents (absolute value).

commentstring

Optional comment for the order item (e.g., “No sugar”).

POST /orders HTTP/1.1
Host: cafe.cloud.redocly.com
Authorization: Bearer <access_token>
Content-Type: application/json

{
  "id": "ord_01h1s5z6vf2mm1mz3hevnn9va7",
  "object": "order",
  "customerName": "string",
  "status": "placed",
  "totalPrice": 1,
  "createdAt": "2026-01-01T00:00:00Z",
  "updatedAt": "2026-01-01T00:00:00Z",
  "orderItems": [
    {
      "menuItemId": "string",
      "quantity": 1,
      "discount": 0,
      "comment": "string"
    }
  ]
}

curl -X POST 'https://cafe.cloud.redocly.com/orders' \
  -H 'Authorization: Bearer <access_token>' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "id": "ord_01h1s5z6vf2mm1mz3hevnn9va7",
  "object": "order",
  "customerName": "string",
  "status": "placed",
  "totalPrice": 1,
  "createdAt": "2026-01-01T00:00:00Z",
  "updatedAt": "2026-01-01T00:00:00Z",
  "orderItems": [
    {
      "menuItemId": "string",
      "quantity": 1,
      "discount": 0,
      "comment": "string"
    }
  ]
}'

import requests

url = "https://cafe.cloud.redocly.com/orders"
headers = {
    "Authorization": "Bearer <access_token>",
    "Content-Type": "application/json",
}
payload = {
    "id": "ord_01h1s5z6vf2mm1mz3hevnn9va7",
    "object": "order",
    "customerName": "string",
    "status": "placed",
    "totalPrice": 1,
    "createdAt": "2026-01-01T00:00:00Z",
    "updatedAt": "2026-01-01T00:00:00Z",
    "orderItems": [
        {
            "menuItemId": "string",
            "quantity": 1,
            "discount": 0,
            "comment": "string",
        },
    ],
}

response = requests.post(
    url,
    headers=headers,
    json=payload,
)
print(response.status_code)

require 'net/http'
require 'uri'

uri = URI("https://cafe.cloud.redocly.com/orders")
request = Net::HTTP::Post.new(uri)
request["Authorization"] = "Bearer <access_token>"
request["Content-Type"] = "application/json"
request.body = <<~BODY
{
  "id": "ord_01h1s5z6vf2mm1mz3hevnn9va7",
  "object": "order",
  "customerName": "string",
  "status": "placed",
  "totalPrice": 1,
  "createdAt": "2026-01-01T00:00:00Z",
  "updatedAt": "2026-01-01T00:00:00Z",
  "orderItems": [
    {
      "menuItemId": "string",
      "quantity": 1,
      "discount": 0,
      "comment": "string"
    }
  ]
}
BODY

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") do |http|
  http.request(request)
end
puts response.code

Response

{
  "id": "ord_01h1s5z6vf2mm1mz3hevnn9va7",
  "object": "order",
  "customerName": "string",
  "status": "placed",
  "totalPrice": 1,
  "createdAt": "2026-01-01T00:00:00Z",
  "updatedAt": "2026-01-01T00:00:00Z",
  "orderItems": [
    {
      "menuItemId": "string",
      "quantity": 1,
      "discount": 0,
      "comment": "string"
    }
  ]
}

{
  "type": "about:blank",
  "title": "string",
  "status": 1,
  "instance": "/some/uri-reference#specific-occurrence-context",
  "details": {}
}

{
  "type": "about:blank",
  "title": "string",
  "status": 1,
  "instance": "/some/uri-reference#specific-occurrence-context",
  "details": {}
}

{
  "type": "about:blank",
  "title": "string",
  "status": 1,
  "instance": "/some/uri-reference#specific-occurrence-context",
  "details": {}
}

{
  "type": "about:blank",
  "title": "string",
  "status": 1,
  "instance": "/some/uri-reference#specific-occurrence-context",
  "details": {}
}