Akinon Release Notes 09/28/2026) are now live! Click here to learn what's new.
Ctrlk
Docs Portal
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Bundle Product

Bundle product with chapter-based configuration

Retrieve bundle product detail

get

Returns detail information for a bundle product with chapter-based configuration.

Bundle Products: Bundle products allow customers to build custom combinations by selecting items from different chapters (categories). Examples:

  • Build-your-own computer (CPU chapter, RAM chapter, Storage chapter)

  • Custom gift box (main item, accessories, packaging)

  • Personalized product with custom attributes

Chapters: Each chapter represents a selection category with:

  • Required or optional status

  • Form schema for additional inputs (e.g., engraving text)

  • Available product variants within the chapter

Navigation:

  • Use current_chapter parameter to navigate between chapters

  • Use current_page for pagination within chapters

  • Selected attributes are tracked across chapters

Path parameters
product_idintegerRequired

Unique identifier of the bundle product.

Must be a product with type "bundle".

Example: 9012
Query parameters
current_chapterstringOptional

Slug or identifier of the chapter to display.

If not provided, defaults to the first chapter.

Example: cpu-selection
current_pagestringOptional

Page number within the current chapter for pagination.

Defaults to "1" if not specified.

Default: 1Example: 1
Responses
200

Bundle product detail retrieved successfully

application/json

Response for bundle product detail page with chapter navigation.

in_stockbooleanRequired

Aggregate stock status for the bundle.

Example: true
current_pagestringOptional

Current page number within the chapter.

