IntegrationStatus returns diagnostic checks for the caller's integration — whether warehouses are bound, whether either queue is being drained, and whether anything has been sitting in one for too long.

GET

/v2/shipping/status

curl --request GET \
  --url https://api.zentail.com/v2/shipping/status \
  --header 'Authorization: Bearer <token>'

If the integration implements WarehouseService, Zentail also asks it about each warehouse and folds those checks in, so one call answers “is this working” from both sides.

Authorizations

• zentail_oauth
  sales:orders:fulfillment:self

Responses

200

A successful response.

Media typeapplication/json

object

checks

Zentail’s own observations and the integration’s last reported checks, in one list. Read source to tell them apart; render them together, because an operator asking “is this working” does not care who noticed.

Array<object>

object

name

Stable identifier, not prose — an operator or an alert matches on this, so it must not change when the wording does. Lower_snake_case by convention.

string

state

• CHECK_STATE_UNSPECIFIED: Zentail never sends this. Treat it as a check you cannot interpret rather than as a pass.
• CHECK_STATE_PASS: Healthy, nothing to do.
• CHECK_STATE_WARN: Working, but heading somewhere bad — a queue draining slower than it fills, a credential close to expiring. Worth looking at before it becomes a FAIL.
• CHECK_STATE_FAIL: Broken now. Orders this check covers are not moving until it clears.

string

default: CHECK_STATE_UNSPECIFIED

Allowed values: CHECK_STATE_UNSPECIFIED CHECK_STATE_PASS CHECK_STATE_WARN CHECK_STATE_FAIL

message

Prose for a human. Say what is wrong and what would fix it.

string

source

• CHECK_SOURCE_UNSPECIFIED: Not set. Zentail fills this in on every check it returns, so this value only appears on a check an integration sent and Zentail has not folded in.
• CHECK_SOURCE_ZENTAIL: Zentail observed this from the outside.
• CHECK_SOURCE_INTEGRATION: The integration reported this about itself.

string

default: CHECK_SOURCE_UNSPECIFIED

Allowed values: CHECK_SOURCE_UNSPECIFIED CHECK_SOURCE_ZENTAIL CHECK_SOURCE_INTEGRATION

warehouseUniqueId

Which warehouse this check is about, when it is about one. Set by Zentail as it folds a WarehouseStatus response in, and on a check reporting that a warehouse could not be reached.

Without it the fold is lossy: two warehouses returning the same check name are indistinguishable, and anything matching on name alone cannot say which one is broken. Empty on checks about the integration as a whole.

string

Example

{
  "checks": [
    {
      "state": "CHECK_STATE_UNSPECIFIED",
      "source": "CHECK_SOURCE_UNSPECIFIED"
    }
  ]
}

default

An unexpected error response.

Media typeapplication/json

object

code

integer format: int32

message

string

details

Array<object>

object

@type

string

key

additional properties

Example^generated

{
  "code": 1,
  "message": "example",
  "details": [
    {
      "@type": "example"
    }
  ]
}