Skip to main content
POST
/
cart
/
order
Create order
curl --request POST \
  --url https://api.atlas.kitchen/storefronts/v1/cart/order \
  --header 'X-Channel-Id: <api-key>'
{
  "id": 123,
  "identifier": "<string>",
  "channel_id": 123,
  "outlet_id": 123,
  "brand_id": 123,
  "brand": {
    "name": "<string>"
  },
  "fulfilment_type": "<string>",
  "state": "<string>",
  "call_number": "<string>",
  "notes": "<string>",
  "serving_date": "2023-12-25",
  "timeslot_start": 123,
  "timeslot_end": 123,
  "timeslot_range": "<string>",
  "timeslot_type": "<string>",
  "contact_name": "<string>",
  "contact_email": "<string>",
  "contact_number": "<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,
  "is_gift": true,
  "recipient_name": "<string>",
  "recipient_contact_number": "<string>",
  "recipient_organisation_name": "<string>",
  "gift_message": "<string>",
  "is_paid": true,
  "promo_code": "<string>",
  "confirmation_custom_message": "<string>",
  "payment_breakdown": {
    "minimum_order_value": 123,
    "donation_amount": 123,
    "cash_vouchers_amount": 123,
    "service_charge": 123,
    "delivery_fee": 123,
    "amount_to_free_delivery": 123,
    "amount_to_next_delivery_fee": 123,
    "delivery_fee_waiver_cart_subtotal": 123,
    "surcharge": 123,
    "surcharge_label": "<string>",
    "use_points": true,
    "points_amount": 123,
    "points_value": 123,
    "discount": 123,
    "admin_discount": 123,
    "is_post_tax_discount": true,
    "subtotal": 123,
    "total": 123,
    "total_including_tax": 123,
    "tax": 123,
    "tax_inclusive_prices": true,
    "amount_paid": 123,
    "amount_unpaid": 123
  },
  "claim_token_url": "<string>",
  "eligible_points": 123,
  "eligible_points_value": 123,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "cancelled_at": "2023-11-07T05:31:56Z",
  "completed_at": "2023-11-07T05:31:56Z",
  "order_items": [
    {
      "id": 123,
      "item_id": 123,
      "name": "<string>",
      "quantity": 123,
      "currency": "<string>",
      "price_cents": 123,
      "discount": 123,
      "calculated_subtotal": 123,
      "per_unit_quantity": 123,
      "unit_label": "<string>",
      "notes": "<string>",
      "cart_item_id": 123,
      "item_modifier_group_id": 123,
      "modifier_id": 123,
      "sub_items": "<array>"
    }
  ],
  "order_payments": [
    {
      "id": 123,
      "capture_id": "<string>",
      "is_captured": true,
      "capture_type": "<string>",
      "payment_type_id": 123,
      "amount": 123
    }
  ]
}

Authorizations

X-Channel-Id
string
header
required

Channel identifier. A second header X-Session-Id is also required.

Response

Order created successfully

id
integer
identifier
string
channel_id
integer
outlet_id
integer
brand_id
integer
brand
object
fulfilment_type
string
state
string
call_number
string | null
notes
string | null
serving_date
string<date>
timeslot_start
integer
timeslot_end
integer
timeslot_range
string
timeslot_type
string
contact_name
string
contact_email
string
contact_number
string
address_line1
string | null
address_line2
string | null
address_latitude
number<double> | null
address_longitude
number<double> | null
postal_code
string | null
is_cutlery_required
boolean
is_contactless
boolean
is_asap
boolean
is_gift
boolean
recipient_name
string | null
recipient_contact_number
string | null
recipient_organisation_name
string | null
gift_message
string | null
is_paid
boolean
promo_code
string | null
confirmation_custom_message
string | null
payment_breakdown
object
claim_token_url
string | null
eligible_points
integer
eligible_points_value
integer
created_at
string<date-time>
updated_at
string<date-time>
cancelled_at
string<date-time> | null
completed_at
string<date-time> | null
order_items
object[]
order_payments
object[]