Version History
This section describes changes made in subsequent releases and the new features in this API:
| Release | Enhancements | API Version |
|---|---|---|
| 2024.2-SP5 and Patch in API 2024.2 | To enable a service-level health check, we introduced a new endpoint: - GET /api/v1/healthCheck It allows the API client to check the status of the dependent backend services. On the 200 response, the client receives the overall status information: healthy, degraded, unhealthy. | v1 |
| 2023.3-SP2 | Since it is possible to receive a "403" error code in some use cases, we added this response code to the following endpoints: POST /api/v1/emails and POST /api/v1/sms. The 403: Forbidden error indicates that the server understands the request but cannot provide additional access. | v1 |
| 2023.2 | We have added a new Notification API to the Retail API Platform stock of public APIs. Notification API supports sending notification to recipients using different communication channels (email, SMS) and different notification channel providers. As of this release, we have exposed the following endpoints: - POST /api/v1/emails - allows to send an email with attachments. - POST /api/v1/sms - enables to send a SMS notification. | v1 |