Generates marketing offers for orders.
- 23 May 2024
- 19 Minutes to read
- DarkLight
Generates marketing offers for orders.
- Updated on 23 May 2024
- 19 Minutes to read
- DarkLight
Article summary
Did you find this summary helpful?
Thank you for your feedback
Post
/v1/orders/bulk
Security
HTTP
Type bearer
Query parameters
dryRun
booleanRequired
Whether to perform a dry run. Set to true.
Body parameters
object
List of orders.
integrationId
string Required
Unique integration identifier.
ExampleUP-12345678-9
orders
Array of object (Order) Required
List of orders.
object
Order details.
id
string | null
Do not send or set to null in request.
Example
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 in 2-letter ISO 3166-2 country format.
ExampleUS
dateOfBirth
string
Billing contact date of birth in YYYY-MM-DD format.
Pattern/([0-9]{4})-(?:[0-9]{2})-([0-9]{2})/
Example1996-10-21
email
string
Billing contact email.
firstName
string
Billing contact first name.
lastName
string
Billing contact last name.
middleName
string
Billing contact middle name.
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.
title
string
Billing contact title.
Valid values[ "\"DR\"", "\"MISS\"", "\"MR\"", "\"MRS\"", "\"MS\"" ]
channel
string
Request channel.
Valid values[ "\"APP\"", "\"MOBILE_WEB\"", "\"WEB\"", "\"EMAIL\"" ]
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\"" ]
externalId
string
Optional unique order identifier
localization
object (Localization)Required
Order localization details.
country
string Required
2-letter ISO 3166-2 country code.
ExampleUS
currency
string Required
3-letter ISO 4217 currency code.
ExampleUSD
locale
string Required
BCP 47 locale.
Exampleen-US
offers
Array of object (Offer) | null
List of offers for the order. Do not send in request.
object
Offer details.
apr
string Required
Offer APR (0.1532 = 15.32%).
Example0.1532
marketingContent
Array of object (MarketingItem) Required
List of offer marketing content.
object
locale
string Required
Item locale.
Exampleen-US
header
string
Infomodal and tooltip header.
ExampleJust select Pay Monthly at checkout to pay over time, from $x.xx/mo*
subheader
string
Infomodal and tooltip subheader.
ExampleBuy now. Pay over time. Feel good about how you pay.
configuredSubheader
string
Optional configured infomodal and tooltip subheader.
steps
Array of object (Step)
List of infomodal steps.
object
index
string
Step index.
Example0
body
string
Step copy.
ExampleAdd your itinerary to cart
icon
string
Step icon code.
Exampleshopping_cart
disclaimer
string
Infomodal and tooltip disclaimer.
faqs
object (Faqs)
FAQs.
header
string
FAQ header.
ExampleFrequently Asked Questions
open
string
FAQ open button text.
ExampleFAQ
back
string
FAQ back button text.
ExampleBack
items
Array of object (FaqItem)
List of FAQ items.
object
FAQ item.
type
string
FAQ type.
Valid values[ "\"GENERAL\"", "\"PAYMENTS\"" ]
title
string
FAQ title.
ExampleGeneral
questions
Array of object (FaqQuestion)
List of FAQ questions and answers.
object
FAQ question and answer.
index
string
Question index
Example0
title
string
FAQ question
ExampleIs this an installment loan?
body
string
FAQ answer
ExampleYes, all loans through Uplift are installment loans, which means you repay the loan over time with a set number of scheduled payments. Some plans include interest while some are interest-free. Your payments are the same amount over the life of the loan and you can pay off your loan at any time without paying a penalty or fee.
downPayment
string Required
Down payment in dollar format.
Example105.68
financeCharges
string Required
Finance charges in dollar format.
Example56.81
grandTotal
string Required
Total cost of the transaction in dollar format.
Example1056.80
maxApr
string Required
Maximum APR possible for the corresponding order (0.36 = 36%).
Example0.36
minApr
string Required
Minimum APR possible for the corresponding order (0.07 = 7%).
Example0.07
minFilterAmount
string Required
Minimum order amount required for an offer in dollar format.
Example49.00
monthlyPayment
string Required
Monthly payment amount in dollar format.
Example105.68
numberOfPayments
string Required
Number of payments in months.
Example9
originationFee
string Required
Origination fee in dollar format.
Example0
price
string Required
Order price in dollar format.
Example999.99
principal
string Required
Price of the order less the down payment in dollar format.
Example894.31
promos
Array of string Required
Potential offer promotions.
string
Valid values[ "\"ZERO_PERCENT_GUARANTEED\"", "\"ZERO_PERCENT_AT_LEAST_ONE\"", "\"ZERO_PERCENT_VARIABLE\"", "\"ZERO_DOWN_GUARANTEED\"", "\"ZERO_DOWN_VARIABLE\"", "\"THREE_MONTH_DELAYED\"", "\"SIX_MONTH_DELAYED\"" ]
totalPayments
string Required
Grand total less the down payment in dollar format.
Example951.12
orderCategory
string Required
Order category.
Valid values[ "\"TOTAL\"", "\"INSURANCE\"", "\"ACTIVITY_OPTION\"", "\"ADDON_OPTION\"", "\"BAG_OPTION\"", "\"CAR_OPTION\"", "\"CRUISE_OPTION\"", "\"DECK_OPTION\"", "\"DEPARTURE_OPTION\"", "\"HOTEL_OPTION\"", "\"MEAL_OPTION\"", "\"RETURN_OPTION\"", "\"ROOM_OPTION\"", "\"SEAT_OPTION\"", "\"STATEROOM_OPTION\"" ]
orderItems
Array of object (OrderItem) Required
A list of order reservations. Only one reservation is allowed per item.
object
Only one item type is allowed per item.
Example{ "air": { "airlineName": "SY", "insurance": [], "tripType": "ROUNDTRIP", "itinerary": [ { "departureDate": "2025-02-28", "arrivalApc": "YVR", "departureApc": "SFO", "arrivalDate": "2025-02-28", "carrierCode": "SY", "fareClass": "Economy" } ] } }
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).
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
Arrival date in YYYY-MM-DD format.
Pattern/([0-9]{4})-(?:[0-9]{2})-([0-9]{2})/
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 Required
Departure date in YYYY-MM-DD format.
Pattern/([0-9]{4})-(?:[0-9]{2})-([0-9]{2})/
Example2024-10-12
ticketType
string
Ticket type.
Valid values[ "\"DIGITAL\"", "\"PHONE\"", "\"PICK_UP\"", "\"POST\"" ]
travelerRefs
Array of object (PersonReference)
List of traveler references.
object
Traveler index.
id
string | null
Do not send or set to null in request.
Example
index
string
Zero-based traveler index.
Example0
fareClass
string
Fare class type.
Examplefirst class
supplier
string
Supplier name (recommended for third-party providers). Use the full airline name.
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\"" ]
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
Disembark date in YYYY-MM-DD format.
Pattern/([0-9]{4})-(?:[0-9]{2})-([0-9]{2})/
Example2024-10-12
embarkDate
string Required
Embark date in YYYY-MM-DD format.
Pattern/([0-9]{4})-(?:[0-9]{2})-([0-9]{2})/
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
Activity date in YYYY-MM-DD format.
Pattern/([0-9]{4})-(?:[0-9]{2})-([0-9]{2})/
Example2024-10-12
name
string
Activity name.
price
string
Activity price in dollar format.
Example100.13
arrivalDate
string
Scheduled arrival date in YYYY-MM-DD format.
Pattern/([0-9]{4})-(?:[0-9]{2})-([0-9]{2})/
Example2024-10-12
arrivalPort
string
Arrival port name.
ExampleAlaska
departureDate
string Required
Departure date in YYYY-MM-DD format.
Pattern/([0-9]{4})-(?:[0-9]{2})-([0-9]{2})/
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
travelerRefs
Array of object (PersonReference)
List of traveler references.
object
Traveler index.
id
string | null
Do not send or set to null in request.
Example
index
string
Zero-based traveler index.
Example0
voyageId
string
Specific voyage identifier.
eventTicket
object (EventTicket)
Event ticket.
id
string | null
Do not send or set to null in request.
Example
endDate
string
Event end date in YYYY-MM-DD format.
Pattern/([0-9]{4})-(?:[0-9]{2})-([0-9]{2})/
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
travelerRefs
Array of object (PersonReference)
List of event attendee references.
object
Traveler index.
id
string | null
Do not send or set to null in request.
Example
index
string
Zero-based traveler index.
Example0
referenceId
string
Event ticket reference identifier.
startDate
string Required
Event start date in YYYY-MM-DD format.
Pattern/([0-9]{4})-(?:[0-9]{2})-([0-9]{2})/
Example2024-10-12
type
string
Event type.
unitPrice
string
Price per ticket in dollar format.
Example100.13
venueName
string
Event venue name.
orderLine
object (OrderLine)
Product line.
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.
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 Required
Check-in date in YYYY-MM-DD format.
Pattern/([0-9]{4})-(?:[0-9]{2})-([0-9]{2})/
Example2024-10-12
checkOutDate
string
Check-out date in YYYY-MM-DD format.
Pattern/([0-9]{4})-(?:[0-9]{2})-([0-9]{2})/
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\"" ]
travelerRefs
Array of object (PersonReference)
List of traveler references.
object
Traveler index.
id
string | null
Do not send or set to null in request.
Example
index
string
Zero-based traveler index.
Example0
subscription
object (Subscription)
Subscription.
id
string | null
Do not send or set to null in request.
Example
activeDate
string Required
Subscription active date in YYYY-MM-DD format.
Pattern/([0-9]{4})-(?:[0-9]{2})-([0-9]{2})/
Example2024-10-12
expireDate
string
Subscription expiration date in YYYY-MM-DD format.
Pattern/([0-9]{4})-(?:[0-9]{2})-([0-9]{2})/
Example2024-10-12
name
string
Subscription name.
travelerRefs
Array of object (PersonReference)
List of subscription recipients.
object
Traveler index.
id
string | null
Do not send or set to null in request.
Example
index
string
Zero-based traveler index.
Example0
renew
boolean
Whether the subscription is automatic renewal.
renewDate
string
Subscription renew date in YYYY-MM-DD format.
Pattern/([0-9]{4})-(?:[0-9]{2})-([0-9]{2})/
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.
rental
object (Rental)
Rental.
id
string | null
Do not send or set to null in request.
Example
agency
string
Rental agency name.
endDate
string
Rental end date in YYYY-MM-DD format.
Pattern/([0-9]{4})-(?:[0-9]{2})-([0-9]{2})/
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
travelerRefs
Array of object (PersonReference)
List of renter references.
object
Traveler index.
id
string | null
Do not send or set to null in request.
Example
index
string
Zero-based traveler index.
Example0
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 Required
Rental start date in YYYY-MM-DD format.
Pattern/([0-9]{4})-(?:[0-9]{2})-([0-9]{2})/
Example2024-10-12
type
string
Rental type or item.
unitPrice
string
Rental price per unit in dollar format.
Example100.13
path
string
Location of the targeted display.
ExampleMain booking path
points
Array of object (Points)
Points details (e.g. loyalty).
object
Points.
pointsType
string
Points type or category.
pointsName
string
Points name.
pointsUsed
string
Number of points used.
Example100
pointsRemaining
string
Number of points remaining.
Example10
originalOrderAmount
string
Original order amount in dollar format.
Example100.13
price
string Required
Total order amount in dollar format.
Example1000.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
Traveler date of birth in YYYY-MM-DD format.
Pattern/([0-9]{4})-(?:[0-9]{2})-([0-9]{2})/
Example1996-10-21
Responses
200
Successful
object
List of orders.
integrationId
string
Unique integration identifier.
ExampleUP-12345678-9
orders
Array of object (Order)
List of orders.
object
Order details.
id
string | null
Do not send or set to null in request.
Example
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 in 2-letter ISO 3166-2 country format.
ExampleUS
dateOfBirth
string
Billing contact date of birth in YYYY-MM-DD format.
Pattern/([0-9]{4})-(?:[0-9]{2})-([0-9]{2})/
Example1996-10-21
email
string
Billing contact email.
firstName
string
Billing contact first name.
lastName
string
Billing contact last name.
middleName
string
Billing contact middle name.
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.
title
string
Billing contact title.
Valid values[ "\"DR\"", "\"MISS\"", "\"MR\"", "\"MRS\"", "\"MS\"" ]
channel
string
Request channel.
Valid values[ "\"APP\"", "\"MOBILE_WEB\"", "\"WEB\"", "\"EMAIL\"" ]
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\"" ]
externalId
string
Optional unique order identifier
localization
object (Localization)
Order localization details.
country
string
2-letter ISO 3166-2 country code.
ExampleUS
currency
string
3-letter ISO 4217 currency code.
ExampleUSD
locale
string
BCP 47 locale.
Exampleen-US
offers
Array of object (Offer) | null
List of offers for the order. Do not send in request.
object
Offer details.
apr
string
Offer APR (0.1532 = 15.32%).
Example0.1532
marketingContent
Array of object (MarketingItem)
List of offer marketing content.
object
locale
string
Item locale.
Exampleen-US
header
string
Infomodal and tooltip header.
ExampleJust select Pay Monthly at checkout to pay over time, from $x.xx/mo*
subheader
string
Infomodal and tooltip subheader.
ExampleBuy now. Pay over time. Feel good about how you pay.
configuredSubheader
string
Optional configured infomodal and tooltip subheader.
steps
Array of object (Step)
List of infomodal steps.
object
index
string
Step index.
Example0
body
string
Step copy.
ExampleAdd your itinerary to cart
icon
string
Step icon code.
Exampleshopping_cart
disclaimer
string
Infomodal and tooltip disclaimer.
faqs
object (Faqs)
FAQs.
header
string
FAQ header.
ExampleFrequently Asked Questions
open
string
FAQ open button text.
ExampleFAQ
back
string
FAQ back button text.
ExampleBack
items
Array of object (FaqItem)
List of FAQ items.
object
FAQ item.
type
string
FAQ type.
Valid values[ "\"GENERAL\"", "\"PAYMENTS\"" ]
title
string
FAQ title.
ExampleGeneral
questions
Array of object (FaqQuestion)
List of FAQ questions and answers.
object
FAQ question and answer.
index
string
Question index
Example0
title
string
FAQ question
ExampleIs this an installment loan?
body
string
FAQ answer
ExampleYes, all loans through Uplift are installment loans, which means you repay the loan over time with a set number of scheduled payments. Some plans include interest while some are interest-free. Your payments are the same amount over the life of the loan and you can pay off your loan at any time without paying a penalty or fee.
downPayment
string
Down payment in dollar format.
Example105.68
financeCharges
string
Finance charges in dollar format.
Example56.81
grandTotal
string
Total cost of the transaction in dollar format.
Example1056.80
maxApr
string
Maximum APR possible for the corresponding order (0.36 = 36%).
Example0.36
minApr
string
Minimum APR possible for the corresponding order (0.07 = 7%).
Example0.07
minFilterAmount
string
Minimum order amount required for an offer in dollar format.
Example49.00
monthlyPayment
string
Monthly payment amount in dollar format.
Example105.68
numberOfPayments
string
Number of payments in months.
Example9
originationFee
string
Origination fee in dollar format.
Example0
price
string
Order price in dollar format.
Example999.99
principal
string
Price of the order less the down payment in dollar format.
Example894.31
promos
Array of string
Potential offer promotions.
string
Valid values[ "\"ZERO_PERCENT_GUARANTEED\"", "\"ZERO_PERCENT_AT_LEAST_ONE\"", "\"ZERO_PERCENT_VARIABLE\"", "\"ZERO_DOWN_GUARANTEED\"", "\"ZERO_DOWN_VARIABLE\"", "\"THREE_MONTH_DELAYED\"", "\"SIX_MONTH_DELAYED\"" ]
totalPayments
string
Grand total less the down payment in dollar format.
Example951.12
orderCategory
string
Order category.
Valid values[ "\"TOTAL\"", "\"INSURANCE\"", "\"ACTIVITY_OPTION\"", "\"ADDON_OPTION\"", "\"BAG_OPTION\"", "\"CAR_OPTION\"", "\"CRUISE_OPTION\"", "\"DECK_OPTION\"", "\"DEPARTURE_OPTION\"", "\"HOTEL_OPTION\"", "\"MEAL_OPTION\"", "\"RETURN_OPTION\"", "\"ROOM_OPTION\"", "\"SEAT_OPTION\"", "\"STATEROOM_OPTION\"" ]
orderItems
Array of object (OrderItem)
A list of order reservations. Only one reservation is allowed per item.
object
Only one item type is allowed per item.
Example{ "air": { "airlineName": "SY", "insurance": [], "tripType": "ROUNDTRIP", "itinerary": [ { "departureDate": "2025-02-28", "arrivalApc": "YVR", "departureApc": "SFO", "arrivalDate": "2025-02-28", "carrierCode": "SY", "fareClass": "Economy" } ] } }
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).
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
Arrival date in YYYY-MM-DD format.
Pattern/([0-9]{4})-(?:[0-9]{2})-([0-9]{2})/
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
Departure date in YYYY-MM-DD format.
Pattern/([0-9]{4})-(?:[0-9]{2})-([0-9]{2})/
Example2024-10-12
ticketType
string
Ticket type.
Valid values[ "\"DIGITAL\"", "\"PHONE\"", "\"PICK_UP\"", "\"POST\"" ]
travelerRefs
Array of object (PersonReference)
List of traveler references.
object
Traveler index.
id
string | null
Do not send or set to null in request.
Example
index
string
Zero-based traveler index.
Example0
fareClass
string
Fare class type.
Examplefirst class
supplier
string
Supplier name (recommended for third-party providers). Use the full airline name.
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\"" ]
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
Disembark date in YYYY-MM-DD format.
Pattern/([0-9]{4})-(?:[0-9]{2})-([0-9]{2})/
Example2024-10-12
embarkDate
string
Embark date in YYYY-MM-DD format.
Pattern/([0-9]{4})-(?:[0-9]{2})-([0-9]{2})/
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
Activity date in YYYY-MM-DD format.
Pattern/([0-9]{4})-(?:[0-9]{2})-([0-9]{2})/
Example2024-10-12
name
string
Activity name.
price
string
Activity price in dollar format.
Example100.13
arrivalDate
string
Scheduled arrival date in YYYY-MM-DD format.
Pattern/([0-9]{4})-(?:[0-9]{2})-([0-9]{2})/
Example2024-10-12
arrivalPort
string
Arrival port name.
ExampleAlaska
departureDate
string
Departure date in YYYY-MM-DD format.
Pattern/([0-9]{4})-(?:[0-9]{2})-([0-9]{2})/
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
travelerRefs
Array of object (PersonReference)
List of traveler references.
object
Traveler index.
id
string | null
Do not send or set to null in request.
Example
index
string
Zero-based traveler index.
Example0
voyageId
string
Specific voyage identifier.
eventTicket
object (EventTicket)
Event ticket.
id
string | null
Do not send or set to null in request.
Example
endDate
string
Event end date in YYYY-MM-DD format.
Pattern/([0-9]{4})-(?:[0-9]{2})-([0-9]{2})/
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
travelerRefs
Array of object (PersonReference)
List of event attendee references.
object
Traveler index.
id
string | null
Do not send or set to null in request.
Example
index
string
Zero-based traveler index.
Example0
referenceId
string
Event ticket reference identifier.
startDate
string
Event start date in YYYY-MM-DD format.
Pattern/([0-9]{4})-(?:[0-9]{2})-([0-9]{2})/
Example2024-10-12
type
string
Event type.
unitPrice
string
Price per ticket in dollar format.
Example100.13
venueName
string
Event venue name.
orderLine
object (OrderLine)
Product line.
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.
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
Check-in date in YYYY-MM-DD format.
Pattern/([0-9]{4})-(?:[0-9]{2})-([0-9]{2})/
Example2024-10-12
checkOutDate
string
Check-out date in YYYY-MM-DD format.
Pattern/([0-9]{4})-(?:[0-9]{2})-([0-9]{2})/
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\"" ]
travelerRefs
Array of object (PersonReference)
List of traveler references.
object
Traveler index.
id
string | null
Do not send or set to null in request.
Example
index
string
Zero-based traveler index.
Example0
subscription
object (Subscription)
Subscription.
id
string | null
Do not send or set to null in request.
Example
activeDate
string
Subscription active date in YYYY-MM-DD format.
Pattern/([0-9]{4})-(?:[0-9]{2})-([0-9]{2})/
Example2024-10-12
expireDate
string
Subscription expiration date in YYYY-MM-DD format.
Pattern/([0-9]{4})-(?:[0-9]{2})-([0-9]{2})/
Example2024-10-12
name
string
Subscription name.
travelerRefs
Array of object (PersonReference)
List of subscription recipients.
object
Traveler index.
id
string | null
Do not send or set to null in request.
Example
index
string
Zero-based traveler index.
Example0
renew
boolean
Whether the subscription is automatic renewal.
renewDate
string
Subscription renew date in YYYY-MM-DD format.
Pattern/([0-9]{4})-(?:[0-9]{2})-([0-9]{2})/
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.
rental
object (Rental)
Rental.
id
string | null
Do not send or set to null in request.
Example
agency
string
Rental agency name.
endDate
string
Rental end date in YYYY-MM-DD format.
Pattern/([0-9]{4})-(?:[0-9]{2})-([0-9]{2})/
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
travelerRefs
Array of object (PersonReference)
List of renter references.
object
Traveler index.
id
string | null
Do not send or set to null in request.
Example
index
string
Zero-based traveler index.
Example0
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
Rental start date in YYYY-MM-DD format.
Pattern/([0-9]{4})-(?:[0-9]{2})-([0-9]{2})/
Example2024-10-12
type
string
Rental type or item.
unitPrice
string
Rental price per unit in dollar format.
Example100.13
path
string
Location of the targeted display.
ExampleMain booking path
points
Array of object (Points)
Points details (e.g. loyalty).
object
Points.
pointsType
string
Points type or category.
pointsName
string
Points name.
pointsUsed
string
Number of points used.
Example100
pointsRemaining
string
Number of points remaining.
Example10
originalOrderAmount
string
Original order amount in dollar format.
Example100.13
price
string
Total order amount in dollar format.
Example1000.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
Traveler date of birth in YYYY-MM-DD format.
Pattern/([0-9]{4})-(?:[0-9]{2})-([0-9]{2})/
Example1996-10-21
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?
