DragonPass API Developer Platform
v1
  • v2
  • v1
HomepageOfficial SiteContact Us
HomepageOfficial SiteContact Us
API Version
v1
  • v2
  • v1
  1. Membership
  • Implementation Guide
    • Get Started
    • DragonPass Modules
    • Our API Solution
  • Development Guide
    • Authentication
    • Response Format
    • Error Codes
    • Order Synchronization
    • UI Design Guidelines
  • Using the API
    • Search for resources
    • E-pass
      • Issuing, Querying, and Cancelling an E-pass
      • Querying E-pass Usage Orders and Details
      • Utilizing The E-pass
        • Lounge
        • Fast Track
        • Dining
    • Membership
      • Manage Memberships & Entitlements
      • Querying Membership Usage Orders and Details
      • Utilizing DragonPass Membership
        • Lounge
        • Fast Track
        • Dining
  • API reference
    • Authentication
      • Generate Access Token
    • Membership Management
      • Membership Registration
      • Update A Membership
      • Retrieve Membership Information
      • Generate Membership Dynamic QR Codes
    • Entitlement Management
      • Update Membership Entitlements
      • Retrieve Membership Entitlement Information
    • Transport Hubs
      • Retrieve Transport Hub
      • Retrieve Transport Hub Details
    • Resources
      • Retrieve Resource List
        • Retrieve Resources List Under A Specific Transport Hub
      • Search For Resources
        • Retrieve Resource Details
        • List Updated Resources
      • Check Resource Availability
        • Check Prebooking Resource Availability
    • Orders Management
      • Create Orders
        • E-pass
          • Issue An E-pass
            • Create E-pass Order
          • Lounge Prebooking
            • Create E-pass with Prebooking Order - Lounge
            • Create E-pass Prebooking Order - Lounge
          • Fast Track
            • Create E-pass Prebooking Order - Fast Track
            • Create E-pass with Prebooking Order - Fast Track
        • Membership
          • Create Membership Prebooking Order - Fast Track
          • Create Membership Prebooking Order - Lounge
      • Retrieve Order List
        • Retrieve E-pass Order List
        • Retrieve Membership Order List
      • Retrieve Order Details
        • E-pass
          • Retrieve E-pass Details
          • Retrieve E-pass Usage Order Details
        • Membership
          • Retrieve Membership Usage Order Details
      • Cancel Orders
        • Cancel an Order
  1. Membership

Querying Membership Usage Orders and Details

Querying Membership Usage Orders and Details#

image.png

Usage Order Status#

EnumStatusDescription
1ConfirmedThe order has been confirmed and is ready to be used.
2UsedThe order has been used to access the service.
3CancelledThe order has been cancelled and cannot be used.
4ExpiredThe order was not used before its validity period and has expired.
5PendingThe order has been created and is awaiting confirmation. This may include waiting for availability checks, or third-party responses.
10FailedThe order failed to be created or processed due to errors or unavailability.
image.png

Retrieve Order List#

→ Use the /orders/memberships endpoint to retrieve the order list for a specific membership or a particular user.
Request
Retrieve Membership Order List - Request

{
  "membershipId": "8888000066668888",
  "module": 1,
  "pageSize": 10,
  "pageNumber": 1
}
Response
A successful response returns the list of all usage orders associated with the specified membership, including details of order created date, locations, and any relevant statuses.
Retrieve Membership Order List - Response

The orderId will be included in the response, which can be used to further search for order details via /orders/memberships/details.
{
    "code": 0,
    "data": {
        "Pagination": {
            "pageSize": 10,
            "pageNumber": 1,
            "totalNumber": 2
        },
        "orders": [
            {
                "orderId": "DP00000000000001",
                "status": 1,
                "module": 1,
                "category": 1,
                "orderCreatedDate": "2024-12-31T00:00:00+00:00",
                "passengerCounts": {
                    "cardholder": 1,
                    "guests": 0
                },
                "resourceId": "N00001",
                "resourceName": "DragonPass Lounge",
                "image": "https://image.dragonpass.com/uploadFile/images/cover.png",
                "transportHubId": "A00001",
                "transportHubName": "Manchester Airport",
                "city": "Manchester",
                "countryOrRegion": "GB"
            },
            {
                "orderId": "DP00000000000002",
                "status": 1,
                "module": 3,
                "category": 1,
                "orderCreatedDate": "2024-12-31T00:00:00+00:00",
                "passengerCounts": {
                    "cardholder": 1,
                    "guests": 0
                },
                "resourceId": "R00001",
                "resourceName": "DragonPass Dining Restaurant",
                "image": "https://image.dragonpass.com/uploadFile/images/cover.png",
                "transportHubId": "A00001",
                "transportHubName": "Manchester Airport",
                "city": "Manchester",
                "countryOrRegion": "GB"
            }
        ]
    }
}

