customer_portal:manuals:iorder:onlineproductscripts [Imagatec Wiki]

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
======iOrder: Product Scripts======

A list of products scripts that are used commonly used for iOrder, with examples of how they can be used.

Note: more product scripts will be added as time permits.

====KEY====
|< 1400px 200px  400px 300px  500px- >|
^ Placeholder				^ Details							^ Example 					^ More Info										^
|X						|limit to day of week				|1-7							|													|
|XXX						|limit to day abbreviation 			|MON or WED					|													|
|XXXXXX					|limit to day expressions 			|WEEKDAYS or WEEKENDS		|													|
|XM 						|limit to day of month 				|16 							|16th day of the month									|
|Y 						|limit to order source 				|2							|													|
|Z 						|limit to order type 					|3							|													|
|$ 						|price override 					|5							|													|
|P						|Product							|P1001						|													|
|T						|Matrix Target 						|T1357						|													|
|D						|Department						|D246						|													|
|CE						|Combo Element					|PIZZA or BREAD or 125DRINK	| combo elements MUST be defined before they can be used	|
|[ABC] 					|limit to price Structure 				|SPECIALPRICES				|													|
|DDMONYYYY				|Date in DDMONYYYY format			|01JAN2012 					|1st January 2012										|
|DD-MON-YYYY			|Date in DD-MON-YYYY format		|01-JAN-2012					| 1st January 2012										|
|TRADEPERIOD			|Time period						|BREAKFAST or LUNCH or DINNER	|													|


=====PRICE=====

Overrides the POS price of the product.

\\
Default use:
<code>PRICE = $</code>

Example - product price is $5 for all stores:
<code>PRICE = 5</code>

---

Struct use:
<code>PRICE [ABC] = $</code>

Example - product price is $5 for stores using price struct SPECIALPRICES:
<code>PRICE [SPECIALPRICES] = 5</code>


=====OLOPRICE=====

Overrides the POS price of the product when purchased ONLINE.

\\
Default use:
<code>OLOPRICE = $</code>

Example - online product price is $5 for all stores:
<code>OLOPRICE = 5</code>

---

Struct use:
<code>OLOPRICE [ABC] = $</code>

Example - online product price is $5 for stores using price struct SPECIALPRICES:
<code>OLOPRICE [SPECIALPRICES] = 5</code>



=====PRICEDAY=====

Overrides the POS price of the product for the specified day.

\\
Default use:
<code>PRICEDAY X = $</code>

Example - on Tuesday limit the price to $5 for all stores:
<code>PRICEDAY 2 = 5</code>

---

Struct use:
<code>PRICEDAY [ABC] X = $</code>

Example - on Tuesday limit the price to $5 for stores using price struct SPECIALPRICES:
<code>PRICEDAY [SPECIALPRICES] 2 = 5</code>



=====PRICEDAYSRC=====

Overrides the POS price of the product for the specified day and order source.

\\
Default use:
<code>PRICEDAYSRC X,Y = $</code>

Example - on Tuesday if order source = 1 limit the price to $5 for all stores:
<code>PRICEDAYSRC 2,1 = 5</code>

---

Struct use:
<code>PRICEDAYSRC [ABC] X,Y = $</code>

Example - on Tuesday if order source = 1 limit the price to $5 for stores using price struct SPECIALPRICES:
<code>PRICEDAYSRC [SPECIALPRICES] 2,1 = 5</code>



=====PRICESOURCE=====

Overrides the POS price of the product for the specified order source.

\\
Default use:
<code>PRICESOURCE Y = $</code>

Example - if order source = 1 limit the price to $5 for all stores:
<code>PRICESOURCE 1 = 5</code>

---

Struct use:
<code>PRICESOURCE [ABC] Y = $</code>

Example - if order source = 1 limit the price to $5 for stores using price struct SPECIALPRICES:
<code>PRICESOURCE [SPECIALPRICES] 1 = 5</code>



=====PRICETYPE=====

Overrides the POS price of the product for the specified order type.

\\
Default use:
<code>PRICETYPE Z = $</code>

