Class Shipment

Represents an order shipment.

Constant Summary 
ConstantDescription
SHIPMENT_NOTSHIPPED: Number = 0Shipment shipping status representing ‘Not shipped’.
SHIPMENT_SHIPPED: Number = 2Shipment shipping status representing ‘Shipped’.
SHIPPING_STATUS_NOTSHIPPED: Number = 0Shipment shipping status representing ‘Not shipped’.
SHIPPING_STATUS_SHIPPED: Number = 2Shipment shipping status representing ‘Shipped’.

Property Summary 
PropertyDescription
ID: String (read-only)Returns the ID of this shipment (“me” for the default shipment).
adjustedMerchandizeTotalGrossPrice: Money (read-only)Returns the adjusted total gross price, including tax, in the purchase currency.
adjustedMerchandizeTotalNetPrice: Money (read-only)Returns the adjusted net price, excluding tax, in the purchase currency.
adjustedMerchandizeTotalPrice: Money (read-only)Returns the product total price after all product discounts.
adjustedMerchandizeTotalTax: Money (read-only)Returns the total adjusted product tax in the purchase currency.
adjustedShippingTotalGrossPrice: Money (read-only)Returns the adjusted sum of all shipping line items of the shipment, including shipping adjustuments and tax
adjustedShippingTotalNetPrice: Money (read-only)Returns the sum of all shipping line items of the shipment, including shipping adjustments, excluding tax.
adjustedShippingTotalPrice: Money (read-only)Returns the adjusted shipping total price.
adjustedShippingTotalTax: Money (read-only)Returns the tax of all shipping line items of the shipment , including shipping adjustments.
allLineItems: Collection (read-only)Returns all line items related to the shipment.
default: Boolean (read-only)Return true if this shipment is the default shipment (shipment ID “me”).
gift: BooleanReturns true if this line item represents a gift, false otherwise.
giftCertificateLineItems: Collection (read-only)Returns all gift certificate line items of the shipment.
giftMessage: StringReturns the value set for gift message or null if no value set.
merchandizeTotalGrossPrice: Money (read-only)Returns the gross product subtotal in the purchase currency.
merchandizeTotalNetPrice: Money (read-only)Returns the net product subtotal, excluding tax, in the purchase currency.
merchandizeTotalPrice: Money (read-only)Returns the product total price.
merchandizeTotalPriceAdjustments: Collection (read-only)Returns a collection of price adjustments that have been applied to the totals, such as a promotion on the purchase value (i.e.
merchandizeTotalTax: Money (read-only)Returns the total product tax in the purchase currency.
productLineItems: Collection (read-only)Returns a collection of all product line items related to this shipment.
proratedMerchandizeTotalPrice: Money (read-only)Returns the total product price of the shipment, including product-level adjustments and prorating all Buy-X-Get-Y and order-level adjustments, according to the scheme described in PriceAdjustment.getProratedPrices().
shipmentNo: String (read-only)Returns the shipment number for this shipment.
shippingAddress: OrderAddress (read-only)Returns the shipping address or null if none is set.
shippingLineItems: Collection (read-only)Returns a collection of all shipping line items of the shipment, excluding any product-level shipping costs that are associated with ProductLineItems of the shipment.
shippingMethod: ShippingMethodReturns the shipping method or null if none is set.
shippingMethodID: String (read-only)Returns the shipping method ID or null if none is set.
shippingPriceAdjustments: Collection (read-only)Returns a collection of price adjustments that have been applied to the shipping costs of the shipment, for example by the promotions engine.
Note that this method returns all shipping price adjustments in this shipment, regardless of which shipping line item they belong to.
shippingStatus: EnumValueReturns the shipping status.
shippingTotalGrossPrice: Money (read-only)Returns the sum of all shipping line items of the shipment, including tax, excluding shipping adjustments.
shippingTotalNetPrice: Money (read-only)Returns the sum of all shipping line items of the shipment, excluding tax and adjustments.
shippingTotalPrice: Money (read-only)Returns the shipping total price.
shippingTotalTax: Money (read-only)Returns the tax of all shipping line items of the shipment before shipping adjustments have been applied.
standardShippingLineItem: ShippingLineItem (read-only)Convenience method.
totalGrossPrice: Money (read-only)Returns the total gross price of the shipment in the purchase currency.
totalNetPrice: Money (read-only)Returns the total net price of the shipment in the purchase currency.
totalTax: Money (read-only)Returns the total tax for the shipment in the purchase currency.
trackingNumber: StringReturns the tracking number of this shipment.

Constructor Summary 

This class does not have a constructor, so you cannot create it directly.

Method Summary 
MethodDescription
createShippingAddress()A shipment has initially no shipping address.
createShippingLineItem(String)Creates a new shipping line item for this shipment.
createShippingPriceAdjustment(String)Creates a shipping price adjustment to be applied to the shipment.
getAdjustedMerchandizeTotalGrossPrice()Returns the adjusted total gross price, including tax, in the purchase currency.
getAdjustedMerchandizeTotalNetPrice()Returns the adjusted net price, excluding tax, in the purchase currency.
getAdjustedMerchandizeTotalPrice()Returns the product total price after all product discounts.
getAdjustedMerchandizeTotalPrice(Boolean)Returns the total product price including product-level adjustments and, optionally, prorated order-level adjustments.
getAdjustedMerchandizeTotalTax()Returns the total adjusted product tax in the purchase currency.
getAdjustedShippingTotalGrossPrice()Returns the adjusted sum of all shipping line items of the shipment, including shipping adjustuments and tax
getAdjustedShippingTotalNetPrice()Returns the sum of all shipping line items of the shipment, including shipping adjustments, excluding tax.
getAdjustedShippingTotalPrice()Returns the adjusted shipping total price.
getAdjustedShippingTotalTax()Returns the tax of all shipping line items of the shipment , including shipping adjustments.
getAllLineItems()Returns all line items related to the shipment.
getGiftCertificateLineItems()Returns all gift certificate line items of the shipment.
getGiftMessage()Returns the value set for gift message or null if no value set.
getID()Returns the ID of this shipment (“me” for the default shipment).
getMerchandizeTotalGrossPrice()Returns the gross product subtotal in the purchase currency.
getMerchandizeTotalNetPrice()Returns the net product subtotal, excluding tax, in the purchase currency.
getMerchandizeTotalPrice()Returns the product total price.
getMerchandizeTotalPriceAdjustments()Returns a collection of price adjustments that have been applied to the totals, such as a promotion on the purchase value (i.e.
getMerchandizeTotalTax()Returns the total product tax in the purchase currency.
getProductLineItems()Returns a collection of all product line items related to this shipment.
getProratedMerchandizeTotalPrice()Returns the total product price of the shipment, including product-level adjustments and prorating all Buy-X-Get-Y and order-level adjustments, according to the scheme described in PriceAdjustment.getProratedPrices().
getShipmentNo()Returns the shipment number for this shipment.
getShippingAddress()Returns the shipping address or null if none is set.
getShippingLineItem(String)Returns the shipping line item identified by the specified ID, or null if not found.
getShippingLineItems()Returns a collection of all shipping line items of the shipment, excluding any product-level shipping costs that are associated with ProductLineItems of the shipment.
getShippingMethod()Returns the shipping method or null if none is set.
getShippingMethodID()Returns the shipping method ID or null if none is set.
getShippingPriceAdjustmentByPromotionID(String)Returns the shipping price adjustment associated with the specified promotion ID.
getShippingPriceAdjustments()Returns a collection of price adjustments that have been applied to the shipping costs of the shipment, for example by the promotions engine.
Note that this method returns all shipping price adjustments in this shipment, regardless of which shipping line item they belong to.
getShippingStatus()Returns the shipping status.
getShippingTotalGrossPrice()Returns the sum of all shipping line items of the shipment, including tax, excluding shipping adjustments.
getShippingTotalNetPrice()Returns the sum of all shipping line items of the shipment, excluding tax and adjustments.
getShippingTotalPrice()Returns the shipping total price.
getShippingTotalTax()Returns the tax of all shipping line items of the shipment before shipping adjustments have been applied.
getStandardShippingLineItem()Convenience method.
getTotalGrossPrice()Returns the total gross price of the shipment in the purchase currency.
getTotalNetPrice()Returns the total net price of the shipment in the purchase currency.
getTotalTax()Returns the total tax for the shipment in the purchase currency.
getTrackingNumber()Returns the tracking number of this shipment.
isDefault()Return true if this shipment is the default shipment (shipment ID “me”).
isGift()Returns true if this line item represents a gift, false otherwise.
removeShippingLineItem(ShippingLineItem)Removes the specified shipping line item and any of its dependent shipping price adjustments.
removeShippingPriceAdjustment(PriceAdjustment)Removes the specified shipping price adjustment from the shipment.
setGift(Boolean)Controls if this line item is a gift or not.
setGiftMessage(String)Sets the value to set for the gift message.
setShippingMethod(ShippingMethod)Set the specified shipping method for the specified shipment.
setShippingStatus(Number)Sets the shipping status of the shipment.
setTrackingNumber(String)Sets the tracking number of this shipment.

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

Constant Details 

SHIPMENT_NOTSHIPPED 
SHIPMENT_NOTSHIPPED: Number = 0

Shipment shipping status representing 'Not shipped'.

Deprecated:

Use SHIPPING_STATUS_NOTSHIPPED instead.

Warning

SHIPMENT_SHIPPED 
SHIPMENT_SHIPPED: Number = 2

Shipment shipping status representing 'Shipped'.

Deprecated:

Use SHIPPING_STATUS_SHIPPED instead.

Warning

SHIPPING_STATUS_NOTSHIPPED 
SHIPPING_STATUS_NOTSHIPPED: Number = 0

Shipment shipping status representing 'Not shipped'.

SHIPPING_STATUS_SHIPPED 
SHIPPING_STATUS_SHIPPED: Number = 2

Shipment shipping status representing 'Shipped'.

Property Details 

ID 
ID: String (read-only)

Returns the ID of this shipment ("me" for the default shipment).

adjustedMerchandizeTotalGrossPrice 
adjustedMerchandizeTotalGrossPrice: Money (read-only)

Returns the adjusted total gross price, including tax, in the purchase currency. The adjusted total gross price represents the sum of product prices and adjustments including tax, excluding services.

adjustedMerchandizeTotalNetPrice 
adjustedMerchandizeTotalNetPrice: Money (read-only)

Returns the adjusted net price, excluding tax, in the purchase currency. The adjusted net price represents the the sum of product prices and adjustments, excluding services and tax.

adjustedMerchandizeTotalPrice 
adjustedMerchandizeTotalPrice: Money (read-only)

Returns the product total price after all product discounts. If the line item container is based on net pricing the adjusted product total net price is returned. If the line item container is based on gross pricing the adjusted product total gross price is returned.

adjustedMerchandizeTotalTax 
adjustedMerchandizeTotalTax: Money (read-only)

Returns the total adjusted product tax in the purchase currency. The total adjusted product tax represents the tax on products and adjustments, excluding services.

adjustedShippingTotalGrossPrice 
adjustedShippingTotalGrossPrice: Money (read-only)

Returns the adjusted sum of all shipping line items of the shipment, including shipping adjustuments and tax

adjustedShippingTotalNetPrice 
adjustedShippingTotalNetPrice: Money (read-only)

Returns the sum of all shipping line items of the shipment, including shipping adjustments, excluding tax.

adjustedShippingTotalPrice 
adjustedShippingTotalPrice: Money (read-only)

Returns the adjusted shipping total price. If the line item container is based on net pricing the adjusted shipping total net price is returned. If the line item container is based on gross pricing the adjusted shipping total gross price is returned.

adjustedShippingTotalTax 
adjustedShippingTotalTax: Money (read-only)

Returns the tax of all shipping line items of the shipment , including shipping adjustments.

allLineItems 
allLineItems: Collection (read-only)

Returns all line items related to the shipment.

The returned collection may include line items of the following types:

Their common type is LineItem.

Each ProductLineItem in the collection may itself contain bundled or option product line items, as well as a product-level shipping line item.

default 
default: Boolean (read-only)

Return true if this shipment is the default shipment (shipment ID "me").

gift 
gift: Boolean

Returns true if this line item represents a gift, false otherwise.

giftCertificateLineItems 
giftCertificateLineItems: Collection (read-only)

Returns all gift certificate line items of the shipment.

giftMessage 
giftMessage: String

Returns the value set for gift message or null if no value set.

merchandizeTotalGrossPrice 
merchandizeTotalGrossPrice: Money (read-only)

Returns the gross product subtotal in the purchase currency. The gross product subtotal represents the sum of product prices including tax, excluding services and adjustments.

merchandizeTotalNetPrice 
merchandizeTotalNetPrice: Money (read-only)

Returns the net product subtotal, excluding tax, in the purchase currency. The net product subtotal represents the sum of product prices, excluding services, adjustments, and tax.

merchandizeTotalPrice 
merchandizeTotalPrice: Money (read-only)

Returns the product total price. If the line item container is based on net pricing the product total net price is returned. If the line item container is based on gross pricing the product total gross price is returned.

merchandizeTotalPriceAdjustments 
merchandizeTotalPriceAdjustments: Collection (read-only)

Returns a collection of price adjustments that have been applied to the totals, such as a promotion on the purchase value (i.e. $10 Off or 10% Off).

Deprecated:

Shipments cannot have product price adjustments, therefore this method will always return an empty collection

Warning

merchandizeTotalTax 
merchandizeTotalTax: Money (read-only)

Returns the total product tax in the purchase currency. The total product tax represents the tax on products, excluding services and adjustments.

productLineItems 
productLineItems: Collection (read-only)

Returns a collection of all product line items related to this shipment.

proratedMerchandizeTotalPrice 
proratedMerchandizeTotalPrice: Money (read-only)

Returns the total product price of the shipment, including product-level adjustments and prorating all Buy-X-Get-Y and order-level adjustments, according to the scheme described in PriceAdjustment.getProratedPrices(). For net pricing the net price is returned. For gross pricing, the gross price is returned.

shipmentNo 
shipmentNo: String (read-only)

Returns the shipment number for this shipment.

When an order is placed (OrderMgr.placeOrder(Order)) shipment number will be filled using a sequence. Before order was placed null will be returned.

shippingAddress 
shippingAddress: OrderAddress (read-only)

Returns the shipping address or null if none is set.

shippingLineItems 
shippingLineItems: Collection (read-only)

Returns a collection of all shipping line items of the shipment, excluding any product-level shipping costs that are associated with ProductLineItems of the shipment.

shippingMethod 
shippingMethod: ShippingMethod

Returns the shipping method or null if none is set.

shippingMethodID 
shippingMethodID: String (read-only)

Returns the shipping method ID or null if none is set.

shippingPriceAdjustments 
shippingPriceAdjustments: Collection (read-only)

Returns a collection of price adjustments that have been applied to the shipping costs of the shipment, for example by the promotions engine.

Note that this method returns all shipping price adjustments in this shipment, regardless of which shipping line item they belong to. Use ShippingLineItem.getShippingPriceAdjustments() to retrieve the shipping price adjustments associated with a specific shipping line item.

shippingStatus 
shippingStatus: EnumValue

Returns the shipping status. Possible values are SHIPMENT_NOTSHIPPED or SHIPMENT_SHIPPED.

shippingTotalGrossPrice 
shippingTotalGrossPrice: Money (read-only)

Returns the sum of all shipping line items of the shipment, including tax, excluding shipping adjustments.

shippingTotalNetPrice 
shippingTotalNetPrice: Money (read-only)

Returns the sum of all shipping line items of the shipment, excluding tax and adjustments.

shippingTotalPrice 
shippingTotalPrice: Money (read-only)

Returns the shipping total price. If the line item container is based on net pricing the shipping total net price is returned. If the line item container is based on gross pricing the shipping total gross price is returned.

shippingTotalTax 
shippingTotalTax: Money (read-only)

Returns the tax of all shipping line items of the shipment before shipping adjustments have been applied.

standardShippingLineItem 
standardShippingLineItem: ShippingLineItem (read-only)

Convenience method. Same as getShippingLineItem(ShippingLineItem.STANDARD_SHIPPING_ID)

totalGrossPrice 
totalGrossPrice: Money (read-only)

Returns the total gross price of the shipment in the purchase currency. The total gross price is the sum of product prices, service prices, adjustments, and tax.

totalNetPrice 
totalNetPrice: Money (read-only)

Returns the total net price of the shipment in the purchase currency. The total net price is the sum of product prices, service prices, and adjustments, excluding tax.

totalTax 
totalTax: Money (read-only)

Returns the total tax for the shipment in the purchase currency.

trackingNumber 
trackingNumber: String

Returns the tracking number of this shipment.

Method Details 

createShippingAddress() 
createShippingAddress(): OrderAddress

A shipment has initially no shipping address. This method creates a shipping address for the shipment and replaces an existing shipping address.

Returns:

  • The new shipping address of the shipment

createShippingLineItem(String) 
createShippingLineItem(id: String): ShippingLineItem

Creates a new shipping line item for this shipment. If the specified ID is already assigned to any of the existing shipping line items of the shipment, the method throws an exception.

Parameters:

  • id - The id to use to locate the new shipping line item.

Returns:

  • The new shipping line item.

createShippingPriceAdjustment(String) 
createShippingPriceAdjustment(promotionID: String): PriceAdjustment

Creates a shipping price adjustment to be applied to the shipment. The price adjustment implicitly belongs to the standard shipping line item if this line item exists, otherwise it belongs to the shipment itself.

The promotion ID is mandatory and must not be the ID of any actual promotion defined in Salesforce B2C Commerce.

If there already exists a shipping price adjustment line item referring to the specified promotion ID, an exception is thrown.

Parameters:

  • promotionID - Promotion ID

Returns:

  • The new price adjustment line item.

Deprecated:

Deprecated in favor of ShippingLineItem.createShippingPriceAdjustment(String), which explicitly relates the price adjustment to a shipping line item.

Warning

getAdjustedMerchandizeTotalGrossPrice() 
getAdjustedMerchandizeTotalGrossPrice(): Money

Returns the adjusted total gross price, including tax, in the purchase currency. The adjusted total gross price represents the sum of product prices and adjustments including tax, excluding services.

Returns:

  • the adjusted total gross price, including tax, in the purchase currency.

getAdjustedMerchandizeTotalNetPrice() 
getAdjustedMerchandizeTotalNetPrice(): Money

Returns the adjusted net price, excluding tax, in the purchase currency. The adjusted net price represents the the sum of product prices and adjustments, excluding services and tax.

Returns:

  • the adjusted net price, excluding tax, in the purchase currency.

getAdjustedMerchandizeTotalPrice() 
getAdjustedMerchandizeTotalPrice(): Money

Returns the product total price after all product discounts. If the line item container is based on net pricing the adjusted product total net price is returned. If the line item container is based on gross pricing the adjusted product total gross price is returned.

Returns:

  • either the adjusted product total net or gross price.

getAdjustedMerchandizeTotalPrice(Boolean) 
getAdjustedMerchandizeTotalPrice(applyOrderLevelAdjustments: Boolean): Money

Returns the total product price including product-level adjustments and, optionally, prorated order-level adjustments. For net pricing the net price is returned. For gross pricing, the gross price is returned.

Parameters:

  • applyOrderLevelAdjustments - If true, prorated order-level adjustments will be applied to total price

Returns:

  • Adjusted net or gross product total price

See Also:

getAdjustedMerchandizeTotalTax() 
getAdjustedMerchandizeTotalTax(): Money

Returns the total adjusted product tax in the purchase currency. The total adjusted product tax represents the tax on products and adjustments, excluding services.

Returns:

  • the total tax in purchase currency.

getAdjustedShippingTotalGrossPrice() 
getAdjustedShippingTotalGrossPrice(): Money

Returns the adjusted sum of all shipping line items of the shipment, including shipping adjustuments and tax

Returns:

  • the adjusted sum of all shipping line items of the shipment, including shipping adjustuments and tax

getAdjustedShippingTotalNetPrice() 
getAdjustedShippingTotalNetPrice(): Money

Returns the sum of all shipping line items of the shipment, including shipping adjustments, excluding tax.

Returns:

  • the sum of all shipping line items of the shipment, including shipping adjustments, excluding tax.

getAdjustedShippingTotalPrice() 
getAdjustedShippingTotalPrice(): Money

Returns the adjusted shipping total price. If the line item container is based on net pricing the adjusted shipping total net price is returned. If the line item container is based on gross pricing the adjusted shipping total gross price is returned.

Returns:

  • either the adjusted shipping total net or gross price

getAdjustedShippingTotalTax() 
getAdjustedShippingTotalTax(): Money

Returns the tax of all shipping line items of the shipment , including shipping adjustments.

Returns:

  • the tax of all shipping line items of the shipment , including shipping adjustments.

getAllLineItems() 
getAllLineItems(): Collection

Returns all line items related to the shipment.

The returned collection may include line items of the following types:

Their common type is LineItem.

Each ProductLineItem in the collection may itself contain bundled or option product line items, as well as a product-level shipping line item.

Returns:

  • all line items related to ths shipment.

getGiftCertificateLineItems() 
getGiftCertificateLineItems(): Collection

Returns all gift certificate line items of the shipment.

Returns:

  • A collection of all GiftCertificateLineItems of the shipment.

getGiftMessage() 
getGiftMessage(): String

Returns the value set for gift message or null if no value set.

Returns:

  • the value set for gift message or null if no value set.

getID() 
getID(): String

Returns the ID of this shipment ("me" for the default shipment).

Returns:

  • the ID of this shipment

getMerchandizeTotalGrossPrice() 
getMerchandizeTotalGrossPrice(): Money

Returns the gross product subtotal in the purchase currency. The gross product subtotal represents the sum of product prices including tax, excluding services and adjustments.

Returns:

  • the total gross price, including tax, in the purchase currency.

getMerchandizeTotalNetPrice() 
getMerchandizeTotalNetPrice(): Money

Returns the net product subtotal, excluding tax, in the purchase currency. The net product subtotal represents the sum of product prices, excluding services, adjustments, and tax.

Returns:

  • the net price, excluding tax, in the purchase currency.

getMerchandizeTotalPrice() 
getMerchandizeTotalPrice(): Money

Returns the product total price. If the line item container is based on net pricing the product total net price is returned. If the line item container is based on gross pricing the product total gross price is returned.

Returns:

  • either the product total net or gross price

getMerchandizeTotalPriceAdjustments() 
getMerchandizeTotalPriceAdjustments(): Collection

Returns a collection of price adjustments that have been applied to the totals, such as a promotion on the purchase value (i.e. $10 Off or 10% Off).

Returns:

  • a collection of price adjustments that have been applied to the totals, such as a promotion on the purchase value (i.e. $10 Off or 10% Off).

Deprecated:

Shipments cannot have product price adjustments, therefore this method will always return an empty collection

Warning

getMerchandizeTotalTax() 
getMerchandizeTotalTax(): Money

Returns the total product tax in the purchase currency. The total product tax represents the tax on products, excluding services and adjustments.

Returns:

  • the total tax in purchase currency.

getProductLineItems() 
getProductLineItems(): Collection

Returns a collection of all product line items related to this shipment.

Returns:

  • a collection of all product line items related to this shipment.

getProratedMerchandizeTotalPrice() 
getProratedMerchandizeTotalPrice(): Money

Returns the total product price of the shipment, including product-level adjustments and prorating all Buy-X-Get-Y and order-level adjustments, according to the scheme described in PriceAdjustment.getProratedPrices(). For net pricing the net price is returned. For gross pricing, the gross price is returned.

Returns:

  • Adjusted and prorated net or gross product total price

getShipmentNo() 
getShipmentNo(): String

Returns the shipment number for this shipment.

When an order is placed (OrderMgr.placeOrder(Order)) shipment number will be filled using a sequence. Before order was placed null will be returned.

Returns:

  • the shipment number for this shipment.

getShippingAddress() 
getShippingAddress(): OrderAddress

Returns the shipping address or null if none is set.

Returns:

  • the shipping address or null if none is set.

getShippingLineItem(String) 
getShippingLineItem(id: String): ShippingLineItem

Returns the shipping line item identified by the specified ID, or null if not found.

To get the standard shipping line item for this shipment, use the identifier ShippingLineItem.STANDARD_SHIPPING_ID.

Parameters:

  • id - the identifier to use to locate the shipping line item.

Returns:

  • the shipping line item identified by the specified ID, or null if not found.

getShippingLineItems() 
getShippingLineItems(): Collection

Returns a collection of all shipping line items of the shipment, excluding any product-level shipping costs that are associated with ProductLineItems of the shipment.

Returns:

  • a collection of all shipping line items of the shipment, excluding any product-level shipping costs.

getShippingMethod() 
getShippingMethod(): ShippingMethod

Returns the shipping method or null if none is set.

Returns:

  • the shipping method or null if none is set.

getShippingMethodID() 
getShippingMethodID(): String

Returns the shipping method ID or null if none is set.

Returns:

  • the shipping method ID or null if none is set.

getShippingPriceAdjustmentByPromotionID(String) 
getShippingPriceAdjustmentByPromotionID(promotionID: String): PriceAdjustment

Returns the shipping price adjustment associated with the specified promotion ID.

Parameters:

  • promotionID - the promotion ID

Returns:

  • The price adjustment associated with the given promotion ID

getShippingPriceAdjustments() 
getShippingPriceAdjustments(): Collection

Returns a collection of price adjustments that have been applied to the shipping costs of the shipment, for example by the promotions engine.

Note that this method returns all shipping price adjustments in this shipment, regardless of which shipping line item they belong to. Use ShippingLineItem.getShippingPriceAdjustments() to retrieve the shipping price adjustments associated with a specific shipping line item.

Returns:

  • a collection of price adjustments that have been applied to the shipping costs of the shipment.

getShippingStatus() 
getShippingStatus(): EnumValue

Returns the shipping status. Possible values are SHIPMENT_NOTSHIPPED or SHIPMENT_SHIPPED.

Returns:

  • the shipping status. Possible values are SHIPMENT_NOTSHIPPED or SHIPMENT_SHIPPED.

getShippingTotalGrossPrice() 
getShippingTotalGrossPrice(): Money

Returns the sum of all shipping line items of the shipment, including tax, excluding shipping adjustments.

Returns:

  • the sum of all shipping line items of the shipment, including tax, excluding shipping adjustments.

getShippingTotalNetPrice() 
getShippingTotalNetPrice(): Money

Returns the sum of all shipping line items of the shipment, excluding tax and adjustments.

Returns:

  • the sum of all shipping line items of the shipment, excluding tax and adjustments.

getShippingTotalPrice() 
getShippingTotalPrice(): Money

Returns the shipping total price. If the line item container is based on net pricing the shipping total net price is returned. If the line item container is based on gross pricing the shipping total gross price is returned.

Returns:

  • either the shipping total net or gross price

getShippingTotalTax() 
getShippingTotalTax(): Money

Returns the tax of all shipping line items of the shipment before shipping adjustments have been applied.

Returns:

  • the tax of all shipping line items of the shipment before shipping adjustments have been applied.

getStandardShippingLineItem() 
getStandardShippingLineItem(): ShippingLineItem

Convenience method. Same as getShippingLineItem(ShippingLineItem.STANDARD_SHIPPING_ID)

Returns:

  • The standard shipping line item, or null if it does not exist.

getTotalGrossPrice() 
getTotalGrossPrice(): Money

Returns the total gross price of the shipment in the purchase currency. The total gross price is the sum of product prices, service prices, adjustments, and tax.

Returns:

  • the grand total price gross of tax for the shipment, in purchase currency.

getTotalNetPrice() 
getTotalNetPrice(): Money

Returns the total net price of the shipment in the purchase currency. The total net price is the sum of product prices, service prices, and adjustments, excluding tax.

Returns:

  • the grand total price for the shipment net of tax, in purchase currency.

getTotalTax() 
getTotalTax(): Money

Returns the total tax for the shipment in the purchase currency.

Returns:

  • the total tax for the shipment, in purchase currency.

getTrackingNumber() 
getTrackingNumber(): String

Returns the tracking number of this shipment.

Returns:

  • the tracking number of this shipment.

isDefault() 
isDefault(): Boolean

Return true if this shipment is the default shipment (shipment ID "me").

Returns:

  • true if this shipment is the default shipment

isGift() 
isGift(): Boolean

Returns true if this line item represents a gift, false otherwise.

Returns:

  • true if this line item represents a gift, false otherwise.

removeShippingLineItem(ShippingLineItem) 
removeShippingLineItem(shippingLineItem: ShippingLineItem): void

Removes the specified shipping line item and any of its dependent shipping price adjustments.

Parameters:

  • shippingLineItem - The shipping line item to be removed.

removeShippingPriceAdjustment(PriceAdjustment) 
removeShippingPriceAdjustment(priceAdjustment: PriceAdjustment): void

Removes the specified shipping price adjustment from the shipment.

Parameters:

  • priceAdjustment - The price adjustment line item to remove

Deprecated:

Deprecated in favor of ShippingLineItem.removeShippingPriceAdjustment(PriceAdjustment) since shipping price adjustments belong to a specific shipping line item.

Warning

setGift(Boolean) 
setGift(isGift: Boolean): void

Controls if this line item is a gift or not.

Parameters:

  • isGift - set to true if you want this line item to represent a gift.

setGiftMessage(String) 
setGiftMessage(message: String): void

Sets the value to set for the gift message.

Parameters:

  • message - the value to set for the gift message.

setShippingMethod(ShippingMethod) 
setShippingMethod(method: ShippingMethod): void

Set the specified shipping method for the specified shipment.

Parameters:

  • method - the shipping method to use.

setShippingStatus(Number) 
setShippingStatus(status: Number): void

Sets the shipping status of the shipment.

Possible values are SHIPPING_STATUS_NOTSHIPPED or SHIPPING_STATUS_SHIPPED.

Parameters:

  • status - Shipment shipping status

setTrackingNumber(String) 
setTrackingNumber(aValue: String): void

Sets the tracking number of this shipment.

Parameters:

  • aValue - the tracking number of this shipment.

Open Commerce API (deprecated)
Shop Baskets (deprecated)
Shop Categories (deprecated)
Shop Content (deprecated)
Shop Content Search (deprecated)
Shop Custom Objects (deprecated)
Shop Customers (deprecated)
Shop Folders (deprecated)
Shop Gift Certificate (deprecated)
Shop Order Search (deprecated)
Shop Orders (deprecated)
Shop Price Adjustment Limits (deprecated)
Shop Product Lists (deprecated)
Shop Product Search (deprecated)
Shop Products (deprecated)
Shop Promotions (deprecated)
Shop Search Suggestion (deprecated)
Shop Sessions (deprecated)
Shop Site (deprecated)
Shop Stores (deprecated)
Data A/B Test Search (deprecated)
Data A/B Tests (deprecated)
Data Alerts (deprecated)
Data Campaign Search (deprecated)
Data Campaigns (deprecated)
Data Cartridges (deprecated)
Data Catalog Search (deprecated)
Data Catalogs (deprecated)
Data Category Search (deprecated)
Data Code Versions (deprecated)
Data Coupon Redemption Search (deprecated)
Data Coupon Search (deprecated)
Data Coupons (deprecated)
Data Custom Object Definitions (deprecated)
Data Custom Objects (deprecated)
Data Custom Objects Search (deprecated)
Data Customer Group Search (deprecated)
Data Customer Groups (deprecated)
Data Customer Lists (deprecated)
Data Gift Certificate Search (deprecated)
Data Gift Certificates (deprecated)
Data Global Custom Objects (deprecated)
Data Global Locale Info (deprecated)
Data Global Preferences (deprecated)
Data Global Site Preferences (deprecated)
Data Inventory List Search (deprecated)
Data Inventory Lists (deprecated)
Data Job Execution Search (deprecated)
Data Jobs (deprecated)
Data Libraries (deprecated)
Data Locale Info (deprecated)
Data Log Requests (deprecated)
Data Metrics (deprecated)
Data OCAPI Configs (deprecated)
Data Orders (deprecated)
Data Permissions (deprecated)
Data Product Search (deprecated)
Data Products (deprecated)
Data Promotion Campaign Assignment Search (deprecated)
Data Promotion Search (deprecated)
Data Promotions (deprecated)
Data Recommender Names (deprecated)
Data Role Search (deprecated)
Data Roles (deprecated)
Data Settings (deprecated)
Data Site Preferences (deprecated)
Data Site Search (deprecated)
Data Sites (deprecated)
Data Slot Configuration Campaign Assignment Search (deprecated)
Data Slot Configuration Search (deprecated)
Data Slot Configurations (deprecated)
Data Slot Search (deprecated)
Data Slots (deprecated)
Data Sorting Rule Search (deprecated)
Data Source Code Group Search (deprecated)
Data Source Code Groups (deprecated)
Data Store Search (deprecated)
Data Stores (deprecated)
Data System Object Definition Search (deprecated)
Data System Object Definitions (deprecated)
Data User Search (deprecated)
Data Users (deprecated)
Script API
B2C Commerce Script API 26.4
TopLevel
dw.alert
dw.campaign
dw.catalog
dw.content
dw.crypto
dw.customer
dw.customer.oauth
dw.customer.shoppercontext
dw.experience
dw.experience.cms
dw.experience.image
dw.extensions.applepay
dw.extensions.facebook
dw.extensions.paymentapi
dw.extensions.paymentrequest
dw.extensions.payments
dw.extensions.pinterest
dw.io
dw.job
dw.net
dw.object
dw.order
AbstractItem
AbstractItemCtnr
Appeasement
AppeasementItem
Basket
BasketMgr
BonusDiscountLineItem
CouponLineItem
CreateAgentBasketLimitExceededException
CreateBasketFromOrderException
CreateCouponLineItemException
CreateOrderException
CreateTemporaryBasketLimitExceededException
GiftCertificate
GiftCertificateLineItem
GiftCertificateMgr
GiftCertificateStatusCodes
Invoice
InvoiceItem
LineItem
LineItemCtnr
Order
OrderAddress
OrderItem
OrderMgr
OrderPaymentInstrument
OrderProcessStatusCodes
PaymentCard
PaymentInstrument
PaymentMethod
PaymentMgr
PaymentProcessor
PaymentStatusCodes
PaymentTransaction
PriceAdjustment
PriceAdjustmentLimitTypes
ProductLineItem
ProductShippingCost
ProductShippingLineItem
ProductShippingModel
Return
ReturnCase
ReturnCaseItem
ReturnItem
Shipment
ShipmentShippingCost
ShipmentShippingModel
ShippingLineItem
ShippingLocation
ShippingMethod
ShippingMgr
ShippingOrder
ShippingOrderItem
SumItem
TaxGroup
TaxItem
TaxMgr
TrackingInfo
TrackingRef
dw.order.hooks
dw.rpc
dw.sitemap
dw.suggest
dw.svc
dw.system
dw.template
dw.util
dw.value
dw.web
dw.ws
B2C Commerce Developer Sandbox REST API

DID THIS ARTICLE SOLVE YOUR ISSUE?
Let us know so we can improve!