Concepts

Product Listings

The product catalog returns product listings along with the product variations for each listing. A listing is either for homestay in a particular region. For example, a homestay listing in the Atlanta area:

{
  //...
  "listingName": "Atlanta",
  "listingType": "Homestay",
  //...
}

Or a host matching add on service:

{
  //...
  "listingName": "Matching Fee",  
  "listingType": "Add-On",
  //...
}

Product Variations

Each listing will have one or more variations. A variation represents a different level or term of service. E.g.

{
  //...
  "productName": "Atlanta Homestay - SRS Guardian Monthly",  
  "productVariation": "Homestay Guardian",  
  "rateVariation": "Monthly",
  //...
}
// VS.
{
  //...
  "productName": "Atlanta Homestay - SRS Pro Weekly",  
  "productVariation": "Homestay Pro",  
  "rateVariation": "Weekly",
  //...
}

{
  //...
  "productName": "Matching Fee (Expedited)",  
  "productVariation": "Matching Fee",  
  "rateVariation": "Unit",
  //...
}
// VS.
{
  //...
  "productName": "Matching Fee (Standard)",  
  "productVariation": "Matching Fee",  
  "rateVariation": "Unit",
  //...
}

Invoice Rate

Each variation will also have a unique product id that identifies that specific product in our system as well as an invoice rate. The invoice rate specifies the cost of the product and what term it covers. Currency values are given in whole cents. So for example:

{
  //...
  "productId": "20231002-235452845-bb10-4180de70bc63",  
  "invoiceRate": {  
      "periodPrice": {  
          "currencyCode": "USD",  
          "amount": 201000  
      },  
      "periodLength": 28,  
      "periodType": "night"  
  }
  //...
}

Represents a product which costs $2,010 per 28 nights. SRS supports prorated pricing but weekly rates are used for stays less than 28 nights.