CloudKitchens Manager Order Endpoints API

openapi: 3.2.0
info:
  title: Public 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
servers:
- url: https://{{public-api-url}}
  description: Staging server url
tags:
- name: manager_order_endpoints
  description: 'Endpoints for applications that act on the merchant/store side of an order rather than as the ordering marketplace — typically Point-of-Sale (POS) systems, Business Intelligence (BI) tools, and reporting integrations.


    This domain lets a merchant-side application retrieve a store''s orders and manage them on the store''s behalf as they progress through their lifecycle.'
  x-displayName: Orders Manager (POS, BI &amp; Reports)
paths:
  /manager/order/v1/orders/order-created:
    post:
      tags:
      - manager_order_endpoints
      summary: Notify the result of a Create Order event
      description: '`RATE LIMIT: 32 per minute`


        Callback used by a merchant-side integration to acknowledge the result of an order-creation webhook it received. Send the `X-Event-Id` of the original webhook event so the platform can correlate the acknowledgement with the order it created.

        '
      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
  /manager/order/v1/orders:
    get:
      tags:
      - manager_order_endpoints
      summary: Fetch order feed for a store
      description: '`RATE LIMIT: 32 per minute`


        Returns a paginated feed of the store''s orders, most useful for POS, BI, and reporting integrations that periodically poll for new and updated orders.


        Use `limit` to control page size and the opaque pagination token to page through results — when the response `offsetToken` is absent, no more orders are available. Narrow the window with `minDateTime` / `maxDateTime` (ISO 8601 with time zone). The lookback window is bounded by the platform''s retention period (currently up to the past 20 days).

        '
      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'
        '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
  /manager/order/v1/sources/{source}/orders/{orderId}:
    get:
      tags:
      - manager_order_endpoints
      summary: Fetch order with Manager Info
      description: '`RATE LIMIT: 32 per minute`


        Returns the full detail of a single order for the given `source` (the ordering marketplace the order came from, e.g. `ubereats`), enriched with merchant-side information: the current POS `injectionState`, the `injectionEvent` that triggered it, any `orderIssues`, and cancellation details when applicable.


        Item and modifier identifiers in the returned order are the store''s external (POS) identifiers, so they line up with the merchant''s own catalog.

        '
      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'
        '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
  /manager/order/v1/sources/{source}/orders/{orderId}/confirm:
    post:
      tags:
      - manager_order_endpoints
      summary: Request order confirmation
      description: '`RATE LIMIT: 32 per minute`


        Confirms (accepts) the order for the given `source` on behalf of the store — the typical action a POS takes when the merchant accepts an incoming order. Optionally include `estimatedPrepTimeMinutes` to communicate how long the order will take to prepare. Processed asynchronously; returns `202 Accepted`.

        '
      operationId: requestOrderConfirmation
      parameters:
      - $ref: '#/components/parameters/storeIdHeader'
      - $ref: '#/components/parameters/source'
      - $ref: '#/components/parameters/orderId'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ManagerConfirmOrderRequest'
        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
  /manager/order/v1/sources/{source}/orders/{orderId}/cancel:
    post:
      tags:
      - manager_order_endpoints
      summary: Request order cancelation
      description: '`RATE LIMIT: 32 per minute`


        Cancels (rejects) the order for the given `source` on behalf of the store. A `cancellationReason` is required; optionally include the `cancelingParty` to record who initiated the cancellation. Processed asynchronously; returns `202 Accepted`.

        '
      operationId: requestOrderCancelation
      parameters:
      - $ref: '#/components/parameters/storeIdHeader'
      - $ref: '#/components/parameters/source'
      - $ref: '#/components/parameters/orderId'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ManagerCancelOrderRequest'
        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
  /manager/order/v1/sources/{source}/orders/{orderId}/ready-to-pickup:
    post:
      tags:
      - manager_order_endpoints
      summary: Mark an order as ready to pickup
      description: '`RATE LIMIT: 32 per minute`


        Signals that the store has finished preparing the order for the given `source` and it is ready for the courier or customer to collect. Marks all of the order''s station tickets as prepared. Processed asynchronously; returns `202 Accepted`.

        '
      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
  /manager/order/v1/sources/{source}/orders/{orderId}/create-packaging-component:
    post:
      tags:
      - manager_order_endpoints
      summary: Create a packaging component
      description: '`RATE LIMIT: 32 per minute`


        Creates a packaging component (a packaging ticket) for the order of the given `source`, used by kitchen/station workflows to print or track packaging for the order. Returns the identifiers of the created order component.

        '
      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'
        '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
  /manager/order/v1/sources/{source}/orders/{orderId}/fulfill:
    post:
      tags:
      - manager_order_endpoints
      summary: Mark an order as fulfilled
      description: '`RATE LIMIT: 32 per minute`


        Marks the order for the given `source` as handed off / fulfilled — the final operational step, once the order has been given to the courier or customer. Processed asynchronously; returns `202 Accepted`.

        '
      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
  /manager/order/v1/sources/{source}/orders/{orderId}/close:
    post:
      tags:
      - manager_order_endpoints
      summary: 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
  /manager/order/v1/sources/{source}/orders/{orderId}/items:
    put:
      tags:
      - manager_order_endpoints
      summary: 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'
        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
  /manager/order/v1/sources/{source}/orders/{orderId}/prep-time:
    post:
      tags:
      - manager_order_endpoints
      summary: Update order prep time
      description: '`RATE LIMIT: 32 per minute`


        Updates the estimated preparation time (in minutes) for the order of the given `source`, e.g. when the kitchen revises its estimate after the order was confirmed. Unlike the other manager endpoints, this one uses the `orders.update` scope. Processed asynchronously; returns `202 Accepted`.

        '
      operationId: updateOrderPrepTime
      parameters:
      - $ref: '#/components/parameters/storeIdHeader'
      - $ref: '#/components/parameters/source'
      - $ref: '#/components/parameters/orderId'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OrderPrepTimeUpdateRequest'
        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
