Skip to main content

​
Quickstart

This guide walks you through making your first Merchant API call. By the end, you will have retrieved your store statistics using a Bearer token.

​
Prerequisites

  • An RMZ store on the RMZ+ plan
  • An API token (generated from your dashboard)

​
Step 1: Get Your API Token

  1. Log in to your RMZ Dashboard
  2. Go to Settings > API Keys
  3. Click Generate Token and copy the value
Your API token grants full access to your store data. Keep it secret and never expose it in client-side code.

​
Step 2: Make Your First Request

Use the token to fetch your store information: 
curl -X GET "https://merchant-api.rmz.gg/shawarma/store" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Accept: application/json"

​
Step 3: Check the Response

A successful response looks like this: 
{
  "message": null,
  "data": {
    "id": 1,
    "name": "My Store",
    "slug": "my-store",
    "logo": "https://...",
    "description": "..."
  },
  "api": "rmz.shawarma",
  "timestamp": 1699999999
}

​
Step 4: Get Store Statistics

Now fetch your store stats: 
curl -X GET "https://merchant-api.rmz.gg/shawarma/store/statics" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
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
}

​
What’s Next

List Orders

Fetch and filter your store orders.

Create an Order

Create orders programmatically via the API.

Authentication Deep Dive

Learn about all auth patterns across RMZ APIs.

Error Handling

Handle errors and edge cases gracefully.