Store
Retrieve your store’s profile information and aggregate statistics.
GET/store
Returns the authenticated store’s profile data.
Authentication
| Header | Value | Required |
|---|
Authorization | Bearer YOUR_API_TOKEN | Yes |
Accept | application/json | Recommended |
Example Request
curl -X GET "https://merchant-api.rmz.gg/shawarma/store" \
-H "Authorization: Bearer YOUR_API_TOKEN" \
-H "Accept: application/json"
Success Response
Returns the full store object with all fields except is_risky and is_restricted (which are hidden). Below is an abbreviated example — the actual response includes all store fields.
{
"message": null,
"data": {
"id": 1,
"subdomain": "my-store",
"name": "My Store",
"balance": "0.00",
"description": "Store description",
"logo": "stores/logo.png",
"favicon": null,
"theme": 1,
"color": "#5400db",
"activities": [],
"social": {},
"settings": {},
"is_maintenance": false,
"maintenance_message": null,
"plan_id": 2,
"plan_expires_at": "2025-12-31T00:00:00.000000Z",
"is_kyc_verified": true,
"is_beta_tester": false,
"customization": {},
"ratio": "4.500",
"ratio_synced_at": null,
"ratio_based_on": 50,
"user_id": 1,
"deleted_at": null,
"created_at": "2024-01-01T00:00:00.000000Z",
"updated_at": "2024-01-15T00:00:00.000000Z",
"human_format": {
"expiry_date_human": "منذ 6 أشهر"
}
},
"api": "rmz.shawarma",
"timestamp": 1699999999
}
The response includes the complete store model. Additional fields may be present depending on store configuration. The fields is_risky and is_restricted are always hidden from the response.
Error Responses
| Code | Description |
|---|
401 | Unauthorized — invalid or missing token |
Get Store Statistics
GET/store/statics
Returns aggregate statistics for the authenticated store. Results are cached for 3 minutes.
Authentication
| Header | Value | Required |
|---|
Authorization | Bearer YOUR_API_TOKEN | Yes |
Accept | application/json | Recommended |
Example Request
curl -X GET "https://merchant-api.rmz.gg/shawarma/store/statics" \
-H "Authorization: Bearer YOUR_API_TOKEN"
Success Response
{
"message": null,
"data": {
"sales_total": 125750.50,
"sales_count": 342,
"customers_count": 156,
"products_count": 23,
"categories_count": 5,
"subscribers_count": 45,
"pages_count": 3,
"coupons_count": 8,
"duration": "lifetime"
},
"api": "rmz.shawarma",
"timestamp": 1699999999
}
Response Fields
| Field | Type | Description |
|---|
sales_total | float | Total revenue (excluding pending, cancelled, refunded orders) |
sales_count | integer | Total number of completed orders |
customers_count | integer | Total registered customers |
products_count | integer | Total products in store |
categories_count | integer | Total categories |
subscribers_count | integer | Total active subscriptions |
pages_count | integer | Total custom pages |
coupons_count | integer | Total coupon codes |
duration | string | Always "lifetime" — indicates statistics cover all time |
Statistics are cached for 3 minutes. Frequent polling will return the same data until the cache expires.
Error Responses
| Code | Description |
|---|
401 | Unauthorized — invalid or missing token |
