Otter Public API

openapi: 3.0.1
info:
  title: Public 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<SecurityDefinitions />\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 <hash signature>' \\\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: [email protected]
  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: Ping Endpoints
  description: Endpoints to ping and test system authentication.
  x-displayName: Ping
- name: Manager Order Endpoints
  description: Endpoints for applications managing order related data and operations.
  x-displayName: Orders Manager
- name: Orders Endpoints
  description: Endpoints to manage orders for a store.
  x-displayName: Orders
- name: Orders Webhooks
  description: Webhooks from orders domains.
  x-displayName: Orders Webhooks
- name: Manager Orders Webhooks
  description: Webhooks from manager orders domain.
  x-displayName: Orders Manager Webhooks
- name: Callback Endpoints
  description: Endpoints for callback management.
  x-displayName: Callback
- name: Reports Endpoints
  description: Endpoints to reports generation operations
  x-displayName: Reports
- name: Reports Webhooks
  description: Webhooks from the reports generation operations
  x-displayName: Reports Webhooks
- name: Reviews Endpoints
  description: Endpoints for review operations
  x-displayName: Reviews
- name: Manager Storefront Endpoints
  description: Endpoints for applications managing storefront related data and operations.
  x-displayName: Storefront Manager
- name: Storefront Endpoints
  description: Endpoints to manage storefront state
  x-displayName: Storefront
- name: Storefront Webhooks
  description: Webhooks from storefront domain.
  x-displayName: Storefront Webhooks
- name: Manager Menu Endpoints
  description: Endpoints for applications managing menus related data and operations.
  x-displayName: Menus Manager
- name: Menus Endpoints
  description: Endpoints to manage menus.
  x-displayName: Menus
- name: Menus Webhooks
  description: Webhooks from menus domain.
  x-displayName: Menus Webhooks
- name: Auth Endpoints
  description: Endpoints to handle token management.
  x-displayName: Auth
- name: Delivery Endpoints
  description: Endpoints to manage delivery.
  x-displayName: Delivery
- name: Delivery Webhooks
  description: Webhooks from the delivery domain.
  x-displayName: Delivery Webhooks
- name: Ping Webhooks
  description: Webhooks to ping and test the system integration.
  x-displayName: Ping Webhooks
- name: Storelinks Endpoints
  description: Endpoints to pair accounts between platforms for onboarding and offboarding purposes.
  x-displayName: Stores Endpoints
- name: Storelinks Webhooks
  description: Webhooks to manage the store onboarding process.
  x-displayName: Stores Webhooks
- name: Finance Endpoints
  description: Endpoints to handle financial data.
  x-displayName: Finance
- name: Utils Endpoints
  description: Endpoints to provide access to integration utilities.
  x-displayName: Integration Utilities
- name: Account Pairing Endpoints
  description: Endpoints to manage store onboarding and status
  x-displayName: Account Pairing
- name: Account Pairing Webhooks
  description: Webhooks to manage store onboarding and status
  x-displayName: Account Pairing Webhooks
- name: Inventory Endpoints
  description: Endpoints to interact with product inventory.
  x-displayName: Inventory
- name: Organization Endpoints
  description: Endpoints to interact with with organizations/brands/stores and with integration connections.
  x-displayName: Organization
- name: Manager Loyalty Endpoints
  description: Endpoints to manage loyalty.
  x-displayName: Loyalty Manager
- name: Direct Orders Endpoints
  description: Endpoints to get orders directly.
  x-displayName: Direct Orders
- name: Store Endpoints
  description: Endpoints to get store information.
  x-displayName: Store
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: &id028
                        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.\nIf 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.\nIf 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.\nIf 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.\nIf 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: &id029
                        da0e4e94-5670-4175-897a-3b7dde45bed5:
                          timeZone: America/Los_Angeles
                          regularHours:
                          - days:
                            - MONDAY
                            - TUESDAY
                            - WEDNESDAY
                            - THURSDAY
                            - FRIDAY
                            timeRanges:
                            - start: 08:00
                              end: 22:00
                          specialHours:
                          - date: '2021-12-31'
                            timeRanges:
                            - start: 08:00
                              end: 22:00
                            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:
          

# --- truncated at 32 KB (460 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/otter/refs/heads/main/openapi/otter-public-api-openapi.yml