Otter Manager Order Endpoints API

openapi: 3.2.0
info:
  title: Public Account Pairing Endpoints Manager Order 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<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: 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: Manager Order Endpoints
  description: Endpoints for applications managing order related data and operations.
  x-displayName: Orders Manager
paths:
  /manager/order/v1/orders/order-created:
    post:
      tags:
      - Manager Order Endpoints
      summary: Otter Notify the Result of a Create Order Event
      description: '`RATE LIMIT: 32 per minute`

        '
      operationId: orderCreated
      parameters:
      - $ref: '#/components/parameters/storeIdHeader'
      - $ref: '#/components/parameters/eventIdHeader'
      responses:
        '200':
          description: The Create Order 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:
        - manager.orders
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /manager/order/v1/orders:
    get:
      tags:
      - Manager Order Endpoints
      summary: Otter Fetch Order Feed for a Store
      operationId: managerGetOrderFeed
      parameters:
      - $ref: '#/components/parameters/storeIdHeader'
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/opaquePaginationToken'
      - $ref: '#/components/parameters/minDateTime'
      - $ref: '#/components/parameters/maxDateTime'
      responses:
        '200':
          description: Order feed was successfully retrieved
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrderFeed'
              examples:
                ManagerGetOrderFeed200Example:
                  summary: Default managerGetOrderFeed 200 response
                  x-microcks-default: true
                  value:
                    orders:
                    - 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: {}
                    offsetToken: H12MAF2fFaFFFa
        '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:
        - manager.orders
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /manager/order/v1/sources/{source}/orders/{orderId}:
    get:
      tags:
      - Manager Order Endpoints
      summary: Otter Fetch Order with Manager Info
      operationId: getManagerOrder
      parameters:
      - $ref: '#/components/parameters/storeIdHeader'
      - $ref: '#/components/parameters/orderId'
      - $ref: '#/components/parameters/source'
      responses:
        '200':
          description: Order information was successfully retrieved
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrderWithManagerInfo'
              examples:
                GetManagerOrder200Example:
                  summary: Default getManagerOrder 200 response
                  x-microcks-default: true
                  value:
                    order:
                      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: {}
                    injectionState: UNKNOWN
                    orderCancelDetails:
                      cancelSource: UNKNOWN
                    injectionEvent: UNKNOWN
                    orderIssues:
                      orderIssues:
                      - {}
                      itemIssues:
                      - {}
        '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:
        - manager.orders
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /manager/order/v1/sources/{source}/orders/{orderId}/confirm:
    post:
      tags:
      - Manager Order Endpoints
      summary: Otter Request Order Confirmation
      description: '`RATE LIMIT: 32 per minute`

        '
      operationId: requestOrderConfirmation
      parameters:
      - $ref: '#/components/parameters/storeIdHeader'
      - $ref: '#/components/parameters/source'
      - $ref: '#/components/parameters/orderId'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ManagerConfirmOrderRequest'
            examples:
              RequestOrderConfirmationRequestExample:
                summary: Default requestOrderConfirmation request
                x-microcks-default: true
                value:
                  estimatedPrepTimeMinutes: 15
        required: false
      responses:
        '202':
          description: The order confirmation request was successfully accepted.
        '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:
        - manager.orders
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /manager/order/v1/sources/{source}/orders/{orderId}/cancel:
    post:
      tags:
      - Manager Order Endpoints
      summary: Otter Request Order Cancelation
      description: '`RATE LIMIT: 32 per minute`

        '
      operationId: requestOrderCancelation
      parameters:
      - $ref: '#/components/parameters/storeIdHeader'
      - $ref: '#/components/parameters/source'
      - $ref: '#/components/parameters/orderId'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ManagerCancelOrderRequest'
            examples:
              RequestOrderCancelationRequestExample:
                summary: Default requestOrderCancelation request
                x-microcks-default: true
                value:
                  cancellationReason: REASON_UNKNOWN
                  cancelingParty:
                    name: Jane Doe
                    phone: +1-555-555-5555
                    phoneCode: 111 11 111
                    email: email@email.com
                    personalIdentifiers: {}
        required: true
      responses:
        '202':
          description: The order cancelation request was successfully accepted.
        '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:
        - manager.orders
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /manager/order/v1/sources/{source}/orders/{orderId}/ready-to-pickup:
    post:
      tags:
      - Manager Order Endpoints
      summary: Otter Mark an Order as Ready to Pickup
      description: '`RATE LIMIT: 32 per minute`

        '
      operationId: markAsReadyToPickup
      parameters:
      - $ref: '#/components/parameters/storeIdHeader'
      - $ref: '#/components/parameters/source'
      - $ref: '#/components/parameters/orderId'
      responses:
        '202':
          description: The order was successfully marked as ready to pickup.
        '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:
        - manager.orders
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /manager/order/v1/sources/{source}/orders/{orderId}/create-packaging-component:
    post:
      tags:
      - Manager Order Endpoints
      summary: Otter Create a Packaging Component
      description: '`RATE LIMIT: 32 per minute`

        '
      operationId: createPackagingOrderComponent
      parameters:
      - $ref: '#/components/parameters/storeIdHeader'
      - $ref: '#/components/parameters/source'
      - $ref: '#/components/parameters/orderId'
      responses:
        '200':
          description: The packaging component was successfully created.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrderComponentId'
              examples:
                CreatePackagingOrderComponent200Example:
                  summary: Default createPackagingOrderComponent 200 response
                  x-microcks-default: true
                  value:
                    orderComponentId: 69f60a06-c335-46d9-b5a1-97f1a211c514
                    orderComponentOrderId: 69f60a06-c335-46d9-b5a1-97f1a211c514
        '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:
        - manager.orders
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /manager/order/v1/sources/{source}/orders/{orderId}/fulfill:
    post:
      tags:
      - Manager Order Endpoints
      summary: Otter Mark an Order as Fulfilled
      description: '`RATE LIMIT: 32 per minute`

        '
      operationId: markAsFulfilled
      parameters:
      - $ref: '#/components/parameters/storeIdHeader'
      - $ref: '#/components/parameters/source'
      - $ref: '#/components/parameters/orderId'
      responses:
        '202':
          description: The order was successfully marked as fulfilled.
        '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:
        - manager.orders
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /manager/order/v1/sources/{source}/orders/{orderId}/close:
    post:
      tags:
      - Manager Order Endpoints
      summary: Otter Mark a Dine-in (open-tab) Order as Closed
      description: 'Marks an open-tab dine-in order as closed. The closing party is always the merchant/POS (system). `RATE LIMIT: 32 per minute`

        '
      operationId: markDineInOrderClosed
      parameters:
      - $ref: '#/components/parameters/storeIdHeader'
      - $ref: '#/components/parameters/source'
      - $ref: '#/components/parameters/orderId'
      responses:
        '202':
          description: The order was successfully marked as closed.
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '409':
          description: Order could not be closed (e.g. already closed or not an open-tab order).
        '422':
          $ref: '#/components/responses/422'
      security:
      - OAuth2.0:
        - manager.orders
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /manager/order/v1/sources/{source}/orders/{orderId}/items:
    put:
      tags:
      - Manager Order Endpoints
      summary: Otter Update Order Customer Items
      description: 'Updates customer items for a dine-in order (quantity change, price adjustment, or add item). Only supported when integration slug is d2c-eater-website, order fulfillment type is dine-in, and the order tab is open (order is modifiable). Modifying party and modification request ID are set by the endpoint. `RATE LIMIT: 8 per minute`

        '
      operationId: managerUpdateOrderCustomerItems
      parameters:
      - $ref: '#/components/parameters/storeIdHeader'
      - $ref: '#/components/parameters/source'
      - $ref: '#/components/parameters/orderId'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OrderCustomerItemsUpdateRequest'
            examples:
              ManagerUpdateOrderCustomerItemsRequestExample:
                summary: Default managerUpdateOrderCustomerItems request
                x-microcks-default: true
                value:
                  currencyCode: USD
                  customerItemModifications: []
        required: true
      responses:
        '202':
          description: The order customer items update was successfully accepted.
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '409':
          description: 'Customer items update is not allowed (e.g. slug is not d2c-eater-website, order is not dine-in, or order tab is not open).

            '
        '422':
          $ref: '#/components/responses/422'
      security:
      - OAuth2.0:
        - manager.orders
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /manager/order/v1/sources/{source}/orders/{orderId}/prep-time:
    post:
      tags:
      - Manager Order Endpoints
      summary: Otter Update Order Prep Time
      description: '`RATE LIMIT: 32 per minute`

        '
      operationId: updateOrderPrepTime
      parameters:
      - $ref: '#/components/parameters/storeIdHeader'
      - $ref: '#/components/parameters/source'
      - $ref: '#/components/parameters/orderId'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OrderPrepTimeUpdateRequest'
            examples:
              UpdateOrderPrepTimeRequestExample:
                summary: Default updateOrderPrepTime request
                x-microcks-default: true
                value:
                  prepTimeMinutes: 1780000000000
        required: true
      responses:
        '202':
          description: The order new preparation time was successfully accepted.
        '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:
        - orders.update
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  schemas:
    PreparationTime:
      type:
      - object
      - 'null'
      description: Preparation time information for an order.
      properties:
        estimatedPreparationTime:
          type: string
          description: Preparation time estimated by the order provider. Use the Standard ISO 8601 Duration format (E.g. PT1H30M for 1 hour, 30 minutes).
          example: PT30M
    ManagerItemIssue:
      required:
      - code
      type: object
      properties:
        code:
          type: string
          description: The error code indicating the type of error
          enum:
          - UNKNOWN
          - ITEM_MISMATCH
          - INCOMPLETE_MENU
          - NO_PARENT_ENTITY
          - MULTIPLE_PARENT_ENTITIES
          - MISCONFIGURED_INTEGRATION
          - INVALID_PARENT_ENTITY_SETUP
          - CATEGORY_MISSING
          - EXTERNAL_MODIFIER_GROUP_MISSING
          - INTERNAL_MODIFIER_GROUP_MISSING
          example: ITEM_MISMATCH
        description:
          type: string
          description: A friendly description describing what went wrong
          example: Item not found
      description: A detailed issue encountered with this item or modifier
    SignatureRequirement:
      type:
      - object
      - 'null'
      properties:
        enabled:
          type: boolean
          description: Marks the signature requirement as required.
          example: true
        collectSignerName:
          type: boolean
          description: Whether the signer's name should be collected.
          example: true
        collectSignerRelationship:
          type: boolean
          description: Whether the signer's relationship with the intended recipient should be collected.
          example: true
      description: Enables and configure the signature requirement.
    PaymentDetailsBecs:
      type: object
      description: Details of a BECS payment method in Australia.
      properties:
        mandateStatus:
          $ref: '#/components/schemas/MandateStatus'
        lastFour:
          type: string
          description: The last four digits of the BECS account.
          example: '3210'
        bsbNumber:
          type: string
          description: The BSB number of the BECS account.
          example: 062-001
        mandateId:
          type: string
          description: The mandate ID for the BECS account.
          example: becs_mandate_789
        url:
          type: string
          description: The URL for the BECS payment details.
          example: http://example.com/becs
    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
    RecordProviderType:
      type: string
      enum:
      - ALLINPAY
      - CHECKOUT
      - CSS
      - MERCADO_PAGO
      - OLIVENETWORKS
      - SHOUQIANBA
      - STRIPE
      - UNIONPAY
      - VAN_DAOU
      - VAN_JTNET
      - VAN_KICC
      - VAN_KIS
      - VAN_KOVAN
      - VAN_KSNET
      - VAN_NICE
      - VAN_SMARTRO
      - UNKNOWN
      example: STRIPE
      description: The type of payment provider.
    SourceExternalIdentifiers:
      type:
      - object
      - 'null'
      properties:
        id:
          type: string
          description: Unique ID for the order that was placed.
          example: 69f60a06-c335-46d9-b5a1-97f1a211c514
        friendlyId:
          type: string
          description: ID used for driver pickup and restaurant management.
          example: ABCDE
        source:
          type: string
          description: Describes the source of the order, typically from a food ordering marketplace.
          example: ubereats
        sourceType:
          type: string
          description: source type of the order
          enum:
          - POINT_OF_SALE
          - ORDERING_MARKETPLACE
          - AGGREGATOR
          - CUSTOMER_INTERACTION
          example: POINT_OF_SALE
        sourceExternalIdentifiers:
          $ref: '#/components/schemas/SourceExternalIdentifiers'
      description: The external identifiers.
    QuantityUpdatedModification:
      required:
      - customerItemIds
      - quantity
      - oldQuantity
      type: object
      properties:
        customerItemIds:
          type: array
          description: Unique IDs for the ordered customer items (station item can map to multiple).
          minItems: 1
          items:
            type: string
        quantity:
          type: number
          minimum: 0
          format: int32
          description: New quantity (0 to remove item).
          example: 1.0
        oldQuantity:
          type: number
          minimum: 0
          format: int32
          description: Previous quantity.
          example: 1.0
    Address:
      type:
      - object
      - 'null'
      properties:
        fullAddress:
          type:
          - string
          - 'null'
          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
          - 'null'
          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
          - 'null'
          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.
    Person:
      type:
      - object
      - 'null'
      properties:
        name:
          type:
          - string
          - 'null'
          description: The person's name as it should be displayed.
          example: Jane Doe
          maxLength: 255
        phone:
          type:
          - string
          - 'null'
          description: The person's phone number.
          example: +1-555-555-5555
          maxLength: 25
        phoneCode:
          type:
          - string
          - 'null'
          description: A code or extension of the phone number.
          example: 111 11 111
          maxLength: 25
        email:
          type:
          - string
          - 'null'
          description: The

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