Skip to main content

Onboard an organization

Let merchants authorize your app and connect stores using OAuth and the organization API.

Overview​

Store onboarding requires the store owner to authorize your application (OAuth Authorization Code flow). You browse organization → brand → store hierarchy, then create a connection that maps Otter’s store to your storeId.

Before you begin​

  • OAuth client configured for your application
  • User can sign in and grant access
  • You know the storeId your system uses for each location

Organization structure​

Organization Structure

EndpointPurpose
GET /organization/v1/organizationCurrent user’s organization
GET /organization/v1/organization/brands?limit=100List brands
GET /organization/v1/organization/brands/{brandId}Brand detail
GET /organization/v1/organization/brands/{brandId}/stores?limit=100List stores
GET /organization/v1/organization/brands/{brandId}/stores/{storeId}Store detail

Steps​

Onboarding Flow

  1. Fetch organization structure (endpoints above).
  2. Select the store to onboard.
  3. GET /organization/v1/organization/brands/{brandId}/stores/{storeId}/connection.
  4. Connect the store:

Verify​

Complete OAuth, connect one store, and confirm store-scoped API calls work with X-Store-Id.

Resources​

Next​