TRtravelify
Account

Retrieves an account order details

Changed on
post/account/order

Request

  • Base URL
    https://api.travelify.io
  • URL
    https://api.travelify.io/account/order
  • Auth
    none declared

Request body

emailAddressstring required

Booking email address

departDatestring date-time required

Departure date of travel

orderRefstring required

Order reference

Example request

{
  "emailAddress": "joe.bloggs@email.com",
  "departDate": "2022-12-30",
  "orderRef": "1234"
}

Response

OK

idinteger

Order identifier

keystring nullable

Order key

status1 | 2 | 3 | 4 | 5 | 6 | 7 | 8

Enumerator defining order status:<br>1=Basket, 2=Processing, 3=Confirmed, 4=ConfirmedFailure, 5=Cancelled, 6=CancelledPartial, 7=OnHold, 8=ConfirmedPayLater

orderRefstring nullable

Order reference to display to customer

userIDstring nullable

IGNORE: Used for external data sources

searchIdinteger nullable

Primary search identifier used to create order

agentIdinteger nullable

Agent identifier

customerIdinteger nullable

Customer identifier

backofficeUrlstring nullable

Backoffice order view url

customerTitle0 | 1 | 2 | 3 | 4 | 5 | 6

Enumerator defining traveller name titles:<br>0=Unspecified, 1=Mr, 2=Miss, 3=Mrs, 4=Ms, 5=Master, 6=Dr

customerFirstnamestring nullable

Customer first name

customerSurnamestring nullable

Customer surname

customerEmailstring nullable

Customer email address

customerAddress1string nullable

Customer billing address 1

customerAddress2string nullable

Customer billing address 2

customerCitystring nullable

Customer billing city

customerStatestring nullable

Customer billing state/county

customerPostalCodestring nullable

Customer billing postal code

customerCountryCodestring nullable

Customer billing country code

customerTelType1 | 2 | 3 | 4

Enumerator defining phone types:<br>1=Generic, 2=Mobile, 3=Home, 4=Office

customerTelPrefixstring nullable

Customer telephone prefix

customerTelNumstring nullable

Customer telephone number

customerAcceptsMarketingboolean nullable

Customer accepts marketing

specialRequestsstring nullable

Optional special requests

languagestring nullable

Order language

currencystring nullable

Order currency code

ipAddressstring nullable

Customer IP address

createdstring date-time

Order creation date time

voucherIdinteger nullable

Voucher id

voucherCodestring nullable

Voucher code

voucherNamestring nullable

Voucher name

voucherValuenumber double nullable

Voucher value

voucherIsPercentboolean nullable

Voucher is a percentage discount

voucherIsGiftboolean nullable

Voucher is a gift voucher

summarystring nullable

Summary title of order used for front end display

locationImageUrlstring nullable

Location image url used for front end display

locationGuidestring nullable

Location guide used for front end display

departurestring date-time nullable

Departure date used for front end display

durationinteger nullable

Duration of travel used for front end display

dataobject nullable

Order data

sourcesobject nullable

Order tracking sources

upsellsActiveProductTypes[] nullable

List of upsell products active on application

Changes

  • 152b86af1f3fRevision changes
    • warning

      added the new 191.00 enum value to the // response property for the response status

    • warning

      added the new 191.00 enum value to the // response property for the response status

    • warning

      added the new 25.00 enum value to the // response property for the response status

  • 372210d46976Revision changes
    • warning

      added the new 189.00 enum value to the // response property for the response status

    • warning

      added the new 189.00 enum value to the // response property for the response status

    • warning

      added the new 190.00 enum value to the // response property for the response status

    • warning

      added the new 190.00 enum value to the // response property for the response status