Otter · Schema

OrderTotal

Details about values of the order.

RestaurantOrder ManagementDeliveryOnline OrderingMenu ManagementAnalytics

Properties

Name	Type	Description
subtotal	number	The order's subtotal, as the sum of all item and modifier prices.
claimedSubtotal	number	The order's claimed subtotal, without guaranteeing this will match calculated subtotal.
discount	number	Any discount amount for the order.
tax	number	Tax paid by the customer.
tip	number	Tip paid by the customer.
deliveryFee	number	Delivery fee.
total	number	Order total including everything paid by the customer.
couponCode	string	Coupon code applied to the order.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "OrderTotal",
  "description": "Details about values of the order.",
  "$id": "https://raw.githubusercontent.com/api-evangelist/otter/refs/heads/main/json-schema/public-api-order-total-schema.json",
  "type": "object",
  "properties": {
    "subtotal": {
      "type": "number",
      "description": "The order's subtotal, as the sum of all item and modifier prices.",
      "example": 11.97
    },
    "claimedSubtotal": {
      "type": "number",
      "nullable": true,
      "description": "The order's claimed subtotal, without guaranteeing this will match calculated subtotal.",
      "example": 1.0
    },
    "discount": {
      "type": "number",
      "nullable": true,
      "description": "Any discount amount for the order.",
      "example": 1
    },
    "tax": {
      "type": "number",
      "nullable": true,
      "description": "Tax paid by the customer.",
      "example": 1.1
    },
    "tip": {
      "type": "number",
      "nullable": true,
      "description": "Tip paid by the customer.",
      "example": 2
    },
    "deliveryFee": {
      "type": "number",
      "nullable": true,
      "description": "Delivery fee.",
      "example": 5
    },
    "total": {
      "type": "number",
      "nullable": true,
      "description": "Order total including everything paid by the customer.",
      "example": 19.07
    },
    "couponCode": {
      "type": "string",
      "nullable": true,
      "description": "Coupon code applied to the order.",
      "example": "VWXYZ98765"
    }
  },
  "required": [
    "subtotal"
  ]
}