Atlas Open API
  1. Orders
Atlas Open API
  • Introduction
  • Authentication
  • Date and Time
  • Errors
  • Webhooks
    • Incoming
      • Reservations (BETA)
    • Outgoing
      • Menus, Stocks, Orders, Outlets, Users
  • Menus
    • Menu List
      GET
    • Menu Details
      GET
  • Orders
    • Create Order
      POST
    • Order Details
      GET
  • Stocks
    • Outlet Stocks
      GET
  • Users
    • User Sync
      GET
  1. Orders

Order Details

Designing
GET
/orders/{order_id}
Returns the details of a specific order

Request

Authorization
Add parameter in header
X-Api-Key
Example:
X-Api-Key: ********************
Path Params
order_id
string 
required
Header Params
X-Merchant-Id
string 
required
Your merchant ID

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://api-stg.atlas.kitchen/orders/' \
--header 'X-Merchant-Id;'

Responses

🟢200Success
application/json
Body
id
integer 
required
ID that uniquely identifies the order
user_id
integer 
required
User associated with the order
channel_id
integer 
required
Channel associated with the order
outlet_id
integer 
required
Outlet associated with the order
brand_id
integer  | null 
required
Brand associated with the order
identifier
string  | null 
required
state
string 
required
Current state of the order
fulfilment_type
enum<string> 
required
Specifies how the order will be fulfilled
Allowed values:
dine_inpickupdelivery
serving_date
string <date>
required
Date the order will be served, format YYYY-MM-DD
timeslot_start
integer 
required
Corresponds to the start of serving timeslot, number of seconds from the start of serving_date.
timeslot_end
integer 
required
Corresponds to the end of serving timeslot, number of seconds from the start of serving_date.
timeslot_type
enum<string> 
required
Type of timeslot the value corresponds to
Allowed value:
asap
timeslot_range
string 
read-onlyrequired
Human-readable presentation of the timeslot range
order_items
array[object (OrderItemResponse) {12}] 
required
id
integer 
required
ID that uniquely identifies the order item
item_id
integer 
required
Item the order item refers to
name
string 
required
Name of the item
quantity
integer 
required
Quantity of the item
>= 1
price_cents
integer 
required
currency
string 
required
Currency of price
discount
integer 
required
Default:
0
notes
string  | null 
required
Additional notes about the item
calculated_subtotal
integer  | null 
required
per_unit_quantity
integer  | null 
required
unit_label
string  | null 
required
sub_items
array [object {11}] 
required
contact_name
string  | null 
required
Name of the contact person, required for deliveriy
contact_email
string  | null 
required
Email of the contact person, required for delivery
contact_number
string  | null 
required
Mobile number of the contact person, required for delivery
address_line1
string  | null 
required
Component of the delivery address, required for delivery
address_line2
string  | null 
required
Component of the delivery address, required for delivery
external_order_id
string  | null 
required
External custom order ID
external_order_short_code
string  | null 
required
External custom order ID for easy reference
call_number
string 
required
postal_code
string  | null 
required
Postal code of the delivery address, required for delivery
address_latitude
number  | null 
required
Component of delivery address coordinates, used to check if address is within the outlet's service zone.
address_longitude
number  | null 
required
Component of delivery address coordinates, used to check if address is within the outlet's service zone.
is_cutlery_required
boolean 
required
Determines whether cutlery will be provided for delivery orders
Default:
false
is_contactless
boolean 
required
Default:
false
notes
string  | null 
required
Additional notes about the order
is_gift
boolean 
required
Specifies if the order is for gifting, in which case, ther order price won't be visible to the recipient.
Default:
false
recipient_name
string  | null 
required
Name of the gift recipient, required for gift orders
recipient_contact_number
string  | null 
required
Contact number of the gift recipient, required for gift orders
gift_message
string  | null 
required
Message to the gift recipient
is_paid
boolean 
required
Default:
false
promo_code
string  | null 
required
created_at
integer 
required
Timestamp on order creation. Format: unix time
updated_at
integer 
required
Timestamp on last order update. Format: unix time
cancelled_at
integer  | null 
required
Timestamp on order cancellation. Format: unix time
completed_at
integer  | null 
required
Timestamp on order completion. Format: unix time
donation_amount
integer 
required
>= 0
Default:
0
confirmation_custom_message
string  | null 
required
Example
{
  "id": 0,
  "user_id": 0,
  "channel_id": 0,
  "outlet_id": 0,
  "brand_id": 0,
  "identifier": "string",
  "state": "string",
  "fulfilment_type": "dine_in",
  "serving_date": "2019-08-24",
  "timeslot_start": 0,
  "timeslot_end": 0,
  "timeslot_type": "asap",
  "timeslot_range": "string",
  "order_items": [
    {
      "id": 0,
      "item_id": 0,
      "name": "string",
      "quantity": 1,
      "price_cents": 0,
      "currency": "string",
      "discount": 0,
      "notes": "string",
      "calculated_subtotal": 0,
      "per_unit_quantity": 0,
      "unit_label": "string",
      "sub_items": [
        {
          "id": 0,
          "item_id": 0,
          "name": "string",
          "quantity": 1,
          "price_cents": 0,
          "currency": "string",
          "discount": 0,
          "notes": "string",
          "calculated_subtotal": 0,
          "per_unit_quantity": 0,
          "unit_label": "string"
        }
      ]
    }
  ],
  "contact_name": "string",
  "contact_email": "string",
  "contact_number": "string",
  "address_line1": "string",
  "address_line2": "string",
  "external_order_id": "string",
  "external_order_short_code": "string",
  "call_number": "string",
  "postal_code": "string",
  "address_latitude": 0,
  "address_longitude": 0,
  "is_cutlery_required": false,
  "is_contactless": false,
  "notes": "string",
  "is_gift": false,
  "recipient_name": "string",
  "recipient_contact_number": "string",
  "gift_message": "string",
  "is_paid": false,
  "promo_code": "string",
  "created_at": 0,
  "updated_at": 0,
  "cancelled_at": 0,
  "completed_at": 0,
  "donation_amount": 0,
  "confirmation_custom_message": "string"
}
🟠404Not Found
🔴500Server Error
🟠401Unauthorized
Modified at 2024-10-02 05:23:08
Previous
Create Order
Next
Outlet Stocks
Built with