Paid Freight & Customs API via x402. Unpaid tool calls return 402.
Maintain this server? Claim it
Call this server's tools from your browser. Nothing to install.
Requests go through mcptry because browsers can't call most MCP servers directly. Header values are sent to the server for that request only and are never stored or logged.
Tool list from our last check. Connect live to refresh it.
Read the bill of lading number, shipper, consignee, container, and weight from supplied text. No shipment is booked. Price $0.05 USDC. POST /api/v1/freight-customs/bill-of-lading-extract. An unpaid call returns the x402 payment terms and does not run.
This tool isn't marked read-only, so it may change something on the server or in an account you connected.
Pick your client. Values in capitals, like YOUR_TOKEN, are yours to fill in.
Run in a terminal
claude mcp add --transport http freight-customs https://www.brainiac.software/mcp/freight-customs
Read the bill of lading number, shipper, consignee, container, and weight from supplied text. No shipment is booked. Price $0.05 USDC. POST /api/v1/freight-customs/bill-of-lading-extract. An unpaid call returns the x402 payment terms and does not run.
| Argument | Type | Description |
|---|---|---|
| file | object | |
| text | string | |
| shipment | object |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"file": {
"type": "object",
"required": [
"mediaType",
"fileBase64"
],
"properties": {
"filename": {
"type": "string",
"maxLength": 180,
"minLength": 1
},
"mediaType": {
"enum": [
"application/pdf",
"text/plain"
],
"type": "string"
},
"fileBase64": {
"type": "string",
"maxLength": 12000000,
"minLength": 1
}
}
},
"text": {
"type": "string",
"maxLength": 200000,
"minLength": 1
},
"shipment": {
"type": "object",
"properties": {
"lines": {
"type": "array",
"items": {
"type": "object",
"required": [
"description"
],
"properties": {
"unit": {
"type": "string",
"maxLength": 20,
"minLength": 1
},
"amount": {
"type": "number",
"maximum": 1000000000000,
"minimum": 0
},
"hsCode": {
"type": "string",
"maxLength": 14,
"minLength": 4
},
"packages": {
"type": "integer",
"maximum": 1000000,
"minimum": 0
},
"quantity": {
"type": "number",
"maximum": 1000000000,
"exclusiveMinimum": 0
},
"volumeM3": {
"type": "number",
"maximum": 1000000,
"minimum": 0
},
"unitPrice": {
"type": "number",
"maximum": 1000000000000,
"minimum": 0
},
"description": {
"type": "string",
"maxLength": 300,
"minLength": 1
},
"netWeightKg": {
"type": "number",
"maximum": 1000000000,
"minimum": 0
},
"grossWeightKg": {
"type": "number",
"maximum": 1000000000,
"minimum": 0
}
}
},
"maxItems": 80
},
"vessel": {
"type": "string",
"maxLength": 120,
"minLength": 1
},
"voyage": {
"type": "string",
"maxLength": 40,
"minLength": 1
},
"parties": {
"type": "array",
"items": {
"type": "object",
"required": [
"role",
"name"
],
"properties": {
"name": {
"type": "string",
"maxLength": 200,
"minLength": 1
},
"role": {
"enum": [
"seller",
"exporter",
"buyer",
"importer",
"consignee",
"shipper",
"notify"
],
"type": "string"
},
"address": {
"type": "string",
"maxLength": 400,
"minLength": 1
}
}
},
"maxItems": 12
},
"currency": {
"type": "string",
"pattern": "^[A-Za-z]{3}$"
},
"incoterm": {
"type": "string",
"maxLength": 80,
"minLength": 3
},
"reference": {
"type": "string",
"maxLength": 80,
"minLength": 1
},
"namedPlace": {
"type": "string",
"maxLength": 160,
"minLength": 1
},
"invoiceDate": {
"type": "string",
"format": "date",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"
},
"totalAmount": {
"type": "number",
"maximum": 1000000000000,
"minimum": 0
},
"invoiceNumber": {
"type": "string",
"maxLength": 80,
"minLength": 1
},
"originCountry": {
"type": "string",
"maxLength": 80,
"minLength": 2
},
"portOfLoading": {
"type": "string",
"maxLength": 120,
"minLength": 1
},
"totalPackages": {
"type": "integer",
"maximum": 1000000,
"minimum": 0
},
"totalVolumeM3": {
"type": "number",
"maximum": 1000000,
"minimum": 0
},
"containerNumber": {
"type": "string",
"maxLength": 20,
"minLength": 1
},
"portOfDischarge": {
"type": "string",
"maxLength": 120,
"minLength": 1
},
"totalNetWeightKg": {
"type": "number",
"maximum": 1000000000,
"minimum": 0
},
"billOfLadingNumber": {
"type": "string",
"maxLength": 80,
"minLength": 1
},
"destinationCountry": {
"type": "string",
"maxLength": 80,
"minLength": 2
},
"totalGrossWeightKg": {
"type": "number",
"maximum": 1000000000,
"minimum": 0
}
}
}
}
}Check that supplied invoice lines, quantities, and amounts agree, and that the seller, buyer, currency, and total are present. No duty is calculated. Price $0.05 USDC. POST /api/v1/freight-customs/commercial-invoice-validate. An unpaid call returns the x402 payment terms and does not run.
| Argument | Type | Description |
|---|---|---|
| file | object | |
| text | string | |
| shipment | object |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"file": {
"type": "object",
"required": [
"mediaType",
"fileBase64"
],
"properties": {
"filename": {
"type": "string",
"maxLength": 180,
"minLength": 1
},
"mediaType": {
"enum": [
"application/pdf",
"text/plain"
],
"type": "string"
},
"fileBase64": {
"type": "string",
"maxLength": 12000000,
"minLength": 1
}
}
},
"text": {
"type": "string",
"maxLength": 200000,
"minLength": 1
},
"shipment": {
"type": "object",
"properties": {
"lines": {
"type": "array",
"items": {
"type": "object",
"required": [
"description"
],
"properties": {
"unit": {
"type": "string",
"maxLength": 20,
"minLength": 1
},
"amount": {
"type": "number",
"maximum": 1000000000000,
"minimum": 0
},
"hsCode": {
"type": "string",
"maxLength": 14,
"minLength": 4
},
"packages": {
"type": "integer",
"maximum": 1000000,
"minimum": 0
},
"quantity": {
"type": "number",
"maximum": 1000000000,
"exclusiveMinimum": 0
},
"volumeM3": {
"type": "number",
"maximum": 1000000,
"minimum": 0
},
"unitPrice": {
"type": "number",
"maximum": 1000000000000,
"minimum": 0
},
"description": {
"type": "string",
"maxLength": 300,
"minLength": 1
},
"netWeightKg": {
"type": "number",
"maximum": 1000000000,
"minimum": 0
},
"grossWeightKg": {
"type": "number",
"maximum": 1000000000,
"minimum": 0
}
}
},
"maxItems": 80
},
"vessel": {
"type": "string",
"maxLength": 120,
"minLength": 1
},
"voyage": {
"type": "string",
"maxLength": 40,
"minLength": 1
},
"parties": {
"type": "array",
"items": {
"type": "object",
"required": [
"role",
"name"
],
"properties": {
"name": {
"type": "string",
"maxLength": 200,
"minLength": 1
},
"role": {
"enum": [
"seller",
"exporter",
"buyer",
"importer",
"consignee",
"shipper",
"notify"
],
"type": "string"
},
"address": {
"type": "string",
"maxLength": 400,
"minLength": 1
}
}
},
"maxItems": 12
},
"currency": {
"type": "string",
"pattern": "^[A-Za-z]{3}$"
},
"incoterm": {
"type": "string",
"maxLength": 80,
"minLength": 3
},
"reference": {
"type": "string",
"maxLength": 80,
"minLength": 1
},
"namedPlace": {
"type": "string",
"maxLength": 160,
"minLength": 1
},
"invoiceDate": {
"type": "string",
"format": "date",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"
},
"totalAmount": {
"type": "number",
"maximum": 1000000000000,
"minimum": 0
},
"invoiceNumber": {
"type": "string",
"maxLength": 80,
"minLength": 1
},
"originCountry": {
"type": "string",
"maxLength": 80,
"minLength": 2
},
"portOfLoading": {
"type": "string",
"maxLength": 120,
"minLength": 1
},
"totalPackages": {
"type": "integer",
"maximum": 1000000,
"minimum": 0
},
"totalVolumeM3": {
"type": "number",
"maximum": 1000000,
"minimum": 0
},
"containerNumber": {
"type": "string",
"maxLength": 20,
"minLength": 1
},
"portOfDischarge": {
"type": "string",
"maxLength": 120,
"minLength": 1
},
"totalNetWeightKg": {
"type": "number",
"maximum": 1000000000,
"minimum": 0
},
"billOfLadingNumber": {
"type": "string",
"maxLength": 80,
"minLength": 1
},
"destinationCountry": {
"type": "string",
"maxLength": 80,
"minLength": 2
},
"totalGrossWeightKg": {
"type": "number",
"maximum": 1000000000,
"minimum": 0
}
}
}
}
}List shipment fields that are present or missing in the supplied documents. Duty, restrictions, sanctions, and country-specific requirements stay unverified. Price $0.04 USDC. POST /api/v1/freight-customs/data-completeness. An unpaid call returns the x402 payment terms and does not run.
| Argument | Type | Description |
|---|---|---|
| file | object | |
| text | string | |
| shipment | object |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"file": {
"type": "object",
"required": [
"mediaType",
"fileBase64"
],
"properties": {
"filename": {
"type": "string",
"maxLength": 180,
"minLength": 1
},
"mediaType": {
"enum": [
"application/pdf",
"text/plain"
],
"type": "string"
},
"fileBase64": {
"type": "string",
"maxLength": 12000000,
"minLength": 1
}
}
},
"text": {
"type": "string",
"maxLength": 200000,
"minLength": 1
},
"shipment": {
"type": "object",
"properties": {
"lines": {
"type": "array",
"items": {
"type": "object",
"required": [
"description"
],
"properties": {
"unit": {
"type": "string",
"maxLength": 20,
"minLength": 1
},
"amount": {
"type": "number",
"maximum": 1000000000000,
"minimum": 0
},
"hsCode": {
"type": "string",
"maxLength": 14,
"minLength": 4
},
"packages": {
"type": "integer",
"maximum": 1000000,
"minimum": 0
},
"quantity": {
"type": "number",
"maximum": 1000000000,
"exclusiveMinimum": 0
},
"volumeM3": {
"type": "number",
"maximum": 1000000,
"minimum": 0
},
"unitPrice": {
"type": "number",
"maximum": 1000000000000,
"minimum": 0
},
"description": {
"type": "string",
"maxLength": 300,
"minLength": 1
},
"netWeightKg": {
"type": "number",
"maximum": 1000000000,
"minimum": 0
},
"grossWeightKg": {
"type": "number",
"maximum": 1000000000,
"minimum": 0
}
}
},
"maxItems": 80
},
"vessel": {
"type": "string",
"maxLength": 120,
"minLength": 1
},
"voyage": {
"type": "string",
"maxLength": 40,
"minLength": 1
},
"parties": {
"type": "array",
"items": {
"type": "object",
"required": [
"role",
"name"
],
"properties": {
"name": {
"type": "string",
"maxLength": 200,
"minLength": 1
},
"role": {
"enum": [
"seller",
"exporter",
"buyer",
"importer",
"consignee",
"shipper",
"notify"
],
"type": "string"
},
"address": {
"type": "string",
"maxLength": 400,
"minLength": 1
}
}
},
"maxItems": 12
},
"currency": {
"type": "string",
"pattern": "^[A-Za-z]{3}$"
},
"incoterm": {
"type": "string",
"maxLength": 80,
"minLength": 3
},
"reference": {
"type": "string",
"maxLength": 80,
"minLength": 1
},
"namedPlace": {
"type": "string",
"maxLength": 160,
"minLength": 1
},
"invoiceDate": {
"type": "string",
"format": "date",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"
},
"totalAmount": {
"type": "number",
"maximum": 1000000000000,
"minimum": 0
},
"invoiceNumber": {
"type": "string",
"maxLength": 80,
"minLength": 1
},
"originCountry": {
"type": "string",
"maxLength": 80,
"minLength": 2
},
"portOfLoading": {
"type": "string",
"maxLength": 120,
"minLength": 1
},
"totalPackages": {
"type": "integer",
"maximum": 1000000,
"minimum": 0
},
"totalVolumeM3": {
"type": "number",
"maximum": 1000000,
"minimum": 0
},
"containerNumber": {
"type": "string",
"maxLength": 20,
"minLength": 1
},
"portOfDischarge": {
"type": "string",
"maxLength": 120,
"minLength": 1
},
"totalNetWeightKg": {
"type": "number",
"maximum": 1000000000,
"minimum": 0
},
"billOfLadingNumber": {
"type": "string",
"maxLength": 80,
"minLength": 1
},
"destinationCountry": {
"type": "string",
"maxLength": 80,
"minLength": 2
},
"totalGrossWeightKg": {
"type": "number",
"maximum": 1000000000,
"minimum": 0
}
}
}
}
}Search the public UK Trade Tariff for commodity candidates matching a goods description. The result is not a customs classification and does not state a duty. Price $0.06 USDC. POST /api/v1/freight-customs/hs-code-candidate-suggest. An unpaid call returns the x402 payment terms and does not run.
| Argument | Type | Description |
|---|---|---|
| hsCode | string | |
| description* | string |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"description"
],
"properties": {
"hsCode": {
"type": "string",
"maxLength": 14,
"minLength": 4
},
"description": {
"type": "string",
"maxLength": 300,
"minLength": 2
}
}
}Read a named Incoterms rule and its named place from the request. The obligation text is that named rule. No duty amount is calculated. Price $0.04 USDC. POST /api/v1/freight-customs/incoterms-obligation-extract. An unpaid call returns the x402 payment terms and does not run.
| Argument | Type | Description |
|---|---|---|
| file | object | |
| text | string | |
| incoterm | string | |
| namedPlace | string |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"file": {
"type": "object",
"required": [
"mediaType",
"fileBase64"
],
"properties": {
"filename": {
"type": "string",
"maxLength": 180,
"minLength": 1
},
"mediaType": {
"enum": [
"application/pdf",
"text/plain"
],
"type": "string"
},
"fileBase64": {
"type": "string",
"maxLength": 12000000,
"minLength": 1
}
}
},
"text": {
"type": "string",
"maxLength": 200000,
"minLength": 1
},
"incoterm": {
"type": "string",
"maxLength": 80,
"minLength": 3
},
"namedPlace": {
"type": "string",
"maxLength": 160,
"minLength": 1
}
}
}Check package counts and net and gross weights on a supplied packing list. A missing weight is not treated as zero. Price $0.04 USDC. POST /api/v1/freight-customs/packing-list-validate. An unpaid call returns the x402 payment terms and does not run.
| Argument | Type | Description |
|---|---|---|
| file | object | |
| text | string | |
| shipment | object |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"file": {
"type": "object",
"required": [
"mediaType",
"fileBase64"
],
"properties": {
"filename": {
"type": "string",
"maxLength": 180,
"minLength": 1
},
"mediaType": {
"enum": [
"application/pdf",
"text/plain"
],
"type": "string"
},
"fileBase64": {
"type": "string",
"maxLength": 12000000,
"minLength": 1
}
}
},
"text": {
"type": "string",
"maxLength": 200000,
"minLength": 1
},
"shipment": {
"type": "object",
"properties": {
"lines": {
"type": "array",
"items": {
"type": "object",
"required": [
"description"
],
"properties": {
"unit": {
"type": "string",
"maxLength": 20,
"minLength": 1
},
"amount": {
"type": "number",
"maximum": 1000000000000,
"minimum": 0
},
"hsCode": {
"type": "string",
"maxLength": 14,
"minLength": 4
},
"packages": {
"type": "integer",
"maximum": 1000000,
"minimum": 0
},
"quantity": {
"type": "number",
"maximum": 1000000000,
"exclusiveMinimum": 0
},
"volumeM3": {
"type": "number",
"maximum": 1000000,
"minimum": 0
},
"unitPrice": {
"type": "number",
"maximum": 1000000000000,
"minimum": 0
},
"description": {
"type": "string",
"maxLength": 300,
"minLength": 1
},
"netWeightKg": {
"type": "number",
"maximum": 1000000000,
"minimum": 0
},
"grossWeightKg": {
"type": "number",
"maximum": 1000000000,
"minimum": 0
}
}
},
"maxItems": 80
},
"vessel": {
"type": "string",
"maxLength": 120,
"minLength": 1
},
"voyage": {
"type": "string",
"maxLength": 40,
"minLength": 1
},
"parties": {
"type": "array",
"items": {
"type": "object",
"required": [
"role",
"name"
],
"properties": {
"name": {
"type": "string",
"maxLength": 200,
"minLength": 1
},
"role": {
"enum": [
"seller",
"exporter",
"buyer",
"importer",
"consignee",
"shipper",
"notify"
],
"type": "string"
},
"address": {
"type": "string",
"maxLength": 400,
"minLength": 1
}
}
},
"maxItems": 12
},
"currency": {
"type": "string",
"pattern": "^[A-Za-z]{3}$"
},
"incoterm": {
"type": "string",
"maxLength": 80,
"minLength": 3
},
"reference": {
"type": "string",
"maxLength": 80,
"minLength": 1
},
"namedPlace": {
"type": "string",
"maxLength": 160,
"minLength": 1
},
"invoiceDate": {
"type": "string",
"format": "date",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"
},
"totalAmount": {
"type": "number",
"maximum": 1000000000000,
"minimum": 0
},
"invoiceNumber": {
"type": "string",
"maxLength": 80,
"minLength": 1
},
"originCountry": {
"type": "string",
"maxLength": 80,
"minLength": 2
},
"portOfLoading": {
"type": "string",
"maxLength": 120,
"minLength": 1
},
"totalPackages": {
"type": "integer",
"maximum": 1000000,
"minimum": 0
},
"totalVolumeM3": {
"type": "number",
"maximum": 1000000,
"minimum": 0
},
"containerNumber": {
"type": "string",
"maxLength": 20,
"minLength": 1
},
"portOfDischarge": {
"type": "string",
"maxLength": 120,
"minLength": 1
},
"totalNetWeightKg": {
"type": "number",
"maximum": 1000000000,
"minimum": 0
},
"billOfLadingNumber": {
"type": "string",
"maxLength": 80,
"minLength": 1
},
"destinationCountry": {
"type": "string",
"maxLength": 80,
"minLength": 2
},
"totalGrossWeightKg": {
"type": "number",
"maximum": 1000000000,
"minimum": 0
}
}
}
}
}Combine document checks, weight evidence, the named Incoterm, and UK Trade Tariff candidates. No declaration is submitted and no shipment is booked. Price $0.12 USDC. POST /api/v1/freight-customs/preparation-report. An unpaid call returns the x402 payment terms and does not run.
| Argument | Type | Description |
|---|---|---|
| packages | array | |
| shipment | object | |
| packingList | object | |
| billOfLading | object | |
| commercialInvoice | object | |
| volumetricDivisor | number |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"packages": {
"type": "array",
"items": {
"type": "object",
"required": [
"count"
],
"properties": {
"count": {
"type": "integer",
"maximum": 100000,
"minimum": 1
},
"widthCm": {
"type": "number",
"maximum": 100000,
"exclusiveMinimum": 0
},
"heightCm": {
"type": "number",
"maximum": 100000,
"exclusiveMinimum": 0
},
"lengthCm": {
"type": "number",
"maximum": 100000,
"exclusiveMinimum": 0
},
"description": {
"type": "string",
"maxLength": 200,
"minLength": 1
},
"netWeightKg": {
"type": "number",
"maximum": 1000000000,
"minimum": 0
},
"grossWeightKg": {
"type": "number",
"maximum": 1000000000,
"minimum": 0
}
}
},
"maxItems": 80
},
"shipment": {
"type": "object",
"properties": {
"lines": {
"type": "array",
"items": {
"type": "object",
"required": [
"description"
],
"properties": {
"unit": {
"type": "string",
"maxLength": 20,
"minLength": 1
},
"amount": {
"type": "number",
"maximum": 1000000000000,
"minimum": 0
},
"hsCode": {
"type": "string",
"maxLength": 14,
"minLength": 4
},
"packages": {
"type": "integer",
"maximum": 1000000,
"minimum": 0
},
"quantity": {
"type": "number",
"maximum": 1000000000,
"exclusiveMinimum": 0
},
"volumeM3": {
"type": "number",
"maximum": 1000000,
"minimum": 0
},
"unitPrice": {
"type": "number",
"maximum": 1000000000000,
"minimum": 0
},
"description": {
"type": "string",
"maxLength": 300,
"minLength": 1
},
"netWeightKg": {
"type": "number",
"maximum": 1000000000,
"minimum": 0
},
"grossWeightKg": {
"type": "number",
"maximum": 1000000000,
"minimum": 0
}
}
},
"maxItems": 80
},
"vessel": {
"type": "string",
"maxLength": 120,
"minLength": 1
},
"voyage": {
"type": "string",
"maxLength": 40,
"minLength": 1
},
"parties": {
"type": "array",
"items": {
"type": "object",
"required": [
"role",
"name"
],
"properties": {
"name": {
"type": "string",
"maxLength": 200,
"minLength": 1
},
"role": {
"enum": [
"seller",
"exporter",
"buyer",
"importer",
"consignee",
"shipper",
"notify"
],
"type": "string"
},
"address": {
"type": "string",
"maxLength": 400,
"minLength": 1
}
}
},
"maxItems": 12
},
"currency": {
"type": "string",
"pattern": "^[A-Za-z]{3}$"
},
"incoterm": {
"type": "string",
"maxLength": 80,
"minLength": 3
},
"reference": {
"type": "string",
"maxLength": 80,
"minLength": 1
},
"namedPlace": {
"type": "string",
"maxLength": 160,
"minLength": 1
},
"invoiceDate": {
"type": "string",
"format": "date",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"
},
"totalAmount": {
"type": "number",
"maximum": 1000000000000,
"minimum": 0
},
"invoiceNumber": {
"type": "string",
"maxLength": 80,
"minLength": 1
},
"originCountry": {
"type": "string",
"maxLength": 80,
"minLength": 2
},
"portOfLoading": {
"type": "string",
"maxLength": 120,
"minLength": 1
},
"totalPackages": {
"type": "integer",
"maximum": 1000000,
"minimum": 0
},
"totalVolumeM3": {
"type": "number",
"maximum": 1000000,
"minimum": 0
},
"containerNumber": {
"type": "string",
"maxLength": 20,
"minLength": 1
},
"portOfDischarge": {
"type": "string",
"maxLength": 120,
"minLength": 1
},
"totalNetWeightKg": {
"type": "number",
"maximum": 1000000000,
"minimum": 0
},
"billOfLadingNumber": {
"type": "string",
"maxLength": 80,
"minLength": 1
},
"destinationCountry": {
"type": "string",
"maxLength": 80,
"minLength": 2
},
"totalGrossWeightKg": {
"type": "number",
"maximum": 1000000000,
"minimum": 0
}
}
},
"packingList": {
"type": "object",
"properties": {
"file": {
"type": "object",
"required": [
"mediaType",
"fileBase64"
],
"properties": {
"filename": {
"type": "string",
"maxLength": 180,
"minLength": 1
},
"mediaType": {
"enum": [
"application/pdf",
"text/plain"
],
"type": "string"
},
"fileBase64": {
"type": "string",
"maxLength": 12000000,
"minLength": 1
}
}
},
"text": {
"type": "string",
"maxLength": 200000,
"minLength": 1
},
"shipment": {
"type": "object",
"properties": {
"lines": {
"type": "array",
"items": {
"type": "object",
"required": [
"description"
],
"properties": {
"unit": {
"type": "string",
"maxLength": 20,
"minLength": 1
},
"amount": {
"type": "number",
"maximum": 1000000000000,
"minimum": 0
},
"hsCode": {
"type": "string",
"maxLength": 14,
"minLength": 4
},
"packages": {
"type": "integer",
"maximum": 1000000,
"minimum": 0
},
"quantity": {
"type": "number",
"maximum": 1000000000,
"exclusiveMinimum": 0
},
"volumeM3": {
"type": "number",
"maximum": 1000000,
"minimum": 0
},
"unitPrice": {
"type": "number",
"maximum": 1000000000000,
"minimum": 0
},
"description": {
"type": "string",
"maxLength": 300,
"minLength": 1
},
"netWeightKg": {
"type": "number",
"maximum": 1000000000,
"minimum": 0
},
"grossWeightKg": {
"type": "number",
"maximum": 1000000000,
"minimum": 0
}
}
},
"maxItems": 80
},
"vessel": {
"type": "string",
"maxLength": 120,
"minLength": 1
},
"voyage": {
"type": "string",
"maxLength": 40,
"minLength": 1
},
"parties": {
"type": "array",
"items": {
"type": "object",
"required": [
"role",
"name"
],
"properties": {
"name": {
"type": "string",
"maxLength": 200,
"minLength": 1
},
"role": {
"enum": [
"seller",
"exporter",
"buyer",
"importer",
"consignee",
"shipper",
"notify"
],
"type": "string"
},
"address": {
"type": "string",
"maxLength": 400,
"minLength": 1
}
}
},
"maxItems": 12
},
"currency": {
"type": "string",
"pattern": "^[A-Za-z]{3}$"
},
"incoterm": {
"type": "string",
"maxLength": 80,
"minLength": 3
},
"reference": {
"type": "string",
"maxLength": 80,
"minLength": 1
},
"namedPlace": {
"type": "string",
"maxLength": 160,
"minLength": 1
},
"invoiceDate": {
"type": "string",
"format": "date",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"
},
"totalAmount": {
"type": "number",
"maximum": 1000000000000,
"minimum": 0
},
"invoiceNumber": {
"type": "string",
"maxLength": 80,
"minLength": 1
},
"originCountry": {
"type": "string",
"maxLength": 80,
"minLength": 2
},
"portOfLoading": {
"type": "string",
"maxLength": 120,
"minLength": 1
},
"totalPackages": {
"type": "integer",
"maximum": 1000000,
"minimum": 0
},
"totalVolumeM3": {
"type": "number",
"maximum": 1000000,
"minimum": 0
},
"containerNumber": {
"type": "string",
"maxLength": 20,
"minLength": 1
},
"portOfDischarge": {
"type": "string",
"maxLength": 120,
"minLength": 1
},
"totalNetWeightKg": {
"type": "number",
"maximum": 1000000000,
"minimum": 0
},
"billOfLadingNumber": {
"type": "string",
"maxLength": 80,
"minLength": 1
},
"destinationCountry": {
"type": "string",
"maxLength": 80,
"minLength": 2
},
"totalGrossWeightKg": {
"type": "number",
"maximum": 1000000000,
"minimum": 0
}
}
}
}
},
"billOfLading": {
"type": "object",
"properties": {
"file": {
"type": "object",
"required": [
"mediaType",
"fileBase64"
],
"properties": {
"filename": {
"type": "string",
"maxLength": 180,
"minLength": 1
},
"mediaType": {
"enum": [
"application/pdf",
"text/plain"
],
"type": "string"
},
"fileBase64": {
"type": "string",
"maxLength": 12000000,
"minLength": 1
}
}
},
"text": {
"type": "string",
"maxLength": 200000,
"minLength": 1
},
"shipment": {
"type": "object",
"properties": {
"lines": {
"type": "array",
"items": {
"type": "object",
"required": [
"description"
],
"properties": {
"unit": {
"type": "string",
"maxLength": 20,
"minLength": 1
},
"amount": {
"type": "number",
"maximum": 1000000000000,
"minimum": 0
},
"hsCode": {
"type": "string",
"maxLength": 14,
"minLength": 4
},
"packages": {
"type": "integer",
"maximum": 1000000,
"minimum": 0
},
"quantity": {
"type": "number",
"maximum": 1000000000,
"exclusiveMinimum": 0
},
"volumeM3": {
"type": "number",
"maximum": 1000000,
"minimum": 0
},
"unitPrice": {
"type": "number",
"maximum": 1000000000000,
"minimum": 0
},
"description": {
"type": "string",
"maxLength": 300,
"minLength": 1
},
"netWeightKg": {
"type": "number",
"maximum": 1000000000,
"minimum": 0
},
"grossWeightKg": {
"type": "number",
"maximum": 1000000000,
"minimum": 0
}
}
},
"maxItems": 80
},
"vessel": {
"type": "string",
"maxLength": 120,
"minLength": 1
},
"voyage": {
"type": "string",
"maxLength": 40,
"minLength": 1
},
"parties": {
"type": "array",
"items": {
"type": "object",
"required": [
"role",
"name"
],
"properties": {
"name": {
"type": "string",
"maxLength": 200,
"minLength": 1
},
"role": {
"enum": [
"seller",
"exporter",
"buyer",
"importer",
"consignee",
"shipper",
"notify"
],
"type": "string"
},
"address": {
"type": "string",
"maxLength": 400,
"minLength": 1
}
}
},
"maxItems": 12
},
"currency": {
"type": "string",
"pattern": "^[A-Za-z]{3}$"
},
"incoterm": {
"type": "string",
"maxLength": 80,
"minLength": 3
},
"reference": {
"type": "string",
"maxLength": 80,
"minLength": 1
},
"namedPlace": {
"type": "string",
"maxLength": 160,
"minLength": 1
},
"invoiceDate": {
"type": "string",
"format": "date",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"
},
"totalAmount": {
"type": "number",
"maximum": 1000000000000,
"minimum": 0
},
"invoiceNumber": {
"type": "string",
"maxLength": 80,
"minLength": 1
},
"originCountry": {
"type": "string",
"maxLength": 80,
"minLength": 2
},
"portOfLoading": {
"type": "string",
"maxLength": 120,
"minLength": 1
},
"totalPackages": {
"type": "integer",
"maximum": 1000000,
"minimum": 0
},
"totalVolumeM3": {
"type": "number",
"maximum": 1000000,
"minimum": 0
},
"containerNumber": {
"type": "string",
"maxLength": 20,
"minLength": 1
},
"portOfDischarge": {
"type": "string",
"maxLength": 120,
"minLength": 1
},
"totalNetWeightKg": {
"type": "number",
"maximum": 1000000000,
"minimum": 0
},
"billOfLadingNumber": {
"type": "string",
"maxLength": 80,
"minLength": 1
},
"destinationCountry": {
"type": "string",
"maxLength": 80,
"minLength": 2
},
"totalGrossWeightKg": {
"type": "number",
"maximum": 1000000000,
"minimum": 0
}
}
}
}
},
"commercialInvoice": {
"type": "object",
"properties": {
"file": {
"type": "object",
"required": [
"mediaType",
"fileBase64"
],
"properties": {
"filename": {
"type": "string",
"maxLength": 180,
"minLength": 1
},
"mediaType": {
"enum": [
"application/pdf",
"text/plain"
],
"type": "string"
},
"fileBase64": {
"type": "string",
"maxLength": 12000000,
"minLength": 1
}
}
},
"text": {
"type": "string",
"maxLength": 200000,
"minLength": 1
},
"shipment": {
"type": "object",
"properties": {
"lines": {
"type": "array",
"items": {
"type": "object",
"required": [
"description"
],
"properties": {
"unit": {
"type": "string",
"maxLength": 20,
"minLength": 1
},
"amount": {
"type": "number",
"maximum": 1000000000000,
"minimum": 0
},
"hsCode": {
"type": "string",
"maxLength": 14,
"minLength": 4
},
"packages": {
"type": "integer",
"maximum": 1000000,
"minimum": 0
},
"quantity": {
"type": "number",
"maximum": 1000000000,
"exclusiveMinimum": 0
},
"volumeM3": {
"type": "number",
"maximum": 1000000,
"minimum": 0
},
"unitPrice": {
"type": "number",
"maximum": 1000000000000,
"minimum": 0
},
"description": {
"type": "string",
"maxLength": 300,
"minLength": 1
},
"netWeightKg": {
"type": "number",
"maximum": 1000000000,
"minimum": 0
},
"grossWeightKg": {
"type": "number",
"maximum": 1000000000,
"minimum": 0
}
}
},
"maxItems": 80
},
"vessel": {
"type": "string",
"maxLength": 120,
"minLength": 1
},
"voyage": {
"type": "string",
"maxLength": 40,
"minLength": 1
},
"parties": {
"type": "array",
"items": {
"type": "object",
"required": [
"role",
"name"
],
"properties": {
"name": {
"type": "string",
"maxLength": 200,
"minLength": 1
},
"role": {
"enum": [
"seller",
"exporter",
"buyer",
"importer",
"consignee",
"shipper",
"notify"
],
"type": "string"
},
"address": {
"type": "string",
"maxLength": 400,
"minLength": 1
}
}
},
"maxItems": 12
},
"currency": {
"type": "string",
"pattern": "^[A-Za-z]{3}$"
},
"incoterm": {
"type": "string",
"maxLength": 80,
"minLength": 3
},
"reference": {
"type": "string",
"maxLength": 80,
"minLength": 1
},
"namedPlace": {
"type": "string",
"maxLength": 160,
"minLength": 1
},
"invoiceDate": {
"type": "string",
"format": "date",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"
},
"totalAmount": {
"type": "number",
"maximum": 1000000000000,
"minimum": 0
},
"invoiceNumber": {
"type": "string",
"maxLength": 80,
"minLength": 1
},
"originCountry": {
"type": "string",
"maxLength": 80,
"minLength": 2
},
"portOfLoading": {
"type": "string",
"maxLength": 120,
"minLength": 1
},
"totalPackages": {
"type": "integer",
"maximum": 1000000,
"minimum": 0
},
"totalVolumeM3": {
"type": "number",
"maximum": 1000000,
"minimum": 0
},
"containerNumber": {
"type": "string",
"maxLength": 20,
"minLength": 1
},
"portOfDischarge": {
"type": "string",
"maxLength": 120,
"minLength": 1
},
"totalNetWeightKg": {
"type": "number",
"maximum": 1000000000,
"minimum": 0
},
"billOfLadingNumber": {
"type": "string",
"maxLength": 80,
"minLength": 1
},
"destinationCountry": {
"type": "string",
"maxLength": 80,
"minLength": 2
},
"totalGrossWeightKg": {
"type": "number",
"maximum": 1000000000,
"minimum": 0
}
}
}
}
},
"volumetricDivisor": {
"type": "number",
"maximum": 10000,
"exclusiveMinimum": 0
}
}
}Compare references, parties, quantities, and weights across at least two supplied documents. A field that appears on only one document is reported separately from a conflict. Price $0.06 USDC. POST /api/v1/freight-customs/shipment-document-consistency. An unpaid call returns the x402 payment terms and does not run.
| Argument | Type | Description |
|---|---|---|
| packingList | object | |
| billOfLading | object | |
| commercialInvoice | object |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"packingList": {
"type": "object",
"properties": {
"file": {
"type": "object",
"required": [
"mediaType",
"fileBase64"
],
"properties": {
"filename": {
"type": "string",
"maxLength": 180,
"minLength": 1
},
"mediaType": {
"enum": [
"application/pdf",
"text/plain"
],
"type": "string"
},
"fileBase64": {
"type": "string",
"maxLength": 12000000,
"minLength": 1
}
}
},
"text": {
"type": "string",
"maxLength": 200000,
"minLength": 1
},
"shipment": {
"type": "object",
"properties": {
"lines": {
"type": "array",
"items": {
"type": "object",
"required": [
"description"
],
"properties": {
"unit": {
"type": "string",
"maxLength": 20,
"minLength": 1
},
"amount": {
"type": "number",
"maximum": 1000000000000,
"minimum": 0
},
"hsCode": {
"type": "string",
"maxLength": 14,
"minLength": 4
},
"packages": {
"type": "integer",
"maximum": 1000000,
"minimum": 0
},
"quantity": {
"type": "number",
"maximum": 1000000000,
"exclusiveMinimum": 0
},
"volumeM3": {
"type": "number",
"maximum": 1000000,
"minimum": 0
},
"unitPrice": {
"type": "number",
"maximum": 1000000000000,
"minimum": 0
},
"description": {
"type": "string",
"maxLength": 300,
"minLength": 1
},
"netWeightKg": {
"type": "number",
"maximum": 1000000000,
"minimum": 0
},
"grossWeightKg": {
"type": "number",
"maximum": 1000000000,
"minimum": 0
}
}
},
"maxItems": 80
},
"vessel": {
"type": "string",
"maxLength": 120,
"minLength": 1
},
"voyage": {
"type": "string",
"maxLength": 40,
"minLength": 1
},
"parties": {
"type": "array",
"items": {
"type": "object",
"required": [
"role",
"name"
],
"properties": {
"name": {
"type": "string",
"maxLength": 200,
"minLength": 1
},
"role": {
"enum": [
"seller",
"exporter",
"buyer",
"importer",
"consignee",
"shipper",
"notify"
],
"type": "string"
},
"address": {
"type": "string",
"maxLength": 400,
"minLength": 1
}
}
},
"maxItems": 12
},
"currency": {
"type": "string",
"pattern": "^[A-Za-z]{3}$"
},
"incoterm": {
"type": "string",
"maxLength": 80,
"minLength": 3
},
"reference": {
"type": "string",
"maxLength": 80,
"minLength": 1
},
"namedPlace": {
"type": "string",
"maxLength": 160,
"minLength": 1
},
"invoiceDate": {
"type": "string",
"format": "date",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"
},
"totalAmount": {
"type": "number",
"maximum": 1000000000000,
"minimum": 0
},
"invoiceNumber": {
"type": "string",
"maxLength": 80,
"minLength": 1
},
"originCountry": {
"type": "string",
"maxLength": 80,
"minLength": 2
},
"portOfLoading": {
"type": "string",
"maxLength": 120,
"minLength": 1
},
"totalPackages": {
"type": "integer",
"maximum": 1000000,
"minimum": 0
},
"totalVolumeM3": {
"type": "number",
"maximum": 1000000,
"minimum": 0
},
"containerNumber": {
"type": "string",
"maxLength": 20,
"minLength": 1
},
"portOfDischarge": {
"type": "string",
"maxLength": 120,
"minLength": 1
},
"totalNetWeightKg": {
"type": "number",
"maximum": 1000000000,
"minimum": 0
},
"billOfLadingNumber": {
"type": "string",
"maxLength": 80,
"minLength": 1
},
"destinationCountry": {
"type": "string",
"maxLength": 80,
"minLength": 2
},
"totalGrossWeightKg": {
"type": "number",
"maximum": 1000000000,
"minimum": 0
}
}
}
}
},
"billOfLading": {
"type": "object",
"properties": {
"file": {
"type": "object",
"required": [
"mediaType",
"fileBase64"
],
"properties": {
"filename": {
"type": "string",
"maxLength": 180,
"minLength": 1
},
"mediaType": {
"enum": [
"application/pdf",
"text/plain"
],
"type": "string"
},
"fileBase64": {
"type": "string",
"maxLength": 12000000,
"minLength": 1
}
}
},
"text": {
"type": "string",
"maxLength": 200000,
"minLength": 1
},
"shipment": {
"type": "object",
"properties": {
"lines": {
"type": "array",
"items": {
"type": "object",
"required": [
"description"
],
"properties": {
"unit": {
"type": "string",
"maxLength": 20,
"minLength": 1
},
"amount": {
"type": "number",
"maximum": 1000000000000,
"minimum": 0
},
"hsCode": {
"type": "string",
"maxLength": 14,
"minLength": 4
},
"packages": {
"type": "integer",
"maximum": 1000000,
"minimum": 0
},
"quantity": {
"type": "number",
"maximum": 1000000000,
"exclusiveMinimum": 0
},
"volumeM3": {
"type": "number",
"maximum": 1000000,
"minimum": 0
},
"unitPrice": {
"type": "number",
"maximum": 1000000000000,
"minimum": 0
},
"description": {
"type": "string",
"maxLength": 300,
"minLength": 1
},
"netWeightKg": {
"type": "number",
"maximum": 1000000000,
"minimum": 0
},
"grossWeightKg": {
"type": "number",
"maximum": 1000000000,
"minimum": 0
}
}
},
"maxItems": 80
},
"vessel": {
"type": "string",
"maxLength": 120,
"minLength": 1
},
"voyage": {
"type": "string",
"maxLength": 40,
"minLength": 1
},
"parties": {
"type": "array",
"items": {
"type": "object",
"required": [
"role",
"name"
],
"properties": {
"name": {
"type": "string",
"maxLength": 200,
"minLength": 1
},
"role": {
"enum": [
"seller",
"exporter",
"buyer",
"importer",
"consignee",
"shipper",
"notify"
],
"type": "string"
},
"address": {
"type": "string",
"maxLength": 400,
"minLength": 1
}
}
},
"maxItems": 12
},
"currency": {
"type": "string",
"pattern": "^[A-Za-z]{3}$"
},
"incoterm": {
"type": "string",
"maxLength": 80,
"minLength": 3
},
"reference": {
"type": "string",
"maxLength": 80,
"minLength": 1
},
"namedPlace": {
"type": "string",
"maxLength": 160,
"minLength": 1
},
"invoiceDate": {
"type": "string",
"format": "date",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"
},
"totalAmount": {
"type": "number",
"maximum": 1000000000000,
"minimum": 0
},
"invoiceNumber": {
"type": "string",
"maxLength": 80,
"minLength": 1
},
"originCountry": {
"type": "string",
"maxLength": 80,
"minLength": 2
},
"portOfLoading": {
"type": "string",
"maxLength": 120,
"minLength": 1
},
"totalPackages": {
"type": "integer",
"maximum": 1000000,
"minimum": 0
},
"totalVolumeM3": {
"type": "number",
"maximum": 1000000,
"minimum": 0
},
"containerNumber": {
"type": "string",
"maxLength": 20,
"minLength": 1
},
"portOfDischarge": {
"type": "string",
"maxLength": 120,
"minLength": 1
},
"totalNetWeightKg": {
"type": "number",
"maximum": 1000000000,
"minimum": 0
},
"billOfLadingNumber": {
"type": "string",
"maxLength": 80,
"minLength": 1
},
"destinationCountry": {
"type": "string",
"maxLength": 80,
"minLength": 2
},
"totalGrossWeightKg": {
"type": "number",
"maximum": 1000000000,
"minimum": 0
}
}
}
}
},
"commercialInvoice": {
"type": "object",
"properties": {
"file": {
"type": "object",
"required": [
"mediaType",
"fileBase64"
],
"properties": {
"filename": {
"type": "string",
"maxLength": 180,
"minLength": 1
},
"mediaType": {
"enum": [
"application/pdf",
"text/plain"
],
"type": "string"
},
"fileBase64": {
"type": "string",
"maxLength": 12000000,
"minLength": 1
}
}
},
"text": {
"type": "string",
"maxLength": 200000,
"minLength": 1
},
"shipment": {
"type": "object",
"properties": {
"lines": {
"type": "array",
"items": {
"type": "object",
"required": [
"description"
],
"properties": {
"unit": {
"type": "string",
"maxLength": 20,
"minLength": 1
},
"amount": {
"type": "number",
"maximum": 1000000000000,
"minimum": 0
},
"hsCode": {
"type": "string",
"maxLength": 14,
"minLength": 4
},
"packages": {
"type": "integer",
"maximum": 1000000,
"minimum": 0
},
"quantity": {
"type": "number",
"maximum": 1000000000,
"exclusiveMinimum": 0
},
"volumeM3": {
"type": "number",
"maximum": 1000000,
"minimum": 0
},
"unitPrice": {
"type": "number",
"maximum": 1000000000000,
"minimum": 0
},
"description": {
"type": "string",
"maxLength": 300,
"minLength": 1
},
"netWeightKg": {
"type": "number",
"maximum": 1000000000,
"minimum": 0
},
"grossWeightKg": {
"type": "number",
"maximum": 1000000000,
"minimum": 0
}
}
},
"maxItems": 80
},
"vessel": {
"type": "string",
"maxLength": 120,
"minLength": 1
},
"voyage": {
"type": "string",
"maxLength": 40,
"minLength": 1
},
"parties": {
"type": "array",
"items": {
"type": "object",
"required": [
"role",
"name"
],
"properties": {
"name": {
"type": "string",
"maxLength": 200,
"minLength": 1
},
"role": {
"enum": [
"seller",
"exporter",
"buyer",
"importer",
"consignee",
"shipper",
"notify"
],
"type": "string"
},
"address": {
"type": "string",
"maxLength": 400,
"minLength": 1
}
}
},
"maxItems": 12
},
"currency": {
"type": "string",
"pattern": "^[A-Za-z]{3}$"
},
"incoterm": {
"type": "string",
"maxLength": 80,
"minLength": 3
},
"reference": {
"type": "string",
"maxLength": 80,
"minLength": 1
},
"namedPlace": {
"type": "string",
"maxLength": 160,
"minLength": 1
},
"invoiceDate": {
"type": "string",
"format": "date",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"
},
"totalAmount": {
"type": "number",
"maximum": 1000000000000,
"minimum": 0
},
"invoiceNumber": {
"type": "string",
"maxLength": 80,
"minLength": 1
},
"originCountry": {
"type": "string",
"maxLength": 80,
"minLength": 2
},
"portOfLoading": {
"type": "string",
"maxLength": 120,
"minLength": 1
},
"totalPackages": {
"type": "integer",
"maximum": 1000000,
"minimum": 0
},
"totalVolumeM3": {
"type": "number",
"maximum": 1000000,
"minimum": 0
},
"containerNumber": {
"type": "string",
"maxLength": 20,
"minLength": 1
},
"portOfDischarge": {
"type": "string",
"maxLength": 120,
"minLength": 1
},
"totalNetWeightKg": {
"type": "number",
"maximum": 1000000000,
"minimum": 0
},
"billOfLadingNumber": {
"type": "string",
"maxLength": 80,
"minLength": 1
},
"destinationCountry": {
"type": "string",
"maxLength": 80,
"minLength": 2
},
"totalGrossWeightKg": {
"type": "number",
"maximum": 1000000000,
"minimum": 0
}
}
}
}
}
}
}Sum supplied package weights and calculate volume from centimetre dimensions. Volumetric weight is calculated only when the request includes a divisor. Price $0.03 USDC. POST /api/v1/freight-customs/shipment-weight-volume-calculate. An unpaid call returns the x402 payment terms and does not run.
| Argument | Type | Description |
|---|---|---|
| packages* | array | |
| statedVolumeM3 | number | |
| statedNetWeightKg | number | |
| volumetricDivisor | number | |
| statedGrossWeightKg | number |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"packages"
],
"properties": {
"packages": {
"type": "array",
"items": {
"type": "object",
"required": [
"count"
],
"properties": {
"count": {
"type": "integer",
"maximum": 100000,
"minimum": 1
},
"widthCm": {
"type": "number",
"maximum": 100000,
"exclusiveMinimum": 0
},
"heightCm": {
"type": "number",
"maximum": 100000,
"exclusiveMinimum": 0
},
"lengthCm": {
"type": "number",
"maximum": 100000,
"exclusiveMinimum": 0
},
"description": {
"type": "string",
"maxLength": 200,
"minLength": 1
},
"netWeightKg": {
"type": "number",
"maximum": 1000000000,
"minimum": 0
},
"grossWeightKg": {
"type": "number",
"maximum": 1000000000,
"minimum": 0
}
}
},
"maxItems": 80,
"minItems": 1
},
"statedVolumeM3": {
"type": "number",
"maximum": 1000000,
"minimum": 0
},
"statedNetWeightKg": {
"type": "number",
"maximum": 1000000000,
"minimum": 0
},
"volumetricDivisor": {
"type": "number",
"maximum": 10000,
"exclusiveMinimum": 0
},
"statedGrossWeightKg": {
"type": "number",
"maximum": 1000000000,
"minimum": 0
}
}
}Read parties, addresses, goods lines, weights, values, and references from supplied shipment text or a text-based PDF. Fields that are not printed are left empty. Price $0.05 USDC. POST /api/v1/freight-customs/shipping-document-extract. An unpaid call returns the x402 payment terms and does not run.
| Argument | Type | Description |
|---|---|---|
| file | object | |
| text | string | |
| shipment | object |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"file": {
"type": "object",
"required": [
"mediaType",
"fileBase64"
],
"properties": {
"filename": {
"type": "string",
"maxLength": 180,
"minLength": 1
},
"mediaType": {
"enum": [
"application/pdf",
"text/plain"
],
"type": "string"
},
"fileBase64": {
"type": "string",
"maxLength": 12000000,
"minLength": 1
}
}
},
"text": {
"type": "string",
"maxLength": 200000,
"minLength": 1
},
"shipment": {
"type": "object",
"properties": {
"lines": {
"type": "array",
"items": {
"type": "object",
"required": [
"description"
],
"properties": {
"unit": {
"type": "string",
"maxLength": 20,
"minLength": 1
},
"amount": {
"type": "number",
"maximum": 1000000000000,
"minimum": 0
},
"hsCode": {
"type": "string",
"maxLength": 14,
"minLength": 4
},
"packages": {
"type": "integer",
"maximum": 1000000,
"minimum": 0
},
"quantity": {
"type": "number",
"maximum": 1000000000,
"exclusiveMinimum": 0
},
"volumeM3": {
"type": "number",
"maximum": 1000000,
"minimum": 0
},
"unitPrice": {
"type": "number",
"maximum": 1000000000000,
"minimum": 0
},
"description": {
"type": "string",
"maxLength": 300,
"minLength": 1
},
"netWeightKg": {
"type": "number",
"maximum": 1000000000,
"minimum": 0
},
"grossWeightKg": {
"type": "number",
"maximum": 1000000000,
"minimum": 0
}
}
},
"maxItems": 80
},
"vessel": {
"type": "string",
"maxLength": 120,
"minLength": 1
},
"voyage": {
"type": "string",
"maxLength": 40,
"minLength": 1
},
"parties": {
"type": "array",
"items": {
"type": "object",
"required": [
"role",
"name"
],
"properties": {
"name": {
"type": "string",
"maxLength": 200,
"minLength": 1
},
"role": {
"enum": [
"seller",
"exporter",
"buyer",
"importer",
"consignee",
"shipper",
"notify"
],
"type": "string"
},
"address": {
"type": "string",
"maxLength": 400,
"minLength": 1
}
}
},
"maxItems": 12
},
"currency": {
"type": "string",
"pattern": "^[A-Za-z]{3}$"
},
"incoterm": {
"type": "string",
"maxLength": 80,
"minLength": 3
},
"reference": {
"type": "string",
"maxLength": 80,
"minLength": 1
},
"namedPlace": {
"type": "string",
"maxLength": 160,
"minLength": 1
},
"invoiceDate": {
"type": "string",
"format": "date",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"
},
"totalAmount": {
"type": "number",
"maximum": 1000000000000,
"minimum": 0
},
"invoiceNumber": {
"type": "string",
"maxLength": 80,
"minLength": 1
},
"originCountry": {
"type": "string",
"maxLength": 80,
"minLength": 2
},
"portOfLoading": {
"type": "string",
"maxLength": 120,
"minLength": 1
},
"totalPackages": {
"type": "integer",
"maximum": 1000000,
"minimum": 0
},
"totalVolumeM3": {
"type": "number",
"maximum": 1000000,
"minimum": 0
},
"containerNumber": {
"type": "string",
"maxLength": 20,
"minLength": 1
},
"portOfDischarge": {
"type": "string",
"maxLength": 120,
"minLength": 1
},
"totalNetWeightKg": {
"type": "number",
"maximum": 1000000000,
"minimum": 0
},
"billOfLadingNumber": {
"type": "string",
"maxLength": 80,
"minLength": 1
},
"destinationCountry": {
"type": "string",
"maxLength": 80,
"minLength": 2
},
"totalGrossWeightKg": {
"type": "number",
"maximum": 1000000000,
"minimum": 0
}
}
}
}
}We read every tool's name, description and inputs the way the model will, looking for instructions hidden from you. A clean result means no warning signs, not a guarantee. Scanned Nov 19, 2026.
No readOnlyHint / destructiveHint annotations, so clients can't tell a read from a write without asking.
Fix: Add annotations to each tool, e.g. { readOnlyHint: true } for tools that only read.