Jump to Content
Guides
API Endpoints
Announcements
Contact
v1
v2
Go to Apicbase
API Endpoints
Go to Apicbase
v2
Guides
API Endpoints
Announcements
Contact
❗ Introduction
All
Pages
Start typing to search…
JUMP TO
Development Topics
❗ Introduction
❗ Scopes
❗ Pagination
❗ Rate Limiting
Accounts
Users
Get Users
get
Get User Details
get
Get Outlets
get
Get Outlet Details
Create Outlet
post
Edit Outlet
patch
Get User Roles
get
User Connectors
Create User & Connector
post
Get User Connectors
get
Get User Connector Details
get
Update User Connector
patch
Delete User Connector
del
Libraries
Get Libraries
get
Get Active Library
get
Switch Active Library
post
Library
Library Details
Get Suppliers
get
Get Supplier
get
Create Supplier
post
Edit Supplier
patch
Get Currency
get
Get Custom Field Definitions
get
Products
Ingredients
Get Ingredients
get
Get Ingredient Details
get
Create Ingredient
post
Edit Ingredient
patch
Menus
Get Menus
get
Get Menu Details
get
Get Menus Linked to an Outlet
get
Create Menu
post
Edit Menu
patch
Get Courses in a Menu
get
Recipes
Get Recipes
get
Get Recipe Details
get
Create Recipe
post
Edit Recipe
patch
Get Recipe Historical Financial Data
get
Get Recipe Nutritional Data
get
Get Recipes Linked to an Outlet
get
Swap ingredients in recipes
put
Packages
Get Stock Items
get
Get Stock Item
get
Create Stock Item
post
Edit Stock Item
patch
Get Supplier Packages
get
Get Supplier Package
get
Create Supplier Package
post
Edit Supplier Package
patch
Get Related Items through Indirect Links for Outlet
get
Get Eco Labels
get
Menu Planning
Create Menu Cycle Schedule
post
Get Menu Cycle Schedule Details
get
Edit Menu Cycle Schedule
patch
Delete Menu Cycle Schedule
del
Copy Menu Cycle Schedule
post
Distribute Menu Cycle Schedule
post
Get Menu Cycle Instance Details
get
Edit Menu Cycle Instance
patch
Delete Menu Cycle Instance
del
Planned Recipes Calendar View
get
Production Plan
Create Production Plan
Update Production Plan
patch
Get Production Plans
get
Get Production Plan Details
get
Custom Tasks
Create Custom Task
post
Get Custom Tasks
get
Update Custom Task
patch
Search
Global Search
get
Audit Logs
Get Audit Logs
get
Inventory
Count Events
Get Top Counts
get
Get Top Count Details
get
Get Stock Items in a Top Count
get
Start Top Count
post
Submit Top Count
patch
Cancel Top Count
del
Start Sub-Count
post
Get Sub-Count Details
get
Claim Sub-Count
patch
Delete All Sub-Counts in a Top Count
del
Update Item Quantity in a Sub-Count
put
Overwrite Items in a Sub-Count
post
Delete All Items in a Sub-Count
patch
Submit Sub-Count
patch
Reopen Sub-Count
patch
Cancel Sub-Count
del
Update Sub-Count Name
patch
Waste Events
Get Waste Events
get
Get Waste Event Details
get
Start Waste Event
post
Add Item to Waste Event
post
Update Item in Waste Event
patch
Remove Item from Waste Event
del
Overwrite Items in a Waste Event
post
Bulk Update Items in a Waste Event
patch
Delete All Items in Waste Event
patch
Claim Waste Event
patch
Cancel Waste Event
del
Submit Waste Event
patch
Creation Events
Get Creation Events
Get Creation Event Details
get
Start Creation Event
post
Add Item to Creation Event
post
Update Item in Creation Event
Remove Item from Creation Event
del
Overwrite Items in a Creation Event
post
Bulk Update Items in a Creation Event
patch
Delete All Items in Creation Event
patch
Claim Creation Event
patch
Cancel Creation Event
del
Submit Creation Event
patch
Other Events
Get Incoming Transfer Events
get
Get Outgoing Transfer Events
get
Create Manual Sales Event
post
Stock
Get Stock Items in Inventory
get
Get Stock Item Updates for Outlet
get
Get Inventory Stock Item Details
get
Get a Stock Item's Inventory Information
get
Update a Stock Item's Inventory Information
post
Procurement
Purchase Orders
Get Purchase Orders
get
Get Purchase Order Details
get
Update Invoice Status
patch
Get Invoice Status Options
get
Get Invoice Files
get
Attach invoice file (no AI)
post
Delete Invoice File
del
Aggregated Deliveries
Get Aggregated Deliveries
get
Get Aggregated Delivery
get
Set the Next Delivery Date
patch
Close Deliveries
post
Deliveries
Get Deliveries
get
Get Delivery Details
get
Create Delivery Draft
post
Edit Delivery
patch
Submit Delivery Draft
post
Cancel Delivery Draft
del
Get Packages in Delivery
get
Add Package to Delivery Draft
post
Edit Package in Delivery Draft
patch
Delete Package in Delivery Draft
del
Get Intake Reason Codes
get
Get Delivery Note Files
get
Upload Delivery Note File
post
Delete Delivery Note File
del
Receive External Delivery
post
Invoices
Upload Invoices (with AI)
post
Create Invoice Record
post
Get Invoices
get
Get Invoice Details
get
Update Invoice Record
patch
Delete Invoice
del
Update Invoice Approval Status
patch
Upload Invoice File (no AI)
post
Delete Uploaded Invoice File
del
Create Invoice Comment
post
Update Invoice Comment
patch
Delete Invoice Comment
del
Link Invoice to Purchase Order
post
Unlink Invoice from Purchase Order
del
Bulk Export Invoices
post
Bulk Delete Invoices
post
Incoming Orders
Get Incoming Orders
get
Get Incoming Order
get
Delivery Notes
Create a new delivery note
post
List delivery notes
get
Get delivery note details
get
Update a delivery note
patch
Delete a delivery note
del
Ordering Details
Get Supplier Ordering Details
get
Edit Supplier Ordering Details
post
Sales
Generic POS API
Create Items and Groups
post
Create or Update Item
put
Update Item
patch
Upload Sales Data
post
Get Connection Settings
get
Set Connection Settings
post
Analytics
Get Item Sales Data
get
Get Aggregated Sales Data
get
Get POS Items in Outlet
get
Revenue
Get Revenue
get
Get Recipes Revenue
get
Demand Forecasting
Generate Demand Forecast
post
Media
Images
Get Images
get
Get Image
get
Suppliers
Suppliers API
Assortment Files
Create Assortment File
post
Get Files Metadata
get
Get File Metadata
get
Customers and Packages
Get Customers
get
Get Customer Packages
get
Get Customer Package
get
Purchase Orders
Mark Purchase Order as Fetched or Viewed
patch
Get Supplier Purchase Orders
get
Events
Get Events
get
Powered by
❗ Introduction
Ask AI
