To check shopwave server health. If it returns status code 200, our important services are up and running. Please note that this is not API unit test result, rather this is just to check server health.
The endpoint you need to use for this is:
/status| Key | Details | Example |
|---|---|---|
| Authorization* | {token_type} {access_token} | Bearer c3499c2729730a7f807efb8676a92dcb6f8a3f8f |
| Method* | GET | GET |
| x-accept-version | {recommended_latest_version_number} | 2 |
* Required header
| Key | Details | Data Type | Example |
|---|---|---|---|
| statusCode | Very important to check this for shopwave server uptime. 200 for success. | int | 200 |
| Key | Details | Data Type |
|---|---|---|
| status | Just a static message to confirm shopwave server status | string |
| serverTimestamp | Server datetime in YYYY-MM-DDTHH:ii:ss.BZ ISO format. All our servers are in GMT timezone. | datetime |
Please check the live API calls for more details on the API messages.
| ID | Status Code | Title | Details |
|---|---|---|---|
| 908 | 401 | Expired Token | Token expired or invalid. Please renew your token |
| 911 | 401 | Authorization Header Invalid | The authorization header is invalid. The correct format is Authorization: {token_type} {accessToken} |
| 910 | 404 | Not Found | The resource you are looking for does not exist |
| 899 | 500 | Unknown Error | Something went wrong. Please contact the site administrator |
Please check the live API calls for more info on the API messages.
| ID | Status Code | Title | Details |
|---|---|---|---|
| 203 | 200 | Request Processed Successfully | The request has been successfully completed. |
| 202 | 200 | Token is valid | Token is validated and found valid. |
