Olo · Example Payload

Olo Promotions Validate Example

Food ServiceRestaurantsOnline OrderingDeliveryPoint of SaleHospitalityPaymentsLoyaltyMarketing

Olo Promotions Validate Example is an example object payload from Olo, with 20 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

orderIdaccountIdsourcehandoffcurrencyplacedwantedstoreNumberrestaurantbrandsubtotaltaxtipdeliverycustomFeesdiscounttotaladdresspaymentsbasket

Example Payload

{
  "orderId": null,
  "accountId": "044d8de0-0978-40f2-aab6-07aadea2a876",
  "source": "Other",
  "handoff": "Pickup",
  "currency": "USD",
  "placed": null,
  "wanted": null,
  "storeNumber": "193",
  "restaurant": "192498",
  "brand": "193",
  "subtotal": 15.00,
  "tax": 0.00,
  "tip": 0.00,
  "delivery": 0.00,
  "customFees": 0.0,
  "discount": 0.0,
  "total": 15.00,
  "address": null,
  "payments": null,
  "basket": {
    "id": "8521027f-1a81-4f53-afc6-e0c7e19f9ea5",
    "rewards": [
      {
        "provider": "Mock Promotions API",
        "id": "abcd1234",
        "level": "Basket",
        "product": null,
        "discount": 0.0
      }
    ],
    "coupons": [
      {
        "provider": null,
        "id": null,
        "level": "Basket",
        "product": null,
        "discount": 0.0
      }
    ],
    "entries": [
      {
        "quantity": 3,
        "item": {
          "product": "534035",
          "label": "Cheeseburger",
          "cost": 5.00
        }
      }
    ],
    "posEntries": [
      {
        "quantity": 3,
        "posItem": {
          "product": "51242557",
          "categories": [],
          "modifiers": [],
          "label": "Cheeseburger",
          "cost": 5.00
        }
      }
    ]
  }
}