API Documentation
Base URL: https://api.kwiree.net/v1
Authentication: Bearer token in Authorization header
Core Endpoints
/catalogs/{catalog_id}/productsIngest or update products
Max batch size: 10,000 products per request
/catalogs/{catalog_id}/searchExecute search query
Avg latency: 80ms, P99: <150ms
/analytics/queriesRetrieve query analytics
Metrics: query volume, zero-result rate, latency
Request/Response Examples
Ingest Products
curl -X POST https://api.kwiree.net/v1/catalogs/my-store/products \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"products": [
{
"id": "prod_123",
"title": "Wireless Headphones",
"description": "Bluetooth 5.0, 30hr battery...",
"price": 79.99,
"category": "Electronics",
"attributes": {
"brand": "AudioTech",
"color": "Black"
}
}
]
}'Search
curl -X POST https://api.kwiree.net/v1/catalogs/my-store/search \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"query": "wireless headphones",
"limit": 10,
"filters": {
"category": "Electronics",
"price": { "max": 100 }
}
}'Integration Guide
Getting started takes 1-2 weeks:
Week 1: Integration & Testing
Week 2: Production Rollout
Common Integration Patterns
Shopify
Custom app with webhook for product updates
BigCommerce
API integration via middleware
Custom
Direct REST API, webhooks for real-time updates
Gotchas to Watch For
Attribute mapping
Your schema must map to Kwiree schema. See attribute guide.
Multi-language
English only at this time. Multi-language support on roadmap.
Index updates
Happens in the background asynchronously. Not instant.
Fallback
Build failover to your current search if API is down.
What You'll Need
Developer Time
~20-30 hours for full integration
Catalog Data
Product IDs, titles, descriptions, attributes
Query Logs
Required for relevance measurement (optional for integration)
Staging Environment
To test before production deployment