Skip to main content

​
Environments

RMZ APIs are available in production. All base URLs use the rmz.gg domain.

​
Base URLs

​
Merchant API

All Merchant API endpoints are prefixed under /shawarma. For example:
  • GET https://merchant-api.rmz.gg/shawarma/store
  • GET https://merchant-api.rmz.gg/shawarma/orders
  • POST https://merchant-api.rmz.gg/shawarma/orders

​
Storefront API

The Storefront API identifies the store by the request’s origin domain. Your custom storefront must send requests from the store’s configured domain. For example:
  • GET https://front.rmz.gg/api/products
  • POST https://front.rmz.gg/api/cart/add
  • POST https://front.rmz.gg/api/checkout

​
License Verification API

A single endpoint for verifying license keys:
  • POST https://license.rmz.gg/verify

​
FiveM API

Used by the FiveM resource to poll for pending commands:
  • GET https://fivem.rmz.gg/api/fivem/queue
  • DELETE https://fivem.rmz.gg/api/fivem/queue
  • GET https://fivem.rmz.gg/api/fivem/queue/online/{playerId}
The FiveM resource handles communication with this API automatically. You do not need to call these endpoints directly.

​
Embed API

The Embed API allows external websites to embed a checkout widget. For example:
  • GET https://embed.rmz.gg/api/embed/product/{productId}
  • POST https://embed.rmz.gg/api/embed/checkout

​
Required Headers

All APIs expect JSON:
The Merchant API additionally requires:
The Storefront API uses cart tokens for cart operations: