Upload Product Media

POST/products/upload

Uploads a file (product image, extra image, or digital file) and returns a media id. Pass that id to Create Product / Update Product as image.file.response.id (or inside product_files[] / extra_images[]).

Authentication

Headers

Header	Value	Required
`Authorization`	`Bearer YOUR_API_TOKEN`	Yes
`Content-Type`	`multipart/form-data`	Yes

Query Parameters

Parameter	Type	Required	Description
`type`	string	No	`image` (main, default), `extra_image`, or `file` (digital file)

Body (multipart/form-data)

Field	Type	Required	Description
`file`	file	Yes	For `image`/`extra_image`: jpg, jpeg, png, gif (max 10 MB). For `file`: jpg, mp4, jpeg, png, gif, pdf, zip, docx, txt (max ~117 MB)

Example Request

curl -X POST "https://merchant-api.rmz.gg/shawarma/products/upload?type=image" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -F "file=@/path/to/product.jpg"

const form = new FormData();
form.append("file", fileInput.files[0]);

const res = await fetch("https://merchant-api.rmz.gg/shawarma/products/upload?type=image", {
  method: "POST",
  headers: { "Authorization": "Bearer YOUR_API_TOKEN" },
  body: form
});
const { data } = await res.json();
const mediaId = data.id; // pass as image.file.response.id

Success Response

200 OK

{
  "message": null,
  "data": {
    "id": 9001,
    "type": "main_product_image",
    "name": "product.jpg",
    "file_name": "a1b2c3....jpg",
    "path": "products/images/",
    "mime_type": "image/jpeg",
    "size": 48213
  },
  "api": "rmz.shawarma",
  "timestamp": 1699999999
}

Where to use the returned id

Map each upload type to the create/update field that references the returned data.id:

Upload `type`	Use in create/update as
`image`	`image.file.response.id` (main product image)
`extra_image`	`extra_images[].file.response.id` (gallery)
`file`	`product_files[].file.response.id` (digital file — `product`/`license` types)

{
  "image": { "file": { "response": { "id": 9001 } } },
  "extra_images": [ { "file": { "response": { "id": 9101 } } } ],
  "product_files": [ { "file": { "response": { "id": 9002 } } } ]
}

Error Responses

Code	Description
`401`	Unauthorized — invalid or missing token
`403`	Plan does not include the API feature
`422`	Invalid file type or file too large

Overview

Store

Orders

Products

Categories

Subscriptions

Portal Sessions

Upload Product Media

Upload Product Media

Authentication

Headers

Query Parameters

Body (multipart/form-data)

Example Request

Success Response

Where to use the returned id

Error Responses

​Upload Product Media

​Authentication

​Headers

​Query Parameters

​Body (multipart/form-data)

​Example Request

​Success Response

​Where to use the returned id

​Error Responses

Upload Product Media

Authentication

Headers

Query Parameters

Body (multipart/form-data)

Example Request

Success Response

Where to use the returned id

Error Responses