Comprehensive REST API for managing e-commerce operations including products, orders, customers, payments, and fulfillment.
The Vrio API provides comprehensive programmatic access to manage every aspect of your e-commerce operations. Built as a RESTful API, it enables you to integrate Vrio with your existing systems, automate workflows, and build custom applications on top of the Vrio platform.
Getting Started
Authentication
All API requests require authentication using API keys. Learn how to retrieve your API credentials, configure required headers (including the X-Api-Key header), and troubleshoot common authentication errors like 403 responses.
Understanding Responses
The Vrio API uses standard HTTP response codes and provides detailed error messages to help you debug issues. Learn how to interpret response codes, handle validation errors with specific error codes and field-level feedback, and implement proper error handling in your applications.
Customer APIs
Build powerful customer-facing features with APIs that manage customer profiles, addresses, payment methods, and subscription lifecycles. Enable customers to update their subscriptions, manage billing frequencies, pause or skip renewals, and access their order history through your custom interface.
Key Features:
- Customer profile and payment method management
- Subscription lifecycle control (pause, resume, cancel, swap offers)
- Self-service billing frequency adjustments
- Order history and tracking access
Payment APIs
Process one-time and recurring payments with comprehensive order management capabilities. The Payment APIs handle everything from initial order creation to complex scenarios like 3D Secure authentication, payment method fallbacks, and multi-step checkout flows.
Key Features:
- Single and multi-step order processing
- 3D Secure (3DS) authentication handling
- Response code 101 workflows for additional verification
- Duplicate transaction prevention with idempotency
- Post-purchase upsells and order modifications
- Payment method routing and retry logic
Upgrading to the Vrio API
If you're currently using the legacy API (Sublytics), learn about the benefits and process of upgrading.