Example - if order type = 3 limit the price to $5 for all stores:
<code>PRICETYPE 3 = 5</code>

---

Struct use:
<code>PRICETYPE [ABC] Z = $</code>

Example - if order type = 3 limit the price to $5 for stores using price struct SPECIALPRICES:
<code>PRICETYPE [SPECIALPRICES] 3 = 5</code>



=====OTDAYPRICE=====

Overrides the POS price of the product for the specified order type and day.

\\
Default use:
<code>OTDAYPRICE Z,X = $</code>

Example - on Tuesday if order type = 3 limit the price to $5 for all stores:
<code>OTDAYPRICE 3,2 = 5</code>

---

Struct use:
<code>OTDAYPRICE [ABC] Z,X = $</code>

Example - on Tuesday if order type = 3 limit the price to $5 for stores using price struct SPECIALPRICES:
<code>OTDAYPRICE [SPECIALPRICES] 3,2 = 5</code>



=====ONLINEDAYS=====

Sets the days when this product is available for online purchase.

\\
Single day use:
<code>ONLINEDAYS = X</code>

Example - on Tuesday this product can be purchases for all stores:
<code>ONLINEDAYS = 2</code>

---

Multiple days use:
<code>ONLINEDAYS = X,X,X</code>

Example - on Tuesday, Thursday and Friday this product can be purchases for all stores:
<code>ONLINEDAYS = 2,4,5</code>



=====DAY RESTRICTIONS=====

Restricts the purchase of the product to the specified day(s) of the week.

\\
Single day use:
<code>DAY = XXX</code>

Example - on Tuesday this product can be purchases for all stores:
<code>DAY = TUE</code>

---

Multiple days use:
<code>DAY = XXX,XXX,XXX</code>

Example - on Tuesday, Thursday and Friday this product can be purchases for all stores:
<code>DAY = TUE,THU,FRI</code>

---

Consecutive days use:
<code>DAY = XXX-XXX</code>

Example - from Tuesday to Thursday this product can be purchases for all stores:
<code>DAY = TUE-THU</code>

---

Expression use:
<code>DAY = XXXXXX</code>

Example - on weekends this product can be purchases for all stores:
<code>DAY = WEEKENDS</code>

Example - on weekday this product can be purchases for all stores:
<code>DAY = WEEKDAYS</code>

---

Mixed days and Expression use:
<code>DAY = XXX,XXX-XXX,XXXXXX</code>

Example - on Monday, Wednesday to Thursday, and weekends, this product can be purchases for all stores:
<code>DAY = MON,WED-THU,WEEKDAYS</code>

---

All above support the ~ for NOT. eg:\\

Example - on Tuesday this product can NOT be purchases for all stores:
<code>DAY = ~TUE</code>

Example - on weekends this product can NOT be purchases for all stores:
<code><code>DAY = ~WEEKENDS</code>



=====MONTH RESTRICTIONS=====

Restricts the purchase of the product to the specified day(s) of the month.

\\
Single day of month use:
<code>MONTH = XM</code>

Example - on the 16th day of the month this product can be purchases for all stores:
<code>MONTH = 16</code>

---

Multiple days of month use:
<code>MONTH = XM,XM,XM</code>

Example - on the 10th, 16th and 18th days of the month this product can be purchases for all stores:
<code>MONTH = 10,16,18</code>

---

Consecutive days of month use:
<code>MONTH = XM-XM</code>

Example - from the 20th to the 24th day of the month this product can be purchases for all stores:
<code>MONTH = 20-24</code>

---

Mixed days of month use:
<code>MONTH = 10,16,18,20-24</code>

Example - on the 10th, 16th and 18th days and of the month, and from the 20th to the 24th day of the month, this product can be purchases for all stores:
<code>MONTH = 10,16,18,20-24</code>

---

All above support the ~ for NOT. eg:\\

Example - on the 16th day of the month this product can NOT be purchases for all stores:
<code>MONTH = ~16</code>

Example - from the 20th to the 24th day of the month this product can NOT be purchases for all stores:
<code>MONTH = ~20-24</code>



