Skip to main content

Menus Manager

Own the menu catalog in your app and sync menus with Otter, then publish to connected targets.

Overview​

Use Menus Manager when your integration is the primary editor of menus. You read and upsert menus via the API, track async jobs, publish to Otter-connected targets, and suspend or unsuspend entities.

How it fits​

Menus Manager: upsert into Otter, jobs and targets, publish to integrated targets

Integration overview​

  1. Read and replace menus — send the complete desired menu snapshot; poll job status until SUCCESS or FAILED.
  2. Optionally publish to targets.
  3. Suspend or unsuspend entities, then republish to targets.
  4. Optionally sync manager menus with Otter menus and publish to OFO.

What you can call​

CapabilityNotes
Get menus for a storeList available menus
Replace menusReturns 202 with a pending async job; omitted or unreachable customer-menu entities are deleted, so send the complete desired state
Get async menu job statusPoll GET /v1/menus/jobs/{jobId}
Get publish targetsList targets and last publish status per store
Publish menus to targetsAsync publish job per target
Sync manager menusBulk sync + optional publish
Suspend / unsuspend entitiesIDs must match upsert ids; republish to propagate

Endpoint details: API reference.

Test​

  • Replace a small test menu; poll until the job completes, then remove one entity from the full payload and verify it is deleted.
  • Publish to one test target and confirm status via publish-targets.

Every included item must carry its intended availability status. On legacy menus, FOR_SALE clears an existing suspension and suspended statuses replace the current suspension. Confirm equivalent behavior for template-enabled stores during onboarding.

Next​

Implement Read and upsert menus, then wire publish and suspend flows before go-live.