Create Order

POST

/outlets/{outlet_id}/channels/{channel_id}/orders

Creates an order under the specified outlet and channel.

Request

Authorization

Add parameter in header

X-Api-Key

Example:

X-Api-Key: ********************

Path Params

Header Params

Body Params application/json

Example

{
    "fulfilment_type": "delivery",
    "serving_date": "2025-04-03",
    "timeslot_start": 54000,
    "timeslot_end": 55800,
    "timeslot_type": "asap",
    "contact_name": "{{$person.firstName}}",
    "contact_email": "{{$internet.email}}",
    "contact_number": "80000001",
    "postal_code": "038988",
    "address_line1": "8 Temasek Boulevard",
    "address_line2": "Suntec Tower 3",
    "external_order_id": "{{$string.alphanumeric(length=16,casing='upper')}}",
    "external_order_short_code": "OR{{$string.numeric(length=3)}}",
    "address_latitude": 1.3201834070900638,
    "address_longitude": 103.85793397422587,
    "order_items": [
        {
            "item_id": 380,
            "quantity": 1,
            "price_cents": 1500,
            "sub_items": [{
                "item_id": 496,
                "quantity": 1,
                "price_cents": 0
            }]
        },
        { "item_id": 480, "quantity": 2, "price_cents": 1000 }
    ]
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.atlas.kitchen/admin/v1/outlets//channels//orders' \
--header 'X-Merchant-Id;' \
--header 'Content-Type: application/json' \
--header 'X-Api-Key;' \
--data-raw '{
    "fulfilment_type": "delivery",
    "serving_date": "2025-04-03",
    "timeslot_start": 54000,
    "timeslot_end": 55800,
    "timeslot_type": "asap",
    "contact_name": "{{$person.firstName}}",
    "contact_email": "{{$internet.email}}",
    "contact_number": "80000001",
    "postal_code": "038988",
    "address_line1": "8 Temasek Boulevard",
    "address_line2": "Suntec Tower 3",
    "external_order_id": "{{$string.alphanumeric(length=16,casing='\''upper'\'')}}",
    "external_order_short_code": "OR{{$string.numeric(length=3)}}",
    "address_latitude": 1.3201834070900638,
    "address_longitude": 103.85793397422587,
    "order_items": [
        {
            "item_id": 380,
            "quantity": 1,
            "price_cents": 1500,
            "sub_items": [{
                "item_id": 496,
                "quantity": 1,
                "price_cents": 0
            }]
        },
        { "item_id": 480, "quantity": 2, "price_cents": 1000 }
    ]
}'

Responses

🟢200Success

application/json

Body

Example

{
    "id": 85,
    "identifier": null,
    "user_id": 17,
    "channel_id": 1,
    "outlet_id": 3,
    "brand_id": null,
    "fulfilment_type": "delivery",
    "state": "unpaid",
    "notes": null,
    "serving_date": "2024-10-01",
    "timeslot_start": 54000,
    "timeslot_end": 55800,
    "timeslot_range": "3:00PM–3:30PM",
    "contact_name": "John",
    "contact_email": "john@example.com",
    "contact_number": "80000001",
    "address_line1": "8 Temasek Boulevard",
    "address_line2": "Suntec Tower 3",
    "address_latitude": null,
    "address_longitude": null,
    "postal_code": "038988",
    "is_gift": false,
    "recipient_name": null,
    "recipient_contact_number": null,
    "gift_message": null,
    "is_paid": false,
    "promo_code": null,
    "delivery_fee": 0,
    "surcharge": 0,
    "admin_discount": 0,
    "discount": 0,
    "tax": 0,
    "tax_rate": "0.0",
    "tax_inclusive_prices": false,
    "subtotal": 0,
    "total": 0,
    "total_including_tax": 0,
    "is_cutlery_required": false,
    "is_contactless": false,
    "created_at": 1727423000,
    "updated_at": 1727423000,
    "cancelled_at": 1727423000,
    "completed_at": 1727423000,
    "order_items": [
        {
            "id": 214,
            "item_id": 380,
            "name": "Coffee",
            "quantity": 1,
            "currency": "SGD",
            "calculated_subtotal": 400,
            "per_unit_quantity": 1,
            "unit_label": null,
            "notes": null,
            "discount": 0,
            "price_cents": 400,
            "sub_items": [
                {
                    "id": 215,
                    "item_id": 496,
                    "name": "Iced",
                    "quantity": 1,
                    "currency": "SGD",
                    "calculated_subtotal": 0,
                    "per_unit_quantity": 1,
                    "unit_label": null,
                    "notes": null,
                    "discount": 0,
                    "price_cents": 0
                }
            ]
        },
        {
            "id": 216,
            "item_id": 480,
            "name": "Eggs Benedict",
            "quantity": 2,
            "currency": "SGD",
            "calculated_subtotal": 1600,
            "per_unit_quantity": 1,
            "unit_label": null,
            "notes": null,
            "discount": 0,
            "price_cents": 1600,
            "sub_items": []
        }
    ]
}

🔴500Server Error

🟠401Unauthorized

🟠422Invalid Parameter

🟠422Configuration Required

Modified at 2025-04-02 05:44:27

Menu Create or Update

Order Details