Introduction

This guide outlines the basket management API endpoints in the system. These endpoints allow you to manage shopping baskets and basket items, including adding products, updating quantities, applying voucher codes, and retrieving basket information.

The Basket API provides functionality for:

1. Basket Management

• Retrieve current basket details with all items and pricing

• Add products to the basket with quantity and attributes

• Set specific quantities for products (replacing existing quantities)

• Update basket item attributes (e.g., gift notes, custom fields)

• Apply and remove voucher codes for discounts

• Clear all items from the basket

• Get mini basket summary for quick overview

2. Item Operations

• Add products with configurable attributes

• Support for bundle products with chapter-based form data

• Manage sub-items (extra products, miscellaneous items)

• Update gift notes and custom attributes on basket items

• Automatic stock validation and unavailable product handling

3. Promotional Features

• Automatic application of promotional offers

• Voucher code validation and application

• Detailed discount information per item and basket

• Upsell message display for failed offers

• Support for coupon codes and bulk voucher codes

Each endpoint is designed to support e-commerce operations where users build and manage their shopping baskets before proceeding to checkout.

NOTE: All methods support session-based authentication via cookies (osessionid). The basket is automatically associated with the current session and user (if authenticated). Promotional offers are automatically applied after each basket modification.