Basket Offers

Retrieve basket offer details

get

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.

Path parameters

pkintegerRequired

Unique identifier of the basket offer

Example: 123

Responses

200

Successfully retrieved the basket offer details

application/json

404

Basket offer not found

application/json

500

Internal server error

application/json

get

/basket-offers/{pk}/

HTTPcURLJavaScriptPython

GET /basket-offers/{pk}/ HTTP/1.1
Host: sandbox.akinon.com
Accept: */*

{
  "pk": 123,
  "benefit_items": [
    {
      "pk": 456,
      "product": {
        "pk": 789,
        "name": "Sample Product",
        "sku": "PROD-001",
        "base_code": "BASE-001",
        "price": "99.99",
        "retail_price": "129.99",
        "currency_type": "tr",
        "price_type": "default",
        "unit_type": "quantity",
        "tax_rate": "18.00",
        "in_stock": true,
        "stock": 50,
        "absolute_url": "/product/789/",
        "product_type": "simple",
        "attributes": {
          "color": "Blue",
          "size": "Medium"
        },
        "attributes_kwargs": {
          "color": {
            "value": "Blue",
            "data_type": "text"
          }
        },
        "productimage_set": [
          {
            "pk": 1,
            "image": "/media/products/image1.jpg",
            "order": 1
          }
        ],
        "data_source": {
          "pk": 1,
          "name": "Main Warehouse"
        }
      },
      "benefit_price": {
        "total_price": "79.99",
        "discount": "20.00"
      }
    }
  ]
}