validationId and createdDate fields are required. The status value (Pass, Review, Fail, or Error) determines whether the order proceeds to fulfillment or is held in PendingReview. See the Order Validators and Fraud Check Applications guide for the full schema, status effects, and implementation guidance.
## OpenAPI
````yaml /openapi/openapi_commerce.json put /commerce/orders/{orderId}/validationresults
openapi: 3.0.1
info:
description: |-
The Commerce API interacts with the commerce entities of your tenant, including shoppers's active shopping carts, checkouts, submitted orders, wishlists, and returns as well as B2B quotes.
Use the Carts resource to manage storefront shopping carts as shoppers add and remove items for purchase. Each time a shopper's cart is modified, the Carts resource updates the estimated total with any applicable discounts.
Use the Channels and Channel Groups resources to manage the channels a company uses to create logical commercial business divisions based on region or types of sales, such as "US Online," "Amazon," or "EMEA Retail." All orders include a channel association that enables the company to perform financial reporting for each defined channel. Because channels are managed at the tenant level, you must associate all the tenant's sites with a channel. Sites that do not have a defined channel association cannot successfully submit orders.
Use the Checkouts resource to track a shopper's order items and their intended destinations on sites that have the multiple shipment feature enabled.
Use the Orders resource to manage all components of order processing, payment, and order-level fulfillment.
Use the Quotes resource to support B2B functionality by managing order quotes, similar to wishlists.
Use the Returns resource to manage returned items that were previously fufilled. Returns can include any number of items associated with an original order. Each return must either be associated with an original order or a product definition to represent each returned item.
Use the Wish Lists resource to manage the shopper wish lists of products associated with a customer account. Although customer accounts are managed at the tenant level, the system stores shopper wish lists at the site level. This enables the same customer to have wish lists for each of a merchant's sites. The Wish List Items resource allows you to manage the individual items in a wish list.
validationId and createdDate fields are
required. The status value (Pass,
Review, Fail, or Error)
determines whether the order proceeds to fulfillment or is held in
PendingReview. See the Order
Validators and Fraud Check Applications guide for the full schema,
status effects, and implementation guidance.
parameters:
- description: Unique identifier of the order to which you want to add a note.
in: path
name: orderId
required: true
schema:
type: string
- description: limits which fields are returned in the response body
in: query
name: responseFields
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/OrderValidationResult'
description: The order validation result.
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/OrderValidationResult'
text/json:
schema:
$ref: '#/components/schemas/OrderValidationResult'
text/plain:
schema:
$ref: '#/components/schemas/OrderValidationResult'
description: OK
components:
schemas:
OrderValidationResult:
description: The result of an order validator.
properties:
createdDate:
description: DateTime that this validation result was created
format: date-time
nullable: true
type: string
messages:
description: Messages returned by the order validator
items:
$ref: '#/components/schemas/OrderValidationMessage'
nullable: true
type: array
status:
description: >-
Status of the order validation result. See
OrderValidatorStatusConst for options.
nullable: true
type: string
validationId:
description: >-
Identifier set by the capability that states the id of this specific
validation attempt
nullable: true
type: string
validatorName:
description: >-
Identifier set by the capability that states the specific name of
this validator.
nullable: true
type: string
validatorType:
description: >-
Identifies the type of the validator (types are enumerated in
OrderValidatorTypeConst)
nullable: true
type: string
type: object
OrderValidationMessage:
description: Validation message returned by an order validator.
properties:
message:
description: Actual message returned by the validator.
nullable: true
type: string
messageType:
description: >-
Identifier to indicate the type of the message, See
OrderValidatorMessageTypeConst for options.
nullable: true
type: string
orderItemId:
description: Order item id that this message applies to. Can be empty.
nullable: true
type: string
type: object
securitySchemes:
bearerAuth:
bearerFormat: JWT
description: JWT Authorization header using the Bearer scheme.
scheme: bearer
type: http
````