Catalog

Catalogs are accessed at URL https://api.whenfresh.com/world/gb/addresses/[ADDRESS KEY]/catalog.

The Catalog URL is embedded within each Postal Address resource.

Properties

Property	Expected Type	Description
variables	ItemList	A list of Variables that can be purchased.

Example JSON

{
    "@type" : "Catalog",
    "variables" : [
       {
          "variableId" : "https://api.whenfresh.com/variable/WhenFresh/Property Market/Property Attribute/Property Last Listed as Rented/provenance/Zoopla/Property Attribute",
          "price" : {
             "currency" : "GBP",
             "value" : 0.03
          },
          "@type" : "https://api.whenfresh.com/variable/WhenFresh/Property Market/Property Attribute/Property Last Listed as Rented"
       },
       {
          "@type" : "https://api.whenfresh.com/variable/WhenFresh/Bedrooms/Property Attribute/Bedroom Count Band",
          "price" : {
             "value" : 0.03,
             "currency" : "GBP"
          },
          "variableId" : "https://api.whenfresh.com/variable/WhenFresh/Bedrooms/Property Attribute/Bedroom Count Band/provenance/Zoopla/Property Attribute"
       },
       {
          "variableId" : "https://api.whenfresh.com/variable/WhenFresh/Property Market/Property Attribute/Property Last Listed as To Rent/provenance/Zoopla/Property Attribute",
          "price" : {
             "currency" : "GBP",
             "value" : 0.03
          },
          "@type" : "https://api.whenfresh.com/variable/WhenFresh/Property Market/Property Attribute/Property Last Listed as To Rent"
       },
    ],
    "@id" : "https://api.whenfresh.com/world/GB/addresses/8e05p·0/catalog",
    "@context" : "https://api.whenfresh.com/.hydra/context.jsonld"
 }