Order class - Revision history

Administrator at 04:35, 22 June 2023

2023-06-22T04:35:03Z

← Older revision		Revision as of 04:35, 22 June 2023
Line 68:		Line 68:
	{{CGscriptProperties_Template\|ReturnType=int\|Name=<nowiki>UserId</nowiki>\|HasGetter=1\|Obsolete=1		{{CGscriptProperties_Template\|ReturnType=int\|Name=<nowiki>UserId</nowiki>\|HasGetter=1\|Obsolete=1
	\|Description=<nowiki>The id of the user ordering.</nowiki>}}		\|Description=<nowiki>The id of the user ordering.</nowiki>}}
	{{CGscriptProperties_Template\|ReturnType=int\|Name=<nowiki>UserResourceId</nowiki>\|HasGetter=1\|Description=<nowiki>The id of the user ordering.</nowiki>}}		{{CGscriptProperties_Template\|ReturnType=int\|Name=<nowiki>UserResourceId</nowiki>\|HasGetter=1\|HasSetter=1\|Description=<nowiki>The id of the user ordering.</nowiki>}}
	}}		}}

Administrator at 07:06, 23 December 2022

2022-12-23T07:06:26Z

← Older revision		Revision as of 07:06, 23 December 2022
Line 16:		Line 16:
	{{CGscriptParameters_Template\|Type=string\|Name=<nowiki>msg</nowiki>\|Description=<nowiki>Message to add.</nowiki>}}		{{CGscriptParameters_Template\|Type=string\|Name=<nowiki>msg</nowiki>\|Description=<nowiki>Message to add.</nowiki>}}
	\|Description=<nowiki>Add an entry to AdminNote automatically appending a newline.</nowiki>}}		\|Description=<nowiki>Add an entry to AdminNote automatically appending a newline.</nowiki>}}
			{{CGscriptMethods_Template\|ReturnType=Empty\|Name=<nowiki>AddNote</nowiki>\|Parameters=
			{{CGscriptParameters_Template\|Type=string\|Name=<nowiki>msg</nowiki>\|Description=<nowiki>Message to add.</nowiki>}}
			\|Description=<nowiki>Append new comment for exist order</nowiki>}}
	{{CGscriptMethods_Template\|ReturnType=bool\|Name=<nowiki>Approve</nowiki>\|Parameters=		{{CGscriptMethods_Template\|ReturnType=bool\|Name=<nowiki>Approve</nowiki>\|Parameters=
	{{CGscriptParameters_Template\|Type=bool\|Name=<nowiki>acceptTestPayment</nowiki>\|Description=<nowiki>If true, test payments will succeed, otherwise an exception is throw if test cards are used</nowiki>}}		{{CGscriptParameters_Template\|Type=bool\|Name=<nowiki>acceptTestPayment</nowiki>\|Description=<nowiki>If true, test payments will succeed, otherwise an exception is throw if test cards are used</nowiki>}}
Line 54:		Line 57:
	{{CGscriptProperties_Template\|ReturnType=int\|Name=<nowiki>OrderPoints</nowiki>\|HasGetter=1\|Description=<nowiki>How many points was used in total.</nowiki>}}		{{CGscriptProperties_Template\|ReturnType=int\|Name=<nowiki>OrderPoints</nowiki>\|HasGetter=1\|Description=<nowiki>How many points was used in total.</nowiki>}}
	{{CGscriptProperties_Template\|ReturnType=string\|Name=<nowiki>OrderStatus</nowiki>\|HasGetter=1\|Description=<nowiki>The current processing status of an order</nowiki>}}		{{CGscriptProperties_Template\|ReturnType=string\|Name=<nowiki>OrderStatus</nowiki>\|HasGetter=1\|Description=<nowiki>The current processing status of an order</nowiki>}}
			{{CGscriptProperties_Template\|ReturnType=number\|Name=<nowiki>PaidCash</nowiki>\|HasGetter=1\|Description=<nowiki>Cash is paid</nowiki>}}
			{{CGscriptProperties_Template\|ReturnType=int\|Name=<nowiki>PaidPoints</nowiki>\|HasGetter=1\|Description=<nowiki>Points is paid</nowiki>}}
	{{CGscriptProperties_Template\|ReturnType=number\|Name=<nowiki>PercentageDiscount</nowiki>\|HasGetter=1\|Description=<nowiki>How much discount does this user get.</nowiki>}}		{{CGscriptProperties_Template\|ReturnType=number\|Name=<nowiki>PercentageDiscount</nowiki>\|HasGetter=1\|Description=<nowiki>How much discount does this user get.</nowiki>}}
	{{CGscriptProperties_Template\|ReturnType=int\|Name=<nowiki>PostagePoints</nowiki>\|HasGetter=1\|Description=<nowiki>How many points was used for postage.</nowiki>}}		{{CGscriptProperties_Template\|ReturnType=int\|Name=<nowiki>PostagePoints</nowiki>\|HasGetter=1\|Description=<nowiki>How many points was used for postage.</nowiki>}}
Line 61:		Line 66:
	{{CGscriptProperties_Template\|ReturnType=bool\|Name=<nowiki>UseGiftPoints</nowiki>\|HasGetter=1\|Description=<nowiki>Does this user get gift points if a bought product gives some.</nowiki>}}		{{CGscriptProperties_Template\|ReturnType=bool\|Name=<nowiki>UseGiftPoints</nowiki>\|HasGetter=1\|Description=<nowiki>Does this user get gift points if a bought product gives some.</nowiki>}}
	{{CGscriptProperties_Template\|ReturnType=string\|Name=<nowiki>UserComment</nowiki>\|HasGetter=1\|HasSetter=1\|Description=<nowiki>Get the comment the buyer wrote.</nowiki>}}		{{CGscriptProperties_Template\|ReturnType=string\|Name=<nowiki>UserComment</nowiki>\|HasGetter=1\|HasSetter=1\|Description=<nowiki>Get the comment the buyer wrote.</nowiki>}}
	{{CGscriptProperties_Template\|ReturnType=int\|Name=<nowiki>UserId</nowiki>\|HasGetter=1\|Description=<nowiki>The id of the user ordering.</nowiki>}}		{{CGscriptProperties_Template\|ReturnType=int\|Name=<nowiki>UserId</nowiki>\|HasGetter=1\|Obsolete=1
			\|Description=<nowiki>The id of the user ordering.</nowiki>}}
			{{CGscriptProperties_Template\|ReturnType=int\|Name=<nowiki>UserResourceId</nowiki>\|HasGetter=1\|Description=<nowiki>The id of the user ordering.</nowiki>}}
	}}		}}

