Shipping Option Groups

Read-only endpoints for shipping option groups — the shipping cost line items attached to an order once it has been placed. Each group records which shipping_option was selected for a set of order items, the final amount charged for shipping them, and the order items it covers. Groups are created internally by the order pipeline when an order is placed; they cannot be created, updated, or deleted through this API.

Core Capabilities

1. Listing & Filtering

• Retrieve a paginated list of shipping option groups.

• Filter by identifier (id, pk, pk__in), by the order the group belongs to (order), or by a specific order item it covers (order_item); order results by any field using the sort parameter.

2. Retrieval

• Retrieve a single shipping option group by its identifier, including the full nested shipping option.

Dynamic Settings & Environment Variables

No dynamic settings or environment variables are read directly by these read-only endpoints. The shipping_option and amount values shown here were already determined at checkout time by the shipping resolution and cost-calculation process, which the dynamic settings below (fully described in the parent Shipping Options section) govern:

Key	Effect on the values shown here
USE_EXTERNAL_COST_CALCULATOR, EXTERNAL_COST_CALCULATOR	Determine whether amount was computed by the shipping option's built-in calculator or delegated to an external cost-calculator service.
CHECKOUT_SHIPPING_OPTION_SELECTION_PAGE, REMOTE_SHIPPING_OPTION_PROVIDER	Determine which shipping resolution flow selected the shipping_option referenced by the group.
USE_BASKET_ITEM_ATTRIBUTES_FOR_ATTRIBUTE_BASED_SHIPPING, ATTRIBUTE_KEYS_FOR_ATTRIBUTE_BASED_SHIPPING_OPTION	Relevant only when the attribute-based shipping resolution flow was active; influenced how basket items were grouped before a shipping_option was chosen for each group.
CHECKOUT_RETAIL_STORE_FILTERS	Relevant only when the selected shipping_option is a retail-store delivery; determined which retail stores were eligible when it was selected.