API Changelog
Back to All

API Change Log – August 24th, 2022 Release

over 2 years ago by Abhay Anumula

Check the API updates for this release.

Reports

  • API Endpoint: {apiurl}/v1/reports/sales/accrual_basis/flat_file
  • Scenario: App group Id of the appointment is required for generating a link to the invoice page.
  • Earlier Behavior: App group id was not present and only the invoice id was present.
  • New Behavior: With this release, along with the invoice id, app group id will also be sent.
  • API Documentation Link: NA

Guest

  • API Endpoint: {apirul} /v1/guest/{guest_id}/gift_cards
  • Scenario: Fetch gift cards in the Claim Gift Cards API as per the new filters.
  • Earlier Behavior: NA
  • New Behavior: With this release, the API will fetch gift card info as per the new filters.
  • API Documentation Link: NA
  • API Endpoint: {apiurl}/v1/guests/{guest_id}/forms/send
  • Scenario: To send the guest’s custom form email to the user.
  • Earlier Behavior: NA
  • New Behavior: With this release, the guest’s custom form email is sent to the user.
  • API Documentation Link: NA

  • API Endpoint: {apiurl}/v1/guests/{guest_id}/appointments/past?page=1&size=5&status=5

  • Scenario: The following details are added to the guest profile appointment response:

    Specific therapist flag
    Therapist details

  • Earlier Behavior: The guest profile appointment response did not contain the therapist’s details.

  • New Behavior: With this release, we are adding the parameter therapist_specific_type.

  • API Documentation Link: NA

  • API Endpoint: {apiurl}/v1/guests/{guest_id}/products

  • Scenario: New parameters in guest products API.

    balance_quantity
    refund_invoice

  • Earlier Behavior: The guest products API did not contain the required balance quantity to refund the item.

Employee

  • API Endpoint: {apiurl}/v1/employees/{employee_id}/blockouttimes
  • Scenario: Making created_by_id mandatory for API key authentication.
  • Earlier Behavior: Earlier, created_by_id was not mandatory.
  • New Behavior: With this release, created_by_id is made mandatory for API key authentication.
  • API Documentation Link: API Documentation

  • API Endpoint: {apiurl}/api/employees/{employee_id}

  • Scenario: The following parameters are added to the response:

    is_educator: If the employee is an educator, it returns true.
    invoice_item_id: Unique identifier of the service in the invoice.
    quantity: Service quantity
    is_feedback_filled: Guest feedback status bool.
    is_product_consumption_updated: Product consumption status bool.
    are_custom_fields_filled: Custom fields status bool.
    are_package_targets_required: Package targets required bool.
    are_package_targets_filled: Package targets filled status bool.
    is_prescription_signed: Prescription signed status bool.
    is_educator_rating_filled: Educator rating status bool.

  • Earlier Behavior: These parameters were not present in the response earlier.

  • New Behavior: These parameters are added that show the pending actions on an appointment block.

  • API Documentation Link: NA

Forms

  • API Endpoint: {apiurl}/api/Organizations/FormsMetadata/8B233444-A9B4-4991-8CBF28E70B101561
  • Scenario: Added security demands to API and returning parameter status to true in response in case of successful submission of forms metadata.
  • Earlier Behavior: No security demands were present, and the status was false even if the metadata was saved successfully.
  • New Behavior: Added security demands to API and returning parameter status to true in response in case of successful submission of forms metadata.
  • API Documentation Link: NA

  • API Endpoint: {apiurl}/v1/forms/F2BBBE92-214B-4C0D-9EA4-E53F6A6A0D92/logs?owner_id={owner_id}¢er_id={center_id}&log_type=1

  • Scenario: Added six new parameters in the response object GetCustomFormLogsResponse.

    field_name
    field_type
    field_label
    ip_address
    user_agent
    Zenoti_employee_email

  • Earlier Behavior: Earlier, the parameters were not present in the response object.

  • New Behavior: With this release, we are adding six new parameters to the response object – GetCustomFormLogsResponse

  • API Documentation Link: NA