Skip to main content
PUT
Error

Authorizations

Authorization
string
header
required

JWT Authorization header using the Bearer scheme.

Path Parameters

orderId
string
required

Unique identifier of the order to which you want to add a note.

Query Parameters

responseFields
string

limits which fields are returned in the response body

Body

application/json

The order validation result.

The result of an order validator.

createdDate
string<date-time> | null

DateTime that this validation result was created

messages
object[] | null

Messages returned by the order validator

status
string | null

Status of the order validation result. See OrderValidatorStatusConst for options.

validationId
string | null

Identifier set by the capability that states the id of this specific validation attempt

validatorName
string | null

Identifier set by the capability that states the specific name of this validator.

validatorType
string | null

Identifies the type of the validator (types are enumerated in OrderValidatorTypeConst)

Response

OK

The result of an order validator.

createdDate
string<date-time> | null

DateTime that this validation result was created

messages
object[] | null

Messages returned by the order validator

status
string | null

Status of the order validation result. See OrderValidatorStatusConst for options.

validationId
string | null

Identifier set by the capability that states the id of this specific validation attempt

validatorName
string | null

Identifier set by the capability that states the specific name of this validator.

validatorType
string | null

Identifies the type of the validator (types are enumerated in OrderValidatorTypeConst)