offerings

Get one offering, with the questions guests answer as they book: bookings.create takes their answers, keyed by question id

get/offerings/{id}

Request

  • Base URL: https://daybag.io/api/v1
  • URL: https://daybag.io/api/v1/offerings/{id}
  • Auth: HTTP bearer

Path parameters

idstring uuid required

Response

Success

idstring required
org_idstring required
kind'class' | 'appointment' | 'rental' required

class: sessions with seats, from its calendar · appointment: times from its calendar or weekly hours · rental: inventory over periods

namestring required
descriptionstring required
locationstring required

Where it meets, as guests read it: an address, a place or GPS coordinates. Or an https meeting link for an offering online, which guests join

duration_minutesinteger required

Length of a class session or appointment, or of one rental period (1440 = a day)

capacityinteger required

class: seats per session · appointment: parallel bookings per slot · rental: items in stock

max_per_bookinginteger required

Most seats, people or items in one booking. An appointment is one-on-one at 1 (its default); more lets a guest book for a party

price_centsinteger required

class: per seat · appointment: per appointment, for its first person (see guest_price_cents) · rental: per item per period

guest_price_centsinteger nullable

appointment: what each additional guest in a party adds; null (the default) charges each the full price, 0 makes them free

deposit_centsinteger nullable

A deposit guests pay at booking where they pay online, in the currency's minor units (at most the total); the rest is due at the start. Null: the whole total

deposit_percentinteger nullable

A deposit as a percent of the total, 1 to 99, paid at booking where guests pay online; null: the whole total

slot_interval_minutesinteger nullable required

Minutes between start times; null means back to back

buffer_minutesinteger required
min_notice_minutesinteger required
max_advance_daysinteger required
max_periodsinteger required

Rentals: the most periods one booking can span

activeboolean required

false pauses booking: guests and agents can't book it, and it stays in your dashboard

metadataunknown required
latnumber nullable

The meeting point's latitude, for its map link and the weather call

lonnumber nullable
place_idstring nullable

Google Maps' place ID for the location, which the guest's map link opens

gauge_sitestring nullable

A USGS river gauge's site number

schedule'hours' | 'calendar' nullable

An appointment's: weekly hours or calendar entries; null for other kinds

waiver_requiredboolean

Each person booked signs your waiver (waiver.get) on their phone before they come

waitlist_enabledboolean

A full time keeps a waitlist that guests join, emailed when a place opens (waitlist_list). Switched off, everyone waiting comes off and is emailed

courseboolean

A class sold as a course: availability.get lists each calendar entry that ends as one slot, and bookings.create takes its series_id to book every time of it

photo_urlstring nullable

Its photo, at the top of its card on the booking page: a JPEG's absolute URL, or null without one. Read-only: photos are uploaded in the dashboard (the offering's Photo)

created_atstring required

ISO 8601 timestamp (UTC)

Changes

No recorded changes to this operation across all 1 revision of this API.