=====DATE RESTRICTIONS=====

Restricts the purchase of the product to the specified date(s).

\\
Single date use:
<code>DATE = DDMONYYYY</code>

Example - on the 01-JAN-2012 this product can be purchases for all stores:
<code>DATE = 01JAN2012</code>

---

Consecutive date use:
<code>DAY = DDMONYYYY-DDMONYYYY</code>

Example - from the 1st of January 2012 to the 31st of January 2012 this product can be purchases for all stores:
<code>DAY = 01JAN2012-31JAN2012</code>

---

Before date use:
<code>DATE = BEFORE DDMONYYYY</code>

Example - before the 31st of January 2012 this product can be purchases for all stores:
<code>DATE = BEFORE 31JAN2012</code>

---

After date use:
<code>DATE = AFTER DDMONYYYY</code>

Example - after the 31st of January 2012 this product can be purchases for all stores:
<code>DATE = AFTER 31JAN2012</code>

---

Single date supports the ~ for NOT. eg:\\

Example - on the 16th day of the month this product can NOT be purchases for all stores:
<code>DATE = 31JAN2012</code>



=====TIME RESTRICTIONS=====

Restricts the purchase of the product to the specified time(s).

\\
Default time use:
<code>TIME = HH:MM-HH:MM</code>

Example - from 10am to 2:30pm this product can be purchases for all stores:
<code>TIME = 10:00-14:30</code>

---

Trade periods use:
<code>TIME = TRADEPERIOD</code>

Example - during breakfast trade period this product can be purchases for all stores:
<code>TIME = BREAKFAST</code>

Example - during lunch trade period this product can be purchases for all stores:
<code>TIME = LUNCH</code>

Example - during dinner trade period this product can be purchases for all stores:
<code>TIME = DINNER</code>

---

Before time use:
<code>TIME = BEFORE HH:MM</code>

Example - before 2:30pm this product can be purchases for all stores:
<code>TIME = BEFORE 14:30</code>

---

After time use:
<code>TIME = AFTER HH:MM</code>

Example - after 2:30pm this product can be purchases for all stores:
<code>TIME = AFTER 14:30</code>

---

Not before time use:
<code>TIME = NOTBEFORE HH:MM</code>

Example - before 2:30pm this product can NOT be purchases for all stores:
<code>TIME = NOTBEFORE 14:30</code>

---

Not after time use:
<code>TIME = NOTAFTER HH:MM</code>

Example - after 2:30pm this product can NOT be purchases for all stores:
<code>TIME = NOTAFTER 14:30</code>

---

Trade periods support the ~ for NOT. eg:\\

Example - during breakfast trade period this product can NOT be purchases for all stores:
<code>TIME = ~BREAKFAST</code>



=====TOPPING LIST SCRIPTS=====

Provides toppings and product options during product customisation.

\\
**IMPORTANT**\\

Any toppings list scripts used must be defined under rules (excluding title scripts). eg:
<code>ONLINETOPPINGRULE = TOPPINGS,SINGLECHOICE,SINGLECHOICE2,EXTRAS</code>

---

====TOPPINGS====

Add a toppings list to a product (products selected by default). eg:
<code>TOPPINGS = P,P,P,P</code>

Add a custom title for the toppings list. eg:
<code>TOPPINGLISTTITLE = Toppings list title</code>

---

====TOPPINGLISTSINGLECHOICE#====

Add a maximum of 3 single choice toppings dropdowns to a product (single product selection is required). eg:
<code>TOPPINGLISTSINGLECHOICE = P,D,T
TOPPINGLISTSINGLECHOICE2 = P,D,T
TOPPINGLISTSINGLECHOICE3 = P,D,T</code>

Add a custom title for the single choice toppings dropdowns. eg:
<code>TOPPINGLISTSINGLECHOICETITLE = First single choice dropdown title
TOPPINGLISTSINGLECHOICE2TITLE = Second single choice dropdown title
TOPPINGLISTSINGLECHOICE3TITLE = Third single choice dropdown title</code>

---

====TOPPINGLISTADDITIONAL====

