Create Product
POST
Creates a product of any type (/productsproduct, code, service, subscription, license, course). The API accepts the full product model — the same fields the dashboard uses — including media, custom fields, variants, course content, discounts, metadata, and SEO.
Authentication
Headers
| Header | Value | Required |
|---|---|---|
Authorization | Bearer YOUR_API_TOKEN | Yes |
Accept | application/json | Recommended |
Content-Type | application/json | Yes |
Body Parameters
Core
| Parameter | Type | Required | Description |
|---|---|---|---|
name | string | Yes | Product name |
type | string | Yes | One of product, code, service, subscription, license, course |
price | number | Yes | Selling price |
cost_price | number | Yes | Your cost price |
slug | string | No | URL slug — auto-generated from name if omitted. Must be unique within your store |
description | string | No | Product description. HTML allowed (sanitized server-side) |
marketing_title | string | No | Optional marketing headline |
activation_info | string | No | Post-purchase activation instructions. HTML allowed (sanitized) |
status | integer | No | 1 = active |
show_reviews | boolean | No | Whether to show reviews on the product page |
is_noticeable | boolean | No | Highlight/feature flag |
Pricing & inventory
| Parameter | Type | Required | Description |
|---|---|---|---|
discount_price | number | No | Discounted price |
discount_expiry | date | No | Discount expiry, YYYY-MM-DD |
stock | integer | No | Stock quantity (non-code types) |
min_qty | number | No | Minimum order quantity |
max_purchase_count | integer | No | Max units one customer can buy |
Media
Upload files first via Upload Product Media to get a mediaid, then reference it here.
| Parameter | Type | Required | Description |
|---|---|---|---|
image.file.response.id | integer | Yes | Main product image media id |
image_ulid | string | No | Optional client-side reference |
product_files | array | No | Digital files (product/license types): [{ "file": { "response": { "id": <media_id> } } }] |
extra_images | array | No | Additional gallery images: [{ "file": { "response": { "id": <media_id> } } }] |
Media you reference must have been uploaded by your store. Unknown or foreign media ids return
404.Categories, benefits & custom fields
| Parameter | Type | Required | Description |
|---|---|---|---|
categories | array | No | Array of category ids belonging to your store |
benefits | array | No | Array of benefit ids |
fields | array | No | Custom order fields — see shape below |
"fields": [
{
"type": "select",
"name": "Region",
"placeholder": "Choose a region",
"required": true,
"options": [ { "name": "EU", "price": 0 }, { "name": "US", "price": 5 } ]
}
]
Digital codes (type: code)
| Parameter | Type | Required | Description |
|---|---|---|---|
codes | array | For code | Codes added to inventory: [{ "code": "..." }] |
Subscription / License variants (type: subscription or license)
| Parameter | Type | Required | Description |
|---|---|---|---|
subscriptionVariants | array | For subscription/license | Plan variants — see shape below |
"subscriptionVariants": [
{
"duration": 30,
"price": 19.99,
"badge": "Most popular",
"features": [ { "name": "Priority support", "description": "24/7" } ]
}
]
License configuration (type: license)
| Parameter | Type | Description |
|---|---|---|
license_config.lock_type | string | none, hwid, or ip |
license_config.prefix | string | Up to 8 alphanumeric chars |
license_config.expiry_type | string | lifetime or timed |
license_config.expiry_days | integer | 1–3650 (for timed) |
license_config.max_activations | integer | 0–100 |
license_config.e2ee | boolean | Enables end-to-end encryption; an encryption key is generated automatically |
Subscription configuration (type: subscription)
| Parameter | Type | Description |
|---|---|---|
trial_days | integer | 0–90 |
cancel_behavior | string | end_of_period or immediate |
auto_renew_default | boolean | Default auto-renew state |
grace_period_days | integer | 0–30 |
Course content (type: course)
"course": {
"instructor": "Jane Doe",
"level": "beginner",
"sections": [
{
"title": "Getting started",
"description": "Intro",
"sort_index": 0,
"modules": [
{ "title": "Welcome", "type": "media", "video_uri": "https://...", "sort_index": 0 },
{ "title": "Notes", "type": "text", "content": "<p>...</p>", "sort_index": 1 }
]
}
]
}
| Field | Type | Description |
|---|---|---|
course.instructor | string | Instructor name |
course.level | string | Course level |
course.sections[].title | string | Section title (required for course) |
course.sections[].modules[].type | string | media or text |
course.sections[].modules[].video_uri | string | Media URL (for media modules) |
course.sections[].modules[].content | string | HTML content (for text modules) |
Display metadata & SEO
| Parameter | Type | Description |
|---|---|---|
metadata.display.show_discount_countdown | boolean | Show a discount countdown |
metadata.display.show_discount_savings | boolean | Show savings amount |
metadata.display.show_monthly_breakdown | boolean | Show monthly price breakdown |
seo.meta_title | string | ≤ 70 chars |
seo.meta_description | string | ≤ 320 chars |
seo.meta_keywords | string | ≤ 255 chars |
seo.og_title | string | ≤ 70 chars |
seo.og_description | string | ≤ 320 chars |
seo.canonical_url | string (url) | ≤ 500 chars |
seo.robots | string | ≤ 50 chars |
seo.extra_meta | array | Additional meta entries |
Example Requests
curl -X POST "https://merchant-api.rmz.gg/shawarma/products" \
-H "Authorization: Bearer YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"name": "Premium Key",
"type": "code",
"price": 49.99,
"cost_price": 20,
"image": { "file": { "response": { "id": 9001 } } },
"categories": [12],
"codes": [ { "code": "KEY-AAA-111" }, { "code": "KEY-BBB-222" } ]
}'
{
"name": "Pro Plan",
"type": "subscription",
"price": 19.99,
"cost_price": 0,
"image": { "file": { "response": { "id": 9001 } } },
"trial_days": 7,
"cancel_behavior": "end_of_period",
"auto_renew_default": true,
"subscriptionVariants": [
{ "duration": 30, "price": 19.99, "badge": "Monthly", "features": [{ "name": "Priority support" }] },
{ "duration": 365, "price": 199, "badge": "Yearly", "features": [] }
],
"metadata": { "display": { "show_monthly_breakdown": true } }
}
{
"name": "App License",
"type": "license",
"price": 99,
"cost_price": 10,
"image": { "file": { "response": { "id": 9001 } } },
"license_config": { "lock_type": "hwid", "expiry_type": "timed", "expiry_days": 365, "max_activations": 3, "e2ee": true },
"subscriptionVariants": [ { "duration": 365, "price": 99, "features": [] } ],
"product_files": [ { "file": { "response": { "id": 9002 } } } ]
}
{
"name": "Mastering X",
"type": "course",
"price": 49,
"cost_price": 0,
"image": { "file": { "response": { "id": 9001 } } },
"course": {
"instructor": "Jane Doe",
"level": "beginner",
"sections": [
{ "title": "Intro", "modules": [ { "title": "Welcome", "type": "media", "video_uri": "https://..." } ] }
]
}
}
Success Response
201 Created
{
"message": "تم إنشاء المنتج بنجاح",
"data": {
"id": 103,
"name": "Premium Key",
"slug": "premium-key",
"type": "code",
"price": 49.99,
"codes": [ { "id": 5001, "code": "KEY-AAA-111" }, { "id": 5002, "code": "KEY-BBB-222" } ],
"image": { "id": 9001 },
"categories": [ { "id": 12 } ],
"subscriptionVariants": []
},
"api": "rmz.shawarma",
"timestamp": 1699999999
}
Error Responses
| Code | Description |
|---|---|
401 | Unauthorized — invalid or missing token |
403 | Plan does not include the API feature, or license type requires a plan with license integration |
404 | A referenced media id (image / product_files / extra_images) does not belong to your store |
422 | Validation error (missing name/price/type, invalid type, duplicate slug, category not in your store, etc.). The data object contains field errors. |