Your neighborhood marketplace. Your retail operating system.EGYPT · UAE · SAUDI ARABIA · GCC

POS & ERP API guide

Connect your own systems

Create a key in your retailer integration dashboard. Choose catalog read, catalog write, or order read access. Keep the key in your external system’s server settings.

Create an API keyDownload OpenAPI specification

Requests

Authorization: Bearer aswaq_api_YOUR_KEY
GET https://aswaqos.com/api/v1/products?limit=100
GET https://aswaqos.com/api/v1/orders?limit=100
POST https://aswaqos.com/api/v1/products
Content-Type: application/json

{"products":[{"sku":"YOUR-SKU","name":"Your product","price":"12.500","stock":20,"unit":"item","currency":"AED"}],"replace_stock":false}

The response returns a next cursor when there are more records. Pass it as after. Prices use the store currency; conversion is never automatic. Writes are limited to 100 products per request. Existing stock is preserved unless replace_stock is true. Replacing stock is blocked while orders are open.

Order exports contain totals, statuses and items, without customer names, phone numbers or addresses. Rate limit: 120 requests per key per minute. Revoking a key takes effect immediately.

Signed order events

Set a public HTTPS receiver and a shared secret. Verify HMAC-SHA256 of timestamp + "." + the unchanged request body. Reject old timestamps and deduplicate X-AswaqOS-Delivery. A 2xx reply means accepted; confirm processing in the receiving workflow. Failed events remain in the dashboard for manual retry.

X-AswaqOS-Delivery: event-identifier
X-AswaqOS-Timestamp: unix-seconds
X-AswaqOS-Signature: sha256=hex-signature
Events: order.created, order.status_changed
Payload: {id,event,created_at,data}