Class TrackingInfo

• TopLevel.Object
  • dw.object.Extensible
    • dw.order.TrackingInfo

Provides basic information about a tracking info. An instance is identified by an ID and can be referenced from n ShippingOrderItems using TrackingRefs. This also allows one ShippingOrderItem to be associated with n TrackingInfo.

See Also:

• ShippingOrder.addTrackingInfo(String)
• ShippingOrderItem.addTrackingRef(String, Quantity)

Property Summary 

Property	Description
ID: String (read-only)	Get the mandatory identifier for this tracking information.
carrier: String	Get the Carrier.
carrierService: String	Get the service(ship method) of the used carrier.
shipDate: Date	Get the ship date.
shippingOrder: ShippingOrder (read-only)	Gets the shipping order.
trackingNumber: String	Get the tracking number.
trackingRefs: Collection (read-only)	Gets the tracking refs (shipping order items) which are assigned to this tracking info.
warehouseID: String	Get the id of the shipping warehouse.

Constructor Summary 

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

Method Summary 

Method	Description
getCarrier()	Get the Carrier.
getCarrierService()	Get the service(ship method) of the used carrier.
getID()	Get the mandatory identifier for this tracking information.
getShipDate()	Get the ship date.
getShippingOrder()	Gets the shipping order.
getTrackingNumber()	Get the tracking number.
getTrackingRefs()	Gets the tracking refs (shipping order items) which are assigned to this tracking info.
getWarehouseID()	Get the id of the shipping warehouse.
setCarrier(String)	Set the Carrier.
setCarrierService(String)	Set the service(ship method) of the used carrier.
setShipDate(Date)	Set the ship date.
setTrackingNumber(String)	Set the TrackingNumber.
setWarehouseID(String)	Set the id of the shipping warehouse.

Methods inherited from class Extensible 

describe, getCustom

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

Property Details 

ID 

ID: String (read-only)

Get the mandatory identifier for this tracking information. The id allows the tracking information to be referenced from TrackingRefs. To support short shipping a shipping-order-item can manage a list of TrackingRefs, each with an optional quantity value allowing individual items to ship in multiple parcels with known item quantity in each.

See Also:

• ShippingOrder.addTrackingInfo(String)

---

carrier 

carrier: String

Get the Carrier.

---

carrierService 

carrierService: String

Get the service(ship method) of the used carrier.

---

shipDate 

shipDate: Date

Get the ship date.

---

shippingOrder 

shippingOrder: ShippingOrder (read-only)

Gets the shipping order.

---

trackingNumber 

trackingNumber: String

Get the tracking number.

---

trackingRefs 

trackingRefs: Collection (read-only)

Gets the tracking refs (shipping order items) which are assigned to this tracking info.

---

warehouseID 

warehouseID: String

Get the id of the shipping warehouse.

---

Method Details 

getCarrier() 

getCarrier(): String

Get the Carrier.

Returns:

• the Carrier

---

getCarrierService() 

getCarrierService(): String

Get the service(ship method) of the used carrier.

Returns:

• the carrier service (ship method)

---

getID() 

getID(): String

Get the mandatory identifier for this tracking information. The id allows the tracking information to be referenced from TrackingRefs. To support short shipping a shipping-order-item can manage a list of TrackingRefs, each with an optional quantity value allowing individual items to ship in multiple parcels with known item quantity in each.

Returns:

• the id

See Also:

• ShippingOrder.addTrackingInfo(String)

---

getShipDate() 

getShipDate(): Date

Get the ship date.

Returns:

• the ship date

---

getShippingOrder() 

getShippingOrder(): ShippingOrder

Gets the shipping order.

Returns:

• the shipping order

---

getTrackingNumber() 

getTrackingNumber(): String

Get the tracking number.

Returns:

• the TrackingNumber

---

getTrackingRefs() 

getTrackingRefs(): Collection

Gets the tracking refs (shipping order items) which are assigned to this tracking info.

Returns:

• the tracking refs (shipping order items) which are assigned to this tracking info.

---

getWarehouseID() 

getWarehouseID(): String

Get the id of the shipping warehouse.

Returns:

• the id of the shipping warehouse

---

setCarrier(String) 

setCarrier(carrier: String): void

Set the Carrier.

Parameters:

• carrier - the Carrier

---

setCarrierService(String) 

setCarrierService(carrierService: String): void

Set the service(ship method) of the used carrier.

Parameters:

• carrierService - the carrier service, eg. the ship method

---

setShipDate(Date) 

setShipDate(shipDate: Date): void

Set the ship date.

Parameters:

• shipDate - the ship date

---

setTrackingNumber(String) 

setTrackingNumber(trackingNumber: String): void

Set the TrackingNumber.

Parameters:

• trackingNumber - the TrackingNumber

---

setWarehouseID(String) 

setWarehouseID(warehouseID: String): void

Set the id of the shipping warehouse.

Parameters:

• warehouseID - the id of the shipping warehouse

---