Version 1.41.0

Third Party API (v 1.41.0)

What's New

GET /api/business/{businessId}/branch/{branchId}/appointment/{appointmentId}/consultation-link

Get the consultation form link for an appointment

What's Changed

POST /api/business/{businessId}/loyaltypoints

Return Type:

New response : 404 Not Found

Not Found

POST /api/business/{businessId}/creditaccounttransaction

Return Type:

New response : 404 Not Found

Not Found

POST /api/business/{businessId}/branch/{branchId}/deposit/payment-link

Request:

Changed content type : application/json

• Added property cardCaptureOnly (boolean)

  Create a link that charges nothing and only saves the client's card details. Use this to secure a card for appointments that don't require a deposit. When false or not provided, the link charges the deposit calculated from the branch's deposit settings.

Return Type:

Changed response : 201 Created

Deposit payment link created successfully

• Changed content type : application/json

  • Added property cardCaptureOnly (boolean)

    Whether the link charges nothing and only saves the client's card details

GET /api/business/{businessId}/clientcourse/{clientCourseId}

Return Type:

Changed response : 200 OK

Specified client course retrieved

• Changed content type : application/json

  • Added property createTime (string)

    When the client course was created (UTC)

  • Added property updateTime (string)

    When the client course was last updated (UTC). This is the value the updated_from and updated_to filters match against. Using a session only changes an item's remainingUnits and does not change this value.

PUT /api/business/{businessId}/clientcourse/{clientCourseId}

Return Type:

Changed response : 200 OK

Client course updated successfully

• Changed content type : application/json

  • Added property createTime (string)

    When the client course was created (UTC)

  • Added property updateTime (string)

    When the client course was last updated (UTC). This is the value the updated_from and updated_to filters match against. Using a session only changes an item's remainingUnits and does not change this value.

GET /api/business/{businessId}/clientcourse

Parameters:

Added: updated_from in query

start of the updated date-time range (inclusive), ISO-8601 date-time in UTC. Returns client courses whose updateTime is on or after this value. Must be supplied together with updated_to, and the range can be at most 31 days

Added: updated_to in query

end of the updated date-time range (exclusive), ISO-8601 date-time in UTC. Returns client courses whose updateTime is before this value. Must be supplied together with updated_from, and the range can be at most 31 days

Return Type:

Changed response : 400 Bad Request

Invalid request parameters. Returned when only one of updated_from and updated_to is supplied (both are required together), the range spans more than 31 days, or a value is not a valid ISO-8601 date-time

Changed response : 200 OK

Client courses listed

• Changed content type : application/json

  • Changed property _embedded (object)

    • Changed property clientCourses (array)

      Changed items (object):

      • Added property createTime (string)

        When the client course was created (UTC)

      • Added property updateTime (string)

        When the client course was last updated (UTC). This is the value the updated_from and updated_to filters match against. Using a session only changes an item's remainingUnits and does not change this value.

GET /api/business/{businessId}/branch/{branchId}/appointment

Return Type:

Changed response : 400 Bad Request

Invalid request parameters. Returned when: neither a [from_date, to_date] range nor an [updated_from, updated_to] range is supplied; only one bound of a range is supplied (both bounds are required); a supplied date range spans more than 31 days; updated_from is not before updated_to; a from_date, to_date, updated_from or updated_to value is not a valid date/date-time; or 'sort' is not one of the supported values ('appointmentDate', 'creationDate')

Result

API changes are backward compatible