Vouchers

A collection of endpoints to use at the end of the booking flow to retrieve reserved tickets and vouchers.

Get tickets for activity in order

Returns an array of available tickets/vouchers for the specified activity in the order. Use the GET /orders/{orderUuid}/activities/{activityUuid}/tickets/{ticketId} endpoint to download each ticket.

Request
path Parameters
orderUuid
required
string <uuid>

The order UUID.

activityUuid
required
string <uuid>

The UUID of the activity.

header Parameters
Accept-Language
string (Language code)
Default: en-US

The value of this parameter might affect the language of the content in the response, provided a translation in the requested language is available.

X-Musement-Application
string (Application value)

A partner's application value, used for analyzing API usage and to identify areas of improvement.

X-Musement-Version
string^[0-9]+?.[0-9]+?.[0-9]+?$

The API version to use for the request.

When absent, the latest version is used by default, however the latest version may not be stable. Partners are encouraged to use the latest stable version: 3.4.0.

Example: 3.4.0
Responses
200

Tickets for activity in order

404

Not found: order or activity do not exist or no tickets are available

default

Error

get/orders/{orderUuid}/activities/{activityUuid}/tickets
Request samples
curl -i -X GET \
  'https://sandbox.musement.com/api/v3/orders/{orderUuid}/activities/{activityUuid}/tickets' \
  -H 'Accept-Language: en-US' \
  -H 'X-Musement-Application: string' \
  -H 'X-Musement-Version: 3.4.0'
Response samples
application/json
[
  • {
    }
]

Get PDF ticket for product in order

Returns a PDF for a single reserved activity product in the specified order.

Request
path Parameters
orderUuid
required
string <uuid>

The order UUID.

activityUuid
required
string <uuid>

The UUID of the activity.

ticketId
required
string

The Base64 encoded ticket ID.

header Parameters
X-Musement-Application
string (Application value)

A partner's application value, used for analyzing API usage and to identify areas of improvement.

X-Musement-Version
string^[0-9]+?.[0-9]+?.[0-9]+?$

The API version to use for the request.

When absent, the latest version is used by default, however the latest version may not be stable. Partners are encouraged to use the latest stable version: 3.4.0.

Example: 3.4.0
Responses
200

PDF ticket for product in order

404

Not found: order or activity do not exist or ticket is not available

500

Internal server error: unable to create PDF

default

Error

get/orders/{orderUuid}/activities/{activityUuid}/tickets/{ticketId}
Request samples
curl -i -X GET \
  'https://sandbox.musement.com/api/v3/orders/{orderUuid}/activities/{activityUuid}/tickets/{ticketId}' \
  -H 'X-Musement-Application: string' \
  -H 'X-Musement-Version: 3.4.0'
Response samples
application/json
{
  • "code": "9442",
  • "message": "Ticket not available"
}

Get PDF voucher for activity in order

Returns a single PDF with all available tickets/vouchers for the specified activity in the order.

Request
path Parameters
orderUuid
required
string <uuid>

The order UUID.

activityUuid
required
string <uuid>

The UUID of the activity.

header Parameters
X-Musement-Application
string (Application value)

A partner's application value, used for analyzing API usage and to identify areas of improvement.

X-Musement-Version
string^[0-9]+?.[0-9]+?.[0-9]+?$

The API version to use for the request.

When absent, the latest version is used by default, however the latest version may not be stable. Partners are encouraged to use the latest stable version: 3.4.0.

Example: 3.4.0
Responses
200

PDF voucher for activity in order

404

Not found: order or activity do not exist or at least one voucher is not available

500

Internal server error: unable to create PDF

default

Error

get/orders/{orderUuid}/activities/{activityUuid}/voucher
Request samples
curl -i -X GET \
  'https://sandbox.musement.com/api/v3/orders/{orderUuid}/activities/{activityUuid}/voucher' \
  -H 'X-Musement-Application: string' \
  -H 'X-Musement-Version: 3.4.0'
Response samples
application/json
{
  • "code": "9442",
  • "message": "Voucher not available"
}

Get PDF for order item

Returns a single PDF with all available tickets/vouchers for the specified order item.

Request
path Parameters
orderUuid
required
string <uuid>

The order UUID.

orderItemUuid
required
string

Order item identifier

header Parameters
X-Musement-Application
string (Application value)

A partner's application value, used for analyzing API usage and to identify areas of improvement.

X-Musement-Version
string^[0-9]+?.[0-9]+?.[0-9]+?$

The API version to use for the request.

When absent, the latest version is used by default, however the latest version may not be stable. Partners are encouraged to use the latest stable version: 3.4.0.

Example: 3.4.0
Responses
200

PDF for order item

404

Not found: order or order item do not exist or at least one voucher is not available

500

Internal server error: unable to create PDF

default

Error

get/orders/{orderUuid}/items/{orderItemUuid}/voucher
Request samples
curl -i -X GET \
  'https://sandbox.musement.com/api/v3/orders/{orderUuid}/items/{orderItemUuid}/voucher' \
  -H 'X-Musement-Application: string' \
  -H 'X-Musement-Version: 3.4.0'
Response samples
application/json
{
  • "code": "9442",
  • "message": "Voucher not available"
}

Get external PDF for order item

Returns a single PDF with all externally sourced tickets/vouchers for the specified order item.

Request
path Parameters
orderUuid
required
string <uuid>

The order UUID.

orderItemUuid
required
string

Order item identifier

header Parameters
X-Musement-Application
string (Application value)

A partner's application value, used for analyzing API usage and to identify areas of improvement.

X-Musement-Version
string^[0-9]+?.[0-9]+?.[0-9]+?$

The API version to use for the request.

When absent, the latest version is used by default, however the latest version may not be stable. Partners are encouraged to use the latest stable version: 3.4.0.

Example: 3.4.0
Responses
200

External PDF for order item

404

Not found: order or order item do not exist

409

Conflict: order item has no external vouchers or unable to get external voucher

default

Error

get/orders/{orderUuid}/items/{orderItemUuid}/vouchers-external
Request samples
curl -i -X GET \
  'https://sandbox.musement.com/api/v3/orders/{orderUuid}/items/{orderItemUuid}/vouchers-external' \
  -H 'X-Musement-Application: string' \
  -H 'X-Musement-Version: 3.4.0'
Response samples
application/json
{
  • "code": "9442",
  • "message": "Voucher not available"
}