Properties
Methods
Method | Signature | Comments/Sample |
---|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
getBuysafeCost | BigDecimal getBuysafeCost() | |
getBuysafeCostFormatted | string getBuysafeCostFormatted() | |
getBuysafeRefunded | BigDecimal getBuysafeRefunded() | |
getBuysafeRefundedFormatted | string getBuysafeRefundedFormatted() | |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
getDiscount | BigDecimal getDiscount() | this is the subtotal discount |
getDiscountFormatted | string getDiscountFormatted | |
|
|
|
getGiftCertificateAmount | BigDecimal getGiftCertificateAmount() | |
getGiftCertificateAmountFormatted | string getGiftCertificateAmountFormatted() | |
getGiftCharge | BigDecimal getGiftCharge() | |
getGiftChargeFormatted | string getGiftChargeFormatted() | |
getGiftWrapCost | BigDecimal getGiftWrapCost() | |
getGiftWrapCostFormatted | string getGiftWrapCostFormatted() | |
|
|
|
getGiftMessage | string[] getGiftMessage() | returns an array of the gift message. Each line of the gift message is a maximum of 80 characters long. |
|
| returns a csv delimited string of item descriptions |
|
| returns a csv delimited string of item ids |
getItemIdsAsJson | string getItemIdsAsJson() | returns a json array of item ids. very useful if you need the cart item ids in a javascript array. |
|
| returns a csv delimited string of item quantities |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
getShippingHandlingDiscount | BigDecimal getShippingHandlingDiscount() | |
getShippingHandlingDiscountFormatted | string getShippingHandlingDiscountFormatted() | |
getShippingHandling | BigDecimal getShippingHandling() | |
getShippingHandlingFormatted | string getShippingHandlingFormatted() | |
getShippingHandlingRefunded | BigDecimal getShippingHandlingRefunded() | |
getShippingHandlingRefundedFormatted | string getShippingHandlingRefundedFormatted() | |
|
|
|
|
|
|
|
|
|
|
|
|
getSubtotalFormatted | string getSubtotalFormatted() | |
getSubtotalBeforeDiscount | BigDecimal getSubtotalBeforeDiscount() | |
getSubtotalBeforeDiscountFormatted | string getSubtotalBeforeDiscountFormatted() | |
|
|
|
|
|
|
getTaxRate | BigDecimal getTaxRate() | |
getTaxRateFormatted | string getTaxRateFormatted() | |
|
|
|
|
|
|
getTotalFormatted | string getTotalFormatted() | |
getTotalRefunded | BigDecimal getTotalRefunded() | |
getTotalRefundedFormatted | string getTotalRefundFormatted() | |
getTrackingNumbers | string[] getTrackingNumbers() | Returns the tracking numbers that are available on the order. |
getTrackingUrl | string getTrackingUrl(string trackingNumber) | Returns the URL that the customer can click to track the given tracking number. Use this in a loop of getTrackingNumbers to output tracking information for the customer on the shipment notification. |
getUnshippedItems | Item[] getUnshippedItems() | Returns the items that have not been shipped on the order. Useful in the shipment notification email. |
|
|
|
|
| itemIds is a csv string of item ids |
|
|
|
|
|
|
isPaymentProcessed | boolean isPaymentProcessed | true if the customer has finalized payment. this is a very important method if you are embedded download links or codes within your receipt using the this method should always wrap those calls to ensure a customer with declined payment does not receive digital goods. #if($order.isPaymentProcessed()) #if($order.isPurchased('ItemA') Here is your download code: ABCDEFG #end #else There was a problem verifying your payment information, please contact our customer support. Thank you. #end |
|
|
|
|
|
|
|
|
|
|
| Checks to see if any of the items on the order were located in the specified folderPath. The folderPath should start and end with / to make sure it's a complete item management folder path. The includeSubFolders parameter is optional and will default to false. |
isShipmentComplete | boolean isShipmentComplete() | Returns true once the order is completely shipped and moved to the completed orders stage. |
isShowBuysafe | boolean isShowBuysafe() | Returns true if the order is bonded with buySAFE. |
|
|
|
|
|
|
|
| this actually updates the order |
|
| this actually updates the order |
|
| this actually updates the order |
|
| this actually updates the order |
|
| this actually updates the order |
|
| this actually updates the order |
|
| this actually updates the order |