Skip to main content
POST
/
orders
Create order
curl --request POST \
  --url https://integrations.clopos.com/open-api/orders \
  --header 'Content-Type: application/json' \
  --header 'x-brand: <api-key>' \
  --header 'x-token: <api-key>' \
  --header 'x-venue: <api-key>' \
  --data '"<any>"'
"<any>"

​
Purpose

Converts line items, customer information, and amounts from your POS integrations into a Clopos order in a single request.

​
HTTP Request

POST https://integrations.clopos.com/open-api/orders

​
Authorization

Send the following headers for all fields:
  • x-token: Your OAuth access token
  • x-brand: Your brand code
  • x-venue: Your branch ID
  • Idempotency-Key: A unique value to prevent duplicate calls with the same body (recommended)

​
Prerequisites

  • The top-level customer_id must be provided.
  • Service context is required in payload.service:
    • sale_type_id — a valid sale type ID from List Sale Types
    • sale_type_name — human-readable sale type name
    • venue_id and venue_name — the venue where the order will be fulfilled
  • Product and modifier identifiers must exist in the POS catalog. Include the meta.order_product data returned by catalog APIs for accurate reconciliation.
  • Totals and discounts are recalculated by the platform; send the raw values shown to operators.

​
Request Example

curl --location 'https://integrations.clopos.com/open-api/orders' \
  -H 'x-token: oauth_example_token' \
  -H 'x-brand: openapitest' \
  -H 'x-venue: 1' \
  -H 'Idempotency-Key: 0fe7bc1e-9972-4c2f-bf03-4e0f09ba9d9d' \
  -H 'Content-Type: application/json' \
  -d '{
        "customer_id": 9,
        "payload": {
          "service": {
            "sale_type_id": 2,
            "sale_type_name": "Delivery",
            "venue_id": 1,
            "venue_name": "Main"
          },
          "customer": {
            "id": 9,
            "phone": "+994705401040",
            "address": null,
            "customer_discount_type": 1,
            "name": "Rahid Akhundzada"
          },
          "products": [
            {
              "product_id": 1,
              "count": 1,
              "product_modificators": [
                { "modificator_id": 187, "count": 1 },
                { "modificator_id": 201, "count": 1 }
              ],
              "meta": {
                "price": 0,
                "order_product": {
                  "product": {
                    "id": 1,
                    "type": "DISH",
                    "name": "Mega Dürüm Menü Alana Çiğ Köfte Dürüm",
                    "category_id": 1,
                    "station_id": 1,
                    "image": {
                      "original": "https://cdn.clopos.com/omega/f78e74e9-75da-468f-b7cf-96bed863832f/original.jpg",
                      "thumb": "https://cdn.clopos.com/omega/f78e74e9-75da-468f-b7cf-96bed863832f/thumb.jpg"
                    },
                    "meta": {
                      "modifier_pos": {
                        "5": 0,
                        "8": 1,
                        "9": 2,
                        "32": 3
                      }
                    }
                  },
                  "count": 1,
                  "status": "completed",
                  "product_modificators": [
                    {
                      "modificator": {
                        "id": 187,
                        "name": "yyy",
                        "price": 3
                      },
                      "count": 1
                    },
                    {
                      "modificator": {
                        "id": 201,
                        "name": "S-bb",
                        "price": 15
                      },
                      "count": 1
                    }
                  ],
                  "product_hash": "MTExODcsMTEyMDE="
                }
              }
            }
          ],
          "meta": {
            "comment": "",
            "discount": {
              "discount_type": 1,
              "discount_value": 10
            },
            "orderTotal": "16.2000",
            "apply_service_charge": true,
            "customer_discount_type": 1,
            "service_charge_value": 0
          }
        }
      }'

​
Full payload example

{
  "customer_id": 9,
  "payload": {
    "service": {
      "sale_type_id": 2,
      "sale_type_name": "Delivery",
      "venue_id": 1,
      "venue_name": "Main"
    },
    "customer": {
      "id": 9,
      "name": "Rahid Akhundzada",
      "customer_discount_type": 1,
      "phone": "+994705401040",
      "address": null
    },
    "products": [
      {
        "product_id": 1,
        "count": 1,
        "product_modificators": [
          { "modificator_id": 187, "count": 1 },
          { "modificator_id": 201, "count": 1 }
        ],
        "meta": {
          "price": 0,
          "order_product": {
            "product": {
              "id": 1,
              "name": "Mega Dürüm Menü Alana Çiğ Köfte Dürüm",
              "category_id": 1,
              "station_id": 1,
              "price": 0
            },
            "count": 1,
            "status": "completed",
            "product_modificators": [
              { "modificator_id": 187, "count": 1 },
              { "modificator_id": 201, "count": 1 }
            ],
            "product_hash": "MTExODcsMTEyMDE="
          }
        }
      }
    ],
    "meta": {
      "comment": "",
      "discount": {
        "discount_type": 1,
        "discount_value": 10
      },
      "orderTotal": "16.2000",
      "apply_service_charge": true,
      "customer_discount_type": 1,
      "service_charge_value": 0
    }
  }
}

​
Response

​
201 Created — Order created

{
  "success": true,
  "data": {
    "status": "PENDING",
    "payload": {
      "service": {
        "sale_type_id": 2,
        "sale_type_name": "Delivery",
        "venue_id": 1,
        "venue_name": "Main"
      },
      "customer": {
        "id": 9,
        "customer_discount_type": 1,
        "name": "Rahid Akhundzada"
      },
      "products": [
        {
          "product_id": 1,
          "count": 1,
          "product_modificators": [
            { "modificator_id": 187, "count": 1 },
            { "modificator_id": 201, "count": 1 }
          ],
          "meta": {
            "price": 0,
            "order_product": {
              "product": {
                "id": 1,
                "name": "Mega Dürüm Menü Alana Çiğ Köfte Dürüm",
                "category_id": 1,
                "station_id": 1,
                "price": 0
              },
              "count": 1,
              "status": "completed",
              "product_modificators": [
                { "modificator_id": 187, "count": 1 },
                { "modificator_id": 201, "count": 1 }
              ],
              "product_hash": "MTExODcsMTEyMDE="
            }
          }
        }
      ],
      "meta": {
        "comment": null,
        "discount": {

Authorizations

​
x-token
string
header
required

Access token obtained from /auth endpoint

​
x-brand
string
header
required

Brand identifier

​
x-venue
string
header
required

Venue identifier

Body

application/json · any

Order details

The body is of type any.

Response

Order created successfully

The response is of type any.