Skip to content
GET
/v1/integration/{integrationId}/orderSync
curl --request GET \
--url https://api.zentail.com/v1/integration/1/orderSync \
--header 'Authorization: Bearer <token>'

Returns false when order sync is turned off for the integration, whether by Zentail staff, by the pause applied when the channel connection is lost, or because it was never turned on. A channel service should then stop importing new orders for it.

integrationId
required
integer

Zentail Integration ID

Success

Media typeapplication/json
object
enabled
boolean
Examplegenerated
{
"enabled": true
}

Bad Request

Media typeapplication/json
object
errorCode
number
errorMessages
Array<string>
referenceId
string format: uuid
Example
{
"errorCode": 400
}

Permission Denied

Media typeapplication/json
object
errorCode
number
errorMessages
Array<string>
referenceId
string format: uuid
Example
{
"errorCode": 403
}

Not Found

Media typeapplication/json
object
errorCode
number
errorMessages
Array<string>
referenceId
string format: uuid
Example
{
"errorCode": 404
}

Zentail Error

Media typeapplication/json
object
errorCode
number
errorMessages
Array<string>
referenceId
string format: uuid
errorMessage
string
Example
{
"errorCode": 500
}

Zentail Error

Media typeapplication/json
object
errorCode
number
errorMessages
Array<string>
referenceId
string format: uuid
Example
{
"errorCode": 503
}

Sourcesnapshot of https://app.zentail.com/api/swagger, committed at spec/v1/zentail-api.json

Builtf1d143e6

API changelog