Querying E-pass Usage Orders and Details

Usage Order Status

Enum	Status	Description
1	Confirmed	The order has been confirmed and is ready to be used.
2	Used	The order has been used to access the service.
3	Cancelled	The order has been cancelled and cannot be used.
4	Expired	The order was not used before its validity period and has expired.
5	Pending	The order has been created and is awaiting confirmation. This may include waiting for availability checks, or third-party responses.
10	Failed	The order failed to be created or processed due to errors or unavailability.

Retrieve Order List

→ Use /orders/ePasses to retrieve the usage order list for a specific E-pass.

Request

Retrieve Order List - Request

{
  "ePassId": "8888000066668888",
  "module": 1,
  "pageSize": 10,
  "pageNumber": 1
}

Response

A successful response returns the list of all usage orders associated with the specified E-pass, including details of order created date, locations, and any relevant statuses.

Retrieve Order List - Response

The orderId in the response refers to the actual usage order's ID, not the E-pass order ID.

{
    "code": 0,
    "data": {
        "Pagination": {
            "pageSize": 10,
            "pageNumber": 1,
            "totalNumber": 3
        },
        "orders": [
            {
                "orderId": "DP00000000000001",
                "status": 2,
                "usedUsages": 1,
                "module": 1,
                "category": 1,
                "orderCreatedDate": "2024-12-31T00:00:00+00:00",
                "resourceId": "N00001",
                "resourceName": "DragonPass Lounge",
                "image": "https://image.dragonpass.com/uploadFile/images/cover.png",
                "transportHubName": "Manchester Airport",
                "transportHubId": "A00001",
                "city": "Manchester",
                "countryOrRegion": "GB"
            },
            {
                "orderId": "DP00000000000002",
                "status": 2,
                "usedUsages": 1,
                "module": 1,
                "category": 1,
                "orderCreatedDate": "2024-01-01T00:00:00+00:00",
                "resourceId": "N00002",
                "resourceName": "DragonPass Lounge",
                "image": "https://image.dragonpass.com/uploadFile/images/cover.png",
                "transportHubName": "Manchester Airport",
                "transportHubId": "A00001",
                "city": "Manchester",
                "countryOrRegion": "GB"
            }
        ]
    }
}

Retrieve E-pass Usage Order Details

→ Use /orders/epasses/details
to retrieve the usage orders(walk-in/prebooking) associated with a specific E-pass, identifying when and where services linked to the E-pass have been used.

Request

Retrieve E-pass Usage Order Details - Request

{
    "orderId": "DP00000000000001"
}

Response

In our API response, the returned data consists of two parts:

Basic information

Order-specific information

Depending on the module and category of the order, the order-specific information will be included in the extra field.

Here is a sample of a Lounge Walk-in order:

Retrieve E-pass Usage Order Details - Response

Lounge Walk-in Order Example

{
    "code": 0,
    "data": {
        "status": 2,
        "module": 1,
        "category": 1,
        "ePassId": "8888000066668888",
        "orderId": "DP00000000000001",
        "orderCreatedDate": "2024-12-31T00:00:00+00:00",
        "orderCancelledDate": null,
        "extra": {
            "clientUserId": "3EF5D065-76F8-4D3E-801A-B329D15F461A",
            "usageDate": "2024-12-31T00:00:00",
            "usedUsages": 1,
            "resourceId": "N00001",
            "resourceName": "DragonPass Lounge",
            "iata": "MAN",
            "transportHubName": "Manchester Airport",
            "terminal": "Terminal 1",
            "city": "Manchester",
            "countryOrRegion": "GB"
        }
    }
}

Lounge Prebooking Order Example

