RETM | REST API
  1. Categories
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
        GET
      • Single Categoy
        GET
    • Products
      • Products
      • Single Product
      • Simple List
    • 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. Categories

Single Categoy

GET
https://{serviceID}.retm.sa/api/v2/categories/{ID}
Fetch Single Category with products in pagination

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
Path Params
ID
string 
required

Responses

🟢200List
application/json
Body
id
string 
required
name
object 
required
ar
string 
required
en
string 
required
products
object 
required
items
array [object {13}] 
required
pagination
object 
required
Example
{
    "id": "01hjnnt6d2hyasgjepb87z8gev",
    "name": {
        "ar": "المقطرة",
        "en": "Drip coffee"
    },
    "products": {
        "items": [
            {
                "id": "01GZK6C7J03PQP7KGRAQ3F197Y",
                "name": {
                    "en": "coffee day",
                    "ar": "قهوة اليوم"
                },
                "description": [],
                "image": "https://cdn.retm.sa/items/IN6yn7QGo.jpg",
                "price": "7.000",
                "calories": "9.00",
                "estimated_time": "14.00",
                "type": 4,
                "over_stock": 1,
                "variations": [
                    {
                        "id": "01j82mx3m4376mp9rw5a9rxkbx",
                        "sku": "185950419",
                        "name": {
                            "ar": "كبير",
                            "en": "large"
                        },
                        "price": "11.000",
                        "image": null,
                        "stock_qty": null
                    },
                    {
                        "id": "01j82mx3mh145fy0jcbzc2ry0r",
                        "sku": "937363666",
                        "name": {
                            "ar": "صغير",
                            "en": "small"
                        },
                        "price": "9.000",
                        "image": null,
                        "stock_qty": null
                    }
                ],
                "modifiers": [
                    {
                        "name": {
                            "ar": "المشروب",
                            "en": "Drink"
                        },
                        "multiple": 1,
                        "min_selection": 0,
                        "max_selection": null,
                        "items": [
                            {
                                "id": "01hpkd1wj0k9bfermyc8cy0agk",
                                "name": {
                                    "ar": "بيبسي",
                                    "en": "Pepsi"
                                },
                                "extra_price": "12.000"
                            },
                            {
                                "id": "01hpkd1wj290dfcbvxxdj89pzs",
                                "name": {
                                    "ar": "كوكاكولا",
                                    "en": "Cocacole"
                                },
                                "extra_price": "10.000"
                            },
                            {
                                "id": "01hzkgmq8sd98ya14p0wa4aqry",
                                "name": {
                                    "ar": "عرض المشروب هدية",
                                    "en": "عرض المشروب هدية"
                                },
                                "extra_price": "-10.000"
                            }
                        ]
                    }
                ],
                "category": {
                    "id": "01hjnnt6d2hyasgjepb87z8gev",
                    "title": {
                        "ar": "المقطرة",
                        "en": "Drip coffee"
                    }
                },
                "taxes": [
                    {
                        "id": "01j9t4g36v6vgz798bd3nj3ezh",
                        "name": {
                            "en": "VAT",
                            "ar": "ضريبة القيمة المضافة"
                        },
                        "value": "15.000",
                        "type": 2,
                        "from_final_total": 0
                    }
                ]
            }
        ],
        "pagination": {
            "from": 1,
            "to": 1,
            "per": 25,
            "total": 1,
            "current": 1,
            "path": "https://sandbox.retm.sa/api/v2/categories/01hjnnt6d2hyasgjepb87z8gev"
        }
    }
}
Modified at 2024-11-05 07:16:51
Previous
List Categories
Next
Products
Built with