Shopping

The Shopping API allows developers to build complete and scalable e-commerce experiences. It covers the full shopping journey — from product discovery and store navigation to cart management and order processing.

This documentation provides a conceptual overview, recommended integration flows, and links to the detailed API reference.

1. Load the Shopping homepage
2. Search or browse products
3. View product details
4. Navigate to a store page
5. Add products to the cart
6. Create and manage orders

Each section below explains how the Shopping API supports these steps.

Retrieve curated shopping data used to render the main shopping experience. This endpoint is typically used as the entry point to the shopping journey.

GET /v2/e-commerce/homepage/shopping

export type DynamicModel = DynamicSection[];

Each section groups related components and defines their layout.

export interface Section<T> {
  id?: string;
  title?: string;
  seeMoreRoute?: string;
  grid: 'horizontal' | 'vertical';
  data?: T;
}

A dynamic section is a section containing multiple components.

export type DynamicSection = Section<SectionComponent[]>;

Shared properties across all components.

interface SectionComponentBase {
  component: TypesComponent;
  route?: string; // Internal navigation
  url?: string;   // External navigation
}

Used for quick navigation or call-to-action elements.

export interface SectionButton extends SectionComponentBase {
  component: TypesComponent.button;
  icon: string;
  label?: string;
  color?: string;
  square?: boolean;
}

Common uses:

• Category shortcuts
• Promotional CTAs
• Entry points to key features

Used for promotional or informational content.

export interface SectionBanner extends SectionComponentBase {
  component: TypesComponent.banner;
  title?: string;
  description?: string;
  color?: string;
  icon: string;
}

Common uses:

• Campaign highlights
• Feature announcements
• Seasonal promotions

Represents a purchasable product displayed on the homepage.

export interface SectionProductCard extends SectionComponentBase {
  component: TypesComponent.product;
  description?: string;
  isShowcase?: boolean;
  id: string;
  name: string;
  image: string;
  enterprise: {
    id: string;
    name: string;
    icon: string;
    alias?: string;
  };
  amount: {
    wibx: string;
    original?: string;
    second: {
      coin: string;
      value: string;
    };
  };
  rating?: number;
  liked: boolean;
  visibility?: {
    grayed: boolean;
    message: string;
    visible: boolean;
  };
}

Common uses:

• Featured products
• Store recommendation
• Personalized product lists

export type SectionComponent =
  | SectionButton
  | SectionBanner
  | SectionProductCard;

export enum TypesComponent {
  button = 'button',
  banner = 'banner',
  product = 'product',
}

Search products globally or within a specific store using keywords and filters.

GET /v2/e-commerce/products/search

• Global search bar
• Store-specific product listings
• Infinite scrolling or paginated catalogs

Retrieve detailed information about a specific product, including pricing, availability, and additional metadata.

GET /v2/e-commerce/products/{enterpriseId}/{id}

/shopping/product/{storeId}/{productId}

• Product detail pages
• Product comparison views
• Add-to-cart flows

Retrieve store-specific homepage data to build a branded storefront experience.

GET /v2/e-commerce/homepage/store/{storeId}

/shopping/store/{storeId}

• Brand landing pages
• Enterprise-specific catalogs
• Dedicated store experiences

Manage the full lifecycle of a user’s shopping cart. The cart persists selected products and allows quantity updates before checkout.

GET    /v3/e-commerce/cart    - Retrieve current cart contents
POST   /v3/e-commerce/cart    - Add an item to the cart
PUT    /v3/e-commerce/cart    - Update item quantities
DELETE /v3/e-commerce/cart    - Remove all items from the cart

• Shopping cart screens
• Quantity adjustments
• Cart cleanup or reset flows

Create and manage customer orders after the checkout process.

POST /v3/e-commerce/orders

Used to finalize a cart and create an order.

GET /v2/e-commerce/orders

Used to display order history and order details.

POST /v3/e-commerce/orders/withdrawal

Used to confirm product pickup or withdrawal, when applicable.

• Checkout and payment confirmation
• Order history pages
• Fulfillment and pickup workflows