COGS Well API

Does COGS Well have a public API?

COGS-Well publishes no developer API or documentation for its restaurant customers. Data moves in through built-in POS, accounting and AP connections and EDI to supplier systems, and comes back out only through the reporting UI. Integuru generates a production-ready HTTP API for COGS Well from your own login, with 11 verified actions across cost alerts and comparisons, item sales, inventory structure, site item settings, packagings and vendors.

What you can do with the COGS Well API

A director of operations for a 12-site group opens COGS-Well on Monday to see which ingredient costs moved, which sites are not counting the items they should, and what each department sold. The actions return the same views.

Watch costs move

• cost_alerts returns items whose cost changed within days_back (default 30) of a required effective_date.
• item_cost_comparison compares item costs as of effective_date across an interval, grouped by group_by, company-wide or per site_id.

Read sales and inventory structure

• item_sales_report returns item sales between required start_date and end_date, grouped by summarize_by (default department) and filtered by business_unit_id and sales_category_id.
• list_inventory_categories and list_inventory_departments return the inventory taxonomy.

Audit what each site counts and buys

• list_site_items returns a site's items, with counted_only to restrict to items on the count sheet.
• list_site_item_settings returns per-site item configuration for a required site_id, filterable by category, department, item group, vendor and vendor group, paginated 10 per page.
• list_item_packagings returns pack sizes by vendor_id, and list_vendors (with active_only) returns the supplier list.
• list_sites and list_locations return the site and location identifiers everything else scopes on.

Who uses this

Multi-site operators consolidating food cost across concepts pull cost_alerts for every site each week and post the movers into the same report as their Restaurant365 P&L. Procurement teams feed list_item_packagings and list_vendors into a price-comparison job that also reads the US Foods and Performance Food pages, so the same case is compared at the same pack size. Inventory tools reconcile list_site_items with counted_only against their own count sheets, and operators running a second costing system pair this page with xtraCHEF or WISK. The restaurants industry page covers inventory and food cost end to end.

Setup notes

Integuru authenticates against cogs-well.net with your COGS-Well user. Call list_sites first; most actions accept site_id with 0 meaning company-wide, and list_site_item_settings requires a real site. effective_date, start_date and end_date are YYYY-MM-DD. Integer filters on list_site_item_settings treat 0 as all.

Get started

Install the CLI and connect your COGS Well login:

npm install -g integuru

Or sign in at app.integuru.com, add COGS Well, and call the same 11 actions from the dashboard. For recipe or theoretical usage reports this page does not list, the Managed Service scopes and builds them against your account.