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

get/orders/{orderUuid}/activities/{activityUuid}/tickets

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
activityUuid
required
string <uuid>

The UUID of the activity.

orderUuid
required
string <uuid>

The order UUID.

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.

For more info, check out our guide.
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
For more info, check out our guide.
Responses
200

Tickets for activity in order

404

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

default

Error

Request samples 
Response samples 
application/json
[
  • {
    }
]
Get PDF ticket for product in order
get/orders/{orderUuid}/activities/{activityUuid}/tickets/{ticketId}
Returns a PDF for a single reserved activity product in the specified order.


Request 
path Parameters
activityUuid
required
string <uuid> 
The UUID of the activity.


 
orderUuid
required
string <uuid> 
The order UUID.


 
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.


 
For more info, check out our guide.
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
For more info, check out our guide.
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


Request samples 
Response samples 
application/json
{
  • "code": "9442",
  • "message": "Ticket not available"
}
Get PDF voucher for activity in order
get/orders/{orderUuid}/activities/{activityUuid}/voucher
Returns a single PDF with all available tickets/vouchers for the specified activity in the order.


Request 
path Parameters
activityUuid
required
string <uuid> 
The UUID of the activity.


 
orderUuid
required
string <uuid> 
The order UUID.


 
header Parameters
X-Musement-Application
string (Application value) 
A partner's application value, used for analyzing API usage and to identify areas of improvement.


 
For more info, check out our guide.
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
For more info, check out our guide.
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


Request samples 
Response samples 
application/json
{
  • "code": "9442",
  • "message": "Voucher not available"
}
Get PDF for order item
get/orders/{orderUuid}/items/{orderItemUuid}/voucher
Returns a single PDF with all available tickets/vouchers for the specified order item.


Request 
path Parameters
orderItemUuid
required
string
Order item identifier


 
orderUuid
required
string <uuid> 
The order UUID.


 
header Parameters
X-Musement-Application
string (Application value) 
A partner's application value, used for analyzing API usage and to identify areas of improvement.


 
For more info, check out our guide.
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
For more info, check out our guide.
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


Request samples 
Response samples 
application/json
{
  • "code": "9442",
  • "message": "Voucher not available"
}
Get external PDF for order item
get/orders/{orderUuid}/items/{orderItemUuid}/vouchers-external
Returns a single PDF with all externally sourced tickets/vouchers for the specified order item.


Request 
path Parameters
orderItemUuid
required
string
Order item identifier


 
orderUuid
required
string <uuid> 
The order UUID.


 
header Parameters
X-Musement-Application
string (Application value) 
A partner's application value, used for analyzing API usage and to identify areas of improvement.


 
For more info, check out our guide.
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
For more info, check out our guide.
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


Request samples 
Response samples 
application/json
{
  • "code": "9442",
  • "message": "Voucher not available"
}