RETM | REST API
  1. Products
RETM | REST API
  • Developer guide
  • New to our DevPortal 🤔
  • Authentication
    • Token
      POST
  • Webhook
    • Overview
    • Invoice Webhooks
      • Webhook Events
      • Invoice Created
    • Orders Webhooks
      • Webhook Events
      • Order Triggeres
    • Menu Webhooks
      • Menu Updates
      • Menu Changed
    • Loyalty Webhooks
      • Promotional Coupon
      • Check Reward
      • Redeem Reward
    • Customer webhook
      • Customer Data
      • Customer hook
    • Error webhook
      • Stay Alert to Connectivity Issues
      • Error webhook
  • Orders
    • Orders
      GET
    • Create Order
      POST
    • Cancel Order
      POST
    • Update delivery order status
      POST
  • Menu
    • Categories
      • List Categories
      • Single Categoy
    • Products
      • Products
        GET
      • Single Product
        GET
      • Simple List
        GET
    • Menu
      GET
  • Branches
    • Branches
      GET
  • Devices
    • Devices
      GET
  • Order type
    • Order types
      GET
    • Create order type
      POST
  • Price Lists
    • Price Lists
  • Payment Methods
    • Payment methods
    • Create pay method
  • Order Charges
    • order charges
    • Create order charges
  • Taxes
    • Tax list
    • Create tax
  • Customers
    • Customers
  1. Products

Products

GET
https://{serviceID}.retm.sa/api/v2/products/list
Fetch all products in the system with less details in pagination
TypeMeaning
1Normal Product
2With Modifiers
3UNDER PROGRESS
4With Variations

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************

Responses

🟢200Products
application/json
Body
items
array [object {10}] 
required
id
string 
optional
name
object 
optional
description
object 
optional
image
string 
optional
price
string 
optional
calories
string 
optional
estimated_time
string 
optional
type
integer 
optional
over_stock
integer 
optional
category
object 
optional
pagination
object 
required
from
integer 
required
to
integer 
required
per
integer 
required
total
integer 
required
current
integer 
required
path
string 
required
Example
{
    "items": [
        {
            "id": "01GZK6C7J03PQP7KGRAQ3F197Y",
            "name": {
                "en": "coffee day",
                "ar": "قهوة اليوم"
            },
            "description": {
                "en": "coffee day",
                "ar": "قهوة اليوم"
            },
            "image": "https://cdn.retm.sa/items/IN6yn7QGo.jpg",
            "price": "7.000",
            "calories": "9.00",
            "estimated_time": "14.00",
            "type": 4,
            "over_stock": 1,
            "category": {
                "id": "01hjnnt6d2hyasgjepb87z8gev",
                "title": {
                    "ar": "المقطرة",
                    "en": "Drip coffee"
                }
            }
        }
    ],
    "pagination": {
        "from": 1,
        "to": 1,
        "per": 25,
        "total": 1,
        "current": 1,
        "path": "https://sandbox.retm.sa/api/v2/products/list"
    }
}
Modified at 2024-11-05 07:17:44
Previous
Single Categoy
Next
Single Product
Built with