# Class ShippingOrder - [TopLevel.Object](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md) - [dw.object.Extensible](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.object.Extensible.md) - [dw.order.AbstractItemCtnr](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.order.AbstractItemCtnr.md) - [dw.order.ShippingOrder](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.order.ShippingOrder.md) A shipping order is used to specify items that should be shipped, and is typically exported to, and updated by a back-office warehouse management system. An [Order](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.order.Order.md) can have n shipping orders expressing how the order is to be shipped. The creation, export and update of shipping orders is largely handled by custom logic in scripts by implementing [ShippingOrderHooks](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.order.hooks.ShippingOrderHooks.md). Use method [Order.createShippingOrder()](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.order.Order.md#createshippingorder) for creation and add items using [createShippingOrderItem(OrderItem, Quantity)](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.order.ShippingOrder.md#createshippingorderitemorderitem-quantity) - each item is related to an order item which in turn represents a product- or shipping- line item in the order. A shipping order has a status calculated from its item status, one of - CONFIRMED - shipping order not yet exported, with 0 items, or all items in status CONFIRMED. - WAREHOUSE - shipping order exported, with all items in status WAREHOUSE. - SHIPPED - exported shipping order has been updated, with 1-n items in status SHIPPED and 0-n CANCELLED. - CANCELLED - exported shipping order has been updated, with all items in status CANCELLED. The following status transitions are supported. Every status transition is documented by the addition of an order note such as 'Shipping order 123456 status changed to WAREHOUSE.': | From | To | When | Use | | --------- | --------- | ----------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | CONFIRMED | WAREHOUSE | Shipping order exported | Call [setStatusWarehouse()](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.order.ShippingOrder.md#setstatuswarehouse) - note this is the only way to set the items to status WAREHOUSE | | WAREHOUSE | SHIPPED | One or more items have been SHIPPED | Call [ShippingOrderItem.setStatus(String)](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.order.ShippingOrderItem.md#setstatusstring) using [ShippingOrderItem.STATUS_SHIPPED](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.order.ShippingOrderItem.md#status_shipped) | | WAREHOUSE | CANCELLED | All items have been CANCELLED | Call [ShippingOrderItem.setStatus(String)](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.order.ShippingOrderItem.md#setstatusstring) using [ShippingOrderItem.STATUS_CANCELLED](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.order.ShippingOrderItem.md#status_cancelled) | Order post-processing APIs (gillian) are now inactive by default and will throw an exception if accessed. Activation needs preliminary approval by Product Management. Please contact support in this case. Existing customers using these APIs are not affected by this change and can use the APIs until further notice. ## Constant Summary | Constant | Description | | --------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------- | | [ORDERBY_ITEMID](#orderby_itemid): [Object](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md) | Sorting by item id. | | [ORDERBY_ITEMPOSITION](#orderby_itemposition): [Object](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md) | Sorting by the position of the related oder item. | | [ORDERBY_UNSORTED](#orderby_unsorted): [Object](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md) | Unsorted , as it is. | | [QUALIFIER_PRODUCTITEMS](#qualifier_productitems): [Object](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md) | Selects the product items. | | [QUALIFIER_SERVICEITEMS](#qualifier_serviceitems): [Object](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md) | Selects for the service items. | | [STATUS_CANCELLED](#status_cancelled): [String](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.String.md) = "CANCELLED" | Constant for Shipping Order Status CANCELLED | | [STATUS_CONFIRMED](#status_confirmed): [String](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.String.md) = "CONFIRMED" | Constant for Shipping Order Status CONFIRMED | | [STATUS_SHIPPED](#status_shipped): [String](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.String.md) = "SHIPPED" | Constant for Shipping Order Status SHIPPED | | [STATUS_WAREHOUSE](#status_warehouse): [String](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.String.md) = "WAREHOUSE" | Constant for Shipping Order Status WAREHOUSE | ## Property Summary | Property | Description | | --------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | | [invoice](#invoice): [Invoice](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.order.Invoice.md) `(read-only)` | Returns null or the previously created [Invoice](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.order.Invoice.md). | | [invoiceNumber](#invoicenumber): [String](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.String.md) `(read-only)` | Returns `null` or the invoice-number. | | [items](#items): [FilteringCollection](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.util.FilteringCollection.md) `(read-only)` | A filtering collection of the shipping order items belonging to the shipping order. | | [shipDate](#shipdate): [Date](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Date.md) | Gets the shipping date. | | [shippingAddress](#shippingaddress): [OrderAddress](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.order.OrderAddress.md) | Returns the shipping address (optional, can be null). | | [shippingMethod](#shippingmethod): [ShippingMethod](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.order.ShippingMethod.md) `(read-only)` | Returns the shipping method of the shipping order. | | [shippingOrderNumber](#shippingordernumber): [String](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.String.md) `(read-only)` | Gets the shipping order number. | | [status](#status): [EnumValue](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.value.EnumValue.md) `(read-only)` | Gets the status of this shipping order. | | [trackingInfos](#trackinginfos): [Collection](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.util.Collection.md) `(read-only)` | Gets all tracking informations for this shipping order. | ## Constructor Summary This class does not have a constructor, so you cannot create it directly. ## Method Summary | Method | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | [addTrackingInfo](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.order.ShippingOrder.md#addtrackinginfostring)([String](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.String.md)) | Adds a tracking info to this shipping order with the given ID. | | [createInvoice](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.order.ShippingOrder.md#createinvoice)() | Creates a new [Invoice](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.order.Invoice.md) based on this ShippingOrder. | | [createInvoice](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.order.ShippingOrder.md#createinvoicestring)([String](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.String.md)) | Creates a new [Invoice](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.order.Invoice.md) based on this ShippingOrder. | | [createShippingOrderItem](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.order.ShippingOrder.md#createshippingorderitemorderitem-quantity)([OrderItem](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.order.OrderItem.md), [Quantity](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.value.Quantity.md)) | Create a [ShippingOrderItem](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.order.ShippingOrderItem.md) in the shipping order with the number `shippingOrderNumber`. | | [createShippingOrderItem](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.order.ShippingOrder.md#createshippingorderitemorderitem-quantity-boolean)([OrderItem](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.order.OrderItem.md), [Quantity](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.value.Quantity.md), [Boolean](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Boolean.md)) | Create a [ShippingOrderItem](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.order.ShippingOrderItem.md) in the shipping order with the number `shippingOrderNumber`. | | [getInvoice](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.order.ShippingOrder.md#getinvoice)() | Returns null or the previously created [Invoice](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.order.Invoice.md). | | [getInvoiceNumber](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.order.ShippingOrder.md#getinvoicenumber)() | Returns `null` or the invoice-number. | | [getItems](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.order.ShippingOrder.md#getitems)() | A filtering collection of the shipping order items belonging to the shipping order. | | [getShipDate](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.order.ShippingOrder.md#getshipdate)() | Gets the shipping date. | | [getShippingAddress](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.order.ShippingOrder.md#getshippingaddress)() | Returns the shipping address (optional, can be null). | | [getShippingMethod](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.order.ShippingOrder.md#getshippingmethod)() | Returns the shipping method of the shipping order. | | [getShippingOrderNumber](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.order.ShippingOrder.md#getshippingordernumber)() | Gets the shipping order number. | | [getStatus](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.order.ShippingOrder.md#getstatus)() | Gets the status of this shipping order. | | [getTrackingInfo](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.order.ShippingOrder.md#gettrackinginfostring)([String](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.String.md)) | Gets a tracking info for this shipping order. | | [getTrackingInfos](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.order.ShippingOrder.md#gettrackinginfos)() | Gets all tracking informations for this shipping order. | | [setShipDate](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.order.ShippingOrder.md#setshipdatedate)([Date](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Date.md)) | Sets the shipping date. | | [setShippingAddress](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.order.ShippingOrder.md#setshippingaddressorderaddress)([OrderAddress](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.order.OrderAddress.md)) | Set a shipping address for the shipping order. | | [setShippingMethodID](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.order.ShippingOrder.md#setshippingmethodidstring)([String](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.String.md)) | Set the id of shipping method. | | [setStatusWarehouse](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.order.ShippingOrder.md#setstatuswarehouse)() | Set a CONFIRMED shipping order (all items in status CONFIRMED) to status WAREHOUSE (all items in status WAREHOUSE).
Note - this method is the only way to transition a shipping order from CONFIRMED to WAREHOUSE. | ### Methods inherited from class AbstractItemCtnr [getCreatedBy](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.order.AbstractItemCtnr.md#getcreatedby), [getCreationDate](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.order.AbstractItemCtnr.md#getcreationdate), [getGrandTotal](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.order.AbstractItemCtnr.md#getgrandtotal), [getItems](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.order.AbstractItemCtnr.md#getitems), [getLastModified](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.order.AbstractItemCtnr.md#getlastmodified), [getModifiedBy](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.order.AbstractItemCtnr.md#getmodifiedby), [getOrder](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.order.AbstractItemCtnr.md#getorder), [getProductSubtotal](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.order.AbstractItemCtnr.md#getproductsubtotal), [getServiceSubtotal](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.order.AbstractItemCtnr.md#getservicesubtotal) ### Methods inherited from class Extensible [describe](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.object.Extensible.md#describe), [getCustom](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.object.Extensible.md#getcustom) ### Methods inherited from class Object [assign](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#assignobject-object), [create](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#createobject), [create](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#createobject-object), [defineProperties](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#definepropertiesobject-object), [defineProperty](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#definepropertyobject-object-object), [entries](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#entriesobject), [freeze](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#freezeobject), [fromEntries](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#fromentriesiterable), [getOwnPropertyDescriptor](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#getownpropertydescriptorobject-object), [getOwnPropertyNames](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#getownpropertynamesobject), [getOwnPropertySymbols](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#getownpropertysymbolsobject), [getPrototypeOf](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#getprototypeofobject), [hasOwnProperty](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#hasownpropertystring), [is](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#isobject-object), [isExtensible](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#isextensibleobject), [isFrozen](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#isfrozenobject), [isPrototypeOf](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#isprototypeofobject), [isSealed](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#issealedobject), [keys](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#keysobject), [preventExtensions](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#preventextensionsobject), [propertyIsEnumerable](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#propertyisenumerablestring), [seal](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#sealobject), [setPrototypeOf](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#setprototypeofobject-object), [toLocaleString](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#tolocalestring), [toString](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#tostring), [valueOf](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#valueof), [values](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#valuesobject) ## Constant Details ### ORDERBY_ITEMID - ORDERBY_ITEMID: [Object](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md) - : Sorting by item id. Use with method [getItems()](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.order.ShippingOrder.md#getitems) as an argument to method [FilteringCollection.sort(Object)](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.util.FilteringCollection.md#sortobject). *** ### ORDERBY_ITEMPOSITION - ORDERBY_ITEMPOSITION: [Object](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md) - : Sorting by the position of the related oder item. Use with method [getItems()](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.order.ShippingOrder.md#getitems) as an argument to method [FilteringCollection.sort(Object)](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.util.FilteringCollection.md#sortobject). *** ### ORDERBY_UNSORTED - ORDERBY_UNSORTED: [Object](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md) - : Unsorted , as it is. Use with method [getItems()](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.order.ShippingOrder.md#getitems) as an argument to method [FilteringCollection.sort(Object)](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.util.FilteringCollection.md#sortobject). *** ### QUALIFIER_PRODUCTITEMS - QUALIFIER_PRODUCTITEMS: [Object](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md) - : Selects the product items. Use with method [getItems()](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.order.ShippingOrder.md#getitems) as an argument to method [FilteringCollection.select(Object)](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.util.FilteringCollection.md#selectobject). *** ### QUALIFIER_SERVICEITEMS - QUALIFIER_SERVICEITEMS: [Object](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md) - : Selects for the service items. Use with method [getItems()](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.order.ShippingOrder.md#getitems) as an argument to method [FilteringCollection.select(Object)](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.util.FilteringCollection.md#selectobject). *** ### STATUS_CANCELLED - STATUS_CANCELLED: [String](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.String.md) = "CANCELLED" - : Constant for Shipping Order Status CANCELLED *** ### STATUS_CONFIRMED - STATUS_CONFIRMED: [String](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.String.md) = "CONFIRMED" - : Constant for Shipping Order Status CONFIRMED *** ### STATUS_SHIPPED - STATUS_SHIPPED: [String](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.String.md) = "SHIPPED" - : Constant for Shipping Order Status SHIPPED *** ### STATUS_WAREHOUSE - STATUS_WAREHOUSE: [String](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.String.md) = "WAREHOUSE" - : Constant for Shipping Order Status WAREHOUSE *** ## Property Details ### invoice - invoice: [Invoice](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.order.Invoice.md) `(read-only)` - : Returns null or the previously created [Invoice](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.order.Invoice.md). **See Also:** - [createInvoice(String)](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.order.ShippingOrder.md#createinvoicestring) *** ### invoiceNumber - invoiceNumber: [String](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.String.md) `(read-only)` - : Returns `null` or the invoice-number. **See Also:** - [createInvoice(String)](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.order.ShippingOrder.md#createinvoicestring) *** ### items - items: [FilteringCollection](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.util.FilteringCollection.md) `(read-only)` - : A filtering collection of the shipping order items belonging to the shipping order. This [FilteringCollection](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.util.FilteringCollection.md) could be sorted / filtered using: - [FilteringCollection.sort(Object)](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.util.FilteringCollection.md#sortobject)with [ORDERBY_ITEMID](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.order.ShippingOrder.md#orderby_itemid) - [FilteringCollection.sort(Object)](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.util.FilteringCollection.md#sortobject)with [ORDERBY_ITEMPOSITION](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.order.ShippingOrder.md#orderby_itemposition) - [FilteringCollection.sort(Object)](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.util.FilteringCollection.md#sortobject)with [ORDERBY_UNSORTED](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.order.ShippingOrder.md#orderby_unsorted) - [FilteringCollection.select(Object)](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.util.FilteringCollection.md#selectobject)with [QUALIFIER_PRODUCTITEMS](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.order.ShippingOrder.md#qualifier_productitems) - [FilteringCollection.select(Object)](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.util.FilteringCollection.md#selectobject)with [QUALIFIER_SERVICEITEMS](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.order.ShippingOrder.md#qualifier_serviceitems) **See Also:** - [createShippingOrderItem(OrderItem, Quantity)](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.order.ShippingOrder.md#createshippingorderitemorderitem-quantity) - [ShippingOrderItem](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.order.ShippingOrderItem.md) *** ### shipDate - shipDate: [Date](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Date.md) - : Gets the shipping date. Returns `null` if this shipping order is not yet shipped. *** ### shippingAddress - shippingAddress: [OrderAddress](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.order.OrderAddress.md) - : Returns the shipping address (optional, can be null). Note: the shipping address is not copied into the ShippingOrder but is a link to a [OrderAddress](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.order.OrderAddress.md) held in the [Order](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.order.Order.md). *** ### shippingMethod - shippingMethod: [ShippingMethod](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.order.ShippingMethod.md) `(read-only)` - : Returns the shipping method of the shipping order. Can be `null`. *** ### shippingOrderNumber - shippingOrderNumber: [String](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.String.md) `(read-only)` - : Gets the shipping order number. *** ### status - status: [EnumValue](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.value.EnumValue.md) `(read-only)` - : Gets the status of this shipping order. The status is read-only and calculated from the item status. See class documentation for more details. The possible values are [STATUS_CONFIRMED](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.order.ShippingOrder.md#status_confirmed), [STATUS_WAREHOUSE](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.order.ShippingOrder.md#status_warehouse), [STATUS_SHIPPED](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.order.ShippingOrder.md#status_shipped), [STATUS_CANCELLED](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.order.ShippingOrder.md#status_cancelled). *** ### trackingInfos - trackingInfos: [Collection](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.util.Collection.md) `(read-only)` - : Gets all tracking informations for this shipping order. **See Also:** - [TrackingInfo](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.order.TrackingInfo.md) *** ## Method Details ### addTrackingInfo(String) - addTrackingInfo(trackingInfoID: [String](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.String.md)): [TrackingInfo](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.order.TrackingInfo.md) - : Adds a tracking info to this shipping order with the given ID. **Parameters:** - trackingInfoID - the tracking info id **Returns:** - the new tracking info **See Also:** - [TrackingInfo](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.order.TrackingInfo.md) *** ### createInvoice() - createInvoice(): [Invoice](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.order.Invoice.md) - : Creates a new [Invoice](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.order.Invoice.md) based on this ShippingOrder. The shipping-order-number will be used as the invoice-number. The Invoice can then be accessed using [getInvoice()](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.order.ShippingOrder.md#getinvoice) or [getInvoiceNumber()](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.order.ShippingOrder.md#getinvoicenumber) can be used. The method must not be called more than once for a ShippingOrder, nor may 2 Invoices exist with the same invoice-number. The new Invoice is a debit-invoice with a status [Invoice.STATUS_NOT_PAID](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.order.Invoice.md#status_not_paid), and will be passed to the capture payment-hook in a separate database transaction for processing. **Returns:** - new invoice *** ### createInvoice(String) - createInvoice(invoiceNumber: [String](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.String.md)): [Invoice](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.order.Invoice.md) - : Creates a new [Invoice](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.order.Invoice.md) based on this ShippingOrder. The invoice-number must be specified as an argument.The Invoice can then be accessed using [getInvoice()](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.order.ShippingOrder.md#getinvoice) or [getInvoiceNumber()](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.order.ShippingOrder.md#getinvoicenumber) can be used. The method must not be called more than once for a ShippingOrder, nor may 2 Invoices exist with the same invoice-number. The new Invoice is a debit-invoice with a status [Invoice.STATUS_NOT_PAID](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.order.Invoice.md#status_not_paid), and will be passed to the capture payment-hook in a separate database transaction for processing. **Parameters:** - invoiceNumber - the invoice-number to use **Returns:** - new invoice *** ### createShippingOrderItem(OrderItem, Quantity) - createShippingOrderItem(orderItem: [OrderItem](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.order.OrderItem.md), quantity: [Quantity](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.value.Quantity.md)): [ShippingOrderItem](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.order.ShippingOrderItem.md) - : Create a [ShippingOrderItem](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.order.ShippingOrderItem.md) in the shipping order with the number `shippingOrderNumber`. The quantity of the new item can be optionally specified. A quantity of `null` indicates the new item should be based on the entire order item and is recommended for [ShippingLineItem](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.order.ShippingLineItem.md)s. If a quantity is specified for a [ProductLineItem](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.order.ProductLineItem.md) which is less than [ProductLineItem.getQuantity()](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.order.ProductLineItem.md#getquantity) the ProductLineItem will be split, creating a new ProductLineItem. The new ShippingOrderItem will be associated with the new ProductLineItem, which will receive the specified quantity. See also [createShippingOrderItem(OrderItem, Quantity, Boolean)](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.order.ShippingOrder.md#createshippingorderitemorderitem-quantity-boolean). **Parameters:** - quantity - the quantity for which the shipping order item will be created - orderItem - the order item for which the shipping order item is to be created **Returns:** - the created shipping order item *** ### createShippingOrderItem(OrderItem, Quantity, Boolean) - createShippingOrderItem(orderItem: [OrderItem](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.order.OrderItem.md), quantity: [Quantity](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.value.Quantity.md), splitIfPartial: [Boolean](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Boolean.md)): [ShippingOrderItem](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.order.ShippingOrderItem.md) - : Create a [ShippingOrderItem](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.order.ShippingOrderItem.md) in the shipping order with the number `shippingOrderNumber`. The quantity of the new item can be optionally specified. A quantity of `null` indicates the new item should be based on the entire order item and is recommended for [ShippingLineItem](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.order.ShippingLineItem.md)s. If the specified quantity is less than [ProductLineItem.getQuantity()](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.order.ProductLineItem.md#getquantity) the ProductLineItem will be split or not depending on `splitIfPartial` parameter. When `split` is `true`, the method is equivalent to [createShippingOrderItem(OrderItem, Quantity)](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.order.ShippingOrder.md#createshippingorderitemorderitem-quantity). **Parameters:** - quantity - the quantity for which the shipping order item will be created, not null - orderItem - the order item for which the shipping order item is to be created - splitIfPartial - the flag whether ProductLineItem should be split when requested quantity is less than ProductLineItem's quantity **Returns:** - the created shipping order item *** ### getInvoice() - getInvoice(): [Invoice](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.order.Invoice.md) - : Returns null or the previously created [Invoice](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.order.Invoice.md). **Returns:** - null or the previously created invoice. **See Also:** - [createInvoice(String)](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.order.ShippingOrder.md#createinvoicestring) *** ### getInvoiceNumber() - getInvoiceNumber(): [String](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.String.md) - : Returns `null` or the invoice-number. **Returns:** - `null` or the previously created invoice number. **See Also:** - [createInvoice(String)](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.order.ShippingOrder.md#createinvoicestring) *** ### getItems() - getItems(): [FilteringCollection](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.util.FilteringCollection.md) - : A filtering collection of the shipping order items belonging to the shipping order. This [FilteringCollection](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.util.FilteringCollection.md) could be sorted / filtered using: - [FilteringCollection.sort(Object)](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.util.FilteringCollection.md#sortobject)with [ORDERBY_ITEMID](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.order.ShippingOrder.md#orderby_itemid) - [FilteringCollection.sort(Object)](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.util.FilteringCollection.md#sortobject)with [ORDERBY_ITEMPOSITION](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.order.ShippingOrder.md#orderby_itemposition) - [FilteringCollection.sort(Object)](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.util.FilteringCollection.md#sortobject)with [ORDERBY_UNSORTED](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.order.ShippingOrder.md#orderby_unsorted) - [FilteringCollection.select(Object)](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.util.FilteringCollection.md#selectobject)with [QUALIFIER_PRODUCTITEMS](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.order.ShippingOrder.md#qualifier_productitems) - [FilteringCollection.select(Object)](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.util.FilteringCollection.md#selectobject)with [QUALIFIER_SERVICEITEMS](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.order.ShippingOrder.md#qualifier_serviceitems) **Returns:** - the filtering collection of the shipping items. **See Also:** - [createShippingOrderItem(OrderItem, Quantity)](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.order.ShippingOrder.md#createshippingorderitemorderitem-quantity) - [ShippingOrderItem](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.order.ShippingOrderItem.md) *** ### getShipDate() - getShipDate(): [Date](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Date.md) - : Gets the shipping date. Returns `null` if this shipping order is not yet shipped. **Returns:** - the shipping date or `null` *** ### getShippingAddress() - getShippingAddress(): [OrderAddress](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.order.OrderAddress.md) - : Returns the shipping address (optional, can be null). Note: the shipping address is not copied into the ShippingOrder but is a link to a [OrderAddress](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.order.OrderAddress.md) held in the [Order](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.order.Order.md). **Returns:** - the shipping address or `null` *** ### getShippingMethod() - getShippingMethod(): [ShippingMethod](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.order.ShippingMethod.md) - : Returns the shipping method of the shipping order. Can be `null`. **Returns:** - the shipping method or `null` *** ### getShippingOrderNumber() - getShippingOrderNumber(): [String](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.String.md) - : Gets the shipping order number. **Returns:** - the shipping order number *** ### getStatus() - getStatus(): [EnumValue](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.value.EnumValue.md) - : Gets the status of this shipping order. The status is read-only and calculated from the item status. See class documentation for more details. The possible values are [STATUS_CONFIRMED](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.order.ShippingOrder.md#status_confirmed), [STATUS_WAREHOUSE](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.order.ShippingOrder.md#status_warehouse), [STATUS_SHIPPED](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.order.ShippingOrder.md#status_shipped), [STATUS_CANCELLED](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.order.ShippingOrder.md#status_cancelled). **Returns:** - the status *** ### getTrackingInfo(String) - getTrackingInfo(trackingInfoID: [String](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.String.md)): [TrackingInfo](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.order.TrackingInfo.md) - : Gets a tracking info for this shipping order. **Parameters:** - trackingInfoID - the tracking info id **Returns:** - the tracking info or `null` **See Also:** - [TrackingInfo](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.order.TrackingInfo.md) *** ### getTrackingInfos() - getTrackingInfos(): [Collection](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.util.Collection.md) - : Gets all tracking informations for this shipping order. **Returns:** - all tracking informations for this shipping order **See Also:** - [TrackingInfo](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.order.TrackingInfo.md) *** ### setShipDate(Date) - setShipDate(date: [Date](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Date.md)): void - : Sets the shipping date. **Parameters:** - date - the ship date *** ### setShippingAddress(OrderAddress) - setShippingAddress(address: [OrderAddress](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.order.OrderAddress.md)): void - : Set a shipping address for the shipping order. **Parameters:** - address - the shipping address **See Also:** - [getShippingAddress()](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.order.ShippingOrder.md#getshippingaddress) *** ### setShippingMethodID(String) - setShippingMethodID(shippingMethodID: [String](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.String.md)): void - : Set the id of shipping method. **Parameters:** - shippingMethodID - the id of the shipping method **See Also:** - [ShippingMethod.getID()](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.order.ShippingMethod.md#getid) *** ### setStatusWarehouse() - setStatusWarehouse(): void - : Set a CONFIRMED shipping order (all items in status CONFIRMED) to status WAREHOUSE (all items in status WAREHOUSE). Note - this method is the only way to transition a shipping order from CONFIRMED to WAREHOUSE. **Throws:** - IllegalArgumentException - if the shipping order is in a status other than CONFIRMED. ***