Otter · Schema

OrderCustomerPaymentUpdateRequest

The request to update customer payment for an order.

RestaurantOrder ManagementDeliveryOnline OrderingMenu ManagementAnalytics

Properties

Name Type Description
currencyCode string The 3-letter currency code (ISO 4217) to use for all monetary values in this order.
customerPayment array The requested customer payment to transition the order to.
orderTotal object
orderTotalsV2 object
View JSON Schema on GitHub

JSON Schema

public-api-order-customer-payment-update-request-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "OrderCustomerPaymentUpdateRequest",
  "description": "The request to update customer payment for an order.",
  "$id": "https://raw.githubusercontent.com/api-evangelist/otter/refs/heads/main/json-schema/public-api-order-customer-payment-update-request-schema.json",
  "type": "object",
  "properties": {
    "currencyCode": {
      "maxLength": 3,
      "minLength": 3,
      "type": "string",
      "description": "The 3-letter currency code (ISO 4217) to use for all monetary values in this order.",
      "example": "EUR"
    },
    "customerPayment": {
      "type": "array",
      "description": "The requested customer payment to transition the order to.",
      "items": {
        "$ref": "https://raw.githubusercontent.com/api-evangelist/otter/refs/heads/main/json-schema/public-api-customer-payment-schema.json"
      }
    },
    "orderTotal": {
      "nullable": true,
      "$ref": "https://raw.githubusercontent.com/api-evangelist/otter/refs/heads/main/json-schema/public-api-order-total-schema.json"
    },
    "orderTotalsV2": {
      "nullable": true,
      "$ref": "https://raw.githubusercontent.com/api-evangelist/otter/refs/heads/main/json-schema/public-api-order-total-v2-schema.json"
    }
  },
  "required": [
    "currencyCode",
    "customerPayment"
  ]
}