Default: 1Example: 1
get/bundle-product/{product_id}/
GET /bundle-product/{product_id}/ HTTP/1.1
Host: sandbox.akinon.com
Accept: */*

{
  "in_stock": true,
  "bundle_product": {
    "pk": 12345,
    "name": "Premium Running Shoes - Blue/White",
    "sku": "SHOE-RUN-BLU-42",
    "base_code": "SHOE-RUN-BLU",
    "attributes": {
      "color": "Blue",
      "size": "42",
      "material": "Synthetic"
    },
    "attribute_set": 15,
    "attributes_kwargs": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "extra_attributes": null,
    "productimage_set": [
      {
        "pk": 98765,
        "status": "active",
        "image": "https://cdn.akinon.com/products/shoe-main.jpg",
        "order": 1,
        "thumbnail": "https://cdn.akinon.com/products/shoe-main-thumb.jpg",
        "mid_thumbnail": "https://example.com",
        "detailed_thumbnail": "https://example.com"
      }
    ],
    "productvideo_set": [
      {
        "pk": 1,
        "video_type": "text",
        "video": "https://example.com"
      }
    ],
    "price": "149.99",
    "retail_price": "199.99",
    "currency_type": "try",
    "price_type": "default",
    "tax_rate": "18.00",
    "in_stock": true,
    "stock": 25,
    "unit_type": "quantity",
    "product_type": "0",
    "absolute_url": "/products/premium-running-shoes-12345/",
    "form_schema": [
      {
        "key": "text",
        "label": "text",
        "type": "text",
        "required": true,
        "options": [
          {}
        ]
      }
    ],
    "is_ready_to_basket": true,
    "data_source": {
      "pk": 42,
      "name": "seller-123",
      "title": "Premium Electronics Store",
      "slug": "premium-electronics"
    },
    "basket_offers": [
      {}
    ],
    "is_listable": true,
    "listing_code": "SHOE-RUN-BLU"
  },
  "chapters": [
    {
      "chapter": {
        "pk": 101,
        "name": "Select Your Processor",
        "slug": "cpu-selection",
        "order": 1,
        "is_required": true,
        "form_schema": [
          {
            "key": "text",
            "label": "text",
            "type": "text",
            "required": true,
            "options": [
              {}
            ]
          }
        ],
        "attributes": {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        },
        "attributes_kwargs": {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        }
      },
      "variants": [
        {
          "attribute_key": "size",
          "attribute_name": "Size",
          "options": [
            {
              "is_selected": true,
              "is_selectable": true,
              "is_selectable_without_stock": null,
              "in_stock": null,
              "order": "1",
              "label": "42 EU",
              "value": "42",
              "product": {
                "pk": 12345,
                "name": "Premium Running Shoes - Blue/White",
                "sku": "SHOE-RUN-BLU-42",
                "base_code": "SHOE-RUN-BLU",
                "attributes": {
                  "color": "Blue",
                  "size": "42",
                  "material": "Synthetic"
                },
                "attribute_set": 15,
                "attributes_kwargs": {
                  "ANY_ADDITIONAL_PROPERTY": "anything"
                },
                "extra_attributes": null,
                "productimage_set": [
                  {
                    "pk": 98765,
                    "status": "active",
                    "image": "https://cdn.akinon.com/products/shoe-main.jpg",
                    "order": 1,
                    "thumbnail": "https://cdn.akinon.com/products/shoe-main-thumb.jpg",
                    "mid_thumbnail": "https://example.com",
                    "detailed_thumbnail": "https://example.com"
                  }
                ],
                "productvideo_set": [
                  {
                    "pk": 1,
                    "video_type": "text",
                    "video": "https://example.com"
                  }
                ],
                "price": "149.99",
                "retail_price": "199.99",
                "currency_type": "try",
                "price_type": "default",
                "tax_rate": "18.00",
                "in_stock": true,
                "stock": 25,
                "unit_type": "quantity",
                "product_type": "0",
                "absolute_url": "/products/premium-running-shoes-12345/",
                "form_schema": [
                  {
                    "key": "text",
                    "label": "text",
                    "type": "text",
                    "required": true,
                    "options": [
                      {}
                    ]
                  }
                ],
                "is_ready_to_basket": true,
                "data_source": {
                  "pk": 42,
                  "name": "seller-123",
                  "title": "Premium Electronics Store",
                  "slug": "premium-electronics"
                },
                "basket_offers": [
                  {}
                ],
                "is_listable": true,
                "listing_code": "SHOE-RUN-BLU"
              }
            }
          ]
        }
      ]
    }
  ],
  "current_chapter": {
    "pk": 101,
    "name": "Select Your Processor",
    "slug": "cpu-selection",
    "order": 1,
    "is_required": true,
    "form_schema": [
      {
        "key": "text",
        "label": "text",
        "type": "text",
        "required": true,
        "options": [
          {}
        ]
      }
    ],
    "attributes": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "attributes_kwargs": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  },
  "current_page": "1",
  "selected_attributes": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

Upload custom image for bundle product

post

Uploads a custom image for personalized bundle products.

Use Case: Some bundle products allow customers to upload custom images for personalization (e.g., photo printing, custom engravings). This endpoint handles the image upload process.

Response: Returns the uploaded file information including:

  • Generated UUID for tracking

  • Original filename

  • Storage path for the uploaded image

Path parameters
product_idintegerRequired

Unique identifier of the bundle product

Example: 9012
Body
imagestring · binaryRequired

Image file to upload (Base64 encoded)

chapterstringRequired

Chapter slug for which the image is being uploaded

Responses
200

Image uploaded successfully

application/json
uuidstringOptional

Unique identifier for the uploaded file

Example: a1b2c3d4-e5f6-7890-abcd-ef1234567890
filenamestringOptional

Original filename of the uploaded image

Example: custom-design.jpg
file_pathstringOptional

Storage path where the image was saved

Example: user-inputs/bundle-product/a1b2c3d4-e5f6-7890-abcd-ef1234567890.jpg
post/bundle-product/{product_id}/
POST /bundle-product/{product_id}/ HTTP/1.1
Host: sandbox.akinon.com
Content-Type: multipart/form-data
Accept: */*
Content-Length: 35

{
  "image": "binary",
  "chapter": "text"
}
{
  "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "filename": "custom-design.jpg",
  "file_path": "user-inputs/bundle-product/a1b2c3d4-e5f6-7890-abcd-ef1234567890.jpg"
}
PreviousGrouped Product
NextCategory

Last updated

Was this helpful?