commerce/orders/validationresults

Manage the results of order validation.

JSON Example

OrderValidationResult Properties

Property Description
createdDate

type: DateTime

DateTime that this validation result was created

messages

type: list of orderValidationMessage

Array list of validation and status messages associated with shipping rates, orders, and product purchasable state.

orderValidationMessage.message

type: string

The text of the change message, such as "This product is no longer available." System-supplied and read-only.

orderValidationMessage.messageType

type: string

The type of message returned by the order validation capability, such as "Fraud Score."

orderValidationMessage.orderItemId

type: string

Unique identifier of the order item associated with a validation message, order, or return.

status

type: string

The current status of the object.

This value is read only. Valid values for this field are: "Active", "Expired", and "Inactive".

validationId

type: string

Read-only identifier defined by the order validation capability that uniquely identifies this validation operation.

validatorName

type: string

Read-only name of this order validator supplied by the capability.

validatorType

type: string

The type of order validator supplied by the capability. At this time, the only supported validator type is Fraud.

Operations

Operation Name Request URI Description
AddValidationResult PUT %7borderId%7d%2fvalidationresults%3fresponseFields%3d%7bresponseFields%7d

Add a new order validation result to a submitted order.

GetValidationResults GET %7borderId%7d%2fvalidationresults

Retrieves a list of the validation results associated with the order.