Get Validation Results

Retrieves all validation results stored on an order. Each result represents the outcome of an order validator capability — such as a fraud check — that was called when the order was submitted. Results include the validator status (Pass, Review, Fail, or Error), validator type, and any messages returned by the validator. See the Order Validators and Fraud Check Applications guide for full details on how validation results affect order state.

GET /commerce/orders/{orderId}/validationresults

Error

A valid request URL is required to generate request examples

200

[
  {
    "createdDate": "2023-11-07T05:31:56Z",
    "messages": [
      {
        "message": "<string>",
        "messageType": "<string>",
        "orderItemId": "<string>"
      }
    ],
    "status": "<string>",
    "validationId": "<string>",
    "validatorName": "<string>",
    "validatorType": "<string>"
  }
]

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

Response

200

application/json

Success

createdDate · string<date-time> | null

DateTime that this validation result was created

messages · object[] | null

Messages returned by the order validator

Show child attributes

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)