components:
  schemas:
    OrderTotal:
      required:
      - subtotal
      type: object
      properties:
        subtotal:
          type: number
          description: 'The order''s calculated subtotal: the sum of all item and modifier prices **before** tax, tips, fees, and discounts are applied. This is the value the platform computes from the line items.


            All amounts in this object are expressed in the major unit of the order''s `currencyCode` (for example `11.97` means 11 dollars and 97 cents), never in minor units (cents).'
          example: 11.97
        claimedSubtotal:
          type:
          - number
          - 'null'
          description: The subtotal as claimed by the order source (the ordering marketplace), which is **not guaranteed to match** the calculated `subtotal`. When you send an order, set this only if the source reports a subtotal that may differ from the sum of the line items; otherwise omit it and `subtotal` is used. Downstream reconciliation and reporting use this to surface discrepancies between what the source claimed and what the items add up to.
          example: 11.97
        discount:
          type:
          - number
          - 'null'
          description: The total discount applied to the order, represented as a **negative** value (a discount reduces what the customer pays), e.g. `-1.10`. On input either sign is accepted — the platform normalizes the value to negative (it takes the absolute value and negates it) — but responses always return it negative. This is a single aggregate figure; to break a discount down by who funded it (restaurant, marketplace, voucher, promotion, operator, or loyalty) use `orderTotalV2` instead.
          example: -1.1
        tax:
          type:
          - number
          - 'null'
          description: Total tax paid by the customer for this order. This is an aggregate; for a per-line tax / VAT breakdown use `orderTotalV2`.
          example: 1.1
        tip:
          type:
          - number
          - 'null'
          description: Total tip paid by the customer. This is an aggregate that does not distinguish a tip destined for the restaurant from a tip destined for the delivery courier — `orderTotalV2` splits those into `tipForRestaurant` and `tipForServiceProviderCourier`.
          example: 2
        deliveryFee:
          type:
          - number
          - 'null'
          description: Total delivery fee paid by the customer. This is an aggregate that does not distinguish a fee for store-provided delivery from a fee for marketplace-provided delivery — `orderTotalV2` splits those into `feeForRestaurantProvidedDelivery` and `feeForServiceProviderDelivery`.
          example: 5
        total:
          type:
          - number
          - 'null'
          description: 'The grand total: everything paid by the customer for this order (subtotal + tax + tip + fees − discounts). This is the amount used as the customer-facing order value in receipts, reporting, and reconciliation.'
          example: 19.07
        couponCode:
          type:
          - string
          - 'null'
          description: Coupon code applied to the order. When an order carries multiple coupon codes they are joined into this single string with the pipe character (`|`) as a separator (for example `SAVE5|FREESHIP`). To send or receive coupon codes as a structured list, use `orderTotalV2.customerTotal.couponCodes`.
          example: VWXYZ98765
      description: 'Flat, customer-facing breakdown of an order''s monetary values (V1).


        `orderTotal` captures only what the customer was charged, as a small set of aggregate figures. It cannot express per-line taxes, the source of a discount, the split of tips/delivery fees between the store and the marketplace, or the store''s net payout and the marketplace''s charges. For any of those, prefer the richer `orderTotalV2`.


        When creating or updating an order you must supply **at least one** of `orderTotal` or `orderTotalV2`. You may send both; if you do, `orderTotalV2` takes precedence for the financial breakdown and the `orderTotal` aggregates are checked against it for consistency. All values are in the major unit of the order''s `currencyCode`.'
    PromotionDetails:
      type:
      - object
      - 'null'
      description: Order promotion details.
      properties:
        externalId:
          type: string
          description: External promotion identifier.
        name:
          type: string
          description: Promotion name.
          example: 20% off, up to $5
        value:
          type: number
          description: Promotion value.
          example: 2
    Payout:
      type:
      - object
      - 'null'
      properties:
        payoutFromServiceProvider:
          type:
          - number
          - 'null'
          description: Amount the store is paid out by the order source (the ordering marketplace the order came from). For marketplace orders this is usually the customer total minus the marketplace's `serviceProviderCharge` deductions.
          example: 1
        payoutFrom3rdParty:
          type:
          - number
          - 'null'
          description: Amount the store is paid out by a third-party organization involved in the order (for example a separate payment or delivery aggregator), when applicable.
          example: 1
        cashPayout:
          type:
          - number
          - 'null'
          description: Amount the store effectively keeps from cash collected directly from the customer at pickup or delivery (cash never flows through the marketplace).
          example: 1
      description: Breakdown of the net payout the store receives for this order, by source of the payout. The sum of these fields represents the money the store ultimately nets; pair it with `serviceProviderCharge` to reconcile against the customer-facing `customerTotal`. Amounts are in the major unit of the order's `currencyCode`.
    OrderWithManagerInfo:
      required:
      - order
      - injectionState
      - injectionEvent
      type: object
      properties:
        order:
          $ref: '#/components/schemas/Order'
        injectionState:
          type: string
          description: 'The current state of injecting this order into the store''s POS / merchant system. Notable values: `PENDING` (injection in progress), `SUCCEEDED` / `MANUAL_INJECTION_SUCCEEDED` (order reached the POS), `SUCCEEDED_WITH_UNLINKED_ITEM` (injected but some items could not be matched to the POS catalog), `MANUAL_INJECTION_REQUIRED` / `FAILED_ATTEMPT` (needs attention), and the `ORDER_CANCELED` / `ORDER_REJECTED` family for cancellation/rejection outcomes.'
          enum:
          - UNKNOWN
          - PENDING
          - SUCCEEDED
          - FAILED_ATTEMPT
          - MANUAL_INJECTION_SUCCEEDED
          - MANUAL_INJECTION_REQUIRED
          - SUCCEEDED_WITH_UNLINKED_ITEM
          - ORDER_CANCELED
          - ORDER_CANCEL_FAILED
          - ORDER_REJECTED
          - ORDER_REJECT_FAILED
          - RE_INJECTION_REQUESTED
          - RE_INJECTION_PENDING
        orderCancelDetails:
          description: If canceled - specific details about why this order was canceled
          $ref: '#/components/schemas/ManagerOrderCancelDetails'
        injectionEvent:
          type: string
          description: The order event that triggered order injection into manager
          enum:
          - UNKNOWN
          - ORDER_CREATE
          - ORDER_ACCEPT
          - ORDER_IMPORT
          - ORDER_RE_INJECT
        orderIssues:
          description: Issues encountered with this manager order
          $ref: '#/components/schemas/ManagerOrderIssues'
      description: An order placed by a customer with manager injection details
    ItemAddedModification:
      required:
      - addedItem
      type: object
      properties:
        addedItem:
          $ref: '#/components/schemas/Item'
          description: The customer item added to the order. Include any modifiers on this item via its modifiers array.
    CustomerItemModification:
      type: object
      description: One modification to apply. Exactly one of quantityUpdated, priceAdjusted, or itemAdded must be set.
      properties:
        quantityUpdated:
          $ref: '#/components/schemas/QuantityUpdatedModification'
          description: Change quantity for existing item(s). Set quantity to 0 to remove.
        priceAdjusted:
          $ref: '#/components/schemas/OrderPriceAdjustedModification'
          description: Adjust order subtotal (positive = up charge, negative = refund).
        itemAdded:
          $ref: '#/components/schemas/ItemAddedModification'
          description: Add a new item to the order.
      oneOf:
      - required:
        - quantityUpdated
      - required:
        - priceAdjusted
      - required:
        - itemAdded
    PictureRequirement:
      type:
      - object
      - 'null'
      properties:
        enabled:
          type: boolean
          description: Marks the picture requirement as required.
          example: true
      description: Enables and configure the picture requirement.
    AccountType:
      type: string
      enum:
      - CHECKING
      - SAVINGS
      description: The type of ACH account.
      example: CHECKING
    CompositeFinanceLine:
      required:
      - breakdown
      type: object
      properties:
        breakdown:
          type: array
          minItems: 1
          description: Breakdown values for the finance line.
          items:
            $ref: '#/components/schemas/SimpleFinanceLine'
      description: composite finance line can represent a value, tax and VAT for a given line as a list of SimpleFinanceLine objects
    ManagerOrderIssue:
      required:
      - code
      type: object
      properties:
        code:
          type: string
          description: The specific issues with this item
          enum:
          - UNKNOWN
          - MENU_RES

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