{ "opencollection": "1.0.0", "info": { "name": "WellnessLiving Appointments API", "version": "1.1.20260620071011" }, "request": { "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "items": [ { "info": { "name": "Appointments", "type": "folder" }, "items": [ { "info": { "name": "Gets information about appointment.", "type": "http" }, "http": { "method": "GET", "url": "https://us.wellnessliving.com/Wl/Appointment/Info/Info.json", "headers": [ { "name": "X-Error-Rules", "value": "" } ], "params": [ { "name": "k_appointment", "value": "", "type": "query", "description": "Class identifier to get information for." } ] }, "docs": "Returns detailed information about the specified appointment, including service details, staff member,\n date and time in the location's timezone, booking status, client information, and any associated\n assets or add-ons. Access is validated against the current user's permissions." }, { "info": { "name": "Retrieves a list with all calendar days in specified period with available and unavailable appointment booking schedule.", "type": "http" }, "http": { "method": "GET", "url": "https://us.wellnessliving.com/Wl/Appointment/Book/Schedule/Calendar.json", "headers": [ { "name": "X-Error-Rules", "value": "" } ], "params": [ { "name": "a_uid", "value": "", "type": "query", "description": "List of user keys to book appointments.\nThere may be empty values in this list, which means that this is a walk-in." }, { "name": "dt_date", "value": "", "type": "query", "description": "The date to show the available appointment booking schedule." }, { "name": "i_duration", "value": "", "type": "query", "description": "The duration of the asset booking or custom appointment duration in minutes. Zero in case of service predefined duration.\nIn case of back-to-back book" }, { "name": "i_index", "value": "", "type": "query", "description": "An index of the selected asset. `0` for booking of service or if asset is not on layout." }, { "name": "id_gender_staff", "value": "", "type": "query", "description": "The ID of the staff member's gender.\nIn case of back-to-back booking - staff gender of first appointment.\nOne of the [AGenderSid](#/components/schemas" }, { "name": "is_back_to_back", "value": "", "type": "query", "description": "Determines whether multiple appointments are booked in back-to-back mode." }, { "name": "is_month_view", "value": "", "type": "query", "description": "If calendar should be displayed in month view mode." }, { "name": "is_staff", "value": "", "type": "query", "description": "`true` if the request is made by staff member; in this case booking policy restrictions are ignored.\n`false` if the request is made by client; booking" }, { "name": "is_tab_all", "value": "", "type": "query", "description": "`true` - search in all tabs.\n`false` - search only for the selected bookable tab.\n\nCannot be set simultaneously with {DayTimeApi::$k_class_tab}." }, { "name": "is_unavailable", "value": "", "type": "query", "description": "`true` - return service categories that have no staff members able to conduct them.\n`false` - return only service categories that have staff members a" }, { "name": "is_walk_in", "value": "", "type": "query", "description": "If `true`, the client is a walk-in. Otherwise, this will be `false`." }, { "name": "k_class_tab", "value": "", "type": "query", "description": "Current booking tab.\nOnly used for asset booking with \"Allow clients to select a date and time, then the available asset\" booking policy enabled.\n\nCan" }, { "name": "k_location", "value": "", "type": "query", "description": "Location to show available appointment booking schedule." }, { "name": "k_resource", "value": "", "type": "query", "description": "The resource key to show which days are available for booking.\nShould be `0` in case of back-to-back booking." }, { "name": "k_service", "value": "", "type": "query", "description": "The service key used for showing the available appointment booking schedule.\nIn case of back-to-back booking - service key of first appointment." }, { "name": "k_staff", "value": "", "type": "query", "description": "The staff member key used for showing the available appointment booking schedule.\nIn case of back-to-back booking - staff key of first appointment.\n`0" }, { "name": "k_timezone", "value": "", "type": "query", "description": "Key of timezone.\n\n`null` if not set to use client's profile timezone." }, { "name": "s_appointment", "value": "", "type": "query", "description": "The staff key to show what days are available for booking.\n\nFor back-to-back booking ([DayTimeApi](/Wl/Appointment/Book/Schedule/DayTime.json) == `tru" }, { "name": "s_product", "value": "", "type": "query", "description": "A list of service add-ons keys(encoded as JSON string).\nIn case of back-to-back booking - add-ons of first appointment." }, { "name": "uid", "value": "", "type": "query", "description": "The user key.\n\nThis field is used if the client books for himself or for the relative.\n\nThis field is incorrect to use for guest booking since in this" }, { "name": "uid_staff", "value": "", "type": "query", "description": "The staff user key used for showing the available appointment booking schedule.\nIn case of back-to-back booking - staff user key of first appointment." } ] }, "docs": "Returns each day in the requested month marked as available or unavailable for booking the given\n service at the given location. Availability is determined by the business schedule, holidays,\n and staff availability for the selected date range." }, { "info": { "name": "Retrieves an information about staff members for the current service.", "type": "http" }, "http": { "method": "GET", "url": "https://us.wellnessliving.com/Wl/Appointment/Book/Staff/List.json", "headers": [ { "name": "X-Error-Rules", "value": "" } ], "params": [ { "name": "dt_date", "value": "", "type": "query", "description": "The date/time of the appointment selected by user, in the location's time zone." }, { "name": "i_duration_custom", "value": "", "type": "query", "description": "Custom appointment duration in minutes.\n\n`null` if not set." }, { "name": "id_role", "value": "", "type": "query", "description": "User role by whom this api called.\nFor different roles different results might be generated." }, { "name": "is_unavailable", "value": "", "type": "query", "description": "`true` - returns service categories that have no staff members available to conduct them.\n`false` - returns only service categories that have staff me" }, { "name": "k_appointment_ignore", "value": "", "type": "query", "description": "Key of appointment which must be ignored when searches available staff." }, { "name": "k_location", "value": "", "type": "query", "description": "The key of the location." }, { "name": "k_service", "value": "", "type": "query", "description": "The key of a service for which to show information." }, { "name": "k_timezone", "value": "", "type": "query", "description": "User's timezone.\n\n`null` until initialized or to use location timezone." }, { "name": "uid", "value": "", "type": "query", "description": "The user key for whom the service is booking.\n\n`null` when not set." } ] }, "docs": "Returns the list of staff members who can perform the specified service at the given location\n on the specified date and time. Each entry includes the staff member's name, image, gender,\n and availability. An 'any staff' option is included when the service allows random staff assignment." }, { "info": { "name": "Completes the appointment booking for one or more providers, optionally creating a new client.", "type": "http" }, "http": { "method": "POST", "url": "https://us.wellnessliving.com/Wl/Appointment/Book/Finish/FinishMultiple.json", "headers": [ { "name": "X-Error-Rules", "value": "" } ], "params": [ { "name": "a_pay", "value": "", "type": "query", "description": "The payment type for the appointment. One of the [RsAppointmentPaySid](#/components/schemas/RsAppointmentPaySid) constants.\n\nKeys refer to provider in" }, { "name": "a_uid", "value": "", "type": "query", "description": "List of user keys to book appointments.\nThere may be empty values in this list, which means that this is a walk-in." }, { "name": "a_user", "value": "", "type": "query", "description": "Data to create new users.\nSpecify this if `$uid` is empty.\nThe data must contain the next keys:" }, { "name": "is_walk_in", "value": "", "type": "query", "description": "If `true`, the client is a walk-in. Otherwise, this will be `false`." }, { "name": "k_appointment", "value": "", "type": "query", "description": "The appointment key.\nSpecify this to reschedule a certain appointment." }, { "name": "k_business", "value": "", "type": "query", "description": "The business key." }, { "name": "k_location", "value": "", "type": "query", "description": "Location to show available appointment booking schedule." }, { "name": "uid", "value": "", "type": "query", "description": "The user key.\n\nThis field is used if the client books for himself or for the relative.\n\nThis field is incorrect to use for guest booking since in this" } ], "body": { "type": "form-urlencoded", "data": [ { "name": "a_answer", "value": "" }, { "name": "a_book_data", "value": "" }, { "name": "a_notification", "value": "" }, { "name": "a_paid", "value": "" }, { "name": "a_pay_form", "value": "" }, { "name": "a_payment_data", "value": "" }, { "name": "a_purchase_item", "value": "" }, { "name": "a_quiz_response", "value": "" }, { "name": "id_mode", "value": "" }, { "name": "is_back_to_back", "value": "" }, { "name": "is_try", "value": "" }, { "name": "s_id", "value": "" } ] } }, "docs": "Accepts booking details for one or more providers in `a_book_data`,\n processes payment using the selected Purchase Option, creates appointment records, and sends\n booking confirmation notifications. A new client account can be created by supplying user\n details in `a_user` when no UID is provided." } ] } ], "bundled": true }