Skip to main content
PUT
Update a Product

Path Parameters

productId
integer
required
supplierapi
string
required
Pattern: supplier|apiv1/supplier

Body

application/json

The message to send

productName
string

Name of the Product.

mediaId
integer

ID of the Media Image use as Product thumbnail.

country
string

2-character Country code.

timezone
string

String representing products timezone.

productClassId
integer

ID of Product Class.

rating
number<float>

A rating in the range of 1-5 and accepting of half values.

teaser
string

Brief product description (up to 300 characters).

description
string

Longer product description.

itineraryDetails
string[]

Array of itinerary details in objects.

departuresPickups
string

Information about departures or pickups.

extras
string

Information about extras which are not included in product price.

voucherInstructions
string

Information for customer, including phone numbers and confirmation instructions etc.

voucherInformationContactDetailsBits
integer

Combined bitwise value of address contact details to be printed on voucher.

agentInstructions
string

Additional information for the agent.

noRefunds
boolean

Disables refunds for the product.

noRefundsMessage
string

Message explaining why refunds are not available.

cancellationFeePolicyId
integer

ID of product's cancellation fee policy.

contactPhone
string

Contact phone number.

contactEmail
string

Contact email address.

addressLineOne
string

First line of Product Address.

addressLineTwo
string

Second line of Product Address.

addressSuburb
string

Suburb of Product Address.

addressCity
string

City of Product Address.

addressState
string

State of Product Address.

addressPostcode
string

Postcode of Product Address.

startLocation
integer

Category ID of Product start location.

secondaryLocation
integer

Category ID of Product's secondary location.

endLocation
integer

Category ID of end location.

activityTypes
integer[]

Array of Category ID's (Integers) of activity type.

accommodationTypes
integer[]

Array of Category ID's (Integers) of accommodation types.

transportTypes
integer[]

Array of Category ID's (Integers) of transport types.

minAgeRecommendation
integer

Minimum recommended age.

maxAgeRecommendation
integer

Maximum recommended age.

ageRestriction
string

Description of any age restrictions.

fitnessRequirements
string

Description of fitness requirements.

minGroupSize
integer

Minimum group size.

maxGroupSize
integer

Maximum group size.

dietaryRequirements
string

Description of dietary requirements.

luggageRequirements
string

Description of luggage requirements.

includedItems
string[]

Array of items included in the fare.

bringItems
string[]

Array of items that guest is expected to bring.

voucherTerms
string

Description of terms and conditions.

weekDays
string[]

Array of days of week that trip departs.

departureDates
string

Comma-separated tour departure dates

recurrenceDate
string

Frequency of departure recurrence (e.g. 'Weekly' or 'Monthly').

specialCircumstanceDate
string

Description of special dates which affect departure info (e.g. Christmas Day).

operatingPartner
string

Operating partner.

tourCode
string

Tour code.

mandatoryFieldCheckout
string[]

Array of customer fields absolutely necessary to make the booking. Customer field names: title, phone, emailAddress, dateOfBirth, redeemerCountry, postcode.

Response

Returned when successful.