Method | Signature | Comments/Sample |
---|
getBillingAddress1
| string getBillingAddress1()
| |
getBillingAddress2
| string getBillingAddress2()
| |
getBillingCity
| string getBillingCity()
| |
getBillingCompany
| string getBillingCompany()
| |
getBillingCountry
| string getBillingCountry()
| |
getBillingCountry3LetterCode
| string getBillingCountry3LetterCode()
| |
getBillingFirstName
| string getBillingFirstName()
| |
getBillingLastName
| string getBillingLastName()
| |
getBillingPostalCode
| string getBillingPostalCode()
| |
getBillingState
| string getBillingState()
| |
getBuysafeCost | BigDecimal getBuysafeCost() | |
getBuysafeCostFormatted | string getBuysafeCostFormatted() | |
getBuysafeRefunded | BigDecimal getBuysafeRefunded() | |
getBuysafeRefundedFormatted | string getBuysafeRefundedFormatted() | |
getCouponCodes
| string[ ] getCouponCodes()
| |
getCreationDate
| Date getCreationDate()
| |
getCurrencyCode
| string getCurrencyCode()
| |
getCustomField1
| string getCustomField1()
| |
getCustomField2
| string getCustomField2()
| |
getCustomField3
| string getCustomField3()
| |
getCustomField4
| string getCustomField4()
| |
getCustomField5
| string getCustomField5()
| |
getCustomField6
| string getCustomField6()
| |
getCustomField7
| string getCustomField7()
| |
getDeliveryDate
| Date getDeliveryDate()
| |
getDirectTrackProducts
| string getDirectTrackProducts()
| |
getDirectTrackProducts2
| string getDirectTrackProducts2()
| |
getDirectTrackProducts3
| string getDirectTrackProducts3()
| |
getEmail
| string getEmail()
| |
getGiftEmail
| string getGiftEmail()
| |
getGiftMessage | string[] getGiftMessage() | returns an array of the gift message. Each line of the gift message is a maximum of 80 characters long. |
getItemDescriptions
| string getItemDescriptions()
| returns a csv delimited string of item descriptions |
getItemIds
| string getItemIds()
| 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. |
getItemQuantities
| string getItemQuantities()
| returns a csv delimited string of item quantities |
getItems
| OrderItem[] getItems()
| |
getMerchantId
| string getMerchantId()
| |
getOmnitureProducts
| string getOmnitureProducts()
| |
getOmnitureProductsWithShipping
| string getOmnitureProductsWithShipping()
| |
getorderHash
| string getorderHash()
| |
getOrderId
| string getOrderId()
| |
getPaymentDate
| Date getPaymentDate()
| |
getReceiptEmail
| string getReceiptEmail()
| |
getShipping
| string getShipping()
| |
getShippingAddress1
| string getShippingAddress1()
| |
getShippingAddress2
| string getShippingAddress2()
| |
getShippingAsBigDecimal
| BigDecimal getShippingAsBigDecimal()
| |
getShippingCity
| string getShippingCity()
| |
getShippingCompany
| string getShippingCompany()
| |
getShippingCountry
| string getShippingCountry()
| |
getShippingCountry3LetterCode
| string getShippingCountry3LetterCode()
| |
getShippingDate
| Date getShippingDate()
| |
getShippingFirstName
| string getShippingFirstName()
| |
getShippingLastName
| string getShippingLastName()
| |
getShippingPostalCode
| string getShippingPostalCode()
| |
getShippingState
| string getShippingState()
| |
getSubtotal
| string getSubtotal()
| |
getSubtotalAndShipping
| string getSubtotalAndShipping()
| |
getSubtotalAndShippingAsBigDecimal
| BigDecimal getSubtotalAndShippingAsBigDecimal()
| |
getSubtotalAsBigDecimal
| BigDecimal getSubtotalAsBigDecimal()
| |
getSubtotalDiscount
| string getSubtotalDiscount()
| |
getSubtotalDiscountAsBigDecimal
| BigDecimal getSubtotalDiscountAsBigDecimal()
| |
getTax
| string getTax()
| |
getTaxAsBigDecimal
| BigDecimal getTaxAsBigDecimal()
| |
getTextFormat
| string getTextFormat()
| returns the entire order is a huge fixed with text string. Use within <pre> tags |
getTier1AffiliateId
| integer getTier1AffiliateId()
| |
getTotal
| string getTotal()
| |
getTotalAsBigDecimal
| BigDecimal getTotalAsBigDecimal()
| |
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. |
hasItemWithOption
| boolean hasItemWithOption(string itemId, string optionName, string optionValue)
| |
ifPurchased
| boolean ifPurchased(string itemIds)
| itemIds is a csv string of item ids |
isCouponCodeUsed
| boolean isCouponCodeUsed(string code)
| |
isMailingListOptIn
| boolean isMailingListOptIn()
| |
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 $order.isPurchased('ITEM') calls. this method should always wrap those calls to ensure a customer with declined payment does not receive digital goods. Code Block |
---|
#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.
#else
#if($order.isPurchased('ItemA')
Here is your download code: ABCDEFG
#end
#end |
|
isPaymentMethod
| boolean isPaymentMethod(string paymentMethod)
| |
isPrepaidCreditCard
| boolean isPrepaidCreditCard()
| |
isPurchased
| boolean isPurchased(string itemId)
| |
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. |
isTestOrder
| boolean isTestOrder()
| |
prorateItemCost
| BigDecimal prorateItemCost(string itemId, integer expirationDays)
| |
setCustomField1
| void setCustomField1(value)
| this actually updates the order |
setCustomField2
| void setCustomField2(value)
| this actually updates the order |
setCustomField3
| void setCustomField3(value)
| this actually updates the order |
setCustomField4
| void setCustomField4(value)
| this actually updates the order |
setCustomField5
| void setCustomField5(value)
| this actually updates the order |
setCustomField6
| void setCustomField6(value)
| this actually updates the order |
setCustomField7
| void setCustomField7(value)
| this actually updates the order |