The commerce engine behind Adorė.

Documentation

Three views of the same OpenAPI 3 schema, generated from the code so it never goes stale.

Quick start

From zero to a placed order in five calls.

Call it from anywhere

Bearer tokens, JSON in, JSON out.

const API = 'https://api.xn--ador-yva.com/api/v1';

const { token } = await fetch(`${API}/auth/login`, {
  method: 'POST', headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({ email: '[email protected]', password: 'adore123' }),
}).then(r => r.json());

const bag = await fetch(`${API}/bag/items`, {
  method: 'POST',
  headers: { 'Content-Type': 'application/json', Authorization: `Bearer ${token}` },
  body: JSON.stringify({ productId: 'p028', size: 'L', color: 'Green' }),
}).then(r => r.json());

console.log(bag.total); // naira, VAT and delivery included

import requests

API = "https://api.xn--ador-yva.com/api/v1"
s = requests.Session()
token = s.post(f"{API}/auth/login", json={"email": "[email protected]", "password": "adore123"}).json()["token"]
s.headers["Authorization"] = f"Bearer {token}"

r = s.get(f"{API}/products", params={"collection": "couples", "sort": "priceAsc"})
for p in r.json()["items"]:
    print(p["name"], p["price"])

TOKEN=$(curl -s -X POST https://api.xn--ador-yva.com/api/v1/auth/login \
  -H 'Content-Type: application/json' \
  -d '{"email":"[email protected]","password":"adore123"}' | jq -r .token)

curl -s https://api.xn--ador-yva.com/api/v1/orders -H "Authorization: Bearer $TOKEN" | jq '.orders[0].timeline'

Endpoint map

All paths are relative to /api/v1. 🔓 public · 🔐 shopper · 🛡️ staff

Error codes

Every error answers { code, message, status, requestId, details? }. The message is safe to show to shoppers.