Shop API

List all products.

Filters: ?category={id}&is_active=true&search=keyword

{
  "success": true,
  "data": [
    {
      "id": "uuid",
      "name": "Premium T-Shirt",
      "slug": "premium-t-shirt",
      "price": "29.99",
      "compare_at_price": "39.99",
      "sku": "TSH-001",
      "is_active": true,
      "is_featured": true,
      "stock_quantity": 100,
      "category": {"id": "uuid", "name": "Apparel"},
      "variant_count": 3
    }
  ],
  "count": 25
}

Create a product.

{
  "name": "Premium T-Shirt",
  "slug": "premium-t-shirt",
  "description": "100% organic cotton t-shirt",
  "price": "29.99",
  "compare_at_price": "39.99",
  "sku": "TSH-001",
  "category_id": "uuid",
  "track_inventory": true,
  "stock_quantity": 100,
  "is_active": true,
  "is_featured": false,
  "features": ["100% organic", "Machine washable"],
  "technical_specs": {"material": "Cotton", "weight": "200g"}
}

Get, update, or delete a product.

Upload product image (multipart/form-data or base64 JSON).

Formats: JPEG, PNG, WebP (max 10MB)

List or create variants for a product.

Create Variant

{
  "title": "Large / Blue",
  "sku": "TSH-001-LG-BL",
  "price": "29.99",
  "stock_quantity": 25
}

Update or delete a variant.

List or create product categories.

{
  "name": "Apparel",
  "slug": "apparel",
  "description": "Clothing and accessories"
}

Update or delete a category.

Get or update shop settings.

Response

{
  "success": true,
  "data": {
    "is_enabled": true,
    "currency_code": "PYG",
    "currency_symbol": "Gs.",
    "supported_currencies": [],
    "layout": "grid",
    "products_per_page": 12,
    "show_categories": true,
    "url_prefix": "shop",
    "product_base": "product",
    "category_base": "category",
    "shop_url": "https://subdomain.escalateflow.com/shop/"
  }
}

Update example

curl -X PUT "https://escalateflow.com/api/v1/projects/{id}/shop/settings/" \
  -H "X-API-Key: ef_live_xxxxxxxxxxxxxxxxxxxx" \
  -H "Content-Type: application/json" \
  -d '{
    "currency_code": "PYG",
    "currency_symbol": "Gs.",
    "is_enabled": true,
    "shop_title": "Mi Tienda"
  }'

Get or update shop page HTML.

AI-generate a shop page.

{"prompt": "Create a modern shop page for a fashion brand"}

Get the product page template.

Add a product to the session cart.

curl -X POST "https://my-store.escalateflow.com/shop/cart/add/{product_id}/" \
  -H "Content-Type: application/json" \
  -d '{"quantity": 2}'

Get full cart contents with formatted prices. Used by the sidebar cart JavaScript.

Response

{
  "success": true,
  "items": [
    {
      "id": "uuid",
      "name": "Smart TV Samsung 55\" 4K",
      "slug": "smart-tv-samsung-55-4k",
      "price": "4290000.00",
      "price_formatted": "Gs. 4.290.000",
      "image_url": "https://...",
      "quantity": 2,
      "line_total": "8580000.00",
      "line_total_formatted": "Gs. 8.580.000"
    }
  ],
  "item_count": 1,
  "cart_count": 2,
  "subtotal": "8580000.00",
  "subtotal_formatted": "Gs. 8.580.000",
  "currency_symbol": "Gs."
}

The *_formatted fields include the currency symbol and locale-appropriate thousand/decimal separators based on the shop's currency_code setting. Raw decimal strings (price, subtotal) are also returned for backward compatibility.

Update item quantity. Body: {"quantity": 3}

Remove an item from the cart.

List or create hero slides.

{
  "title": "Summer Collection",
  "subtitle": "Up to 50% off",
  "image_url": "https://...",
  "cta_text": "Shop Now",
  "cta_url": "/shop/summer"
}

AI-generate hero slides.

Update or delete a hero slide.