The Account Pairing API and its guides are deprecated and may be removed in a future release. Contact your Otter representative for migration options.
Stores & account pairing
Link restaurant locations between your system and Otter so store-scoped API calls and webhooks use the same store identity.
Overview
Account pairing connects an Otter store to your application’s external store id. You can onboard fully via API, partially with manual completion in Otter Developer Portal, and update store status when needed.
Integration overview
- Configure webhooks: Fetch Store Credentials (
stores.fetch_credentials) for optional extra credentials, and Upsert Store (stores.upsert) for new store payloads. - Choose onboarding path:
- Onboard a store — validate and register external id via API
- Partial store onboarding — acknowledge webhook; finish in Otter Developer Portal
- Use
PUT /v1/stores/statusto suspend, activate, or invalidate a store.
Removing stores
Handle the Remove Store (stores.remove) webhook when Otter removes a store link — drop the local store association for that external store id. As a fallback, treat 403 with message Account could not be found: {ext_store_id=[service-slug], partner_id=[application UUID]} as a signal to drop the association if you missed the webhook.
Test
- Receive a test Upsert Store (
stores.upsert) webhook and complete onboarding for one test store. - Confirm
X-Store-Idworks on a store-scoped API call (Quickstart).
Related
- Stores and connections — Core Concepts (pairing paths,
X-Store-Id) - API reference
- Quickstart
Next
Pick Onboard a store or Partial store onboarding based on how much automation you need.