REST APIs Documentation

Resource Objects

14 Mar 2025
8 Minutes to read

Dark
Light

Resource Objects

Updated on 14 Mar 2025
8 Minutes to read

Dark
Light

Article summary

Did you find this summary helpful?

Thank you for your feedback

📌 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.

General

PersonObject

Key	Type	Allowed Values	Description
id	Integer	Non-negative, starting at 0	Traveler’s index in the list
first_name	String	Any characters, except the below list	Traveler’s first name
last_name	String	Any characters, except the below list	Traveler’s last name
date_of_birth	String	MM/DD/YYYY	Traveler’s date of birth in the specified format
loyalty	Object	LoyaltyObject	Container for loyalty information

⚠️Not allowed values for first_name and last_name
Any unicode letter category
~
#
;
%
+
|
/
,
@
$
<
^
=
\
:

Example:

{
  "id": 0,
  "first_name": "Arthur",
  "last_name": "Davis",
  "date_of_birth": "04/07/1963"
}

LoyaltyObject

Note: This object is exclusively for use in Travelers and its purpose is to specify rewards or loyalty programs.

Key	Type	Allowed Values	Description
member_id	String	Any	Traveler's loyalty account number
name	String	Any	Name of the merchant's loyalty program
type	String	Any	The currency of the actual loyalty program. Specify “points”, “miles” or other relevant value
tier_level	String	Any	The traveler's specific loyalty level
tier_expiration	String	Any	Date the loyalty tier expires
cobrand_cardholder	String	Any	Name of the co-branded credit card program
date_last_active	String	MM/DD/YYYY	Date of the member's most recent loyalty activity.
points_earned	Integer	Any number	Points/miles earned for this trip
loyalty_rewards	Integer	Any Number	Points/miles balance

Example: Travelers booking using a loyalty card.

 {
   "id": 0,
   "first_name": "Arthur",
   "last_name": "Davis",
   "date_of_birth": "04/07/1963",
   "loyalty": {
     "member_id": "FF287122",
     "name": "My Miles",
     "type": "travel",
     "tier_level": "Silver",
     "cobrand_cardholder": "My Points Visa",
     "date_last_active": "04/11/2028",
     "points_earned": "1565", 
     "loyalty_rewards": "65250"
 }
}

CustomerContactObject

Key	Type	Allowed Values	Description
first_name	String	Any characters, except the below list	Customer’s first name
last_name	String	Any characters, except the below list	Customer’s last name
date_of_birth	String	MM/DD/YYYY	Customer’s date of birth in the specified format
street_address	String	Any	Customer’s first line of address
city	String	Any	Customer’s city
region	String	2-letter code e.g. NY	Customer’s state/province using the standard 2-letter code
country	String	2-letter ISO 3166-2 Country Code e.g. US, CA	Customer’s country using the standard 2-letter code
postal_code	String	Numerical (US) Alpha-numerical (Canada) e.g. N2L3M6	Customer’s postal zip code
phone	String	10 digit number, no special characters.	Customer’s phone number
email	String	Email format (domain)	Customer’s email

⚠️Not allowed values for first_name and last_name
Any unicode letter category
~
#
;
%
+
|
/
,
@
$
<
^
=
\
:

Example:

{
  "first_name": "Arthur",
  "last_name": "Davis",
  "date_of_birth": "04/07/1963",
  "street_address": "1013 Weda Cir",
  "city": "Mayfield",
  "region": "KY",
  "country": "US",
  "postal_code": "99999",
  "phone": "5555552478",
  "email": "arthur@uplift.com"
}

AddOnObject

Key	Type	Allowed Values	Description
id	String	Any, ensure Unique	Add on product identifier (partner specific)
name	String	Any	Add on product name
price	Integer	Non-negative, in Cents	Add on product price

Example:

{
  "id": "0",
  "name": "Priority Boarding",
  "price": 5000
}

InsuranceObject

Key	Type	Allowed Values	Description
id	String	Any, ensure Unique	Insurance identifier (partner specific)
types	[ String ]	cancellation travel bankruptcy	Insurance type
price	Integer	Non-negative, in Cents	Insurance price

Example:

{
  "id": "0",
  "types": ["cancellation"],
  "price": 10000
}

AddressObject

Key	Type	Allowed Values	Description
street_address	String	Any	Street address
city	String	Any	City name
region	String	2-letter code e.g. NY	State/province of property using the standard 2-letter code
country	String	2-letter ISO 3166-2 Country Code e.g. US, CA	Country of property using the standard 2-letter code
postal_code	String	Numerical (US) Alpha-numerical (Canada) e.g. N2L3M6	Postal code of property

Example:

