Report whether an integration's credentials are working

POST

/v1/integration/{integrationId}/connectionStatus

curl --request POST \
  --url https://api.zentail.com/v1/integration/1/connectionStatus \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "connected": true, "error": "example" }'

Marks the integration as connected or disconnected. A disconnected integration raises the connection warning shown to the seller on every page, so only report a disconnect once the channel has rejected the credentials, not on a transient network failure.

Authorizations

• zentail_oauth
  inventory:self
• zentail_oauth
  inventory:warehouse:self
• zentail_oauth
  legacy
• zentail_oauth
  listing:self
• zentail_oauth
  sales
• zentail_oauth
  sales:orders
• zentail_oauth
  sales:orders:fulfillment:self
• zentail_oauth
  sales:orders:inventory:self
• zentail_oauth
  sales:orders:self

Parameters

Path Parameters

integrationId

required

integer

Zentail Integration ID

Request Body

Place the connection status in a JSON object in the body of the request.

Media typeapplication/json

object

connected

required

False when the integration’s credentials are being rejected by the channel.

boolean

error

Short reason shown to the seller alongside the connection warning. Send null when connected.

string

Example^generated

{
  "connected": true,
  "error": "example"
}

Responses

200

Success

Media typeapplication/json

string

Example^generated

example

400

Bad Request

Media typeapplication/json

object

errorCode

number

errorMessages

Array<string>

referenceId

string format: uuid

Example

{
  "errorCode": 400
}

403

Permission Denied

Media typeapplication/json

object

errorCode

number

errorMessages

Array<string>

referenceId

string format: uuid

Example

{
  "errorCode": 403
}

404

Not Found

Media typeapplication/json

object

errorCode

number

errorMessages

Array<string>

referenceId

string format: uuid

Example

{
  "errorCode": 404
}

500

Zentail Error

Media typeapplication/json

object

errorCode

number

errorMessages

Array<string>

referenceId

string format: uuid

errorMessage

string

Example

{
  "errorCode": 500
}

503

Zentail Error

Media typeapplication/json

object

errorCode

number

errorMessages

Array<string>

referenceId

string format: uuid

Example

{
  "errorCode": 503
}