> 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/retrieve-a-shipping-option-group.md). # Retrieve a shipping option group Returns a single shipping option group by its identifier. ```json {"openapi":"3.1.0","info":{"title":"Admin API","version":"1.0.0"},"tags":[{"name":"Shipping Option Groups","description":"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.\n\n## Core Capabilities\n\n**1. Listing & Filtering**\n* Retrieve a paginated list of shipping option groups.\n* 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.\n\n**2. Retrieval**\n* Retrieve a single shipping option group by its identifier, including the full nested shipping option.\n\n## Dynamic Settings & Environment Variables\n\nNo 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:\n\n| Key | Effect on the values shown here |\n|-----|----------------------------------|\n| `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. |\n| `CHECKOUT_SHIPPING_OPTION_SELECTION_PAGE`, `REMOTE_SHIPPING_OPTION_PROVIDER` | Determine which shipping resolution flow selected the `shipping_option` referenced by the group. |\n| `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. |\n| `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. |"}],"servers":[{"description":"Omnitron Remote Proxy (external access — recommended)","url":"https://{omnitron_url}/api/remote/{channel_id}","variables":{"omnitron_url":{"default":"sandbox.akinon.com","description":"Omnitron server URL (e.g., {omnitron.akinon.com})"},"channel_id":{"default":"1","description":"The channel identifier the remote request is routed through"}}},{"description":"Commerce API Server (internal / direct access only)","url":"https://{commerce_url}/api/v1","variables":{"commerce_url":{"default":"sandbox.akinon.com","description":"Internal commerce server URL, reachable only from within the Omnitron network"}}}],"security":[{"tokenAuth":[]}],"components":{"securitySchemes":{"tokenAuth":{"type":"apiKey","in":"header","name":"Authorization","description":"Token credential sent in the Authorization header, in the form: `Token `. Requires a staff (admin) account."}},"schemas":{"ShippingOptionGroup":{"type":"object","description":"A shipping option group — the shipping cost line item attached to an order. Groups are created internally by the order pipeline when an order is placed, pairing the `shipping_option` that was selected with the final `amount` charged and the order items it covers. This resource is read-only; it cannot be created, updated, or deleted through this API.","properties":{"pk":{"type":"integer","description":"Unique identifier of the shipping option group."},"amount":{"type":"string","description":"Shipping cost charged for this group. Decimal with at most 12 total digits and 2 decimal places (i.e. up to 10 digits before the decimal point). Resolved by the shipping option's calculator at the time the order was placed; see the **Dynamic Settings & Environment Variables** section for the settings that influence how it was computed."},"created_date":{"type":"string","format":"date-time","description":"When the group was created."},"modified_date":{"type":"string","format":"date-time","description":"When the group was last modified."},"shipping_option":{"allOf":[{"$ref":"#/components/schemas/ShippingOption"}],"description":"The shipping option that was selected for this group."},"order_items":{"type":"array","description":"Identifiers of the order items covered by this shipping option group.","items":{"type":"integer"}}},"required":["pk","amount","created_date","modified_date","shipping_option","order_items"]},"ShippingOption":{"type":"object","description":"A shipping option returned by the API.","properties":{"pk":{"type":"integer","readOnly":true,"description":"Unique identifier of the shipping option."},"name":{"type":"string","description":"Display name. Returned in the active request language, falling back to the default language."},"slug":{"type":"string","description":"URL-friendly unique identifier."},"is_active":{"type":"boolean","description":"Whether the shipping option is active. Inactive options are hidden from the storefront.","default":true},"calculator":{"type":"object","description":"Calculator configuration. Determines how the shipping cost is computed.\n\nThe object must contain at minimum a `slug` key identifying the calculator. See the [Shipping Rules & Calculators guide](https://docs.akinon.com/technical-guides/commerce/shipping-rules-calculator) for available calculators and their parameters."},"rule":{"type":"object","description":"Rule configuration. Determines which baskets are eligible for this shipping option.\n\nThe object must contain a `slug` key identifying the rule. The `name` key is optional. Send `{}` to apply `AnyRule` (all baskets are eligible). See the [Shipping Rules & Calculators guide](https://docs.akinon.com/technical-guides/commerce/shipping-rules-calculator) for available rules and their parameters."},"sort_order":{"type":"integer","description":"Sort order used when listing options. Lower values appear first.","default":0},"description":{"type":["string","null"],"description":"Optional description of the shipping option."},"kwargs":{"$ref":"#/components/schemas/ShippingOptionKwargs"},"delivery_type":{"oneOf":[{"$ref":"#/components/schemas/ShippingOptionDeliveryTypeDetail"},{"type":"null"}],"description":"Delivery type of the shipping option."}},"required":["pk","name","slug","is_active","calculator","rule","sort_order"]},"ShippingOptionKwargs":{"type":"object","description":"Extra configuration for the shipping option.\n\n`required_fields` lists the keys that must be present in the checkout data when an order is created with this shipping option. At order creation time, the values for those keys are copied from the checkout data into `Order.extra_field`.","properties":{"required_fields":{"type":"array","description":"List of field keys that must be present in the checkout data.","items":{"type":"string"}}}},"ShippingOptionDeliveryTypeDetail":{"type":"object","description":"Read representation of a delivery type — includes the raw enum value and its human-readable label.","properties":{"value":{"type":"string","description":"Enum value."},"label":{"type":"string","description":"Human-readable label for the delivery type."}}},"Error":{"type":"object","description":"An error response.","properties":{"detail":{"type":"string","description":"A human-readable description of the error."}},"additionalProperties":true}},"responses":{"Unauthorized":{"description":"Authentication credentials were not provided or are invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"Forbidden":{"description":"The authenticated user does not have administrator privileges.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"ShippingOptionGroupNotFound":{"description":"The requested shipping option group does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"paths":{"/shipping_option_groups/{id}/":{"get":{"tags":["Shipping Option Groups"],"operationId":"retrieveShippingOptionGroup","summary":"Retrieve a shipping option group","description":"Returns a single shipping option group by its identifier.","responses":{"200":{"description":"The requested shipping option group.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ShippingOptionGroup"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/ShippingOptionGroupNotFound"}}}}}} ``` --- # 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/retrieve-a-shipping-option-group.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.