Skip to main content
GET
Healthcheck

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"

logo_url
string

Absolute URL to the configured UI logo (general/general/ui_logo), or the bundled default when none is configured. Exposed on this guest route so the sign-in page can show instance branding before authentication.

Example:

"https://acme.shipstream.io/media/ui_logo/logo.png"

logo_collapsed_url
string

Absolute URL to the configured collapsed-sidebar mark (general/general/ui_logo_collapsed), or the default skin mark when none is configured.

Example:

"https://acme.shipstream.io/skin/adminhtml/default/go/images/shipstream-logo-2.png"

favicon_url
string

Absolute URL to the configured UI favicon (general/general/ui_favicon), or the bundled default when none is configured.

Example:

"https://acme.shipstream.io/media/ui_favicon/favicon.png"