Skip to main content
OPLOG’s Product API provides comprehensive product management capabilities for various business scenarios. This guide covers the essential requirements, configurations, and examples for creating different types of products in your catalog.

​
Integration Overview

The Product API is designed to handle multiple product types:
  • Simple Products - Basic product registration with minimal information
  • Physical Products - Detailed products with dimensions and weight
  • Digital Products - Software, books, and downloadable content
  • Apparel Products - Clothing with size and material specifications
  • Multi-currency Products - International products with different currencies
All products must include unique SKU, product name, and type. Optional features like images, categories, and pricing enhance the product catalog experience.

​
Creating Products

OPLOG’s Product POST endpoint has several required fields that you need to be aware of:

Quick Start Requirements

Essential Fields: SKU (unique), name, type, and barcodes are mandatory for all products.
1

Set Unique SKU

Define a unique product identifier that won’t be repeated system-wide
2

Add Product Information

Include name, type, and barcode arrays for product identification
3

Configure Optional Features

Add images, pricing, dimensions, and categories as needed

​
Core Requirements

{
  "sku": "LAPTOP-DELL-001"  // Unique product identifier
}
Requirements:
  • Must be unique for each product across the entire system
  • Cannot be repeated system-wide
  • Alphanumeric characters can be used
  • Recommended format: CATEGORY-BRAND-NUMBER
Examples:
  • "LAPTOP-DELL-001" ✅
  • "TSHIRT-BLU-M" ✅
  • "BOOK-PROG-001" ✅
{
  "name": "Dell Inspiron 15 3000 Laptop"  // Product display name
}
Requirements:
  • Product name is mandatory
  • Must use characters included in the ISO 8859-1 character set
  • Should be descriptive and customer-friendly
Best Practices:
  • Include brand name when applicable
  • Add key specifications (size, model, etc.)
  • Keep it concise but informative
{
  "type": "Product"  // Fixed value
}
Requirements:
  • Must be sent as fixed value "Product"
  • This field distinguishes products from other entity types
  • Always use exactly "Product" (case-sensitive)
{
  "barcodes": [
    "1234567890123",
    "9876543210987"
  ]
}
Requirements:
  • Can be sent as unique barcode arrays
  • Multiple barcodes are supported
  • Each barcode should be specified as a separate string
  • Should not exceed 100 characters per barcode
  • Should not contain special characters
  • Barcode fields supported to ISO 646
Multiple Barcodes:
  • Use array format for multiple barcodes
  • Each entry should be a separate string
  • Useful for products with multiple packaging formats

​
Optional Features

{
  "imageUrl": "https://example.com/images/laptop-dell.jpeg"
}
Requirements:
  • Only PNG and JPEG formats are supported
  • Must be publicly accessible URL
  • High-quality product image is recommended
Best Practices:
  • Use HTTPS URLs for security
  • Optimize images for web (reasonable file size)
  • Ensure consistent image dimensions across products
{
  "category": "Electronics/Computer"
}
Purpose:
  • Organize products into logical groups
  • Helps with catalog navigation and filtering
  • Use hierarchical structure with forward slashes
Examples:
  • "Electronics/Computer"
  • "Apparel/T-Shirt"
  • "Books/Technology"
  • "Home Decor/Vase"
{
  "price": 800.00,
  "salePrice": 700.00,
  "currency": "USD",
  "taxRatio": 8.25
}
Fields:
  • price - Regular product price
  • salePrice - Discounted price (optional)
  • currency - ISO 4217 currency code
  • taxRatio - Local tax rate (percentage)
Currency Support:
  • Must use ISO 4217 standardization
  • UNSUPPORTED value can be used for special cases
  • Price fields must be appropriate for the currency
{
  "width": 35.8,
  "length": 24.7,
  "height": 2.2,
  "weight": 1.83,
  "unitOfDimension": "Cm",
  "unitOfWeight": "Kg"
}
Requirements:
  • Dimensions in CM (centimeters)
  • Weight in KG (kilograms)
  • Important for shipping calculations
Default Units:
  • unitOfDimension: “Cm” (default)
  • unitOfWeight: “Kg” (default)
{
  "salesUrl": "https://mystore.com/products/dell-laptop"
}
Fields:
  • salesUrl - Product sales page link

​
Currency Support

Price fields must be appropriate for the selected currency. Use UNSUPPORTED value only for special cases.

​
Product Examples

Minimal product setup with required fields only.
{
  "sku": "BASIC-001",
  "barcodes": [
    "1234567890125",
    "9876543210983"
  ],
  "name": "Coffee Cup",
  "type": "Product"
}
Complete product information including dimensions, pricing, and images.
{
  "sku": "LAPTOP-DELL-001",
  "imageUrl": "https://example.com/images/laptop-dell.jpeg",
  "name": "Dell Inspiron 15 3000 Laptop",
  "barcodes": [
    "1234567890123",
    "9876543210987"
  ],
  "type": "Product",
  "category": "Electronics/Computer",
  "price": 800.00,
  "salePrice": 700.00,
  "currency": "USD",
  "taxRatio": 8.25,
  "salesUrl": "https://mystore.com/products/dell-laptop",
  "width": 35.8,
  "length": 24.7,
  "height": 2.2,
  "weight": 1.83,
  "unitOfDimension": "Cm",
  "unitOfWeight": "Kg"
}
Clothing item with size and material specifications.
{
  "sku": "TSHIRT-BLU-M",
  "imageUrl": "https://example.com/images/tshirt-blue.png",
  "name": "Blue Cotton T-Shirt - Medium",
  "barcodes": [
    "8690123456789"
  ],
  "type": "Product",
  "category": "Apparel/T-Shirt",
  "price": 29.99,
  "salePrice": 24.99,
  "currency": "USD",
  "taxRatio": 8.75,
  "salesUrl": "https://fashion.com/blue-tshirt-m",
  "width": 30,
  "length": 25,
  "height": 1,
  "weight": 0.2,
  "unitOfDimension": "Cm",
  "unitOfWeight": "Kg"
}
Digital or physical book with zero tax rate.
{
  "sku": "BOOK-PROG-001",
  "imageUrl": "https://example.com/images/programming-book.jpeg",
  "name": "JavaScript Programming Book",
  "barcodes": [
    "9786051234567"
  ],
  "type": "Product",
  "category": "Books/Technology",
  "price": 45.50,
  "currency": "USD",
  "taxRatio": 0,
  "salesUrl": "https://bookstore.com/js-programming",
  "width": 16,
  "length": 24,
  "height": 2,
  "weight": 0.4,
  "unitOfDimension": "Cm",
  "unitOfWeight": "Kg"
}
High-tech product with premium pricing.
{
  "sku": "WATCH-APPLE-001",
  "imageUrl": "https://example.com/images/apple-watch.png",
  "name": "Apple Watch Series 9",
  "barcodes": [
    "194253001652",
    "888462177638"
  ],
  "type": "Product",
  "category": "Electronics/Smart Watch",
  "price": 399.00,
  "salePrice": 349.00,
  "currency": "USD",
  "taxRatio": 8.25,
  "salesUrl": "https://techstore.com/apple-watch-9",
  "width": 4.5,
  "length": 3.8,
  "height": 1.1,
  "weight": 0.042,
  "unitOfDimension": "Cm",
  "unitOfWeight": "Kg"
}
Beauty product with organic certification.
{
  "sku": "CREAM-FACE-001",
  "imageUrl": "https://example.com/images/face-cream.png",
  "name": "Moisturizing Face Cream 50ml",
  "barcodes": [
    "8690987654321"
  ],
  "type": "Product",
  "category": "Cosmetics/Skincare",
  "price": 29.99,
  "salePrice": 24.99,
  "currency": "USD",
  "taxRatio": 8.75,
  "salesUrl": "https://beauty.com/face-cream-50ml",
  "width": 5,
  "length": 5,
  "height": 8,
  "weight": 0.1,
  "unitOfDimension": "Cm",
  "unitOfWeight": "Kg"
}
International product with Euro pricing.
{
  "sku": "PERFUME-EUR-001",
  "imageUrl": "https://example.com/images/perfume.png",
  "name": "French Perfume 100ml",
  "barcodes": [
    "3274872375475"
  ],
  "type": "Product",
  "category": "Cosmetics/Perfume",
  "price": 85.00,
  "salePrice": 75.00,
  "currency": "EUR",
  "taxRatio": 20.00,
  "salesUrl": "https://parfumstore.com/french-perfume",
  "width": 6,
  "length": 4,
  "height": 12,
  "weight": 0.15,
  "unitOfDimension": "Cm",
  "unitOfWeight": "Kg"
}

​
TAG Management

OPLOG.ONE’s TAG management system provides flexible metadata tagging capabilities across various business entities. Organizations can attach custom labels to records, transforming basic data into actionable intelligence for better workflow optimization. The system proves valuable for both operational efficiency and analytics. Teams can quickly identify and process records based on specific criteria - staff can locate items requiring special handling, managers can prioritize high-value transactions, and leadership can analyze performance metrics across different categories. This flexible approach eliminates rigid classification systems, allowing businesses to evolve their tagging strategies as operational needs change.

​
TAG Best Practices

Consistent Format

Use comma-separated format for multiple tags

Descriptive Tags

Include relevant keywords for better searchability

Regular Updates

Update tags when product status or categories change

Standardization

Establish tag naming conventions across your catalog
TAG Usage Examples:
  • Category Tags: electronics,computer,laptop
  • Status Tags: new-arrival,sale,clearance,discontinued
  • Feature Tags: wireless,gaming,professional,budget
  • Campaign Tags: black-friday,summer-sale,back-to-school
TAG management is designed specifically for post-creation metadata updates and provides flexible freetext categorization for your products.