List Order Reservations

GET/reservations

[updatedIn] 2 months ago

This endpint allows you to retrieve all the current order reservations.

`orders.read` - Orders Read Only

Request

Authorization: OAuth 2.0

Add the parameter

Authorization

to [header]，whose value is to concatenate the Token after the Bearer.

[api.label.example]

Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c

[message.queryParameter]

start

string <date>

required

Reservation Start Date

Example:

2024-01-01

end

string <date>

required

Reservation End Date

Example:

2024-01-31

Request samples

[api.label.responses]

Success(200)

HTTP Code: 200

Content Type : JSONapplication/json

status

integer

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

string

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 (Reservation) {8}]

optional

number

required

A unique alphanumeric code assigned to a specific reservation or booking. List of order reservations can be found here.

title

string

required

A descriptive label or name given to a specific reservation.

type

string

required

The type of reservation.

start

string

required

Reservation start date

end

string

required

Reservation end date

weight

integer

required

Reservation item weight.

url

string

required

Reservation URL

created_at

string

required

Reservation create at timestamp.

{
  "status": 200,
  "success": true,
  "data": [
    {
      "id": 1473353380,
      "title": "تعليم القيادة (2)",
      "type": "day",
      "start": "2024-02-16T00:00:00",
      "end": "2024-02-16T:23:59:59",
      "seats_count": 2,
      "url": "https://dashboard.test/orders/order/yRdxQ9m28rEbamllyGd1Xz5KoDJZgkAP",
      "created_at": "2024-02-13 13:48:33"
    },
    {
      "id": 566146469,
      "title": "تعليم القيادة (1)",
      "type": "time",
      "start": "2024-02-19T10:00:00",
      "end": "2024-02-19T10:30:00",
      "seats_count": 1,
      "url": "https://dashboard.test/orders/order/LR98Gn45mxgPMnQQ930WwkpdzKNbQjJv",
      "created_at": "2024-02-15 11:58:36"
    }
  ]
}

[updatedIn] 2 months ago