Add additional toppings/products dropdown to a product (product selections are optional). eg:
<code>TOPPINGLISTADDITIONAL = P,D</code>

Add a custom title for the additional toppings/products dropdown. eg:
<code>TOPPINGLISTADDITIONALTITLE = Extra toppings dropdown title</code>

Set the default product for the additional toppings/products dropdown. eg:
<code>TOPPINGLISTADDITIONALDEFAULTOPTION = P</code>

---

====TOPPINGLISTEXTRAS====

Add extra toppings/products dropdown to a product (product selections are optional). eg:
<code>TOPPINGLISTEXTRAS = P,D</code>

Add a custom title for the extra toppings/products dropdown. eg:
<code>TOPPINGLISTEXTRASTITLE = Extra toppings dropdown title</code>

Set the default product for the extra toppings/products dropdown. eg:
<code>TOPPINGLISTEXTRASDEFAULTOPTION = P</code>

---

====FREETOPPINGS====

Add free toppings/products dropdown to a product (product selections are optional). eg:
<code>FREETOPPINGS = P,D</code>

Add a custom title for the free toppings/products dropdowns. eg:
<code>FREETOPPINGSLISTTITLE = Free toppings dropdown title</code>



=====OLODEAL=====

Defines deals that are only available online.

\\
Default use:
<code>OLODEAL = P, P</code>

Example - deal includes\\
  * any one product in the same department as P1001\\
  * any one product in the same department as P1002\\
  * can be purchased online only\\
  * final price is the the deal's product price\\
  * available for all stores:
<code>OLODEAL = P1001,P1002</code>

---

Advanced use:
<code>OLODEAL = P, T, D, CE</code>

Example - deal includes\\
  * any one product product in the same department as P1001\\
  * any one matrix product with a target product T1357\\
  * any one product from department D246\\
  * any one product defined as combo element 125DRINK\\
  * can be purchased online only\\
  * final price is the deal product price\\
  * available for all stores:
<code>OLODEAL = P1001, T1357, D246, 125DRINK</code>

---

Online deals support prefixes used in POS. eg:
'           !      FORCE PRODUCT, can be used !Pxxx
'           *      WATERMARK, the price of this element is not changed to zero, but marked as part of the combo
'           (%)    WATERMARK, the price of this element is a percentage of the normal price, but marked as part of the combo
'           ($)    WATERMARK, the price of this element is a set price, but marked as part of the combo

Example - deal includes:\\
  * ONLY the product P1001\\
  * can be purchased online only\\
  * final price is the deal's product price\\
  * available for all stores:
<code>OLODEAL = !P1001</code>

Example - deal includes\\
  * any one product in the same department as the watermarked product P1001 at the price of the product selected\\
  * ONLY the product P1002\\
  * can be purchased online only\\
  * final price is deal's product price + the price of the watermarked product selected\\
  * available for all stores:
<code>OLODEAL = *P1001,!P1002</code>

Example - deal includes\\
  * any one product in the same department as the watermarked product P1001 at 75% of the price of the product selected\\
  * can be purchased online only\\
  * final price is 75% of the price of the watermarked product selected\\
  * available for all stores:
<code>OLODEAL = (%75)P1001</code>

Example - deal includes\\
  * any one product in the same department as the watermarked product P1001 for $10\\
  * can be purchased online only\\
  * final price is the watermarked price $10\\
  * available for all stores:
<code>OLODEAL = ($10)P1001</code>



=====EXPIRES=====

Sets an expiry date for the product. The product cannot be purchased AFTER this date.

\\
**Note:**\\
Available in cloud POS only atm.

\\
Default use:
<code>EXPIRES = DD-MON-YYYY</code>

Example - product expires and cannot be used after 1 January 2012 for all stores:
<code>EXPIRES = 01-JAN-2012</code>

Struct use:
<code>EXPIRES [ABC] = DD-MON-YYYY</code>

Example - product expires and cannot be used after 1 January 2012 for stores using price struct SPECIALPRICES:
<code>EXPIRES [SPECIALPRICES] = 01JAN2012</code>