Introduction
Get started with the YaVendio Business API in minutes
The Business API lets YaVendio merchants programmatically read their orders, conversations, contacts and company profile, manage their product catalog and send WhatsApp template messages (once the account is enabled for sending). Use it to build integrations, sync data with external systems, or power custom dashboards.
Quick Start
Get your first API response in three steps:
1. Create an API Key
Go to the YaVendio Dashboard → Settings → API Keys and click "Create API Key". Assign a descriptive name; the key is created with full API access.
2. Make Your First Request
curl -X GET "https://api.ya.onl/v1/orders?page=1&limit=5" \
-H "X-API-Key: yv_live_v1_your_api_key"3. Explore the Response
{
"data": [
{
"id": 12345,
"order_date": "2026-03-10T15:30:00Z",
"status": "confirmed",
"currency": "PEN",
"total_amount": 139.70
}
],
"pagination": {
"page": 1,
"limit": 5,
"total_pages": 10,
"total_items": 48,
"has_more": true
}
}What's Next?
Authentication
Learn how API keys work, scopes, and best practices.
Pagination
Navigate through large result sets efficiently.
Rate Limiting
Understand request limits and how to handle them.
Error Handling
Handle errors gracefully in your integration.
Manage Products
Learn how to create and manage products with variants, options, media, and categories.
Template Messages
Write to a customer first with an approved template — recovering a cart, telling someone their order is ready — and check where the message got to.
