How to Set up Musement – External API
Last updated: February 16, 2023
Enabling a new company for the API
Set up the price sheet:
- Create a Musement-specific price sheet. Open the “Online” price sheet, click the edit pencil and duplicate. Name the new sheet “Musement.”
- Uncheck the second box in the price sheet settings that says “This sheet can be used by online customers” and save.
- In the Price Sheet settings, click on the Overview tab and select the Musement sheet under the Prices and visibility menu. This is important so we do not make changes to the base price sheet (which affects online/direct price sheets).
- Do a top-to-bottom review of all customer types that are visible on that price sheet, and hide any that seem unsuitable. Ex: Comps, discounts, gift cards, customer types that are outdated and no longer in use.
- Click on Filter pricing and uncheck the “Hide custom fields” box as well as the “Simple custom fields” box. This will expose all custom fields on both the customer type and whole booking level.
- Do a top-to-bottom review of all required custom fields on the whole booking level and remove the requirement setting for any that are unsuitable. This includes: checkboxes, priced custom fields, discount custom fields, miscellaneous fields like How did you hear about us? etc.
- Add Musement as an affiliate and assign the Musement price sheet. Leave the rest of the affiliate settings blank.
Set up the Invoice Sheet:
- Create a new Billing invoice sheet with the commission specified in the original connection request. If a commission was not provided, you can respond and request it (skip this step until that has been provided).
- Relationship Type: Owed to You
- Insert Commission Percentage. NOTE: If there are different percentages for different items the commission can be set on the item level instead with a 0% commission invoice sheet.
- Select Commission affects tax (For EMEA/APAC) and Commission does not affect tax (for Americas).
- Name this sheet “Billing – [Commission %]” and create the new invoice sheet.
- Example here
Set up the Cancellation Policy
- Create a new cancellation policy and name it “Default – API – Anytime” cancellation policy
- Before 48 hours = 100% refund of both company and affiliate payments.
- Before -100 hours = 0% refund of both company and affiliate payments.
- Example here.
Complete the Affiliate Set Up
- Add the invoice sheet
- Add the “Default – API – Anytime” cancellation policy
- Add the “API External” permissions group
- Remove the “Require a voucher number on bookings” setting
Sign the client up for affiliate booking and cancellation notification emails.
- Example here.
Once the above steps are complete you may reply back to the request email and confirm that API access has been enabled for Musement using the macro “Musement Response to Request to Connect”.