Menu

Bedful Resources

The bedful API exposes all the resources you need to make bedful properties available on your own website. All resources have a unique immutable identifier which is assigned at creation - we call this the ID. Most resources also have other fields like Name or Summary.

Core Resources

The core resources in bedful are those required to reason about properties on the system. All of these (apart from users and channels) are associated with a particular site and unique to that site. The core resources comprise:

  • Sites - sites are bookable properties on the system, for example Campsites, Hotels, Campervan Hire
  • Units - units are the smallest bookable unit of accommodation on the system, for example Pitches, Rooms, Vans
  • Bookings - bookings represent a guest stay at a site, and may have multiple units and extras associated with them
  • Users - users have various roles and may be partners or guests - they are usually subsidiary records

Additional Resources

The additional resources below are not essential for connecting to the Bedful API but may be useful for more advanced usage.

  • Groups - groups associate several units within a site, which may be, for example all Bell Tents or All VW Campervans
  • Seasons - seasons are date ranges which apply to units, rates and extras and control their availability
  • Rates - rates represent pricing structures used by sites
  • Images - images refer to image files uploaded to bedful asset servers - they typically are addressed by hash, unlike other resources
  • Channels – channels represent sources for bookings (Booking systems or Sales Channels like Cool Camping)
  • Tags - tags represent a way of grouping sites or units together based on common attributes, for example England, Adults Only or Wifi

Types

  • Dates - All dates are UTC.  Acceptable formats for date params are either in RFC3339 (JSON date format) or 2020-01-01.
  • Numbers - Numbers like IDs etc are integers
  • Currency - Currency values are given in cents of the given currency