GET v1/Customers/{customerId}/FavoriteItems
URI template
v1/Customers/{customerId}/FavoriteItems?siteId={siteId}&menuId={menuId}&promiseTime={promiseTime}Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
customerId |
The id of the customer |
globally unique identifier |
Required |
siteId |
The site id that favorite items should be checked against |
integer |
Default value is 0 |
menuId |
The menu id that favorite items should be checked against |
integer |
Default value is 0 |
promiseTime |
The promise time that favorite items should be checked against. Don't specify any time zone. Example: Time in restaurant is 10:35AM AEST. The same time is applied as promise time. Value of promiseTime parameter should be “2016-06-16T10:35:00”. |
date |
None. |
Body Parameters
None.
Response Information
Resource Description
A list of favorite items for the customer. Known internal errors are NotAcceptable, CustomerNotFound and BadRequest
GetFavoriteItemsResultName | Description | Type | Additional information |
---|---|---|---|
FavoriteItems |
List of favorite items for the customer |
Collection of FavoriteItem |
None. |
FavoriteComboItems |
List of favorite combos for the customer |
Collection of FavoriteComboItem |
None. |
MenuCheckResult |
Result of checking favorite items against site, menu id and promisetime if provided, NotProcessed as default |
integer |
None. |
Response Formats
application/json, text/json
{ "FavoriteItems": [ { "$id": "2", "FavoriteItemId": 1, "FavoriteItemName": "sample string 2", "ItemName": "sample string 3", "ItemLineNumber": 4, "SalesItemId": 5, "MenuItemId": 6, "SpecialInstructions": "sample string 7", "ShortDescription": "sample string 8", "RecipientName": "sample string 9", "NextModifierSequenceNumber": 10, "ItemOrderingMode": 0, "UnitPrice": 11.0, "ExtendedPrice": 12.0, "Status": 0, "Section1Type": 0, "Section2Type": 0, "Section3Type": 0, "Section4Type": 0, "Available": true, "Modifiers": [ { "$id": "3", "Name": "sample string 14", "UnitPrice": 15.0, "ExtendedPrice": 16.0, "SequenceNumber": 17, "ItemOptionGroupId": 18, "SalesItemOptionId": 19, "Action": 0, "DefaultAction": 0, "ItemLineNumber": 20, "ParentSequenceNumber": 21, "Quantity": 22, "IsOnEntireItem": true, "IsOnSection1": true, "IsOnSection2": true, "IsOnSection3": true, "IsOnSection4": true, "FreeQuantity": 28, "Modifiers": null, "Status": 0 }, { "$id": "4", "Name": "sample string 29", "UnitPrice": 30.0, "ExtendedPrice": 31.0, "SequenceNumber": 32, "ItemOptionGroupId": 33, "SalesItemOptionId": 34, "Action": 0, "DefaultAction": 0, "ItemLineNumber": 35, "ParentSequenceNumber": 36, "Quantity": 37, "IsOnEntireItem": true, "IsOnSection1": true, "IsOnSection2": true, "IsOnSection3": true, "IsOnSection4": true, "FreeQuantity": 43, "Modifiers": null, "Status": 0 } ] }, { "$id": "5", "FavoriteItemId": 44, "FavoriteItemName": "sample string 45", "ItemName": "sample string 46", "ItemLineNumber": 47, "SalesItemId": 48, "MenuItemId": 49, "SpecialInstructions": "sample string 50", "ShortDescription": "sample string 51", "RecipientName": "sample string 52", "NextModifierSequenceNumber": 53, "ItemOrderingMode": 0, "UnitPrice": 54.0, "ExtendedPrice": 55.0, "Status": 0, "Section1Type": 0, "Section2Type": 0, "Section3Type": 0, "Section4Type": 0, "Available": true, "Modifiers": [ { "$id": "6", "Name": "sample string 57", "UnitPrice": 58.0, "ExtendedPrice": 59.0, "SequenceNumber": 60, "ItemOptionGroupId": 61, "SalesItemOptionId": 62, "Action": 0, "DefaultAction": 0, "ItemLineNumber": 63, "ParentSequenceNumber": 64, "Quantity": 65, "IsOnEntireItem": true, "IsOnSection1": true, "IsOnSection2": true, "IsOnSection3": true, "IsOnSection4": true, "FreeQuantity": 71, "Modifiers": null, "Status": 0 }, { "$id": "7", "Name": "sample string 72", "UnitPrice": 73.0, "ExtendedPrice": 74.0, "SequenceNumber": 75, "ItemOptionGroupId": 76, "SalesItemOptionId": 77, "Action": 0, "DefaultAction": 0, "ItemLineNumber": 78, "ParentSequenceNumber": 79, "Quantity": 80, "IsOnEntireItem": true, "IsOnSection1": true, "IsOnSection2": true, "IsOnSection3": true, "IsOnSection4": true, "FreeQuantity": 86, "Modifiers": null, "Status": 0 } ] } ], "FavoriteComboItems": [ { "$id": "8", "DesignId": 87, "GroupLineId": 88, "PromoId": 89, "PromoType": 0, "Price": 90.0, "WebSalesGroupItems": [ { "$id": "9", "FavoriteItemId": 91, "FavoriteWebSalesGroupName": "sample string 92", "GroupLineId": 93, "WebSalesGroupId": 94, "MenuItemName": "sample string 95", "PromoId": 96, "PromoType": 97, "PromoPrice": 98.0 }, { "$id": "10", "FavoriteItemId": 99, "FavoriteWebSalesGroupName": "sample string 100", "GroupLineId": 101, "WebSalesGroupId": 102, "MenuItemName": "sample string 103", "PromoId": 104, "PromoType": 105, "PromoPrice": 106.0 } ] }, { "$id": "11", "DesignId": 107, "GroupLineId": 108, "PromoId": 109, "PromoType": 0, "Price": 110.0, "WebSalesGroupItems": [ { "$id": "12", "FavoriteItemId": 111, "FavoriteWebSalesGroupName": "sample string 112", "GroupLineId": 113, "WebSalesGroupId": 114, "MenuItemName": "sample string 115", "PromoId": 116, "PromoType": 117, "PromoPrice": 118.0 }, { "$id": "13", "FavoriteItemId": 119, "FavoriteWebSalesGroupName": "sample string 120", "GroupLineId": 121, "WebSalesGroupId": 122, "MenuItemName": "sample string 123", "PromoId": 124, "PromoType": 125, "PromoPrice": 126.0 } ] } ], "MenuCheckResult": 127 }
application/xml, text/xml
<GetFavoriteItemsResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OnlineOrderingAPI.Models.v1.Response"> <FavoriteComboItems xmlns:d2p1="http://schemas.datacontract.org/2004/07/OnlineOrderingAPI.Models.v1"> <d2p1:FavoriteComboItem> <d2p1:DesignId>87</d2p1:DesignId> <d2p1:GroupLineId>88</d2p1:GroupLineId> <d2p1:Price>90</d2p1:Price> <d2p1:PromoId>89</d2p1:PromoId> <d2p1:PromoType>Unknown</d2p1:PromoType> <d2p1:WebSalesGroupItems> <d2p1:FavoriteWebSalesGroupItem> <d2p1:FavoriteItemId>91</d2p1:FavoriteItemId> <d2p1:FavoriteWebSalesGroupName>sample string 92</d2p1:FavoriteWebSalesGroupName> <d2p1:GroupLineId>93</d2p1:GroupLineId> <d2p1:MenuItemName>sample string 95</d2p1:MenuItemName> <d2p1:PromoId>96</d2p1:PromoId> <d2p1:PromoPrice>98</d2p1:PromoPrice> <d2p1:PromoType>97</d2p1:PromoType> <d2p1:WebSalesGroupId>94</d2p1:WebSalesGroupId> </d2p1:FavoriteWebSalesGroupItem> <d2p1:FavoriteWebSalesGroupItem> <d2p1:FavoriteItemId>99</d2p1:FavoriteItemId> <d2p1:FavoriteWebSalesGroupName>sample string 100</d2p1:FavoriteWebSalesGroupName> <d2p1:GroupLineId>101</d2p1:GroupLineId> <d2p1:MenuItemName>sample string 103</d2p1:MenuItemName> <d2p1:PromoId>104</d2p1:PromoId> <d2p1:PromoPrice>106</d2p1:PromoPrice> <d2p1:PromoType>105</d2p1:PromoType> <d2p1:WebSalesGroupId>102</d2p1:WebSalesGroupId> </d2p1:FavoriteWebSalesGroupItem> </d2p1:WebSalesGroupItems> </d2p1:FavoriteComboItem> <d2p1:FavoriteComboItem> <d2p1:DesignId>107</d2p1:DesignId> <d2p1:GroupLineId>108</d2p1:GroupLineId> <d2p1:Price>110</d2p1:Price> <d2p1:PromoId>109</d2p1:PromoId> <d2p1:PromoType>Unknown</d2p1:PromoType> <d2p1:WebSalesGroupItems> <d2p1:FavoriteWebSalesGroupItem> <d2p1:FavoriteItemId>111</d2p1:FavoriteItemId> <d2p1:FavoriteWebSalesGroupName>sample string 112</d2p1:FavoriteWebSalesGroupName> <d2p1:GroupLineId>113</d2p1:GroupLineId> <d2p1:MenuItemName>sample string 115</d2p1:MenuItemName> <d2p1:PromoId>116</d2p1:PromoId> <d2p1:PromoPrice>118</d2p1:PromoPrice> <d2p1:PromoType>117</d2p1:PromoType> <d2p1:WebSalesGroupId>114</d2p1:WebSalesGroupId> </d2p1:FavoriteWebSalesGroupItem> <d2p1:FavoriteWebSalesGroupItem> <d2p1:FavoriteItemId>119</d2p1:FavoriteItemId> <d2p1:FavoriteWebSalesGroupName>sample string 120</d2p1:FavoriteWebSalesGroupName> <d2p1:GroupLineId>121</d2p1:GroupLineId> <d2p1:MenuItemName>sample string 123</d2p1:MenuItemName> <d2p1:PromoId>124</d2p1:PromoId> <d2p1:PromoPrice>126</d2p1:PromoPrice> <d2p1:PromoType>125</d2p1:PromoType> <d2p1:WebSalesGroupId>122</d2p1:WebSalesGroupId> </d2p1:FavoriteWebSalesGroupItem> </d2p1:WebSalesGroupItems> </d2p1:FavoriteComboItem> </FavoriteComboItems> <FavoriteItems xmlns:d2p1="http://schemas.datacontract.org/2004/07/OnlineOrderingAPI.Models.v1"> <d2p1:FavoriteItem> <d2p1:Available>true</d2p1:Available> <d2p1:ExtendedPrice>12</d2p1:ExtendedPrice> <d2p1:FavoriteItemId>1</d2p1:FavoriteItemId> <d2p1:FavoriteItemName>sample string 2</d2p1:FavoriteItemName> <d2p1:ItemLineNumber>4</d2p1:ItemLineNumber> <d2p1:ItemName>sample string 3</d2p1:ItemName> <d2p1:ItemOrderingMode>Normal</d2p1:ItemOrderingMode> <d2p1:MenuItemId>6</d2p1:MenuItemId> <d2p1:Modifiers> <d2p1:FavoriteItemModifier> <d2p1:Action>Default</d2p1:Action> <d2p1:DefaultAction>Default</d2p1:DefaultAction> <d2p1:ExtendedPrice>16</d2p1:ExtendedPrice> <d2p1:FreeQuantity>28</d2p1:FreeQuantity> <d2p1:IsOnEntireItem>true</d2p1:IsOnEntireItem> <d2p1:IsOnSection1>true</d2p1:IsOnSection1> <d2p1:IsOnSection2>true</d2p1:IsOnSection2> <d2p1:IsOnSection3>true</d2p1:IsOnSection3> <d2p1:IsOnSection4>true</d2p1:IsOnSection4> <d2p1:ItemLineNumber>20</d2p1:ItemLineNumber> <d2p1:ItemOptionGroupId>18</d2p1:ItemOptionGroupId> <d2p1:Modifiers i:nil="true" /> <d2p1:Name>sample string 14</d2p1:Name> <d2p1:ParentSequenceNumber>21</d2p1:ParentSequenceNumber> <d2p1:Quantity>22</d2p1:Quantity> <d2p1:SalesItemOptionId>19</d2p1:SalesItemOptionId> <d2p1:SequenceNumber>17</d2p1:SequenceNumber> <d2p1:Status>Normal</d2p1:Status> <d2p1:UnitPrice>15</d2p1:UnitPrice> </d2p1:FavoriteItemModifier> <d2p1:FavoriteItemModifier> <d2p1:Action>Default</d2p1:Action> <d2p1:DefaultAction>Default</d2p1:DefaultAction> <d2p1:ExtendedPrice>31</d2p1:ExtendedPrice> <d2p1:FreeQuantity>43</d2p1:FreeQuantity> <d2p1:IsOnEntireItem>true</d2p1:IsOnEntireItem> <d2p1:IsOnSection1>true</d2p1:IsOnSection1> <d2p1:IsOnSection2>true</d2p1:IsOnSection2> <d2p1:IsOnSection3>true</d2p1:IsOnSection3> <d2p1:IsOnSection4>true</d2p1:IsOnSection4> <d2p1:ItemLineNumber>35</d2p1:ItemLineNumber> <d2p1:ItemOptionGroupId>33</d2p1:ItemOptionGroupId> <d2p1:Modifiers i:nil="true" /> <d2p1:Name>sample string 29</d2p1:Name> <d2p1:ParentSequenceNumber>36</d2p1:ParentSequenceNumber> <d2p1:Quantity>37</d2p1:Quantity> <d2p1:SalesItemOptionId>34</d2p1:SalesItemOptionId> <d2p1:SequenceNumber>32</d2p1:SequenceNumber> <d2p1:Status>Normal</d2p1:Status> <d2p1:UnitPrice>30</d2p1:UnitPrice> </d2p1:FavoriteItemModifier> </d2p1:Modifiers> <d2p1:NextModifierSequenceNumber>10</d2p1:NextModifierSequenceNumber> <d2p1:RecipientName>sample string 9</d2p1:RecipientName> <d2p1:SalesItemId>5</d2p1:SalesItemId> <d2p1:Section1Type>Unassigned</d2p1:Section1Type> <d2p1:Section2Type>Unassigned</d2p1:Section2Type> <d2p1:Section3Type>Unassigned</d2p1:Section3Type> <d2p1:Section4Type>Unassigned</d2p1:Section4Type> <d2p1:ShortDescription>sample string 8</d2p1:ShortDescription> <d2p1:SpecialInstructions>sample string 7</d2p1:SpecialInstructions> <d2p1:Status>Normal</d2p1:Status> <d2p1:UnitPrice>11</d2p1:UnitPrice> </d2p1:FavoriteItem> <d2p1:FavoriteItem> <d2p1:Available>true</d2p1:Available> <d2p1:ExtendedPrice>55</d2p1:ExtendedPrice> <d2p1:FavoriteItemId>44</d2p1:FavoriteItemId> <d2p1:FavoriteItemName>sample string 45</d2p1:FavoriteItemName> <d2p1:ItemLineNumber>47</d2p1:ItemLineNumber> <d2p1:ItemName>sample string 46</d2p1:ItemName> <d2p1:ItemOrderingMode>Normal</d2p1:ItemOrderingMode> <d2p1:MenuItemId>49</d2p1:MenuItemId> <d2p1:Modifiers> <d2p1:FavoriteItemModifier> <d2p1:Action>Default</d2p1:Action> <d2p1:DefaultAction>Default</d2p1:DefaultAction> <d2p1:ExtendedPrice>59</d2p1:ExtendedPrice> <d2p1:FreeQuantity>71</d2p1:FreeQuantity> <d2p1:IsOnEntireItem>true</d2p1:IsOnEntireItem> <d2p1:IsOnSection1>true</d2p1:IsOnSection1> <d2p1:IsOnSection2>true</d2p1:IsOnSection2> <d2p1:IsOnSection3>true</d2p1:IsOnSection3> <d2p1:IsOnSection4>true</d2p1:IsOnSection4> <d2p1:ItemLineNumber>63</d2p1:ItemLineNumber> <d2p1:ItemOptionGroupId>61</d2p1:ItemOptionGroupId> <d2p1:Modifiers i:nil="true" /> <d2p1:Name>sample string 57</d2p1:Name> <d2p1:ParentSequenceNumber>64</d2p1:ParentSequenceNumber> <d2p1:Quantity>65</d2p1:Quantity> <d2p1:SalesItemOptionId>62</d2p1:SalesItemOptionId> <d2p1:SequenceNumber>60</d2p1:SequenceNumber> <d2p1:Status>Normal</d2p1:Status> <d2p1:UnitPrice>58</d2p1:UnitPrice> </d2p1:FavoriteItemModifier> <d2p1:FavoriteItemModifier> <d2p1:Action>Default</d2p1:Action> <d2p1:DefaultAction>Default</d2p1:DefaultAction> <d2p1:ExtendedPrice>74</d2p1:ExtendedPrice> <d2p1:FreeQuantity>86</d2p1:FreeQuantity> <d2p1:IsOnEntireItem>true</d2p1:IsOnEntireItem> <d2p1:IsOnSection1>true</d2p1:IsOnSection1> <d2p1:IsOnSection2>true</d2p1:IsOnSection2> <d2p1:IsOnSection3>true</d2p1:IsOnSection3> <d2p1:IsOnSection4>true</d2p1:IsOnSection4> <d2p1:ItemLineNumber>78</d2p1:ItemLineNumber> <d2p1:ItemOptionGroupId>76</d2p1:ItemOptionGroupId> <d2p1:Modifiers i:nil="true" /> <d2p1:Name>sample string 72</d2p1:Name> <d2p1:ParentSequenceNumber>79</d2p1:ParentSequenceNumber> <d2p1:Quantity>80</d2p1:Quantity> <d2p1:SalesItemOptionId>77</d2p1:SalesItemOptionId> <d2p1:SequenceNumber>75</d2p1:SequenceNumber> <d2p1:Status>Normal</d2p1:Status> <d2p1:UnitPrice>73</d2p1:UnitPrice> </d2p1:FavoriteItemModifier> </d2p1:Modifiers> <d2p1:NextModifierSequenceNumber>53</d2p1:NextModifierSequenceNumber> <d2p1:RecipientName>sample string 52</d2p1:RecipientName> <d2p1:SalesItemId>48</d2p1:SalesItemId> <d2p1:Section1Type>Unassigned</d2p1:Section1Type> <d2p1:Section2Type>Unassigned</d2p1:Section2Type> <d2p1:Section3Type>Unassigned</d2p1:Section3Type> <d2p1:Section4Type>Unassigned</d2p1:Section4Type> <d2p1:ShortDescription>sample string 51</d2p1:ShortDescription> <d2p1:SpecialInstructions>sample string 50</d2p1:SpecialInstructions> <d2p1:Status>Normal</d2p1:Status> <d2p1:UnitPrice>54</d2p1:UnitPrice> </d2p1:FavoriteItem> </FavoriteItems> <MenuCheckResult>127</MenuCheckResult> </GetFavoriteItemsResult>