Experiences

Experiences are the products that the supplier provides. PORTA experiences can eventually be imported into Musement.

Get experiences

SecuritySupplier-production or Supplier-sandbox
Request
query Parameters
vendor_id
string^(?!\-|\.|\_)[0-9a-z\-\.\_]{1,50}$

Filter results to those which belong to the specified vendor.

header Parameters
accept
required
string

Specify the format of the response.

Value: "application/json"
accept-version
required
string (PORTA version)

The version of PORTA for the request.

Value: Description
vnd.porta-api.v1

Version 1.0.0

Responses
200

Experiences

default

Error response

get/supplier/catalog/experiences
Request samples
Response samples
application/json
[
  • {
    }
]

Create experience

SecuritySupplier-production or Supplier-sandbox
Request
header Parameters
accept
required
string

Specify the format of the response.

Value: "application/json"
accept-version
required
string (PORTA version)

The version of PORTA for the request.

Value: Description
vnd.porta-api.v1

Version 1.0.0

Request Body schema: application/json
archived
boolean
Default: false

When an experience is archived, it is no longer for sale in Musement sites.

When an experience is un-archived, a member of the Content Supplier Connectivity team is required to un-archive the corresponding business platform activity.

availability_slot_type
required
string

The type of availability slot for the experience.

Enum: Description
DAILY

Customers must select a date for their booking. They do not select a time.

OPEN

Customers do not select a date or time. Their booking expires on a set date or a set number of days after purchase.

TIME

Customers must select a date and time for their booking.

currency
required
string <currency>

The currency to use for billing.

This property must follow the ISO 4217 standard.

cutoff_time
string <duration>
Default: "P0D"

The minimum amount of time required to book a travel date in advance.

This property must follow the ISO 8601 standard.

experience_id
required
string^(?!\-|\.|\_)[0-9a-z\-\.\_]{1,50}$

The experience ID, assigned by the supplier.

experience_name
required
string

The name of the experience as it will appear in PORTA.

external_experience_id
string

An additional ID for the experience which suppliers can use for their own records.

external_experience_name
string

An additional name for the experience which suppliers can use for their own records.

required
Array of objects (Options) unique

The bookable options for the experience. This property must contain at least one option.

vendor_id
required
string^(?!\-|\.|\_)[0-9a-z\-\.\_]{1,50}$

The ID of the vendor that the experience belongs to.

Responses
200

Experience

default

Error response

post/supplier/catalog/experiences
Request samples
application/json
{
  • "archived": false,
  • "availability_slot_type": "DAILY",
  • "currency": "string",
  • "cutoff_time": "P0D",
  • "experience_id": "string",
  • "experience_name": "string",
  • "external_experience_id": "string",
  • "external_experience_name": "string",
  • "options": [
    ],
  • "vendor_id": "string"
}
Response samples
application/json
{
  • "archived": false,
  • "availability_slot_type": "DAILY",
  • "currency": "string",
  • "cutoff_time": "P0D",
  • "experience_id": "string",
  • "experience_name": "string",
  • "external_experience_id": "string",
  • "external_experience_name": "string",
  • "options": [
    ],
  • "vendor_id": "string"
}

Get experience

SecuritySupplier-production or Supplier-sandbox
Request
path Parameters
experience_id
required
string^(?!\-|\.|\_)[0-9a-z\-\.\_]{1,50}$

The experience ID.

header Parameters
accept
required
string

Specify the format of the response.

Value: "application/json"
accept-version
required
string (PORTA version)

The version of PORTA for the request.

Value: Description
vnd.porta-api.v1

Version 1.0.0

Responses
200

Experience

default

Error response

get/supplier/catalog/experiences/{experience_id}
Request samples
Response samples
application/json
{
  • "archived": false,
  • "availability_slot_type": "DAILY",
  • "currency": "string",
  • "cutoff_time": "P0D",
  • "experience_id": "string",
  • "experience_name": "string",
  • "external_experience_id": "string",
  • "external_experience_name": "string",
  • "options": [
    ],
  • "vendor_id": "string"
}

Update experience

Updating an experience is limited to a small selection of properties.

Changes may take up to 24 hours to appear in the business platform and distribution sites.

SecuritySupplier-production or Supplier-sandbox
Request
path Parameters
experience_id
required
string^(?!\-|\.|\_)[0-9a-z\-\.\_]{1,50}$

The experience ID.

header Parameters
accept
required
string

Specify the format of the response.

Value: "application/json"
accept-version
required
string (PORTA version)

The version of PORTA for the request.

Value: Description
vnd.porta-api.v1

Version 1.0.0

Request Body schema: application/json
archived
boolean
Default: false

When an experience is archived, it is no longer for sale in Musement sites.

When an experience is un-archived, a member of the Content Supplier Connectivity team is required to un-archive the corresponding business platform activity.

cutoff_time
string <duration>
Default: "P0D"

The minimum amount of time required to book a travel date in advance.

This property must follow the ISO 8601 standard.

experience_name
string

The name of the experience as it will appear in PORTA.

external_experience_id
string

An additional ID for the experience which suppliers can use for their own records.

external_experience_name
string

An additional name for the experience which suppliers can use for their own records.

vendor_id
string^(?!\-|\.|\_)[0-9a-z\-\.\_]{1,50}$

The ID of the vendor that the experience belongs to.

Responses
200

Experience

default

Error response

patch/supplier/catalog/experiences/{experience_id}
Request samples
application/json
{
  • "archived": false,
  • "cutoff_time": "P0D",
  • "experience_name": "string",
  • "external_experience_id": "string",
  • "external_experience_name": "string",
  • "vendor_id": "string"
}
Response samples
application/json
{
  • "archived": false,
  • "availability_slot_type": "DAILY",
  • "currency": "string",
  • "cutoff_time": "P0D",
  • "experience_id": "string",
  • "experience_name": "string",
  • "external_experience_id": "string",
  • "external_experience_name": "string",
  • "options": [
    ],
  • "vendor_id": "string"
}
Copyright © TUI Musement. All rights reserved.