Home > widget-integration > AddToCartItem
AddToCartItem interface
Configuration for cart item addition
Supports both single product and multi-product addition patterns. Can be extended with custom properties for shop-specific needs.
Signature:
export interface AddToCartItem
Example 1
Single product addition
const item: AddToCartItem = {
productId: '12345',
quantity: 2,
properties: {
gift_message: 'Happy Birthday!'
}
};
Example 2
Multi-product addition
const items: AddToCartItem = {
items: [
{ id: '12345', quantity: 1 },
{ id: '67890', quantity: 2, selling_plan: 'subscription_123' }
]
};
Example 3
Subscription product
const item: AddToCartItem = {
productId: '12345',
quantity: 1,
selling_plan: 'subscription_monthly',
properties: {
subscription_frequency: 'monthly'
}
};
Properties
|
Property |
Modifiers |
Type |
Description |
|---|---|---|---|
|
(Optional) Array of items for multi-product addition | |||
|
string |
(Optional) Product variant ID for single product addition | ||
|
Record<string, unknown> |
(Optional) Custom properties for line item (gift messages, engraving, etc.) | ||
|
number |
(Optional) Quantity to add (default: 1) | ||
|
string | null |
(Optional) Selling plan ID for subscription products |