Version: 1.0.0
VTO Partner API
Overview
The VTO Partner API gives you full control over your Virtual Try-On catalog and digitalization process. With this API, you can:
- Build and manage your product catalog - Create brands, categories, products, and variants programmatically
- Upload and organize product images - Manage all visual assets for your VTO experience
- Configure digitalization settings - Define how each variant appears in the virtual try-on
- Control inventory availability - Update stock status in real time. Out-of-stock variants stay visible with an out-of-stock label; to hide a variant, set its status to draft or archived
- Automate catalog updates - Sync your existing product database with the VTO platform
You can create or update a ready-to-use catalog at any time, giving you the flexibility to manage your VTO experience independently without manual intervention.
Setup
- Get your API key from your account manager
- Set the
api_keyvariable in your requests - Set
project_keyto your project slug
Authentication
All requests require the X-API-Key header.
Workflow Order
When creating data from scratch, follow this order:
- Images - Upload images first (required for brands, categories, products)
- Brands - Create brands (required for products)
- Categories - Create categories (required for products)
- Products - Create products (requires brands, categories, images)
- Variants - Create variants with digitizer config (requires products)
- Stock - Update stock status for variants
Authentication
- API Key: ApiKeyAuth
All API requests require authentication via the X-API-Key header. Set the api_key variable in your environment.
Security Scheme Type: | apiKey |
|---|---|
Header parameter name: | X-API-Key |