DragonPass API Developer Platform
v2
  • v2
  • v1
Homepage
Official SiteContact Us
Homepage
Official SiteContact Us
API Version
v2
  • v2
  • v1
v2
  • v2
  • v1
  1. E-pass
  • Implementation Guide
    • Get Started
    • Our API Solution
    • DragonPass Modules
  • Development Guide
    • Authentication
    • Response Format
    • Error Codes
    • Order Lifecycle
    • Multiple Language Support and Fallback
    • Sandbox Order Simulation
    • UI Design Guidelines
  • Using the API
    • Search for Resources
      • Search for Resources
      • Check Prebooking Resource & Option Availability
      • Pricing Query
      • Image Parameters
    • E-pass
      • Issuing, Querying, and Cancelling an E-pass
      • Querying E-pass Usage Orders and Details
      • Utilizing The E-pass
        • Lounge
        • Fast Track
        • Dining
        • Cross Module
        • Fitness
        • eSIM
    • Membership
      • Manage Memberships & Entitlements
      • Querying Membership Usage Orders and Details
      • Utilizing DragonPass Membership
        • Lounge
        • Fast Track
        • Dining
        • Fitness
        • eSIM
    • User
      • User Management
  • Push Event
    • Lounge/Dining Walk-in Redemption Event
    • Prebooking Order Status Change Event
    • Instructions
    • Resource Update Push Service
  • Release Notes
    • 2025
    • 2026
  • Migration Guide
    • From V1 to V2
  • API Reference
    • Authentication
      • Generate Access Token
    • Search
      • Aggregated Search by Keyword
      • Retrieve Available Modules by Location
    • Transport Hubs
      • Retrieve Transport Hub
      • Retrieve Transport Hub Details
    • Resources
      • Resource List
        • Retrieve Resources List
      • Resource Details
        • Retrieve Resource Details
      • Check Resource Availability
        • Check Prebooking Resource Availability
        • Check Prebooking Option Availability
      • Fitness
        • Retrieve Fitness Resource Option Details
        • Retrieve Fitness Resources Schedule
      • eSIM
        • Retrieve eSIM Resource Option Details
        • Retrieve eSIM Resouces Options
      • Pricing
        • Retrieve Resource Pricing Information
        • Retrieve Prebooking Option Pricing Information
    • User Management
      • User Creation
      • Update User Information
      • Delete A User
      • Retrieve User Information
      • Retrieve User Memberships List
      • Retrieve User E-passes List
    • E-pass
      • E-pass Management
        • Create E-pass Order
        • Retrieve E-pass Details
        • Cancel an E-pass
      • Orders & Usage
        • Create Orders
          • Lounge Prebooking
            • Create E-pass Prebooking Order - Lounge
            • Create E-pass with Prebooking Order - Lounge
          • Fast Track
            • Create E-pass Prebooking Order - Fast Track
            • Create E-pass with Prebooking Order - Fast Track
          • Fitness
            • Create E-pass Prebooking Order - Fitness
            • Create E-pass with Prebooking Order - Fitness
          • eSIM
            • Create E-pass Prebooking Order - eSIM
            • Top up eSIM data package - E-pass
            • Create E-pass with Prebooking Order - eSIM
        • Retrieve Order List
          • Retrieve E-pass Order List
        • Cancel Orders
          • Cancel an Order
        • Module Specific APIs
          • Fitness
            • Fitness Order Check-In
          • eSIM
            • Retrieve eSIM Data Packages
            • Check eSIM Top-up Availability
            • Retrieve eSIM Order Live Extended Details
        • Usage Details
          • Retrieve E-pass Usage Order Details
    • Membership & Entitlement
      • Membership Lifecycle
        • Membership Registration
        • Update A Membership
        • Retrieve Membership Information
        • Generate Membership Dynamic QR Codes
      • Entitlement Management
        • Update Membership Entitlements
        • Retrieve Membership Entitlement Information
      • Orders & Usage
        • Preview Orders
          • Preview Membership Prebooking Order
        • Create Orders
          • Create Membership Prebooking Order - Lounge
          • Create Membership Prebooking Order - Fast Track
          • Create Membership Prebooking Order - Fitness
          • Create Membership Prebooking Order - eSIM
          • Top up eSIM data package - Membership
        • Cancel Orders
          • Cancel an Order
        • Retrieve Order List
          • Retrieve Membership Order List
        • Usage Details
          • Retrieve Membership Usage Order Details
        • Module Specific APIs
          • Fitness
            • Fitness Order Check-In
          • eSIM
            • Retrieve eSIM Order Live Extended Details
            • Check eSIM Top-up Availability
            • Retrieve eSIM Data Packages
    • Push Event Recovery
      • Push Event Recovery
    • [Sandbox Only] Simulation
      • Lounge
        • Simulate Lounge Redemption - Walk in
        • Simulate Lounge Redemption - Prebooking
        • Simulate Lounge Order Cancellation
      • Fast Track
        • Simulate Fast Track Redemption - Prebooking
        • Simulate Fast Track Order Cancellation
  • Our Team
