Product

The Product API provides comprehensive endpoints for managing products and their variants in the Onlive system. These endpoints enable full lifecycle management of products, including creation, retrieval, updates, and deletion, along with variant and option management.

🔒 Authentication

All endpoints require authentication using the ONLIVESITE authentication scheme. Include the Authorization header in your requests:

Authorization: ONLIVESITE Credential:ONLIVEAccessKeyId, Signature=CalculatedSignature

🌐 Base URL

https://openapi.onlive.site/api/v1/products

🔍 Product Types

The system supports various product provider types:

• onlive - Native Onlive products
• shopify-private - Private Shopify integration products
• shopify-public - Public Shopify integration products
• moddo - Moddo integration products
• prestashop - PrestaShop integration products
• woocommerce - WooCommerce integration products

📦 Product Structure

Products in the system are structured hierarchically:

1. Product: The main entity containing general information
2. Options: Configurable attributes (e.g., size, color)
3. Variants: Specific combinations of options with unique:
   • SKU
   • Price
   • Stock level
   • Images
   • Option combinations

🛠️ Available Operations

Product Management

• Create new products with variants and options
• Retrieve product details and list products
• Update existing products and their properties
• Delete products and associated data

Variant Operations

• Create and update product variants
• Manage variant-specific properties
• Update stock levels and prices
• Handle variant media assets

Common Operations

• Manage product categories
• Configure product options
• Handle product media
• Update inventory levels
• Set pricing and currency

📘 Common Use Cases

• 📦 Product Catalog: Create and manage your product catalog
• 🎨 Variants: Set up products with different options (size, color, etc.)
• 💰 Pricing: Update product prices and apply discounts
• 📊 Inventory: Manage stock levels across variants
• 🖼️ Media: Upload and manage product images
• 🔄 Integrations: Sync with external e-commerce platforms
• 🏷️ Categories: Organize products into categories

⚡ Best Practices

1. Product Structure

   • Define clear, unique product names
   • Use descriptive categories
   • Maintain consistent option naming

2. Variants

   • Use meaningful SKUs
   • Keep option combinations unique
   • Maintain accurate stock levels
   • Provide variant-specific images

3. Media

   • Use high-quality WebP images
   • Include multiple product angles
   • Optimize image sizes
   • Follow naming conventions

4. Data Quality

   • Keep descriptions detailed
   • Use proper HTML formatting
   • Maintain accurate metadata
   • Update prices consistently

5. Performance

   • Batch variant updates
   • Use efficient option structures
   • Optimize image delivery
   • Cache product data

🔗 Related Resources

• Product Properties: Detailed property definitions
• Authentication: Authentication details
• Asset Overview: General asset management
• Media Management: Handle product media

❌ Common Errors

Code	Description	Resolution
INVALID_REQUEST	Invalid request body	Check request format and required fields
DUPLICATE_SKU	SKU already exists	Use a unique SKU for the variant
OPTION_IN_USE	Cannot remove used option	Remove variant using option first
VALIDATION_ERROR	Field validation failed	Check field requirements and formats

For detailed information about specific operations, please refer to the individual endpoint documentation sections.