High Level Schema Overview
- 14 Mar 2025
- 1 Minute to read
- DarkLight
High Level Schema Overview
- Updated on 14 Mar 2025
- 1 Minute to read
- DarkLight
Article summary
Did you find this summary helpful?
Thank you for your feedback
We have divided our schema into different verticals on the basis of the different industries that our partners operate in. Ensure to use the schema that is relevant to your business.
đź“Ś Mandatory Fields
Note that the order object must include all its corresponding mandatory fields; the mandatory fields are highlighted in bold in the tables below.
⚠️ Note that billing_contact can be used on payment pages to pre-fill information in the Uplift application iFrame. Thus, while it is not required by any vertical with the exception of Retail, it is highly recommended to improve customer experience.
Air
Key | Type | Allowed Values | Description |
|---|---|---|---|
travelers | [ PersonObject ] | Traveler's personal details | |
air_reservations | [ AirReservationObject ] | Air reservation itinerary details | |
add_ons | [ AddOnObject ] | Add on product details | |
order_amount | Integer | Non-negative, in Cents | Total price amount of order |
billing_contact | CustomerContactObject | Customer’s billing contact information | |
points | [ PointObject ] | Points details (e.g. loyalty) |
Hotel
Key | Type | Allowed Values | Description |
|---|---|---|---|
travelers | [ PersonObject ] | Traveler's personal details | |
hotel_reservations | [ HotelReservationObject ] | Hotel reservation itinerary details | |
add_ons | [ AddOnObject ] | Add on product details | |
order_amount | Integer | Non-negative, in Cents | Total price amount of order |
billing_contact | CustomerContactObject | Customer’s billing contact information | |
points | [ PointObject ] | Points details (e.g. loyalty) |
Cruise
Key | Type | Allowed Values | Description |
|---|---|---|---|
travelers | [ PersonObject ] | Traveler's personal details | |
cruise_reservations | [ CruiseReservationObject ] | Cruise reservation itinerary details | |
add_ons | [ AddOnObject ] | Add on product details | |
order_amount | Integer | Non-negative, in Cents | Total price amount of order |
billing_contact | CustomerContactObject | Customer’s billing contact information | |
points | [ PointObject ] | Points details (e.g. loyalty) |
Retail
Key | Type | Allowed Values | Description |
|---|---|---|---|
billing_contact | CustomerContactObject | Customer’s billing contact information | |
shipping_contact | CustomerContactObject | Customer’s shipping contact information | |
order_lines | [ OrderLineObject ] | Order line details (such as quantity, sku, name etc.) | |
order_amount | Integer | Non-negative, in Cents | Total price amount of order |
Event-Tickets
Key | Type | Allowed Values | Description |
|---|---|---|---|
travelers | [ PersonObject ] | Customer's personal details | |
event_tickets | [ EventTicketObject ] | Event ticket details | |
add_ons | [ AddOnObject ] | Add on product details | |
order_amount | Integer | Non-negative, in Cents | Total price amount of order |
billing_contact | CustomerContactObject | Customer’s billing contact information | |
points | [ PointObject ] | Points details (e.g. loyalty) |
Rentals
Key | Type | Allowed Values | Description |
|---|---|---|---|
travelers | [ PersonObject ] | Traveler's personal details | |
rentals | [ RentalObject ] | Rental agreement details | |
add_ons | [ AddOnObject ] | Add on product details | |
order_amount | Integer | Non-negative, in Cents | Total price amount of order |
billing_contact | CustomerContactObject | Customer’s billing contact information | |
points | [ PointObject ] | Points details (e.g. loyalty) |
Passes-Subscription
Key | Type | Allowed Values | Description |
|---|---|---|---|
travelers | [ PersonObject ] | Traveler's personal details | |
passes_subscription | [ PassesSubscriptionObject ] | Pass/Subscription details | |
add_ons | [ AddOnObject ] | Add on product details | |
order_amount | Integer | Non-negative, in Cents | Total price amount of order |
billing_contact | CustomerContactObject | Customer’s billing contact information |
Was this article helpful?