List Order Histories

This endpoint allows you to return the order history of previous and current order statuses for a specific order by passing the order_id as a path parameter.

Request

Authorization

Add the parameter

Authorization

to Headers，whose value is to concatenate the Token after the Bearer.

Example:

Authorization: Bearer ********************

Path Params

order_id

integer

required

Order ID

Example:

3155923424

Query Params

page

integer

optional

The Pagination page number

Example:

Responses

🟢200Success

application/json

Body

status

number

optional

Response status code, a numeric or alphanumeric identifier used to convey the outcome or status of a request, operation, or transaction in various systems and applications, typically indicating whether the action was successful, encountered an error, or resulted in a specific condition.

success

boolean

optional

Response flag, boolean indicator used to signal a particular condition or state in the response of a system or application, often representing the presence or absence of certain conditions or outcomes.

data

array[object (ListOrderHistories) {6}]

optional

number

required

A unique identifier associated with a specific entry or record in a database that contains information about a customer's past order or transaction history.

status

string

required

The current state of a specific order in a customer's transaction history.

note

string

required

A written remark, or message associated with an order entry in a customer's transaction history.

created_at

object (Date)

required

created_by

object | null

required

type

enum<string>

required

Type value

Allowed values:

commentactivity

pagination

object (Pagination)

optional

For a better response behavior as well as maintain the best security level, All retrieving API endpoints use a mechanism to retrieve data in chunks called pagination. Pagination working by return only a specific number of records in each response, and through passing the page number you can navigate the different pages.

count

number

required

Number of returned results.

total

number

required

Number of all results.

perPage

number

required

Number of results per page.

<= 65

currentPage

number

required

Number of current page.

totalPages

number

required

Number of total pages.

links

object

required

Array of linkes to next and previous pages.

Examples

ExampleUnauthorizedSuccess | With Created_by

{
    "status": 200,
    "success": true,
    "data": [
        {
            "id": 213320125,
            "status": "تم التنفيذ",
            "note": "تم ارسال الطلب عبر شركة الشحن ارامكس",
            "created_at": {
                "date": "2020-04-02 18:59:47.000000",
                "timezone_type": 3,
                "timezone": "Asia/Riyadh"
            }
        },
        {
            "id": 213320122,
            "status": "قيد التنفيذ",
            "note": "null",
            "created_at": {
                "date": "2020-04-02 16:59:47.000000",
                "timezone_type": 3,
                "timezone": "Asia/Riyadh"
            }
        },
        {
            "id": 213320121,
            "status": "تحت المراجعة",
            "note": "null",
            "created_at": {
                "date": "2020-04-02 16:50:47.000000",
                "timezone_type": 3,
                "timezone": "Asia/Riyadh"
            }
        }
    ],
    "pagination": {
        "count": 3,
        "total": 3,
        "perPage": 15,
        "currentPage": 1,
        "totalPages": 1,
        "links": []
    }
}

🟠404Record Not Found

Request

Request samples

Responses