Notify a Zentail seller about a problem processing an order

POST

/v1/salesOrder/{orderNumber}/alert

curl --request POST \
  --url https://api.zentail.com/v1/salesOrder/1/alert \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "message": "example", "type": "example", "resolved": true, "resolution": "example" }'

Creates or resolves an alert on a salesOrder

Authorizations

• zentail_oauth
  sales:orders:fulfillment:self
• zentail_oauth
  sales:orders:self

Parameters

Path Parameters

orderNumber

required

number

Zentail Order Number

Request Body

Place all of the alert details in a JSON object in the body of the request.

Media typeapplication/json

object

message

Why the alert was raised. Required when resolved is false, and ignored when it is true.

string

type

required

string

resolved

required

boolean

resolution

Why the alert was resolved. Stored on the alert and shown to the seller. Only read when resolved is true.

string

Example^generated

{
  "message": "example",
  "type": "example",
  "resolved": true,
  "resolution": "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
}