Administrator at 05:26, 11 January 2021

2021-01-11T05:26:19Z

← Older revision		Revision as of 05:26, 11 January 2021
Line 16:		Line 16:
	{{CGscriptParameters_Template\|Type=string\|Name=<nowiki>msg</nowiki>\|Description=<nowiki>Message to add.</nowiki>}}		{{CGscriptParameters_Template\|Type=string\|Name=<nowiki>msg</nowiki>\|Description=<nowiki>Message to add.</nowiki>}}
	\|Description=<nowiki>Add an entry to AdminNote automatically appending a newline.</nowiki>}}		\|Description=<nowiki>Add an entry to AdminNote automatically appending a newline.</nowiki>}}
	~~{{CGscriptMethods_Template\|ReturnType=bool\|Name=<nowiki>Approve</nowiki>\|Description=<nowiki>Order is approve by cashier with default Merchant.</nowiki>}}~~
	{{CGscriptMethods_Template\|ReturnType=bool\|Name=<nowiki>Approve</nowiki>\|Parameters=		{{CGscriptMethods_Template\|ReturnType=bool\|Name=<nowiki>Approve</nowiki>\|Parameters=
	{{CGscriptParameters_Template\|Type=string\|Name=<nowiki>merchantName</nowiki>\|Description=<nowiki>Merchant name to load the appropriate merchant configuration from the web config</nowiki>}}		{{CGscriptParameters_Template\|Type=bool\|Name=<nowiki>acceptTestPayment</nowiki>\|Description=<nowiki>If true, test payments will succeed, otherwise an exception is throw if test cards are used</nowiki>}}
			\|Description=<nowiki>Order is approve by cashier with default Merchant.</nowiki>}}
			{{CGscriptMethods_Template\|ReturnType=bool\|Name=<nowiki>Approve</nowiki>\|Parameters=
			{{CGscriptParameters_Template\|Type=bool\|Name=<nowiki>acceptTestPayment</nowiki>\|Description=<nowiki>If true, test payments will succeed, otherwise an exception is throw if test cards are used</nowiki>\|Comma=,}}{{CGscriptParameters_Template\|Type=string\|Name=<nowiki>merchantName</nowiki>\|Description=<nowiki>Merchant name to load the appropriate merchant configuration from the web config</nowiki>}}
	\|Description=<nowiki>Order is approve by cashier.</nowiki>}}		\|Description=<nowiki>Order is approve by cashier.</nowiki>}}
	{{CGscriptMethods_Template\|ReturnType=string\|Name=<nowiki>ExecuteFromOther</nowiki>\|Parameters=		{{CGscriptMethods_Template\|ReturnType=string\|Name=<nowiki>ExecuteFromOther</nowiki>\|Parameters=

Administrator at 04:22, 14 December 2020

2020-12-14T04:22:09Z

← Older revision		Revision as of 04:22, 14 December 2020
Line 1:		Line 1:
	~~Result:~~
	{{CGscriptClass_Template		{{CGscriptClass_Template
	\|Name=<nowiki>Order</nowiki>		\|Name=<nowiki>Order</nowiki>
Line 52:		Line 51:
	{{CGscriptProperties_Template\|ReturnType=string\|Name=<nowiki>OrderPaymentType</nowiki>\|HasGetter=1\|Description=<nowiki>How was the order paid. Possible values is ByPoint, ByCreditCard, ByInvoice, ByCash, ByGiro, ByDanKort, ByPointAndCreditCard.</nowiki>}}		{{CGscriptProperties_Template\|ReturnType=string\|Name=<nowiki>OrderPaymentType</nowiki>\|HasGetter=1\|Description=<nowiki>How was the order paid. Possible values is ByPoint, ByCreditCard, ByInvoice, ByCash, ByGiro, ByDanKort, ByPointAndCreditCard.</nowiki>}}
	{{CGscriptProperties_Template\|ReturnType=int\|Name=<nowiki>OrderPoints</nowiki>\|HasGetter=1\|Description=<nowiki>How many points was used in total.</nowiki>}}		{{CGscriptProperties_Template\|ReturnType=int\|Name=<nowiki>OrderPoints</nowiki>\|HasGetter=1\|Description=<nowiki>How many points was used in total.</nowiki>}}
			{{CGscriptProperties_Template\|ReturnType=string\|Name=<nowiki>OrderStatus</nowiki>\|HasGetter=1\|Description=<nowiki>The current processing status of an order</nowiki>}}
	{{CGscriptProperties_Template\|ReturnType=number\|Name=<nowiki>PercentageDiscount</nowiki>\|HasGetter=1\|Description=<nowiki>How much discount does this user get.</nowiki>}}		{{CGscriptProperties_Template\|ReturnType=number\|Name=<nowiki>PercentageDiscount</nowiki>\|HasGetter=1\|Description=<nowiki>How much discount does this user get.</nowiki>}}
	{{CGscriptProperties_Template\|ReturnType=int\|Name=<nowiki>PostagePoints</nowiki>\|HasGetter=1\|Description=<nowiki>How many points was used for postage.</nowiki>}}		{{CGscriptProperties_Template\|ReturnType=int\|Name=<nowiki>PostagePoints</nowiki>\|HasGetter=1\|Description=<nowiki>How many points was used for postage.</nowiki>}}

Administrator at 09:49, 11 December 2020

2020-12-11T09:49:22Z

← Older revision		Revision as of 09:49, 11 December 2020
Line 1:		Line 1:
			Result:
	{{CGscriptClass_Template		{{CGscriptClass_Template
	\|Name=<nowiki>Order</nowiki>		\|Name=<nowiki>Order</nowiki>
Line 16:		Line 17:
	{{CGscriptParameters_Template\|Type=string\|Name=<nowiki>msg</nowiki>\|Description=<nowiki>Message to add.</nowiki>}}		{{CGscriptParameters_Template\|Type=string\|Name=<nowiki>msg</nowiki>\|Description=<nowiki>Message to add.</nowiki>}}
	\|Description=<nowiki>Add an entry to AdminNote automatically appending a newline.</nowiki>}}		\|Description=<nowiki>Add an entry to AdminNote automatically appending a newline.</nowiki>}}
			{{CGscriptMethods_Template\|ReturnType=bool\|Name=<nowiki>Approve</nowiki>\|Description=<nowiki>Order is approve by cashier with default Merchant.</nowiki>}}
			{{CGscriptMethods_Template\|ReturnType=bool\|Name=<nowiki>Approve</nowiki>\|Parameters=
			{{CGscriptParameters_Template\|Type=string\|Name=<nowiki>merchantName</nowiki>\|Description=<nowiki>Merchant name to load the appropriate merchant configuration from the web config</nowiki>}}
			\|Description=<nowiki>Order is approve by cashier.</nowiki>}}
	{{CGscriptMethods_Template\|ReturnType=string\|Name=<nowiki>ExecuteFromOther</nowiki>\|Parameters=		{{CGscriptMethods_Template\|ReturnType=string\|Name=<nowiki>ExecuteFromOther</nowiki>\|Parameters=
	{{CGscriptParameters_Template\|Type=string\|Name=<nowiki>successUrl</nowiki>\|Description=<nowiki>Url to send buyer to after successfully paying for the product. If empty then send to webshop receipt page</nowiki>\|Comma=,}}{{CGscriptParameters_Template\|Type=string\|Name=<nowiki>failureUrl</nowiki>\|Description=<nowiki>Url to send buyer to after cancelling payment. If empty then send to webshop cancel page. Empty means default</nowiki>\|Comma=,}}{{CGscriptParameters_Template\|Type=string\|Name=<nowiki>merchantName</nowiki>\|Description=<nowiki>Merchant name to load the appropriate merchant configuration from the web config</nowiki>\|Comma=,}}{{CGscriptParameters_Template\|Type=bool\|Name=<nowiki>payByInvoice</nowiki>\|Description=<nowiki>Pay by points/creditcard or if true by invoice</nowiki>\|Comma=,}}{{CGscriptParameters_Template\|Type=Function\|Name=<nowiki>callback</nowiki>\|Description=<nowiki>Function to call after ordernumber is assigned, so that it can be stored somewhere. OrderNumber is the first and only parameter</nowiki>}}		{{CGscriptParameters_Template\|Type=string\|Name=<nowiki>successUrl</nowiki>\|Description=<nowiki>Url to send buyer to after successfully paying for the product. If empty then send to webshop receipt page</nowiki>\|Comma=,}}{{CGscriptParameters_Template\|Type=string\|Name=<nowiki>failureUrl</nowiki>\|Description=<nowiki>Url to send buyer to after cancelling payment. If empty then send to webshop cancel page. Empty means default</nowiki>\|Comma=,}}{{CGscriptParameters_Template\|Type=string\|Name=<nowiki>merchantName</nowiki>\|Description=<nowiki>Merchant name to load the appropriate merchant configuration from the web config</nowiki>\|Comma=,}}{{CGscriptParameters_Template\|Type=bool\|Name=<nowiki>payByInvoice</nowiki>\|Description=<nowiki>Pay by points/creditcard or if true by invoice</nowiki>\|Comma=,}}{{CGscriptParameters_Template\|Type=Function\|Name=<nowiki>callback</nowiki>\|Description=<nowiki>Function to call after ordernumber is assigned, so that it can be stored somewhere. OrderNumber is the first and only parameter</nowiki>}}
Line 28:		Line 33:
	{{CGscriptParameters_Template\|Type=Function\|Name=<nowiki>callback</nowiki>\|Description=<nowiki>Function to call after ordernumber is assigned, so that it can be stored somewhere. OrderNumber is the first and only parameter</nowiki>}}		{{CGscriptParameters_Template\|Type=Function\|Name=<nowiki>callback</nowiki>\|Description=<nowiki>Function to call after ordernumber is assigned, so that it can be stored somewhere. OrderNumber is the first and only parameter</nowiki>}}
	\|Description=<nowiki>Save and initiate the payment process. This will commit current transaction and redirect to payment. On next question you can see state of order</nowiki>}}		\|Description=<nowiki>Save and initiate the payment process. This will commit current transaction and redirect to payment. On next question you can see state of order</nowiki>}}
			{{CGscriptMethods_Template\|ReturnType=string\|Name=<nowiki>ExecutePoints</nowiki>\|Parameters=
			{{CGscriptParameters_Template\|Type=int\|Name=<nowiki>points</nowiki>\|Description=<nowiki>how many points that user used to paid</nowiki>\|Comma=,}}{{CGscriptParameters_Template\|Type=string\|Name=<nowiki>successUrl</nowiki>\|Description=<nowiki>Url to send buyer to after successfully paying for the product. Its suffix will be added with order number</nowiki>\|Comma=,}}{{CGscriptParameters_Template\|Type=string\|Name=<nowiki>failureUrl</nowiki>\|Description=<nowiki>Url to send buyer to after cancelling payment. Its suffix will be added with order number</nowiki>}}
			\|Description=<nowiki>Save and initiate the payment process. It's return a url used to redirect next page</nowiki>}}
			{{CGscriptMethods_Template\|ReturnType=string\|Name=<nowiki>ExecutePoints</nowiki>\|Parameters=
			{{CGscriptParameters_Template\|Type=int\|Name=<nowiki>points</nowiki>\|Description=<nowiki>how many points that user used to paid</nowiki>\|Comma=,}}{{CGscriptParameters_Template\|Type=string\|Name=<nowiki>successUrl</nowiki>\|Description=<nowiki>Url to send buyer to after successfully paying for the product. Its suffix will be added with order number</nowiki>\|Comma=,}}{{CGscriptParameters_Template\|Type=string\|Name=<nowiki>failureUrl</nowiki>\|Description=<nowiki>Url to send buyer to after cancelling payment. Its suffix will be added with order number</nowiki>\|Comma=,}}{{CGscriptParameters_Template\|Type=string\|Name=<nowiki>merchantName</nowiki>\|Description=<nowiki>Merchant name to load the appropriate merchant configuration from the web config</nowiki>}}
			\|Description=<nowiki>Save and initiate the payment process. It's return a url used to redirect next page</nowiki>}}
	{{CGscriptMethods_Template\|ReturnType=string\|Name=<nowiki>ToString</nowiki>\|Inherited=object\|Description=<nowiki>The string representation of the object.</nowiki>}}		{{CGscriptMethods_Template\|ReturnType=string\|Name=<nowiki>ToString</nowiki>\|Inherited=object\|Description=<nowiki>The string representation of the object.</nowiki>}}
	\|Properties=		\|Properties=

Administrator at 05:15, 2 July 2020

2020-07-02T05:15:14Z

Show changes

Nguyenduyan at 05:20, 23 December 2016

2016-12-23T05:20:44Z

← Older revision		Revision as of 05:20, 23 December 2016
Line 1:		Line 1:
	{{CGscriptClass_Template \|Name=Order \|Description=Order object used while processing orders \|Methods= {{CGscriptMethods_Template\|ReturnType=Empty\|Name=AddLog\|Parameters= {{CGscriptParameters_Template\|Type=string\|Name=msg\|Description=Message to add.}} \|Description=Add an entry to AdminNote automatically appending a newline.}} {{CGscriptMethods_Template\|ReturnType=string\|Name=ToString\|Description=The string representation of the object.}} \|Properties= {{CGscriptProperties_Template\|ReturnType=string\|Name=AdminNote\|HasGetter=1\|Description=Get the comments the system or admin has written.}} {{CGscriptProperties_Template\|ReturnType=number\|Name=GiftPoints\|HasGetter=1\|Description=How many points does the buyer get for completing this order.}} {{CGscriptProperties_Template\|ReturnType=~~number~~\|Name=HandlingPoints\|HasGetter=1\|Description=How many points was used for handling.}} {{CGscriptProperties_Template\|ReturnType=bool\|Name=IsPhysicalOrder\|HasGetter=1\|Description=Does the order contain physical items or not.}} {{CGscriptProperties_Template\|ReturnType=string\|Name=ObjectTypeName\|HasGetter=1\|Description=The name of the type of object.}} {{CGscriptProperties_Template\|ReturnType=number\|Name=OrderCash\|HasGetter=1\|Description=How much cash was used in total.}} {{CGscriptProperties_Template\|ReturnType=DateTime\|Name=OrderDate\|HasGetter=1\|Description=Time and date the buyer completed the order.}} {{CGscriptProperties_Template\|ReturnType=string\|Name=OrderNumber\|HasGetter=1\|Description=The order number of the order.}} {{CGscriptProperties_Template\|ReturnType=string\|Name=OrderPaymentType\|HasGetter=1\|Description=How was the order paid. Possible values is ByPoint, ByCreditCard, ByInvoice, ByCash, ByGiro, ByDanKort, ByPointAndCreditCard.}} {{CGscriptProperties_Template\|ReturnType=~~number~~\|Name=OrderPoints\|HasGetter=1\|Description=How many points was used in total.}} {{CGscriptProperties_Template\|ReturnType=number\|Name=PercentageDiscount\|HasGetter=1\|Description=How much discount does this user get.}} {{CGscriptProperties_Template\|ReturnType=~~number~~\|Name=PostagePoints\|HasGetter=1\|Description=How many points was used for postage.}} {{CGscriptProperties_Template\|ReturnType=array\|Name=ProductOrders\|HasGetter=1\|Description=List of actual products bought.}} {{CGscriptProperties_Template\|ReturnType=~~number~~\|Name=ProductPoints\|HasGetter=1\|Description=How many points was used for the actual products.}} {{CGscriptProperties_Template\|ReturnType=TypeInformation\|Name=TypeInformation\|HasGetter=1\|Description=Get information about this class.}} {{CGscriptProperties_Template\|ReturnType=bool\|Name=UseGiftPoints\|HasGetter=1\|Description=Does this user get gift points if a bought product gives some.}} {{CGscriptProperties_Template\|ReturnType=string\|Name=UserComment\|HasGetter=1\|Description=Get the comment the buyer wrote.}} {{CGscriptProperties_Template\|ReturnType=~~number~~\|Name=UserId\|HasGetter=1\|Description=The id of the user ordering.}} }}		{{CGscriptClass_Template
			\|Name=Order
			\|Description=Order object used while processing orders
			\|Constructors=
			{{CGscriptConstructors_Template\|Parameters=
			{{CGscriptParameters_Template\|Type=string\|Name=currency\|Description=Currency to use for calculations. Use empty for default currency}}
			\|Description=Create a new order}}
			{{CGscriptConstructors_Template\|Parameters=
			{{CGscriptParameters_Template\|Type=string\|Name=currency\|Description=Currency to use for calculations. Use empty for default currency\|Comma=,}}{{CGscriptParameters_Template\|Type=string\|Name=deliveryTo\|Description=Name of recipient\|Comma=,}}{{CGscriptParameters_Template\|Type=string\|Name=address\|Description=First address line of delivery address\|Comma=,}}{{CGscriptParameters_Template\|Type=string\|Name=address2\|Description=Second address line of delivery address\|Comma=,}}{{CGscriptParameters_Template\|Type=string\|Name=city\|Description=City of delivery address\|Comma=,}}{{CGscriptParameters_Template\|Type=string\|Name=zipcode\|Description=Zipcode of delivery address\|Comma=,}}{{CGscriptParameters_Template\|Type=string\|Name=region\|Description=Region of delivery address\|Comma=,}}{{CGscriptParameters_Template\|Type=string\|Name=postbox\|Description=Postbox of delivery address\|Comma=,}}{{CGscriptParameters_Template\|Type=string\|Name=country\|Description=Country of delivery address\|Comma=,}}{{CGscriptParameters_Template\|Type=int\|Name=deliveryTypeId\|Description=Which type of delivery to use\|Comma=,}}{{CGscriptParameters_Template\|Type=string\|Name=userComment\|Description=Optional comment from the user}}
			\|Description=Create a new order for physical products}}
			\|Methods=
			{{CGscriptMethods_Template\|ReturnType=Empty\|Name=AddLog\|Parameters=
			{{CGscriptParameters_Template\|Type=string\|Name=msg\|Description=Message to add.}}
			\|Description=Add an entry to AdminNote automatically appending a newline.}}
			{{CGscriptMethods_Template\|ReturnType=string\|Name=ExecuteFromOther\|Parameters=
			{{CGscriptParameters_Template\|Type=string\|Name=successUrl\|Description=Url to send buyer to after successfully paying for the product. If empty then send to webshop receipt page\|Comma=,}}{{CGscriptParameters_Template\|Type=string\|Name=failureUrl\|Description=Url to send buyer to after cancelling payment. If empty then send to webshop cancel page. Empty means default\|Comma=,}}{{CGscriptParameters_Template\|Type=string\|Name=merchantName\|Description=Merchant name to load the appropriate merchant configuration from the web config\|Comma=,}}{{CGscriptParameters_Template\|Type=bool\|Name=payByInvoice\|Description=Pay by points/creditcard or if true by invoice\|Comma=,}}{{CGscriptParameters_Template\|Type=Function\|Name=callback\|Description=Function to call after ordernumber is assigned, so that it can be stored somewhere. OrderNumber is the first and only parameter}}
			\|Description=Save and initiate the payment process. This will commit current transaction and return the url to show next}}
			{{CGscriptMethods_Template\|ReturnType=Empty\|Name=ExecuteFromQuestionnaire\|Parameters=
			{{CGscriptParameters_Template\|Type=string\|Name=merchantName\|Description=Merchant name to load the appropriate merchant configuration from the web config\|Comma=,}}{{CGscriptParameters_Template\|Type=bool\|Name=payByInvoice\|Description=Pay by points/creditcard or if true by invoice\|Comma=,}}{{CGscriptParameters_Template\|Type=Function\|Name=callback\|Description=Function to call after ordernumber is assigned, so that it can be stored somewhere. OrderNumber is the first and only parameter}}
			\|Description=Save and initiate the payment process. This will commit current transaction and redirect to payment. On next question you can see state of order}}
			{{CGscriptMethods_Template\|ReturnType=Empty\|Name=ExecuteFromQuestionnaire\|Parameters=
			{{CGscriptParameters_Template\|Type=string\|Name=merchantName\|Description=Merchant name to load the appropriate merchant configuration from the web config. Empty means default\|Comma=,}}{{CGscriptParameters_Template\|Type=Function\|Name=callback\|Description=Function to call after ordernumber is assigned, so that it can be stored somewhere. OrderNumber is the first and only parameter}}
			\|Description=Save and initiate the payment process. This will commit current transaction and redirect to payment. On next question you can see state of order}}
			{{CGscriptMethods_Template\|ReturnType=Empty\|Name=ExecuteFromQuestionnaire\|Parameters=
			{{CGscriptParameters_Template\|Type=Function\|Name=callback\|Description=Function to call after ordernumber is assigned, so that it can be stored somewhere. OrderNumber is the first and only parameter}}
			\|Description=Save and initiate the payment process. This will commit current transaction and redirect to payment. On next question you can see state of order}}
			{{CGscriptMethods_Template\|ReturnType=string\|Name=ToString\|Description=The string representation of the object.}}
			\|Properties=
			{{CGscriptProperties_Template\|ReturnType=string\|Name=AdminNote\|HasGetter=1\|Description=Get the comments the system or admin has written.}}
			{{CGscriptProperties_Template\|ReturnType=number\|Name=GiftPoints\|HasGetter=1\|Description=How many points does the buyer get for completing this order.}}
			{{CGscriptProperties_Template\|ReturnType=int\|Name=HandlingPoints\|HasGetter=1\|Description=How many points was used for handling.}}
			{{CGscriptProperties_Template\|ReturnType=bool\|Name=IsPhysicalOrder\|HasGetter=1\|Description=Does the order contain physical items or not.}}
			{{CGscriptProperties_Template\|ReturnType=string\|Name=ObjectTypeName\|HasGetter=1\|Description=The name of the type of object.}}
			{{CGscriptProperties_Template\|ReturnType=number\|Name=OrderCash\|HasGetter=1\|Description=How much cash was used in total.}}
			{{CGscriptProperties_Template\|ReturnType=DateTime\|Name=OrderDate\|HasGetter=1\|Description=Time and date the buyer completed the order.}}
			{{CGscriptProperties_Template\|ReturnType=string\|Name=OrderNumber\|HasGetter=1\|Description=The order number of the order.}}
			{{CGscriptProperties_Template\|ReturnType=string\|Name=OrderPaymentType\|HasGetter=1\|Description=How was the order paid. Possible values is ByPoint, ByCreditCard, ByInvoice, ByCash, ByGiro, ByDanKort, ByPointAndCreditCard.}}
			{{CGscriptProperties_Template\|ReturnType=int\|Name=OrderPoints\|HasGetter=1\|Description=How many points was used in total.}}
			{{CGscriptProperties_Template\|ReturnType=number\|Name=PercentageDiscount\|HasGetter=1\|Description=How much discount does this user get.}}
			{{CGscriptProperties_Template\|ReturnType=int\|Name=PostagePoints\|HasGetter=1\|Description=How many points was used for postage.}}
			{{CGscriptProperties_Template\|ReturnType=array\|Name=ProductOrders\|HasGetter=1\|Description=List of actual products bought.}}
			{{CGscriptProperties_Template\|ReturnType=int\|Name=ProductPoints\|HasGetter=1\|Description=How many points was used for the actual products.}}
			{{CGscriptProperties_Template\|ReturnType=TypeInformation\|Name=TypeInformation\|HasGetter=1\|Description=Get information about this class.}}
			{{CGscriptProperties_Template\|ReturnType=bool\|Name=UseGiftPoints\|HasGetter=1\|Description=Does this user get gift points if a bought product gives some.}}
			{{CGscriptProperties_Template\|ReturnType=string\|Name=UserComment\|HasGetter=1\|HasSetter=1\|Description=Get the comment the buyer wrote.}}
			{{CGscriptProperties_Template\|ReturnType=int\|Name=UserId\|HasGetter=1\|Description=The id of the user ordering.}}
			}}

Tungocman: Created page with "{{CGscriptClass_Template |Name=Order |Description=Order object used while processing orders |Methods= {{CGscriptMethods_Template|ReturnType=Empty|Name=AddLog|Parameters= {{CGs..."

2015-10-05T10:18:14Z

Created page with "{{CGscriptClass_Template |Name=Order |Description=Order object used while processing orders |Methods= {{CGscriptMethods_Template|ReturnType=Empty|Name=AddLog|Parameters= {{CGs..."

New page

{{CGscriptClass_Template |Name=Order |Description=Order object used while processing orders |Methods= {{CGscriptMethods_Template|ReturnType=Empty|Name=AddLog|Parameters= {{CGscriptParameters_Template|Type=string|Name=msg|Description=Message to add.}} |Description=Add an entry to AdminNote automatically appending a newline.}} {{CGscriptMethods_Template|ReturnType=string|Name=ToString|Description=The string representation of the object.}} |Properties= {{CGscriptProperties_Template|ReturnType=string|Name=AdminNote|HasGetter=1|Description=Get the comments the system or admin has written.}} {{CGscriptProperties_Template|ReturnType=number|Name=GiftPoints|HasGetter=1|Description=How many points does the buyer get for completing this order.}} {{CGscriptProperties_Template|ReturnType=number|Name=HandlingPoints|HasGetter=1|Description=How many points was used for handling.}} {{CGscriptProperties_Template|ReturnType=bool|Name=IsPhysicalOrder|HasGetter=1|Description=Does the order contain physical items or not.}} {{CGscriptProperties_Template|ReturnType=string|Name=ObjectTypeName|HasGetter=1|Description=The name of the type of object.}} {{CGscriptProperties_Template|ReturnType=number|Name=OrderCash|HasGetter=1|Description=How much cash was used in total.}} {{CGscriptProperties_Template|ReturnType=DateTime|Name=OrderDate|HasGetter=1|Description=Time and date the buyer completed the order.}} {{CGscriptProperties_Template|ReturnType=string|Name=OrderNumber|HasGetter=1|Description=The order number of the order.}} {{CGscriptProperties_Template|ReturnType=string|Name=OrderPaymentType|HasGetter=1|Description=How was the order paid. Possible values is ByPoint, ByCreditCard, ByInvoice, ByCash, ByGiro, ByDanKort, ByPointAndCreditCard.}} {{CGscriptProperties_Template|ReturnType=number|Name=OrderPoints|HasGetter=1|Description=How many points was used in total.}} {{CGscriptProperties_Template|ReturnType=number|Name=PercentageDiscount|HasGetter=1|Description=How much discount does this user get.}} {{CGscriptProperties_Template|ReturnType=number|Name=PostagePoints|HasGetter=1|Description=How many points was used for postage.}} {{CGscriptProperties_Template|ReturnType=array|Name=ProductOrders|HasGetter=1|Description=List of actual products bought.}} {{CGscriptProperties_Template|ReturnType=number|Name=ProductPoints|HasGetter=1|Description=How many points was used for the actual products.}} {{CGscriptProperties_Template|ReturnType=TypeInformation|Name=TypeInformation|HasGetter=1|Description=Get information about this class.}} {{CGscriptProperties_Template|ReturnType=bool|Name=UseGiftPoints|HasGetter=1|Description=Does this user get gift points if a bought product gives some.}} {{CGscriptProperties_Template|ReturnType=string|Name=UserComment|HasGetter=1|Description=Get the comment the buyer wrote.}} {{CGscriptProperties_Template|ReturnType=number|Name=UserId|HasGetter=1|Description=The id of the user ordering.}} }}

← Older revision		Revision as of 07:06, 23 December 2022
Line 16:		Line 16:
	{{CGscriptParameters_Template\|Type=string\|Name=<nowiki>msg</nowiki>\|Description=<nowiki>Message to add.</nowiki>}}		{{CGscriptParameters_Template\|Type=string\|Name=<nowiki>msg</nowiki>\|Description=<nowiki>Message to add.</nowiki>}}
	\|Description=<nowiki>Add an entry to AdminNote automatically appending a newline.</nowiki>}}		\|Description=<nowiki>Add an entry to AdminNote automatically appending a newline.</nowiki>}}
			{{CGscriptMethods_Template\|ReturnType=Empty\|Name=<nowiki>AddNote</nowiki>\|Parameters=
			{{CGscriptParameters_Template\|Type=string\|Name=<nowiki>msg</nowiki>\|Description=<nowiki>Message to add.</nowiki>}}
			\|Description=<nowiki>Append new comment for exist order</nowiki>}}
	{{CGscriptMethods_Template\|ReturnType=bool\|Name=<nowiki>Approve</nowiki>\|Parameters=		{{CGscriptMethods_Template\|ReturnType=bool\|Name=<nowiki>Approve</nowiki>\|Parameters=
	{{CGscriptParameters_Template\|Type=bool\|Name=<nowiki>acceptTestPayment</nowiki>\|Description=<nowiki>If true, test payments will succeed, otherwise an exception is throw if test cards are used</nowiki>}}		{{CGscriptParameters_Template\|Type=bool\|Name=<nowiki>acceptTestPayment</nowiki>\|Description=<nowiki>If true, test payments will succeed, otherwise an exception is throw if test cards are used</nowiki>}}
Line 54:		Line 57:
	{{CGscriptProperties_Template\|ReturnType=int\|Name=<nowiki>OrderPoints</nowiki>\|HasGetter=1\|Description=<nowiki>How many points was used in total.</nowiki>}}		{{CGscriptProperties_Template\|ReturnType=int\|Name=<nowiki>OrderPoints</nowiki>\|HasGetter=1\|Description=<nowiki>How many points was used in total.</nowiki>}}
	{{CGscriptProperties_Template\|ReturnType=string\|Name=<nowiki>OrderStatus</nowiki>\|HasGetter=1\|Description=<nowiki>The current processing status of an order</nowiki>}}		{{CGscriptProperties_Template\|ReturnType=string\|Name=<nowiki>OrderStatus</nowiki>\|HasGetter=1\|Description=<nowiki>The current processing status of an order</nowiki>}}
			{{CGscriptProperties_Template\|ReturnType=number\|Name=<nowiki>PaidCash</nowiki>\|HasGetter=1\|Description=<nowiki>Cash is paid</nowiki>}}
			{{CGscriptProperties_Template\|ReturnType=int\|Name=<nowiki>PaidPoints</nowiki>\|HasGetter=1\|Description=<nowiki>Points is paid</nowiki>}}
	{{CGscriptProperties_Template\|ReturnType=number\|Name=<nowiki>PercentageDiscount</nowiki>\|HasGetter=1\|Description=<nowiki>How much discount does this user get.</nowiki>}}		{{CGscriptProperties_Template\|ReturnType=number\|Name=<nowiki>PercentageDiscount</nowiki>\|HasGetter=1\|Description=<nowiki>How much discount does this user get.</nowiki>}}
	{{CGscriptProperties_Template\|ReturnType=int\|Name=<nowiki>PostagePoints</nowiki>\|HasGetter=1\|Description=<nowiki>How many points was used for postage.</nowiki>}}		{{CGscriptProperties_Template\|ReturnType=int\|Name=<nowiki>PostagePoints</nowiki>\|HasGetter=1\|Description=<nowiki>How many points was used for postage.</nowiki>}}
Line 61:		Line 66:
	{{CGscriptProperties_Template\|ReturnType=bool\|Name=<nowiki>UseGiftPoints</nowiki>\|HasGetter=1\|Description=<nowiki>Does this user get gift points if a bought product gives some.</nowiki>}}		{{CGscriptProperties_Template\|ReturnType=bool\|Name=<nowiki>UseGiftPoints</nowiki>\|HasGetter=1\|Description=<nowiki>Does this user get gift points if a bought product gives some.</nowiki>}}
	{{CGscriptProperties_Template\|ReturnType=string\|Name=<nowiki>UserComment</nowiki>\|HasGetter=1\|HasSetter=1\|Description=<nowiki>Get the comment the buyer wrote.</nowiki>}}		{{CGscriptProperties_Template\|ReturnType=string\|Name=<nowiki>UserComment</nowiki>\|HasGetter=1\|HasSetter=1\|Description=<nowiki>Get the comment the buyer wrote.</nowiki>}}
	{{CGscriptProperties_Template\|ReturnType=int\|Name=<nowiki>UserId</nowiki>\|HasGetter=1\|Description=<nowiki>The id of the user ordering.</nowiki>}}		{{CGscriptProperties_Template\|ReturnType=int\|Name=<nowiki>UserId</nowiki>\|HasGetter=1\|Obsolete=1
			\|Description=<nowiki>The id of the user ordering.</nowiki>}}
			{{CGscriptProperties_Template\|ReturnType=int\|Name=<nowiki>UserResourceId</nowiki>\|HasGetter=1\|Description=<nowiki>The id of the user ordering.</nowiki>}}
	}}		}}

← Older revision		Revision as of 05:26, 11 January 2021
Line 16:		Line 16:
	{{CGscriptParameters_Template\|Type=string\|Name=<nowiki>msg</nowiki>\|Description=<nowiki>Message to add.</nowiki>}}		{{CGscriptParameters_Template\|Type=string\|Name=<nowiki>msg</nowiki>\|Description=<nowiki>Message to add.</nowiki>}}
	\|Description=<nowiki>Add an entry to AdminNote automatically appending a newline.</nowiki>}}		\|Description=<nowiki>Add an entry to AdminNote automatically appending a newline.</nowiki>}}
	~~{{CGscriptMethods_Template\|ReturnType=bool\|Name=<nowiki>Approve</nowiki>\|Description=<nowiki>Order is approve by cashier with default Merchant.</nowiki>}}~~
	{{CGscriptMethods_Template\|ReturnType=bool\|Name=<nowiki>Approve</nowiki>\|Parameters=		{{CGscriptMethods_Template\|ReturnType=bool\|Name=<nowiki>Approve</nowiki>\|Parameters=
	{{CGscriptParameters_Template\|Type=string\|Name=<nowiki>merchantName</nowiki>\|Description=<nowiki>Merchant name to load the appropriate merchant configuration from the web config</nowiki>}}		{{CGscriptParameters_Template\|Type=bool\|Name=<nowiki>acceptTestPayment</nowiki>\|Description=<nowiki>If true, test payments will succeed, otherwise an exception is throw if test cards are used</nowiki>}}
			\|Description=<nowiki>Order is approve by cashier with default Merchant.</nowiki>}}
			{{CGscriptMethods_Template\|ReturnType=bool\|Name=<nowiki>Approve</nowiki>\|Parameters=
			{{CGscriptParameters_Template\|Type=bool\|Name=<nowiki>acceptTestPayment</nowiki>\|Description=<nowiki>If true, test payments will succeed, otherwise an exception is throw if test cards are used</nowiki>\|Comma=,}}{{CGscriptParameters_Template\|Type=string\|Name=<nowiki>merchantName</nowiki>\|Description=<nowiki>Merchant name to load the appropriate merchant configuration from the web config</nowiki>}}
	\|Description=<nowiki>Order is approve by cashier.</nowiki>}}		\|Description=<nowiki>Order is approve by cashier.</nowiki>}}
	{{CGscriptMethods_Template\|ReturnType=string\|Name=<nowiki>ExecuteFromOther</nowiki>\|Parameters=		{{CGscriptMethods_Template\|ReturnType=string\|Name=<nowiki>ExecuteFromOther</nowiki>\|Parameters=