Otter · Schema

OrderTotalV2

V2 for details about values of the order, provides richer objects allowing to capture taxes, misc charges, payments more precisely.

RestaurantOrder ManagementDeliveryOnline OrderingMenu ManagementAnalytics

Properties

Name Type Description
customerTotal object
customerPayment object The customer perspective, each price field in this model is meant to represent the values the customer paid/received and how. Values must match amounts and payment methods described in customerPayment
payout object Breakdown of net payout received by the store. Optional object, should be provided when payout information is available during the order lifecycle.
View JSON Schema on GitHub

JSON Schema

public-api-order-total-v2-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "OrderTotalV2",
  "description": "V2 for details about values of the order, provides richer objects allowing to capture taxes, misc charges, payments more precisely.",
  "$id": "https://raw.githubusercontent.com/api-evangelist/otter/refs/heads/main/json-schema/public-api-order-total-v2-schema.json",
  "type": "object",
  "properties": {
    "customerTotal": {
      "nullable": false,
      "allOf": [
        {
          "$ref": "https://raw.githubusercontent.com/api-evangelist/otter/refs/heads/main/json-schema/public-api-financial-data-schema.json"
        }
      ]
    },
    "customerPayment": {
      "nullable": true,
      "description": "The customer perspective, each price field in this model is meant to represent the values the customer paid/received and how. Values must match amounts and payment methods described in customerPayments.",
      "allOf": [
        {
          "$ref": "https://raw.githubusercontent.com/api-evangelist/otter/refs/heads/main/json-schema/public-api-customer-payment-v2-schema.json"
        }
      ]
    },
    "payout": {
      "nullable": true,
      "description": "Breakdown of net payout received by the store. Optional object, should be provided when payout information is available during the order lifecycle.",
      "allOf": [
        {
          "$ref": "https://raw.githubusercontent.com/api-evangelist/otter/refs/heads/main/json-schema/public-api-payout-schema.json"
        }
      ]
    }
  },
  "required": [
    "customerTotal"
  ]
}