RETM | REST API
  1. Orders
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
      • 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
      GET
  • Payment Methods
    • Payment methods
    • Create pay method
  • Order Charges
    • order charges
    • Create order charges
  • Taxes
    • Tax list
    • Create tax
  • Customers
    • Customers
  1. Orders

Orders

GET
https://{serviceID}.retm.sa/api/v2/orders/list

Request

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

Responses

🟢200Success
application/json
Body
object {0}
Example
[
    {
        "id": "01jenxdyv1n6ghxmpk2amqe59p",
        "partner_reference": null,
        "price": null,
        "tax": "0.000",
        "coupon": {
            "code": null,
            "amount": "0.000"
        },
        "order_type": {
            "id": null,
            "name": null
        },
        "branch": {
            "id": "01HWJ1P1DZDZX5BAXE9SV0DRY1",
            "name": {
                "en": "Alnahdhah Branch",
                "ar": "فرع النهضة"
            }
        },
        "taxes": [],
        "status": 3,
        "rate": null,
        "note": null,
        "estimated_time": null,
        "created_at": "2024-12-09T14:33:33.000000Z",
        "updated_at": "2024-12-10T21:44:54.000000Z",
        "customer": {
            "id": "01hdgv4mfjhvds9bevm0mk2sk0",
            "name": {
                "en": "RM|API - New Customer",
                "ar": "RM|API - عميل جديد"
            },
            "phone": "01201763086",
            "address": {
                "id": "01hdgv4mkmjjqq4718f91e6v4b",
                "name": {
                    "en": "Digital Menu"
                },
                "address": null,
                "longitude": null,
                "latitude": null,
                "note": null
            }
        },
        "products": [
            {
                "id": "01GZK6C7J03PQP7KGRAQ3F197Y",
                "name": {
                    "en": "coffee day",
                    "ar": "قهوة اليوم"
                },
                "variant": {
                    "id": "01j82mx3m4376mp9rw5a9rxkbx",
                    "name": {
                        "ar": "كبير",
                        "en": "large"
                    }
                },
                "modifiers": [
                    {
                        "id": "01hpkd1wj0k9bfermyc8cy0agk",
                        "title": {
                            "ar": "المشروب",
                            "en": "Drink"
                        },
                        "name": {
                            "ar": "بيبسي",
                            "en": "Pepsi"
                        },
                        "quantity": "2.00"
                    }
                ],
                "price": null,
                "tax": "0.000",
                "discount": null,
                "quantity": "2.00",
                "note": null
            }
        ],
        "application": {}
    }
]
Modified at 2024-12-10 22:08:08
Previous
Error webhook
Next
Create Order
Built with