Atlas Open API
  1. Stocks
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
    • Update Order
      PATCH
  • Stocks
    • Outlet Stocks
      GET
  • Users
    • User Sync
      GET
  1. Stocks

Outlet Stocks

GET
/outlets/{outlet_id}/serving_dates/{serving_date}/stocks
Returns a list of current stock quantities for all products at the outlet on the specified day, useful for identifying items in stock.
Stocks returned are arranged by descending quantity, where -1 means unlimited quantity.

Request

Authorization
Add parameter in header
X-Api-Key
Example:
X-Api-Key: ********************
Path Params
outlet_id
integer 
required
Outlet to get the stocks for
Example:
5
serving_date
string 
required
Date to get the stocks for. Format: YYYY-MM-DD
Example:
2024-09-01
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.atlas.kitchen/outlets/5/serving_dates/2024-09-01/stocks' \
--header 'X-Merchant-Id;' \
--header 'X-Api-Key;'

Responses

🟢200ListResponse
application/json
Body
object
string 
required
Specifies the object type of the items
outlet_id
integer 
required
Outlet for which the stock list is for
serving_date
string 
required
Date for which the stock list is valid
items
array [object {2}] 
required
item_id
integer 
required
quantity
integer 
required
Number available for the serving date.
-1 signifies unlimited quantity
Example
{
  "object": "stock",
  "outlet_id": 241,
  "serving_date": "2024-09-01",
  "items": [
    {
      "product_id": 379,
      "quantity": 100
    },
    {
      "product_id": 353,
      "quantity": 0
    },
    {
      "product_id": 337,
      "quantity": -1
    },
    {
      "product_id": 352,
      "quantity": -1
    }
  ]
}
🟠404Not Found
🔴500Server Error
🟠401Unauthorized
🟠422Invalid Parameter
Previous
Update Order
Next
User Sync
Built with