Salesforce B2C Commerce 24.7 > B2C Commerce API > B2C Commerce Script > dw.order
dw.order
Class GiftCertificateLineItem
Object
dw.object.PersistentObject
dw.object.ExtensibleObject
dw.order.LineItem
dw.order.GiftCertificateLineItem
Represents a Gift Certificate line item in the cart. When an order is processed, a Gift Certificate is created based on the information in the Gift Certificate line item.
Properties
giftCertificateID  :  String
The ID of the gift certificate that this line item was used to create. If this line item has not been used to create a Gift Certificate, this method returns null.
message  :  String
The message to include in the email of the person receiving the gift certificate line item.
productListItem  :  ProductListItem
The associated ProductListItem.
recipientEmail  :  String
The email address of the person receiving the gift certificate line item.
recipientName  :  String
The name of the person receiving the gift certificate line item.
senderName  :  String
The name of the person or organization that sent the gift certificate line item or null if undefined.
shipment  :  Shipment
The associated Shipment.
Constructor Summary
This class does not have a constructor, so you cannot create it directly.
Method Summary
getGiftCertificateID() : String
Returns the ID of the gift certificate that this line item was used to create.
getMessage() : String
Returns the message to include in the email of the person receiving the gift certificate line item.
getProductListItem() : ProductListItem
Returns the associated ProductListItem.
getRecipientEmail() : String
Returns the email address of the person receiving the gift certificate line item.
getRecipientName() : String
Returns the name of the person receiving the gift certificate line item.
getSenderName() : String
Returns the name of the person or organization that sent the gift certificate line item or null if undefined.
getShipment() : Shipment
Returns the associated Shipment.
setGiftCertificateID(id : String) : void
Sets the ID of the gift certificate associated with this line item.
setMessage(message : String) : void
Sets the message to include in the email of the person receiving the gift certificate line item.
setProductListItem(productListItem : ProductListItem) : void
Sets the associated ProductListItem.
setRecipientEmail(recipientEmail : String) : void
Sets the email address of the person receiving the gift certificate line item.
setRecipientName(recipient : String) : void
Sets the name of the person receiving the gift certificate line item.
setSenderName(sender : String) : void
Sets the name of the person or organization that sent the gift certificate line item.
setShipment(shipment : Shipment) : void
Associates the gift certificate line item with the specified shipment.
Methods inherited from class LineItem
getBasePrice, getGrossPrice, getLineItemCtnr, getLineItemText, getNetPrice, getPrice, getPriceValue, getTax, getTaxBasis, getTaxClassID, getTaxRate, setBasePrice, setGrossPrice, setLineItemText, setNetPrice, setPriceValue, setTax, setTaxClassID, setTaxRate, updatePrice, updateTax, updateTax, updateTaxAmount
Methods inherited from class ExtensibleObject
describe, getCustom
Methods inherited from class PersistentObject
getCreationDate, getLastModified, getUUID
Methods inherited from class Object
assign, create, create, defineProperties, defineProperty, entries, freeze, fromEntries, getOwnPropertyDescriptor, getOwnPropertyNames, getOwnPropertySymbols, getPrototypeOf, hasOwnProperty, is, isExtensible, isFrozen, isPrototypeOf, isSealed, keys, preventExtensions, propertyIsEnumerable, seal, setPrototypeOf, toLocaleString, toString, valueOf, values
Method Detail
getGiftCertificateID
getGiftCertificateID() : String
Returns the ID of the gift certificate that this line item was used to create. If this line item has not been used to create a Gift Certificate, this method returns null.
Returns:
the ID of the gift certificate or null if undefined.
getMessage
getMessage() : String
Returns the message to include in the email of the person receiving the gift certificate line item.
Returns:
the message to include in the email of the person receiving the gift certificate line item.
getProductListItem
getProductListItem() : ProductListItem
Returns the associated ProductListItem.
Returns:
item or null.
getRecipientEmail
getRecipientEmail() : String
Returns the email address of the person receiving the gift certificate line item.
Returns:
the email address of the person receiving the gift certificate line item.
getRecipientName
getRecipientName() : String
Returns the name of the person receiving the gift certificate line item.
Returns:
the name of the person receiving the gift certificate line item.
getSenderName
getSenderName() : String
Returns the name of the person or organization that sent the gift certificate line item or null if undefined.
Returns:
the name of the person or organization that sent the gift certificate line item or null if undefined.
getShipment
getShipment() : Shipment
Returns the associated Shipment.
Returns:
The shipment of the gift certificate line item
setGiftCertificateID
setGiftCertificateID(id : String) : void
Sets the ID of the gift certificate associated with this line item.
Parameters:
id - the ID of the gift certificate associated with this line item.
setMessage
setMessage(message : String) : void
Sets the message to include in the email of the person receiving the gift certificate line item.
Parameters:
message - the message to include in the email of the person receiving the gift certificate line item.
setProductListItem
setProductListItem(productListItem : ProductListItem) : void
Sets the associated ProductListItem.

The product list item to be set must be of type gift certificate otherwise an exception is thrown.

Parameters:
productListItem - the product list item to be associated
setRecipientEmail
setRecipientEmail(recipientEmail : String) : void
Sets the email address of the person receiving the gift certificate line item.
Parameters:
recipientEmail - the email address of the person receiving the gift certificate line item.
setRecipientName
setRecipientName(recipient : String) : void
Sets the name of the person receiving the gift certificate line item.
Parameters:
recipient - the name of the person receiving the gift certificate line item.
setSenderName
setSenderName(sender : String) : void
Sets the name of the person or organization that sent the gift certificate line item.
Parameters:
sender - the name of the person or organization that sent the gift certificate line item.
setShipment
setShipment(shipment : Shipment) : void
Associates the gift certificate line item with the specified shipment.
Gift certificate line item and shipment must belong to the same line item ctnr.
Parameters:
shipment - The new shipment of the gift certificate line item

Infocenter Retirement: On June 30, 2023, the Infocenter was retired, and documentation currently hosted on the Infocenter will be published to Salesforce Help, Commerce Cloud Developer Center, and Salesforce B2C Commerce Developer Documentation Resources. For more information, see the release note.