Listing Outlets

An outlet in Apicbase represents a physical location — a restaurant, kitchen, or any operational site — within your library. Outlets are central to how Apicbase organises inventory, procurement, and sales data: stock is tracked per outlet, purchase orders are received into an outlet, and count events are performed at an outlet.

Because of this, the outlet ID is a required parameter in the majority of inventory and procurement API calls. Fetching your outlets and storing their IDs is typically one of the first steps in any integration.

Fetching Outlets

Use the Get Outlets endpoint to retrieve all outlets in the current library. Each outlet object includes its id, name, and associated metadata.

All outlets within a library share the same currency. See Fetching the Library's Currency if you need to display or convert price values.

Using the Outlet ID

Once you have fetched your outlets, hold on to the id field of each one. This ID is required whenever you interact with outlet-scoped resources, for example:

• Inventory count events: POST /inventory/outlets/{outlet_id}/count_events/
• Waste events: POST /inventory/outlets/{outlet_id}/waste_events/
• Stock items: GET /inventory/outlets/{outlet_id}/stock_items/
• Delivery notes: GET /outlets/{outlet_id}/delivery_notes/

If your integration targets a single outlet, you can fetch the list once at startup and store the relevant ID. If it targets multiple outlets, iterate over the list and scope each subsequent call to the appropriate outlet.

Multiple Outlets

A library can contain any number of outlets. If your application needs to let users select which outlet they are working in, the Get Outlets list is the right source for building that selection. Use the Get Outlet Details endpoint if you need to retrieve up-to-date information for a single outlet by ID.

Note that recipes, ingredients, and menus belong to the library, not to individual outlets. Inventory and operational data, on the other hand, is always outlet-scoped.