For AI agents: the docs index is at https://developers.apicbase.com/llms.txt. Append .md to any documentation page URL to get its markdown version.
Jump to Content
Apicbase
GuidesAPI EndpointsAnnouncementsContact
Go to ApicbaseApicbase
API Endpoints
Go to Apicbase
GuidesAPI EndpointsAnnouncementsContact

Development Topics

  • ❗ Introduction
  • ❗ Scopes
  • ❗ Pagination
  • ❗ Rate Limiting

Accounts

  • Users
    • Get Usersget
    • Get User Detailsget
    • Get Outletsget
    • Get Outlet Detailsget
    • Create Outletpost
    • Edit Outletpatch
    • Get User Rolesget
  • User Connectors
    • Create User & Connectorpost
    • Get User Connectorsget
    • Get User Connector Detailsget
    • Update User Connectorpatch
    • Delete User Connectordel
  • Libraries
    • Get Librariesget
    • Get Active Libraryget
    • Switch Active Librarypost

Library

  • Library Details
    • Get Suppliersget
    • Get Supplierget
    • Create Supplierpost
    • Edit Supplierpatch
    • Get Currencyget
    • Get Custom Field Definitionsget
  • Products
    • Ingredients
      • Get Ingredientsget
      • Get Ingredient Detailsget
      • Create Ingredientpost
      • Edit Ingredientpatch
      • Clone Ingredientpost
      • Merge Ingredientspost
      • List Ingredient Mergesget
      • Revert Ingredient Mergepost
    • Menus
      • Get Menusget
      • Get Menu Detailsget
      • Get Menus Linked to an Outletget
      • Create Menupost
      • Edit Menupatch
      • Clone Menupost
      • Get Courses in a Menuget
    • Recipes
      • Get Recipesget
      • Get Recipe Detailsget
      • Create Recipepost
      • Edit Recipepatch
      • Clone Recipepost
      • Get Recipe Financial Dataget
      • Get Recipe Historical Financial Dataget
      • Get Recipe Nutritional Dataget
      • Get Recipes Linked to an Outletget
      • Swap ingredients in recipesput
    • Packages
      • Get Stock Itemsget
      • Get Stock Itemget
      • Create Stock Itempost
      • Edit Stock Itempatch
      • Get Supplier Packagesget
      • Get Supplier Packageget
      • Create Supplier Packagepost
      • Edit Supplier Packagepatch
      • Get Supplier Package Integration Dataget
    • Get Related Items through Indirect Links for Outletget
    • Get Eco Labelsget
  • Menu Planning
    • Create Menu Cycle Schedulepost
    • Get Menu Cycle Schedule Detailsget
    • Edit Menu Cycle Schedulepatch
    • Delete Menu Cycle Scheduledel
    • Copy Menu Cycle Schedulepost
    • Distribute Menu Cycle Schedulepost
    • Get Menu Cycle Instance Detailsget
    • Edit Menu Cycle Instancepatch
    • Delete Menu Cycle Instancedel
    • Planned Recipes Calendar Viewget
  • Production Plan
    • Create Production Planpost
    • Update Production Planpatch
    • Delete Production Plandel
    • Duplicate Production Planpost
    • Get Production Plansget
    • Get Production Plan Detailsget
    • Tasks
      • List Plan Tasksget
      • Get Plan Taskget
      • Delete Plan Taskdel
      • Bulk Upsert Plan Taskspost
      • Reorder Plan Taskspost
      • Reset Plan Taskspost
      • Update Plan Sub-Taskpatch
      • Delete Plan Sub-Taskdel
    • Custom Tasks
      • Create Custom Taskpost
      • Get Custom Tasksget
      • Update Custom Taskpatch
    • Production Runs
      • Create Production Runpost
      • Get Production Runsget
      • Start Production Runpost
      • Get Production Run Tasksget
      • Update Production Run Task Statuspatch
      • Finish Production Runpost
      • Update Production Run Schedulepatch
      • Delete Production Run Scheduledel
      • Delete Production Rundel
  • Compliance Tasks
    • Get Critical Control Pointsget
    • Get Critical Control Point Detailsget
    • Create Critical Control Pointpost
    • Update Critical Control Pointpatch
    • Delete Critical Control Pointdel
    • Get Task Templatesget
    • Get Task Template Detailsget
    • Create Task Templatepost
    • Update Task Templatepatch
    • Add Task Template Attachmentpost
    • Delete Task Template Attachmentdel
    • Get Task Custom Fieldsget
    • Get Outlet Tasks Calendarget
    • Get Task Occurrence Detailsget
    • Save Task Occurrencepatch
    • Complete Task Occurrencepost
    • Mark Task Occurrence Not Applicablepost
    • Delete Task Occurrencedel
    • Add Task Occurrence Attachmentpost
    • Delete Task Occurrence Attachmentdel
  • Search
    • Global Searchget
  • Management Figures
    • Get Gross Profit Reportget
    • Get Inventory Movementget
    • Get Sales Performanceget
  • Audit Logs
    • Get Audit Logsget

