Shipment document (Shop API 19.10)

(supports custom properties)

Document representing a shipment.

Property Type Constraints Description
adjusted_merchandize_total_tax Decimal  

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".

adjusted_shipping_total_tax Decimal   The tax of all shipping line items of the line item container after shipping adjustments have been applied.
gift boolean   A flag indicating whether the shipment is a gift.
gift_message String   The gift message.
merchandize_total_tax Decimal   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.
product_sub_total Decimal   The total price of all product items after all product discounts. Depending on taxation policy the returned price is net or gross.
product_total Decimal   The total price of all product items after all product and order discounts. Depending on taxation policy the returned price is net or gross.
shipment_id String   The order specific id to identify the shipment.
shipment_no String   Returns the shipment number for this shipment. This number is automatically generated.
shipment_total Decimal  

The total price of the shipment, including products, shipping and tax.

Note that order level adjustments are not considered.

shipping_address OrderAddress   The shipping address.
shipping_method ShippingMethod   The shipping method.
shipping_status Enum {not_shipped, shipped}   The shipping status of the shipment.
shipping_total Decimal   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.
shipping_total_tax Decimal   The tax of all shipping line items of the line item container before shipping adjustments have been applied.
tax_total Decimal  

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".

tracking_number String   The tracking number of the shipment.