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
    • Menu Create or Update
      POST
  • Orders
    • Create Order
      POST
    • Order Details
      GET
    • Update Order
      PATCH
  • Stocks
    • Outlet Stocks
      GET
  • Users
    • User Sync
      POST
  • Tables
    • Tables
      GET
  • Carts
    • Untitled Endpoint
      POST
  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

Header Params

Request Code 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.atlas.kitchen/admin/v1/orders/' \
--header 'X-Merchant-Id;' \
--header 'X-Api-Key;'

Responses

🟢200Success
application/json
Body

Example
{
    "id": 0,
    "user_id": 0,
    "channel_id": 0,
    "outlet_id": 0,
    "brand_id": 0,
    "identifier": "string",
    "state": "unpaid",
    "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
Update Order
Built with