> 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/checkout/shipping-and-delivery/select-shipping-options-per-attribute-value-group.md).

# Select Shipping Options per Attribute Value Group

Sets the shipping options for each attribute value group in the basket. Each attribute value group must have exactly one shipping option selected.

**Input Format**:

* `attribute_based_shipping_options`: JSON-encoded object mapping attribute values to shipping option IDs
* Keys are attribute values (the group keys from the GET response, e.g., `"electronics"`, `"clothing"`, `"Nike;shoes"`)
* Values are `AttributeBasedShippingOption` primary keys (integers)

**Example**: If the GET response returns the following attribute-based shipping options:

```json
{
  "electronics": {
    "attribute_based_shipping_options": [
      {"pk": 100, "shipping_option_name": "Standard Delivery", "shipping_amount": "5.99"},
      {"pk": 101, "shipping_option_name": "Express Delivery", "shipping_amount": "15.99"}
    ],
    "product_ids": [1001, 1002, 1003],
    "attribute_key": ["category"]
  },
  "clothing": {
    "attribute_based_shipping_options": [
      {"pk": 200, "shipping_option_name": "Economy Delivery", "shipping_amount": "3.99"},
      {"pk": 201, "shipping_option_name": "Standard Delivery", "shipping_amount": "8.99"}
    ],
    "product_ids": [2001, 2002],
    "attribute_key": ["category"]
  }
}
```

To select Standard Delivery (ID: 100) for electronics and Economy Delivery (ID: 200) for clothing:

```
attribute_based_shipping_options: '{"electronics": 100, "clothing": 200}'
```

**Composite Group Keys**: If products are grouped by multiple attributes (e.g., `["brand", "category"]`), the group keys will be composite values separated by semicolons:

```
attribute_based_shipping_options: '{"Nike;shoes": 100, "Adidas;clothing": 200, "Nike;None": 100}'
```

**Validation**:

* All attribute value groups must have a shipping option selected
* Selected options must be available for the current basket, shipping address, and segment
* Product IDs must match the expected grouping
* Shipping amounts are recalculated to ensure consistency

**Shipping Amount**:

* Total shipping amount is the sum of all selected attribute-based shipping option amounts

**Address Validation**:

* Validates that the shipping address hasn't changed since options were loaded
* If address changed, options are recalculated

**Next Pages**:

* If sample product discounts are available: `SampleProductPage`
* If retail store reservation is needed: `ReservationSelectionPage`
* Otherwise: `PaymentOptionSelectionPage`