{
    "code": 0,
    "data": {
        "status": 1,
        "module": 1,
        "category": 2,
        "ePassId": "1788000066668888",
        "orderId": "DP00000000000001",
        "orderCreatedDate": "2024-12-31T00:00:00+00:00",
        "orderCancelledDate": null,
        "extra": {
            "clientUserId": "3EF5D065-76F8-4D3E-801A-B329D15F461A",
            "prebookingDate": "2025-10-01T10:30",
            "usageDate": null,
            "usedUsages": 1,
            "resourceId": "N00001",
            "resourceName": "DragonPass Lounge",
            "iata": "MAN",
            "transportHubName": "Manchester Airport",
            "terminal": "Terminal 1",
            "city": "Manchester",
            "countryOrRegion": "GB",
            "vouchersList": [
                {
                    "voucher": "668800008888",
                    "voucherType": 1
                }
            ],
            "prebookingRequiredInfo": {
                "firstName": "DragonPass",
                "lastName": "DragonPass",
                "email": "developer@dragonpass.com",
                "phoneNumber": "8081966002",
                "callingCode": "44",
                "transportNumber": "EK001"
            }
        }
    }
}

Fast Track Prebooking Order Example

{
    "code": 0,
    "data": {
        "status": 2,
        "module": 2,
        "category": 2,
        "ePassId": "1788000066668888",
        "orderId": "DP00000000000001",
        "orderCreatedDate": "2024-12-31T00:00:00+00:00",
        "orderCancelledDate": null,
        "extra": {
            "clientUserId": "3EF5D065-76F8-4D3E-801A-B329D15F461A",
            "prebookingDate": "2025-10-01T10:30",
            "usageDate": "",
            "usedUsages": 1,
            "resourceId": "C00001",
            "resourceName": "DragonPass Fast Track Service",
            "iata": "MAN",
            "transportHubName": "Manchester Airport",
            "terminal": "Terminal 1",
            "city": "Manchester",
            "countryOrRegion": "GB",
            "passengers": [
                {
                    "firstName": "DragonPass",
                    "lastName": "DragonPass",
                    "passengersType": 1,
                    "leadPassenger": true
                }
            ],
            "vouchersList": [
                {
                    "firstName": "DragonPass",
                    "lastName": "DragonPass",
                    "voucher": "668800008888",
                    "voucherType": 1
                }
            ]
        }
    }
}

Set Meal(Lounge Alternative) Order Example

{
    "code": 0,
    "data": {
        "status": 2,
        "module": 3,
        "category": 1,
        "ePassId": "8888000066668888",
        "orderId": "DP00000000000001",
        "orderCreatedDate": "2024-12-31T00:00:00+00:00",
        "orderCancelledDate": null,
        "extra": {
            "clientUserId": "3EF5D065-76F8-4D3E-801A-B329D15F461A",
            "usageDate": "2024-12-31T00:00:00",
            "usedUsages": 1,
            "resourceId": "R00001",
            "resourceName": "DragonPass Dining Restaurant",
            "iata": "MAN",
            "transportHubName": "Manchester Airport",
            "terminal": "Terminal 1",
            "city": "Manchester",
            "countryOrRegion": "GB"
        }
    }
}

Dining Coupon Order Example

{
    "code": 0,
    "data": {
        "status": 2,
        "module": 4,
        "category": 1,
        "ePassId": "8888000066668888",
        "orderId": "DP00000000000001",
        "orderCreatedDate": "2024-12-31T00:00:00+00:00",
        "orderCancelledDate": null,
        "extra": {
            "clientUserId": "3EF5D065-76F8-4D3E-801A-B329D15F461A",
            "usageDate": "2024-12-31T00:00:00",
            "usedUsages": 1,
            "resourceId": "R00001",
            "resourceName": "DragonPass Dining Restaurant",
            "iata": "MAN",
            "transportHubName": "Manchester Airport",
            "terminal": "Terminal 1",
            "city": "Manchester",
            "countryOrRegion": "GB",
            "diningOptions": {
                "description": "30.00 USD coupon to redeem against your total bill.",
                "value": "30",
                "currency": "USD"
            }
        }
    }
}

Querying E-pass Usage Orders and Details