Inventory

  • Count Events
    • Get Top Countsget
    • Get Top Count Detailsget
    • Get Stock Items in a Top Countget
    • Start Top Countpost
    • Submit Top Countpatch
    • Cancel Top Countdel
    • Start Sub-Countpost
    • Get Sub-Count Details
    • Claim Sub-Countpatch
    • Delete All Sub-Counts in a Top Countdel
    • Update Item Quantity in a Sub-Countput
    • Overwrite Items in a Sub-Countpost
    • Delete All Items in a Sub-Countpatch
    • Submit Sub-Countpatch
    • Reopen Sub-Countpatch
    • Cancel Sub-Countdel
    • Update Sub-Count Namepatch
  • Waste Events
    • Get Waste Eventsget
    • Get Waste Event Detailsget
    • Start Waste Eventpost
    • Add Item to Waste Eventpost
    • Update Item in Waste Eventpatch
    • Remove Item from Waste Eventdel
    • Overwrite Items in a Waste Eventpost
    • Bulk Update Items in a Waste Eventpatch
    • Delete All Items in Waste Eventpatch
    • Claim Waste Eventpatch
    • Cancel Waste Eventdel
    • Submit Waste Eventpatch
  • Creation Events
    • Get Creation Eventsget
    • Get Creation Event Detailsget
    • Start Creation Eventpost
    • Add Item to Creation Eventpost
    • Update Item in Creation Eventpatch
    • Remove Item from Creation Eventdel
    • Overwrite Items in a Creation Eventpost
    • Bulk Update Items in a Creation Eventpatch
    • Delete All Items in Creation Eventpatch
    • Claim Creation Eventpatch
    • Cancel Creation Eventdel
    • Submit Creation Eventpatch
  • Transfer Events
    • Get Incoming Transfer Eventsget
    • Get Outgoing Transfer Eventsget
    • Get Outgoing Transfer Eventget
    • Claim Outgoing Transfer Eventpatch
    • Cancel Outgoing Transfer Eventdel
  • Manual Sales
    • Get Manual Sales Eventsget
    • Get Manual Sales Event Detailsget
    • Create Manual Sales Eventpost
    • Claim Manual Sales Eventpatch
    • Cancel Manual Sales Eventdel
  • Other Events
  • Stock
    • Get Stock Items in Inventoryget
    • Get Stock Item Updates for Outletget
    • Get Inventory Stock Item Detailsget
    • Get a Stock Item's Inventory Informationget
    • Update a Stock Item's Inventory Informationpost
  • Stock Periods
    • Get Stock Periodsget
    • Get Stock Periodget
    • Create Stock Periodpost
    • Edit Stock Periodpatch
    • Delete Stock Perioddel
    • Close Stock Periodpost
    • Reopen Stock Periodpost
    • Get Stock Period Summaryget
    • Get Stock Period Warningsget