Retrieve Order Details#

→ Use the /orders/memberships/details endpoint to retrieve the order details.
Request
Retrieve Membership 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 Membership Usage Order Details - Response

Lounge Walk-in Order Example#

{
    "code": 0,
    "data": {
        "status": 2,
        "module": 1,
        "category": 1,
        "membershipId": "8888000066668888",
        "orderId": "DP00000000000001",
        "orderCreatedDate": "2024-12-31T00:00:00+00:00",
        "orderCancelledDate": null,
        "extra": {
            "usageDate": "2024-12-31T00:00:00",
            "usedEntitlementDetails": {
                "cardholderExclusiveEntitlements": 1,
                "guestsExclusiveEntitlements": 1,
                "sharedEntitlements": 0
            },
            "resourceId": "N00001",
            "resourceName": "DragonPass Lounge",
            "iata": "MAN",
            "transportHubName": "Manchester Airport",
            "terminal": "Terminal 1",
            "city": "Manchester",
            "countryOrRegion": "GB",
            "passengerCounts": {
                "cardholder": 1,
                "guests": 1
            }
        }
    }
}

Lounge Prebooking Order Example#

{
    "code": 0,
    "data": {
        "status": 1,
        "module": 1,
        "category": 2,
        "membershipId": "8888000066668888",
        "orderId": "DP00000000000001",
        "orderCreatedDate": "2024-12-31T00:00:00+00:00",
        "orderCancelledDate": null,
        "extra": {
            "prebookingDate": "2025-10-01T10:30",
            "usageDate": "2025-10-01T10:35:26+00:00",
            "cashPaymentApplied": false,
            "usedEntitlementDetails": {
                "cardholderExclusiveEntitlements": 1,
                "guestsExclusiveEntitlements": 0,
                "sharedEntitlements": 0
            },
            "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",
                "flightNumber": "EK001"
            },
            "passengerCounts": {
                "cardholder": 1,
                "guests": 0
            }
        }
    }
}

Fast Track Prebooking Order Example#

{
    "code": 0,
    "data": {
        "status": 2,
        "module": 2,
        "category": 2,
        "membershipId": "8888000066668888",
        "orderId": "DP00000000000001",
        "orderCreatedDate": "2024-12-31T00:00:00+00:00",
        "orderCancelledDate": null,
        "extra": {
            "prebookingDate": "2025-10-01T10:30",
            "usageDate": null,
            "cashPaymentApplied": false,
            "usedEntitlementDetails": {
                "cardholderExclusiveEntitlements": 1,
                "guestsExclusiveEntitlements": 0,
                "sharedEntitlements": 0
            },
            "passengerCounts": {
                "cardholder": 1,
                "guests": 0
            },
            "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,
        "membershipId": "8888000066668888",
        "orderId": "DP00000000000001",
        "orderCreatedDate": "2024-12-31T00:00:00+00:00",
        "orderCancelledDate": null,
        "extra": {
            "usageDate": "2024-12-31T00:00:00",
            "usedEntitlementDetails": {
                "cardholderExclusiveEntitlements": 1,
                "guestsExclusiveEntitlements": 1,
                "sharedEntitlements": 0
            },
            "passengerCounts": {
                "cardholder": 1,
                "guests": 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,
        "membershipId": "8888000066668888",
        "orderId": "DP00000000000001",
        "orderCreatedDate": "2024-12-31T00:00:00+00:00",
        "orderCancelledDate": null,
        "extra": {
            "usageDate": "2024-12-31T00:00:00",
            "usedEntitlementDetails": {
                "cardholderExclusiveEntitlements": 1,
                "guestsExclusiveEntitlements": 0,
                "sharedEntitlements": 0
            },
            "passengerCounts": {
                "cardholder": 1,
                "guests": 0
            },
            "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"
            }
        }
    }
}
Modified atĀ 2025-07-09 06:33:27
Previous
Manage Memberships & Entitlements
Next
Lounge