Create Order
- 04 Jun 2025
- 17 Minutes to read
- DarkLight
Create Order
- Updated on 04 Jun 2025
- 17 Minutes to read
- DarkLight
Article summary
Did you find this summary helpful?
Thank you for your feedback!
Post
/v1/orders
Used to create different order types. Look at the order_items array for the different types of orders.
Security
HTTP
Type bearer
Body parameters
object
Order details.
addOns
Array of object
List of addons.
object
externalId
string
Unique addon identifier.
name
string
Addon name.
price
string
Addon price in dollar format.
Example100.13
billingContact
object (BillingContact)
city
string
Billing contact city.
ExampleNew York City
country
string
Billing contact country.
Valid values[ "\"US\"", "\"CA\"" ]
dateOfBirth
string (date)
Billing contact date of birth in YYYY-MM-DD format.
Example1996-10-21
email
string
Billing contact email.
Examplesample@flexpay.com
firstName
string
Billing contact first name.
ExampleArthur
lastName
string
Billing contact last name.
ExampleDavis
middleName
string
Billing contact middle name.
ExampleMiddle
phone
string
Billing contact phone number.
Example5555551444
postalCode
string
Billing contact numerical (US)/alpha-numerical (CA) postal or zip code.
Example99999
region
string
Billing contact state/province in standard 2-letter format.
ExampleKY
streetAddress
string
Billing contact street address.
Example1013 Weda Cir
title
string
Billing contact title.
Valid values[ "\"DR\"", "\"MISS\"", "\"MR\"", "\"MRS\"", "\"MS\"" ]
merchantConfig
object (MerchantConfig) Required
Contains merchant specific configurations
cancelUrl
string Required
The merchant cancel URL to redirect to if the application is unsuccessful.
confirmationUrl
string Required
The merchant confirmation URL to redirect to after the application is completed through the Uplift domain.
confirmationId
string | null
Confirmation ID for the order
channel
string
Request channel.
Valid values[ "\"APP\"", "\"MOBILE_WEB\"", "\"WEB\"" ]
integrationId
string Required
Unique integration identifier.
ExampleUP-12345678-99
orderItems
Array of object (OrderItem) Required
A list of order reservations.
object
Only one detail type per line.
OneOf
AirDetails
object (AirDetails)
air
object (AirReservation)
id
string | null
Do not send or set to null in request.
Example
airlineName
string
Full airline name (recommended for third-party providers).
ExampleSample Airlines
insurance
Array of object (Insurance)
Insurance details.
object
Insurance.
externalId
string
Unique insurance identifier.
price
string
Insurance price in dollar format.
Example100.12
types
Array of string
List of insurance types.
string
Valid values[ "\"BANKRUPTCY\"", "\"CANCELLATION\"", "\"TRAVEL\"" ]
itinerary
Array of object (AirSegment) Required
Reservation itinerary details. If there are multiple itinerary segments, order the segments chronologically (earliest to latest departureDate).
object
arrivalApc
string Required
Arrival airport code in IATA 3-letter format.
ExampleJFK
arrivalCity
string
Arrival city.
ExampleNew York City
arrivalDate
string (date)
Arrival date in YYYY-MM-DD format.
Example2024-10-12
carrierCode
string
Airline code in IATA 2-letter format.
ExampleAI
departureApc
string Required
Departure airport code in IATA 3-letter format.
ExampleLGA
departureCity
string
Departure city.
ExampleLos Angeles
departureDate
string (date) Required
Departure date in YYYY-MM-DD format.
Example2024-10-12
ticketType
string
Ticket type.
Valid values[ "\"DIGITAL\"", "\"PHONE\"", "\"PICK_UP\"", "\"POST\"" ]
fareClass
string
Fare class type.
Examplefirst class
supplier
string
Supplier name (recommended for third-party providers). Use the full airline name.
ExampleSample Airlines
price
string
Total reservation amount in dollar format.
Example100.13
reservationType
string
Reservation type.
Valid values[ "\"OPAQUE\"", "\"PRE_PAID\"", "\"STANDARD\"" ]
tripType
string
Trip type.
Valid values[ "\"ONEWAY\"", "\"OPEN_JAW\"", "\"ROUNDTRIP\"" ]
CruiseDetails
object (CruiseDetails)
cruise
object (CruiseReservation)
Cruise reservation.
id
string | null
Do not send or set to null in request.
Example
addOns
Array of object (CruiseAddon)
List of cruise addons.
object
Cruise addon.
name
string
Addon name.
price
string
Addon price in dollar format.
Example100.13
brand
string
Reservation brand name (recommended for third-party providers). Use full cruise line name.
cruiseDuration
string
Cruise duration in days.
Example10
cruiseLine
string
Cruise line name.
disembarkDate
string (date)
Disembark date in YYYY-MM-DD format.
Example2024-10-12
embarkDate
string (date) Required
Embark date in YYYY-MM-DD format.
Example2024-10-12
insurance
Array of object (Insurance)
Insurance details.
object
Insurance.
externalId
string
Unique insurance identifier.
price
string
Insurance price in dollar format.
Example100.12
types
Array of string
List of insurance types.
string
Valid values[ "\"BANKRUPTCY\"", "\"CANCELLATION\"", "\"TRAVEL\"" ]
itinerary
Array of object (CruiseSegment) Required
Reservation itinerary. If there are multiple itinerary segments, order them chronologically (earliest to latest departureDate).
object
Cruise segment.
activities
Array of object (CruiseActivity)
Booked reservation activities.
object
Cruise activity.
date
string (date)
Activity date in YYYY-MM-DD format.
Example2024-10-12
name
string
Activity name.
price
string
Activity price in dollar format.
Example100.13
arrivalDate
string (date)
Scheduled arrival date in YYYY-MM-DD format.
Example2024-10-12
arrivalPort
string
Arrival port name.
ExampleAlaska
departureDate
string (date) Required
Departure date in YYYY-MM-DD format.
Example2024-10-12
departurePort
string
Departure port name.
ExampleMiami
rooms
Array of object (CruiseCabin)
List of cruise cabins.
object
Cruise cabin.
berthedType
string
Cabin bed arrangement.
cabinType
string
Cabin type.
deckNumber
string
Cabin stateroom deck number.
diningService
string
Cabin dining service.
stateRoomNumber
string
Cabin stateroom number.
stateRoomType
string
Cabin stateroom type.
shipCode
string
Ship code.
supplier
string
Supplier name (recommended for third-party providers). Use full cruise line name.
Examplecarnival
voyageId
string
Specific voyage identifier.
EventTicketDetails
object (EventTicketDetails)
eventTicket
object (EventTicket)
Event ticket.
id
string | null
Do not send or set to null in request.
Example
endDate
string (date)
Event end date in YYYY-MM-DD format.
Example2024-10-12
eventName
string
Event name.
extras
Array of object (Extra)
List of event extras.
object
Extra.
externalId
string
Unique extra identifier.
name
string
Extra name.
price
string
Extra price in dollar format.
Example100.13
host
string
Event host.
insurance
Array of object (Insurance)
Insurance details.
object
Insurance.
externalId
string
Unique insurance identifier.
price
string
Insurance price in dollar format.
Example100.12
types
Array of string
List of insurance types.
string
Valid values[ "\"BANKRUPTCY\"", "\"CANCELLATION\"", "\"TRAVEL\"" ]
location
object (Location)
Location details.
city
string
ExampleLos Angeles
country
string
2-letter ISO 3166-2 country code
ExampleUS
postalCode
string
Numerical (US)/alpha-numerical (CA) postal or zip code.
Example99999
region
string
State/province in standard 2-letter format.
ExampleCA
streetAddress
string
quantity
string
Number of tickets purchased.
Example1
referenceId
string
Event ticket reference identifier.
startDate
string (date) Required
Event start date in YYYY-MM-DD format.
Example2024-10-12
type
string
Event type.
unitPrice
string
Price per ticket in dollar format.
Example100.13
venueName
string
Event venue name.
OrderLineDetails
object (OrderLineDetails)
orderLine
object (OrderLine)
Product item.
id
string | null
Do not send or set to null in request.
Example
name
string
Product name.
quantity
string
Product quantity.
Example1
sku
string
Product SKU.
type
string
Product type.
Valid values[ "\"DIGITAL\"", "\"DISCOUNT\"", "\"FEE\"", "\"GIFT_CARD\"", "\"PHYSICAL\"", "\"SALES_TAX\"", "\"SHIPPING_FEE\"", "\"STORE_CREDIT\"", "\"SURCHARGE\"", "\"TRAVEL\"" ]
unitPrice
string
Product unit price in dollar format.
Example100.13
reference
string
Product reference information - use this field for any additional information to be captured for reporting.
HotelDetails
object (HotelDetails)
hotel
object (HotelReservation)
Hotel reservation.
id
string | null
Do not send or set to null in request.
Example
brand
string
Hotel brand name.
checkInDate
string (date) Required
Check-in date in YYYY-MM-DD format.
Example2024-10-12
checkOutDate
string (date)
Check-out date in YYYY-MM-DD format.
Example2024-10-12
hotelName
string Required
Hotel name.
insurance
Array of object (Insurance)
Insurance details.
object
Insurance.
externalId
string
Unique insurance identifier.
price
string
Insurance price in dollar format.
Example100.12
types
Array of string
List of insurance types.
string
Valid values[ "\"BANKRUPTCY\"", "\"CANCELLATION\"", "\"TRAVEL\"" ]
numberOfRooms
string
Reservation number of rooms.
Example2
price
string
Reservation price in dollar format.
Example100.13
propertyCode
string
Hotel property code.
reservationType
string
Reservation type.
Valid values[ "\"OPAQUE\"", "\"PRE_PAID\"", "\"STANDARD\"" ]
supplier
string
Supplier name (recommended for third-party providers). Use full hotel brand name.
ticketType
string
Ticket type.
Valid values[ "\"DIGITAL\"", "\"PHONE\"", "\"PICK_UP\"", "\"POST\"" ]
SubscriptionDetails
object (SubscriptionDetails)
subscription
object (Subscription)
Subscription.
id
string | null
Do not send or set to null in request.
Example
activeDate
string (date) Required
Subscription active date in YYYY-MM-DD format.
Example2024-10-12
expireDate
string (date)
Subscription expiration date in YYYY-MM-DD format.
Example2024-10-12
name
string
Subscription name.
renew
boolean
Whether the subscription is automatic renewal.
renewDate
string (date)
Subscription renew date in YYYY-MM-DD format.
Example2024-10-12
purchaseSite
string
Subscription purchase website.
quantity
string
Subscription quantity.
Example1
type
string
Subscription type.
unitPrice
string
Price per subscription in dollar format.
Example100.13
upgraded
boolean
Whether the purchase is an upgrade for an existing subscription.
RentalDetails
object (RentalDetails)
rental
object (Rental)
Rental.
id
string | null
Do not send or set to null in request.
Example
agency
string
Rental agency name.
endDate
string (date)
Rental end date in YYYY-MM-DD format.
Example2024-10-12
extras
Array of object (Extra)
List of rental extras.
object
Extra.
externalId
string
Unique extra identifier.
name
string
Extra name.
price
string
Extra price in dollar format.
Example100.13
insurance
Array of object (Insurance)
Insurance details.
object
Insurance.
externalId
string
Unique insurance identifier.
price
string
Insurance price in dollar format.
Example100.12
types
Array of string
List of insurance types.
string
Valid values[ "\"BANKRUPTCY\"", "\"CANCELLATION\"", "\"TRAVEL\"" ]
quantity
string
Number of rental items.
Example1
referenceId
string
Rental agency-specific reference ID.
rentalItems
Array of object (RentalItem)
List of rental items.
object
Rental item details.
name
string
Item name.
price
string
Item price in dollar format.
Example100.13
startDate
string (date) Required
Rental start date in YYYY-MM-DD format.
Example2024-10-12
type
string
Rental type or item.
unitPrice
string
Rental price per unit in dollar format.
Example100.13
localization
object (Localization) Required
Order localization details.
country
string Required
Localization countries.
Valid values[ "\"US\"", "\"CA\"" ]
currency
string Required
Localization currencies.
Valid values[ "\"USD\"", "\"CAD\"" ]
locale
string Required
Localization locales.
Valid values[ "\"en-US\"", "\"en-CA\"", "\"fr-CA\"" ]
path
string
Location of the targeted display.
ExampleMain booking path
price
string Required
Total order amount in dollar format.
Example1000.13
points
Array of object (Points)
List of point details (e.g. loyalty).
object
Amount of Points/Miles used to pay for the current transaction. The member may not be one of the traveler.
pointsType
string
Points type or category.
originalOrderAmount
string
If applicable, the original amount of the transaction (cash amount) before the member applied Points/Miles to the transaction.
Example100.13
supplierCode
string
Supplier code.
ExampleSC-12345678-9
campaignAttributes
Array of object (CampaignAttribute)
List of targeted campaign attributes.
object
Optional targeted campaign attribute.
name
string Required
Campaign attribute name.
Examplemerchant_field_1
value
string Required
Campaign attribute value.
Examplesubvention
travelers
Array of object (Person)
List of travelers.
object
Traveler details.
id
string | null
Do not send or set to null in request.
Example
firstName
string
lastName
string
title
string
Traveler title.
Valid values[ "\"DR\"", "\"MISS\"", "\"MR\"", "\"MRS\"", "\"MS\"" ]
dateOfBirth
string (date)
Traveler date of birth in YYYY-MM-DD format.
Example1996-10-21
loyalty
object
Details about loyalty programs for the applicant.
memberId
string
The member's loyalty program ID.
ExampleBA7854365
name
string
The name of the loyalty program.
ExampleMarriott Bonvoy, AAdvantage, Rapid Rewards, SkyMiles
type
string
The currency used by the loyalty program.
ExampleMiles, Points, KrisFlyer Miles, Avios
tierLevel
string
The tier level of the member.
ExampleSilver, Gold, Titanium, President’s Circle
tierExpiration
string (date)
The expiration of the member's tier level - last day of validity, if any.
Example2024-10-12
memberFirstName
string
The first name of the member. This is used if the loyalty member is different from the customer (E.g., providing someone else’s loyalty account).
ExampleLaura Mary
memberLastName
string
The last name of the member.
ExampleSmith
memberDateOfBirth
string (date)
The date of birth of the member.
Example2024-10-12
cobrandCardholder
string
The name of the card held by the member.
ExampleBritish Airways Visa Signature, Hilton Honors American Express, Marriott Bonvoy Boundless
loyaltyRewards
string
Amount of Points/Miles remaining in the member’s loyalty account after the transaction. The member may not be one of the travelers.
Example10
pointsEarned
string
Amount of Points/Miles accrued with the current transaction, if any.
Example1002
dateLastActive
string (date)
Date of the member’s most recent loyalty activity.
Example2024-10-12
numOfTravelersInclMinors
integer | null
Total number of travelers including minors
Responses
200
Successful order response
object
addOns
Array of object
List of addons.
object
externalId
string
Unique addon identifier.
name
string
Addon name.
price
string
Addon price in dollar format.
Example100.13
billingContact
object (BillingContact)
city
string
Billing contact city.
ExampleNew York City
country
string
Billing contact country.
Valid values[ "\"US\"", "\"CA\"" ]
dateOfBirth
string (date)
Billing contact date of birth in YYYY-MM-DD format.
Example1996-10-21
email
string
Billing contact email.
Examplesample@flexpay.com
firstName
string
Billing contact first name.
ExampleArthur
lastName
string
Billing contact last name.
ExampleDavis
middleName
string
Billing contact middle name.
ExampleMiddle
phone
string
Billing contact phone number.
Example5555551444
postalCode
string
Billing contact numerical (US)/alpha-numerical (CA) postal or zip code.
Example99999
region
string
Billing contact state/province in standard 2-letter format.
ExampleKY
streetAddress
string
Billing contact street address.
Example1013 Weda Cir
title
string
Billing contact title.
Valid values[ "\"DR\"", "\"MISS\"", "\"MR\"", "\"MRS\"", "\"MS\"" ]
merchantConfig
object (MerchantConfig)
Contains merchant specific configurations
cancelUrl
string
The merchant cancel URL to redirect to if the application is unsuccessful.
confirmationUrl
string
The merchant confirmation URL to redirect to after the application is completed through the Uplift domain.
confirmationId
string | null
Confirmation ID for the order
channel
string
Request channel.
Valid values[ "\"APP\"", "\"MOBILE_WEB\"", "\"WEB\"" ]
integrationId
string
Unique integration identifier.
ExampleUP-12345678-99
orderItems
Array of object (OrderItem)
A list of order reservations.
object
Only one detail type per line.
OneOf
AirDetails
object (AirDetails)
air
object (AirReservation)
id
string | null
Do not send or set to null in request.
Example
airlineName
string
Full airline name (recommended for third-party providers).
ExampleSample Airlines
insurance
Array of object (Insurance)
Insurance details.
object
Insurance.
externalId
string
Unique insurance identifier.
price
string
Insurance price in dollar format.
Example100.12
types
Array of string
List of insurance types.
string
Valid values[ "\"BANKRUPTCY\"", "\"CANCELLATION\"", "\"TRAVEL\"" ]
itinerary
Array of object (AirSegment)
Reservation itinerary details. If there are multiple itinerary segments, order the segments chronologically (earliest to latest departureDate).
object
arrivalApc
string
Arrival airport code in IATA 3-letter format.
ExampleJFK
arrivalCity
string
Arrival city.
ExampleNew York City
arrivalDate
string (date)
Arrival date in YYYY-MM-DD format.
Example2024-10-12
carrierCode
string
Airline code in IATA 2-letter format.
ExampleAI
departureApc
string
Departure airport code in IATA 3-letter format.
ExampleLGA
departureCity
string
Departure city.
ExampleLos Angeles
departureDate
string (date)
Departure date in YYYY-MM-DD format.
Example2024-10-12
ticketType
string
Ticket type.
Valid values[ "\"DIGITAL\"", "\"PHONE\"", "\"PICK_UP\"", "\"POST\"" ]
fareClass
string
Fare class type.
Examplefirst class
supplier
string
Supplier name (recommended for third-party providers). Use the full airline name.
ExampleSample Airlines
price
string
Total reservation amount in dollar format.
Example100.13
reservationType
string
Reservation type.
Valid values[ "\"OPAQUE\"", "\"PRE_PAID\"", "\"STANDARD\"" ]
tripType
string
Trip type.
Valid values[ "\"ONEWAY\"", "\"OPEN_JAW\"", "\"ROUNDTRIP\"" ]
CruiseDetails
object (CruiseDetails)
cruise
object (CruiseReservation)
Cruise reservation.
id
string | null
Do not send or set to null in request.
Example
addOns
Array of object (CruiseAddon)
List of cruise addons.
object
Cruise addon.
name
string
Addon name.
price
string
Addon price in dollar format.
Example100.13
brand
string
Reservation brand name (recommended for third-party providers). Use full cruise line name.
cruiseDuration
string
Cruise duration in days.
Example10
cruiseLine
string
Cruise line name.
disembarkDate
string (date)
Disembark date in YYYY-MM-DD format.
Example2024-10-12
embarkDate
string (date)
Embark date in YYYY-MM-DD format.
Example2024-10-12
insurance
Array of object (Insurance)
Insurance details.
object
Insurance.
externalId
string
Unique insurance identifier.
price
string
Insurance price in dollar format.
Example100.12
types
Array of string
List of insurance types.
string
Valid values[ "\"BANKRUPTCY\"", "\"CANCELLATION\"", "\"TRAVEL\"" ]
itinerary
Array of object (CruiseSegment)
Reservation itinerary. If there are multiple itinerary segments, order them chronologically (earliest to latest departureDate).
object
Cruise segment.
activities
Array of object (CruiseActivity)
Booked reservation activities.
object
Cruise activity.
date
string (date)
Activity date in YYYY-MM-DD format.
Example2024-10-12
name
string
Activity name.
price
string
Activity price in dollar format.
Example100.13
arrivalDate
string (date)
Scheduled arrival date in YYYY-MM-DD format.
Example2024-10-12
arrivalPort
string
Arrival port name.
ExampleAlaska
departureDate
string (date)
Departure date in YYYY-MM-DD format.
Example2024-10-12
departurePort
string
Departure port name.
ExampleMiami
rooms
Array of object (CruiseCabin)
List of cruise cabins.
object
Cruise cabin.
berthedType
string
Cabin bed arrangement.
cabinType
string
Cabin type.
deckNumber
string
Cabin stateroom deck number.
diningService
string
Cabin dining service.
stateRoomNumber
string
Cabin stateroom number.
stateRoomType
string
Cabin stateroom type.
shipCode
string
Ship code.
supplier
string
Supplier name (recommended for third-party providers). Use full cruise line name.
Examplecarnival
voyageId
string
Specific voyage identifier.
EventTicketDetails
object (EventTicketDetails)
eventTicket
object (EventTicket)
Event ticket.
id
string | null
Do not send or set to null in request.
Example
endDate
string (date)
Event end date in YYYY-MM-DD format.
Example2024-10-12
eventName
string
Event name.
extras
Array of object (Extra)
List of event extras.
object
Extra.
externalId
string
Unique extra identifier.
name
string
Extra name.
price
string
Extra price in dollar format.
Example100.13
host
string
Event host.
insurance
Array of object (Insurance)
Insurance details.
object
Insurance.
externalId
string
Unique insurance identifier.
price
string
Insurance price in dollar format.
Example100.12
types
Array of string
List of insurance types.
string
Valid values[ "\"BANKRUPTCY\"", "\"CANCELLATION\"", "\"TRAVEL\"" ]
location
object (Location)
Location details.
city
string
ExampleLos Angeles
country
string
2-letter ISO 3166-2 country code
ExampleUS
postalCode
string
Numerical (US)/alpha-numerical (CA) postal or zip code.
Example99999
region
string
State/province in standard 2-letter format.
ExampleCA
streetAddress
string
quantity
string
Number of tickets purchased.
Example1
referenceId
string
Event ticket reference identifier.
startDate
string (date)
Event start date in YYYY-MM-DD format.
Example2024-10-12
type
string
Event type.
unitPrice
string
Price per ticket in dollar format.
Example100.13
venueName
string
Event venue name.
OrderLineDetails
object (OrderLineDetails)
orderLine
object (OrderLine)
Product item.
id
string | null
Do not send or set to null in request.
Example
name
string
Product name.
quantity
string
Product quantity.
Example1
sku
string
Product SKU.
type
string
Product type.
Valid values[ "\"DIGITAL\"", "\"DISCOUNT\"", "\"FEE\"", "\"GIFT_CARD\"", "\"PHYSICAL\"", "\"SALES_TAX\"", "\"SHIPPING_FEE\"", "\"STORE_CREDIT\"", "\"SURCHARGE\"", "\"TRAVEL\"" ]
unitPrice
string
Product unit price in dollar format.
Example100.13
reference
string
Product reference information - use this field for any additional information to be captured for reporting.
HotelDetails
object (HotelDetails)
hotel
object (HotelReservation)
Hotel reservation.
id
string | null
Do not send or set to null in request.
Example
brand
string
Hotel brand name.
checkInDate
string (date)
Check-in date in YYYY-MM-DD format.
Example2024-10-12
checkOutDate
string (date)
Check-out date in YYYY-MM-DD format.
Example2024-10-12
hotelName
string
Hotel name.
insurance
Array of object (Insurance)
Insurance details.
object
Insurance.
externalId
string
Unique insurance identifier.
price
string
Insurance price in dollar format.
Example100.12
types
Array of string
List of insurance types.
string
Valid values[ "\"BANKRUPTCY\"", "\"CANCELLATION\"", "\"TRAVEL\"" ]
numberOfRooms
string
Reservation number of rooms.
Example2
price
string
Reservation price in dollar format.
Example100.13
propertyCode
string
Hotel property code.
reservationType
string
Reservation type.
Valid values[ "\"OPAQUE\"", "\"PRE_PAID\"", "\"STANDARD\"" ]
supplier
string
Supplier name (recommended for third-party providers). Use full hotel brand name.
ticketType
string
Ticket type.
Valid values[ "\"DIGITAL\"", "\"PHONE\"", "\"PICK_UP\"", "\"POST\"" ]
SubscriptionDetails
object (SubscriptionDetails)
subscription
object (Subscription)
Subscription.
id
string | null
Do not send or set to null in request.
Example
activeDate
string (date)
Subscription active date in YYYY-MM-DD format.
Example2024-10-12
expireDate
string (date)
Subscription expiration date in YYYY-MM-DD format.
Example2024-10-12
name
string
Subscription name.
renew
boolean
Whether the subscription is automatic renewal.
renewDate
string (date)
Subscription renew date in YYYY-MM-DD format.
Example2024-10-12
purchaseSite
string
Subscription purchase website.
quantity
string
Subscription quantity.
Example1
type
string
Subscription type.
unitPrice
string
Price per subscription in dollar format.
Example100.13
upgraded
boolean
Whether the purchase is an upgrade for an existing subscription.
RentalDetails
object (RentalDetails)
rental
object (Rental)
Rental.
id
string | null
Do not send or set to null in request.
Example
agency
string
Rental agency name.
endDate
string (date)
Rental end date in YYYY-MM-DD format.
Example2024-10-12
extras
Array of object (Extra)
List of rental extras.
object
Extra.
externalId
string
Unique extra identifier.
name
string
Extra name.
price
string
Extra price in dollar format.
Example100.13
insurance
Array of object (Insurance)
Insurance details.
object
Insurance.
externalId
string
Unique insurance identifier.
price
string
Insurance price in dollar format.
Example100.12
types
Array of string
List of insurance types.
string
Valid values[ "\"BANKRUPTCY\"", "\"CANCELLATION\"", "\"TRAVEL\"" ]
quantity
string
Number of rental items.
Example1
referenceId
string
Rental agency-specific reference ID.
rentalItems
Array of object (RentalItem)
List of rental items.
object
Rental item details.
name
string
Item name.
price
string
Item price in dollar format.
Example100.13
startDate
string (date)
Rental start date in YYYY-MM-DD format.
Example2024-10-12
type
string
Rental type or item.
unitPrice
string
Rental price per unit in dollar format.
Example100.13
localization
object (Localization)
Order localization details.
country
string
Localization countries.
Valid values[ "\"US\"", "\"CA\"" ]
currency
string
Localization currencies.
Valid values[ "\"USD\"", "\"CAD\"" ]
locale
string
Localization locales.
Valid values[ "\"en-US\"", "\"en-CA\"", "\"fr-CA\"" ]
path
string
Location of the targeted display.
ExampleMain booking path
price
string
Total order amount in dollar format.
Example1000.13
points
Array of object (Points)
List of point details (e.g. loyalty).
object
Amount of Points/Miles used to pay for the current transaction. The member may not be one of the traveler.
pointsType
string
Points type or category.
originalOrderAmount
string
If applicable, the original amount of the transaction (cash amount) before the member applied Points/Miles to the transaction.
Example100.13
supplierCode
string
Supplier code.
ExampleSC-12345678-9
campaignAttributes
Array of object (CampaignAttribute)
List of targeted campaign attributes.
object
Optional targeted campaign attribute.
name
string
Campaign attribute name.
Examplemerchant_field_1
value
string
Campaign attribute value.
Examplesubvention
travelers
Array of object (Person)
List of travelers.
object
Traveler details.
id
string | null
Do not send or set to null in request.
Example
firstName
string
lastName
string
title
string
Traveler title.
Valid values[ "\"DR\"", "\"MISS\"", "\"MR\"", "\"MRS\"", "\"MS\"" ]
dateOfBirth
string (date)
Traveler date of birth in YYYY-MM-DD format.
Example1996-10-21
loyalty
object
Details about loyalty programs for the applicant.
memberId
string
The member's loyalty program ID.
ExampleBA7854365
name
string
The name of the loyalty program.
ExampleMarriott Bonvoy, AAdvantage, Rapid Rewards, SkyMiles
type
string
The currency used by the loyalty program.
ExampleMiles, Points, KrisFlyer Miles, Avios
tierLevel
string
The tier level of the member.
ExampleSilver, Gold, Titanium, President’s Circle
tierExpiration
string (date)
The expiration of the member's tier level - last day of validity, if any.
Example2024-10-12
memberFirstName
string
The first name of the member. This is used if the loyalty member is different from the customer (E.g., providing someone else’s loyalty account).
ExampleLaura Mary
memberLastName
string
The last name of the member.
ExampleSmith
memberDateOfBirth
string (date)
The date of birth of the member.
Example2024-10-12
cobrandCardholder
string
The name of the card held by the member.
ExampleBritish Airways Visa Signature, Hilton Honors American Express, Marriott Bonvoy Boundless
loyaltyRewards
string
Amount of Points/Miles remaining in the member’s loyalty account after the transaction. The member may not be one of the travelers.
Example10
pointsEarned
string
Amount of Points/Miles accrued with the current transaction, if any.
Example1002
dateLastActive
string (date)
Date of the member’s most recent loyalty activity.
Example2024-10-12
numOfTravelersInclMinors
integer | null
Total number of travelers including minors
id
string | null
Do not send or set to null in request.
Example
errorCodes
Array of string (OrderErrorCodes) | null
List of error codes when attempting to generate an offer. Do not send in request.
string
Possible error codes when attempting to generate offers for an order.
Valid values[ "\"INVALID_AIR_RESERVATION\"", "\"INVALID_BILLING_CONTACT\"", "\"INVALID_COUNTRY\"", "\"INVALID_CURRENCY\"", "\"INVALID_LOCALE\"", "\"MAX_BOOKING_WINDOW\"", "\"MAX_PRICE\"", "\"MIN_BOOKING_WINDOW\"", "\"MIN_PRICE\"", "\"MISSING_PRODUCT\"", "\"MISSING_TRAVEL_RESERVATION\"", "\"NO_OFFERS\"" ]
payment
object (Payment)
Payment details.
card
object (Card)
Card details for merchant payout
id
string | null
Do not send or set to null in request.
ccv
string
Example123
expirationMonth
integer
Example12
nameOnCard
string
ExampleArthur Davis
expirationYear
integer
Example2027
number
string
Example5431111111111111
contact
object
postalCode
string
Example99999
email
string
Examplearthur@flexpay.com
firstName
string
ExampleArthur
phone
string
Example5555551749
city
string
ExampleMayfield
region
string
ExampleKY
lastName
string
ExampleDavis
streetAddress
string
Example1013 Weda Cir
country
string
ExampleUS
type
string
Valid values[ "\"VISA\"", "\"MASTERCARD\"", "\"UATP\"" ]
token
string
additionalTokens
object
instrumentToken
string
maskedCc
string
aliasCvv
string
uppCvvExpirationDate
string (date)
Example2026-10-12
bin
string
errorCode
string
Error code for unsuccessful but valid payment requests.
Valid values[ "\"LOAN_NOT_ACCEPTED\"" ]
status
string | null
Order status code.
Valid values[ "\"ERROR\"", "\"LOAN_ACCEPTED\"", "\"OFFER_SELECTED\"", "\"OFFERS_GENERATED\"", "\"ORDER_CREATED\"", "\"SESSION_EXPIRED\"" ]
redirectUrl
string | null
The redirect url for the application
400
Bad Request
object
codeName
string
ExampleINVALID_REQUEST_ERROR
message
string
Examplefield required
statusCode
integer
Example400
param
string
Examplebody.integrationId
401
Unauthorized
object
codeName
string
ExampleINVALID_REQUEST_ERROR
message
string
ExampleUnauthorized
statusCode
integer
Example401
403
Access Denied
object
codeName
string
ExampleINVALID_REQUEST_ERROR
message
string
ExampleAccess Denied
statusCode
integer
Example403
405
Method Not Allowed
object
codeName
string
ExampleINVALID_REQUEST_ERROR
message
string
ExampleMethod Not Allowed
statusCode
integer
Example405
408
Request Timeout
object
codeName
string
ExampleAPI_TIMEOUT
message
string
ExampleRequest Timeout
statusCode
integer
Example408
500
Internal Server Error
object
codeName
string
ExampleAPI_ERROR
message
string
ExampleInternal Server Error
statusCode
integer
Example500
Was this article helpful?