Skip to main content

Purpose

Create a new order in Clopos using the simplified v2 payload. Optional fields with defaults can be omitted.

HTTP Request

This endpoint requires authentication. Include your JWT in the x-token header. See Authentication for how to obtain a token and Errors for error responses.

Request Example

Payload fields

Top-level

  • auto_accept_terminal (number, optional): Terminal that auto-accepts.
  • auto_order_accept (boolean, default false): Auto-accept the order.
  • auto_order_sent_to_station (boolean, default false): Auto-send to stations after acceptance.
  • order_number (string, optional, max 20 chars): Custom order number to assign to the order.
  • sale_type_id (number, required): Sale type to use.
  • venue_id (number, required): Venue where the order belongs.
  • delivery_fee (number, optional): Delivery charge to apply.
  • comment (string, optional): Free text note for the order.

Discounts

  • discount (object, optional; defaults applied if present but fields omitted)
    • discount_type (number, default 0)
    • discount_value (number, default 0)

Service charge

  • service_charge (object, optional; defaults applied if present but fields omitted)
    • enabled (boolean, default false)
    • value (number, default 0)

Customer (required)

  • id (number)
  • phone (string)
  • address (string)
  • customer_discount_type (number)
  • name (string)

Products (array, required)

Each product item requires:
  • product_id (number)
  • product_name (string, required) — Display name of the product
  • count (number)
  • price (number)
  • status (string)
  • product_hash (string)
  • portion_size (number, default 1, optional)
  • note (string, optional) — Free text note for the product (e.g., “No onions”)
  • modifiers (array, optional; defaults to [])
    • modifier_id (number)
    • modifier_name (string, required) — Display name of the modifier
    • count (number)
    • price (number, default 0, optional)
    • portion_size (number, default 1, optional)
Optional fields and any values with defaults can be omitted; defaults are applied server-side .

Response (example)

Response Field Reference