Homepage
Official SiteContact Us
Homepage
Official SiteContact Us
API Version
v2
  • v2
  • v1
v2
  • v2
  • v1
  1. E-pass

Querying E-pass Usage Orders and Details

Overview#

2.png

E-pass Order vs. Usage Order#

In the DragonPass system, E-pass Orders and Usage Orders represent two different levels of an order lifecycle.
E-pass Order
An E-pass order usually starts with "MS".
It represents the purchase or issuance of an E-pass, which contains one or more available usages.
Usage Order
A Usage Order is generated each time an entitlement is actually used.
The order prefix varies by product type. For example, "SL" represents a single lounge usage.
image.png

Retrieve Order List#

→ Use /orders/ePasses to retrieve the usage order list for a specific E-pass.
Request
Retrieve E-pass 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 example of a Lounge Walk-in order:
Retrieve E-pass Usage Order Details - Lounge Walk in - Response

Lounge Walk-in#

{
    "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#

{
    "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": "EK0001"
            }
        }
    }
}

Fast Track Prebooking#

{
    "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
                }
            ],
            "prebookingRequiredInfo": {
                "firstName": "DragonPass",
                "lastName": "DragonPass",
                "email": "developer@dragonpass.com",
                "phoneNumber": "8081966002",
                "callingCode": "44",
                "transportNumber": "EK0001"
            }
        }
    }
}

Set Meal(Lounge Alternative)#

{
    "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#

{
    "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"
            }
        }
    }
}

Fitness#

{
    "code": 0,
    "data": {
        "status": 1,
        "module": 7,
        "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": "F00001",
            "resourceName": "DragonPass Fitness Club",
            "city": "Manchester",
            "countryOrRegion": "GB",
            "vouchersList": [
                {
                    "voucher": "668800008888",
                    "voucherType": 1
                }
            ],
            "prebookingRequiredInfo": {
                "firstName": "DragonPass",
                "lastName": "DragonPass",
                "email": "developer@dragonpass.com",
                "phoneNumber": "8081966002",
                "callingCode": "44",
                "transportNumber": "string"
            },
            "fitnessOptions": {
                "optionId": "F00001-01",
                "optionName": "Day Pass",
                "optionType": 1,
                "startTime": "10:00",
                "endTime": "11:00",
                "description": "Book a day pass for gym access anytime during opening hours on your chosen date.",
                "highlights": [
                    "Full access to all gym facilities."
                ],
                "language": [
                    "English"
                ],
                "includes": [
                    "Bottle of water"
                ],
                "excludes": [
                    "Sportswear"
                ],
                "notes": [
                    "Please check-in at least 20 min before the class starts."
                ]
            }
        }
    }
}

eSIM#

For eSIM orders, the usage details endpoint will only return basic order information. To retrieve additional details such as remaining data volume and expiration date, please use the Retrieve eSIM Order Extended Details endpoint.
{
    "code": 0,
    "data": {
        "status": 1,
        "module": 8,
        "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": "2025-10-15T10:00:00",
            "usedUsages": 1,
            "resourceId": "E00001",
            "resourceName": "eSIM United Kingdom",
            "vouchersList": [
                {
                    "voucher": "668800008888",
                    "voucherType": 1
                }
            ],
            "esimOptions": {
                "optionId": "E00001-01",
                "optionName": "eSIM United Kingdom - 30GB 10Days",
                "status": 1,
                "activationDate": "2025-04-27T10:00:00+00:00",
                "expirationDate": "2025-04-27T10:00:00+00:00"
            },
            "esim": {
                "iccid": "898600F1234567890123",
                "status": 1
            },
            "esimOrderType": 1
        }
    }
}
Modified at 2026-03-31 06:38:10
Previous
Issuing, Querying, and Cancelling an E-pass
Next
Lounge