Skip to main content

Update Reservation

PUT 
/api/reservations/:id

Update Reservation

Request​

Path Parameters

    id integerrequired

Header Parameters

    X-Company-Slug stringrequired

Body

    customer_id number

    internal customer id. you can use search customer endpoint

    customer

    object

    this object required if there is no customer_id set

    name stringrequired
    surname stringrequired
    email emailrequired
    phone stringrequired
    gender ContactGenderEnum (string)

    Possible values: [male, female, other]

    notes string

    Possible values: <= 255 characters

    starting_at date-time
    finishing_at date-time

    items

    object[]

  • Array [

    • service_id numberrequired
    price number

    if you set price, the default price set from catalog will be overwritten.

    quantity numberrequired
    employee_id number
    estimated_time number
    starting_at date-time

    you might not send starting at, in this case the system will adjust the services in appointment period

    finishing_at date-time

  • ]

    • source_id number

    you can use your internal identifier for mapping purposes

    status ReservationStatusEnum (string)

    Possible values: [new, accepted, cancelled, no-show, success]

Responses​

Successful response

Schema

    id string
    code string
    customer_id string
    created_by_id string
    updated_by_id string
    notes stringnullable
    total float
    starting_at date-time
    finishing_at date-time
    created_at date-time
    updated_at date-time
    status ReservationStatusEnum (string)

    Possible values: [new, accepted, cancelled, no-show, success]

    customer

    object

    id string
    name string
    surname stringnullable
    type ContactTypeEnum (string)nullable

    Possible values: [vendor, customer]

    email emailnullable
    phone phonenullable
    gender ContactGenderEnum (string)nullable

    Possible values: [male, female, other]

    birthdate datenullable
    address stringnullable
    custom_fields objectnullable
    created_at date-time
    updated_at date-time
    default_photo_id numbernullable

    services

    object[]

  • Array [

    • id string
    reservation_id string
    employee_id string
    service_id string
    price float
    quantity integer
    estimated_time integer
    starting_at date-time
    finishing_at date-time
    is_bound boolean

    service

    object

    id string
    name string
    slug string
    description stringnullable
    price float
    original_price floatnullable
    estimated_time integer
    category_id string
    created_at date-time
    updated_at date-time

    employee

    object

    id string
    email string
    name stringnullable
    surname stringnullable
    language stringnullable
    phone_number stringnullable
    remember_me_token booleannullable
    birthday datenullable
    created_at date-time
    updated_at date-time
    timezone stringnullable

    meta

    object

    gender ContactGenderEnum (string)nullable

    Possible values: [male, female, other]

  • ]

    • createdBy

    object

    id string
    email string
    name stringnullable
    surname stringnullable
    language stringnullable
    phone_number stringnullable
    remember_me_token booleannullable
    birthday datenullable
    created_at date-time
    updated_at date-time
    timezone stringnullable

    meta

    object

    gender ContactGenderEnum (string)nullable

    Possible values: [male, female, other]

    updatedBy

    object

    id string
    email string
    name stringnullable
    surname stringnullable
    language stringnullable
    phone_number stringnullable
    remember_me_token booleannullable
    birthday datenullable
    created_at date-time
    updated_at date-time
    timezone stringnullable

    meta

    object

    gender ContactGenderEnum (string)nullable

    Possible values: [male, female, other]

    source_id numbernullable
    custom_fields objectnullable
    transaction_id stringnullable
Loading...