Product Unit

The Product Unit API provides endpoints for managing individual units of products in the Onlive system. Product units represent physical or virtual instances of products that can be tracked, managed, and assigned to specific users or groups.

🔒 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/product-units

🔑 Unit Structure

Product units are structured with these key components:

1. Core Unit: Base entity with unique identifier and status
2. Product Reference: Link to parent product
3. Assignment: User or group ownership details
4. Properties: Unit-specific attributes
5. Status: Current state and availability

🛠️ Available Operations

Unit Management

• Create new product units
• Retrieve unit details and list units
• Update existing unit properties
• Delete/deactivate units

Assignment Operations

• Assign units to users or groups
• Transfer unit ownership
• Track unit assignments
• Manage unit access rights

Common Tasks

• Check unit availability
• Update unit status
• Track unit history
• Manage unit metadata

📘 Common Use Cases

• 📱 Device Management: Track individual devices or licenses
• 🎮 Virtual Assets: Manage digital product instances
• 📦 Physical Products: Track serialized items
• 👥 User Assignment: Manage product unit allocation
• 🔄 Usage Tracking: Monitor unit utilization

⚡ Best Practices

1. Unit Identification

   • Use consistent naming conventions
   • Maintain unique identifiers
   • Track serial numbers when applicable

2. Assignment Management

   • Validate user/group existence
   • Maintain assignment history
   • Handle transfers properly

3. Status Updates

   • Keep status current
   • Document status changes
   • Use appropriate status types

4. Data Quality

   • Validate input data
   • Maintain audit trails
   • Keep metadata updated

5. Performance

   • Batch unit operations
   • Optimize queries
   • Cache unit data

🔗 Related Resources

• Unit Properties: Detailed property definitions
• Authentication: Authentication details
• Asset Overview: General asset management
• Product API: Product management

❌ Common Errors

Code	Description	Resolution
INVALID_REQUEST	Invalid request body	Check request format and required fields
NOT_FOUND	Unit not found	Verify unit ID or create new unit
FORBIDDEN	Permission denied	Check user group access rights
VALIDATION_ERROR	Field validation failed	Check field requirements and formats

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