Sign in

v1

latestSwagger 2.02026-08-06115129197.7 KB
Appointment

Create an appointment

Returns the newly created appointment

post/appointments

Query parameters

partner_idstring

The appointments's id

client_partner_idstring

The client's id

client_mytime_idinteger

The client's mytime id

child_partner_idstring

The child's id

child_mytime_idinteger

The child's mytime id

location_partner_idstring

The location's id

location_mytime_idinteger

The location's mytime id

employee_partner_idstring

The employee's id

employee_mytime_idinteger

The employee's mytime id

begin_atstring required

The appointment's start time. e.g 2017-10-17T10:00:00Z

end_atstring required

The appointment's end time. e.g 2017-10-17T12:00:00Z

referrerstring

Referrer for appointment

address_idstring

Client address ID

employee_requestedboolean

Whether an employee was requested

check_conflictsboolean

Whether to check for appointment conflicts or not

skip_bundle_purchasesboolean

Whether to skip bundle purchases when creating the appointment

Headers

X-Subdomainstring

Merchant subdomain - Optional

Request body

booked_bystring

Booked by

partner_namestring

Partner Name to display in appointment notes

appointment_group_idinteger

Id of the appointment group this appointment belongs to. Two or more appointments sharing the same appointment_group_id are treated as a single booking (one ticket at checkout, one payment, grouped notifications). Obtain a group id by calling POST /appointment_groups.

Example request

{
  "booked_by": "merchant",
  "partner_name": "Partner API",
  "variations": [
    {
      "variation_mytime_id": 309616,
      "price": 100,
      "segments": [
        {
          "position": 0,
          "kind": "service",
          "duration": 120,
          "segment_template_id": 7272
        }
      ]
    }
  ]
}

Response

Appointment response

purchased_at_pricenumber
begin_atstring required
end_atstring required
client_namestring
client_emailstring
created_atstring
statusstring
time_zonestring
is_existing_customerstring
client_phonestring
variation_namestring
full_addressstring
employee_partner_idinteger
location_partner_idinteger
client_partner_idinteger
mytime_idstring
client_mobile_phonestring
client_home_phonestring
client_work_phonestring
checked_in_atstring
checked_instring
checked_out_atstring
pos_statusstring
address_idstring
employee_requestedstring
child_partner_idinteger
employee_mytime_idinteger required
location_mytime_idinteger required
client_mytime_idinteger required
child_mytime_idinteger
partner_idinteger
appointment_group_idinteger

ID of the appointment group this appointment belongs to, or null if it is not part of a group.

Example response

{
  "variations": [
    {
      "price": 120,
      "multiplier_base_price": 40,
      "price_multiplier": 3
    }
  ]
}