Skip to main content
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​

  1. Get your API key from your account manager
  2. Set the api_key variable in your requests
  3. Set project_key to your project slug

Authentication​

All requests require the X-API-Key header.

Workflow Order​

When creating data from scratch, follow this order:

  1. Images - Upload images first (required for brands, categories, products)
  2. Brands - Create brands (required for products)
  3. Categories - Create categories (required for products)
  4. Products - Create products (requires brands, categories, images)
  5. Variants - Create variants with digitizer config (requires products)
  6. Stock - Update stock status for variants

Authentication​

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