Prior to the introduction of the split shipping feature, the Store API endpoints only supported a single shipping group. All items in the cart inherently belonged to that shipping group though the relationship between shipping group and cart items was not established in the order repository until the order was submitted. To that end, the pricing and order-related endpoints supported specification of the shipping address and shipping method for the default shipping group, via the shippingAddress
and shippingMethod
properties, in the request and response payloads. For backwards compatibility these properties continue to be supported in the request and response payloads with the caveats described below.
In request payloads, the shippingAddress
and shippingMethod
properties are:
Ignored if the
shippingGroups
array is specified.Used to set the shipping address and method of the first shipping group in the
shippingGroups
array when theshippingGroups
array is not explicitly specified.
In response payloads, the shippingAddress
and shippingMethod
properties refer to the shipping address and shipping method of the first shipping group in the shippingGroups
array.