````json
{"openapi":"3.1.0","info":{"title":"Overview","version":"1.0.0"},"tags":[{"name":"Shipping & Delivery","description":"# Checkout Shipping & Delivery\n\nConfigure shipping options and collect delivery preferences from your customers. These endpoints cover shipping method selection, delivery time slot selection, retail store and locker pickup, remote price calculation, delivery bags, and SMS notifications.\n\n## Authentication\n\nThese endpoints support both authenticated and anonymous sessions.\n\n- **Authenticated users**: Session cookie (`sessionid`) tracks checkout progress.\n- **Anonymous users**: Guest checkout is available when the `CAN_GUEST_PURCHASE` setting is enabled.\n## Request Format\n\nInclude the following header in all checkout requests:\n\n- **x-requested-with**: `XMLHttpRequest`\n\n## Dynamic Settings\n\nThe following settings are managed at runtime through the admin interface and do not require a server restart.\n\n### CHECKOUT_SHIPPING_OPTION_SELECTION_PAGE\nDetermines which shipping option page is active:\n- `ShippingOptionSelectionPage` — standard shipping options\n- `DataSourceShippingOptionSelectionPage` — options grouped by supplier\n- `AttributeBasedShippingOptionSelectionPage` — options grouped by product attribute\n- `RemoteShippingOptionSelectionPage` — options fetched from an external service\n\n### ATTRIBUTE_KEYS_FOR_ATTRIBUTE_BASED_SHIPPING_OPTION\nRules that determine how basket items are grouped by product attribute when the attribute-based shipping page is active. Rules are evaluated in priority order; the first matching rule determines the grouping key.\n\n### REMOTE_SHIPPING_OPTION_PROVIDER\nExternal service configuration used when `RemoteShippingOptionSelectionPage` is active. Includes the service URL and authentication credentials.\n\n### REMOTE_DELIVERY_OPTION_PROVIDER\nExternal service configuration for fetching delivery options remotely.\n\n### CHECKOUT_RETAIL_STORE_FILTERS\nFiltering options for the retail store list. When `by_stock` is enabled, only stores with available stock for basket items are shown.\n\n### DELIVERY_BAGS_CONF\nConfiguration for the delivery bags step. Set `is_active` to `true` to include the delivery bags page. Controls bag SKU, minimum quantity, and whether the customer can specify a custom quantity.\n\n### REMOTE_PRICE_ATTRIBUTE_KEY\nProduct attribute key indicating that an item requires remote price calculation.\n\n## Static Settings\n\nThe following settings are configured in the server environment and require a restart to take effect.\n\n### AUTOSELECT_SHIPPING\nWhen enabled, if only one shipping option is available after filtering, it is selected automatically and the shipping selection page is skipped.\n\n### CHECKOUT_LIST_RETAIL_STORES\nControls whether retail stores are listed on the store selection page. When disabled, an empty list is returned.\n\n### ORDER_BARCODE_SENT_SMS_EXPIRATION_IN_SECONDS\nMinimum interval in seconds between consecutive SMS sends for the same order. Prevents repeated sends within the cooldown period. Defaults to 1800 seconds (30 minutes)."}],"servers":[{"description":"Akinon Checkout API","url":"https://{commerce_url}","variables":{"commerce_url":{"default":"sandbox.akinon.com"}}}],"paths":{"/orders/checkout/?page=AttributeBasedShippingOptionSelectionPage":{"post":{"tags":["Shipping & Delivery"],"operationId":"submitAttributeBasedShippingOptionSelection","summary":"Select Shipping Options per Attribute Value Group","description":"Sets the shipping options for each attribute value group in the basket.\nEach attribute value group must have exactly one shipping option selected.\n\n**Input Format**:\n- `attribute_based_shipping_options`: JSON-encoded object mapping attribute values to shipping option IDs\n- Keys are attribute values (the group keys from the GET response, e.g., `\"electronics\"`, `\"clothing\"`, `\"Nike;shoes\"`)\n- Values are `AttributeBasedShippingOption` primary keys (integers)\n\n**Example**:\nIf the GET response returns the following attribute-based shipping options:\n```json\n{\n  \"electronics\": {\n    \"attribute_based_shipping_options\": [\n      {\"pk\": 100, \"shipping_option_name\": \"Standard Delivery\", \"shipping_amount\": \"5.99\"},\n      {\"pk\": 101, \"shipping_option_name\": \"Express Delivery\", \"shipping_amount\": \"15.99\"}\n    ],\n    \"product_ids\": [1001, 1002, 1003],\n    \"attribute_key\": [\"category\"]\n  },\n  \"clothing\": {\n    \"attribute_based_shipping_options\": [\n      {\"pk\": 200, \"shipping_option_name\": \"Economy Delivery\", \"shipping_amount\": \"3.99\"},\n      {\"pk\": 201, \"shipping_option_name\": \"Standard Delivery\", \"shipping_amount\": \"8.99\"}\n    ],\n    \"product_ids\": [2001, 2002],\n    \"attribute_key\": [\"category\"]\n  }\n}\n```\n\nTo select Standard Delivery (ID: 100) for electronics and Economy Delivery (ID: 200) for clothing:\n```\nattribute_based_shipping_options: '{\"electronics\": 100, \"clothing\": 200}'\n```\n\n**Composite Group Keys**:\nIf products are grouped by multiple attributes (e.g., `[\"brand\", \"category\"]`), the group keys\nwill be composite values separated by semicolons:\n```\nattribute_based_shipping_options: '{\"Nike;shoes\": 100, \"Adidas;clothing\": 200, \"Nike;None\": 100}'\n```\n\n**Validation**:\n- All attribute value groups must have a shipping option selected\n- Selected options must be available for the current basket, shipping address, and segment\n- Product IDs must match the expected grouping\n- Shipping amounts are recalculated to ensure consistency\n\n**Shipping Amount**:\n- Total shipping amount is the sum of all selected attribute-based shipping option amounts\n\n**Address Validation**:\n- Validates that the shipping address hasn't changed since options were loaded\n- If address changed, options are recalculated\n\n**Next Pages**:\n- If sample product discounts are available: `SampleProductPage`\n- If retail store reservation is needed: `ReservationSelectionPage`\n- Otherwise: `PaymentOptionSelectionPage`","parameters":[{"$ref":"#/components/parameters/AjaxRequestHeader"},{"$ref":"#/components/parameters/SessionCookieHeader"}],"requestBody":{"required":true,"content":{"application/x-www-form-urlencoded":{"schema":{"$ref":"#/components/schemas/AttributeBasedShippingOptionSelectionInput"}}}},"responses":{"200":{"description":"Attribute-based shipping options selected successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckoutResponse"}}}}}}}},"components":{"parameters":{"AjaxRequestHeader":{"name":"x-requested-with","in":"header","required":true,"description":"Required header for AJAX requests. Must be set to `XMLHttpRequest` for all checkout requests.","schema":{"type":"string","enum":["XMLHttpRequest"],"default":"XMLHttpRequest"}},"SessionCookieHeader":{"name":"Cookie","in":"header","required":false,"description":"Session cookie header (e.g. `sessionid=abc123` or `osessionid=<session_id>`)","schema":{"type":"string"}}},"schemas":{"AttributeBasedShippingOptionSelectionInput":{"type":"object","required":["attribute_based_shipping_options"],"properties":{"attribute_based_shipping_options":{"type":"string","description":"JSON-encoded object mapping attribute values to shipping option IDs.\nKeys are attribute values (e.g., \"electronics\", \"clothing\", \"warehouse_a\").\nValues are primary keys of `AttributeBasedShippingOption` models.\nOne shipping option must be selected for each attribute value group."}}},"CheckoutResponse":{"type":"object","properties":{"context_list":{"type":"array","items":{"$ref":"#/components/schemas/PageContext"}},"pre_order":{"$ref":"#/components/schemas/PreOrder"},"errors":{"oneOf":[{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},{"type":"null"},{"type":"array","items":{"type":"string"}}]},"template_name":{"type":"string"}}},"PageContext":{"type":"object","properties":{"page_name":{"type":"string","description":"Class name of the page (e.g., \"IndexPage\", \"AddressSelectionPage\")"},"page_slug":{"type":"string","description":"URL-friendly slug for the page"},"page_context":{"type":"object","description":"Page-specific context data","additionalProperties":true}}},"PreOrder":{"type":"object","description":"Pre-order state containing basket, addresses, shipping, payment information","properties":{"basket":{"$ref":"#/components/schemas/Basket"},"shipping_address":{"oneOf":[{"$ref":"#/components/schemas/Address"},{"type":"null"}]},"billing_address":{"oneOf":[{"$ref":"#/components/schemas/Address"},{"type":"null"}]},"shipping_option":{"oneOf":[{"$ref":"#/components/schemas/ShippingOptionDetail"},{"type":"null"}]},"billing_and_shipping_same":{"oneOf":[{"type":"boolean"},{"type":"null"}]},"payment_option":{"oneOf":[{"$ref":"#/components/schemas/PaymentOptionDetail"},{"type":"null"}]},"notifications":{"type":"array","items":{"type":"object"}},"shipping_amount":{"oneOf":[{"type":"string","pattern":"^\\d+\\.\\d{2}$"},{"type":"null"}]},"total_amount":{"oneOf":[{"type":"string","pattern":"^\\d+\\.\\d{2}$"},{"type":"null"}]},"unpaid_amount":{"oneOf":[{"type":"string","pattern":"^\\d+\\.\\d{2}$"},{"type":"null"}]},"loyalty_money":{"oneOf":[{"type":"string","pattern":"^\\d+\\.\\d{2}$"},{"type":"null"}]},"currency_type_label":{"type":"string"},"installment":{"oneOf":[{"$ref":"#/components/schemas/Installment"},{"type":"null"}]},"card_info":{"oneOf":[{"type":"object","description":"Card information from BIN lookup","properties":{"bin_number":{"type":"string","description":"Card BIN (first 6-8 digits)"},"card":{"type":"object","description":"Card details from BIN database","properties":{"pk":{"type":"integer"},"name":{"type":"string","description":"Card type name (e.g., \"Visa\", \"Mastercard\")"}}}}},{"type":"null"}]},"redirect_to_three_d":{"oneOf":[{"type":"boolean"},{"type":"null"}]},"delivery_option":{"oneOf":[{"$ref":"#/components/schemas/DeliveryOption"},{"type":"null"}]},"retail_store":{"oneOf":[{"$ref":"#/components/schemas/RetailStore"},{"type":"null"}]},"funds_transfer_bank":{"oneOf":[{"$ref":"#/components/schemas/BankAccount"},{"type":"null"}]},"number":{"oneOf":[{"type":"string","description":"Pre-order/order number"},{"type":"null"}]},"order":{"oneOf":[{"type":"object","description":"Created order (after checkout completion)","properties":{"pk":{"type":"integer"},"number":{"type":"string"},"status":{"type":"string"}}},{"type":"null"}]},"payment_choice":{"oneOf":[{"$ref":"#/components/schemas/PaymentChoice"},{"type":"null"}]},"user_email":{"oneOf":[{"type":"string"},{"type":"null"}]},"phone_number":{"oneOf":[{"type":"string"},{"type":"null"}]},"user_phone_number":{"oneOf":[{"type":"string"},{"type":"null"}]},"gift_box":{"oneOf":[{"type":"object","properties":{"note":{"type":"string"},"gift_video":{"type":"boolean"},"gift_video_notification_sent":{"type":"boolean"},"price":{"type":"string"}}},{"type":"null"}]},"delivery_range":{"oneOf":[{"type":"object","properties":{"lower":{"type":"string","format":"date-time"},"upper":{"type":"string","format":"date-time"}}},{"type":"null"}]},"total_amount_with_interest":{"oneOf":[{"type":"string","pattern":"^\\d+\\.\\d{2}$"},{"type":"null"}]},"is_guest":{"type":"boolean"},"is_post_order":{"type":"boolean"},"data_source_shipping_options":{"oneOf":[{"type":"array","items":{"$ref":"#/components/schemas/DataSourceShippingOptionDetail"}},{"type":"null"}]},"attribute_based_shipping_options":{"oneOf":[{"type":"array","items":{"$ref":"#/components/schemas/PreOrderAttributeBasedShippingOption"}},{"type":"null"}]}}},"Basket":{"type":"object","properties":{"pk":{"type":"integer"},"total_amount":{"type":"string","pattern":"^\\d+\\.\\d{2}$"}}},"Address":{"type":"object","properties":{"pk":{"type":"integer"},"email":{"type":"string"},"phone_number":{"type":"string"},"first_name":{"type":"string"},"last_name":{"type":"string"},"country":{"$ref":"#/components/schemas/Country"},"city":{"$ref":"#/components/schemas/City"},"line":{"type":"string"},"title":{"type":"string"},"township":{"$ref":"#/components/schemas/Township"},"district":{"oneOf":[{"$ref":"#/components/schemas/District"},{"type":"null"}]},"postcode":{"type":"string"},"notes":{"type":"string"},"company_name":{"type":"string"},"tax_office":{"type":"string"},"tax_no":{"type":"string"},"e_bill_taxpayer":{"type":"boolean"},"is_corporate":{"type":"boolean"},"primary":{"type":"boolean"},"identity_number":{"type":"string"}}},"Country":{"type":"object","properties":{"pk":{"type":"integer"},"code":{"type":"string"},"name":{"type":"string"}}},"City":{"type":"object","properties":{"pk":{"type":"integer"},"name":{"type":"string"}}},"Township":{"type":"object","properties":{"pk":{"type":"integer"},"name":{"type":"string"}}},"District":{"type":"object","properties":{"pk":{"type":"integer"},"name":{"type":"string"}}},"ShippingOptionDetail":{"type":"object","description":"Detailed shipping option with calculated amount","properties":{"pk":{"type":"integer"},"name":{"type":"string"},"slug":{"type":"string"},"logo":{"oneOf":[{"type":"string","format":"uri"},{"type":"null"}]},"shipping_amount":{"type":"string","pattern":"^\\d+\\.\\d{2}$"},"description":{"oneOf":[{"type":"string"},{"type":"null"}]},"kwargs":{"type":"object","additionalProperties":true}}},"PaymentOptionDetail":{"type":"object","description":"Detailed payment option with type information","properties":{"pk":{"type":"integer"},"name":{"type":"string"},"slug":{"type":"string"},"payment_type":{"type":"string","enum":["credit_card","funds_transfer","bkm_express","loyalty_money","cash_register","gpay","redirection","stored_card","masterpass","masterpass_rest","credit_payment","pay_later","saved_card","confirmation","b2b","wallet","pay_on_delivery"]},"payment_type_label":{"type":"string"}}},"Installment":{"type":"object","properties":{"pk":{"type":"integer"},"installment_count":{"type":"integer"},"label":{"type":"string"},"price_with_accrued_interest":{"type":"string","pattern":"^\\d+\\.\\d{2}$"},"monthly_price_with_accrued_interest":{"type":"string","pattern":"^\\d+\\.\\d{2}$"}}},"DeliveryOption":{"type":"object","properties":{"pk":{"type":"integer"},"name":{"type":"string"},"delivery_option_type":{"type":"string","enum":["customer","retail_store","pickup_location"]},"is_active":{"type":"boolean"}}},"RetailStore":{"type":"object","properties":{"pk":{"type":"integer"},"name":{"type":"string"},"erp_code":{"type":"string"},"township":{"$ref":"#/components/schemas/Township"},"click_and_collect":{"type":"boolean"},"is_active":{"type":"boolean"}}},"BankAccount":{"type":"object","description":"Bank account for funds transfer payments","properties":{"pk":{"type":"integer"},"bank_name":{"type":"string","description":"Name of the bank"},"account_holder":{"type":"string","description":"Account holder name"},"iban":{"type":"string","description":"International Bank Account Number"},"currency":{"type":"string","description":"Currency code (e.g., \"USD\", \"EUR\", \"TRY\")"},"is_active":{"type":"boolean"}}},"PaymentChoice":{"type":"object","properties":{"value":{"type":"string"},"label":{"type":"string"},"price":{"type":"string","pattern":"^\\d+\\.\\d{2}$"}}},"DataSourceShippingOptionDetail":{"type":"object","description":"Data source shipping option for multi-vendor shipping","properties":{"pk":{"type":"integer"},"shipping_amount":{"type":"string","pattern":"^\\d+\\.\\d{2}$"},"shipping_option_name":{"type":"string"},"shipping_option_logo":{"oneOf":[{"type":"string","format":"uri"},{"type":"null"}]},"data_source":{"type":"object","properties":{"pk":{"type":"integer"},"title":{"type":"string"}}},"description":{"oneOf":[{"type":"string"},{"type":"null"}]}}},"PreOrderAttributeBasedShippingOption":{"type":"object","description":"Attribute-based shipping option selected for a product group","properties":{"pk":{"type":"integer"},"shipping_option_name":{"type":"string"},"shipping_option_logo":{"oneOf":[{"type":"string","format":"uri"},{"type":"null"}]},"shipping_amount":{"type":"string","pattern":"^\\d+\\.\\d{2}$"},"product_ids":{"type":"array","items":{"type":"integer"}},"attribute_value":{"type":"string"},"attribute_key":{"oneOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}]}}}}}}
````


---

# 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/checkout/shipping-and-delivery/select-shipping-options-per-attribute-value-group.md?ask=<question>&goal=<endgoal>
```

`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.