account_pairing_endpoints

Complete store onboarding

Callback for the Upsert Store webhook. Use this endpoint to inform if the store data and credentials provided through the Upsert Store Webhook were enough to create/update and validate the store. If informing success, the Store ID must be provided to complete the store onboarding process. If informing failure, use the Error Message field to provide details about the problem. Rate limit: 2 requests per minute.

post/v1/stores

Request

Base URL
https://partners.tryotter.com
Auth
OAuth 2
Authorization code/v1/auth/oauth2/authorize
Client credentials
Token URL/v1/auth/token
Scopesstores.manage
TypeScript
https://skmtc.dev/cloudkitchens/apis/otter-api/docs/v1/stores/post.ts
A function with typed inputs. Its response is checked against the schema.

Headers

X-Application-Idstring required

The plain-text Application ID, provided at partner onboarding, also available on Otter Developer Portal.

Example:5045c1c3-694f-4392-b43b-e765cd89c8b8

X-Event-Idstring required

Unique identifier of the event that this callback refers to.

Example:cf0ce51b-d74e-40d3-b177-1925ab4edc0c

Request body

successboolean required

Indicates if your app successfully created and validated the credential provided through the Upsert Store Webhook.

storeIdstring nullable

The unique identifier of the store in your app. This ID, along with the Application ID, will be used to match the correct store when performing operations. It cannot be longer than 255 characters and must only contain printable ASCII characters.

Example request

{
  "storeId": "partner-store-unique-identifier",
  "errorMessage": {
    "message": "The request body is invalid.",
    "details": [
      {
        "attribute": "Order Currency Code",
        "message": "Order Currency Code must be exactly 3 characters"
      }
    ]
  }
}

Response

If informing success, it means the store onboarding process is complete. If informing failure, it means new credentials need to be provided through the Upsert Store Webhook.

Changes

No recorded changes to this operation across all 1 revision of this API.