There are situations where additional context is needed before a
price can be determined. For example, the price of a menu item that uses
time-specific pricing depends on the time the menu item is ordered. For
these situations, the menus API provides two values,
pricingStrategy and pricingRules, that contain
the information you need to calculate the menu item or modifier option's
price. These values appear for every menu item, modifier group, and
modifier option in the fully resolved JSON. Their contents change
depending on how a menu item or modifier option's price has been
configured.
You use the pricingStrategy and
pricingRules values to calculate prices for:
-
Menu items that use either the Time Specific Price or Size Price pricing strategy.
-
Modifier options that inherit their prices from a parent modifier group that uses the Size Price, Sequence Price, or Size/Sequence Price pricing strategy.
-
Modifier options that get their prices from modifier option item references that use the Time Specific Price or Size Price pricing strategy.
The pricingStrategy value tells you which pricing
strategy is in effect so that you can properly interpret the contents of
the pricingRules value and calculate the correct price.
Because they appear in multiple locations in the menu JSON, it is
important to use the correct pricingStrategy and
pricingRules values when calculating prices. The following
sections describe which pricingStrategy and
pricingRules values to use and how to interpret
them.
The following sections describe how to calculate time-specific
and size prices for a menu item. When calculating the price for a menu
item, you use the pricingStrategy and
pricingRules values for that menu item.
|
Note |
|
For menu items that use the Base Price or Menu Specific Price
pricing strategy, no calculations are required. You retrieve the
price from the menu item's |
When a menu item is priced using the Time Specific Price
pricing strategy, its pricingStrategy value is
TIME_SPECIFIC_PRICE and its pricingRules
value contains the information you need to calculate the price of
the item at any given time. Inside the pricingRules
value, you see the timeSpecificPricingRules value which
contains an array of time-specific prices for the menu item.
In this use case, the pricingRules value also
contains the sizeSpecificPricingGuid and
sizeSequencePricingRules values, however, the
sizeSpecificPricingGuid is null and the
sizeSequencePricingRules array is empty because the
menu item uses a time-specific price, not a size price.
Sample JSON for a menu item that uses the Time Specific Price pricing strategy
{
"restaurantGuid": "2071fb81-988b-4d75-b8dc-c5c17cff9706",
...
"menus": [
{
"name": "Dinner",
"guid": "ddd681de-3c12-4d45-b8b1-a5b2ea898210",
...
"menuGroups": [
{
"name": "Pizza",
"guid": "dc868006-919a-4950-a4cc-3a03f9770fd7",
...
"menuItems": [
{
"name": "Cheese Pizza",
"guid": "6f54db28-557b-4070-b3da-58a52fa4a4fb",
...
"price": null,
"pricingStrategy": "TIME_SPECIFIC_PRICE",
"pricingRules": {
"timeSpecificPricingRules": [
{
"timeSpecificPrice": 8.0,
"basePrice": 10.0,
"schedule": [
{
"days": [
"MONDAY",
"TUESDAY",
"WEDNESDAY",
"THURSDAY",
"FRIDAY"
],
"timeRanges": [
{
"start": "12:00",
"end": "14:00"
}
]
}
]
},
{
"timeSpecificPrice": 9.0,
"basePrice": 10.0,
"schedule": [
{
"days": [
"SATURDAY",
"SUNDAY"
],
"timeRanges": [
{
"start": "12:00",
"end": "15:00"
}
]
}
]
}
],
"sizeSpecificPricingGuid": null,
"sizeSequencePricingRules": []
},
...
},
]
}
]
}
],
"modifierGroupReferences": {
...
},
"modifierOptionReferences": {
...
}
}|
The price of the Cheese Pizza menu item during the time
period defined by the |
|
|
The base price of the Cheese Pizza menu item ($10), used for time periods when a time-specific price has not been defined. |
|
|
The schedule for this time specific price, which defines the days and times the price applies. |
|
|
The days this time-specific price applies (Monday through Friday). |
|
|
The times this time-specific price applies (noon to 2pm), in the restaurant's local time. |
|
|
The configuration for another time-specific price for Saturday and Sunday. |
When a menu item is priced using the Size Price pricing
strategy, its pricingStrategy value is
SIZE_PRICE and its pricingRules value
contains the information you need to calculate the prices for
different sizes of the item. Inside the pricingRules
value, you see the sizeSpecificPricingGuid value, which
is populated with the GUID of the Size modifier group
that contains the sizes and prices for this menu item.
The Toast platform automatically creates a Size modifier group
when you choose the Size Price pricing strategy for a menu item. The
system stores the sizes and prices you specify in this modifier
group, using separate modifier options, one for each size. You use
the sizeSpecificPricingGuid value to locate the correct
Size modifier group to use when pricing a menu item that uses size
pricing. In the JSON fragment below, you can see that Cheese Pizza
menu item uses the SIZE_PRICE pricing strategy and the
Size modifier group where the sizes and prices for the Cheese Pizza
menu item are defined has a GUID ending in
31b0. The Size modifier group has two modifier options
that define two sizes for the Cheese Pizza menu item, Small and
Large, which cost $8 and $10, respectively.
In this use case, the timeSpecificPricingRules
array contained in the pricingRules value is empty
because the menu item uses a size price, not a time-specific price.
Also, the sizeSequencePricingRules array is empty
because because this array is used for modifier option pricing, not
menu item pricing.
Sample JSON for a menu item that uses the Size Price pricing strategy
{
"restaurantGuid": "2071fb81-988b-4d75-b8dc-c5c17cff9706",
...
"menus": [
{
"name": "Dinner",
"guid": "ddd681de-3c12-4d45-b8b1-a5b2ea898210",
...
"menuGroups": [
{
"name": "Pizza",
"guid": "dc868006-919a-4950-a4cc-3a03f9770fd7",
...
"menuItems": [
{
"name": "Cheese Pizza",
"guid": "95c5d500-8d92-46f2-bec4-fb2a42a46621",
...
"price": null,
"pricingStrategy": "SIZE_PRICE",
"pricingRules": {
"timeSpecificPricingRules": [],
"sizeSpecificPricingGuid": "23c02762-9d6a-4d3f-a298-71c989bf31b0",
"sizeSequencePricingRules": []
},
...
"modifierGroupReferences": [
2,
6,
...
],
...
}
]
}
]
}
],
"modifierGroupReferences": {
...
"2": {
"referenceId": 2,
"name": "Size",
"guid": "23c02762-9d6a-4d3f-a298-71c989bf31b0",
...
"pricingStrategy": "NONE",
"pricingRules": null,
...
"modifierOptionReferences": [
12,
13
],
...
},
...
},
"modifierOptionReferences": {
...
"12": {
"referenceId": 12,
"name": "Small",
"guid": "352244f2-a952-4a3a-a3ae-7775fa221ce7",
...
"price": 8.0,
"pricingStrategy": "BASE_PRICE",
"pricingRules": null,
...
"modifierGroupReferences": []
},
"13": {
"referenceId": 13,
"name": "Large",
"guid": "4ff89bca-b448-4892-bc4c-62c37a28ac44",
...
"price": 10.0,
"pricingStrategy": "BASE_PRICE",
"pricingRules": null,
...
"modifierGroupReferences": []
}
...
}
}|
The |
|
|
A reference to the Size modifier group in the
|
|
|
References to other, non-size related, modifier groups that modify the Cheese Pizza menu item. |
|
|
The Size modifier group for the Cheese Pizza menu item. |
|
|
References to the modifier options in the Size modifier group where the individual sizes and prices are defined. |
|
|
The Small modifier option, which defines the price of the Small size of the Cheese Pizza menu item. |
|
|
The price ($8) of the Small size of the Cheese Pizza menu item. This price is inherited from the Small modifier option's underlying item reference. |
|
|
The |
|
|
The |
|
|
The Large modifier option, which defines the price of the Large size of the Cheese Pizza menu item. |
Modifier options that are priced at the group level, using the
Size
Price, Sequence Price, or Size/Sequence Price pricing
strategy, require additional price calculation. You can determine if a
modifier option is priced this way by inspecting the modifier option's
price and pricingStrategy values. If the
pricingStrategy value is GROUP_PRICE, then
the modifier option has been priced at the group level. If the
modifier option's price value is null, it
means that the group price is one that cannot be resolved down to the
modifier option level and it requires additional calculation. This
indicates that the modifier group uses the Size Price, Sequence Price,
or Size/Sequence Price pricing strategy because those are the
group-level pricing strategies that require additional
calculation.
When calculating size pricing for a modifier option, the Toast platform determines which size of a menu item has been ordered and then it locates the coordinating size and price for the modifier option. For example, toppings on a small pizza are $1 while toppings on a large pizza are $2. This scenario requires that both the menu item and the modifier group are configured to use the Size Price pricing strategy.
In the example below, the Cheese Pizza menu item's
pricingStrategy is SIZE_PRICE and it has
two sizes defined, Small and Large, priced at $8 and $10
respectively (for information on size pricing for a menu item, see
Menu item with a size price). The Toppings modifier
group's pricingStrategy is also SIZE_PRICE
and its sizes and prices are defined in its own
pricingRules value.
Sample JSON for modifier options that inherit Size pricing from a parent modifier group
{
"restaurantGuid": "2071fb81-988b-4d75-b8dc-c5c17cff9706",
...
"menus": [
{
"name": "Dinner",
"guid": "ddd681de-3c12-4d45-b8b1-a5b2ea898210",
...
"menuGroups": [
{
"name": "Pizza",
"guid": "dc868006-919a-4950-a4cc-3a03f9770fd7",
...
"menuItems": [
{
"name": "Cheese Pizza",
"guid": "95c5d500-8d92-46f2-bec4-fb2a42a46621",
...
"price": null,
"pricingStrategy": "SIZE_PRICE",
"pricingRules": {
"timeSpecificPricingRules": [],
"sizeSpecificPricingGuid": "23c02762-9d6a-4d3f-a298-71c989bf31b0",
"sizeSequencePricingRules": []
},
...
"modifierGroupReferences": [
2,
3,
...
],
...
}
]
}
]
}
],
"modifierGroupReferences": {
...
"2": {
"referenceId": 2,
"name": "Size",
"guid": "23c02762-9d6a-4d3f-a298-71c989bf31b0",
...
"pricingStrategy": "NONE",
"pricingRules": null,
...
"modifierOptionReferences": [
12,
13
],
...
},
"3": {
"referenceId": 3,
"name": "Toppings",
"guid": "58b79986-f88f-411d-ba18-14b1e2441e9d",
...
"pricingStrategy": "SIZE_PRICE",
"pricingRules": {
"timeSpecificPricingRules": [],
"sizeSpecificPricingGuid": "23c02762-9d6a-4d3f-a298-71c989bf31b0",
"sizeSequencePricingRules": [
{
"sizeName": "Small",
(12)
"sizeGuid": "352244f2-a952-4a3a-a3ae-7775fa221ce7",
"sequencePrices": [
{
"sequence": 1,
"price": 2.0
}
]
},
{
"sizeName": "Large",(16)
"sizeGuid": "4ff89bca-b448-4892-bc4c-62c37a28ac44",(17)
"sequencePrices": [
{
"sequence": 1,
"price": 4.0(18)
}
]
}
]
},
...
"modifierOptionReferences": [
10,(19)
11(20)
],
...
},
...
},
"modifierOptionReferences": {
...
"10": {
"referenceId": 10,
"name": "Mushrooms",
"guid": "fa24fee9-76c4-40ba-ae3c-7dfccafdd8d3",
...
"price": null,
"pricingStrategy": "GROUP_PRICE",(21)
"pricingRules": null,
...
"modifierGroupReferences": []
},
"11": {
"referenceId": 11,
"name": "Onions",
"guid": "afee6be7-8280-4c69-a170-9fdf4c76bf7b",
...
"price": null,
"pricingStrategy": "GROUP_PRICE",
"pricingRules": null,
...
"modifierGroupReferences": []
},
"12": {
"referenceId": 12,
"name": "Small",(22)
"guid": "352244f2-a952-4a3a-a3ae-7775fa221ce7",
...
"price": 8.0,(23)
"pricingStrategy": "BASE_PRICE",
"pricingRules": null,
...
"modifierGroupReferences": []
},
"13": {
"referenceId": 13,
"name": "Large",(24)
"guid": "4ff89bca-b448-4892-bc4c-62c37a28ac44",
...
"price": 10.0,(25)
"pricingStrategy": "BASE_PRICE",
"pricingRules": null,
...
"modifierGroupReferences": []
},
...
}
}|
Indicates that the pricing strategy for the Cheese Pizza
menu item is |
|
|
The |
|
|
Reference to the Size modifier group in the
|
|
|
Reference to the Toppings modifier group. |
|
|
The Size modifier group that defines sizes and prices for the Cheese Pizza menu item. |
|
|
Prices are defined on the Small and Large modifier
options themselves, so the |
|
|
Reference to the Small modifier option for the Cheese Pizza menu item. |
|
|
Reference to the Large modifier option for the Cheese Pizza menu item. |
|
|
The Toppings modifier group. |
|
|
Indicates that the pricing strategy for the Toppings
modifier group is |
|
|
The |
|
|
An object that defines the price of toppings added to a Small cheese pizza. |
|
|
The |
|
|
The sequence value is always 1 for the
|
|
|
The price for a Small size of a topping ($2). |
|
|
An object that defines the price of toppings added to a Large cheese pizza. |
|
|
The |
|
|
The price for a Large size of a topping ($4). |
|
|
Reference to the Mushrooms modifier option. |
|
|
Reference to the Onions modifier option. |
|
|
|
|
|
The modifier option that defines the price of a Small cheese pizza. |
|
|
The price of a Small cheese pizza ($8). |
|
|
The modifier option that defines the price of a Large cheese pizza. |
|
|
The price of a Large cheese pizza ($10). |
When using sequence pricing, the cost of a modifier option depends on the order in which it is added to a menu item. For example, on a pizza menu item, the first topping is free, the second topping costs $1.00, the third topping costs $1.50, and all additional toppings cost $2.00. As modifier options are added to or removed from the menu item, the cost of the menu item is updated to reflect those choices.
Unlike the Size Price and Size/Sequence Price pricing strategies, the Sequence Price pricing strategy has no interaction with the pricing strategy of the menu item that a modifier option is applied to. In the example below, the Cheese Pizza menu item has two sizes, Small ($8) and Large ($10). The first topping added to either size costs $1, the second topping costs $2, and all additional toppings cost $2.50. So, a small Cheese Pizza with two toppings costs $11 while a large Cheese Pizza with two toppings costs $13.
Sample JSON for modifier options that inherit Sequence pricing from a parent modifier group
{
"restaurantGuid": "2071fb81-988b-4d75-b8dc-c5c17cff9706",
...
"menus": [
{
"name": "Dinner",
"guid": "ddd681de-3c12-4d45-b8b1-a5b2ea898210",
...
"menuGroups": [
{
"name": "Pizza",
"guid": "dc868006-919a-4950-a4cc-3a03f9770fd7",
...
"menuItems": [
{
"name": "Cheese Pizza",
"guid": "95c5d500-8d92-46f2-bec4-fb2a42a46621",
...
"price": null,
"pricingStrategy": "SIZE_PRICE",
"pricingRules": {
"timeSpecificPricingRules": [],
"sizeSpecificPricingGuid": "23c02762-9d6a-4d3f-a298-71c989bf31b0",
"sizeSequencePricingRules": []
},
...
"modifierGroupReferences": [
2,
4,
...
],
...
}
]
}
]
}
],
"modifierGroupReferences": {
...
"4": {
"referenceId": 4,
"name": "Toppings",
"guid": "2fb9889a-e3e9-4039-9bbd-99defb7f04b1",
...
"pricingStrategy": "SEQUENCE_PRICE",
"pricingRules": {
"timeSpecificPricingRules": [],
"sizeSpecificPricingGuid": null,
"sizeSequencePricingRules": [
{
"sizeName": null,
"sizeGuid": null,
"sequencePrices": [
{
"sequence": 1,
"price": 1.0
},
{
"sequence": 2,
"price": 2.0
},
{
"sequence": 3,
"price": 2.5
}
]
}
]
},
...
"modifierOptionReferences": [
14,
15
],
...
},
"2": {
"referenceId": 2,
"name": "Size",
"guid": "23c02762-9d6a-4d3f-a298-71c989bf31b0",
...
"pricingStrategy": "NONE",
"pricingRules": null,
...
"modifierOptionReferences": [
12,
13
],
...
},
},
"modifierOptionReferences": {
...
"14": {
"referenceId": 14,
"name": "Pepperoni",
"guid": "11adaad3-c391-42e8-a234-350a16e5a68d",
...
"price": null,
"pricingStrategy": "GROUP_PRICE",
"pricingRules": null,
...
"modifierGroupReferences": []
},
"15": {
"referenceId": 15,
"name": "Sausage",
"guid": "bd3a44ed-8362-49b8-8f6e-c899480137ff",
...
"price": null,
"pricingStrategy": "GROUP_PRICE",
"pricingRules": null,
...
"modifierGroupReferences": []
},
...
"12": {
"referenceId": 12,
"name": "Small",
"guid": "352244f2-a952-4a3a-a3ae-7775fa221ce7",
...
"price": 8.0,(16)
"pricingStrategy": "BASE_PRICE",
"pricingRules": null,
...
"modifierGroupReferences": []
},
"13": {
"referenceId": 13,
"name": "Large",
"guid": "4ff89bca-b448-4892-bc4c-62c37a28ac44",
...
"price": 10.0,(17)
"pricingStrategy": "BASE_PRICE",
"pricingRules": null,
...
"modifierGroupReferences": []
}
}
}|
Indicates that the pricing strategy for the Cheese Pizza
menu item is |
|
|
The |
|
|
Reference to the Size modifier group in the
|
|
|
Reference to the Toppings modifier group. |
|
|
The Toppings modifier group. |
|
|
Indicates that the pricing strategy for the Toppings
modifier group is |
|
|
The price of the first topping added to the Cheese Pizza menu item ($1). |
|
|
The price of the second topping added to the Cheese Pizza menu item ($2). |
|
|
The price of the third topping added to the Cheese Pizza menu item ($2.50). Because this is the last price in the sequence, it is also the price of any toppings added beyond the third. |
|
|
Reference to the Pepperoni modifier option. |
|
|
Reference to the Sausage modifier option. |
|
|
The Size modifier group that defines sizes for the Cheese Pizza menu item. |
|
|
Reference to the Small modifier option. |
|
|
Reference to the Large modifier option. |
|
|
|
|
|
A Small cheese pizza costs $8. |
|
|
A Large cheese pizza costs $10. |
With size/sequence pricing, the cost of a modifier option depends on the size of the menu item it is applied to and the order in which it is applied to the menu item. For example, the first topping on a small pizza is $0.50 and additional toppings are $1 while the first topping on a large pizza is $1.50 and additional toppings are $2.50. To configure size/sequence pricing, the menu item must use the Size Price pricing strategy and the modifier group must use the Size/Sequence Price pricing strategy.
In the example below, the Cheese Pizza menu item's
pricingStrategy is SIZE_PRICE and it has
two sizes defined, Small and Large, priced at $8 and $10
respectively (for information on size pricing for a menu item, see
Menu item with a size price). The Toppings modifier
group's pricingStrategy is
SIZE_SEQUENCE_PRICE and it defines that the first
topping on a small Cheese Pizza costs $1 while the second topping
costs $2. Likewise, the first topping on a large Cheese Pizza costs
$3 and the second topping costs $4.
Sample JSON for modifier options that inherit Size/Sequence pricing from a parent modifier group
{
"restaurantGuid": "2071fb81-988b-4d75-b8dc-c5c17cff9706",
...
"menus": [
{
"name": "Dinner",
"guid": "ddd681de-3c12-4d45-b8b1-a5b2ea898210",
...
"menuGroups": [
{
"name": "Pizza",
"guid": "dc868006-919a-4950-a4cc-3a03f9770fd7",
...
"menuItems": [
{
"name": "Cheese Pizza",
"guid": "95c5d500-8d92-46f2-bec4-fb2a42a46621",
...
"price": null,
"pricingStrategy": "SIZE_PRICE",
"pricingRules": {
"timeSpecificPricingRules": [],
"sizeSpecificPricingGuid": "23c02762-9d6a-4d3f-a298-71c989bf31b0",
"sizeSequencePricingRules": []
},
...
"modifierGroupReferences": [
2,
5,
...
],
...
}
]
}
]
}
],
"modifierGroupReferences": {
...
"2": {
"referenceId": 2,
"name": "Size",
"guid": "23c02762-9d6a-4d3f-a298-71c989bf31b0",
...
"pricingStrategy": "NONE",
"pricingRules": null,
...
"modifierOptionReferences": [
12,
13
],
...
},
"5": {
"referenceId": 5,
"name": "Toppings",
"guid": "e65dd350-5628-45fd-993d-8cf9c4f15a76",
...
"pricingStrategy": "SIZE_SEQUENCE_PRICE",
"pricingRules": {
"timeSpecificPricingRules": [],
"sizeSpecificPricingGuid": "23c02762-9d6a-4d3f-a298-71c989bf31b0",
"sizeSequencePricingRules": [
{
"sizeName": "Small",
"sizeGuid": "352244f2-a952-4a3a-a3ae-7775fa221ce7",
"sequencePrices": [
{
"sequence": 1,
"price": 1.0
},
{
"sequence": 2,
"price": 2.0
}
]
},
{
"sizeName": "Large",
"sizeGuid": "4ff89bca-b448-4892-bc4c-62c37a28ac44",
"sequencePrices": [
{
"sequence": 1,
"price": 3.0
},
{
"sequence": 2,
"price": 4.0
}
]
}
]
},
...
"modifierOptionReferences": [
16,(16)
17(17)
],
...
},
...
},
"modifierOptionReferences": {
...
"16": {
"referenceId": 16,
"name": "Olives",
"guid": "8d45403d-5393-4c19-9d11-1dd963df8a26",
...
"price": null,
"pricingStrategy": "GROUP_PRICE",(18)
"pricingRules": null,
...
"modifierGroupReferences": []
},
"17": {
"referenceId": 17,
"name": "Peppers",
"guid": "d4977c91-08d3-4060-a7bd-13e19a83e794",
...
"price": null,
"pricingStrategy": "GROUP_PRICE",
"pricingRules": null,
...
"modifierGroupReferences": []
},
"12": {
"referenceId": 12,
"name": "Small",(19)
"guid": "352244f2-a952-4a3a-a3ae-7775fa221ce7",
...
"price": 8.0,(20)
"pricingStrategy": "BASE_PRICE",
"pricingRules": null,
...
"modifierGroupReferences": []
},
"13": {
"referenceId": 13,
"name": "Large",
"guid": "4ff89bca-b448-4892-bc4c-62c37a28ac44",
...
"price": 10.0,
"pricingStrategy": "BASE_PRICE",
"pricingRules": null,
...
"modifierGroupReferences": []
}
}
}|
Indicates that the pricing strategy for the Cheese Pizza
menu item is |
|
|
The |
|
|
Reference to the Size modifier group in the
|
|
|
Reference to the Toppings modifier group. |
|
|
The Size modifier group that defines sizes and prices for the Cheese Pizza menu item. |
|
|
Prices are defined on the Small and Large modifier
options themselves, so the |
|
|
Reference to the Small modifier option for the Cheese Pizza menu item. |
|
|
Reference to the Large modifier option for the Cheese Pizza menu item. |
|
|
The Toppings modifier group. |
|
|
Indicates that the pricing strategy for the Toppings
modifier group is |
|
|
The |
|
|
An object that defines the price of toppings added to a Small cheese pizza. |
|
|
The |
|
|
The price of the first topping added to a Small cheese pizza ($1). |
|
|
The price of the second topping added to a Small cheese pizza ($2). Because this is the last price in the sequence, it is also the price of any toppings added beyond the second. |
|
|
Reference to the Olives modifier option. |
|
|
Reference to the Peppers modifier option. |
|
|
|
|
|
The modifier option that defines the price of a Small cheese pizza. |
|
|
The price of a Small cheese pizza ($8). |
This section describes the pricingRules and
pricingStrategy values when you have configured a
modifier option so that it uses the price of its underlying item
reference and that item reference uses the Time Specific Price
or Size Price pricing strategy.
The example below shows a modifier group, Toppings, whose
modifier options are individually priced. One of the modifier
options in the Toppings group, Goat Cheese, uses the
TIME_SPECIFIC_PRICE pricing strategy. When the Goat
Cheese modifier option is ordered between noon and 2pm, it costs $1.
During the rest of the day, it costs $2.
Sample JSON for a modifier option that inherits a Time Specific Price from its item reference
{
"restaurantGuid": "2071fb81-988b-4d75-b8dc-c5c17cff9706",
...
"menus": [
{
"name": "Dinner",
"guid": "ddd681de-3c12-4d45-b8b1-a5b2ea898210",
...
"menuGroups": [
{
"name": "Pizza",
"guid": "dc868006-919a-4950-a4cc-3a03f9770fd7",
...
"menuItems": [
{
"name": "Cheese Pizza",
"guid": "95c5d500-8d92-46f2-bec4-fb2a42a46621",
...
"price": null,
"pricingStrategy": "SIZE_PRICE",
"pricingRules": {
"timeSpecificPricingRules": [],
"sizeSpecificPricingGuid": "23c02762-9d6a-4d3f-a298-71c989bf31b0",
"sizeSequencePricingRules": []
},
...
"modifierGroupReferences": [
2,
6,
...
],
...
}
]
}
]
}
],
"modifierGroupReferences": {
"6": {
"referenceId": 6,
"name": "Toppings",
"guid": "a1778e92-7ce9-4b1e-867d-c1effd7478b8",
...
"pricingStrategy": "NONE",
"pricingRules": null,
...
"modifierOptionReferences": [
18,
...
],
...
},
"2": {
"referenceId": 2,
"name": "Size",
"guid": "23c02762-9d6a-4d3f-a298-71c989bf31b0",
...
"pricingStrategy": "NONE",
"pricingRules": null,
...
"modifierOptionReferences": [
12,
13
],
...
},
},
"modifierOptionReferences": {
"18": {
"referenceId": 18,
"name": "Goat Cheese",
"guid": "0ca19f15-184c-4b69-8049-cd50bf96c39e",
...
"price": null,
"pricingStrategy": "TIME_SPECIFIC_PRICE",
"pricingRules": {
"timeSpecificPricingRules": [
{
"timeSpecificPrice": 1.0,
"basePrice": 2.0,
"schedule": [
{
"days": [(16)
"MONDAY",
"TUESDAY",
"WEDNESDAY",
"THURSDAY",
"FRIDAY",
"SATURDAY",
"SUNDAY"
],
"timeRanges": [(17)
{
"start": "12:00",
"end": "14:00"
}
]
}
]
}
],
"sizeSpecificPricingGuid": null,
"sizeSequencePricingRules": []
},
...
},
"12": {
"referenceId": 12,
"name": "Small",(18)
"guid": "352244f2-a952-4a3a-a3ae-7775fa221ce7",
...
"price": 8.0,(19)
"pricingStrategy": "BASE_PRICE",
"pricingRules": null,
...
"modifierGroupReferences": []
},
"13": {
"referenceId": 13,
"name": "Large",
"guid": "4ff89bca-b448-4892-bc4c-62c37a28ac44",
...
"price": 10.0,
"pricingStrategy": "BASE_PRICE",
"pricingRules": null,
...
"modifierGroupReferences": []
}
}
}|
Indicates that the pricing strategy for the Cheese Pizza
menu item is |
|
|
The |
|
|
Reference to the Size modifier group in the
|
|
|
Reference to the Toppings modifier group. |
|
|
The Toppings modifier group. |
|
|
A price is defined on the Goat Cheese modifier option
itself, so the |
|
|
Reference to the Goat Cheese modifier option. |
|
|
The Size modifier group that defines sizes and prices for the Cheese Pizza menu item. |
|
|
Prices are defined on the Small and Large modifier
options themselves, so the |
|
|
Reference to the Small modifier option for the Cheese Pizza menu item. |
|
|
Reference to the Large modifier option for the Cheese Pizza menu item. |
|
|
Indicates that the pricing strategy for the Goat Cheese
modifier option is |
|
|
The price of the Goat Cheese modifier option during the time period defined by the schedule value ($1). |
|
|
The base price of the Goat Cheese modifier option ($2), used for time periods when a time-specific price has not been defined. |
|
|
The schedule for this time-specific price, which defines the days and times the price applies. |
|
|
The days this time-specific price applies (Monday through Sunday). |
|
|
The times this time-specific price applies (noon to 2pm), in the restaurant's local time. |
|
|
The modifier option that defines the price of a Small cheese pizza. |
|
|
The price of a Small cheese pizza ($8). |
The example below shows a modifier group, Toppings, whose
modifier options are individually priced. One of the modifier
options in the Toppings group, Tomatoes, uses the
SIZE_PRICE pricing strategy. Two sizes and prices are
defined for Tomatoes, Small for $1.50 and Large for $3.50.
Sample JSON for a modifier option that inherits a Size Price from its item reference
{
"restaurantGuid": "2071fb81-988b-4d75-b8dc-c5c17cff9706",
...
"menus": [
{
"name": "Dinner",
"guid": "ddd681de-3c12-4d45-b8b1-a5b2ea898210",
...
"menuGroups": [
{
"name": "Pizza",
"guid": "dc868006-919a-4950-a4cc-3a03f9770fd7",
...
"menuItems": [
{
"name": "Cheese Pizza",
"guid": "95c5d500-8d92-46f2-bec4-fb2a42a46621",
...
"price": null,
"pricingStrategy": "SIZE_PRICE",
"pricingRules": {
"timeSpecificPricingRules": [],
"sizeSpecificPricingGuid": "23c02762-9d6a-4d3f-a298-71c989bf31b0",
"sizeSequencePricingRules": []
},
...
"modifierGroupReferences": [
2,
6,
...
],
...
}
]
}
]
}
],
"modifierGroupReferences": {
"7": {
"referenceId": 7,
"name": "Size",
"guid": "1517b7a4-612f-4447-ab93-46b989f01b6b",
...
"pricingStrategy": "NONE",
"pricingRules": null,
...
"modifierOptionReferences": [
20,
21
],
...
},
"6": {
"referenceId": 6,
"name": "Toppings",
"guid": "a1778e92-7ce9-4b1e-867d-c1effd7478b8",
...
"pricingStrategy": "NONE",
"pricingRules": null,
...
"modifierOptionReferences": [
19,
...
],
...
},
"2": {
"referenceId": 2,
"name": "Size",
"guid": "23c02762-9d6a-4d3f-a298-71c989bf31b0",
...
"pricingStrategy": "NONE",
"pricingRules": null,
...
"modifierOptionReferences": [
12,
13
],
...
},
"modifierOptionReferences": {
"19": {
"referenceId": 19,
"name": "Tomatoes",
"guid": "b53cb945-d790-4386-88b5-c29b4f72141f",
...
"price": null,
"pricingStrategy": "SIZE_PRICE",
"pricingRules": {
"timeSpecificPricingRules": [],
"sizeSpecificPricingGuid": "1517b7a4-612f-4447-ab93-46b989f01b6b",
"sizeSequencePricingRules": []
},
...
"modifierGroupReferences": [
7(16)
]
},
"20": {
"referenceId": 20,
"name": "Small",(17)
"guid": "e5c9883b-5c15-4771-9efa-0a63b9124484",
...
"price": 1.5,
"pricingStrategy": "BASE_PRICE",
"pricingRules": null,
...
"modifierGroupReferences": []
},
"21": {
"referenceId": 21,
"name": "Large",(18)
"guid": "269cbff6-2e90-4ef8-8a83-ea5a76fb7199",
...
"price": 3.5,
"pricingStrategy": "BASE_PRICE",
"pricingRules": null,
...
"modifierGroupReferences": []
},
"12": {
"referenceId": 12,
"name": "Small",(19)
"guid": "352244f2-a952-4a3a-a3ae-7775fa221ce7",
...
"price": 8.0,
"pricingStrategy": "BASE_PRICE",
"pricingRules": null,
...
"modifierGroupReferences": []
},
"13": {
"referenceId": 13,
"name": "Large",(20)
"guid": "4ff89bca-b448-4892-bc4c-62c37a28ac44",
...
"price": 10.0,
"pricingStrategy": "BASE_PRICE",
"pricingRules": null,
...
"modifierGroupReferences": []
}
}
}|
Indicates that the pricing strategy for the Cheese Pizza
menu item is |
|
|
The |
|
|
Reference to the Size modifier group in the
|
|
|
Reference to the Toppings modifier group. |
|
|
The Size modifier group that defines sizes and prices for the Tomatoes modifier option. |
|
|
Reference to the Small modifier option for the Tomatoes modifier option. |
|
|
Reference to the Large modifier option for the Tomatoes modifier option. |
|
|
Prices are defined on the modifier options themselves,
so the |
|
|
Reference to the Tomatoes modifier option. |
|
|
The Size modifier group that defines sizes and prices for the Cheese Pizza menu item. |
|
|
Reference to the Small modifier option for the Cheese Pizza menu item. |
|
|
Reference to the Large modifier option for the Cheese Pizza menu item. |
|
|
The Tomatoes modifier option. |
|
|
Indicates that the pricing strategy for the Tomatoes
modifier option is |
|
|
The |
|
|
Reference to the Size modifier group that defines sizes
and prices for the Tomatoes modifier option. This is the same
modifier group whose |
|
|
The modifier option that defines the price of the Tomatoes modifier option when it is applied to a Small cheese pizza. |
|
|
The modifier option that defines the price of the Tomatoes modifier option when it is applied to a Large cheese pizza. |
|
|
The modifier option that defines the price of a Small cheese pizza. |
|
|
The modifier option that defines the price of a Large cheese pizza. |