new module:models/Shipment()
Constructs a new Shipment.
Document representing a shipment.
- Source:
Members
(readonly) ShippingStatusEnum :String
Allowed values for the shipping_status property.
Type:
- String
- Source:
(inner) adjusted_merchandize_total_tax :Number
The products tax after discounts applying in purchase currency. Adjusted merchandize prices represent the sum of product prices before services such as shipping have been added, but after adjustment from promotions have been added. Note that order level adjustments are considered if Discount Taxation preference is set to "Tax Products and Shipping Only Based on Adjusted Price".
Type:
- Number
- Source:
(inner) adjusted_shipping_total_tax :Number
The tax of all shipping line items of the line item container after shipping adjustments have been applied.
Type:
- Number
- Source:
(inner) c_fromStoreId :String
Used to map the shipment to a brick and mortar store.
Type:
- String
- Source:
(inner) c_shipmentType :String
Type:
- String
- Source:
(inner) c_storePickupMessage :String
This is text used by the end user when sending a message to the brick and mortar store about the shipment. This is reflected in the order export.
Type:
- String
- Source:
(inner) gift :Boolean
A flag indicating whether the shipment is a gift.
Type:
- Boolean
- Source:
(inner) gift_message :String
The gift message.
Type:
- String
- Source:
(inner) merchandize_total_tax :Number
The products total tax in purchase currency. Merchandize total prices represent the sum of product prices before services such as shipping or adjustment from promotions have been added.
Type:
- Number
- Source:
(inner, constant) not_shipped
value: "not_shipped"
- Source:
(inner) product_sub_total :Number
The total price of all product items after all product discounts. Depending on taxation policy the returned price is net or gross.
Type:
- Number
- Source:
(inner) product_total :Number
The total price of all product items after all product and order discounts. Depending on taxation policy the returned price is net or gross.
Type:
- Number
- Source:
(inner) shipment_id :String
The order specific id to identify the shipment.
Type:
- String
- Source:
(inner) shipment_no :String
Returns the shipment number for this shipment. This number is automatically generated.
Type:
- String
- Source:
(inner) shipment_total :Number
The total price of the shipment, including products, shipping and tax. Note that order level adjustments are not considered.
Type:
- Number
- Source:
(inner, constant) shipped
value: "shipped"
- Source:
(inner) shipping_address :module:models/OrderAddress
The shipping address.
Type:
- Source:
(inner) shipping_method :module:models/ShippingMethod
The shipping method.
Type:
- Source:
(inner) shipping_status :module:models/Shipment.ShippingStatusEnum
The shipping status of the shipment.
Type:
- module:models/Shipment.ShippingStatusEnum
- Source:
(inner) shipping_total :Number
The total shipping price of the shipment after all shipping discounts. Excludes tax if taxation policy is net. Includes tax if taxation policy is gross.
Type:
- Number
- Source:
(inner) shipping_total_tax :Number
The tax of all shipping line items of the line item container before shipping adjustments have been applied.
Type:
- Number
- Source:
(inner) tax_total :Number
The total tax amount of the shipment. Note that order level adjustments are considered if Discount Taxation preference is set to "Tax Products and Shipping Only Based on Adjusted Price".
Type:
- Number
- Source:
(inner) tracking_number :String
The tracking number of the shipment.
Type:
- String
- Source:
Methods
(static) constructFromObject(data, obj) → {module:models/Shipment}
Constructs a Shipment from a plain JavaScript object, optionally creating a new instance.
Copies all relevant properties from data to obj if supplied or a new instance if not.
Parameters:
| Name | Type | Description |
|---|---|---|
data |
Object | The plain JavaScript object bearing properties of interest. |
obj |
module:models/Shipment | Optional instance to populate. |
- Source:
Returns:
The populated Shipment instance.