Skip to main content

​
Merchant API

The Merchant API (codenamed Shawarma) lets you manage your RMZ store programmatically. Use it to fetch store data, manage orders, list products, and pull statistics into external systems.

​
Base URL

https://merchant-api.rmz.gg/shawarma

​
Authentication

​
Rate Limiting

​
Response Format

All successful responses follow this structure: 
{
  "message": "Success message or null",
  "data": { },
  "api": "rmz.shawarma",
  "timestamp": 1699999999
}
Error responses include error: true: 
{
  "message": "Error description",
  "data": null,
  "api": "rmz.shawarma",
  "timestamp": 1699999999,
  "error": true
}

​
Pagination

​
Idempotency

The POST /orders endpoint implements idempotency to prevent duplicate orders. Duplicate requests within 5 minutes return the existing checkout or order instead of creating a new one. Idempotency is based on a hash of the request content.

​
Available Endpoints

MethodEndpointDescription
GET/storeGet store information
GET/store/staticsGet store statistics
GET/ordersList orders (paginated)
POST/ordersCreate a new order
GET/orders/{id}Get order details
PUT/orders/{id}Update order status
GET/productsList products (paginated)
GET/products/{id}Get product details
GET/categoriesList categories (paginated)
GET/subscriptionsList subscriptions (paginated)
GET/subscriptions/{id}Get subscription details

​
Order Statuses

Status CodeDescriptionArabic
1Awaiting Paymentبإنتظار الدفع
2Under Reviewقيد المراجعة
3In Progressقيد التنفيذ
4Completedمكتمل
5Cancelledملغي
6Refundedمسترجع

​
Product Types

TypeDescription
productDigital product
codeDigital codes/keys
serviceService-based product
subscriptionRecurring subscription