Procurement

  • Purchase Orders
    • Create Purchase Orderspost
    • Get Purchase Ordersget
    • Get Purchase Order Detailsget
    • Add Packages to Purchase Orderpost
    • Send Purchase Orderpost
    • Delete Purchase Orderdel
    • Mark Purchase Order as Fetched or Viewedpatch
    • Get Invoice Status Optionsget
    • Get Invoice Filesget
    • Attach invoice file (no AI)post
    • Delete Invoice Filedel
  • Aggregated Deliveries
    • Get Aggregated Deliveriesget
    • Get Aggregated Deliveryget
    • Set the Next Delivery Datepatch
    • Close Deliveriespost
  • Deliveries
    • Get Deliveriesget
    • Get Delivery Detailsget
    • Create Delivery Draftpost
    • Edit Deliverypatch
    • Submit Delivery Draftpost
    • Cancel Delivery Draftdel
    • Get Packages in Deliveryget
    • Add Package to Delivery Draftpost
    • Edit Package in Delivery Draftpatch
    • Delete Package in Delivery Draftdel
    • Get Intake Reason Codesget
    • Get Delivery Note Filesget
    • Upload Delivery Note Filepost
    • Delete Delivery Note Filedel
    • Receive External Deliverypost
  • Invoices
    • Upload Invoices (with AI)post
    • Create Invoice Recordpost
    • Get Invoicesget
    • Get Invoice Detailsget
    • Update Invoice Recordpatch
    • Delete Invoicedel
    • Update Invoice Approval Statuspatch
    • Upload Invoice File (no AI)post
    • Delete Uploaded Invoice Filedel
    • Create Invoice Commentpost
    • Update Invoice Commentpatch
    • Delete Invoice Commentdel
    • Link Invoice to Purchase Orderpost
    • Unlink Invoice from Purchase Orderdel
    • Bulk Export Invoicespost
    • Bulk Delete Invoicespost
  • Incoming Orders
    • Get Incoming Ordersget
    • Get Incoming Orderget
    • Pick Incoming Orderpost
    • Ship Incoming Orderpost
    • Bulk Pick Incoming Orderspost
    • Bulk Ship Incoming Orderspost
  • Delivery Notes
    • Create Delivery Notepost
    • Get Delivery Notesget
    • Get Delivery Note Detailsget
    • Edit Delivery Notepatch
    • Delete Delivery Notedel
  • Ordering Details
    • Get Supplier Ordering Detailsget
    • Edit Supplier Ordering Detailspost
  • Bill of Materials
    • Calculate BOM for Single Recipepost
    • Calculate BOM for Multiple Recipespost
    • Calculate BOM for Menupost

Sales

  • Generic POS API
    • Create Items and Groupspost
    • Create or Update Itemput
    • Update Itempatch
    • Upload Sales Datapost
    • Get Connection Settingsget
    • Set Connection Settingspost
  • POS Product Linking
    • Bulk Link POS Productspost
    • Bulk Unlink POS Productspost
  • Analytics
    • Get Item Sales Dataget
    • Get Aggregated Sales Dataget
    • Get POS Items in Outletget
  • Revenue
    • Get Revenueget
    • Get Recipes Revenueget
  • Demand Forecasting
    • Generate Demand Forecastpost

Media

  • Images
    • Get Imagesget
    • Get Imageget

Suppliers

  • Suppliers API
  • Assortment Files
    • Create Assortment Filepost
    • Get Files Metadataget
    • Get File Metadataget
  • Customers and Packages
    • Get Customersget
    • Get Customer Packagesget
    • Get Customer Packageget
    • Update Customer Packagepatch
  • Purchase Orders
    • Mark Purchase Order as Fetched or Viewedpatch
    • Get Supplier Purchase Ordersget
  • Events
    • Get Eventsget
  • Delivery Notes
    • Create Delivery Notepost
    • Get Delivery Notesget
    • Get Delivery Note Detailsget
    • Edit Delivery Notepatch
    • Delete Delivery Notedel
Powered by 

Other Events

Updated over 1 year ago


Cancel Manual Sales Event
Stock
Did this page help you?

Updated over 1 year ago


Cancel Manual Sales Event
Stock
Did this page help you?