API reference
- Getting Started with Your API
- SDKs and Toolkits
- Commerce Overview
- PUTAdd/Update Alternate Contact
- PUTApply Adjustment
- DELRemove Adjustment
- PUTApply Coupon
- DELRemove Coupon
- PUTApply Handling Adjustment
- DELRemove Handling Adjustment
- POSTApply Package to Order
- PUTApply Shipping Adjustment
- DELRemove Shipping Adjustment
- POSTAuto Capture Payments
- PUTCancel Order
- PUTChange Order Price List
- PUTChange Order UserId
- POSTCreate A Shipment
- POSTCreate Digital Package
- POSTCreate Payment Action
- POSTCreate Pickup
- POSTCreate Refund
- PUTDelete Order Draft
- PUTEvaluate Order Rollup Status
- GETGet Available Actions
- POSTPerform Order Action
- GETGet Available Digital Package Fulfillment Actions
- GETGet Available Payment Actions
- POSTPerform Payment Action
- GETGet Available Pickup Fulfillment Actions
- GETGet Available Shipment Methods
- GETGet Billing Info
- PUTSet Billing Info
- GETGet Digital Package
- PUTUpdate Digital Package
- DELDelete Digital Package
- GETGet Extended Properties
- PUTUpdated Extended Properties
- POSTAdds Extended Properties
- DELDelete Extended Properties
- GETGet Fulfillment Info
- PUTSet Fulfillment Info
- GETGet Order
- PUTUpdate Order
- GETGet Order Attributes
- PUTUpdate Order Attributes
- POSTCreate Order Attributes
- GETGet Order Cancel Reasons
- GETGet Order Data
- GETGet Order Item
- DELDelete Order Item
- GETGet Order Item Data
- GETGet Order Item Via LineId
- GETGet Order Items
- POSTCreate Order Item
- GETGet Order Note
- PUTUpdate Order Note
- DELDelete Order Note
- GETGet Order Notes
- POSTCreate Order Note
- GETGet Order Package
- PUTUpdate Order Package
- DELDelete Order Package
- GETGet Order Package Label
- GETGet Order Returnable Items
- GETGet Orders
- POSTCreate Order
- GETGet Payment
- GETGet Payments
- GETGet Pickup
- PUTUpdate Pickup
- DELDelete Pickup
- GETGet Queued Historical Order
- GETGet Queued Historical Orders
- GETGet Queued Order
- GETGet Queued Orders
- GETGet Refund Reasons
- GETGet Shipment
- DELDelete An Existing Order Shipment
- GETGet Taxable Orders
- GETGet Validation Results
- PUTAdd Validation Result
- POSTPerform Fulfillment Action
- POSTPrice Order
- PUTProcess Digital Wallet
- POSTProcess Return Rules
- PUTRemove Alternate Contact
- DELRemove Coupons
- POSTReprice Canceled Shipment
- POSTReprice Shipment
- POSTReprice Substitutes
- PUTResend Gateway Gift Card Email
- PUTResend Order Confirmation Email
- POSTResend Package Fulfillment Email
- PUTResend Refund Email
- GETRetrieves Available Fulfillment Actions
- PUTSms Opt Out
- GETSplit Order Into Shipment
- POSTSplit Shipments
- PUTUpdate Extended Property
- DELDelete Extended Property
- PUTUpdate Item Duty
- PUTUpdate Item Fulfillment
- PUTUpdate Item Product Price
- PUTUpdate Item Quantity
- PUTUpdate Order Data
- DELDelete Order Data
- PUTUpdate Order Discount
- PUTUpdate Order Item Data
- DELDelete Order Item Data
- PUTUpdate Order Item Discount
- PUTUpdate Order Item Gift Information
- PUTUpdate Order Item Subscription Info
- PUTUpdate Order Restrictions
- POSTUpdate Shipment Adjustments
- POSTUpdate Shipment and Multiple Shipment Items Adjustment
- POSTUpdate Shipment Item
- PUTUpdate Shipping and Suggestions
- PUTUpdate the Delivery Date of Order Item
- PUTUpdates SubstituteInfo on OrderItem
- POSTUpsert Gift Message
- PUTUpsert Inventory Tags on OrderItem
A valid request URL is required to generate request examples{
"createdDate": "2023-11-07T05:31:56Z",
"messages": [
{
"message": "<string>",
"messageType": "<string>",
"orderItemId": "<string>"
}
],
"status": "<string>",
"validationId": "<string>",
"validatorName": "<string>",
"validatorType": "<string>"
}Add Validation Result
Adds a validation result to an order from an external system. This endpoint is used by asynchronous validators that review orders after submission and push results back into Kibo — for example, a fraud service that processes orders in a background queue. The 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.
A valid request URL is required to generate request examples{
"createdDate": "2023-11-07T05:31:56Z",
"messages": [
{
"message": "<string>",
"messageType": "<string>",
"orderItemId": "<string>"
}
],
"status": "<string>",
"validationId": "<string>",
"validatorName": "<string>",
"validatorType": "<string>"
}Documentation Index
Fetch the complete documentation index at: https://docs.kibocommerce.com/llms.txt
Use this file to discover all available pages before exploring further.
Authorizations
JWT Authorization header using the Bearer scheme.
Path Parameters
Unique identifier of the order to which you want to add a note.
Query Parameters
limits which fields are returned in the response body
Body
The order validation result.
The result of an order validator.
DateTime that this validation result was created
Messages returned by the order validator
Show child attributes
Show child attributes
Status of the order validation result. See OrderValidatorStatusConst for options.
Identifier set by the capability that states the id of this specific validation attempt
Identifier set by the capability that states the specific name of this validator.
Identifies the type of the validator (types are enumerated in OrderValidatorTypeConst)
Response
Success
The result of an order validator.
DateTime that this validation result was created
Messages returned by the order validator
Show child attributes
Show child attributes
Status of the order validation result. See OrderValidatorStatusConst for options.
Identifier set by the capability that states the id of this specific validation attempt
Identifier set by the capability that states the specific name of this validator.
Identifies the type of the validator (types are enumerated in OrderValidatorTypeConst)