E-shop

The E-shop module provides complete e-commerce functionality including product management, order processing, and checkout.

Products

Create Product

Create a new product.

const result = await sdk.eshop.createProduct({
key: 'premium-widget',
description: 'A high-quality widget for all your needs',
nodeIds: ['node_widgets', 'node_premium'],
blocks: [
  {
    key: 'details',
    type: 'TEXT',
    content: {
      body: { en: 'Product specifications...' }
    }
  }
],
variants: [
  {
    sku: 'WIDGET-SM',
    prices: [{ market: 'USD', amount: 2999 }],
    stock: 100,
    attributes: [],
    weight: 500
  },
  {
    sku: 'WIDGET-LG',
    prices: [{ market: 'USD', amount: 3999 }],
    stock: 50,
    attributes: [],
    weight: 750
  }
],
status: 'ACTIVE'
});

Get Product

Retrieve a product by ID or slug.

// By ID
const result = await sdk.eshop.getProduct({
  id: 'prod_xyz789'
});

// By slug (locale-aware)
const result = await sdk.eshop.getProduct({
  slug: 'premium-widget'
});

List Products

List products with filtering and pagination.

const result = await sdk.eshop.getProducts({
ids: ['prod_1', 'prod_2'],
nodeIds: ['node_widgets'],
nodeId: 'node_featured',
blocks: ['details', 'specs'],
status: 'ACTIVE',
statuses: ['ACTIVE', 'DRAFT'],
query: 'premium',
sortField: 'createdAt',
sortDirection: 'desc',
cursor: null,
limit: 20,
createdAtFrom: 1704067200,
createdAtTo: 1706745600
});

const { items, cursor } = result;
items.forEach(product => {
console.log(product.key, product.variants);
});

Update Product

Update an existing product.

const result = await sdk.eshop.updateProduct({
  id: 'prod_xyz789',
  key: 'updated-widget',
  slug: { en: 'updated-widget', es: 'widget-actualizado' },
  access: 'PUBLIC',
  nodeIds: ['node_widgets', 'node_sale'],
  networkIds: [],
  blocks: [/* updated blocks */],
  variants: [
    {
      id: 'var_existing',
      sku: 'WIDGET-SM-V2',
      prices: [{ market: 'USD', amount: 3499 }],
      stock: 150,
      attributes: [],
      weight: 500
    }
  ],
  status: 'ACTIVE'
});

Delete Product

Delete a product.

await sdk.eshop.deleteProduct({
  id: 'prod_xyz789'
});

Orders

Create Order

Create a new order without payment processing (use checkout for payment).

const result = await sdk.eshop.createOrder({
  market: 'USD',
  items: [
    { productId: 'prod_xyz789', variantId: 'var_small', quantity: 2 },
    { productId: 'prod_abc456', variantId: 'var_default', quantity: 1 }
  ],
  blocks: [
    {
      key: 'shipping-notes',
      type: 'TEXT',
      content: { body: 'Leave at door' }
    }
  ]
});

Get Order

Retrieve an order by ID.

const order = await sdk.eshop.getOrder({
  id: 'ord_xyz789'
});

console.log(order.status, order.total, order.items);

List Orders

List orders with filtering.

const result = await sdk.eshop.getOrders({
accountId: 'acc_customer123',
statuses: ['CONFIRMED', 'SHIPPED'],
productIds: ['prod_xyz789'],
query: '[email protected]',
sortField: 'createdAt',
sortDirection: 'desc',
cursor: null,
limit: 50,
createdAtFrom: '2024-01-01',
createdAtTo: '2024-12-31'
});

result.items.forEach(order => {
console.log(order.id, order.status, order.total);
});

Update Order

Update order status or details.

await sdk.eshop.updateOrder({
id: 'ord_xyz789',
status: 'SHIPPED',
blocks: [
  {
    key: 'tracking',
    type: 'TEXT',
    content: { body: 'Tracking: 1Z999AA10123456784' }
  }
],
items: [
  { productId: 'prod_xyz', variantId: 'var_1', quantity: 2 }
],
payment: {
  // Optional payment update
}
});

Checkout

Get Quote

Calculate order total before checkout.

const quote = await sdk.eshop.getQuote({
items: [
  { productId: 'prod_xyz789', variantId: 'var_small', quantity: 2 }
],
paymentMethodId: 'pm_card_visa',
shippingMethodId: 'ship_standard',
promoCode: 'SAVE10',
blocks: [
  {
    key: 'gift-message',
    type: 'TEXT',
    content: { body: 'Happy Birthday!' }
  }
]
});

console.log('Subtotal:', quote.subtotal);
console.log('Discount:', quote.discount);
console.log('Shipping:', quote.shipping);
console.log('Tax:', quote.tax);
console.log('Total:', quote.total);

Checkout

Process payment and complete order.

const result = await sdk.eshop.checkout({
items: [
  { productId: 'prod_xyz789', variantId: 'var_small', quantity: 2 }
],
paymentMethodId: 'pm_card_visa',
shippingMethodId: 'ship_standard',  // Required
blocks: [
  {
    key: 'customer-info',
    type: 'FORM',
    content: {
      email: '[email protected]',
      firstName: 'John',
      lastName: 'Doe'
    }
  }
],
promoCodeId: 'promo_save10'
});

if (result.requiresAction) {
// 3D Secure required
window.location.href = result.redirectUrl;
} else {
// Payment complete
console.log('Order placed:', result.order);
}

Complete Checkout Flow

import { loadStripe } from '@stripe/stripe-js';

const stripe = await loadStripe('pk_live_xxx');

async function checkout(cart: CartItem[]) {
  // 1. Get quote to show prices
  const quote = await sdk.eshop.getQuote({
    items: cart.map(item => ({
      productId: item.productId,
      variantId: item.variantId,
      quantity: item.quantity
    })),
    shippingMethodId: selectedShipping,
    promoCode: promoCodeInput
  });

  console.log('Total:', quote.total);

  // 2. Create Stripe payment method
  const { paymentMethod, error } = await stripe.createPaymentMethod({
    type: 'card',
    card: cardElement,
    billing_details: {
      email: customerEmail
    }
  });

  if (error) {
    throw new Error(error.message);
  }

  // 3. Checkout
  const result = await sdk.eshop.checkout({
    items: cart.map(item => ({
      productId: item.productId,
      variantId: item.variantId,
      quantity: item.quantity
    })),
    paymentMethodId: paymentMethod.id,
    shippingMethodId: selectedShipping,
    blocks: [
      {
        key: 'customer',
        type: 'FORM',
        content: {
          email: customerEmail,
          firstName: customerFirstName,
          lastName: customerLastName,
          address: shippingAddress
        }
      }
    ],
    promoCodeId: appliedPromoId
  });

  if (result.requiresAction) {
    // Handle 3D Secure
    const { error } = await stripe.confirmCardPayment(
      result.clientSecret
    );
    if (error) throw new Error(error.message);
  }

  return result.order;
}