The API accepts requests and returns responses in JSON format only. All incoming requests must have an "Accept: application/json" header. An error message with a 406 HTTP status code will be returned if this is omitted.
The Website Travel API uses OAuth2 authentication. To acquire a token, call POST /apiv1/supplier/token
, including
the client_id and client_secret in the body of the message.
This token should then be appended to every URI as the access_token
parameter.
Products are represented in the products database with two different entities - Products and ProductsDetails. Each Product has a unique identifier (the productId), and may have several ProductsDetails in different states. For example, a Product might have a Live ProductsDetail which agents can view and purchase, a Draft ProductsDetail reflecting changes that the supplier has just made to it, and a History ProductsDetail showing the previous version of the product.
All edits to Products are made to the Draft ProductsDetail, which will then go through an approval process before it becomes Live. Similarly, if you want to delete a Product from the system, this must go through the approval process.
The API provides support for:
POST /apiv1/supplier/product
.PUT /apiv1/supplier/product/{productId}
. These edits will be made to the
Draft ProductsDetail, which will be created automatically if necessary.POST /product/{productId}/abandonchanges
POST /apiv1/supplier/product/{productId}/submit
.DELETE /apiv1/supplier/product/{productId}
. In some cases, the delete will
not happen immediately. Instead, a separate Delete Pending ProductsDetail will be created, and once the request has been
approved by Website Travel staff, the Product and all its ProductsDetails will be deleted.The different product detail statuses are:
Status Name | Status Code | Status Description |
---|---|---|
Live | L | The ProductsDetail is visible to agents and can be purchased |
History | H | The ProductsDetail shows a previous version of the product |
Draft | D | The ProductsDetail can be edited by supplier |
Candidate | C | The ProductsDetail has been submitted for approval, but has not yet been approved |
Approved | A | The ProductsDetail has been approved by Website Travel staff, and will become live on the next day |
Delete Pending | X | The supplier has requested that the Product be deleted, but this has not yet been approved |
Delete Approved | Y | The request to delete the Product has been approved by Website Travel staff, and it will be deleted on the next day |
Basic steps for publishing a product by using the Supplier API.
A token can be retrieved by posting a client_id and client_secret, this token must be included on all subsequent requests.
POST /apiv1/supplier/token { "client_id": "MY_CLIENT_ID", "client_secret": "MY_PASSWORD_OR_HASH" }
It is required to include the authorisation token on each request, this can be done on the request header or as parameters on the URL (even when working with non GET requests).
Header method example:Accept: application/json, text/javascript, */*; q=0.01 Authorization: Bearer MY_RETRIEVED_TOKENURL method example
GET /apiv1/supplier/products?access_token=MY_RETRIEVED_TOKEN
Create a draft product by doing a POST containing all the required fields.
Please note: You can create a draft product with less information than is required by the submit process.
Product teaser, images and fares are examples of required information that is required when submitting a product but not when creating a draft.
POST /apiv1/supplier/product { "productName": "Taihape Gumboot Throwing", "country": "NZ", "productClassId": 525, "addressLineOne": "1234 State Highway 1", "addressPostcode": "123", "addressCity": "Taihape", "startLocation" : 19, "activityTypes" : [26], "mediaId": 1000001, "teaser" : "This is a test API test product", "description" : "and this is a small description for a test product", "voucherInformationContactDetailsBits" : 6 }
Add between 5 and 10 images to the draft product by doing a PUT containing an array of mediaIds.
PUT /apiv1/supplier/product/{productId}/images { "mediaIds": [1000001,1000002,1000003,1000004,1000005] }
Add a fare to the draft product by doing a POST.
Please note: Multiple fares are added by doing multiple requests.
POST /apiv1/supplier/product/{productId}/price { "fareName": "General", "currency": "NZD", "pax": 1, "duration": 1, "periodStart": "2015-10-01", "rrp": "110.00", "netRate": "100", "levy": "0" }
The final step of the process is to submit the product for approval, this is done by doing an empty POST to the provided route.
POST /apiv1/supplier/product/{productId}/submit
Products are created as drafts and must be submitted for approval. In the case where a product is already approved, updates can be auto approved provided some conditions are met.
1. The supplier is enabled for auto approval
2. No price margins were affected by the changes
If the above is satisfied, then updates to APPROVED OR LIVE status products/prices, will be sent to APPROVED immediately. Else, a DRAFT will be created and then submitted as CANDIDATE straight away.
Suppliers can upload images to the Website Travel database through the API. Each image is assigned a unique ID, and can be associated with multiple Products. Because images are very important to our agents, it is compulsory to provide images for each Product, and no Product will be approved to go live unless it has at least 5 images.
A Product Prices Detail (often referred to as a "price") is the actual item which is available for agents to purchase on the Website Travel platform. It is only necessary to provide a price for the supplier's home currency, and this will be automatically converted into the agent's currency using the latest exchange rate. Alternatively, if you want to provide a fixed rate for overseas agents, you can set additional prices in other currencies.
The "Package" product class can be used to create packages. Products with this product class may have one or more prices (just like other product classes). Each price must have multiple Package Options, each or which contains one or more Package Products. When purchasing the package, the customer will be able to choose one Package Product for each Package Option.
A package product may represent any fare in the Website Travel system which is sold in the package's currency. A Package Product also has a quantity (indicating how many of that fare will be added to the customer's order when they select the Package Product), and an RRP difference which can be used to apply an additional charge if the customer chooses that product rather than another product under the same option.
Each product can be tagged with a number of categories, which our agents use to search our database.
A product can only have one product class, and this affects some of the other options that are available for the product. The different product classes are:
Product Class Id | Product Class Name | Product Class Code | Product Description |
---|---|---|---|
525 | Activity | V | Activity only Product |
565 | Merchandise | M | Merchandise |
527 | Accommodation | A | Accommodation Product |
597 | Tour Product | C | Different Tour Products. |
531 | Transport | T | Transportation |
Some products can be tagged with categories which say what type of accommodation, activity or transport they provide. For example, there are categories for dorm and twin share accommodation, museum and kayaking activities, and coach and hire car transport.
Accommodation categories can be applied to A, C or U class products. Activity categories can be applied to V, U, S or C class products. Transport categories can be applied to U, S, C or T class products. Each product can be tagged with a maximum of three categories per category type.
Another type of category deals with the location of your product. Location categories are hierarchical, with four levels - countries, states, regions and localities. API methods are provided for you to navigate the hierarchy of location categories and find the localities that best describe your product's location.
You can set your product's location by setting its start and end location properties. These should both be localities, and the product will automatically inherit the locality's parent categories.
As well as collecting the start and end location category, we also ask you to provide a full street address for your product. This is used to geocode the product and allows users to search for products by latitude and longitude.
If you have any queries about this API, please contact api@websitetravel.com.
Fetch a list of agent fathers the authenticated supplier has access to.
Top Level Result Object
Field name | Nullable | Type | Description |
---|---|---|---|
agentFatherId | n | Integer | Agent Father identifer. |
agentFatherName | n | String | Agent Father name. |
Status Code | Description |
---|---|
200 |
|
403 |
|
500 |
|
Fetch a list of agents the authenticated supplier has access to.
Top Level Result Object
Field name | Nullable | Type | Description |
---|---|---|---|
agentId | n | Integer | Agent identifer. |
agentFatherId | n | Integer | Agent Father identifer. |
agentCode | n | String | Three-letter Agent identifier. |
name | n | String | Agent name. |
emailAccounts | y | String | Agent accounts email address. |
businessNumber | y | String | Agent business number. |
street1 | n | String | Street address of Agent. |
street2 | y | String | Secondary street address of Agent. |
suburb | n | String | Agent suburb. |
state | y | String | Agent state. |
postcode | y | String | Agent postcode. |
country | n | String | Agent Country. |
workPhone | n | String | Agent work phone number. |
currency | n | Object | Currency object. |
Currency Object
Field name | Nullable | Type | Description |
---|---|---|---|
isoCode | n | String | Agent's currency code (ISO-4217 three-character code). |
Status Code | Description |
---|---|
200 |
|
403 |
|
500 |
|
Grants an OAuth token to be used when querying the Website Travel API. This token should be provided as the
access_token
parameter to all other API calls.
Parameter | Type | Required? | Description |
---|---|---|---|
client_id | String | true | Client ID. |
client_secret | String | true | Client secret. |
Status Code | Description |
---|---|
200 |
|
400 |
|
Retrieves information about all of the supplier's cancellation fee policies. Output as for GET /cancellationpolicy/{cancellationFeePolicyId}.
Name | Type | Description |
---|---|---|
supplierapi |
Status Code | Description |
---|---|
200 |
|
403 |
|
500 |
|
Creates a new cancellation fee policy based on the JSON array of data provided.
Top Level Result Object
Field name | Nullable | Type | Description |
---|---|---|---|
cancellationFeePolicyId | n | Integer | ID of the new cancellation fee policy. |
Name | Type | Description |
---|---|---|
supplierapi |
Parameter | Type | Required? | Description |
---|---|---|---|
policyName | String | true | Name of the cancellation fee policy. |
policyDescription | String | false | Additional description information. |
usePercentMode | Boolean | true | Whether the policy is in percent mode (true) or dollar mode (false). |
isDefault | Boolean | false | Whether this policy should become the default cancellation fee policy for this supplier. |
cancellationFeeRules | Array | false | Array of CancellationFeeRule objects. |
cancellationFeeRule.daysBeforeTravelDate | Integer | true | Duration before travel date that this rule will be in effect. |
cancellationFeeRule.feeAmount | Float | true | Amount of cancellation fee when rule applies (a percentage value when policy is in percent mode, or a monetary amount when in dollar mode). |
Status Code | Description |
---|---|
201 |
|
400 |
|
403 |
|
500 |
|
Deletes the cancellation fee policy with the given and Cancellation Fee Policy ID.
Name | Type | Description |
---|---|---|
supplierapi | ||
cancellationFeePolicyId |
Status Code | Description |
---|---|
204 |
|
403 |
|
404 |
|
500 |
|
Retrieves information about the given cancellation fee policy.
Top Level Result Object
Field name | Nullable | Type | Description |
---|---|---|---|
cancellationFeePolicyId | n | Integer | ID of this cancellation fee policy. |
policyName | n | String | Name of the cancellation fee policy. |
policyDescription | y | String | Description of cancellation fee policy. |
usePercentMode | n | boolean | Whether the cancellation fee policy uses "percent mode" (true) or "dollar mode" (false). |
cancellationFeeRules | n | array | Collection of CancellationFeeRule objects. |
isDefault | n | boolean | Whether this is the default cancellation fee policy for this supplier. |
CancellationFeeRule Object
Field name | Nullable | Type | Description |
---|---|---|---|
daysBeforeTravelDate | n | Integer | Duration before voucher travel date that this rule will be in effect. For example, if there are two rules with daysBeforeTravelDate=2 and daysBeforeTravelDate=5, the first rule will be in effect if the voucher is cancelled within two days of travel, and the second rule will be in effect between three and five days before travel. |
feeAmount | n | Float | Amount of cancellation fee. This value is a percentage between 0 and 100 if the policy is in "percent mode", or a monetary amount in the applicable fare's currency if the policy is in "dollar mode". |
Name | Type | Description |
---|---|---|
supplierapi | ||
cancellationFeePolicyId |
Status Code | Description |
---|---|
200 |
|
403 |
|
404 |
|
500 |
|
Update a cancellation fee policy. All fields are optional; you only need to pass in the fields that you want to change.
201 response code on success.
Name | Type | Description |
---|---|---|
supplierapi | ||
cancellationFeePolicyId | int |
Parameter | Type | Required? | Description |
---|---|---|---|
policyName | String | false | Name of the cancellation fee policy. |
policyDescription | String | false | Additional description information. |
usePercentMode | Boolean | false | Whether the policy is in percent mode (true) or dollar mode (false). |
isDefault | Boolean | false | Whether this policy should become the default cancellation fee policy for this supplier. |
cancellationFeeRules | Array | false | Array of CancellationFeeRule objects. |
cancellationFeeRule.daysBeforeTravelDate | Integer | true | Duration before travel date that this rule will be in effect. |
cancellationFeeRule.feeAmount | Float | true | Amount of cancellation fee when rule applies (a percentage value when policy is in percent mode, or a monetary amount when in dollar mode). |
Status Code | Description |
---|---|
204 |
|
400 |
|
403 |
|
404 |
|
500 |
|
Returns a list of IDs for the selected Category. Unlike Countries and productCategories the results can be filtered in hierarchies for example passing in the Country code for Australia to the state query will limit the returned states to just those in Australia. The same filtering works for region and locality and the transport activity and accommodation results. In the case of the latter three for example you can return all activities in a region by supplying the region(s) as an argument. Each hierarchy filter (except Country) can be applied multiple times with different values. For example by passing the State ID's for NSW and Queensland to the activities filter you can see all activities that are available in those two states. Note at this point you can not filter by the activity, transport or accommodation type this means you can not get all states that kayaking is available in.
Top Level Result Object
Field name | Nullable | Type | Description |
---|---|---|---|
results | n | Array (Objects) | Array of Category objects. |
Category Object
Field name | Nullable | Type | Description |
---|---|---|---|
id | n | Integer | ID of Category. |
text | n | String | Name of Category. |
Name | Type | Description |
---|---|---|
supplierapi | ||
name | string | The name of the Category to return. Can be ('countries', 'states', 'regions', 'locations', 'transport' (transport type), 'activities', 'accommodation'). |
Name | Information | ||||
---|---|---|---|---|---|
term |
|
||||
countries |
|
||||
states |
|
||||
regions |
|
Status Code | Description |
---|---|
200 |
|
403 |
|
400 |
|
Retrieves one or more categories by their ID.
Name | Type | Description |
---|---|---|
supplierapi | ||
categoryIds | string | Comma separated list of IDs of categories to return |
Parameter | Type | Required? | Description |
---|---|---|---|
categoryIds | String | true | List of Category IDs to retrieve. |
Status Code | Description |
---|---|
200 |
|
404 |
|
403 |
|
500 |
|
Get the a list of Product Categories and their ID's. Note at this point it may return Product Categories that the logged in Agent has no Products in. Use the codes returned to limit search results to Products in those Categories. See documentation for /products.
Top Level Result Object
Field name | Nullable | Type | Description |
---|---|---|---|
results | n | Array (Objects) | Array of Category objects. |
Category Object
Field name | Nullable | Type | Description |
---|---|---|---|
id | n | Integer | ID of Category. |
text | n | String | Name of Category. |
Name | Type | Description |
---|---|---|
paramType | string | |
supplierapi |
Parameter | Type | Required? | Description |
---|---|---|---|
paramType | string | true | One of productclasses - List of Product Class Ids faretypecategories - List of available Fare Type Category Ids |
Status Code | Description |
---|---|
200 |
|
403 |
|
Returns a list of IDs for the selected Product.
Top Level Result Object
Field name | Nullable | Type | Description |
---|---|---|---|
results | n | Array (Objects) | Array of Category objects. |
Category Object
Field name | Nullable | Type | Description |
---|---|---|---|
categoryId | n | Integer | ID of Category. |
label | n | String | Name of Category. |
Name | Type | Description |
---|---|---|
productId | ||
supplierapi |
Status Code | Description |
---|---|
200 |
|
403 |
|
400 |
|
Files should be uploaded using the Content-Type: multipart/form-data
HTTP header. Raw data is expected.
Supported mime types are: image/jpg and image/jpeg. Maximum file size is 4Mb.
All image are resized as thumbnails to suit the system. Unless "isLogo" is true, then images will also be resized in system defined "medium" and "large" sizes. Original image will always remain.
Top Level Result Object
Field name | Nullable | Type | Description |
---|---|---|---|
mediaId | n | Integer | Media ID of the image. |
supplierId | n | String | Supplier ID associated with image. |
caption | y | String | Optional image caption. |
path | n | String | Absolute URL path of original sized image. |
Name | Type | Description |
---|---|---|
supplierapi |
Parameter | Type | Required? | Description |
---|---|---|---|
file | String | true | Raw file data. |
caption | String | false | Optional caption text. |
isLogo | Boolean | false | If true, smaller sizes of image provided will not be created. |
Status Code | Description |
---|---|
200 |
|
400 |
|
415 |
|
500 |
|
The returned result is an array of images. If no images are found a 404 response will be returned.
Top Level Result Object
Field name | Nullable | Type | Description |
---|---|---|---|
mediaId | n | Integer | Media ID of the image. |
path | n | String | Absolute URL path of image. |
originalName | n | String | Original name of file. |
caption | y | String | Optional image caption. |
active | y | Null | Unused. |
mimeType | y | String | Mime type of file. |
Name | Type | Description |
---|---|---|
supplierapi |
Parameter | Type | Required? | Description |
---|---|---|---|
productId | Integer | false | Optional Product ID to fetch. This is the same as calling `/supplier/product/123/images` with the size 'sm' argument. |
Status Code | Description |
---|---|
200 |
|
403 |
|
404 |
|
500 |
|
Using a specific Media ID delete the image associated.
Warning: This removes the file from the filesystem entirely.
See Status Codes
Name | Type | Description |
---|---|---|
mediaId | ||
supplierapi |
Status Code | Description |
---|---|
204 |
|
400 |
|
403 |
|
404 |
|
500 |
|
Using a specific Media ID fetch the image associated.
Top Level Result Object
Field name | Nullable | Type | Description |
---|---|---|---|
mediaId | n | Integer | Media ID of the image. |
path | n | String | Absolute URL path of image. |
caption | y | String | Optional image caption. |
active | y | Null | Unused. |
Name | Type | Description |
---|---|---|
mediaId | ||
supplierapi |
Parameter | Type | Required? | Description |
---|---|---|---|
size | String | false | Optional size of images to fetch. Defaults to small (sm). |
Status Code | Description |
---|---|
200 |
|
400 |
|
403 |
|
404 |
|
500 |
|
Adds an option to the Package based on the JSON array of data provided.
Top Level Result Object
Field name | Nullable | Type | Description |
---|---|---|---|
optionId | n | Integer | ID of the newly created Package Option. |
Name | Type | Description |
---|---|---|
productPricesDetailId | ||
supplierapi |
Parameter | Type | Required? | Description |
---|---|---|---|
label | String | true | Label for the Package Option. |
ordering | Integer | true | Sort ordering for the Package Option. The ordering for other Options will be adjusted as necessary to accommodate the new Option's ordering. |
Status Code | Description |
---|---|
201 |
|
400 |
|
403 |
|
404 |
|
500 |
|
Deletes the Option with the given ID.
Name | Type | Description |
---|---|---|
productPricesDetailId | ||
optionId | ||
supplierapi |
Status Code | Description |
---|---|
204 |
|
400 |
|
403 |
|
404 |
|
500 |
|
Update a Package Option. All fields are optional; you only need to pass in the fields that you want to change.
204 on success
Name | Type | Description |
---|---|---|
productPricesDetailId | ||
optionId | ||
supplierapi |
Parameter | Type | Required? | Description |
---|---|---|---|
label | String | false | Label for the Package Option. |
ordering | Integer | false | Sort ordering for the Package Option. The ordering of other Options will be adjusted as needed to accommodate this. |
Status Code | Description |
---|---|
204 |
|
400 |
|
403 |
|
404 |
|
500 |
|
Adds a product to the given Package Option.
201 on success
Top Level Result Object
Field name | Nullable | Type | Description |
---|---|---|---|
packageProductId | n | Integer | ID of the newly created Package Product. |
Name | Type | Description |
---|---|---|
productPricesDetailId | ||
optionId | ||
supplierapi |
Parameter | Type | Required? | Description |
---|---|---|---|
productPricesDetailId | Integer | true | ProductPricesDetail to be linked to the PackageProduct. |
quantity | Integer | false | Quantity of the ProductPricesDetail to be included. Defaults to 1. |
ordering | Integer | true | Sort ordering for the PackageProduct. The ordering for other PackageProducts will be adjusted as necessary to accommodate the new PackageProduct's ordering |
rrpDifference | Float | false | Amount to add onto package's base RRP if this Package Product is selected. If null, the difference between the RRP for this product and the RRP for the cheapest product in the option will be used. Must be null for the cheapest product in this package option. |
Status Code | Description |
---|---|
201 |
|
400 |
|
403 |
|
404 |
|
500 |
|
Deletes the given Package Product
Name | Type | Description |
---|---|---|
productPricesDetailId | ||
optionId | ||
packageProductId | ||
supplierapi |
Status Code | Description |
---|---|
204 |
|
400 |
|
403 |
|
404 |
|
500 |
|
Edits the given Package Product
204 on success
Name | Type | Description |
---|---|---|
productPricesDetailId | ||
optionId | ||
packageProductId | ||
supplierapi |
Parameter | Type | Required? | Description |
---|---|---|---|
productPricesDetailId | Integer | false | ProductPricesDetail to linked to the PackageProduct. |
quantity | Integer | false | Quantity of the ProductPricesDetail to be included. Defaults to 1. |
ordering | Integer | false | Sort ordering for the PackageProduct. The ordering for other PackageProducts will be adjusted as necessary to accommodate the new PackageProduct's ordering |
rrpDifference | Float | false | Amount to add onto package's base RRP if this Package Product is selected. If null, the difference between the RRP for this product and the RRP for the cheapest product in the option will be used. Must be null for the cheapest product in this package option. |
Status Code | Description |
---|---|
204 |
|
400 |
|
403 |
|
404 |
|
500 |
|
Retrieves information about the given package.
Top Level Result Object
Field name | Nullable | Type | Description |
---|---|---|---|
optionId | n | Integer | ID of the Package Option. |
label | n | String | Label for the Package Option. |
ordering | n | Integer | Sort order for the Package Option (affects order shown in UI). |
packageProducts | n | Array | Array of Package Product objects. |
PackageProduct Object
Field name | Nullable | Type | Description |
---|---|---|---|
packageProductId | n | Integer | ID of the Package Product. |
productPricesDetailId | n | Integer | ID of the ProductPricesDetail. |
ordering | n | Integer | Sort order for the Package Product (affects order shown in UI). |
quantity | n | Integer | Quantity of the ProductPricesDetail to be included in the package. |
rrpDifference | y | Float | Amount to add onto package's base RRP if this Package Product is selected. If null, the difference between the RRP for this product and the RRP for the cheapest product in the option will be used. Must be null for the cheapest product in this package option. |
Name | Type | Description |
---|---|---|
productPricesDetailId | ||
supplierapi |
Status Code | Description |
---|---|
200 |
|
403 |
|
404 |
|
500 |
|
Adds a price to the Product based on the JSON array of data provided.
Top Level Result Object
Field name | Nullable | Type | Description |
---|---|---|---|
productPricesDetailsId | n | Integer | ID of the newly created Product Prices Detail. |
Name | Type | Description |
---|---|---|
productId | integer | |
supplierapi |
Parameter | Type | Required? | Description |
---|---|---|---|
fareName | String | true | Name of the Fare Type. |
fareTypeCategoryId | Integer | true | ID of Fare Type Category. |
numAdults | Integer | false | Number of adults who are eligible to travel on this fare (applies to fares with family Fare Type Category only). |
numChildren | Integer | false | Number of children who are eligible to travel on this fare (applies to fares with family Fare Type Category only). |
childMinAge | Integer | false | Minimum age for children to be eligible for this fare (applies to fares with child or family Fare Type Category only). |
childMaxAge | Integer | false | Maximum age for children to be eligible for this fare (applies to fares with child or family Fare Type Category only). |
earlyBirdLeadDays | Integer | false | Lead time (in days) that the fare must be booked in advance (applies to early bird fares only). |
currency | String | true | Currency code. |
pax | Integer | true | Number of people the price covers. |
fareQtyRestrictions | Integer | false | Total quantity (or multiples of) this fare that agents must select when purchasing this fare. |
duration | Integer | true | Duration of the tour in days. |
durationNights | Integer | false | Duration of the tour in nights. |
periodStart | String | true | Start date of the active period. |
periodEnd | String | false | End date of the active period. |
travelStart | String | false | Start date of the travel period. |
travelEnd | String | false | End date of the travel period. |
productPriceSequence | Integer | false | Sequence of this price. |
rrp | Float | true | Recommended retail price. |
netRate | Float | true | Net or wholesale price. |
levy | Float | true | Any levy charged on top of RRP at point of travel. |
levyDescription | string | false | Description of levy. |
agents | array | false | Ids of the agents that have access to this price. |
packageOnlyFare | Boolean | false | Is this a Package only fare? |
allowOpenDated | Boolean | false | Allow open dated bookings? |
defaultFare | Boolean | false | Is this the default fare for the Product? |
cancellationFeePolicyId | integer | false | ID of product's cancellation fee policy (not applicable if noRefunds is turned on for product). |
allowEmptyRedeemerDetails | Boolean | false | Allow empty redeemer details |
allowFreeSell | Boolean | false | Allow freelance sell |
note | String | false | Any special comments made by Supplier. |
bookingSystemMapping | array | false | Fields used to map product to an external reservation system. Required fields vary according to booking system used; please contact Website Travel for more information. |
Status Code | Description |
---|---|
201 |
|
403 |
|
400 |
|
500 |
|
Retrieves information about the given Product Price.
Top Level Result Object
Field name | Nullable | Type | Description |
---|---|---|---|
productPricesDetailsId | n | Integer | ID of this Price. |
fareName | n | String | Name of the Fare Type. |
fareTypeCategory | y | Integer | ID of the Fare Type Category. |
numAdults | y | Integer | Number of adults who are eligible to travel on this fare (applies to fares with family Fare Type Category only). |
numChildren | y | Integer | Number of children who are eligible to travel on this fare (applies to fares with family Fare Type Category only). |
minChildAge | y | Integer | Minimum age for children to be eligible for this fare (applies to fares with child or family Fare Type Category only). |
maxChildAge | y | Integer | Maximum age for children to be eligible for this fare (applies to fares with child or family Fare Type Category only). |
earlyBirdLeadDays | y | Integer | Lead time (in days) that the fare must be booked in advance (applies to early bird fares only). |
status | n | String | Current status (e.g. 'Draft', 'History', 'Live'). |
currency | n | String | ISO 4217 currency code. |
agentPricingGroupId | n | Integer | Agent pricing group ID. |
rrp | n | Float | Recommended retail price. |
netRate | n | Float | Net or wholesale price. |
levy | n | Float | Any levy charged on top of RRP at point of travel. |
levyDescription | n | String | Description of levy. |
periodStart | n | String | Start date of the active period in format YYYY-MM-DD. |
periodEnd | n | String | End date of the active period in format YYYY-MM-DD. |
travelStart | n | String | Start date of the travel period in format YYYY-MM-DD. |
travelEnd | n | String | End date of the travel period in format YYYY-MM-DD. |
pax | n | Integer | Number of people the price covers. |
fareQtyRestrictions | n | Integer | Total quantity (or multiples of) this fare that agents must select when purchasing this fare |
duration | n | Integer | Duration of the tour in days. |
durationNights | n | Integer | Duration of the tour in nights. |
packageOnlyFare | n | Boolean | Is this a Package only fare? |
allowOpenDated | n | Boolean | Allow open dated bookings? |
cprFare | n | Boolean | Denotes Control Panel Rate where Agent Pricing Group in use. |
allowEmptyRedeemerDetails | n | Boolean | Allow empty redeemer details |
allowFreeSell | n | Boolean | Allow freelance sell |
note | n | String | Any special comments made by Supplier. |
deletePending | n | Boolean | This same fare has a delete request pending |
bookingSystemMapping | y | Array | Fields used to map product to an external reservation system. Fields vary according to booking system used; please contact Website Travel for more information. |
Name | Type | Description |
---|---|---|
productId | int | Product ID. |
productPricesDetailId | int | Product Prices Details ID. |
supplierapi |
Status Code | Description |
---|---|
200 |
|
400 |
|
403 |
|
500 |
|
Deletes the Price with the given Product ID and Product Prices Details ID.
Name | Type | Description |
---|---|---|
productId | int | Product ID. |
productPricesDetailsId | int | Prices Details ID. |
supplierapi |
Status Code | Description |
---|---|
204 |
|
403 |
|
400 |
|
500 |
|
Update a Price. All fields are optional; you only need to pass in the fields that you want to change. When editing a live price, a copy will be made of the price in draft status, and the ID of this new price will be returned in the response body. This means that the existing live price will remain in effect until the new draft price has gone through our product approval process. On the other hand, edits to draft prices and to MarketPlace prices which have been directly negotiated between supplier and agent will be made to the existing Price, and no response body will be returned.
Top Level Result Object
Field name | Nullable | Type | Description |
---|---|---|---|
productPricesDetailsId | n | Integer | ID of new Price (if any). |
Name | Type | Description |
---|---|---|
productId | int | Product ID. |
productPricesDetailIds | ||
supplierapi | string | Part of the path to this route (eg \"supplier\" or \"apiv1/supplier\") |
productPricesDetailsId | int |
Parameter | Type | Required? | Description |
---|---|---|---|
fareName | String | false | Name of the Fare Type. |
fareTypeCategoryId | Integer | true | ID of Fare Type Category. |
numAdults | Integer | false | Number of adults who are eligible to travel on this fare (applies to fares with family Fare Type Category only). |
numChildren | Integer | false | Number of children who are eligible to travel on this fare (applies to fares with family Fare Type Category only). |
childMinAge | Integer | false | Minimum age for children to be eligible for this fare (applies to fares with child or family Fare Type Category only). |
childMaxAge | Integer | false | Maximum age for children to be eligible for this fare (applies to fares with child or family Fare Type Category only). |
earlyBirdLeadDays | Integer | false | Lead time (in days) that the fare must be booked in advance (applies to early bird fares only). |
pax | Integer | false | Number of people the price covers. |
fareQtyRestrictions | Integer | false | Total quantity (or multiples of) this fare that agents must select when purchasing this fare |
duration | Integer | false | Duration of the tour in days. |
durationNights | Integer | false | Duration of the tour in nights. |
periodStart | String | false | Start date of the active period. |
periodEnd | String | false | End date of the active period. |
travelStart | String | false | Start date of the travel period. |
travelEnd | String | false | End date of the travel period. |
rrp | Float | false | Recommended retail price. |
netRate | Float | false | Net or wholesale price. |
levy | Float | false | Any levy charged on top of RRP at point of travel. |
levyDescription | String | false | Description of levy. |
packageOnlyFare | Boolean | false | Is this a Package only fare? |
allowOpenDated | Boolean | false | Allow open dated bookings? |
defaultFare | Boolean | false | Is this the default fare for the Product? |
cancellationFeePolicyId | integer | false | ID of product's cancellation fee policy (not applicable if noRefunds is turned on for product). |
allowEmptyRedeemerDetails | Boolean | false | Allow empty redeemer details |
note | String | false | Any special comments made by Supplier. |
bookingSystemMapping | array | false | Fields used to map product to an external reservation system. Required fields vary according to booking system used; please contact Website Travel for more information. |
agents | array | false | Ids of the agents that have access to this price. |
Status Code | Description |
---|---|
201 |
|
204 |
|
403 |
|
400 |
|
500 |
|
Creates a draft version of the product price which can be used to make further edits. While the main route to PUT changes to a product price will automatically create a new draft when necessary and return the new ID, some other routes (e.g. to manage package options) do not.
The exact behaviour depends on the current status of the product prices detail passed in:
Name | Type | Description |
---|---|---|
productId | ||
productPricesDetailsId | ||
supplierapi |
Status Code | Description |
---|---|
204 |
|
400 |
|
403 |
|
404 |
|
422 |
|
500 |
|
Retrieves information about all Product prices for the Product. Output as for GET product/{productId}/price/{productPricesDetailId} as above.
Name | Type | Description |
---|---|---|
productId | int | Product ID. |
supplierapi |
Status Code | Description |
---|---|
200 |
|
400 |
|
403 |
|
500 |
|
Creates a new Product with the details provided.
Top Level Result Object
Field name | Nullable | Type | Description |
---|---|---|---|
productId | n | Integer | ID of the newly created Product. |
Note that HTML text fields support a very limited subset of HTML - <p>, <ol>, <ul>, <li> and <br> elements only are permitted, and no attributes may be used on any of these elements. This helps us to prevent malicious content and ensure a consistent visual presentation for all products in our TravelDesk™ system.
Name | Type | Description |
---|---|---|
supplierapi |
Parameter | Type | Required? | Description |
---|---|---|---|
productName | String | true | Name of the Product. |
mediaId | Integer | false | ID of the Media Image use as Product thumbnail. |
country | String | true | 2-character Country code. |
timezone | String | false | String (e.g. 'Australia/Sydney') representing products timezone. If left empty, will default to Suppliers timezone. Based on timezone database @ https://www.iana.org/time-zones |
productClassId | Integer | true | ID of Product Class (see output from /categories/productclasses). |
apiProviderId | Integer | false | Internal use only, if you've been given a value to use for this property then please do so here. |
externalId | Integer | false | Internal use only, if you've been given a value to use for this property then please do so here. |
rating | Decimal | false | Valid only for Accommodation products. A 'star' rating in the range of 1-5 and accepting of half values e.g. '3.5'. |
teaser | String | false | Brief product description (up to 300 characters). |
description | String | false | Longer product description. |
itineraryDetails | Array (Objects) | false | Array of itinerary details in objects. Example itinerary object: 'itineraryTitle':Day1,'itineraryBreakfast':0, 'itineraryLunch':1, 'itineraryDinner':0, 'itineraryDescription':'Day1 itinerary details'. For itineraryBreakfast/itineraryLunch/itineraryDinner:1 represents included meal, 0 means no meal provided. |
departuresPickups | String | false | Information about departures or pickups. |
extras | String | false | Information about extras which are not included in product price - eg airport transfers, meals. |
voucherInstructions | String | false | Information for customer, including phone numbers and confirmation instructions etc. Has to be more than 20 characters, if not system automatically assign default voucher instruction that is 'Open date tickets are subject to availability, please give 7-14 days notice to book. All bookings must be reconfirmed 24-48 hours in advance. Operator terms & conditions applies.' |
voucherInformationContactDetailsBits | Integer | false | Combined bitwise value of address contact details to be printed on voucher. Depending on your supplier setup this will either be the details of your supplier account or contact details specific to this product. Combination of: Work phone = 1, Fee phone = 2, Address line one = 4, Address line two = 8, Suburb/city = 16, State = 32, Postcode = 64, Cuntry = 128. For example, to display free phone, state and country on vouchers for this product, you would send a value of (2 | 32 | 128) 162. At least one phone number (work phone|free phone) is required. |
agentInstructions | String | false | Additional information for the agent. |
noRefunds | Boolean | false | Disables refunds for the product. |
noRefundsMessage | String | false | Message explaining why refunds are not available. |
cancellationFeePolicyId | integer | false | ID of product's cancellation fee policy (not applicable if noRefunds is turned on). |
contactPhone | String | false | Contact phone number. |
contactEmail | String | false | Contact email address. |
addressLineOne | String | true | First line of Product Address. |
addressLineTwo | String | false | Second line of Product Address. |
addressSuburb | String | false | Suburb of Product Address. |
addressCity | String | true | City of Product Address. |
addressState | String | false | State of Product Address. |
addressPostcode | String | true | Postcode of Product Address. |
startLocation | Integer | true | Category ID of Product start location. |
secondaryLocation | Integer | false | Category ID of Product's secondary location. The use of this field implies that the start location is also the end location; if not, the endLocation field should be specified instead. |
endLocation | Integer | false | Category ID of end location. |
activityTypes | Array | false | Array of Category ID's (Integers) of activity type. Applies to activity, combo tour, day tour and multi-day tour Product classes only. |
accommodationTypes | Array | false | Array of Category ID's (Integers) of accommodation types. Applies to accommodation, combo tour, day tour and multi-day tour Product classes only. |
transportTypes | Array | false | Array of Category ID's (Integers) of transport types. Applies to transport, combo tour, day tour and multi-day tour Product classes only. |
minAgeRecommendation | Integer | false | Minimum recommended age. |
maxAgeRecommendation | Integer | false | Maximum recommended age. |
ageRestriction | String | false | Description of any age restrictions (e.g. for an R18 hostel). |
fitnessRequirements | String | false | Description of fitness requirements. |
minGroupSize | Integer | false | Minimum group size. |
maxGroupSize | Integer | false | Maximum group size. |
dietaryRequirements | String | false | Description of dietary requirements. |
luggageRequirements | String | false | Description of luggage requirements. |
includedItems | Array | false | Array of items included in the fare. |
bringItems | Array | false | Array of items that guest is expected to bring. |
voucherTerms | String | false | Description of terms and conditions, disclaimers etc. |
weekDays | Array | false | Array of days of week that trip departs.. This field is 'Deprecated', recommended to use 'departureDates' field. |
departureDates | String | false | Comma-separated tour departure dates |
recurrenceDate | String | false | Frequency of departure recurrence (e.g. 'Weekly' or 'Monthly'). This field is 'Deprecated', recommended to use 'departureDates' field. |
specialCircumstanceDate | String | false | Description of special dates which affect departure info (e.g. Christmas Day).. This field is 'Deprecated', recommended to use 'departureDates' field. |
operatingPartner | String | false | Operating partner. |
tourCode | String | false | Tour code. |
mandatoryFieldCheckout | Array | false | Array of customer fields absolutely necessary to make the booking. Customer field names: title, phone, emailAddress, dateOfBirth, redeemerCountry, postcode. |
Status Code | Description |
---|---|
201 |
|
403 |
|
400 |
|
500 |
|
Abandons all changes to a product including products in Candidate, approved, Delete_Pending and Delete_Approved
Name | Type | Description |
---|---|---|
productId | ||
supplierapi |
Status Code | Description |
---|---|
204 |
|
400 |
|
403 |
|
404 |
|
500 |
|
Marks the specified Product for delete. The behaviour of this API method depends on the current state of the Product's ProductsDetails. In some cases it will not be deleted straight away, but a request for the Product to be deleted will be lodged with the Website Travel product management team.
Name | Type | Description |
---|---|---|
productId | ||
supplierapi |
Parameter | Type | Required? | Description |
---|---|---|---|
reason | String | true | Required reason for deleting this product. |
Status Code | Description |
---|---|
204 |
|
400 |
|
403 |
|
404 |
|
500 |
|
Updates a product with the details provided. Changes will be made to the Draft ProductsDetail - a new Draft ProductsDetail will be created if the product does not already have one. The draft must be submitted using the POST /product/{productId}/submit method and go through an approval process before the changes take effect. All fields are optional - only pass in the ones which you wish to change.
Name | Type | Description |
---|---|---|
supplierapi | ||
productId |
Parameter | Type | Required? | Description |
---|---|---|---|
productName | String | false | Name of the Product. |
mediaId | Integer | false | ID of the Media Image use as Product thumbnail. |
country | String | false | 2-character Country code. |
timezone | String | false | String (e.g. 'Australia/Sydney') representing products timezone. If left empty, will default to Suppliers timezone. Based on timezone database @ https://www.iana.org/time-zones |
productClassId | Integer | false | ID of Product Class (see output from /categories/productclasses). |
rating | Decimal | false | Valid only for Accommodation products. A 'star' rating in the range of 1-5 and accepting of half values e.g. '3.5'. |
teaser | String | false | Brief product description (up to 300 characters). |
description | String | false | Longer product description. |
itineraryDetails | Array (Objects) | false | Array of itinerary details in objects. Example itinerary object: 'itineraryTitle':Day1,'itineraryBreakfast':0, 'itineraryLunch':1, 'itineraryDinner':0, 'itineraryDescription':'Day1 itinerary details'. For itineraryBreakfast/itineraryLunch/itineraryDinner:1 represents included meal, 0 means no meal provided. |
departuresPickups | String | false | Information about departures or pickups. |
extras | String | false | Information about extras which are not included in product price - eg airport transfers, meals. |
voucherInstructions | String | false | Information for customer, including phone numbers and confirmation instructions etc. Has to be more than 20 characters, if not system automatically assign default voucher instruction that is 'Open date tickets are subject to availability, please give 7-14 days notice to book. All bookings must be reconfirmed 24-48 hours in advance. Operator terms & conditions applies.' |
voucherInformationContactDetailsBits | Integer | false | Combined bitwise value of address contact details to be printed on voucher. Depending on your supplier setup this will either be the details of your supplier account or contact details specific to this product. Combination of: Work phone = 1, Fee phone = 2, Address line one = 4, Address line two = 8, Suburb/city = 16, State = 32, Postcode = 64, Cuntry = 128. For example, to display free phone, state and country on vouchers for this product, you would send a value of (2 | 32 | 128) 162. At least one phone number (work phone|free phone) is required. |
agentInstructions | String | false | Additional information for the agent. |
noRefunds | Boolean | false | Disables refunds for the product. |
noRefundsMessage | String | false | Message explaining why refunds are not available. |
cancellationFeePolicyId | integer | false | ID of product's cancellation fee policy (not applicable if noRefunds is turned on). |
contactPhone | String | false | Contact phone number. |
contactEmail | String | false | Contact email address. |
addressLineOne | String | false | First line of Product Address. |
addressLineTwo | String | false | Second line of Product Address. |
addressSuburb | String | false | Suburb of Product Address. |
addressCity | String | false | City of Product Address. |
addressState | String | false | State of Product Address. |
addressPostcode | String | false | Postcode of Product Address. |
startLocation | Integer | false | Category ID of Product start location. |
secondaryLocation | Integer | false | Category ID of Product's secondary location. The use of this field implies that the start location is also the end location; if not, the endLocation field should be specified instead. |
endLocation | Integer | false | Category ID of end location. |
activityTypes | Array | false | Array of category ID's (Integers) of activity type. Applies to activity, combo tour, day tour and multi-day tour Product classes only. |
accommodationTypes | Array | false | Array of category ID's (Integers) of accommodation types. Applies to accommodation, combo tour, day tour and multi-day tour Product classes only. |
transportTypes | Array | false | Array of category ID's (Integers) of transport types. Applies to transport, combo tour, day tour and multi-day tour Product classes only. |
minAgeRecommendation | Integer | false | Minimum recommended age. |
maxAgeRecommendation | Integer | false | Maximum recommended age. |
ageRestriction | String | false | Description of any age restrictions (e.g. for an R18 hostel). |
fitnessRequirements | String | false | Description of fitness requirements. |
minGroupSize | Integer | false | Minimum group size. |
maxGroupSize | Integer | false | Maximum group size. |
dietaryRequirements | String | false | Description of dietary requirements. |
luggageRequirements | String | false | Description of luggage requirements. |
includedItems | Array | false | Array of items included in the fare. |
bringItems | Array | false | Array of items that guest is expected to bring. |
voucherTerms | String | false | Description of terms and conditions, disclaimers etc. |
weekDays | Array | false | Array of days of week that trip departs.. This field is 'Deprecated', recommended to use 'departureDates' field. |
departureDates | String | false | Comma-separated tour departure dates. |
recurrenceDate | String | false | Frequency of departure recurrence (e.g. 'Weekly' or 'Monthly'). This field is 'Deprecated', recommended to use 'departureDates' field. |
specialCircumstanceDate | String | false | Description of special dates which affect departure info (e.g. Christmas Day).. This field is 'Deprecated', recommended to use 'departureDates' field. |
operatingPartner | String | false | Operating partner. |
tourCode | String | false | Tour code. |
mandatoryFieldCheckout | Array | false | Array of customer fields absolutely necessary to make the booking. Customer field names: title, phone, emailAddress, dateOfBirth, redeemerCountry, postcode. |
Status Code | Description |
---|---|
204 |
|
403 |
|
400 |
|
500 |
|
Deletes images from being associated with a Product. Does NOT remove the file entirely.
See Status Codes
Name | Type | Description |
---|---|---|
productId | ||
supplierapi |
Parameter | Type | Required? | Description |
---|---|---|---|
mediaIds | String | true | List of Media ID's associated with a product to remove. |
Status Code | Description |
---|---|
204 |
|
400 |
|
403 |
|
404 |
|
500 |
|
The returned result is an array of images. If no images are found a 404 response will be returned.
/supplier/product/554/images
will return any gallery images attached to the product with ID 554.
Top Level Result Object
Field name | Nullable | Type | Description |
---|---|---|---|
mediaId | n | Integer | Media ID of the image. |
path | n | String | Absolute URL path of image. |
caption | y | String | Optional image caption. |
active | y | Boolean | True on first image in set. |
Name | Type | Description |
---|---|---|
productId | ||
supplierapi |
Parameter | Type | Required? | Description |
---|---|---|---|
size | String | false | Optional size of images to fetch. Defaults to largest size available. |
Status Code | Description |
---|---|
200 |
|
403 |
|
404 |
|
500 |
|
Associates already uploaded images to a Product.
See Status Codes
Name | Type | Description |
---|---|---|
productId | ||
supplierapi |
Parameter | Type | Required? | Description |
---|---|---|---|
mediaIds | String | true | Maximum of 10 per product. If some images were already set, then only the first X will be used to fill the remaining spaces. |
Status Code | Description |
---|---|
201 |
|
204 |
|
400 |
|
403 |
|
404 |
|
413 |
|
500 |
|
Submits the draft ProductsDetail to be made available for agents to purchase. When this request is made the draft will be moved to candidate status, and then to approved status and finally live status as it moves through the Website Travel approval process.
Name | Type | Description |
---|---|---|
productId | ||
supplierapi |
Status Code | Description |
---|---|
204 |
|
403 |
|
404 |
|
500 |
|
Retrieves information about the given ProductsDetail
Top Level Result Object
Field name | Nullable | Type | Description |
---|---|---|---|
productId | n | Integer | Product ID |
productStatusCode | n | string | One-character product status code |
productStatus | n | String | Product status name |
productName | n | String | Product name |
productCountry | n | String | 2-character ISO 3166 Country code |
productTimezone | y | String | String (e.g. 'Australia/Sydney') representing products timezone. Based on timezone database @ https://www.iana.org/time-zones |
productClassId | n | Integer | Product class ID |
rating | y | Decimal | Valid only for Accommodation products. A 'star' rating in the range of 1-5. |
productClass | n | String | Name of product class |
teaser | n | String | Short product description |
description | n | String | Long product description |
itineraryDetails | y | Array (Object) | Array of itineraryDetails Objects. Example:
"itineraryDetails": [ { "itineraryTitle": "day1", "itineraryBreakfast": 0, "itineraryLunch": 1, "itineraryDinner": 0, "itineraryDescription": "day1 details" }, { "itineraryTitle": "day2", "itineraryBreakfast": 1, "itineraryLunch": 0, "itineraryDinner": 0, "itineraryDescription": "day2 details" } ] For itineraryBreakfast / itineraryLunch / itineraryDinner: 1 - meal provided, 0 - not provided. |
departuresPickups | n | String | Information about pickups, departures or opening hours |
extras | n | String | Information about extras which can be added to the product |
voucherInstructions | n | String | Instructions to be printed on the voucher |
voucherInformationContactDetailsBits | n | Integer |
Combined bitwise value of address contact details to be printed on voucher. Depending on your
supplier setup this will either be the details of your supplier account or contact details
specific to this product. Combination of: Work phone = 1 Free phone = 2 Address line one = 4 Address line two = 8 Suburb/city = 16 State = 32 Postcode = 64 Country = 128 |
agentInstructions | n | String | Instructions to be made available to agents when placing orders |
noRefunds | n | Boolean | Whether refunds should be permitted for this product. Default value is true. |
noRefundsMessage | n | String | Message to be displayed when an attempt is made to get a refund for a no-refunds product |
contactEmail | y | String | Contact email address set for product |
contactPhone | y | String | Contact phone number set for product |
addressLineOne | n | String | First line of product address |
addressLineTwo | n | String | Second line of product address |
addressSuburb | n | String | Suburb line of product address |
addressCity | n | String | city line of product address |
addressState | n | String | State line of product address |
addressPostcode | n | String | Postcode of product address |
mediaPath | n | Array | Path to product's thumbnail image |
mediaId | n | Integer | Media ID of product's thumbnail image |
countries | n | Array | List of IDs of countries associated with this product |
states | n | Array | List of IDs of states associated with this product |
regions | n | Array | List of IDs of regions associated with this product |
locations | n | Array | List of IDs of locations associated with this product |
accommodation | n | Array | List of IDs of accommodation categories associated with this product |
activities | n | Array | List of IDs of activity categories associated with this product |
transport | n | Array | List of IDs of transport categories associated with this product |
startLocation | y | Integer | Location ID of product start location |
endLocation | y | Array | Location ID of product end location |
minAgeRecommendation | n | Integer | Minimum recommended age. |
maxAgeRecommendation | n | Integer | Maximum recommended age. |
ageRestriction | n | String | Description of any age restrictions (e.g. for an R18 hostel). |
fitnessRequirement | n | String | Description of fitness requirements. |
minGroupSize | n | Integer | Minimum tour group size. |
maxGroupSize | n | Integer | Maximum tour group size. |
dietaryRequirements | n | Integer | Dietary requirements. |
luggageRequirements | n | String | Luggage requirements. |
includedItems | n | Array(String) | Description of items included in fare. |
bringItems | n | Array(String) | Description of items the guest is expected to bring. |
voucherTerms | y | String | Description of terms and conditions, disclaimers etc. |
weekDays | y | Array(String) | Comma-separated list of days of the week that trip departs. This field is "Deprecated", recommended to use "departureDates" field. |
departureDates | y | String | Comma-separated tour departure dates. |
recurrenceDate | y | String | Frequency of departure recurrence (e.g. "Weekly", "Daily", "Monthly"). This field is "Deprecated", recommended to use "departureDates" field. |
specialCircumstanceDate | y | String | Description of special dates which affect departure info (e.g. Christmas Day).. This field is "Deprecated", recommended to use "departureDates" field. |
operatingPartner | y | String | Operating partner. |
tourCode | y | String | Tour code. |
mandatoryFieldCheckout | y | Array | Array of customer fields absolutely necessary to make the booking. Customer field names: title, phone, emailAddress, dateOfBirth, redeemerCountry, postcode. |
itineraryDetails Object
Field name | Nullable | Type | Description |
---|---|---|---|
itineraryTitle | y | String | itinerary Title Example day 1 |
itineraryBreakfast | y | Integer | 1 - meal provided. 0 - not provided |
itineraryLunch | y | Integer | 1 - meal provided. 0 - not provided |
itineraryDinner | y | Integer | 1 - meal provided. 0 - not provided |
itineraryDescription | y | String | Details of the specific day |
Name | Type | Description |
---|---|---|
productId | ||
productStatusCode | ||
supplierapi |
Status Code | Description |
---|---|
200 |
|
403 |
|
500 |
|
Allows you to send a message to the WT team about a specific ProductsDetail record.
Name | Type | Description |
---|---|---|
productId | ||
productStatusCode | ||
supplierapi |
Parameter | Type | Required? | Description |
---|---|---|---|
message | String | true | Message to send. |
Status Code | Description |
---|---|
204 |
|
400 |
|
403 |
|
404 |
|
500 |
|
Retrieves information about the products that belong to the logged-in supplier. Note that the records returned are "productdetails", not products, so there may be multiple records in different statuses with the same product ID.
Top Level Result Object
Field name | Nullable | Type | Description |
---|---|---|---|
fetchedRecords | n | Integer | Number of records returned in this response. |
totalMatchingRecords | n | Integer | Total number of matching records found. |
results | n | Array | List of ProductsDetails objects. |
ProductsDetails Object
Field name | Nullable | Type | Description |
---|---|---|---|
productId | n | Integer | Product ID |
productName | n | String | Product name |
productStatusCode | n | Character | Product status code |
productStatus | n | String | Product status name |
deletePending | n | Boolean | This product has a delete request pending |
Name | Type | Description |
---|---|---|
supplierapi |
Name | Information | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
productId |
|
||||||||||
productName |
|
||||||||||
productStatusCode |
|
||||||||||
sortBy |
|
||||||||||
sortDirection |
|
||||||||||
recordsStart |
|
||||||||||
recordsLength |
|
Status Code | Description |
---|---|
200 |
|
403 |
|
500 |
|