Confirm that the channel has recieved a Zentail-initiated status change

POST

/v1/salesOrder/{orderNumber}/confirmStatus

curl --request POST \
  --url https://api.zentail.com/v1/salesOrder/1/confirmStatus \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "status": "PENDING_PAYMENT", "lineItems": [ "example" ] }'

ConfirmStatus is an API for sales channels to use to acknowledge that they have received and accepted status changes intiated from Zentail. This should not be used to cancel or ship an order, just to confirm a status that the channel has received.

Authorizations

• zentail_oauth
  sales:orders:self

Parameters

Path Parameters

orderNumber

required

number

Zentail order number

Request Body

Place all of the details in a json object in the body of the request.

Media typeapplication/json

object

status

required

string

Allowed values: PENDING_PAYMENT PENDING PARTIALLY_SHIPPED SHIPPED PARTIALLY_CACNCELLED CANCELLED RETURNED REFUNDED RETURN_REQUESTED

lineItems

required

Array<string>

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
}