Skip to main content

Unified Basket Manager

1. Overview​

The Unified Basket Manager API provides a powerful way to calculate accurate, real-time basket prices for digital channels, such as webshops and mobile apps. Its primary purpose is to ensure omnichannel price consistency by using the very same pricing engine that powers the physical in-store checkout systems.

This service allows you to build a complete shopping basket, apply complex promotions, and seamlessly transition it into a final sales order, guaranteeing that your customers see the same price online as they would at the till.

2. Core Functionality​

The API is built around several key capabilities that work together to create a comprehensive and accurate shopping cart experience.

Unified Pricing Engine​

The core of the service is its ability to replicate the in-store pricing logic. This goes beyond simple list prices and includes all business rules, ensuring that every calculation is consistent across all sales channels.

Complex Promotions, Coupons, and Loyalty​

The API provides robust support for applying a wide array of discounts and offers to the basket, including:

  • Multi-buy promotions (e.g., "2 for 1")
  • Percentage or fixed-amount coupons
  • Personalized loyalty rewards and points
  • Order-level discounts

Contextual Basket Data​

A basket is more than just a list of products. The API allows you to enrich the basket with essential metadata that can influence the final price and fulfillment process. This includes:

  • Customer Information: Name, contact details, and loyalty ID.
  • Fulfillment Method: Details for in-store pickup or home delivery, which may affect final costs like shipping fees or local taxes.

3. The Checkout Workflow: From Basket to Order​

The API manages the basket's lifecycle, culminating in the checkout process. It's important to understand the transition from a dynamic basket to a finalized order.

  1. Building the Basket: Initially, the basket is a flexible object. You can add or remove items, apply coupons, and update customer details. The API will recalculate the price with each change.
  2. Finalizing for Checkout: Before checkout, you must ensure the basket contains all required data, especially customer and fulfillment information.
  3. Creating the Customer Order: The checkout operation is the final step. This action converts the temporary basket into a permanent Customer Order by calling the Customer Order Service. Once this is done, the basket is typically locked.

4. API Reference​

The Unified Basket Manager OpenAPI specification is available at:

https://unified-basket-manager-api.retailsvc.com/schemas/v1/openapi.json