{
  "street_address": "1452 Rental Ave",
  "city": "Mayfield",
  "region": "KY",
  "country": "US",
  "postal_code": "99999"
}

PointObject

Key	Type	Allowed Values	Description
points_used	Integer	Non-negative	Number of points used
original_order_amount	Integer	Non-negative, in Cents	Original order amount

Example:

 {
   "points_used": 100,
   "original_order_amount": 10000
 }

CampaignObject

Key	Type	Allowed Values	Description
code	String	Any	Name of the campaign
order	Integer	Any	If multiple campaigns are running, this field determines what order to consider them in.

Example:

{
  "code": "ABC",
  "order": 1
}

Air-Specific

AirReservationObject

Key	Type	Allowed Values	Description
airline_name	String	Any e.g. Air India	Full name of airline (highly recommended for third-party providers)
origin	String	3-letter IATA code e.g. Toronto Pearson: YYZ	Initial departure airport using the IATA 3-letter code
destination	String	3-letter IATA code e.g. Toronto Pearson: YYZ	Final arrival airport using the IATA 3-letter code
trip_type	String	oneway roundtrip open_jaw	Type of trip
itinerary	[ AirItineraryObject ]	AirItineraryObject	Itinerary details for the trip
insurance	[ InsuranceObject ]	InsuranceObject	Insurance details

Example (One Way):

{
  "airline_name": "Air India",
  "origin": "MIA",
  "destination": "JFK",
  "trip_type": "oneway",
  "itinerary": [
    {
      "departure_apc": "MIA",
      "departure_time": "20271223",
      "arrival_apc": "JFK",
      "arrival_time": "20271224",
      "fare_class": "Economy",
      "carrier_code": "NF",
      "supplier": "air canada"
    }
  ],
  "insurance": [
    {
      "id": "0",
      "types": ["cancellation"],
      "price": 10000
    }
  ]
}

Example (Round Trip):

{
  "airline_name": "Air India",
  "origin": "MIA",
  "destination": "JFK",
  "trip_type": "roundtrip",
  "itinerary": [
    {
      "departure_apc": "MIA",
      "departure_time": "20271223",
      "arrival_apc": "JFK",
      "arrival_time": "20271224",
      "fare_class": "Economy",
      "carrier_code": "NF",
      "supplier": "air canada"
    },

    {
      "departure_apc": "JFK",
      "departure_time": "20271228",
      "arrival_apc": "MIA",
      "arrival_time": "202712228",
      "fare_class": "Economy",
      "carrier_code": "NF",
      "supplier": "air canada"
    }
  ],
  "insurance": [
    {
      "id": "0",
      "types": ["cancellation"],
      "price": 10000
    }
  ]
}

AirItineraryObject

Key	Type	Allowed Values	Description
departure_apc	String	3-letter IATA code e.g. Toronto Pearson: YYZ	Departure airport code using the IATA 3-letter code
departure_time	String	YYYYMMDD	Departure date in the specified format
arrival_apc	String	3-letter IATA code e.g. Toronto Pearson: YYZ	Arrival airport code using the IATA 3-letter code
arrival_time	String	YYYYMMDD	Scheduled arrival date in the specified format
fare_class	String	Any	Type of fare class (e.g. first class, economy)
carrier_code	String	2-letter IATA code e.g. Air India: AI	Airline code using the IATA 2-letter code
supplier	String	Any	Supplier name - this is primarily used in the case of third-party sellers; this is where the name of the airline would be placed

Example:

{
  "departure_apc": "MIA",
  "departure_time": "20271223",
  "arrival_apc": "JFK",
  "arrival_time": "20271224",
  "fare_class": "Economy",
  "carrier_code": "NF",
  "supplier": "air canada"
 }

Hotel-Specific

HotelReservationObject

Key	Type	Allowed Values	Description
hotel_name	String	Any	Name of hotel
brand	String	Any	Brand of hotel defined by partner
property_code	String	Any	Property code defined by partner
supplier	String	Any	Supplier name - this is primarily used in the case of third-party sellers; this is where the name of the airline would be placed
reservation_type	String	pre_paid standard	Use pre_paid for any rate where the hotel will collect the payment in full at or shortly after the booking is made. Use standard for anything else, e.g., pay at hotel.
has_deposit	Boolean	false true	Set to true if the payment is not collected in full in a single transaction, e.g., one night charged at booking and the rest is collected at the hotel during travel. Use false when the payment is collected in one single transaction, at any point between the booking and the travel date.
number_of_rooms	Integer	Positive	Number of rooms in reservation
room_type	String	Any	Type of rooms booked
check_in	String	YYYYMMDD	Date of check in using the specified format
check_out	String	YYYYMMDD	Date of check out using the specified format
address	AddressObject	AddressObject	Address of property
insurance	[ InsuranceObject ]	InsuranceObject	Insurance details if purchased by customer

