CloudKitchens Orders Endpoints API

openapi: 3.2.0
info:
  title: Public Orders 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: orders_endpoints
  description: 'Endpoints used by ordering marketplaces and other order sources to send orders to a store and keep them up to date.


    This domain lets an order source submit new orders as customers place them, reflect later changes as the orders progress, and backfill historical orders for reporting.'
  x-displayName: Orders
paths:
  /v1/orders:
    post:
      tags:
      - orders_endpoints
      summary: Create order
      description: '`RATE LIMIT: 32 per minute`


        Pushes a new order into Otter for the store identified by the `X-Store-Id` header. Used by ordering marketplaces and other order sources when a customer places an order.


        Provide the order''s line items, fulfillment information, customer payments, and exactly one financial breakdown — `orderTotal` (V1) or `orderTotalV2` (V2). New integrations should prefer `orderTotalV2`. All monetary values use the major unit of the order''s `currencyCode`.


        The response returns the order reference (Otter `id`, `friendlyId`, and `storeId`) you can use to correlate and update the order later.

        '
      operationId: createOrder
      parameters:
      - $ref: '#/components/parameters/storeIdHeader'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Order'
        required: true
      responses:
        '200':
          description: The order was successfully created.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrderReference'
        '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.create
  /v1/orders/{orderId}:
    put:
      tags:
      - orders_endpoints
      summary: Update order
      description: '`RATE LIMIT: 32 per minute`


        Replaces the order identified by `orderId` with the full order payload provided in the request body. Send the complete order representation (the same shape used to create it), not a partial patch.


        To change only the status, customer payment, or delivery information, prefer the dedicated `/status`, `/payments`, and `/delivery` endpoints. Returns 404 if no order matches the given `orderId` for this store.

        '
      operationId: updateOrder
      parameters:
      - $ref: '#/components/parameters/storeIdHeader'
      - $ref: '#/components/parameters/orderId'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Order'
        required: true
      responses:
        '200':
          description: The order was successfully updated.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrderReference'
        '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
  /v1/orders/{orderId}/status:
    post:
      tags:
      - orders_endpoints
      summary: Update order status
      description: '`RATE LIMIT: 32 per minute`


        Transitions the order identified by `orderId` to a new status. Only `PREPARED`, `CANCELED`, and `FULFILLED` are accepted by this endpoint.


        When transitioning to `CANCELED`, you may include the optional `X-Event-Id` header to acknowledge a cancellation that the platform requested via the intent-to-cancel webhook. The order lifecycle is asynchronous, so a successful call returns `202 Accepted`.

        '
      operationId: updateOrderStatus
      parameters:
      - $ref: '#/components/parameters/storeIdHeader'
      - $ref: '#/components/parameters/eventIdOptionalHeader'
      - $ref: '#/components/parameters/orderId'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OrderStatusUpdateRequest'
        required: true
      responses:
        '202':
          description: The order status 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
  /v1/orders/{orderId}/payments:
    put:
      tags:
      - orders_endpoints
      summary: Update order customer payment
      description: '`RATE LIMIT: 8 per minute`


        Updates the customer payment and financial breakdown for the order identified by `orderId`.


        This is a **merge, not a full replace**: each field is overwritten only when the request supplies a non-null value for it. Fields sent as `null` (or omitted) keep their existing value. Provide the financial breakdown via `orderTotal` (V1) or `orderTotalsV2` (V2); when V2 is sent it is validated for consistency with the V1 aggregates. The update is processed asynchronously and returns `202 Accepted`.

        '
      operationId: updateOrderCustomerPayment
      parameters:
      - $ref: '#/components/parameters/storeIdHeader'
      - $ref: '#/components/parameters/orderId'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OrderCustomerPaymentUpdateRequest'
        required: true
      responses:
        '202':
          description: The order payment update 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
  /v1/orders/{orderId}/delivery:
    put:
      tags:
      - orders_endpoints
      summary: Update order delivery information
      description: '`RATE LIMIT: 8 per minute`


        Updates the delivery information for the order identified by `orderId` — courier details, destination address, vehicle, last known location, and dropoff instructions. Use it to keep delivery state current as the courier progresses. The update is processed asynchronously and returns `202 Accepted`.

        '
      operationId: updateOrderDeliveryInfo
      parameters:
      - $ref: '#/components/parameters/storeIdHeader'
      - $ref: '#/components/parameters/orderId'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OrderDeliveryInfoUpdateRequest'
        required: true
      responses:
        '202':
          description: The order delivery information 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
  /v1/orders/past-orders:
    post:
      tags:
      - orders_endpoints
      summary: Upload past orders
      description: '`RATE LIMIT: 32 per minute`; orders must have a status of FULFILLED, REJECTED, or CANCELED.


        Backfills already-completed orders for reporting and analytics. Uploaded orders are stored as **read-only** and are **not displayed** in operational views — they exist purely to make historical data available to BI and reporting tools. Up to 100 orders can be uploaded per request.

        '
      operationId: uploadPastOrders
      parameters:
      - $ref: '#/components/parameters/storeIdHeader'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UploadPastOrdersRequest'
        required: true
      responses:
        '200':
          description: The orders was successfully uploaded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UploadPastOrdersResponse'
        '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.create
