Light Mode

Order Details

GET/orders/{order_id}

Last modified: 13 days ago

This endpoint allows you to return the details for a specific order by passing the order_id as a path parameter.

:::danger[Deprecation Notice]
The extended response will be deprecated soon. We urge you to use the format=light query parameter to fetch the to-be default response.
:::

:::tip[Note]
• You are also able to send the reference_id as a query parameter to get order details. Check the List Orders Endpoint for more.
• If you send the query parameter format and set it equal to light, you will receive the order details without Shipments, Items, Pickup Branch, and Customer Groups objects.
:::

`orders.read` - Orders Read Only

Request

Path Params

order_id

integer

required

The Order ID

Example:

3155923424

Query Params

format

enum<string>

required

Use the format query parameter to return Order details without the following objects:

Shipments
Items
Pickup Branch
Customer Groups

Allowed value:

light

Example:

light

Request samples

Responses

Default Response(200)

Deprecated Response(200)

Object Not Found(404)

HTTP Code: 200

Content Type : JSONapplication/json

No schema defined

{
  "status": 200,
  "success": true,
  "data": {
    "id": 418149270,
    "checkout_id": 1464750392,
    "reference_id": 3879219,
    "features": {
      "shippable": true,
      "digitalable": false,
      "multiple_shipments_supported": false,
      "order_type_price_quote": false
    },
    "actions": {
      "cancellable": false,
      "reorderable": true,
      "payable": true
    },
    "urls": {
      "customer": "http://store.test/ar/hemo.store/order/wRK4mBzAZN081YbbX3dal23kYrbxqP7j",
      "admin": "/orders/order/wRK4mBzAZN081YbbX3dal23kYrbxqP7j"
    },
    "date": {
      "date": "2024-02-15 08:23:05.000000",
      "timezone_type": 3,
      "timezone": "Asia/Riyadh"
    },
    "updated_at": {
      "date": "2024-02-15 11:23:05.000000",
      "timezone_type": 3,
      "timezone": "Asia/Riyadh"
    },
    "source": "store",
    "source_details": {
      "type": "direct",
      "value": null,
      "device": "desktop",
      "user-agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/121.0.0.0 Safari/537.36",
      "ip": "127.0.0.1"
    },
    "status": {
      "id": 1298199463,
      "name": "تم التنفيذ",
      "slug": "completed",
      "customized": {
        "id": 1633436842,
        "name": "طلبك بيوصلك قريب"
      }
    },
    "is_price_quote": false,
    "payment_method": "mada",
    "currency": "SAR",
    "amounts": {
      "sub_total": {
        "amount": 250,
        "currency": "SAR"
      },
      "shipping_cost": {
        "amount": 13.04,
        "currency": "SAR"
      },
      "cash_on_delivery": {
        "amount": 0,
        "currency": "SAR"
      },
      "tax": {
        "percent": "15.00",
        "amount": {
          "amount": 39.46,
          "currency": "SAR"
        }
      },
      "discounts": [],
      "total": {
        "amount": 302.5,
        "currency": "SAR"
      }
    },
    "can_cancel": false,
    "show_weight": true,
    "can_reorder": true,
    "is_pending_payment": false,
    "pending_payment_ends_at": 0,
    "total_weight": "٠٫٥١ كجم",
    "rating_link": "http://store.test/ar/hemo.store/rating/418149270?expires=1708694354&&signature=307b4712680bb5eff6b6c8efc49df18f5971e08b919b8fa75c4786b2068a12fa",
    "receiver": {
      "name": "أحمد Conn",
      "email": "[email protected]",
      "phone": "966501724227"
    },
    "customer": {
      "id": 1473353380,
      "first_name": "أحمد",
      "last_name": "Conn",
      "mobile": 501724227,
      "mobile_code": "+966",
      "email": "[email protected]",
      "urls": {
        "customer": "http://store.test/ar/hemo.store/profile",
        "admin": "/customers/x9oKNEzBmR3JlkMRYW6ZYd2q0QpPXy4n"
      },
      "avatar": "https://cdn.assets.salla.network/prod/admin/cp/assets/images/avatar_male.png",
      "gender": "male",
      "birthday": {
        "date": "1970-01-01 00:00:00.000000",
        "timezone_type": 3,
        "timezone": "Asia/Riyadh"
      },
      "city": "الرياض",
      "country": "السعودية",
      "country_code": "SA",
      "currency": "SAR",
      "location": "ابيض طويل",
      "updated_at": {
        "date": "2024-02-15 11:18:00.000000",
        "timezone_type": 3,
        "timezone": "Asia/Riyadh"
      }
    },
    "bank": null,
    "tags": []
  }
}

Last modified: 13 days ago