# Basket Offers

## Retrieve basket offer details

> Returns detailed information about a specific basket offer, including\
> the list of benefit items (products) that are part of the offer and their\
> special pricing information.\
> \
> Only active basket offers that are available for the current currency\
> are returned. The offer must be currently active based on its status\
> and date range.<br>

```json
{"openapi":"3.0.0","info":{"title":"Basket Offers API","version":"1.0.0"},"servers":[{"description":"Server base URL for address operations","url":"https://{commerce_url}","variables":{"commerce_url":{"default":"sandbox.akinon.com","description":"Commerce server URL"}}}],"paths":{"/basket-offers/{pk}/":{"get":{"summary":"Retrieve basket offer details","description":"Returns detailed information about a specific basket offer, including\nthe list of benefit items (products) that are part of the offer and their\nspecial pricing information.\n\nOnly active basket offers that are available for the current currency\nare returned. The offer must be currently active based on its status\nand date range.\n","operationId":"getBasketOffer","tags":["Basket Offers"],"parameters":[{"name":"pk","in":"path","required":true,"description":"Unique identifier of the basket offer","schema":{"type":"integer"}}],"responses":{"200":{"description":"Successfully retrieved the basket offer details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BasketOfferResponse"}}}},"404":{"description":"Basket offer not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}}},"components":{"schemas":{"BasketOfferResponse":{"type":"object","description":"Response containing basket offer details with benefit items","required":["pk","benefit_items"],"properties":{"pk":{"type":"integer","description":"Unique identifier of the basket offer"},"benefit_items":{"type":"array","description":"List of products that are part of this basket offer's benefit collection.\nEach item includes product details and special pricing information\ncalculated based on the offer rules.\n","items":{"$ref":"#/components/schemas/BenefitItem"}}}},"BenefitItem":{"type":"object","description":"A product included in the basket offer with its benefit pricing","required":["pk","product","benefit_price"],"properties":{"pk":{"type":"integer","description":"Unique identifier of the product collection item"},"product":{"$ref":"#/components/schemas/ProductDetail"},"benefit_price":{"$ref":"#/components/schemas/BenefitPrice"}}},"ProductDetail":{"type":"object","description":"Detailed product information including pricing, availability, and attributes","required":["pk","name","sku","price","in_stock"],"properties":{"pk":{"type":"integer","description":"Unique identifier of the product"},"name":{"type":"string","description":"Product name"},"sku":{"type":"string","description":"Stock Keeping Unit identifier"},"base_code":{"type":"string","description":"Base product code"},"price":{"type":"string","description":"Current selling price of the product. Represented as a string to\npreserve decimal precision.\n"},"retail_price":{"type":"string","description":"Original retail price before any discounts. Represented as a string\nto preserve decimal precision.\n"},"currency_type":{"type":"string","description":"Currency code for the pricing","enum":["tr","usd","eur"]},"price_type":{"type":"string","description":"Type of pricing applied","enum":["default","special","campaign"]},"unit_type":{"type":"string","description":"Unit of measurement for the product","enum":["quantity","weight","volume"]},"tax_rate":{"type":"string","description":"Tax rate applied to the product. Represented as a string to preserve\ndecimal precision.\n"},"in_stock":{"type":"boolean","description":"Indicates whether the product is currently available for purchase"},"stock":{"type":"integer","description":"Available stock quantity"},"absolute_url":{"type":"string","format":"uri","description":"Absolute URL to the product detail page"},"product_type":{"type":"string","description":"Type of product","enum":["simple","variant","grouped","bundle","offer"]},"attributes":{"type":"object","description":"Product attributes as key-value pairs. The structure depends on\nthe product's attribute configuration.\n","additionalProperties":true},"attributes_kwargs":{"type":"object","description":"Additional metadata for product attributes, including data type\ninformation and translation data where applicable.\n","additionalProperties":true},"productimage_set":{"type":"array","description":"List of product images","items":{"$ref":"#/components/schemas/ProductImage"}},"productvideo_set":{"type":"array","description":"List of product videos","items":{"$ref":"#/components/schemas/ProductVideo"}},"data_source":{"$ref":"#/components/schemas/DataSource"},"form_schema":{"type":"array","description":"Form schema configuration for product attributes that can be\ncustomized by the customer.\n","items":{"type":"object"},"nullable":true},"is_ready_to_basket":{"type":"boolean","description":"Indicates whether the product is ready to be added to the shopping\nbasket (e.g., all required attributes are configured).\n"},"extra_attributes":{"type":"object","description":"Additional product attributes beyond the standard set","additionalProperties":true,"nullable":true}}},"ProductImage":{"type":"object","description":"Product image information","properties":{"pk":{"type":"integer","description":"Unique identifier of the image"},"image":{"type":"string","format":"uri","description":"URL to the product image"},"order":{"type":"integer","description":"Display order of the image"},"status":{"type":"string","description":"Status of the image","enum":["active","inactive"]},"created_date":{"type":"string","format":"date-time","description":"Timestamp when the image was created"}}},"ProductVideo":{"type":"object","description":"Product video information","properties":{"pk":{"type":"integer","description":"Unique identifier of the video"},"video_url":{"type":"string","format":"uri","description":"URL to the product video"},"order":{"type":"integer","description":"Display order of the video"}}},"DataSource":{"type":"object","description":"Information about the data source (warehouse/supplier) for the product","properties":{"pk":{"type":"integer","description":"Unique identifier of the data source"},"name":{"type":"string","description":"Name of the data source"},"slug":{"type":"string","description":"URL-friendly identifier for the data source"}}},"BenefitPrice":{"type":"object","description":"Special pricing information for the product when purchased as part of\nthis basket offer. The pricing is calculated based on the offer's benefit\nrules and may include discounts or special pricing.\n","properties":{"total_price":{"type":"string","description":"The final price for the product after applying the offer benefit.\nRepresented as a string to preserve decimal precision.\n"},"discount":{"type":"string","description":"The discount amount applied to the product. Represented as a string\nto preserve decimal precision. May be empty if the offer does not\nprovide a discount.\n"}},"additionalProperties":false},"Error":{"type":"object","description":"Standard error response","properties":{"detail":{"type":"string","description":"Error message describing what went wrong"}}}}}}
```