Skip to navigation

OrderShippingConsignment

OBJECT
A shipping consignment for an order.

Fields

entityIdIntegerRequired
Consignment ID.
shippingAddressOrderShippingAddressRequired
Address the consignment is shipping to.
Physical line items for the consignment.
shippingMethodNameStringRequired
Name of the shipping method selected for this consignment.
shippingCostMoneyRequired
Shipping cost.
handlingCostMoneyRequired
Handling cost.
shipmentsOrderShipmentConnectionRequired
List of individual shipments for the consignment.
nonCouponDiscountslist of OrderNonCouponShippingDiscountsRequired

List of non-coupon shipping discounts applied to this shipping consignment.

shippingCostBeforeDiscountMoneyOptional
Estimated consignment shipping cost before any shipping discounts have been applied.
comparisonShippingCostMoneyOptional

The consignment shipping cost to be shown to shopper in the summary as struck-through.