Lamha
Api HomeHome
Api HomeHome
  1. Order
  • lamha
    • Welcome 👋
    • Status Order
    • Payment Method
    • Webhook Order
    • API
      • Order
        • Orders List
          GET
        • Order Create
          POST
        • Order Show
          GET
        • Order Edit
          PUT
        • Delete Order
          DELETE
        • Cancel Order
          POST
        • Return Order
          POST
      • Country
        • Countries
        • City
      • Carrier
        • Carriers
        • Create Shippment
        • Cancel Shippment
        • Label Shipment
  1. Order

Orders List

Developing
GET
https://dev.your-api-server.com{{baseUrl}}/api/v2/orders

Request

Query Params

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location -g --request GET '{{baseUrl}}/api/v2/orders?payment=mada&status=2&city_id=1187&start_at=2024-07-10&end_at=2024-07-15&is_return=0'

Responses

🟢200Success
application/json
Body

Example
{
    "success": true,
    "msg": "Success",
    "data": {
        "current_page": 1,
        "data": [
            {
                "id": 1,
                "order_id": "123123",
                "original_id": "1213221",
                "reference_id": "123223",
                "date": "2024-07-11 18:04:27",
                "payment": "mada",
                "status": 2,
                "city": "Riyadh",
                "amount": 1109,
                "city_id": 1187,
                "weight": 8.25,
                "customer_name": "Lamha Customer",
                "customer_phone": "+966512345678",
                "is_return": 0,
                "carrier_number": {
                    "order_id": 1,
                    "tracking_id": "7745359811101761",
                    "track": "https://mkhdoom.sa/tracking?id=7745359811101761"
                }
            }
        ],
        "first_page_url": "{{baseUrl}}/api/v2/orders?page=1",
        "from": 1,
        "last_page": 1,
        "last_page_url": "{{baseUrl}}/api/v2/orders?page=1",
        "links": [
            {
                "url": null,
                "label": "« السابق",
                "active": false
            },
            {
                "url": "{{baseUrl}}/api/v2/orders?page=1",
                "label": "1",
                "active": true
            },
            {
                "url": null,
                "label": "التالي »",
                "active": false
            }
        ],
        "next_page_url": null,
        "path": "{{baseUrl}}/api/v2/orders",
        "per_page": 25,
        "prev_page_url": null,
        "to": 1,
        "total": 1
    }
}
Modified at 2024-08-29 18:02:28
Previous
Webhook Order
Next
Order Create
Built with