components:
  schemas:
    OrderReference:
      required:
      - externalIdentifiers
      - storeId
      type: object
      properties:
        externalIdentifiers:
          $ref: '#/components/schemas/OrderExternalIdentifiers'
        storeId:
          type: string
          description: The identifier of the store.
          example: ckdss-store-id
      description: An order reference.
    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`.'
    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`.
    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
    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
    CardBrandType:
      type: string
      enum:
      - UNKNOWN
      - AMEX
      - DINERS_CLUB
      - DISCOVER
      - JCB
      - MASTERCARD
      - UNION_PAY
      - VISA
      - GIROCARD
      - EFTPOS_AU
      - INTERAC
      description: The brand of the card.
      example: VISA
    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
    SimpleFinanceLine:
      required:
      - subType
      - name
      - value
      type: object
      properties:
        subType:
          type: string
          enum:
          - VALUE
          - TAX
          - VALUE_WITH_TAX
          - VAT
          description: type of the finance line.
        name:
          type: string
          description: name of the finance line.
          example: sales tax.
        value:
          type: number
          description: money amount.
          example: 3.4
      description: simple finance line.
    ErrorDetail:
      type: object
      properties:
        attribute:
          type: string
          description: The error attribute.
          example: Order Currency Code
        message:
          type: string
          description: The error detail description.
          example: Order Currency Code must be exactly 3 characters
      description: The error detail response object.
    ItemModifier:
      required:
      - quantity
      type: object
      properties:
        quantity:
          minimum: 1
          maximum: 1000
          type: integer
          description: The number of times the modifier was applied to the given item.
          format: int32
          example: 1
        skuPrice:
          type:
          - number
          - 'null'
          description: The stored sku price of this item
          readOnly: true
          example: 1
        id:
          type:
          - string
          - 'null'
          description: The unique ID of the modifier product.
          example: d7a21692-9195-43aa-a58f-5395bba8a804
        lineItemId:
          type:
          - string
          - 'null'
          description: The unique ID of the instance of a modifier in an order. Instances of the same modifier across different orders will have different line item IDs. Multiple instances of the same modifier in one order will have different line item IDs if their modifiers are different.
          readOnly: true
          example: 2f91f9f3-2d7e-4898-ae81-00fe06ed7dbf
        skuId:
          type:
          - string
          - 'null'
          description: sku ID of the item.
          example: 867b8fdc-cf7b-4fc3-b7e0-4c7b68d8b1cc
        name:
          type:
          - string
          - 'null'
          description: The name of the modifier as displayed to the customer.
          example: Avocado
        price:
          type:
          - number
          - 'null'
          description: The unit price of the modifier (the price for a single application of the modifier, **not** multiplied by `quantity`), in the major unit of the order's `currencyCode`.
          example: 1
        groupName:
          type:
          - string
          - 'null'
          description: The parent group of the modifier item
          example: Add ons
        groupId:
          type:
          - string
          - 'null'
          description: The unique ID of the parent group
          example: fb52b138-7ac4-42c1-bfd8-664d57113a41
        stationId:
          type:
          - string
          - 'null'
          description: The ID of the station the modifier item is assigned to.
          readOnly: true
          example: a49cbd3e-94e2-462d-a6de-1985e5d98d1c
        modifiers:
          type:
          - array
          - 'null'
          description: Nested modifiers applied to the item.
          maxItems: 100
          items:
            $ref: '#/components/schemas/ItemModifier'
    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
        sourceExternalIdentifiers:
          $ref: '#/components/schemas/SourceExternalIdentifiers'
      description: The external identifiers.
    MandateStatus:
      type: string
      enum:
      - ACTIVE
      - INACTIVE
      - PENDING
      description: The status of the mandate.
      example: ACTIVE
    ErrorMessage:
      type: object
      properties:
        message:
          type: string
          description: The error description.
          example: The request body is invalid.
        details:
          type: array
          description: The error details.
          items:
            $ref: '#/components/schemas/ErrorDetail'
      description: The error response object.
    PaymentDetailsCard:
      type: object
      description: Details of a card payment method.
      properties:
        brandType:
          $ref: '#/components/schemas/CardBrandType'
        expiration:
          type: object
          properties:
            year:
              type: integer
              description: The expiration year of the card.
              example: 2025
            month:
              type: integer
              description: The expiration month of the card.
              example: 12
        fundingType:
          $ref: '#/components/schemas/CardFundingType'
        walletType:
          $ref: '#/components/schemas/CardWalletType'
        lastFour:
          type: string
          description: The last four digits of the card.
          example: '1234'
        walletLastFour:
          type: string
          description: The last four digits of the wallet account.
          example: '5678'
        authorizationCode:
          type: string
          description: The authorization code for the card.
          example: auth_code_123
        applicationPreferredName:
          type: string
          description: The preferred name of the application.
          example: MyApp
        fingerprint:
          type: string
          description: The fingerprint of the card.
          example: fingerprint_abc123
        readMethod:
          type: string
          description: The method used to read the card.
          example: chip
    PaymentDetailsBacs:
      type: object
      description: Details of a BACS payment method in the UK.
      properties:
        mandateStatus:
          $ref: '#/components/schemas/MandateStatus'
        lastFour:
          type: string
          description: The last four digits of the BACS account.
          example: '9876'
        sortCode:
          type: string
          description: The sort code of the BACS account.
          example: 12-34-56
        mandateId:
          type: string
          description: The mandate ID for the BACS account.
          example: mandate_123
        reference:
          type: string
          description: The reference for the BACS payment.
          example: reference_abc
        url:
          type: string
          description: The URL for the BACS payment details.
          example: http://example.com/bacs
    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
    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 

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