Pricing Management Software Integration Guide

Overview of Integration

Resly Open API provides comprehensive tools and endpoints for managing the rates and restrictions. By combining REST API requests with webhooks, you can maintain a seamless and efficient connection to the Resly system.

Key Features:

• Retrieve account information.
• Access current inventory, rates, and restrictions.
• Update rates and restrictions.

Retrieving Account Information

Description

The first step in integration is to retrieve existing account information data. This includes:

• Rooms
• Room Types
• Rate Plans
• Reservations
• Blocks

Recommended Workflow

1. Initial Data Retrieval: Use GET requests to retrieve the current setup data.
   • Endpoint Example: /room-types (retrieve room types)
2. Receive Updates: After the initial retrieval, use webhooks to stay updated on any changes in the setup.
   • Webhook Example:
     JSON

     {
       "reslyAccountId": "resly-hotel",
       "reslyWebhookType": "roomType",
       "roomTypeId": "1B-GARDEN",
       "roomTypeName": "1 Bedroom Garden Apartment",
       "status": "active",
       "description": "",
       "bedroomCount": 1,
       "bathroomCount": 1,
       "bedCount": 1,
       "roomSize": 100,
       "masterRate": 999,
       "minRate": 100,
       "includedOccupancy": 2,
       "maximumOccupancy": 3,
       "isIndividualProperty": false,
       "address": "",
       "city": "",
       "state": "",
       "postCode": "",
       "country": "",
       "lat": 0,
       "lng": 0,
       "licenseNumber": ""
     }
     

For more information about keeping reservation updated, check out this guide.

Retrieving Current Inventory, Rates, and Restrictions

Description

Access current inventory, rates, and restrictions to:

• Validate data periodically.
• Ensure accurate pricing and availability.

Workflow

1. Retrieve Inventory: Use the GET /room-types/{roomTypeId}/inventory endpoint.
2. Retrieve Rates and Restrictions: Use the GET /rate-plans/{ratePlanId}/rates-and-restrictions endpoints.

Tips

• Periodically validate the data to avoid discrepancies.
• Use caching to minimize API requests while ensuring timely updates.

Updating Rates and Restrictions

Description

Rates and restrictions can be updated via POST requests. All updates must be based on a rate plan.

Workflow

1. Prepare Update Data: Structure the request body with rate or restriction data.

   • Example Payload:
     JSON

     {
         "restrictions": [
             {
                 "date": "2024-12-25",
                 "rate": 123,
                 "stopSell": true,
                 "cta": false,
                 "ctd": true
             },
             {
                 "date": "2024-12-26",
                 "minStay": 3,
                 "maxStay": 30
             },
             {
                 "date": "2024-12-27",
                 "rate": -321
             }
         ],
         "echoToken": "ECHO-TOKEN"
     }
     

2. POST Request: Send the data to the endpoint /rate-plans/{ratePlanId}/rates-and-restrictions.

   • Headers: Ensure authentication headers are included.

❗️

The rates cannot be updated on derived rate plans.

3. Response: The response data will include the update status for each date. If the update is failed, an error message can be found under the object.

• Example Response

{
  "result": [
    {
      "success": true,
      "date": "2024-12-25",
      "rate": 123,
      "stopSell": true,
      "cta": false,
      "ctd": true
    },
    {
      "success": true,
      "date": "2024-12-26",
      "minStay": 3,
      "maxStay": 30
    },
    {
      "success": false,
      "date": "2024-12-27",
      "errorMessage": "Invalid rate value."
    }
  ],
  "stats": {
    "success": 2,
    "failed": 1
  },
  "echoToken": "ECHO-TOKEN"
}

Additional Recommendations

• Authentication: Use your API key to authenticate all requests.
• Rate Limits: Be mindful of API rate limits to avoid throttling.
• Error Handling: Implement robust error handling for network or data issues.
• Documentation Reference: Refer to the Resly Open API documentation for detailed endpoint specifications.

Conclusion

By following this guide, you can integrate Resly’s Pricing Management APIs seamlessly into your system, ensuring smooth operations and accurate data synchronization. For further assistance, contact Resly support or refer to the full API documentation.