Getting Started

Use the Revi API to synchronize commerce data, read review statistics, and retrieve reviews for reporting or external systems.

Base URLs

Environment	Base URL
Production API	https://api.revi.io

Current API

All endpoint paths in this documentation are relative to https://api.revi.io.

Use https://api.revi.io/api/2026-04 for public integrations:

curl "https://api.revi.io/api/2026-04/ping" \
  -H "Accept: application/json" \
  -H "X-API-KEY: revi_test_xxxxxxxxx"

Integration Workflow

1. Call GET /api/2026-04/ping to verify the API key.
2. Send products with POST /api/2026-04/products.
3. Send orders with POST /api/2026-04/orders.
4. Link products to orders with POST /api/2026-04/orders/{id_order}/products.
5. Update order status with PATCH /api/2026-04/orders/{id_order}/status.
6. Retrieve reviews, product ratings, and shop statistics.

Supported Resources

Resource	Main endpoints
System	GET /api/2026-04/ping
Shop	GET /api/2026-04/shop, GET /api/2026-04/shop/stats
Orders	GET /api/2026-04/orders, POST /api/2026-04/orders, GET /api/2026-04/orders/{id_order}, PATCH /api/2026-04/orders/{id_order}/status, POST /api/2026-04/orders/{id_order}/products
Products	GET /api/2026-04/products, POST /api/2026-04/products, GET /api/2026-04/products/{id_product}, GET /api/2026-04/products/{id_product}/reviews
Reviews	GET /api/2026-04/reviews, GET /api/2026-04/reviews/{id}

Data Formats

Endpoints use JSON request bodies and JSON responses.

Use this datetime format unless an endpoint states otherwise:

YYYY-MM-DD HH:MM:SS

Decimals should use fixed decimal formatting:

30.50

First Check

Call GET https://api.revi.io/api/2026-04/ping to confirm the API key resolves to a business.

Successful responses include a Revi-Version header and a JSON envelope:

{
  "success": true,
  "data": {
    "message": "pong",
    "business": "example.com"
  },
  "meta": {
    "api_version": "2026-04"
  }
}