API changelog — September 20, 2023
Updates for this release.
On this page
- Zenoti Mobile
- Fitness
- Analytics
- Reports
- Employee
- Digital forms
- Loyalty
- Webstore v2
- Centers
- Guest
- Calendars
- Campaigns
- Payments
- Offline sync
- Products
Zenoti Mobile
API Endpoint: {api_url}/v1/centers/{center_id}/cash_registers/open_invoices
Scenario: This API can be used in situations where open invoices prevent register closure.
Earlier behavior: NA
New behavior: The API retrieves invoices details that are blocking register closure.
API documentation link:
API Endpoint: {api_url}/api/Invoices
Scenario: This API can be used to retrieve invoices.
Earlier behavior: Did not have provision for custom status value in the request.
New behavior: The API now has provision for custom status value in the request.
API documentation link: NA
Fitness
API Endpoint: {api_url}/v1/guests/{guest_id}/memberships/forms
Scenario: This new API fetches membership forms of a guest.
-- If user_membership_id is null, then the API displays all the membership forms of the all user_membership_id’s of the guest.
-- If user_membership_id is not null then the API displays only the membership forms of the user_membership_id.
Earlier behavior: NA
New behavior: The API fetches membership forms of a guest.
API documentation link:
Analytics
API Endpoint: {api_url}//v1/signals/adoptions
Scenario: This new API fetches the name of adoption signals, URL to redirect the user to the feature set up guide, help article, and adoption signal details of a center or an organization.
Earlier behavior: NA
New behavior: The API fetches adoption signals of a center or an organization.
API documentation link: NA
Reports
API Endpoint: {api_url}/v1/reports/sales/cash_basis/flat_file
Scenario: This API is used to get the sales cash report data.
Earlier behavior: The properties ‘vendors’, ‘brands’, ‘vendor_id', ‘vendor_name', ‘brand_id’, and 'brand_name’ were not present in request and response model.
New behavior: The properties ‘vendors’, ‘brands’, ‘vendor_id', ‘vendor_name', ‘brand_id’, and 'brand_name’ are now present in request and response model.
API documentation link: NA
API Endpoint: {api_url}/v1/reports/sales/accrual_basis/flat_file
Scenario: This API is used to get the sales accrual report data.
Earlier behavior: The properties ‘vendors’, ‘brands’, ‘vendor_id', ‘vendor_name', ‘brand_id’, and 'brand_name’ were not present in request and response model.
New behavior: The properties ‘vendors’, ‘brands’, ‘vendor_id', ‘vendor_name', ‘brand_id’, and 'brand_name’ are now present in request and response model.
API documentation link: NA
API Endpoint: {api_url} /v2/reports/{id}
Scenario:
Earlier behavior: The key log_file_url was not present.
New behavior: Added key log_file_url with value in response to return s3 bucket link for log file in case of zone payroll report.
API documentation link: NA
API Endpoint: {api_url}/v1/reports/guests/communication_channel_preferences/flat_file
Scenario: This API can be used for understanding the communication channel preferences for marketing/transactional notifications.
Earlier behavior: NA
New behavior: This API fetches the report of communication channel preferences of guests for marketing/transactional notifications.
API documentation link: NA
API Endpoint: {api_url}/v1/reports/accounting_integrations/variance/invoice_items/flat_file
Scenario: This API gets the Invoice Item variances between data posted to the accounting system and the data present in Zenoti in the selected duration.
Earlier behavior: NA
New behavior: This API gets the Invoice Item Variances between data posted to the accounting system and the data present in Zenoti in the selected duration.
API documentation link: NA
API Endpoint: {api_url}/v1/reports/business_summary
Scenario: This API the returns details of business summary report.
Earlier behavior: Invoice status model did not have the new properties.
New behavior: Added new property 'invoice_statuses' in request model.
API documentation link:
Employee
API Endpoint: {api_url}/v1/centers/{center_id}/payroll/{id}?month={month}&year={year}
Scenario: Using Updated the security role permission to check whether the employee has access to that center to access the API, instead of the payroll security permissions.
Earlier behavior: The employee needed to have payroll security permission to access the API.
New behavior: Updated the security role permission to check whether the employee has access to that center to access the API, instead of the payroll security permissions.
API documentation link: NA
API Endpoint: {api_url}/api/Employees/EmployeeCommission
Scenario: Addition of new values in response details to the API that fetches commission details data displayed in ZMA.
Earlier behavior: The Response Details did not have the new parameters.
New behavior: Added new parameters to Response Details.
API documentation link: NA
Digital forms
API Endpoint: {api_url}/api/appointments/{AppointmentGroupId}/GetServiceFormdetails
Scenario: Addition of new values in request parameters to the API that fetches appointment form details.
Earlier behavior: The Request Parameters did not have the optional parameter is_guest_print
New behavior: Added the new parameter to Request Parameters.
API documentation link:
Loyalty
API Endpoint: {api_url}/api/v1/guests/details?guest_code={guest_code}
Scenario: The API fetches guest details by guest code.
Earlier behavior: NA
New behavior: The API fetches guest details by guest code.
API documentation link:
Webstore v2
API Endpoint: {apiurl}/api/Catalog/Invoices/GiftCard
Scenario: The API handles the addition of recipient phone number, shipping address, and gift card type during invoice creation.
Earlier behavior: The API added a normal (e-gift) to the invoice.
New behavior: The API adds e-gift, shipped, and picked gift card to the invoice, along with handling recipient's phone number and shipping address.
API documentation link:
##Inventory
API Endpoint: {apiurl}/v2/products/sync
Scenario: The API synchronizes product-related information across organizations.
Earlier behavior: NA
New behavior: The API now syncs product-related information across organizations, acting as a new API for this purpose.
API documentation link:
API Endpoint: {apiurl}/v2/products/sync
Scenario: The API synchronizes product-related information across organizations.
Earlier behavior: NA
New behavior: The API synchronizes product-related information across organizations.
API documentation link:
API Endpoint: {apiurl}/v2/organizations
Scenario: The API fetches the centers of an organization grouped by zones.
Earlier behavior: NA
New behavior: The API fetches the centers of an organization grouped by zones.
API documentation link:
Centers
API Endpoint: {{api_url}}/api/Centers/{center_id}/working_hours/{date}
Scenario:
Earlier behavior: There was no is_closed parameter in response.
New behavior: Added a new parameter is_closed in the CenterWorkingHoursResponse response.
API documentation link:
API Endpoint: {{api_url}}/api/Catalog/Centers
Scenario:
Earlier behavior: There was no is_closed parameter in response.
New behavior: Added a new parameter working_hours in the CenterWorkingHoursModel response
API documentation link:
API Endpoint: {{api_url}}/v1/centers?expand=working_hours
Scenario:
Earlier behavior: There was no is_closed parameter in response.
New behavior: Added a new parameter working_hours in the CenterWorkingHoursModel response.
API documentation link:
API Endpoint: {api_url}/api/Centers/{center_id}/Settings
Scenario: API to fetch center check in visits history
Earlier behavior: The following fields were not present
-- is_active field in the environmental_fee object
-- EnableCampaignAutoApplication field in the Settings object
- New behavior:
Added is_active field to the environmental_fee object
Added field EnableCampaignAutoApplication in the Settings object
API documentation link:
API Endpoint: {api_url} /v1/Centers/{center_id}/overflow
Scenario: This API sets overflow counter for a given center.
Earlier behavior: NA
New behavior: This new API sets overflow counter for a given center
API documentation link:
Guest
API Endpoint: {{api_url}}/v1/guests/guest_id/accounts
Scenario:
Earlier behavior: ProcessorName was missing.
New behavior: Now, ProcessorName is required to display for migrated customers.
API documentation link:
Calendars
API Endpoint: {{api_url}}/v1/calendars/employee/{0}?organization_id={1}
Scenario:
Earlier behavior: Property time zone ID was not present.
New behavior: Added a new property time zone ID.
API documentation link: NA
Campaigns
API Endpoint: {api_url}/v1/campaigns/restricted_words/analyze
Scenario: This API fetches the list of blocked words that are used in the campaign content.
Earlier behavior: NA
New behavior: This new API fetches the list of blocked words that are used in the campaign content.
API documentation link:
API Endpoint: {api_url}/v1/offline_sync/campaign/{campaign_id}/applicable_details
Scenario: This API the returns list of service and product discounts and returns service and product prerequisites.
Earlier behavior: NA
New behavior: This new API the returns list of service and product discounts and returns service and product prerequisites.
API documentation link:
Payments
API Endpoint: {{api_url}}/v1/account_holders/{{account_holder_id}}/owners
Scenario: This API is used to link account holders using tokens.
Earlier behavior: NA
New behavior: This new API is used to link account holders using tokens.
API documentation link:
Offline sync
API Endpoint: {api_url}/v1/offline_sync
Scenario: This API is used to create a schedule if the schedule is not available.
Earlier behavior: The new action to create a schedule for the employee if it's not already there while posting attendance was not present.
New behavior: New action created to create a schedule for the employee if it's not already there while posting attendance.
API documentation link:
API Endpoint: {api_url}/v1/offline_sync/campaigns
Scenario: This API is used to return the list of offline supported campaigns.
Earlier behavior: NA
New behavior: This is a new API.
API documentation link:
Products
API Endpoint: {api_url} /v1/products?clone_product_id={parent_product_id}
Scenario: This API is used to clone an existing product into a new product.
Earlier behavior: NA
New behavior: This is a new API to clone an existing product into a new product.
API documentation link: