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
}
]
}
'import requests
url = "https://api.atlas.kitchen/admin/v1/outlets/{outlet_id}/channels/{channel_id}/orders"
payload = {
"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
}
]
}
headers = {
"X-Api-Key": "<api-key>",
"X-Merchant-Id": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'X-Api-Key': '<api-key>',
'X-Merchant-Id': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
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
}
]
})
};
fetch('https://api.atlas.kitchen/admin/v1/outlets/{outlet_id}/channels/{channel_id}/orders', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.atlas.kitchen/admin/v1/outlets/{outlet_id}/channels/{channel_id}/orders",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'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
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Api-Key: <api-key>",
"X-Merchant-Id: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.atlas.kitchen/admin/v1/outlets/{outlet_id}/channels/{channel_id}/orders"
payload := strings.NewReader("{\n \"serving_date\": \"2023-12-25\",\n \"timeslot_start\": 123,\n \"timeslot_end\": 123,\n \"timeslot_type\": \"<string>\",\n \"contact_name\": \"<string>\",\n \"contact_email\": \"<string>\",\n \"contact_number\": \"<string>\",\n \"fulfilment_type\": \"<string>\",\n \"notes\": \"<string>\",\n \"source_label\": \"<string>\",\n \"external_order_id\": \"<string>\",\n \"is_paid\": true,\n \"subtotal\": 123,\n \"total\": 123,\n \"tax\": 123,\n \"discount\": 123,\n \"surcharge\": 123,\n \"delivery_fee\": 123,\n \"order_items\": [\n {\n \"item_id\": 123,\n \"name\": \"<string>\",\n \"quantity\": 123,\n \"price_cents\": 123,\n \"notes\": \"<string>\",\n \"sub_items\": [\n {}\n ]\n }\n ],\n \"order_payments\": [\n {\n \"amount\": 123,\n \"capture_id\": \"<string>\",\n \"capture_type\": \"<string>\",\n \"payment_type_id\": 123\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Api-Key", "<api-key>")
req.Header.Add("X-Merchant-Id", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.atlas.kitchen/admin/v1/outlets/{outlet_id}/channels/{channel_id}/orders")
.header("X-Api-Key", "<api-key>")
.header("X-Merchant-Id", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"serving_date\": \"2023-12-25\",\n \"timeslot_start\": 123,\n \"timeslot_end\": 123,\n \"timeslot_type\": \"<string>\",\n \"contact_name\": \"<string>\",\n \"contact_email\": \"<string>\",\n \"contact_number\": \"<string>\",\n \"fulfilment_type\": \"<string>\",\n \"notes\": \"<string>\",\n \"source_label\": \"<string>\",\n \"external_order_id\": \"<string>\",\n \"is_paid\": true,\n \"subtotal\": 123,\n \"total\": 123,\n \"tax\": 123,\n \"discount\": 123,\n \"surcharge\": 123,\n \"delivery_fee\": 123,\n \"order_items\": [\n {\n \"item_id\": 123,\n \"name\": \"<string>\",\n \"quantity\": 123,\n \"price_cents\": 123,\n \"notes\": \"<string>\",\n \"sub_items\": [\n {}\n ]\n }\n ],\n \"order_payments\": [\n {\n \"amount\": 123,\n \"capture_id\": \"<string>\",\n \"capture_type\": \"<string>\",\n \"payment_type_id\": 123\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.atlas.kitchen/admin/v1/outlets/{outlet_id}/channels/{channel_id}/orders")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Api-Key"] = '<api-key>'
request["X-Merchant-Id"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"serving_date\": \"2023-12-25\",\n \"timeslot_start\": 123,\n \"timeslot_end\": 123,\n \"timeslot_type\": \"<string>\",\n \"contact_name\": \"<string>\",\n \"contact_email\": \"<string>\",\n \"contact_number\": \"<string>\",\n \"fulfilment_type\": \"<string>\",\n \"notes\": \"<string>\",\n \"source_label\": \"<string>\",\n \"external_order_id\": \"<string>\",\n \"is_paid\": true,\n \"subtotal\": 123,\n \"total\": 123,\n \"tax\": 123,\n \"discount\": 123,\n \"surcharge\": 123,\n \"delivery_fee\": 123,\n \"order_items\": [\n {\n \"item_id\": 123,\n \"name\": \"<string>\",\n \"quantity\": 123,\n \"price_cents\": 123,\n \"notes\": \"<string>\",\n \"sub_items\": [\n {}\n ]\n }\n ],\n \"order_payments\": [\n {\n \"amount\": 123,\n \"capture_id\": \"<string>\",\n \"capture_type\": \"<string>\",\n \"payment_type_id\": 123\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"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
}
]
}{
"type": "<string>",
"message": "<string>",
"error_hash": {}
}Creates a new order for the given outlet and channel. Requires a configured channel link. Supports 3-level item nesting, multiple payments, and admin overrides for payment breakdown fields.
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
}
]
}
'import requests
url = "https://api.atlas.kitchen/admin/v1/outlets/{outlet_id}/channels/{channel_id}/orders"
payload = {
"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
}
]
}
headers = {
"X-Api-Key": "<api-key>",
"X-Merchant-Id": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'X-Api-Key': '<api-key>',
'X-Merchant-Id': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
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
}
]
})
};
fetch('https://api.atlas.kitchen/admin/v1/outlets/{outlet_id}/channels/{channel_id}/orders', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.atlas.kitchen/admin/v1/outlets/{outlet_id}/channels/{channel_id}/orders",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'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
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Api-Key: <api-key>",
"X-Merchant-Id: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.atlas.kitchen/admin/v1/outlets/{outlet_id}/channels/{channel_id}/orders"
payload := strings.NewReader("{\n \"serving_date\": \"2023-12-25\",\n \"timeslot_start\": 123,\n \"timeslot_end\": 123,\n \"timeslot_type\": \"<string>\",\n \"contact_name\": \"<string>\",\n \"contact_email\": \"<string>\",\n \"contact_number\": \"<string>\",\n \"fulfilment_type\": \"<string>\",\n \"notes\": \"<string>\",\n \"source_label\": \"<string>\",\n \"external_order_id\": \"<string>\",\n \"is_paid\": true,\n \"subtotal\": 123,\n \"total\": 123,\n \"tax\": 123,\n \"discount\": 123,\n \"surcharge\": 123,\n \"delivery_fee\": 123,\n \"order_items\": [\n {\n \"item_id\": 123,\n \"name\": \"<string>\",\n \"quantity\": 123,\n \"price_cents\": 123,\n \"notes\": \"<string>\",\n \"sub_items\": [\n {}\n ]\n }\n ],\n \"order_payments\": [\n {\n \"amount\": 123,\n \"capture_id\": \"<string>\",\n \"capture_type\": \"<string>\",\n \"payment_type_id\": 123\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Api-Key", "<api-key>")
req.Header.Add("X-Merchant-Id", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.atlas.kitchen/admin/v1/outlets/{outlet_id}/channels/{channel_id}/orders")
.header("X-Api-Key", "<api-key>")
.header("X-Merchant-Id", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"serving_date\": \"2023-12-25\",\n \"timeslot_start\": 123,\n \"timeslot_end\": 123,\n \"timeslot_type\": \"<string>\",\n \"contact_name\": \"<string>\",\n \"contact_email\": \"<string>\",\n \"contact_number\": \"<string>\",\n \"fulfilment_type\": \"<string>\",\n \"notes\": \"<string>\",\n \"source_label\": \"<string>\",\n \"external_order_id\": \"<string>\",\n \"is_paid\": true,\n \"subtotal\": 123,\n \"total\": 123,\n \"tax\": 123,\n \"discount\": 123,\n \"surcharge\": 123,\n \"delivery_fee\": 123,\n \"order_items\": [\n {\n \"item_id\": 123,\n \"name\": \"<string>\",\n \"quantity\": 123,\n \"price_cents\": 123,\n \"notes\": \"<string>\",\n \"sub_items\": [\n {}\n ]\n }\n ],\n \"order_payments\": [\n {\n \"amount\": 123,\n \"capture_id\": \"<string>\",\n \"capture_type\": \"<string>\",\n \"payment_type_id\": 123\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.atlas.kitchen/admin/v1/outlets/{outlet_id}/channels/{channel_id}/orders")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Api-Key"] = '<api-key>'
request["X-Merchant-Id"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"serving_date\": \"2023-12-25\",\n \"timeslot_start\": 123,\n \"timeslot_end\": 123,\n \"timeslot_type\": \"<string>\",\n \"contact_name\": \"<string>\",\n \"contact_email\": \"<string>\",\n \"contact_number\": \"<string>\",\n \"fulfilment_type\": \"<string>\",\n \"notes\": \"<string>\",\n \"source_label\": \"<string>\",\n \"external_order_id\": \"<string>\",\n \"is_paid\": true,\n \"subtotal\": 123,\n \"total\": 123,\n \"tax\": 123,\n \"discount\": 123,\n \"surcharge\": 123,\n \"delivery_fee\": 123,\n \"order_items\": [\n {\n \"item_id\": 123,\n \"name\": \"<string>\",\n \"quantity\": 123,\n \"price_cents\": 123,\n \"notes\": \"<string>\",\n \"sub_items\": [\n {}\n ]\n }\n ],\n \"order_payments\": [\n {\n \"amount\": 123,\n \"capture_id\": \"<string>\",\n \"capture_type\": \"<string>\",\n \"payment_type_id\": 123\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"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
}
]
}{
"type": "<string>",
"message": "<string>",
"error_hash": {}
}Authorizations
Your API key provided during onboarding. Example c2fb5ae6ea99c37d...
Your numeric merchant ID. Example 1
Body
application/json
Admin override
Admin override
Admin override
Admin override
Admin override
Admin override
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Response
Created order
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Was this page helpful?
⌘I