openapi: 3.0.1 info: title: Public Account Pairing Endpoints Storefront Endpoints API description: "# Overview\n\nThe API endpoints are developed around [RESTful](https://en.wikipedia.org/wiki/Representational_state_transfer) principles secure via the OAuth2.0 protocol.\n\nBeyond the entry points, the API also provides a line of communication into your system via [webhooks](https://en.wikipedia.org/wiki/Webhook).\n\nFor testing purposes, we offer a staging environment. Also, more detailed information about the business rules and workflows can be found on the [**Documentation Section**](/docs/)\n\n## Versioning\nEach API is versioned individually, but we follow these rules:\n- Non breaking changes (eg: adding new fields) are added in the current version without previous communication\n- Breaking changes (fields removal, semantic changed or schema update) have the version incremented\n- Users will be notified about new versions and will be given time to migrate (the time will be set on a case by case basis)\n- Once users migrate to the new version, we will deprecate the old ones\n- Once there is a new version for an API, we won't accept new integrations targeting old versions\n\n## API General Definitions\nThe APIs use resource-oriented URLs communicating, primarily, via JSON and leveraging the HTTP headers, [response status codes](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status), and verbs.\n\nTo exemplify how the API is to be consumed, consider a fake GET resource endpoint invocation below:\n\n```\ncurl --request GET 'https://{{public-api-url}}/v1/resource/123' \\\n--header 'Authorization: Bearer 34fdabeeafds=' --header 'X-Store-Id: 321'\n```\n\n| Header | Description |\n| ---------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n|`Authorization` | Standard HTTP header is used to associate the request with the originating invoker. The content of this header is a `Bearer` token generated from you client_secret, defined in the [API Auth](#/section/Guides/API-Auth) guide.|\n|`X-Store-Id` | The ID of the store in your system this call acts on behalf of. |\n\n_All resource endpoints expect the `Authorization` header, the remaining headers are explicitly stated in the individual endpoint documentation section._\n\nWith these headers, the system will:\n - Validate the client token, making sure the call is originating from a trusted source.\n - Validate that the Application has the permission to access the `v1/resource/{id}` resource via the Application's pre-configured scopes.\n - Translate your X-Store-Id to our internal store ID (e.g. `AAA`).\n - Validate and retrieve resource `AAA`, that is associated to your Application via store id `321`.\n\nPOST/PUT methods will look similar to the GET calls, but they'll take in a body in the HTTP request (default to the application/json content-type).\n\n```\ncurl --location --request POST 'https://{{public-api-url}}/v1/resource' \\\n--header 'Authorization: Bearer 34fdabeeafds=' --header 'X-Store-Id: 321'\n--data '{\"foo\": \"bar\"}'\n```\n\n## API Authentication/Authorization\n\n\n\n## Webhook\n\nThe Public API is able to send notifications to your system via HTTP POST requests.\n\nEvery webhook is signed using HMAC-SHA256 that is present in the header `X-HMAC-SHA256`, and you can also authenticate the requests using Basic Auth, Bearer Token or HMAC-SHA1 (legacy). Please, refer to [**Webhook Authentication Guide**](/docs/guides-webhook-authentication/) for more details.\n\n_Please work with your Account Representative to setup your Application's Webhook configurations._\n\n```\nExample Base-URL = https://{{your-server-url}}/webhook\n```\n\n### Notification Schema\n\n| **Name** | **Type** | **Description** |\n| ------------------------| ---------| -------------------------------------------------------------------- |\n| eventId | string | Unique id of the event. |\n| eventTime | string | The time the event occurred. |\n| eventType | string | The type of event (e.g. create_order). |\n| metadata.storeId | string | Id of the store for which the event is being published. |\n| metadata.applicationId | string | Id of the application for which the event is being published. |\n| metadata.resourceId | string | The external identifier of the resource that this event refers to. |\n| metadata.resourceHref | string | The endpoint to fetch the details of the resource. |\n| metadata.payload | object | The event object which will be detailed in each Webhook description. |\n\n### Notification Request Example\n\n```\ncurl --location --request POST 'https://{{your-server-url}}/webhook' \\\n--header 'User-Agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_5) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/75.0.3770.142 Safari/537.36' \\\n--header 'Authorization: MAC ' \\\n--header 'Content-Type: application/json' \\\n--data-raw '{\n \"eventId\": \"123456\",\n \"eventTime\": \"2020-10-10T20:06:02:123Z\",\n \"eventType\": \"orders.new_order\",\n \"metadata\": {\n \"storeId\": \"755fd19a-7562-487a-b615-171a9f89d669\",\n \"applicationId\": \"e22f94b3-967c-4e26-bf39-9e364066b68b\",\n \"resourceHref\": \"https://{{public-api-url}}/v1/orders/bf9f1d81-f213-496e-a026-91b6af44996c\",\n \"resourceId\": \"bf9f1d81-f213-496e-a026-91b6af44996c\",\n \"payload\": {}\n }\n}\n```\n\n### Expected Response\n\nThe partner application should return an HTTP 200 response code with an empty response body to acknowledge receipt of the webhook event.\n## Rate Limiting\nPlease, refer to [**Rate Limiting Guide**](/docs/guides-rate-limiting/) for more details.\n\n## Error codes\nThe APIs use standard HTTP status codes to indicate the success or failure of a request. Error codes are divided into two categories: 4XX codes for client-side errors and 5xx codes for server-side errors.\n### 4XX Client-Side Errors\nClient-side errors are indicated by status codes in the 4xx range. These errors are typically the result of a problem with the request made by your application.\nIf a client-side error occurs, our API will return a response that includes an appropriate error message. This message will provide information about the cause of the error. The aim of these messages is to assist you in identifying and resolving the issue.\nFor example, if you submit a request with missing or invalid parameters, you might receive a 400 Bad Request error with a message indicating which parameters were missing or incorrect.\n### 5XX Server-Side Errors\nServer-side errors are represented by status codes in the 5xx range. These errors suggest a problem with our server, not with your application's request.\nServer-side errors are typically transient, meaning they are temporary. If a server-side error occurs, we recommend that the client retries the same request with the exact same parameters.\nFor example, if you get a 500 Internal Server Error, it's possible that our server is suffering a temporary problem. In such cases, retrying the request after a short delay is often successful.\nIf you continually receive server-side errors, reach out to our support team for further assistance." version: v1 license: name: Proprietary contact: name: Kin Lane email: kin@apievangelist.com x-generated-from: documentation x-source-url: https://developer-guides.tryotter.com/api-reference/ x-last-validated: '2026-06-03' servers: - url: https://{public-api-url}/ description: Otter Public API base URL. The concrete host is provisioned per integration partner/account via your Otter account representative; substitute the value provided during onboarding. variables: public-api-url: default: public-api-url description: Account-specific Public API host provided by Otter during onboarding. tags: - name: Storefront Endpoints description: Endpoints to manage storefront state x-displayName: Storefront paths: /v1/storefront/availability: post: tags: - Storefront Endpoints summary: Otter Notify About Store Availability Change description: '`RATE LIMIT: 16 per minute` ' operationId: postStoreAvailabilityChange parameters: - $ref: '#/components/parameters/storeIdHeader' - $ref: '#/components/parameters/eventIdOptionalHeader' requestBody: content: application/json: schema: $ref: '#/components/schemas/StoreAvailabilityEventResult' examples: PostStoreAvailabilityChangeRequestExample: summary: Default postStoreAvailabilityChange request x-microcks-default: true value: storeState: OPEN statusChangedAt: '2007-12-03T10:15:30+01:00' eventResultMetadata: operationStatus: SUCCEEDED additionalInformation: Completed without problems. operationFinishedAt: '2007-12-03T10:15:30+01:00' required: true responses: '204': description: The store availability change was successfully processed '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '422': $ref: '#/components/responses/422' security: - OAuth2.0: - storefront.store_availability x-microcks-operation: delay: 0 dispatcher: FALLBACK /v1/storefront/hours: post: tags: - Storefront Endpoints summary: Otter Notify About Store Hours Configuration Change description: '`RATE LIMIT: 16 per minute` ' operationId: postStoreHoursConfigurationChange parameters: - $ref: '#/components/parameters/storeIdHeader' - $ref: '#/components/parameters/eventIdOptionalHeader' requestBody: content: application/json: schema: $ref: '#/components/schemas/StoreHoursConfigurationEventResult' examples: PostStoreHoursConfigurationChangeRequestExample: summary: Default postStoreHoursConfigurationChange request x-microcks-default: true value: storeHoursConfiguration: deliveryHours: {} pickupHours: {} timezone: America/Los_Angeles statusChangedAt: '2007-12-03T10:15:30+01:00' eventResultMetadata: operationStatus: SUCCEEDED additionalInformation: Completed without problems. operationFinishedAt: '2007-12-03T10:15:30+01:00' required: true responses: '204': description: The store hours configuration change was successfully processed. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '422': $ref: '#/components/responses/422' security: - OAuth2.0: - storefront.store_hours_configuration x-microcks-operation: delay: 0 dispatcher: FALLBACK /v1/storefront/pause: post: tags: - Storefront Endpoints summary: Otter Notify the Result of a Pause Request Event description: '`RATE LIMIT: 8 per minute` ' operationId: postPauseStoreEventResult parameters: - $ref: '#/components/parameters/storeIdHeader' - $ref: '#/components/parameters/eventIdHeader' requestBody: content: application/json: schema: $ref: '#/components/schemas/PauseStoreEventResult' examples: PostPauseStoreEventResultRequestExample: summary: Default postPauseStoreEventResult request x-microcks-default: true value: closureId: 4109d2c9-8bc5-413c-af3e-1c92aa381e41 eventResultMetadata: operationStatus: SUCCEEDED additionalInformation: Completed without problems. operationFinishedAt: '2007-12-03T10:15:30+01:00' required: true responses: '204': description: The pause store event result was successfully processed '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '422': $ref: '#/components/responses/422' security: - OAuth2.0: - storefront.store_pause_unpause x-microcks-operation: delay: 0 dispatcher: FALLBACK /v1/storefront/unpause: post: tags: - Storefront Endpoints summary: Otter Notify the Result of an Unpause Request Event description: '`RATE LIMIT: 8 per minute` ' operationId: postUnpauseStoreEventResult parameters: - $ref: '#/components/parameters/storeIdHeader' - $ref: '#/components/parameters/eventIdHeader' requestBody: content: application/json: schema: $ref: '#/components/schemas/UnpauseStoreEventResult' examples: PostUnpauseStoreEventResultRequestExample: summary: Default postUnpauseStoreEventResult request x-microcks-default: true value: eventResultMetadata: operationStatus: SUCCEEDED additionalInformation: Completed without problems. operationFinishedAt: '2007-12-03T10:15:30+01:00' required: true responses: '204': description: The unpause store event result was successfully processed '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '422': $ref: '#/components/responses/422' security: - OAuth2.0: - storefront.store_pause_unpause x-microcks-operation: delay: 0 dispatcher: FALLBACK /v1/storefront/eater-side/status: post: tags: - Storefront Endpoints summary: Otter Notify About Store Availability Change from the Eater Side description: '`RATE LIMIT: 16 per minute` ' operationId: postEaterSideStoreAvailabilityChange parameters: - $ref: '#/components/parameters/storeIdHeader' - $ref: '#/components/parameters/eventIdOptionalHeader' requestBody: content: application/json: schema: $ref: '#/components/schemas/StoreAvailabilityEventResult' examples: PostEaterSideStoreAvailabilityChangeRequestExample: summary: Default postEaterSideStoreAvailabilityChange request x-microcks-default: true value: storeState: OPEN statusChangedAt: '2007-12-03T10:15:30+01:00' eventResultMetadata: operationStatus: SUCCEEDED additionalInformation: Completed without problems. operationFinishedAt: '2007-12-03T10:15:30+01:00' required: true responses: '204': description: The store availability change was successfully processed '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '422': $ref: '#/components/responses/422' security: - OAuth2.0: - storefront.store_availability x-microcks-operation: delay: 0 dispatcher: FALLBACK /v1/storefront/eater-side/hours: post: tags: - Storefront Endpoints summary: Otter Notify About Store Hours Configuration Change on Eater Side description: '`RATE LIMIT: 16 per minute` ' operationId: postEaterSideStoreHoursConfigurationChange parameters: - $ref: '#/components/parameters/storeIdHeader' - $ref: '#/components/parameters/eventIdOptionalHeader' requestBody: content: application/json: schema: $ref: '#/components/schemas/StoreHoursConfigurationEventResult' examples: PostEaterSideStoreHoursConfigurationChangeRequestExample: summary: Default postEaterSideStoreHoursConfigurationChange request x-microcks-default: true value: storeHoursConfiguration: deliveryHours: {} pickupHours: {} timezone: America/Los_Angeles statusChangedAt: '2007-12-03T10:15:30+01:00' eventResultMetadata: operationStatus: SUCCEEDED additionalInformation: Completed without problems. operationFinishedAt: '2007-12-03T10:15:30+01:00' required: true responses: '204': description: The store hours configuration change was successfully processed. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '422': $ref: '#/components/responses/422' security: - OAuth2.0: - storefront.store_hours_configuration x-microcks-operation: delay: 0 dispatcher: FALLBACK /v1/market-intel/store-details: post: tags: - Storefront Endpoints summary: Otter Notify About Store Details Update operationId: postGetStoreDetailsResult parameters: - $ref: '#/components/parameters/eventIdOptionalHeader' requestBody: content: application/json: schema: $ref: '#/components/schemas/GetStoreDetailsEventResult' examples: PostGetStoreDetailsResultRequestExample: summary: Default postGetStoreDetailsResult request x-microcks-default: true value: superRegion: LATAM storeDetails: - regionId: LATAM-N provider: ubereats-provider id: 12345 storeUrl: 30 location: {} address: {} phoneNumbers: - 613-123-4567 storeName: McDonald's menu: {} storeHours: {} tags: - chinese storeBannerPhotoUrl: https://www.ubereats.com/ca/store/mcdonalds-1000-rideau-street/1QY5X6QcQX2Q4Z3Z3QZQYQ.jpg storeRating: {} coordinates: {} storeSales: {} avgBasketAmount: 25.21 storePromotions: - {} storeChain: {} storeDeliveryInformation: {} logoPhotoUrl: https://www.ubereats.com/ca/store/mcdonalds-1000-rideau-street/1QY5X6QcQX2Q4Z3Z3QZQYQ.jpg priceLevel: {} required: true responses: '204': description: The store details updates were successfully processed '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '422': $ref: '#/components/responses/422' security: - OAuth2.0: - marketintel.service_integration x-microcks-operation: delay: 0 dispatcher: FALLBACK components: schemas: Address: type: object nullable: true properties: fullAddress: type: string nullable: true description: Full, human comprehensible address. It is usually formatted in the order appropriate for your locale. example: 123 Sample Street Ste 100, San Francisco, CA 94103 postalCode: type: string description: Postal code of the address. example: '20500' city: type: string description: The city/town portion of the address. example: Washington state: type: string description: Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, or a prefecture. example: DC countryCode: type: string description: CLDR country code. See http://cldr.unicode.org/ example: US addressLines: type: array nullable: true description: Address lines (e.g. street, PO Box, or company name) or the full single line address (e.g. street, city, state, country, zip). example: - 1600 Pennsylvania Avenue NW - 123 Sample Street Ste 100, San Francisco, CA 94103 items: type: string linesOfAddress: type: array nullable: true deprecated: true description: 'Deprecated: use addressLines. Address lines (e.g. street, PO Box, or company name) or the full single line address (e.g. street, city, state, country, zip).' example: - 1600 Pennsylvania Avenue NW - 123 Sample Street Ste 100, San Francisco, CA 94103 items: type: string location: $ref: '#/components/schemas/Location' description: Order delivery address. UnpauseStoreEventResult: type: object properties: eventResultMetadata: $ref: '#/components/schemas/RequiredEventResultMetadata' description: Result of an event that requested to unpause a store. StoreAvailabilityEventResult: type: object properties: storeState: type: string nullable: true description: Represents the current state of a store. enum: - OPEN - OFF_HOUR - SERVICE_PROVIDER_PAUSED - OPERATOR_PAUSED - SERVICE_PROVIDER_PAUSED_COURIERS_UNAVAILABLE - STORE_UNAVAILABLE - HOLIDAY_HOUR - MENU_UNAVAILABLE - SERVICE_PROVIDER_PAUSED_MISCONFIGURED - OPEN_FOR_PICKUP_ONLY - OPEN_FOR_DELIVERY_ONLY - CLOSED_FOR_UNDETERMINED_REASON example: OPEN statusChangedAt: type: string nullable: true description: The time when the store changed to the current state. format: date-time example: '2007-12-03T10:15:30+01:00' eventResultMetadata: $ref: '#/components/schemas/EventResultMetadata' description: The current state of a store. StoreHoursConfigurationEventResult: type: object properties: storeHoursConfiguration: $ref: '#/components/schemas/StoreHoursConfiguration' statusChangedAt: type: string description: The time when the store hours configuration changed. format: date-time example: '2007-12-03T10:15:30+01:00' eventResultMetadata: $ref: '#/components/schemas/EventResultMetadata' description: The current store hours configuration. RequiredEventResultMetadata: type: object properties: operationStatus: type: string description: Status of the operation requested by an event. enum: - SUCCEEDED - INTERNAL_ERROR - AUTHENTICATION_FAILURE - AUTHORIZATION_FAILURE - UNKNOWN_FAILURE - INVALID_STORE_STATE - INVALID_STORE_CONFIGURATION - OPERATION_NOT_SUPPORTED - IGNORED_ALREADY_IN_REQUESTED_STATE - INVALID_REQUEST example: SUCCEEDED additionalInformation: type: string nullable: true description: Additional details about the event result, if available. example: Completed without problems. operationFinishedAt: type: string description: Time when the processing of the event finished. format: date-time example: '2007-12-03T10:15:30+01:00' description: Information about the result of a storefront event. Money: required: - amount - currencyCode type: object properties: currencyCode: maxLength: 3 minLength: 3 type: string description: The 3-letter currency code (ISO 4217) to use for all monetary values. example: EUR amount: minimum: 0 exclusiveMinimum: false type: number description: Amount value. example: 25.21 description: Money amount. example: 25.21 Marketintel_StoreDetails: type: object properties: regionId: type: string nullable: true description: The region that store belongs to. example: LATAM-N provider: type: string description: The store information provider example: ubereats-provider id: type: string description: The external store id example: 12345 storeUrl: type: string nullable: true description: The store url example: 30 location: type: object description: The Geographic location used to discover the store $ref: '#/components/schemas/Marketintel_GeoLocationInformation' address: type: object nullable: true description: The store address $ref: '#/components/schemas/Address' phoneNumbers: type: array minItems: 0 description: The store phone numbers. items: type: string example: 613-123-4567 storeName: type: string nullable: true description: The name of the store. example: McDonald's menu: type: object nullable: true description: The store menu. $ref: '#/components/schemas/Marketintel_StoreMenu' storeHours: type: object nullable: true description: The store hours. $ref: '#/components/schemas/Marketintel_HoursData' tags: type: array minItems: 0 description: The store tags items: description: The store tag example: chinese storeBannerPhotoUrl: type: string nullable: true description: The store bannel photo url. example: https://www.ubereats.com/ca/store/mcdonalds-1000-rideau-street/1QY5X6QcQX2Q4Z3Z3QZQYQ.jpg storeRating: type: object nullable: true description: The store ratings. $ref: '#/components/schemas/Marketintel_StoreRating' coordinates: type: object nullable: true description: The coordinates of the store. $ref: '#/components/schemas/Marketintel_Coordinates' storeSales: type: object nullable: true description: The store sales information. $ref: '#/components/schemas/Marketintel_StoreSales' avgBasketAmount: type: object nullable: true description: The average order amount. $ref: '#/components/schemas/Money' storePromotions: type: array minItems: 0 description: The store promotions. items: $ref: '#/components/schemas/Marketintel_StorePromotion' storeChain: type: object description: The store chain information. $ref: '#/components/schemas/Marketintel_StoreChain' storeDeliveryInformation: type: object nullable: true description: The Store delivery information. $ref: '#/components/schemas/Marketintel_StoreDeliveryInformation' logoPhotoUrl: type: string nullable: true description: The store photo url. example: https://www.ubereats.com/ca/store/mcdonalds-1000-rideau-street/1QY5X6QcQX2Q4Z3Z3QZQYQ.jpg priceLevel: type: string nullable: true description: The estimated delivery time in minutes. $ref: '#/components/schemas/Marketintel_StorePriceLevel' description: The Store delivery information. ErrorDetail: type: object properties: attribute: type: string description: The error attribute. example: Order Currency Code message: type: string description: The error detail description. example: Order Currency Code must be exactly 3 characters description: The error detail response object. ErrorMessage: type: object properties: message: type: string description: The error description. example: The request body is invalid. details: type: array description: The error details. items: $ref: '#/components/schemas/ErrorDetail' description: The error response object. Marketintel_StoreMenu: type: object properties: category: type: string nullable: true description: The grouping category name. example: Fast Food ids: type: array description: The list of external store ids in the list in rank order. items: type: string description: The external id the store example: 123456 location: type: object description: The geographic location of the stores that was searched from. description: The Store listing in ranking order based on category. Marketintel_StoreChain: type: object properties: chainId: type: string nullable: true description: The external chain id. example: 1 chainName: type: string nullable: true description: The name of the chain. example: Macdonalds description: The Store Chain information. Marketintel_StorePromotion: type: object properties: displayName: type: string nullable: true description: The name of the promotion. example: Flat rate discount on Christmas day promotionType: type: string nullable: true description: The type of promotion. example: Flat rate discount campaignType: type: string nullable: true description: The type of promotion campaign. example: Christmas promotionId: type: string nullable: true description: The external promotion id. example: 12345 description: The Store Promotion information. At least one of the displayName, promotionType, campaignType or promotionId need to be present. Location: required: - latitude - longitude type: object nullable: true properties: latitude: type: number description: The latitude of the location. format: double example: 38.8977 longitude: type: number description: The longitude of the location. format: double example: 77.0365 description: Latitude and longitude of the address. Marketintel_HoursData: required: - regularHours - specialHours - timeZone type: object properties: timeZone: type: string description: TimeZone of all times under it. (https://www.joda.org/joda-time/timezones.html) format: timezone-id example: America/Los_Angeles regularHours: type: array description: List of regular hours configuration. items: $ref: '#/components/schemas/Marketintel_RegularHours' specialHours: type: array description: List of special hours configuration, for occasions like Christmas, Thanksgiving, or any other holidays. items: $ref: '#/components/schemas/Marketintel_SpecialHours' description: Represents hours configuration with regular hours and special hours. Storefront_RegularHours: required: - dayOfWeek - timeRanges type: object properties: dayOfWeek: type: string description: Day of the week. enum: - MONDAY - TUESDAY - WEDNESDAY - THURSDAY - FRIDAY - SATURDAY - SUNDAY example: MONDAY timeRanges: type: array minItems: 1 description: Hours range applied to the provided day of the week items: $ref: '#/components/schemas/Storefront_TimeRange' description: Describes the configuration of regular hours. StoreHours: type: object nullable: true properties: regularHours: type: array description: List of regular hours configuration. items: $ref: '#/components/schemas/Storefront_RegularHours' specialHours: type: array nullable: true description: List of special hours configuration. items: $ref: '#/components/schemas/Storefront_SpecialHours' description: Represents store hours configuration with regular hours and special hours. Storefront_SpecialHours: required: - date - timeRanges - specialHourType type: object properties: date: type: string description: Date the special hour configuration applies. format: date example: '2021-10-01' timeRanges: type: array minItems: 1 description: Hours range applied to configured date. items: $ref: '#/components/schemas/Storefront_TimeRange' specialHourType: type: string description: Store state that should be applied during the configured special hour. enum: - OPEN - CLOSED example: OPEN description: Describes the configuration of special store hours. Marketintel_TimeRange: required: - end - start type: object properties: start: type: string description: Start time of the range in 24 hour format. example: 08:00 end: type: string description: End time of the range in 24 hour format. example: 1320 description: Time range in a given date. EventResultMetadata: type: object nullable: true properties: operationStatus: type: string description: Status of the operation requested by an event. enum: - SUCCEEDED - INTERNAL_ERROR - AUTHENTICATION_FAILURE - AUTHORIZATION_FAILURE - UNKNOWN_FAILURE - INVALID_STORE_STATE - INVALID_STORE_CONFIGURATION - OPERATION_NOT_SUPPORTED - IGNORED_ALREADY_IN_REQUESTED_STATE - INVALID_REQUEST example: SUCCEEDED additionalInformation: type: string nullable: true description: Additional details about the event result, if available. example: Completed without problems. operationFinishedAt: type: string description: Time when the processing of the event finished. format: date-time example: '2007-12-03T10:15:30+01:00' description: Information about the result of a storefront event. Marketintel_StorePriceLevel: type: object properties: priceLevel: type: number nullable: true description: The price level of the store in numeric rating. example: 3 priceLevelName: type: string nullable: true description: The price level of the store in text. example: $$$ description: The Store Price Level information. At least one of the price level or price level name need to be present. Marketintel_StoreSales: type: object properties: periodType: type: string nullable: true description: The period type of the sales data example: null numberOfSales: type: integer nullable: true description: The number of sales. example: 100 displayNumberOfSales: type: string nullable: true description: The display text of the number of sales. example: - 20 - 20+ description: The Store Sales information. At least one of the periodType, numberOfSales or displayNumberOfSales need to be present. StoreHoursConfiguration: required: - timezone type: object properties: deliveryHours: $ref: '#/components/schemas/StoreHours' pickupHours: $ref: '#/components/schemas/StoreHours' timezone: type: string description: The store time zone identifier. (e.g. America/New_York) example: America/Los_Angeles description: The current store hours configuration of a store. Marketintel_StoreRating: type: object properties: ratingScore: type: number nullable: true description: The normalized rating score of the store. example: 2 estimatedRatingCount: type: integer nullable: true description: The estimated number of scores in the rating. example: 100 displayRatingCount: type: string nullable: true description: The display text of the number of scores in the rating. example: - 20+ - 20 description: The Store rating information. At least one of the ratingScore, estimatedRatingCount or displayRatingCount need to be present. Marketintel_GeoLocationInformation: type: object properties: regionId: type: string description: The region id of the geographical location. example: - LATAM-N superRegion: type: string description: The super region of the geographical location. example: - LATAM h3Index: type: string description: The H3Index value of the geographic location. example: - 886d344c81fffff searchText: type: string nullable: true description: The text used to search for stores. example: - chinese food address: type: object description: The address of the geographical location. $ref: '#/components/schemas/Address' description: The geographical location information used to discover stores. This information will need be pass back with the result. Marketintel_StoreDeliveryInformation: type: object properties: minDeliveryBasketSize: type: object nullable: true description: The minimum basket value of the order needed for delivery $ref: '#/components/schemas/Money' deliveryFee: type: object nullable: true description: The delivery fee for the order $ref: '#/components/schemas/Money' deliveryType: type: string nullable: true description: The delivery type for the order example: Third Party deliveryTimeMinutes: type: integer nullable: true description: The estimated delivery time in minutes example: 30 description: The Store delivery information. Storefront_TimeRange: type: object properties: startTime: type: string description: Start time of the range in 24 hour format. example: 08:00 endTime: type: string description: End time of the range in 24 hour format. example: 08:00 description: Time range in a given date. GetStoreDetailsEventResult: type: object properties: superRegion: type: string description: Represents a super region geographical mapping. example: LATAM storeDetails: type: array minItems: 0 description: Represents a list of stores items: $ref: '#/components/schemas/Marketintel_StoreDetails' description: The result of an event that request to store details. PauseStoreEventResult: type: object properties: closureId: type: string description: ID required to unpause a store, if available example: 4109d2c9-8bc5-413c-af3e-1c92aa381e41 eventResultMetadata: $ref: '#/components/schemas/RequiredEventResultMetadata' description: Result of an event that requested to pause a store. StoreId: type: string description: The unique identifier of the store in the partner application. 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. During on-boarding, this ID will be similar to `onboarding:905bb725-b141-4a9b-832a-1f254f772c94` (where the UUID is the Internal Store ID). During off-boarding, this field will be filled with the last known Store ID, or with an empty string, in case none is found. In that case, please fall back to the provided `internalStoreId` (a.k.a. Sku-Sku ID). example: partner-store-unique-identifier Marketintel_SpecialHours: required: - date - timeRanges - type type: object properties: date: type: string description: Date the special hour configuration applies. format: date example: '2021-10-01' timeRanges: type: array minItems: 1 description: Hours range applied to configured date. items: $ref: '#/components/schemas/Marketintel_TimeRange' type: type: string description: Store state that should be applied during the configured special hour. enum: - OPEN - CLOSED example: OPEN description: Describes the configuration of special store hours. Marketintel_RegularHours: required: - days - timeRanges type: object properties: days: type: array description: The day of the week this configuration applies. items: type: string description: Day of the week. enum: - MONDAY - TUESDAY - WEDNESDAY - THURSDAY - FRIDAY - SATURDAY - SUNDAY timeRanges: type: array description: Hours range applied to the provided day of the week items: $ref: '#/components/schemas/Marketintel_TimeRange' description: Describes the configuration of regular hours. Marketintel_Coordinates: type: object properties: coordinatesType: type: string description: Coordinates type enum: - WGS84 - GCJ02 example: WGS84 location: type: object description: The longitude and latitude of a location. $ref: '#/components/schemas/Location' description: The geographical coordinates of a location. parameters: storeIdHeader: name: X-Store-Id in: header required: true schema: $ref: '#/components/schemas/StoreId' eventIdOptionalHeader: name: X-Event-Id in: header required: false schema: type: string description: Optional unique identifier of the event that this callback refers to. example: cf0ce51b-d74e-40d3-b177-1925ab4edc0c eventIdHeader: name: X-Event-Id in: header required: true schema: type: string description: Unique identifier of the event that this callback refers to. example: cf0ce51b-d74e-40d3-b177-1925ab4edc0c responses: '422': description: The request body is not valid. content: application/json: schema: $ref: '#/components/schemas/ErrorMessage' '400': description: The request is malformed. content: application/json: schema: $ref: '#/components/schemas/ErrorMessage' '403': description: Authorization not valid for the requested resource. content: application/json: schema: $ref: '#/components/schemas/ErrorMessage' '404': description: Resource not found. content: application/json: schema: $ref: '#/components/schemas/ErrorMessage' '401': description: Invalid authorization. content: application/json: schema: $ref: '#/components/schemas/ErrorMessage' securitySchemes: OAuth2.0: type: oauth2 description: "The **Authorization API** is based on the [OAuth2.0 protocol](https://tools.ietf.org/html/rfc6749), supporting the (Client Credentials)[https://datatracker.ietf.org/doc/html/rfc6749#section-4.4] and the (Authorization Code)[https://datatracker.ietf.org/doc/html/rfc6749#section-4.1] flows. Resources expect a valid token sent as a `Bearer` token in the HTTP `Authorization` header.\n### Scopes\nScopes must be configured by our internal team to be enabled for an app. Once the scopes are configured they can be enabled on the Application Settings Page in Developer Portal. Each endpoint requires a given scope that can be verified on each endpoint documentation. When generating an OAuth2.0 token multiple scopes can be requested.\n\n### Authorization Code Flow\nTo perform this flow, the authorization code flow must be enabled in the Application Settings Page in Developer Portal. When enabling the flow it is mandatory to provide a redirect URI pointing to your application. Once the flow is complete we will redirect the user to this URI passing the 'code' and 'state' parameters.\nThe Authorization Code flow provides a temporary code that the client application can exchange for an access token. To start the flow the application must request the user authorization. This is done by sending a request to https://{{public-api-url}}/v1/auth/oauth2/authorize.\nExample\n```\ncurl --location 'https://{{public-api-url}}/v1/auth/oauth2/authorize?client_id=[CLIENT_ID]&redirect_uri=[REDIRECT_URI]&response_type=code&scope=organization.read&state=8A9D16B4C3E25F6A'\n```\nThis call will return a 302 redirecting the user to our authorization page. If the user approves the application, we will redirect to configured URI passing the authorization code in the query parameter 'code'. The 'state' parameter is also sent to ensure the source of the data.\nWith the authorization code, the client application can generate the token.\n### Client Credentials Flow\nThe client_credentials flow does not require any steps before generating the token. Once your application is ready, and the client_id and client_secret are available, the token can be generated by following the instructions in the next section.\n\n### Generate Token\nTo generate the token, use the `Client ID` and `Client Secret` (provided during onboarding), and optionally the authorization code obtained after performing the Authorization Code flow, to the [Token Auth endpoint](#operation/requestToken) endpoint. The result of this invocation is a token that is valid for a pre-determined time or until it is manually revoked.\n\nThe access token obtained will be sent as a `Bearer` value of the `Authorization` HTTP header.\n\nClient credentials in the request-body and HTTP Basic Auth are supported.\n\n#### Request Example for client_credentials\n```\ncurl --location --request POST 'https://{{public-api-url}}/v1/auth/token' \\\n --header 'Content-Type: application/x-www-form-urlencoded' \\\n --data-urlencode 'scope=ping' \\\n --data-urlencode 'grant_type=client_credentials' \\\n --data-urlencode 'client_id=[APPLICATION_ID]' \\\n --data-urlencode 'client_secret=[CLIENT_SECRET]'\n\n```\n#### Request Example for authorization_code\n```\ncurl --location --request POST 'https://{{public-api-url}}/v1/auth/token' \\\n --header 'Content-Type: application/x-www-form-urlencoded' \\\n --data-urlencode 'scope=ping' \\\n --data-urlencode 'grant_type=authorization_code' \\\n --data-urlencode 'client_id=[APPLICATION_ID]' \\\n --data-urlencode 'client_secret=[CLIENT_SECRET]' \\\n --data-urlencode 'code=[code]' \\\n --data-urlencode 'redirect_uri=[redirect_uri]'\n\n```\n#### Response Example\n```\n{\n \"access_token\": \"oMahtBwBbnZeh4Q66mSuLFmk2V0_CLCKVt0aYcNJlcg.yditzjwCP7yp0PgR6AzQR3wQ1rTdCjkcPeAMuyfK-NU\",\n \"expires_in\": 2627999,\n \"scope\": \"ping orders.create\",\n \"token_type\": \"bearer\"\n}\n```\n\n### Token Usage\n\nThe token provided in field `access_token` is used to authenticate when consuming the API endpoints. Send the token value in the `Authorization` header of every request. The token expiration time is represented in the field `expired_in`, in seconds. Currently, all tokens are valid for 30 days and should be stored and re-used while still valid.\n\nNote that occasionally, a 401 error may be returned for a valid token due to an internal service issue. Such occurrences should be rare. To prevent exposing potential vulnerabilities to attackers, the Public API does not disclose other types of errors in the authentication flow if for any reason the token can't be validated (when it's a valid token then it's ok to return 5XX or other 4XX though - such as 403). In such scenarios, although the internal auth flow avoids retries to prevent attacks, if the token is known to be valid and not expired, a retry with a backoff interval by the client is advised. Another option is to request a new token.\n\n#### Example\n\n```\ncurl --location --request GET 'https://{{public-api-url}}/v1/ping' \\\n --header 'Authorization: Bearer ' \\\n --header 'X-Store-Id: '\n\n```\n" flows: clientCredentials: tokenUrl: /v1/auth/token scopes: catalog: Permission to interact with product inventory for existing stores. delivery.provider: Permission to provide delivery services for existing orders. finance: Permission to provide financial data for orders/stores. manager.menus: Permission to manage menus. manager.orders: Permission to manage orders. manager.storefront: Permission to manage storefront. menus.async_job.read: Permission to read the status of a menu upsert job. menus.entity_suspension: Permission to notify the result of a menu entity availability update, after being requested by a webhook event. menus.get_current: Permission to send the current state of a menu, after being requested by a webhook event. menus.publish: Permission to notify the result of a publish menus operation for a given store. menus.read: Permission to read the current menus for a given store. menus.upsert: Permission to create/update menus for a given store. menus.upsert_hours: Permission to notify the receiving of the upsert hours menu event, after being requested by a webhook event. orders.create: Permission to create new order for a given store. orders.read: Permission to read orders and connected data. orders.update: Permission to create and update new orders for a given store. ping: Permission to ping the system. reports.generate_report: Permission to request reports for given store(s) and period of time. reviews.reply: Permission to reply to reviews. storefront.store_pause_unpause: Permission to notify the result of a pause/unpause operation, after being requested by a webhook event. storefront.store_availability: Permission to send the current state of store. storefront.store_hours_configuration: Permission to send the current store hours configuration. stores.manage: Permission to onboard stores and update the identifier. callback.error.write: Token has permission to send failed webhook event results. manager.loyalty: Permission to interact with loyalty services. direct.orders: Permission to interact with direct order services. store.read: Permission to query store information. authorizationCode: authorizationUrl: /v1/auth/oauth2/authorize tokenUrl: /v1/auth/token scopes: organization.read: Permission to read data for organization/brands/stores on behalf of a user. organization.service_integration: Permission to manage the your integration with a given store on behalf of a user. x-webhooks: orderCreate: post: tags: - Manager Orders Webhooks summary: Otter Order Creation Webhook operationId: orderCreateWebhook requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/EventNotification' - type: object properties: metadata: type: object properties: payload: $ref: '#/components/schemas/Order' - example: eventType: orders.new_order examples: OrderCreateWebhookRequestExample: summary: Default orderCreateWebhook request x-microcks-default: true value: eventId: c75d9460-5d48-423d-8d01-f825fd5b1672 eventTime: '2007-12-03T10:15:30+01:00' eventType: orders.new_order metadata: payload: externalIdentifiers: {} currencyCode: EUR status: NEW_ORDER items: - {} orderedAt: '2007-12-03T10:15:30+01:00' customer: {} customerNote: Please include extra napkins! deliveryInfo: {} orderTotal: {} orderTotalV2: {} customerPayments: - {} fulfillmentInfo: {} promotionsDetails: - {} preparationTime: {} responses: '200': $ref: '#/components/responses/200' '202': $ref: '#/components/responses/202' x-microcks-operation: delay: 0 dispatcher: FALLBACK orderUpdate: post: tags: - Manager Orders Webhooks summary: Otter Order Update Webhook operationId: orderUpdateWebhook requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/EventNotification' - type: object properties: metadata: type: object properties: payload: $ref: '#/components/schemas/Order' - example: eventType: orders.update examples: OrderUpdateWebhookRequestExample: summary: Default orderUpdateWebhook request x-microcks-default: true value: eventId: c75d9460-5d48-423d-8d01-f825fd5b1672 eventTime: '2007-12-03T10:15:30+01:00' eventType: orders.update metadata: payload: externalIdentifiers: {} currencyCode: EUR status: NEW_ORDER items: - {} orderedAt: '2007-12-03T10:15:30+01:00' customer: {} customerNote: Please include extra napkins! deliveryInfo: {} orderTotal: {} orderTotalV2: {} customerPayments: - {} fulfillmentInfo: {} promotionsDetails: - {} preparationTime: {} responses: '200': $ref: '#/components/responses/200' '202': $ref: '#/components/responses/202' x-microcks-operation: delay: 0 dispatcher: FALLBACK intentToCancelOrder: post: tags: - Orders Webhooks summary: Otter Intent to Cancel Order Webhook operationId: intentToCancelOrderWebhook requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/EventNotification' - type: object properties: metadata: type: object properties: payload: $ref: '#/components/schemas/IntentToCancelEvent' - example: eventType: orders.cancel_order examples: IntentToCancelOrderWebhookRequestExample: summary: Default intentToCancelOrderWebhook request x-microcks-default: true value: eventId: c75d9460-5d48-423d-8d01-f825fd5b1672 eventTime: '2007-12-03T10:15:30+01:00' eventType: orders.cancel_order metadata: payload: externalIdentifiers: {} cancellationReason: REASON_UNKNOWN responses: 2XX: $ref: '#/components/responses/2XX' x-microcks-operation: delay: 0 dispatcher: FALLBACK orderStatusUpdate: post: tags: - Orders Webhooks summary: Otter Order Status Update Webhook operationId: orderStatusUpdateWebhook requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/EventNotification' - type: object properties: metadata: type: object properties: payload: $ref: '#/components/schemas/OrderStatusHistory' - example: eventType: orders.order_status_update examples: OrderStatusUpdateWebhookRequestExample: summary: Default orderStatusUpdateWebhook request x-microcks-default: true value: eventId: c75d9460-5d48-423d-8d01-f825fd5b1672 eventTime: '2007-12-03T10:15:30+01:00' eventType: orders.order_status_update metadata: payload: orderStatusHistory: - {} orderAcceptedInfo: {} responses: 2XX: $ref: '#/components/responses/2XX' x-microcks-operation: delay: 0 dispatcher: FALLBACK posInjectionStateUpdate: post: tags: - Orders Webhooks summary: Otter Pos Injection State Update Webhook operationId: posInjectionStateUpdateWebhook requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/EventNotification' - type: object properties: metadata: type: object properties: payload: $ref: '#/components/schemas/PosInjectionStateUpdateEvent' - example: eventType: orders.pos_injection_state_update examples: PosInjectionStateUpdateWebhookRequestExample: summary: Default posInjectionStateUpdateWebhook request x-microcks-default: true value: eventId: c75d9460-5d48-423d-8d01-f825fd5b1672 eventTime: '2007-12-03T10:15:30+01:00' eventType: orders.pos_injection_state_update metadata: payload: externalIdentifiers: {} injectionState: UNKNOWN injectionIssue: UNKNOWN_INJECTION_ISSUE additionalData: ticketData: Some value for the TicketData customField: customValue responses: 2XX: $ref: '#/components/responses/2XX' x-microcks-operation: delay: 0 dispatcher: FALLBACK orderConfirm: post: tags: - Manager Orders Webhooks summary: Otter Order Confirm Notification Webhook operationId: orderConfirmWebhook requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/EventNotification' - type: object properties: metadata: type: object properties: payload: $ref: '#/components/schemas/OrderConfirmEvent' - example: eventType: orders.confirm examples: OrderConfirmWebhookRequestExample: summary: Default orderConfirmWebhook request x-microcks-default: true value: eventId: c75d9460-5d48-423d-8d01-f825fd5b1672 eventTime: '2007-12-03T10:15:30+01:00' eventType: orders.confirm metadata: payload: orderId: 69f60a06-c335-46d9-b5a1-97f1a211c514 responses: 2XX: $ref: '#/components/responses/2XX' x-microcks-operation: delay: 0 dispatcher: FALLBACK orderReady: post: tags: - Manager Orders Webhooks summary: Otter Order Ready Status Notification Webhook operationId: orderReady requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/EventNotification' - type: object properties: metadata: type: object properties: payload: $ref: '#/components/schemas/OrderReadyEvent' - example: eventType: orders.order_ready examples: OrderReadyRequestExample: summary: Default orderReady request x-microcks-default: true value: eventId: c75d9460-5d48-423d-8d01-f825fd5b1672 eventTime: '2007-12-03T10:15:30+01:00' eventType: orders.order_ready metadata: payload: orderId: 69f60a06-c335-46d9-b5a1-97f1a211c514 responses: 2XX: $ref: '#/components/responses/2XX' x-microcks-operation: delay: 0 dispatcher: FALLBACK orderHandedOff: post: tags: - Manager Orders Webhooks summary: Otter Order Handed Off Status Notification Webhook operationId: orderHandedOff requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/EventNotification' - type: object properties: metadata: type: object properties: payload: $ref: '#/components/schemas/OrderHandedOffEvent' - example: eventType: orders.order_handed_off examples: OrderHandedOffRequestExample: summary: Default orderHandedOff request x-microcks-default: true value: eventId: c75d9460-5d48-423d-8d01-f825fd5b1672 eventTime: '2007-12-03T10:15:30+01:00' eventType: orders.order_handed_off metadata: payload: orderId: 69f60a06-c335-46d9-b5a1-97f1a211c514 courierPhone: 415-234-3212 courierBodyTempFahrenheit: 36.6 isCourierWearingMask: true responses: 2XX: $ref: '#/components/responses/2XX' x-microcks-operation: delay: 0 dispatcher: FALLBACK orderFulfilled: post: tags: - Manager Orders Webhooks summary: Otter Order Fulfilled Status Notification Webhook operationId: orderFulfilled requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/EventNotification' - type: object properties: metadata: type: object properties: payload: $ref: '#/components/schemas/OrderFulfilledEvent' - example: eventType: orders.order_fulfilled examples: OrderFulfilledRequestExample: summary: Default orderFulfilled request x-microcks-default: true value: eventId: c75d9460-5d48-423d-8d01-f825fd5b1672 eventTime: '2007-12-03T10:15:30+01:00' eventType: orders.order_fulfilled metadata: payload: orderId: 69f60a06-c335-46d9-b5a1-97f1a211c514 responses: 2XX: $ref: '#/components/responses/2XX' x-microcks-operation: delay: 0 dispatcher: FALLBACK menuPublish: post: tags: - Menus Webhooks summary: Otter Menu Publish Webhook description: 'Webhook to trigger a menu publish. If successful, we expect a [**menu publish callback**](/api-reference/#operation/menuPublishCallback). If an error occurred, please publish a [**callback error**](/api-reference/#operation/publishError) instead.' operationId: menuPublishWebhook requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/EventNotification' - type: object properties: metadata: type: object properties: payload: $ref: '#/components/schemas/MenuPublishEvent' - example: eventType: menus.menu_publish examples: MenuPublishWebhookRequestExample: summary: Default menuPublishWebhook request x-microcks-default: true value: eventId: c75d9460-5d48-423d-8d01-f825fd5b1672 eventTime: '2007-12-03T10:15:30+01:00' eventType: menus.menu_publish metadata: payload: menuData: {} responses: 2XX: $ref: '#/components/responses/2XX' x-microcks-operation: delay: 0 dispatcher: FALLBACK sendMenu: post: tags: - Menus Webhooks summary: Otter Send Menu Webhook description: 'Webhook to trigger a send menu. If successful, we expect a [**menu send callback**](/api-reference/#operation/menuSendCallback). If an error occurred, please publish a [**callback error**](/api-reference/#operation/publishError) instead.' operationId: sendMenuWebhook requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/EventNotification' - type: object properties: metadata: type: object properties: payload: $ref: '#/components/schemas/NullEvent' - example: eventType: menus.send_menu examples: SendMenuWebhookRequestExample: summary: Default sendMenuWebhook request x-microcks-default: true value: eventId: c75d9460-5d48-423d-8d01-f825fd5b1672 eventTime: '2007-12-03T10:15:30+01:00' eventType: menus.send_menu metadata: payload: {} responses: 2XX: $ref: '#/components/responses/2XX' x-microcks-operation: delay: 0 dispatcher: FALLBACK updateMenuEntitiesAvailabilities: post: tags: - Menus Webhooks summary: Otter Update Menu Entities Availabilities Webhook description: 'Webhook to trigger an entities availabilities update. If successful, we expect an [**update menu entities availabilities callback**](/api-reference/#operation/updateMenuEntitiesAvailabilitiesCallback). If an error occurred, please publish a [**callback error**](/api-reference/#operation/publishError) instead.' operationId: updateMenuEntitiesAvailabilitiesWebhook requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/EventNotification' - type: object properties: metadata: type: object properties: payload: $ref: '#/components/schemas/BulkUpdateItemStatus' - example: eventType: menus.update_menu_entities_availabilities examples: UpdateMenuEntitiesAvailabilitiesWebhookRequestExample: summary: Default updateMenuEntitiesAvailabilitiesWebhook request x-microcks-default: true value: eventId: c75d9460-5d48-423d-8d01-f825fd5b1672 eventTime: '2007-12-03T10:15:30+01:00' eventType: menus.update_menu_entities_availabilities metadata: payload: updates: - {} responses: 2XX: $ref: '#/components/responses/2XX' x-microcks-operation: delay: 0 dispatcher: FALLBACK upsertMenuHours: post: tags: - Menus Webhooks summary: Otter Upsert Menu Hours Webhook description: 'Webhook to trigger a menu hours update. If successful, we expect a [**menu upsert hours callback**](/api-reference/#operation/menuUpsertHours). If an error occurred, please publish a [**callback error**](/api-reference/#operation/publishError) instead.' operationId: upsertMenuHoursWebhook requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/EventNotification' - type: object properties: metadata: type: object properties: payload: $ref: '#/components/schemas/UpsertHoursEvent' - example: eventType: menus.upsert_hours examples: UpsertMenuHoursWebhookRequestExample: summary: Default upsertMenuHoursWebhook request x-microcks-default: true value: eventId: c75d9460-5d48-423d-8d01-f825fd5b1672 eventTime: '2007-12-03T10:15:30+01:00' eventType: menus.upsert_hours metadata: payload: menuHoursData: da0e4e94-5670-4175-897a-3b7dde45bed5: timeZone: America/Los_Angeles regularHours: - days: - MONDAY - TUESDAY - WEDNESDAY - THURSDAY - FRIDAY timeRanges: - start: 08:00 end: 1320 specialHours: - date: '2021-12-31' timeRanges: - start: 08:00 end: 1320 type: CLOSED responses: 2XX: $ref: '#/components/responses/2XX' x-microcks-operation: delay: 0 dispatcher: FALLBACK pauseStore: post: tags: - Storefront Webhooks summary: Otter Pause Store Webhook operationId: pauseStoreWebhook requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/EventNotification' - type: object properties: metadata: type: object properties: payload: $ref: '#/components/schemas/NullEvent' - example: eventType: storefront.pause_store examples: PauseStoreWebhookRequestExample: summary: Default pauseStoreWebhook request x-microcks-default: true value: eventId: c75d9460-5d48-423d-8d01-f825fd5b1672 eventTime: '2007-12-03T10:15:30+01:00' eventType: storefront.pause_store metadata: payload: {} responses: 2XX: $ref: '#/components/responses/2XX' x-microcks-operation: delay: 0 dispatcher: FALLBACK unpauseStore: post: tags: - Storefront Webhooks summary: Otter Unpause Store Webhook operationId: unpauseStoreWebhook requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/EventNotification' - type: object properties: metadata: type: object properties: payload: $ref: '#/components/schemas/UnpauseStoreEvent' - example: eventType: storefront.unpause_store examples: UnpauseStoreWebhookRequestExample: summary: Default unpauseStoreWebhook request x-microcks-default: true value: eventId: c75d9460-5d48-423d-8d01-f825fd5b1672 eventTime: '2007-12-03T10:15:30+01:00' eventType: storefront.unpause_store metadata: payload: 4109d2c9-8bc5-413c-af3e-1c92aa381e41 responses: 2XX: $ref: '#/components/responses/2XX' x-microcks-operation: delay: 0 dispatcher: FALLBACK getStoreAvailability: post: tags: - Storefront Webhooks summary: Otter Get Store Availability Webhook operationId: getStoreAvailabilityWebhook requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/EventNotification' - type: object properties: metadata: type: object properties: payload: $ref: '#/components/schemas/NullEvent' - example: eventType: storefront.get_store_availability examples: GetStoreAvailabilityWebhookRequestExample: summary: Default getStoreAvailabilityWebhook request x-microcks-default: true value: eventId: c75d9460-5d48-423d-8d01-f825fd5b1672 eventTime: '2007-12-03T10:15:30+01:00' eventType: storefront.get_store_availability metadata: payload: {} responses: 2XX: $ref: '#/components/responses/2XX' x-microcks-operation: delay: 0 dispatcher: FALLBACK getStoreHoursConfiguration: post: tags: - Storefront Webhooks summary: Otter Get Store Hours Configuration Webhook operationId: getStoreHoursConfigurationWebhook requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/EventNotification' - type: object properties: metadata: type: object properties: payload: $ref: '#/components/schemas/NullEvent' - example: eventType: storefront.get_store_hours examples: GetStoreHoursConfigurationWebhookRequestExample: summary: Default getStoreHoursConfigurationWebhook request x-microcks-default: true value: eventId: c75d9460-5d48-423d-8d01-f825fd5b1672 eventTime: '2007-12-03T10:15:30+01:00' eventType: storefront.get_store_hours metadata: payload: {} responses: 2XX: $ref: '#/components/responses/2XX' x-microcks-operation: delay: 0 dispatcher: FALLBACK deliveryStatusUpdate: post: tags: - Delivery Webhooks summary: Otter Update Delivery Status Webhook operationId: deliveryStatusUpdateWebhook requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/EventNotification' - type: object properties: metadata: type: object properties: payload: $ref: '#/components/schemas/DeliveryStatusUpdateEvent' - example: eventType: delivery.delivery_status_update examples: DeliveryStatusUpdateWebhookRequestExample: summary: Default deliveryStatusUpdateWebhook request x-microcks-default: true value: eventId: c75d9460-5d48-423d-8d01-f825fd5b1672 eventTime: '2007-12-03T10:15:30+01:00' eventType: delivery.delivery_status_update metadata: payload: provider: doordash courier: {} estimatedDeliveryTime: '2007-12-03T10:15:30+01:00' estimatedPickupTime: '2007-12-03T10:15:30+01:00' status: REQUESTED deliveryStatus: REQUESTED currencyCode: EUR baseFee: 1.0 extraFee: 1.0 totalFee: 1.0 distance: {} updatedTime: '2007-12-03T10:15:30+01:00' deliveryTrackingUrl: https://www.doordash.com/delivery/track/1234567890 dropoffInfo: {} responses: 2XX: $ref: '#/components/responses/2XX' x-microcks-operation: delay: 0 dispatcher: FALLBACK requestDeliveryQuotes: post: tags: - Delivery Webhooks summary: Otter Request Delivery Quotes Webhook operationId: requestDeliveryQuotesWebhook requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/EventNotification' - type: object properties: metadata: type: object properties: payload: $ref: '#/components/schemas/RequestDeliveryQuoteEvent' - example: eventType: delivery.request_quote examples: RequestDeliveryQuotesWebhookRequestExample: summary: Default requestDeliveryQuotesWebhook request x-microcks-default: true value: eventId: c75d9460-5d48-423d-8d01-f825fd5b1672 eventTime: '2007-12-03T10:15:30+01:00' eventType: delivery.request_quote metadata: payload: deliveryReferenceId: d1a5e7c6-a79a-49bc-83bf-4169cd9c9dda provider: doordash preferredPickupDuration: 0 pickupAddress: {} dropoffAddress: {} destinationAddress: {} pickUpLocationId: d197bd64-a037-4b6e-aad7-06918e7e2d75 orderSubTotal: 15 currencyCode: KRW containsAlcoholicItem: true customerPayments: - {} orderExternalIdentifiers: {} responses: 2XX: $ref: '#/components/responses/2XX' x-microcks-operation: delay: 0 dispatcher: FALLBACK acceptDelivery: post: tags: - Delivery Webhooks summary: Otter Accept Delivery Webhook operationId: acceptDeliveryWebhook requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/EventNotification' - type: object properties: metadata: type: object properties: payload: $ref: '#/components/schemas/AcceptDeliveryEvent' - example: eventType: delivery.accept examples: AcceptDeliveryWebhookRequestExample: summary: Default acceptDeliveryWebhook request x-microcks-default: true value: eventId: c75d9460-5d48-423d-8d01-f825fd5b1672 eventTime: '2007-12-03T10:15:30+01:00' eventType: delivery.accept metadata: payload: deliveryReferenceId: d1a5e7c6-a79a-49bc-83bf-4169cd9c9dda provider: doordash preferredPickupTime: '2007-12-03T10:15:30+01:00' pickupOrderId: 19dc56c8-4497-4392-a612-9f81beb5fe5f pickupNote: Left side of the restaurant pickupAddress: {} dropoffNote: Please ring the doorbell dropoffAddress: {} customer: {} customerPayments: - {} currencyCode: KRW customerTip: {} orderSubTotal: 15 pickUpLocationId: d197bd64-a037-4b6e-aad7-06918e7e2d75 containsAlcoholicItem: true pickUpInstructions: string store: {} orderItems: - {} ofoDisplayId: 5989 ofoSlug: ifood pickUpInfo: {} orderExternalIdentifiers: {} dropoffInstructions: {} deliveryFee: {} responses: 2XX: $ref: '#/components/responses/2XX' x-microcks-operation: delay: 0 dispatcher: FALLBACK cancelDelivery: post: tags: - Delivery Webhooks summary: Otter Cancel Delivery Webhook operationId: cancelDeliveryWebhook requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/EventNotification' - type: object properties: metadata: type: object properties: payload: $ref: '#/components/schemas/CancelDeliveryEvent' - example: eventType: delivery.cancel examples: CancelDeliveryWebhookRequestExample: summary: Default cancelDeliveryWebhook request x-microcks-default: true value: eventId: c75d9460-5d48-423d-8d01-f825fd5b1672 eventTime: '2007-12-03T10:15:30+01:00' eventType: delivery.cancel metadata: payload: deliveryReferenceId: d1a5e7c6-a79a-49bc-83bf-4169cd9c9dda responses: 2XX: $ref: '#/components/responses/2XX' x-microcks-operation: delay: 0 dispatcher: FALLBACK updateDeliveryRequest: post: tags: - Delivery Webhooks summary: Otter Update Delivery Request Webhook operationId: updateDeliveryRequestWebhook requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/EventNotification' - type: object properties: metadata: type: object properties: payload: $ref: '#/components/schemas/UpdateDeliveryRequestEvent' - example: eventType: delivery.update_request examples: UpdateDeliveryRequestWebhookRequestExample: summary: Default updateDeliveryRequestWebhook request x-microcks-default: true value: eventId: c75d9460-5d48-423d-8d01-f825fd5b1672 eventTime: '2007-12-03T10:15:30+01:00' eventType: delivery.update_request metadata: payload: deliveryReferenceId: d1a5e7c6-a79a-49bc-83bf-4169cd9c9dda provider: doordash currencyCode: USD customerPayments: - {} customerTip: {} pickUpInfo: {} responses: 2XX: $ref: '#/components/responses/2XX' x-microcks-operation: delay: 0 dispatcher: FALLBACK reportGenerated: post: tags: - Reports Webhooks summary: Otter Report Generated Webhook operationId: reportGeneratedWebhook requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/EventNotification' - type: object properties: metadata: type: object properties: payload: $ref: '#/components/schemas/ReportGeneratedEvent' - example: eventType: reports.report_generated examples: ReportGeneratedWebhookRequestExample: summary: Default reportGeneratedWebhook request x-microcks-default: true value: eventId: c75d9460-5d48-423d-8d01-f825fd5b1672 eventTime: '2007-12-03T10:15:30+01:00' eventType: reports.report_generated metadata: payload: reportUrl: https://example.com/ jobId: 38ab397f-b142-4b06-b70c-40c68a408bea responses: 2XX: $ref: '#/components/responses/2XX' x-microcks-operation: delay: 0 dispatcher: FALLBACK ping: post: tags: - Ping Webhooks summary: Otter Ping Webhook description: Used to validate the integration without side effects operationId: pingWebhook requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/EventNotification' - type: object properties: metadata: type: object properties: payload: $ref: '#/components/schemas/PingEvent' - example: eventType: ping.ping examples: PingWebhookRequestExample: summary: Default pingWebhook request x-microcks-default: true value: eventId: c75d9460-5d48-423d-8d01-f825fd5b1672 eventTime: '2007-12-03T10:15:30+01:00' eventType: ping.ping metadata: payload: message: Hello World responses: 2XX: $ref: '#/components/responses/2XX' x-microcks-operation: delay: 0 dispatcher: FALLBACK upsertStore: post: tags: - Account Pairing Webhooks summary: Otter Upsert Store description: Sent when a store is created or updated in `Public API` internal systems.
If metadata contains a `Store ID`, it means a request to update an existent store, otherwise, it's a creation operation.
It provides the store and credentials data needed to validate the store and create a new `Store ID` in the partner application.
At this point, the store is in `onboarding state` waiting the partner application to finish the onboarding process by providing the validated `Store ID`. operationId: upsertStorelinkWebhook requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/EventNotification' - type: object properties: metadata: type: object properties: payload: $ref: '#/components/schemas/UpsertStorelinkEvent' - example: eventType: stores.upsert examples: UpsertStorelinkWebhookRequestExample: summary: Default upsertStorelinkWebhook request x-microcks-default: true value: eventId: c75d9460-5d48-423d-8d01-f825fd5b1672 eventTime: '2007-12-03T10:15:30+01:00' eventType: stores.upsert metadata: payload: credentialsSchemaVersion: '1.0' credentials: - key: email value: test@email.com - key: password value: test-pwd-1234 storeInfo: &id001 name: Store Public Name address: Some Street, 1234 currencyCode: USD timezone: America/Los_Angeles internalStoreId: 51608e41-5d9e-477f-ae02-8c0c68036d5d responses: '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '409': description: The provided credentials already exists in another store. content: application/json: schema: $ref: '#/components/schemas/ErrorMessage' examples: UpsertStorelinkWebhook409Example: summary: Default upsertStorelinkWebhook 409 response x-microcks-default: true value: message: The request body is invalid. details: - attribute: Order Currency Code message: Order Currency Code must be exactly 3 characters '422': description: The provided credentials are not compatible with the provided schema version. content: application/json: schema: $ref: '#/components/schemas/ErrorMessage' examples: UpsertStorelinkWebhook422Example: summary: Default upsertStorelinkWebhook 422 response x-microcks-default: true value: message: The request body is invalid. details: - attribute: Order Currency Code message: Order Currency Code must be exactly 3 characters 2XX: description: 'The provided credentials are compatible with the provided schema version, successfully saved in the partner application database and available for the validation process (establishing a connection with the service related to the Application ID, e.g.: UberEats).' x-microcks-operation: delay: 0 dispatcher: FALLBACK removeStore: post: tags: - Account Pairing Webhooks summary: Otter Remove Store description: Sent when a store is removed from our system. Contains information about the store for which the event was triggered. operationId: removeStoreWebhook requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/EventNotification' - type: object properties: metadata: type: object properties: payload: $ref: '#/components/schemas/RemoveStorelinkEvent' - example: eventType: stores.remove examples: RemoveStoreWebhookRequestExample: summary: Default removeStoreWebhook request x-microcks-default: true value: eventId: c75d9460-5d48-423d-8d01-f825fd5b1672 eventTime: '2007-12-03T10:15:30+01:00' eventType: stores.remove metadata: payload: storeInfo: *id001 responses: '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' 2XX: description: The store credentials for the service related to the Application ID were successfully removed from the partner application database. x-microcks-operation: delay: 0 dispatcher: FALLBACK fetchCredentials: post: tags: - Account Pairing Webhooks summary: Otter Fetch Credentials (synchronously) description: Synchronously returns the last version of the credentials schema needed to create and validate a store in the partner application. If the request contains the `Store ID`, it also returns the saved store credentials corresponding to the provided `Store ID`. operationId: fetchCredentialsWebhook requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/EventNotificationBase' - $ref: '#/components/schemas/OptionalStoreIdInMetadata' - example: eventType: stores.fetch_credentials - type: object properties: metadata: type: object properties: payload: $ref: '#/components/schemas/FetchCredentialsEvent' examples: FetchCredentialsWebhookRequestExample: summary: Default fetchCredentialsWebhook request x-microcks-default: true value: eventId: c75d9460-5d48-423d-8d01-f825fd5b1672 eventTime: '2007-12-03T10:15:30+01:00' eventType: stores.fetch_credentials metadata: payload: credentials: - key: email value: test@email.com - key: password value: test-pwd-1234 responses: '200': description: The credentials schema and, if the request contains the Store ID, the correspondent store credentials. content: application/json: schema: $ref: '#/components/schemas/ViewCredentialsArray' examples: FetchCredentialsWebhook200Example: summary: Default fetchCredentialsWebhook 200 response x-microcks-default: true value: credentialsSchemaVersion: '1.0' credentials: - key: email label: Email value: foodstore@email.com - key: password label: Password value: test-pwd-1234 - key: language label: Choose the language inputType: SELECT selectOptions: - English - Portuguese - key: supported_sizes label: Choose all supported sizes inputType: SELECT selectOptions: - SMALL - MEDIUM - LARGE '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' x-microcks-operation: delay: 0 dispatcher: FALLBACK x-tagGroups: - name: Endpoints tags: - Account Pairing Endpoints - Auth Endpoints - Callback Endpoints - Delivery Endpoints - Finance Endpoints - Inventory Endpoints - Manager Menu Endpoints - Manager Order Endpoints - Manager Storefront Endpoints - Menus Endpoints - Orders Endpoints - Organization Endpoints - Ping Endpoints - Reports Endpoints - Reviews Endpoints - Storefront Endpoints - Manager Loyalty Endpoints - Direct Orders Endpoints - Store Endpoints - name: Webhooks tags: - Account Pairing Webhooks - Delivery Webhooks - Manager Orders Webhooks - Menus Webhooks - Orders Webhooks - Ping Webhooks - Reports Webhooks - Storefront Webhooks