🛍️ E-Commerce API Documentation

🎯 What This API Does

• Product Management: Create, read, update, delete products with full specifications

• Category Organization: Organize products into hierarchical categories

• Brand Management: Manage product brands with many-to-many relationships

• Marketing Tools: Manage banners and promotional content

• Service Management: Handle repair, sell, exchange, and upgrade services

• Tagging System: Flexible product tagging for better organization

• Dynamic Attributes: Custom product attributes (color, storage, etc.)

• Linked Variations: Connect separate products as variations with attribute selection

• Frequently Bought Together: Cross-selling recommendations for related products

🎨 Display Types Supported:

Color Swatches: display_type: "color" - Perfect for color selection like in the realme watch example

Button Groups: display_type: "button" - Great for sizes (S, M, L, XL)

Dropdowns: display_type: "dropdown" - Ideal for storage options (64GB, 128GB, 256GB)

Text Display: display_type: "text" - Simple text-based selection

Image Gallery: display_type: "image" - Image-based selection for visual variants

💡 Frontend Implementation Example:

Color Swatches (like realme watch):

// Based on display_type: "color"
<div class="color-swatches">
  {variation_attributes.map(attr => 
    attr.display_type === 'color' && (
      <div key={attr.attribute.id} className="color-attribute">
        <label>{attr.attribute.name}</label>
        {attr.values.map(color => (
          <button 
            key={color}
            className="color-swatch"
            style={{backgroundColor: getColorCode(color)}}
            onClick={() => selectVariation(attr.attribute.id, color)}
          />
        ))}
      </div>
    )
  )}
</div>

🎯 Key Features:

Many-to-Many Relationships: Each product can have multiple frequently bought together products

Manual Admin Control: Complete control over which products are suggested together

Full Product Details: Returns complete product information including prices, images, ratings

Sort Order Support: Control the display order of suggestions

Active Products Only: Only shows active, in-stock products

Bidirectional Relationships: Supports both forward and reverse relationship queries

💡 Frontend Implementation Example:

Product Detail Page:

// Fetch frequently bought together products
const response = await fetch('/api/frequently-bought-together/product/1');
const data = await response.json();

// Display suggestions
if (data.success && data.data.frequently_bought_together.length > 0) {
  const suggestions = data.data.frequently_bought_together;
  
  suggestions.forEach(product => {
    // Create product card with:
    // - Product image
    // - Product name
    // - Price (with discount if applicable)
    // - Add to cart button
    // - Quick view button
  });
}

🛍️ Business Use Cases:

E-commerce Product Pages: Show "Customers who bought this also bought..." section

Cart Recommendations: Suggest complementary products during checkout

Category Pages: Display related products within categories

Email Marketing: Include product recommendations in promotional emails

Mobile Apps: Implement swipeable product suggestion carousels

Admin Dashboard: Manage cross-selling relationships and track performance

📊 Data Management:

Adding Relationships: Use POST /api/frequently-bought-together/add for each product pair

Bulk Import: Create scripts to import relationships from CSV or external systems

Analytics Integration: Track which relationships drive the most sales

Seasonal Updates: Update relationships based on seasonal trends and promotions

🛒 E-commerce Store Frontend

Scenario: Building a product catalog page

Steps:

1. Get categories: GET /api/categories

2. Get brands: GET /api/brands

3. Get featured products: GET /api/products/featured (includes brands, tags)

4. Get active banners: GET /api/banners

5. Get filterable attributes: GET /api/product-attributes/filterable

6. Get product details: GET /api/products/{id} (includes all relationships)

🔍 Product Search & Filtering

Scenario: Implementing product search with filters

Steps:

1. Get products by category: GET /api/products/category/smartphones

2. Get products by brand: GET /api/brands/apple/products

3. Get products by tag: GET /api/tags/premium/products

4. Get products by attribute: GET /api/product-attributes/color/products

5. Filter by specific attribute value (implement in frontend)

📱 Mobile App Integration

Scenario: Mobile app consuming the API

Steps:

1. Load initial data: Categories, brands, featured products, banners

2. Implement pagination for product lists

3. Use brands and tags for product recommendations

4. Display product details with attributes and brand info

🏷️ Brand Management

Scenario: Managing product brands and brand-product relationships

Steps:

1. Get all brands: GET /api/brands

2. Create new brand: POST /api/brands

3. Update brand info: PUT /api/brands/{id}

4. Get products by brand: GET /api/brands/{slug}/products

5. Manage brand-product relationships (implement in frontend)

🛠️ Admin Dashboard

Scenario: Managing store content

Steps:

1. CRUD operations for all entities (products, categories, brands, etc.)

2. Manage product tags and attributes

3. Update banners and promotional content

4. Monitor service offerings

📦 Product Management with Relationships

Scenario: Creating and managing products with brands, tags, and attributes

Steps:

1. Create product with relationships: POST /api/products (include brand_ids, tag_ids, attributes)

2. Update product relationships: PUT /api/products/{id} (replace all relationships)

3. Get product with all data: GET /api/products/{id}

4. Filter by brand: GET /api/brands/{slug}/products

5. Filter by tag: GET /api/tags/{slug}/products

6. Filter by attribute: GET /api/product-attributes/{slug}/products

🔗 Linked Variations Implementation

Scenario: Creating product variations like WooCommerce Linked Variations

Steps:

1. Create product group: POST /api/linked-variations/groups

2. Create individual products: POST /api/products (separate products for each variant)

3. Link products to group: POST /api/linked-variations/groups/{groupId}/link-products

4. Get linked variations: GET /api/linked-variations/product/{id}

5. Filter by attributes: GET /api/linked-variations/groups/{groupId}/products

6. Display with proper UI: Use display_type (color, button, dropdown) for frontend

🛒 Frequently Bought Together Implementation

Scenario: Implementing cross-selling recommendations on product pages

Steps:

1. Get product details: GET /api/products/{id}

2. Get frequently bought together: GET /api/frequently-bought-together/product/{id}

3. Display suggestions: Show related products with images, prices, and add-to-cart buttons

4. Track clicks: Monitor which suggestions are most effective

5. Manage relationships: POST /api/frequently-bought-together/add for new suggestions

6. Update relationships: DELETE /api/frequently-bought-together/remove for outdated suggestions

🔄 Third-party Integration

Scenario: Integrating with external systems

Steps:

1. Sync product data: GET /api/products

2. Update inventory: PUT /api/products/{id}

3. Manage categories: POST /api/categories

4. Handle webhooks for real-time updates

📚 Next Steps

• Explore all endpoints using the examples above

• Implement error handling in your application

• Add authentication for production use

• Set up rate limiting for API protection

• Monitor API usage and performance

🔧 Troubleshooting

• Check that the Laravel server is running: php artisan serve

• Verify database connection and migrations

• Check Laravel logs in storage/logs/

• Ensure all required fields are provided in requests