Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.rmz.gg/llms.txt

Use this file to discover all available pages before exploring further.

Retrieve product information to display in your embedded checkout widget. Returns pricing, stock, images, store details, and tax settings.

​
Get Product

This is a public endpoint. It requires the X-Embed-Key header but no customer authentication.
GET /api/embed/product/{productId}

​
Path Parameters

ParameterTypeDescription
productIdintegerThe ID of the product to fetch

​
Headers

HeaderRequiredDescription
X-Embed-KeyYesYour store’s embed public key

​
Example Request

curl -X GET "https://embed.rmz.gg/api/embed/product/42" \
  -H "X-Embed-Key: your_embed_public_key" \
  -H "Accept: application/json"

​
Success Response (200)

{
  "success": true,
  "data": {
    "id": 42,
    "name": "Premium Digital Course",
    "description": "A comprehensive guide to...",
    "price": 199.00,
    "discount_price": 149.00,
    "actual_price": 149.00,
    "is_discounted": true,
    "image": "https://cdn.rmz.gg/products/abc123.jpg",
    "extra_images": [
      "https://cdn.rmz.gg/products/img2.jpg",
      "https://cdn.rmz.gg/products/img3.jpg"
    ],
    "stock": 50,
    "in_stock": true,
    "type": "code",
    "min_qty": 1,
    "max_qty": 10,
    "store": {
      "id": 7,
      "name": "My Digital Store",
      "logo": "https://cdn.rmz.gg/stores/logo.png",
      "currency": "SAR",
      "language": "ar"
    },
    "tax_enabled": true,
    "tax_rate": 15.0
  }
}

​
Response Fields

FieldTypeDescription
idintegerProduct ID
namestringProduct display name
descriptionstringProduct description (may contain HTML)
pricefloatOriginal listed price
discount_pricefloat | nullDiscounted price, or null if no discount
actual_pricefloatThe effective price the customer pays (discount price if active, otherwise original price)
is_discountedbooleanWhether a discount is currently active
imagestring | nullPrimary product image URL via CDN
extra_imagesarrayAdditional product image URLs
stockintegerNumber of items available
in_stockbooleanWhether stock is greater than zero
typestringProduct type: code, file, subscription, service, card
min_qtyintegerMinimum purchase quantity
max_qtyintegerMaximum purchase quantity (capped at stock for code products, max 10)
store.idintegerStore ID
store.namestringStore display name
store.logostringStore logo URL
store.currencystringStore currency code (e.g., SAR, USD)
store.languagestringStore language (ar, en)
tax_enabledbooleanWhether tax is enabled for this store
tax_ratefloatTax rate as a percentage (e.g., 15.0 for 15% VAT)

​
Error Responses

Product not found (404) 
{
  "success": false,
  "message": "Product not found"
}
Only active products (status = enabled) are returned. Disabled or draft products will return a 404 response.