{"type":"doc","content":[{"type":"extension","attrs":{"layout":"default","extensionType":"com.atlassian.confluence.macro.core","extensionKey":"toc","parameters":{"macroParams":{"style":{"value":"none"}},"macroMetadata":{"macroId":{"value":"10bea51c-ae3c-45a5-b02e-66cc34d7399a"},"schemaVersion":{"value":"1"},"title":"Table of Contents"}},"localId":"d2883b2f-9eed-4dff-a988-2cd486e01b26"}},{"type":"heading","attrs":{"level":1},"content":[{"text":"Introduction","type":"text"}]},{"type":"paragraph","content":[{"text":"This documentation outlines the integration between MXTS client and Swikly, a French deposit management service. It covers the technical details required for your implementation and provides information to configure the integration.","type":"text"}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"1. Overview","type":"text"}]},{"type":"paragraph","content":[{"text":"This integration allows MXTS clients to automatically trigger deposit requests via Swikly implementation. The integration uses a system of add-ons and notification tasks within Maxxton and leverages API calls between Swikly and Maxxton.","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"2. Key Concepts","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph"},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Add-ons:","type":"text","marks":[{"type":"strong"}]},{"text":" In Maxxton, add-ons are used to represent extra services or charges associated with a reservation. This integration uses two key add-ons:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Caution Swikly en attente","type":"text","marks":[{"type":"code"}]},{"text":" (Pending Swikly Deposit):","type":"text","marks":[{"type":"strong"}]},{"text":" This add-on is ","type":"text"},{"text":"automatically","type":"text","marks":[{"type":"em"}]},{"text":" applied to reservations based on pre-defined business rules. It indicates that a Swikly deposit request needs to be initiated. This add-on is ","type":"text"},{"text":"internal only","type":"text","marks":[{"type":"em"}]},{"text":" and not visible to the guest.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Caution Swikly enregistrée","type":"text","marks":[{"type":"code"}]},{"text":" (Registered Swikly Deposit):","type":"text","marks":[{"type":"strong"}]},{"text":" This add-on is applied ","type":"text"},{"text":"automatically","type":"text","marks":[{"type":"em"}]},{"text":" by Swikly (via API) when the guest successfully completes the deposit pre-authorisation.","type":"text"}]}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Reservation ID:","type":"text","marks":[{"type":"strong"}]},{"text":" A unique identifier for each reservation within Maxxton. This is crucial for linking the reservation to the Swikly deposit request.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Reservation Number:","type":"text","marks":[{"type":"strong"}]},{"text":" A human-readable reservation identifier. While the ","type":"text"},{"text":"reservationId","type":"text","marks":[{"type":"code"}]},{"text":" is used internally, the ","type":"text"},{"text":"reservationNumber","type":"text","marks":[{"type":"code"}]},{"text":" is preferred for customer-facing communication.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"API Users:","type":"text","marks":[{"type":"strong"}]},{"text":" Within Maxxton, API Users are created to grant external systems (like Swikly) access to the Maxxton API. Permissions are carefully controlled by the client. ","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Pick-up Desk Card:","type":"text","marks":[{"type":"strong"}]},{"text":" A setting on the add-ons to make sure that it will be displayed in the pick-up desk in the front office. This helps to follow if deposit have been processed or not by Swikly. ","type":"text"}]}]}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"2. Workflow","type":"text"}]},{"type":"paragraph","content":[{"text":"The integration follows this general workflow:","type":"text"}]},{"type":"orderedList","attrs":{"order":1},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Reservation creation:","type":"text","marks":[{"type":"strong"}]},{"text":" A guest makes a reservation through your website or call center create a reservation on MXTS. ","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Add-on application (Maxxton):","type":"text","marks":[{"type":"strong"}]},{"text":" Based on pre-configured business rules (e.g., accommodation type, presence of specific add-ons like \"Refrigerator\"), the ","type":"text"},{"text":"Caution Swikly en attente","type":"text","marks":[{"type":"code"}]},{"text":" add-on is automatically applied to the reservation ","type":"text"},{"text":"internally","type":"text","marks":[{"type":"em"}]},{"text":". This add-on is configured with a \"Pick-up desk\".","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Email trigger (Maxxton):","type":"text","marks":[{"type":"strong"}]},{"text":" A transactional email is automatically sent to the guest. This email contains a unique Swikly URL that allow the guest to secure the deposit on Swikly platform. ","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Guest Pre-authorisation (Swikly):","type":"text","marks":[{"type":"strong"}]},{"text":" The guest clicks the link in the email and is redirected to Swikly to complete the deposit pre-authorisation.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"API Update (Swikly to Maxxton):","type":"text","marks":[{"type":"strong"}]},{"text":" Upon successful pre-authorisation, Swikly uses the Maxxton API to:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Add the ","type":"text"},{"text":"Caution Swikly enregistrée","type":"text","marks":[{"type":"code"}]},{"text":" add-on to the reservation.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Remove the ","type":"text"},{"text":"Caution Swikly en attente","type":"text","marks":[{"type":"code"}]},{"text":" add-on from the reservation.","type":"text"}]}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Check-in Process (Maxxton):","type":"text","marks":[{"type":"strong"}]},{"text":" During check-in, staff can see the deposit status:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"If ","type":"text"},{"text":"Caution Swikly enregistrée","type":"text","marks":[{"type":"code"}]},{"text":" is present, the deposit is secured.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"If ","type":"text"},{"text":"Caution Swikly en attente","type":"text","marks":[{"type":"code"}]},{"text":" is still present, a warning pop-up can be configured (requires Maxxton development) to alert staff. Staff can also check the \"Pick-up desk\" dashboard.","type":"text"}]}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Reminders (Maxxton):","type":"text","marks":[{"type":"strong"}]},{"text":" Maxxton can be configured to send automated reminder emails to guests if the ","type":"text"},{"text":"Caution Swikly en attente","type":"text","marks":[{"type":"code"}]},{"text":" add-on is still present a certain number of days before arrival.","type":"text"}]}]}]},{"type":"paragraph"},{"type":"heading","attrs":{"level":1},"content":[{"text":"3. Implementation Details","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"3.1 Maxxton Configuration","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Add-ons:","type":"text","marks":[{"type":"strong"}]},{"text":" Create the following two add-ons in Maxxton:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Caution Swikly en attente","type":"text","marks":[{"type":"code"}]},{"text":":","type":"text","marks":[{"type":"strong"}]}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Internal Bill:","type":"text","marks":[{"type":"strong"}]},{"text":" Ensure this add-on is marked for the \"Internal Bill\" so it's not visible to the guest.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Pick-up Desk Card:","type":"text","marks":[{"type":"strong"}]},{"text":" Configure a \"Pick-up desk\" card for this add-on.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Mandatory link:","type":"text","marks":[{"type":"strong"}]},{"text":" Configure rules to automatically apply this add-on based on your business requirements (e.g., specific accommodation types, presence of other add-ons). Example: Add when \"Fridge\" is present for \"Resort A\" accommodations or when a chalet is booked in “Resort B”","type":"text"}]}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Caution Swikly enregistrée","type":"text","marks":[{"type":"code"}]},{"text":":","type":"text","marks":[{"type":"strong"}]}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Internal Bill:","type":"text","marks":[{"type":"strong"}]},{"text":" Ensure this add-on is marked for the \"Internal Bill\" so it's not visible to the guest.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Pick-up Desk Card:","type":"text","marks":[{"type":"strong"}]},{"text":" Configure a \"Pick-up desk\" card for this add-on.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Additional link: ","type":"text","marks":[{"type":"strong"}]},{"text":"Configure rules to be available on all the same rules configure in the mandatory link of the previous add-on. ","type":"text"}]}]}]}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Transactional Email:","type":"text","marks":[{"type":"strong"}]}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Include a Swikly URL in the email template. This URL should be dynamically generated and include the necessary reservation information. See section 3.2 for details.","type":"text"}]}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Info-Text (Optional - Requires Maxxton Development):","type":"text","marks":[{"type":"strong"}]}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Implement a pop-up warning that appears when staff attempts to check in a reservation that still has the ","type":"text"},{"text":"Caution Swikly en attente","type":"text","marks":[{"type":"code"}]},{"text":" add-on.","type":"text"}]}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Task scheduling (for email reminder):","type":"text","marks":[{"type":"strong"}]}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Create a transactional email rule that triggers when the ","type":"text"},{"text":"Caution Swikly en attente","type":"text","marks":[{"type":"code"}]},{"text":" add-on is present.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Use the notification module to configure a scheduled task.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Set the condition to trigger X days before arrival IF the ","type":"text"},{"text":"Caution Swikly en attente","type":"text","marks":[{"type":"code"}]},{"text":" add-on is present.","type":"text"}]}]}]}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"3.2 Swikly URL Generation","type":"text"}]},{"type":"paragraph","content":[{"text":"The URL you include in the transactional email is critical for linking the Swikly deposit request to the correct reservation and accommodation within Maxxton. We recommend using a combined identifier for enhanced security.","type":"text"}]},{"type":"paragraph","content":[{"text":"Recommended Format:","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"https://pms.swikly.com/secure/[reservationId][reservedResourceId]","type":"text","marks":[{"type":"code"}]}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"[reservationId]","type":"text","marks":[{"type":"code"}]},{"text":":","type":"text","marks":[{"type":"strong"}]},{"text":" The unique numerical identifier for the overall reservation in Maxxton.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"[reservedResourceId]","type":"text","marks":[{"type":"code"}]},{"text":":","type":"text","marks":[{"type":"strong"}]},{"text":" The unique numerical identifier for the ","type":"text"},{"text":"specific reserved resource","type":"text","marks":[{"type":"em"}]},{"text":" (e.g., a particular accommodation unit within the reservation or add-ons) that requires the deposit. This is crucial for handling cases where a single reservation includes multiple accommodations and add-ons, each requiring its own deposit. You obtain this ID from the ","type":"text"},{"text":"reservedResources","type":"text","marks":[{"type":"code"}]},{"text":" array in the API response.","type":"text"}]}]}]},{"type":"paragraph","content":[{"text":"Why this format is important:","type":"text","marks":[{"type":"strong"}]}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Security:","type":"text","marks":[{"type":"strong"}]},{"text":" Using a combined identifier makes it significantly harder for someone to guess valid URLs and potentially access unauthorised deposit information. Using just the ","type":"text"},{"text":"reservationId","type":"text","marks":[{"type":"code"}]},{"text":" would be less secure.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Multiple Deposits per Reservation:","type":"text","marks":[{"type":"strong"}]},{"text":" The ","type":"text"},{"text":"reservedResourceId","type":"text","marks":[{"type":"code"}]},{"text":" ensures that each deposit request is correctly linked to the specific accommodation unit within a reservation. This is essential if a guest books multiple units, each with its own deposit requirement.","type":"text"}]}]}]},{"type":"paragraph","content":[{"text":"Example:","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"Let's say:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"reservationId","type":"text","marks":[{"type":"code"}]},{"text":" is ","type":"text"},{"text":"39624032","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"The ","type":"text"},{"text":"reservedResourceId","type":"text","marks":[{"type":"code"}]},{"text":" for the specific accommodation requiring a deposit is ","type":"text"},{"text":"45454370","type":"text","marks":[{"type":"code"}]}]}]}]},{"type":"paragraph","content":[{"text":"The generated Swikly URL would be:","type":"text"}]},{"type":"paragraph","content":[{"text":"https://pms.swikly.com/secure/3962403245454370","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"Implementation Notes:","type":"text","marks":[{"type":"strong"}]}]},{"type":"orderedList","attrs":{"order":1},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"API Response:","type":"text","marks":[{"type":"strong"}]},{"text":" You'll need to extract both the ","type":"text"},{"text":"reservationId","type":"text","marks":[{"type":"code"}]},{"text":" and the correct ","type":"text"},{"text":"reservedResourceId","type":"text","marks":[{"type":"code"}]},{"text":" from the Maxxton API response. Remember to filter the ","type":"text"},{"text":"reservedResources","type":"text","marks":[{"type":"code"}]},{"text":" array to find the entry with ","type":"text"},{"text":"resourceId: XXXX","type":"text","marks":[{"type":"code"}]},{"text":" (the deposit add-on) and then use its ","type":"text"},{"text":"parentId","type":"text","marks":[{"type":"code"}]},{"text":" to find the associated accommodation's or add-ons","type":"text"},{"text":"reservedResourceId","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"3.3 API Integration (Swikly to Maxxton)","type":"text"}]},{"type":"paragraph","content":[{"text":"Swikly will use the Maxxton API to update the reservation status after the guest completes the deposit. This requires:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"OAuth 2.0 Authentication:","type":"text","marks":[{"type":"strong"}]},{"text":" Swikly will authenticate using OAuth 2.0. MXTS client will need to create API Users within Maxxton.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"API Endpoints:","type":"text","marks":[{"type":"strong"}]},{"text":" Swikly will primarily use the endpoint to add and remove add-ons: ","type":"text"},{"text":"/maxxton/v1/reservations/:reservationId/details?returnBill=true&returnCustomer=true&returnReservedResources=true","type":"text","marks":[{"type":"code"}]},{"text":" (and likely a POST/PUT method to modify the ","type":"text"},{"text":"reservedResources","type":"text","marks":[{"type":"code"}]},{"text":" array).","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Permissions:","type":"text","marks":[{"type":"strong"}]},{"text":" MXTS client must grant the Swikly API User the necessary permissions to:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Read reservation details.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Add and remove add-ons.","type":"text"}]}]}]}]}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"4. Client Implementation Guide","type":"text"}]},{"type":"paragraph","content":[{"text":"This section provides instructions for MXTS user to configure the Swikly integration within their Maxxton environment.","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"4.1 Creating an API User for Swikly","type":"text"}]},{"type":"orderedList","attrs":{"order":1},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Log in to Maxxton","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Navigate to Integrations Manager:","type":"text","marks":[{"type":"strong"}]},{"text":" Go to the Integration module and then to \"API Users.\"","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Create a New API User:","type":"text","marks":[{"type":"strong"}]}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Click \"Add integration\"","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Select “REST API”","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Then select “OTHER”","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Provide a Product name (e.g., \"Swikly Integration\"), language, login and email.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Important:","type":"text","marks":[{"type":"strong"}]},{"text":" Carefully configure the permissions. Swikly needs access to:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"You can also limit the API user to one DC and RC or all. ","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Everything for RESERVATION","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"RESORTS: GET","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"ADD_ONS: GET","type":"text"}]}]}]}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Save the API Key:","type":"text","marks":[{"type":"strong"}]},{"text":" Maxxton will generate an API key. Provide this key to Swikly. This key is sensitive and should be treated like a password.","type":"text"}]}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"4.2 Creating the deposit add-ons","type":"text"}]},{"type":"paragraph","content":[{"text":"Create two add-ons on the highest level possible of your tree location structure. We suggest to create an add-on type for this specefic add-ons.","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Create add-on type: ","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Go to content manager","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Click on Add-ons tab","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"On the top right click on “Manage add-on types”","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Click on “New add-on type” if a deposit add-on type is not yet created","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Enter the name desired and code and finally the type should be “fees”","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Do not toggle anything else and if there is already an add-on type deposit make sure to toggle it off. ","type":"text"}]}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Create add-on ","type":"text","marks":[{"type":"strong"}]},{"text":"Caution Swikly en attente","type":"text","marks":[{"type":"code"}]},{"text":":","type":"text","marks":[{"type":"strong"}]}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Go to content manager","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Click on Add-ons tab","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"On the top right click on “Create add-on”","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Choose the highest level location where you wish the ability to have the deposit managed by Swikly. For example if you want deposit managed only on French resort create it at this level. ","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Select the add-on type created previously","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Do not select any parents (not needed)","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Name: ","type":"text"},{"text":"Caution Swikly en attente","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Code: input a code that you want","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Leave the two toggles like they are by default. ","type":"text"},{"text":"Or toggle off the first one if you use DC groups.","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Click “next step”","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Here you can add the translation for all the languages supported on the concern. ","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Toggle on the “Configure pick up desk or moment”","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Select one of the pick up desk configured and that the Reception on park will check. ","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Select the distribution moment (this is used to manage when this add-on will show on the front office, either for example it check if at check-in desk this add-on is on the reservation. Select check-in and checkout in case you have cases where extra deposit can be added during the stay. ","type":"text"}]}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"The add-on is created extra configuration are still needed to complete the configuration. ","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Representation (if DC groups configuration): ","type":"text","marks":[{"type":"strong"}]}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Click on “create representation” ","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Fill the all the fields as you want (not impactful)","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Click on “Next step”","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Select “link distribution channel group”","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Then select the DC groups you which this Add-on to be available. In general you should try to be the most general to have access to this add-on and match the business rules setup on the next configuration of mandatory link. ","type":"text"}]}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Rate: ","type":"text","marks":[{"type":"strong"}]}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Click on “create rate”","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Select “fixed rate”","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Input a value in the field “rate”","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Select “valid from today” or “valid from a specefic period” (if you want this add-on to be available in a specefic period.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Click “next step”","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Choose the rate type. For most cases, applying the rate to all rate types is recommended, especially if you don't use multiple currencies. If you have different rates for the same accommodation, select the rate types individually. Note: Selecting individual types requires you to create a separate rate for each applicable rate type.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Click “next step”","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"This part is useful only if you wish to configure different names on the bill instead of using the name of the add-ons. The other settings are for special uses cases and we do not recommend to use them unless forced. ","type":"text"}]}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Linked accommodation types:","type":"text","marks":[{"type":"strong"}]}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"For this add-on we need to create a mandatory link via the Mandatory add-ons tab. ","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Click “Link accommodation types”","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Select the accommodation where you expect this add-on to be added automatically if they are booked. ","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Click “Next step”","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Here you have to select all the rate type you expect this add-ons link to work with. But if there is rates using a specific rate type please also add it here. The idea is if there is a rate type selected here and it needs to be used on a reservation the rates configured previously has to manage this rate type. ","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Click “Next step”","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Select the period on wish the add-ons need to be added automatically. ","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Click “Next step”","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Toggle “None of the above”","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Toggle off “Show price on bill”","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Toggle on “Required”","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Toggle on “Removable from booking”","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Toggle off “add once in reservation”","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Toggle on “Ignore rentability of add-on rentability”","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Leave the rest toggle off","type":"text"}]}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Click “Next step”","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Check the final window and if everything is correct validate this link by clicking on “Link accommodation types”","type":"text"}]}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"We have now the first add-on created and the logic to where this add-ons need to be added has been managed via the mandatory link. And we can have different rates per accommodation type via the rates configuration. Depending on what is selected in the rates you can for example have a rate of 100 for all chalets and 50 for pitch. ","type":"text"}]}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Create add-on ","type":"text"},{"text":"Caution Swikly enregistrée","type":"text","marks":[{"type":"code"}]},{"text":":","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"Follow the same configuration as previous add-ons. You only need to set a single rate of 0; Swikly will then input a custom amount when this add-on is added to the reservation. Additionally, enable the 'Customise name or rate' setting for this add-on to allow Swikly to input the secured amount from the reservation.\"","type":"text"}]},{"type":"paragraph","content":[{"text":"The only change affects accommodation linking. You must now associate accommodations using the 'additional bookable add-ons' tab. If the first add-on created links to an accommodation, subsequent add-ons must also be linked through this method.","type":"text"},{"type":"hardBreak"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"4.3 Creating the template","type":"text"}]},{"type":"paragraph","content":[{"text":"You will need to create a code template. ","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Go to Notification Manager","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"click on “templates”","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"On the top right click “Create template”","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Input a name for the template","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Select a folder to manage neatly your templates","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Type should be “Template” (depending on the way you manage templates)","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"The rest should be left as default. ","type":"text"}]}]}]},{"type":"paragraph","content":[{"text":"Now you will need to create a report and link this template to it. This can be done on MXTS in the same module via the “reports” tab. ","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Click on “reports” tab. ","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"CLick on the top right “Create report”","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Input a name and code","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"In report viability select “reservation” ","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Once created click on “Create report output”","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Select “Email template”","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Then find the tempalte previously created and finish by clicking “Create output”","type":"text"}]}]}]},{"type":"paragraph","content":[{"text":"Back on the template you created:","type":"text"}]},{"type":"paragraph","content":[{"text":"You should fill in the Subject for all languages setup on the concern and finally in the content you should have the logic that generate the URL and also any design you wish.","type":"text"}]},{"type":"paragraph","content":[{"text":"Here is the logic to manage the links:","type":"text"}]},{"type":"codeBlock","content":[{"text":"\n\n\n Swikly Links\n \n\n\n

Swikly Payment Links

\n\n

\n #set($linksGenerated = false)\n #foreach($resource in $reservedResourceList)\n #if($resource.resource_id == \"444001\")\n #foreach($potentialParent in $reservedResourceList)\n #if($potentialParent.reservedresource_id == $resource.parent_id && ($potentialParent.type == \"accommodationtype\" || $potentialParent.type == \"extra\" || $potentialParent.type == \"producttype\"))\n #set($productName = $potentialParent.name)\n\n

\n \n Swikly Link for: $productName\n \n

\n #set($linksGenerated = true)\n #break\n #end\n #end\n #end\n #end\n\n #if(!$linksGenerated)\n

ERROR LINK NOT GENREATED

\n #end\n

\n\n","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"4.4 Creating the task","type":"text"}]},{"type":"paragraph","content":[{"text":"We will share here how to manage the automation of sending emails to the customer. This part depends on the business use cases of the client. But generally we recommend sending multiple emails via multiple task depending on the day before the arrival.","type":"text"}]},{"type":"paragraph","content":[{"text":"Example of task to send emails for test purposes as there is delta to the arrival date used. ","type":"text"}]},{"type":"paragraph","content":[{"text":"This will check everyday if there is reservation following these requirement, arrival in 30 days and has the add-on ","type":"text"},{"text":"Caution Swikly en attente","type":"text","marks":[{"type":"code"}]},{"text":". You can then create multiple task for different days before the arrival. ","type":"text"}]},{"type":"mediaSingle","attrs":{"layout":"center","width":760,"widthType":"pixel"},"content":[{"type":"media","attrs":{"width":1511,"alt":"Screenshot 2025-03-04 at 17.52.35.png","id":"93d160e4-b0d5-42d8-bb5f-e8cc830200fb","collection":"contentId-1719336961","type":"file","height":828}}]},{"type":"paragraph","content":[{"text":"Important considerations for deposit requests:","type":"text","marks":[{"type":"strong"}]}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Reservation Status:","type":"text","marks":[{"type":"strong"}]},{"text":" Automated deposit requests via Swikly should ","type":"text"},{"text":"only","type":"text","marks":[{"type":"em"}]},{"text":" be triggered for reservations with a status of \"Definitive\" (confirmed). Ensure your Maxxton configuration and business rules enforce this. Reservations in other statuses (e.g., \"Option,\" \"Request\") should not trigger the automated Swikly process.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"On-Site Manual Requests:","type":"text","marks":[{"type":"strong"}]},{"text":" For situations where a deposit needs to be collected after the guest has arrived on-site (and the automated process wasn't triggered or was missed), a ","type":"text"},{"text":"manual","type":"text","marks":[{"type":"em"}]},{"text":" email send is required, but the Swikly link within that email ","type":"text"},{"text":"will","type":"text","marks":[{"type":"em"}]},{"text":" be dynamically generated. Staff must:","type":"text"}]},{"type":"orderedList","attrs":{"order":1},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Use a Pre-Configured Email Template:","type":"text","marks":[{"type":"strong"}]},{"text":" Within the reservation \"Communication\", select a pre-configured email template specifically designed for on-site deposit requests. This template ","type":"text"},{"text":"must","type":"text","marks":[{"type":"em"}]},{"text":" include the correct Swikly URL structure, using Maxxton variables to dynamically insert the ","type":"text"},{"text":"reservationId","type":"text","marks":[{"type":"code"}]},{"text":" and ","type":"text"},{"text":"reservedResourceId","type":"text","marks":[{"type":"code"}]},{"text":" (see details below).","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Send via Communication Tab:","type":"text","marks":[{"type":"strong"}]},{"text":" Send the email directly to the guest.","type":"text"}]}]}]}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"4.2 Providing Information to Swikly","type":"text"}]},{"type":"paragraph","content":[{"text":"Swikly will need some information to setup their platform: ","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Your concern id for Swikly (3 letter concern code, example DME)","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"the API key.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"The resourceId of both add-ons: example XXXXXX","type":"text"}]}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"4.4 Test Environment","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Instruct to use the test environment first before using production environment. ","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Share how to create a test account (managed by the client)","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Test environment URL: ","type":"text"},{"text":"http://XXX-test.maxxton.net","type":"text","marks":[{"type":"link","attrs":{"href":"http://XXX-test.maxxton.net"}}]}]}]}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"5. Swikly Deposit Information Retrieval","type":"text"}]},{"type":"paragraph","content":[{"text":"This section details how Swikly can retrieve deposit information from a reservation.","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"5.1 Get the reservation information","type":"text"}]},{"type":"paragraph","content":[{"text":"Swikly should use the following endpoint to get reservation details:","type":"text"}]},{"type":"paragraph","content":[{"text":"/maxxton/v1/reservations/:reservationId/details?returnBill=true&returnCustomer=true&returnReservedResources=true","type":"text","marks":[{"type":"code"}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"5.2 Data Extraction","type":"text"}]},{"type":"orderedList","attrs":{"order":1},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Find the Deposit Add-on:","type":"text","marks":[{"type":"strong"}]},{"text":" Within the ","type":"text"},{"text":"reservedResources","type":"text","marks":[{"type":"code"}]},{"text":" array, locate the object with ","type":"text"},{"text":"resourceId: XXXXXX","type":"text","marks":[{"type":"code"}]},{"text":" (this is the ","type":"text"},{"text":"Caution Swikly en attente","type":"text","marks":[{"type":"code"}]},{"text":" add-on).","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Get the Deposit Amount:","type":"text","marks":[{"type":"strong"}]},{"text":" The ","type":"text"},{"text":"price","type":"text","marks":[{"type":"code"}]},{"text":" field within this object represents the deposit amount.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Link to Accommodation/add-ons:","type":"text","marks":[{"type":"strong"}]},{"text":" The ","type":"text"},{"text":"parentId","type":"text","marks":[{"type":"code"}]},{"text":" field of the deposit add-on points to the ","type":"text"},{"text":"reservedResourceId","type":"text","marks":[{"type":"code"}]},{"text":" of the associated accommodation or add-ons.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Retrieve Accommodation/add-ons Details:","type":"text","marks":[{"type":"strong"}]},{"text":" Find the ","type":"text"},{"text":"reservedResource","type":"text","marks":[{"type":"code"}]},{"text":" object where ","type":"text"},{"text":"reservedResourceId","type":"text","marks":[{"type":"code"}]},{"text":" matches the ","type":"text"},{"text":"parentId","type":"text","marks":[{"type":"code"}]},{"text":" from step 3. This object contains:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"type","type":"text","marks":[{"type":"code"}]},{"text":": Should be \"ACCOMMODATIONTYPE\" or “PRODUCTTYPE”","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"unit.translations","type":"text","marks":[{"type":"code"}]},{"text":": Contains the unit name (e.g., \"C008\"). Use the object where ","type":"text"},{"text":"\"language\": \"fr\"","type":"text","marks":[{"type":"code"}]},{"text":" for the French name.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"translations","type":"text","marks":[{"type":"code"}]},{"text":": Contains the accommodation type name (e.g., \"Bungalow 4/5p clim ***\"). Use the object where ","type":"text"},{"text":"\"language\": \"fr\"","type":"text","marks":[{"type":"code"}]},{"text":" for the French name. ","type":"text"}]}]}]}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"5.3 Delete add-on once secured","type":"text"}]},{"type":"paragraph","content":[{"text":"After a guest successfully secures a deposit via Swikly, Swikly ","type":"text"},{"text":"must","type":"text","marks":[{"type":"em"}]},{"text":" update the Maxxton reservation to reflect this. This involves two API calls: removing the ","type":"text"},{"text":"Caution Swikly en attente","type":"text","marks":[{"type":"code"}]},{"text":" add-on and adding the ","type":"text"},{"text":"Caution Swikly enregistrée","type":"text","marks":[{"type":"code"}]},{"text":" add-on.","type":"text"}]},{"type":"paragraph","content":[{"text":"Step 1: Remove the ","type":"text","marks":[{"type":"strong"}]},{"text":"Caution Swikly en attente","type":"text","marks":[{"type":"code"}]},{"text":" Add-on","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"API Endpoint (Removal):","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"/maxxton/v1/reservations/:reservationId/reservedresources/:reservedResourceId","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"Method:","type":"text","marks":[{"type":"strong"}]},{"text":" ","type":"text"},{"text":"DELETE","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"Steps:","type":"text","marks":[{"type":"strong"}]}]},{"type":"orderedList","attrs":{"order":1},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Identify the Correct ","type":"text","marks":[{"type":"strong"}]},{"text":"reservedResourceId","type":"text","marks":[{"type":"code"}]},{"text":" and ","type":"text","marks":[{"type":"strong"}]},{"text":"resourceId","type":"text","marks":[{"type":"code"}]},{"text":" to Delete:","type":"text","marks":[{"type":"strong"}]}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Extract the ","type":"text"},{"text":"reservationId","type":"text","marks":[{"type":"code"}]},{"text":" and parent ","type":"text"},{"text":"reservedResourceId","type":"text","marks":[{"type":"code"}]},{"text":" from the ","type":"text"},{"text":"combined_identifier","type":"text","marks":[{"type":"code"}]},{"text":" (e.g., ","type":"text"},{"text":"39624032-45454370","type":"text","marks":[{"type":"code"}]},{"text":").","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Use the ","type":"text"},{"text":"reservationId","type":"text","marks":[{"type":"code"}]},{"text":" in the API endpoint URL.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Use the extracted parent ","type":"text"},{"text":"reservedResourceId","type":"text","marks":[{"type":"code"}]},{"text":" to help you find the correct ","type":"text"},{"text":"deposit add-on","type":"text","marks":[{"type":"em"}]},{"text":" to delete.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Get, via the Get endpoint (","type":"text"},{"text":"/maxxton/v1/reservations/:reservationId/details?returnBill=true&returnCustomer=true&returnReservedResources=true","type":"text","marks":[{"type":"code"}]},{"text":"), the list of ","type":"text"},{"text":"reservedResources","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Find, within this list, the add-ons with ","type":"text"},{"text":"resourceId: 502002","type":"text","marks":[{"type":"code"}]},{"text":" (the \"pending\" add-on) ","type":"text"},{"text":"AND","type":"text","marks":[{"type":"em"}]},{"text":" ","type":"text"},{"text":"parentId: reservedResourceId","type":"text","marks":[{"type":"code"}]},{"text":" (matching the parent resource from the combined identifier). You should find exactly one match.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Get the ","type":"text"},{"text":"reservedResourceId","type":"text","marks":[{"type":"code"}]},{"text":" of ","type":"text"},{"text":"that","type":"text","marks":[{"type":"em"}]},{"text":" matching deposit add-on. ","type":"text"},{"text":"This","type":"text","marks":[{"type":"em"}]},{"text":" is the ID you will use in the ","type":"text"},{"text":"DELETE","type":"text","marks":[{"type":"code"}]},{"text":" request.","type":"text"}]}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Construct the API Call:","type":"text","marks":[{"type":"strong"}]},{"text":" Create a ","type":"text"},{"text":"DELETE","type":"text","marks":[{"type":"code"}]},{"text":" request to the endpoint, replacing ","type":"text"},{"text":":reservationId","type":"text","marks":[{"type":"code"}]},{"text":" and ","type":"text"},{"text":":reservedResourceId","type":"text","marks":[{"type":"code"}]},{"text":" with the correct values (the ","type":"text"},{"text":"reservationId","type":"text","marks":[{"type":"code"}]},{"text":" and the ","type":"text"},{"text":"reservedResourceId","type":"text","marks":[{"type":"code"}]},{"text":" of the ","type":"text"},{"text":"add-on","type":"text","marks":[{"type":"em"}]},{"text":" to be deleted).","type":"text"}]},{"type":"paragraph","content":[{"text":"Example: ","type":"text"},{"text":"DELETE /maxxton/v1/reservations/39624032/reservedresources/99999999","type":"text","marks":[{"type":"code"}]},{"text":" (where ","type":"text"},{"text":"99999999","type":"text","marks":[{"type":"code"}]},{"text":" is the ","type":"text"},{"text":"reservedResourceId","type":"text","marks":[{"type":"code"}]},{"text":" of the pending deposit add-on).","type":"text"}]}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"5.4 Add the ","type":"text","marks":[{"type":"strong"}]},{"text":"Caution Swikly enregistrée","type":"text","marks":[{"type":"code"}]},{"text":" Add-on","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"API Endpoint (Addition):","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"/maxxton/v1/reservations/:reservationId/reservedresources/:reservedResourceId/additions","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"Method:","type":"text","marks":[{"type":"strong"}]},{"text":" ","type":"text"},{"text":"POST","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"Steps:","type":"text","marks":[{"type":"strong"}]}]},{"type":"orderedList","attrs":{"order":1},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Prepare the Request Body:","type":"text","marks":[{"type":"strong"}]},{"text":" Construct a JSON request body according to the provided structure. Crucially:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"resourceId","type":"text","marks":[{"type":"code"}]},{"text":": Use the ","type":"text"},{"text":"resourceId","type":"text","marks":[{"type":"code"}]},{"text":" for the ","type":"text"},{"text":"Caution Swikly enregistrée","type":"text","marks":[{"type":"code"}]},{"text":" add-on (you'll need to obtain this ID from your Maxxton configuration).","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"startDate","type":"text","marks":[{"type":"code"}]},{"text":": Use the start date of the ","type":"text"},{"text":"parent","type":"text","marks":[{"type":"em"}]},{"text":" resource (the accommodation or add-on to which the deposit applies). You can get this from the ","type":"text"},{"text":"reservedResources","type":"text","marks":[{"type":"code"}]},{"text":" array in the initial GET request.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"endDate","type":"text","marks":[{"type":"code"}]},{"text":": Use the end date of the ","type":"text"},{"text":"parent","type":"text","marks":[{"type":"em"}]},{"text":" resource.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"quantity","type":"text","marks":[{"type":"code"}]},{"text":": ","type":"text"},{"text":"1","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]},{"type":"paragraph","content":[{"text":"The ","type":"text"},{"text":":reservedResourceId","type":"text","marks":[{"type":"code"}]},{"text":" in ","type":"text"},{"text":"this","type":"text","marks":[{"type":"em"}]},{"text":" endpoint URL should be the ","type":"text"},{"text":"reservedResourceId","type":"text","marks":[{"type":"code"}]},{"text":" of the ","type":"text"},{"text":"parent","type":"text","marks":[{"type":"em"}]},{"text":" resource (the accommodation or add-on), which you extracted from the ","type":"text"},{"text":"combined_identifier","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Construct the API Call:","type":"text","marks":[{"type":"strong"}]},{"text":" Create a ","type":"text"},{"text":"POST","type":"text","marks":[{"type":"code"}]},{"text":" request to the endpoint, replacing ","type":"text"},{"text":":reservationId","type":"text","marks":[{"type":"code"}]},{"text":" and ","type":"text"},{"text":":reservedResourceId","type":"text","marks":[{"type":"code"}]},{"text":" with the correct values, and including the JSON body.","type":"text"}]},{"type":"paragraph","content":[{"text":"Example:","type":"text"}]},{"type":"codeBlock","content":[{"text":"POST /maxxton/v1/reservations/39624032/reservedresources/45454370/additions\n\n[\n {\n \"resourceId\": \"504002\",\n \"startDate\": \"2024-07-26\",\n \"endDate\": \"2024-08-02\",\n \"quantity\": 1,\n \"price\": 100.00,\n }\n]\n\n","type":"text"}]}]}]}],"version":1}

Browser not supported