> For the complete documentation index, see [llms.txt](https://apidocs.akinon.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://apidocs.akinon.com/commerce-openapis/admin/shipping-options/shipping-option-groups.md). # 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. | --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://apidocs.akinon.com/commerce-openapis/admin/shipping-options/shipping-option-groups.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.