API Change Log – 24 Sep 2024
3 months ago by Uppal
Updates for this release.
Group Invoice
- Webhook Event: Invoice
- Webhook Event Type: Invoice.Closed
- Scenario: This webhook gets triggered when an invoice is closed.
- Earlier behavior: The Invoice.Closed webhook only handled individual invoices and
didn't support group invoices or the group_invoice_id parameter. - New behavior: Enhanced Invoice.Closed webhook now includes group invoice details, every invoice that’s part of the group and the added group_invoice_id parameter, is populated only for group invoices. Otherwise, it remains null and is ignored.
Webstore V2
- API Endpoint: {api_url}/v1/giftcards/templates
- Scenario: This API retrieves a list of various predefined gift card templates for a specified center.
- API method: GET
- Earlier behavior: The API sent the discount price based solely on the predefined gift card discount.
- New behavior: The API now sends the predefined gift card's member price as the discount price, depending on the settings and whether the guest has an active membership.
- API documentation link: https://docs.zenoti.com/reference/list-all-templates
WebPOS
- API Endpoint: {api_url}/v1/group_invoices/{group_invoice_id}/transactions
- Scenario: This API provides invoice transaction details for group invoices.
- API method: GET
- Earlier behavior: New API. No earlier behavior.
- New behavior: This API retrieves transaction details for group invoices, including all associated payments and adjustments.
WebPOS
- API Endpoint: {api_url}/v1/group_invoices/{group_invoice_id}/metadata
- Scenario: This API provides the status for group invoice.
- API method: GET
- Earlier behavior: New API. No earlier behavior.
- New behavior: This API retrieves the current status of group invoices, providing details on whether they are pending, completed, or other relevant status updates.
WebPOS
- API Endpoint: {api_url}/v1/invoices/{invoice_id}/fees
- Scenario: This API provides fee details for an invoice.
- API method: GET
- Earlier behavior: New API. No earlier behavior.
- New behavior: This API retrieves detailed information about the fees associated with a specific invoice, including any applicable charges or adjustments.