Example:

{
  "hotel_name": "Snooze Inn",
  "brand": "Snooze Corp",
  "property_code": "SNINN",
  "supplier": "Snooze Deluxe", 
  "reservation_type": "pre_paid",
  "has_deposit": false,
  "number_of_rooms": 1,
  "room_type": "deluxe suite",
  "check_in": "20271224",
  "check_out": "20271225",
  "address": {
    "street_address": "1015 Travel Ave",
    "city": "New York",
    "region": "NY",
    "country": "US", 
    "postal_code": "10001"
  }, 
  "insurance": [
    {
      "id": "0",
      "types": ["cancellation"],
      "price": 10000
    }
  ] 
}

Cruise-Specific

CruiseReservationObject

Key	Type	Allowed Values	Description
cruise_line	String	Any	Cruise line name
brand	String	Any	Brand name - this is primarily used in the case of third-party sellers; this is where the name of the airline would be placed
ship_code	String	Any	Ship code
voyage_id	String	Any	Specific voyage identifier
embark_date	String	YYYYMMDD	Date of embark (start)
disembark_date	String	YYYYMMDD	Date of disembark (end)
cruise_duration	Integer	Non-negative	Cruise duration in days
itinerary	[ CruiseItineraryObject ]	CruiseItineraryObject	Detailed information about Itinerary
rooms	[ RoomObject ]	RoomObject	Rooms booked in reservation
insurance	[ InsuranceObject ]	InsuranceObject	Insurance details if purchased by customer

Example:

{
  "cruise_line": "Wavy Cruise Lines",
  "brand": "Wavy South USA",
  "ship_code": "WAV",
  "voyage_id": "WAV_MIA_FPO_20271201_20271203",
  "embark_date": "20271205",
  "disembark_date": "20271201",
  "cruise_duration": 4,
  "itinerary": [
    {
      "departure_port": "MIA",
      "departure_date": "20271201",
      "arrival_port": "FPO",
      "arrival_date": "20271203",
      "activities": [
        {
          "name": "Swimming with Dolphins",
          "date": "20271203",
          "price": 10000
        }
      ]
    }
  ],
  "rooms": [
    {
      "cabin_type": "Balcony",
      "deck_number": "9",
      "state_room_type": "Junior Suite",
      "state_room_number": "9207",
      "berthed_type": "2 full beds",
      "dining_service": "Free Style"
    }
  ],
  "insurance": [
    {
     "id": "0",
     "types": ["cancellation"],
     "price": 10000
    }
  ]
}

CruiseItineraryObject

Key	Type	Allowed Values	Description
depature_port	String	Any	Departure port name
depature_date	String	YYYYMMDD	Departure date using the specified format
arrival_port	String	Any	Arrival port name
arrival_date	String	YYYYMMDD	Scheduled arrival date using the specified format
activities	[ ActivityObject ]	ActivityObject	Activities booked part of reservation

Example:

{
  "departure_port": "MIA",
  "departure_date": "20271201",
  "arrival_port": "FPO",
  "arrival_date": "20271203",
  "activities": [
    {
      "name": "Swimming with Dolphins",
      "date": "20271203",
      "price": 10000
    }
  ]
}

ActivityObject

Key	Type	Allowed Values	Description
name	String	Any	Name of activity
date	String	YYYYMMDD	Date of activity using the specified format
price	Integer	Non-negative, in Cents	Price of activity

Example:

{
  "name": "Swimming with Dolphins",
  "date": "20271203",
  "price": 10000
}

RoomObject

Key	Type	Allowed Values	Description
cabin_type	String	Any	Cabin type
deck_number	String	Any	Stateroom’s deck number
state_room_type	String	Any	Stateroom type
state_room_number	String	Any	Stateroom number
berthed_type	String	Any	Bed arrangement in cabin
dining_service	String	Any	Dining service if applicable

Example:

{
  "cabin_type": "Balcony",
  "deck_number": "9",
  "state_room_type": "Junior Suite",
  "state_room_number": "9207",
  "berthed_type": "2 full beds",
  "dining_service": "Free Style"
}

Retail-Specific

OrderLineObject

Key	Type	Allowed Values	Description
name	String	Any	Name of product
sku	String	Any	SKU of product
reference	String	Any	Any reference information - use this field for any additional information to be captured for reporting
merchant_data	String	Any	Additional merchant data - use this field for any additional information to be captured for reporting
unit_price	Integer	Non-negative, in Cents	Unit price of item being purchased
quantity	Integer	Non-negative	Quantity of unit being purchased
quantity_unit	String	Abbreviated e.g. kg	Quantity unit of product (measurement)

Example:

{
  "name": "Electric Guitar",
  "sku": "1254865",
  "reference": "el_guitar_1254865",
  "merchant_data": "limited edition",
  "unit_price": 30000,
  "quantity": 1,
  "quantity_unit": "unit"
}

Event-Ticket-Specific

EventTicketObject

Key	Type	Allowed Values	Description
event_name	String	Any	Name of event
venue_name	String	Any	Name of event’s venue
reference_id	String	Any	Reference identifier used for your internal tracking
type	String	Any	Event type
remarks	String	Any	Any additional information - use this field for any additional information to be captured for reporting
unit_price	Integer	Non-negative, in Cents	Price of tickets per unit
quantity	Integer	Non-negative	Quantity of tickets purchased
start_date	String	YYYYMMDD	Start date of event using the specified format
end_date	String	YYYYMMDD	End date of event using the specified format
location	AddressObject	AddressObject	Location of venue
insurance	[ InsuranceObject ]	InsuranceObject	Event ticket’s insurance details

Example:

{
  "event_name": "Mayfield's Annual Music Festival",
  "venue_name": "Events Park",
  "reference_id": "mayfield_annual_2027",
  "type": "music",
  "remarks": "Tentative due to Covid", 
  "unit_price": 15000, 
  "quantity": 1,
  "start_date": "20271201",
  "end_date": "20271202",
  "location": {
    "street_address": "2525 Events Park Cir",
    "city": "Mayfield",
    "region": "KY",
    "country": "US",
    "postal_code": "99999"
  },
  "insurance": [
    {
      "id": "0",
      "types": ["cancellation"],
      "price": 10000
    }
  ] 
}

Rental-Specific

RentalObject

Key	Type	Allowed Values	Description
agency	String	Any	Name of rental agency
type	String	Any	Type/item of rental
reference_id	String	Any	Rental agency specific reference id
remarks	String	Any	Any additional information - use this field for any additional information to be captured for reporting
unit_price	Integer	Non-negative, in Cents	Price of rentals per unit
quantity	Integer	Non-negative	Quantity of units being rented
start_date	String	YYYYMMDD	Start date of rental using the specified format
end_date	String	YYYYMMDD	End date of rental using the specified format
pickup_location	AddressObject	AddressObject	Pick up location for rentals
dropoff_location	AddressObject	AddressObject	Drop off location for rentals
insurance	[ InsuranceObject ]	InsuranceObject	Rental product's insurance details

Example:

{
  "agency": "Car Rentals of Mayfield",
  "type": "2027 Toyota Camry",
  "reference_id": "xshfkwul",
  "remarks": "Black Friday Promotion",
  "unit_price": 1200000,
  "quantity": 1,
  "start_date": "20271205",
  "end_date": "20271206",
  "pickup_location": {
    "street_address": "1452 Rental Ave",
    "city": "Mayfield",
    "region": "KY",
    "country": "US",
    "postal_code": "99999"
  },
  "dropoff_location": {
    "street_address": "1452 Rental Ave",
    "city": "Mayfield",
    "region": "KY",
    "country": "US",
    "postal_code": "99999"
  },
  "insurance": [
    {
      "id": "0",
      "types": ["cancellation"],
      "price": 10000
    }
  ] 
}

Passes-Subscription-Specific

PassesSubscriptionObject

Key	Type	Allowed Values	Description
purchase_site	String	Any	Website where the pass/subscription was purchased
name	String	Any	Pass/Subscription name
type	String	monthly annual day	Type of pass/subscription
renew	Boolean	false true	Automatic renewal
upgraded	Boolean	false true	Purchase is an upgrade for the current pass/subscription
unit_price	Integer	Non-negative, in Cents	Price of pass/subscription per unit
quantity	Integer	Non-negative	Quantity of passes/subscriptions
expire_date	String	YYYYMMDD	Expiration date ofpass/subscription using the specified format
active_date	String	YYYYMMDD	Activation date ofpass/subscription using the specified format
renew_date	String	YYYYMMDD	Renewal date ofpass/subscription using the specified format
recipients	[ PersonObject ]	PersonObject	Subscriber personal information

Example:

{ 
 "purchase_site": "www.uplift.com",
  "name": "Uplift Music", 
  "type": "annual", 
  "renew": true, 
  "upgraded": false, 
  "unit_price": 99400, 
  "quantity": 1, 
  "expire_date": "20280907", 
  "active_date": "20270907", 
  "renew_date": "20280907", 
  "recipients": [ 
    { 
      "id": "0", 
      "first_name": "Arthur", 
      "last_name": "Davis", 
      "date_of_birth": "04/07/1963" 
    } 
  ] 
}

Was this article helpful?

What's Next

Uplift Initialization Configurations

Table of contents