Back to All

API Change Log – April 16, 2024

19 days ago by Meghana Rangaraju

Updates for this release.

FDO

  • API Endpoint: {api_url}/v1/Centers/{center_id}/cash_registers/{cash_register_id}/balance

  • Scenario: This API has been created to retrieve the amount in a selected Cash Register of a given center.

  • Earlier behavior: New API. No earlier behavior.

  • New behavior: This API retrieves the amount in a specific cash register for a specific center.

  • API documentation link:

Reports

  • API Endpoint: {api_url}/v1/reports/center/metrics/flat_file

  • Scenario: This API has been enhanced to retrieve additional details from the Master Center Metrics report. Specifically, the newly added columns: Products count, Services count, Gift Card count, and Therapist Requested count.

  • Earlier behavior: This API couldn’t retrieve the data for the four new columns.

  • New behavior: The API can now retrieve data from the four new columns in addition to the other data it was retrieving before this enhancement.

  • API documentation link:

Appointment book

  • API Endpoint: {api_url}/v1/guests/appt_book_search

  • Scenario: If the setting for preferred pronouns is enabled (Organizations > Configurations > Business details > Enable Preferred Pronouns) this API will now retrieve guest details with preferred pronouns.

  • Earlier behavior: It couldn’t retrieve the preferred pronoun details.

  • New behavior: The API can now retrieve the guest’s preferred pronoun in addition to the other guest details it was retrieving before this enhancement.

  • API documentation link:

Appointment book

  • API Endpoint: {api_url}/v1/appointments/{appointment_id}

  • Scenario: If the setting for preferred pronouns is enabled (Organizations > Configurations > Business details > Enable Preferred Pronouns) this API will now retrieve appointment details with preferred pronouns.

  • Earlier behavior: It couldn’t retrieve the preferred pronoun details.

  • New behavior: The API can now retrieve the guest’s preferred pronoun in addition to the other appointment details it was retrieving before this enhancement.

  • API documentation link: https://docs.zenoti.com/reference/retrieve-the-details-of-an-appointment

Appointment book

  • API Endpoint: {api_url}/v1/appointments

  • Scenario: If the setting for preferred pronouns is enabled (Organizations > Configurations > Business details > Enable Preferred Pronouns) this API will now retrieve appointment details (for a specific center ID between a provided start date and end date) with preferred pronouns.

  • Earlier behavior: It couldn’t retrieve the preferred pronoun details.

  • New behavior: The API can now retrieve the guest’s preferred pronoun in addition to the other appointment details it was retrieving before this enhancement.

  • API documentation link: https://docs.zenoti.com/reference/retrieve-the-list-of-appointments-of-a-center