GET
/
v1
/
system
/
status
Healthcheck
curl --request GET \
  --url https://{base_url_domain}/api/global/v1/system/status \
  --header 'Authorization: Bearer <token>'
{
  "status": "healthy",
  "status_detail": "Service is operating normally.",
  "authentication": "valid",
  "instance_uid": "acmeinc",
  "time": "2024-04-15T15:21:15.739Z",
  "shipstream_version": "2023.2",
  "shipstream_build": "a1b2c3d4"
}

Authorizations

​
Authorization
string
header
required

Generate a JWT access token through a Custom Global Integration and provide it with each request in the Authorization header prefixed with "Bearer" and then a single space.

Response

A dictionary with a collection property that contains an array of up to limit Merchant objects. If no merchants are found the array will be empty.

​
status
string

General status of the service.

Example:

"healthy"

​
status_detail
string

Detailed status information of the service.

Example:

"Service is operating normally."

​
authentication
string

Status of the authentication.

Example:

"valid"

​
instance_uid
string

Unique identifier for the instance.

Example:

"acmeinc"

​
time
string<date-time>

Human-readable timestamp with millisecond precision in the following format ISO 8601 (yyyy-MM-dd'T'HH:mm:ss.SSS'Z).

Example:

"2024-04-15T15:21:15.739Z"

​
shipstream_version
string

Version of ShipStream.

Example:

"2023.2"

​
shipstream_build
string

Build identifier of ShipStream.

Example:

"a1b2c3d4"