Use this format to send or receive AI-based validation checks related to shipment references.
This document provides shipment reference information for AI validation and verification purposes. The AI checks validate various aspects of the shipment including documentation, compliance, packaging, and logistics requirements.
| Name | Description |
|---|---|
| Root | The top level document |
| Shipment | A shipment of products. |
| AICheckResult | A single AI validation check result |
| Name | Data Type | Description | Required |
|---|---|---|---|
aiResult | Array<AICheckResult> | AI validation check results for the shipment | |
doc_type | String | Always ai_checks | |
shipment | Shipment | Shipment reference information | |
version | String | The version of the specification being used. |
| Name | Data Type | Description | Required |
|---|---|---|---|
agent_reference | String | Reference number provided by the agent | |
booking_reference | String | Booking reference number provided by the party making the booking | |
carrier_booking_number | String | The booking number provided by the carrier | |
consignee_reference | String | A reference number provided by the consignee which will be used to identify the shipment upon receipt. | |
delivery_reference | String | The delivery reference for the shipment | |
forwarder_reference | String | Shipment reference number assigned by the freight forwarder | |
house_bill | String | House bill of lading number | |
master_bill | String | Master bill of lading number | |
po_numbers | String | Purchase orders associated with the shipment | |
quote_reference | String | The reference number for the quote associated with the shipment. | |
shipper_reference | String | Reference number provided by the shipper |
| Name | Data Type | Description | Required |
|---|---|---|---|
explanation | String | A detailed explanation of the check result and any recommended actions | |
name | String | The name of the AI check performed | |
status | String | The status of the check. Should be one of: compliant, non-compliant, or requires-attention |