Skip to main content
POST
/
outlets
/
{outlet_id}
/
channels
/
{channel_id}
/
orders
Create Order
curl --request POST \
  --url https://api.atlas.kitchen/admin/v1/outlets/{outlet_id}/channels/{channel_id}/orders \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <api-key>' \
  --header 'X-Merchant-Id: <api-key>' \
  --data '
{
  "serving_date": "2023-12-25",
  "timeslot_start": 123,
  "timeslot_end": 123,
  "timeslot_type": "<string>",
  "contact_name": "<string>",
  "contact_email": "<string>",
  "contact_number": "<string>",
  "fulfilment_type": "<string>",
  "notes": "<string>",
  "source_label": "<string>",
  "external_order_id": "<string>",
  "is_paid": true,
  "subtotal": 123,
  "total": 123,
  "tax": 123,
  "discount": 123,
  "surcharge": 123,
  "delivery_fee": 123,
  "order_items": [
    {
      "item_id": 123,
      "name": "<string>",
      "quantity": 123,
      "price_cents": 123,
      "notes": "<string>",
      "sub_items": [
        {}
      ]
    }
  ],
  "order_payments": [
    {
      "amount": 123,
      "capture_id": "<string>",
      "capture_type": "<string>",
      "payment_type_id": 123
    }
  ]
}
'
{
  "id": 123,
  "identifier": "<string>",
  "user_id": 123,
  "channel_id": 123,
  "outlet_id": 123,
  "brand_id": 123,
  "fulfilment_type": "<string>",
  "state": "<string>",
  "call_number": 123,
  "notes": "<string>",
  "source_label": "<string>",
  "serving_date": "2023-12-25",
  "timeslot_start": 123,
  "timeslot_end": 123,
  "timeslot_range": "<string>",
  "contact_name": "<string>",
  "contact_email": "<string>",
  "contact_number": "<string>",
  "external_order_id": "<string>",
  "external_order_short_code": "<string>",
  "is_gift": true,
  "is_paid": true,
  "promo_code": "<string>",
  "address_line1": "<string>",
  "address_line2": "<string>",
  "address_latitude": 123,
  "address_longitude": 123,
  "postal_code": "<string>",
  "is_cutlery_required": true,
  "is_contactless": true,
  "is_asap": true,
  "recipient_name": "<string>",
  "recipient_contact_number": "<string>",
  "recipient_organisation_name": "<string>",
  "gift_message": "<string>",
  "confirmation_custom_message": "<string>",
  "current_trip": {},
  "payment_breakdown": {},
  "created_at": 123,
  "updated_at": 123,
  "cancelled_at": 123,
  "completed_at": 123,
  "order_items": [
    {
      "id": 123,
      "item_id": 123,
      "name": "<string>",
      "quantity": 123,
      "currency": "<string>",
      "price_cents": 123,
      "discount": 123,
      "calculated_subtotal": 123,
      "notes": "<string>",
      "report_category": "<string>",
      "product_tags": [
        "<string>"
      ],
      "kitchen_tags": [
        "<string>"
      ],
      "sub_items": "<array>"
    }
  ],
  "order_payments": [
    {
      "id": 123,
      "capture_id": "<string>",
      "is_captured": true,
      "capture_type": "<string>",
      "payment_method_id": 123,
      "amount": 123
    }
  ]
}

Authorizations

X-Api-Key
string
header
required

Your API key provided during onboarding. Example c2fb5ae6ea99c37d...

X-Merchant-Id
string
header
required

Your numeric merchant ID. Example 1

Path Parameters

outlet_id
integer
required
channel_id
integer
required

Body

application/json
serving_date
string<date>
timeslot_start
integer
timeslot_end
integer
timeslot_type
string
contact_name
string
contact_email
string
contact_number
string
fulfilment_type
string
notes
string
source_label
string
external_order_id
string
is_paid
boolean
subtotal
integer

Admin override

total
integer

Admin override

tax
integer

Admin override

discount
integer

Admin override

surcharge
integer

Admin override

delivery_fee
integer

Admin override

order_items
object[]
order_payments
object[]

Response

Created order

id
integer
identifier
string
user_id
integer
channel_id
integer
outlet_id
integer
brand_id
integer
fulfilment_type
string
state
string
call_number
integer
notes
string | null
source_label
string | null
serving_date
string<date>
timeslot_start
integer
timeslot_end
integer
timeslot_range
string
contact_name
string
contact_email
string
contact_number
string
external_order_id
string | null
external_order_short_code
string | null
is_gift
boolean
is_paid
boolean
promo_code
string | null
address_line1
string | null
address_line2
string | null
address_latitude
number | null
address_longitude
number | null
postal_code
string | null
is_cutlery_required
boolean
is_contactless
boolean
is_asap
boolean
recipient_name
string | null
recipient_contact_number
string | null
recipient_organisation_name
string | null
gift_message
string | null
confirmation_custom_message
string | null
current_trip
object
payment_breakdown
object
created_at
integer
updated_at
integer
cancelled_at
integer | null
completed_at
integer | null
order_items
object[]
order_payments
object[]