TRtravelify
BookingFlow

Adds a generic/custom item to basket for payment

Changed on
post/addgenericitem

Request

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

Query parameters

searchIdinteger

Optional numeric search Id - only provide if adding the item to an existing search.

searchKeystring

Optional 36-character search security key - only provide if adding the item to an existing search.

Request body

referencestring required

Reference

datastring nullable

Optional encrypted data for validation check

isGiftVoucherboolean nullable

Is gift voucher (default false)

quantityinteger

Quantity (default 1)

orderRefstring nullable

Order reference to link payment to an existing order (ADVANCED USE ONLY - DO NOT USE WITHOUT PERMISSION FROM TRAVELGENIX)

titlestring nullable

Title

descriptionstring nullable

Description

subTitlestring nullable

Sub-Title (optional)

subDescriptionstring nullable

Sub-Description (optional)

imageUrlstring nullable

Image URL

pricenumber double

Price

depositnumber double nullable

Optional deposit

currencystring nullable

Currency code

attributesobject nullable

Optional attributes

giftMessagestring nullable

Optional message (eg. gift message)

giftSendAtstring date-time nullable

Optional gift voucher send date

Example request

{
  "contactInfo": {
    "internalRef": "CUST-123",
    "emailAddress": "joe.bloggs@email.com",
    "telephone": {
      "countryPrefix": "44",
      "number": "0123456789"
    },
    "firstname": "Joe",
    "surname": "Bloggs",
    "company": "ACME Travel",
    "address1": "123 Any Road",
    "city": "Bournemouth",
    "state": "Dorset",
    "postalCode": "BH1 1AB",
    "countryCode": "GB"
  },
  "recipient": {
    "internalRef": "CUST-123",
    "emailAddress": "joe.bloggs@email.com",
    "telephone": {
      "countryPrefix": "44",
      "number": "0123456789"
    },
    "firstname": "Joe",
    "surname": "Bloggs",
    "company": "ACME Travel",
    "address1": "123 Any Road",
    "city": "Bournemouth",
    "state": "Dorset",
    "postalCode": "BH1 1AB",
    "countryCode": "GB"
  },
  "passengers": [
    {
      "firstname": "Joe",
      "middleNames": "B",
      "surname": "Bloggs",
      "dateOfBirth": "1970-01-25",
      "nationality": "GB",
      "foidNumber": "ABC123456",
      "foidStartDate": "2015-01-10",
      "foidExpiryDate": "2025-01-10",
      "foidIssuingCountry": "GB",
      "telephone": {
        "countryPrefix": "44",
        "number": "0123456789"
      }
    }
  ]
}

Response

OK

Changes