Transport Document

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/evergreen-marine/main/json-schema/evergreen-marine-transport-document-schema.json",
  "title": "Transport Document",
  "description": "The document that governs the terms of carriage between shipper and carrier for maritime transportation. Two distinct types of transport documents exist:\n- Bill of Lading\n- Sea Waybill. \n",
  "x-generated": "2026-10-18",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/evergreen-marine-transport-document-openapi.yml#/components/schemas/TransportDocument",
  "type": "object",
  "properties": {
    "transportDocumentReference": {
      "type": "string",
      "pattern": "^\\S(?:.*\\S)?$",
      "maxLength": 20,
      "description": "A unique number allocated by the shipping line to the transport document and the main number used for the tracking of the status of the shipment.\n"
    },
    "transportDocumentSubReference": {
      "type": "string",
      "pattern": "^\\S(?:.*\\S)?$",
      "maxLength": 100,
      "description": "Additional reference that can be optionally used alongside the `transportDocumentReference` in order to distinguish between versions of the same `Transport Document`.\n"
    },
    "shippingInstructionsReference": {
      "type": "string",
      "pattern": "^\\S(?:.*\\S)?$",
      "maxLength": 100,
      "description": "The identifier for a `Shipping Instructions` provided by the carrier for system purposes.\n"
    },
    "transportDocumentStatus": {
      "type": "string",
      "maxLength": 50,
      "description": "The status of the `Transport Document`. Possible values are:\n- DRAFT\n- APPROVED\n- ISSUED\n- PENDING_SURRENDER_FOR_AMENDMENT\n- SURRENDERED_FOR_AMENDMENT\n- PENDING_SURRENDER_FOR_DELIVERY\n- SURRENDERED_FOR_DELIVERY\n- VOIDED\n"
    },
    "transportDocumentTypeCode": {
      "type": "string",
      "description": "Specifies the type of the transport document\n- `BOL` (Bill of Lading)\n- `SWB` (Sea Waybill)\n",
      "enum": [
        "BOL",
        "SWB"
      ]
    },
    "isShippedOnBoardType": {
      "type": "boolean",
      "description": "Specifies whether the Transport Document is a received for shipment, or shipped on board.\n"
    },
    "freightPaymentTermCode": {
      "type": "string",
      "description": "An indicator of whether freight and ancillary fees for the main transport are prepaid (`PRE`) or collect (`COL`). When prepaid the charges are the responsibility of the shipper or the Invoice payer on behalf of the shipper (if provided). When collect, the charges are the responsibility of the consignee or the Invoice payer on behalf of the consignee (if provided).\n\n- `PRE` (Prepaid)\n- `COL` (Collect)\n",
      "enum": [
        "PRE",
        "COL"
      ]
    },
    "isElectronic": {
      "type": "boolean",
      "description": "An indicator whether the transport document is electronically transferred.\n"
    },
    "isToOrder": {
      "type": "boolean",
      "description": "Indicates whether the B/L is issued `to order` or not. If `true`, the B/L is considered negotiable and an Endorsee party can be defined in the Document parties. If no Endorsee is defined, the B/L is blank endorsed. If `false`, the B/L is considered non-negotiable (also referred to as `straight`).\n\n`isToOrder` must be `false` if `transportDocumentTypeCode='SWB'` (Sea Waybill).\n"
    },
    "numberOfCopiesWithCharges": {
      "type": "integer",
      "format": "int32",
      "minimum": 0,
      "description": "The requested number of copies of the `Transport Document` to be issued by the carrier including charges.\n\n**Conditions:** The following table defines the conditions for the `numberOfCopiesWithCharges` property:\n| Transport Document Type Code | Is Electronic | Meaning |\n|-------|:-------:|-------|\n|`BOL`|`false`|How many paper copies of the Original BL to be issued by the carrier with charges|\n|`BOL`|`true`|Not applicable, there are no copies|\n|`SWB`|`false`|Indicates that charges should be included in the `SWB` (pdf or other formats)|\n|`SWB`|`true`|Indicates that charges should be included in the electronic `SWB`|\n"
    },
    "numberOfCopiesWithoutCharges": {
      "type": "integer",
      "format": "int32",
      "minimum": 0,
      "description": "The requested number of copies of the `Transport Document` to be issued by the carrier **NOT** including charges.\n\n**Conditions:** The following table defines the conditions for the `numberOfCopiesWithoutCharges` property:\n| Transport Document Type Code | Is Electronic | Meaning |\n|-------|:-------:|-------|\n|`BOL`|`false`|How many paper copies of the Original BL to be issued by the carrier without charges|\n|`BOL`|`true`|Not applicable, there are no copies|\n|`SWB`|`false`|Indicates that charges should NOT be included in the `SWB` (pdf or other formats)|\n|`SWB`|`true`|Indicates that charges NOT should be included in the electronic `SWB`|\n"
    },
    "numberOfOriginalsWithCharges": {
      "type": "integer",
      "format": "int32",
      "minimum": 0,
      "description": "Number of originals of the Bill of Lading that has been requested by the customer with charges.\n        \n**Condition:** Only applicable if `transportDocumentType` = `BOL` (Bill of Lading). If `isElectronic = 'True'`, accepted value is `1` (one) or `0` (zero)\n"
    },
    "numberOfOriginalsWithoutCharges": {
      "type": "integer",
      "format": "int32",
      "minimum": 0,
      "description": "Number of originals of the Bill of Lading that has been requested by the customer without charges.\n        \n**Condition:** Only applicable if `transportDocumentType` = `BOL` (Bill of Lading). If `isElectronic = 'True'`, accepted value is `1` (one) or `0` (zero)\n"
    },
    "displayedNameForPlaceOfReceipt": {
      "description": "The name to be used in order to specify how the `Place of Receipt` should be displayed on the `Transport Document` to match the name and/or address provided on the `Letter of Credit`.\n\n**Condition:** The order of the items in this array **MUST** be preserved as by the provider of the API.\n",
      "type": "array",
      "maxItems": 5,
      "items": {
        "type": "string",
        "maxLength": 35,
        "description": "A line of the address to be displayed on the transport document.\n"
      }
    },
    "displayedNameForPortOfLoad": {
      "description": "The name to be used in order to specify how the `Port of Load` should be displayed on the `Transport Document` to match the name and/or address provided on the `Letter of Credit`.\n\n**Condition:** The order of the items in this array **MUST** be preserved as by the provider of the API.\n",
      "type": "array",
      "maxItems": 5,
      "items": {
        "type": "string",
        "maxLength": 35,
        "description": "A line of the address to be displayed on the transport document.\n"
      }
    },
    "displayedNameForPortOfDischarge": {
      "description": "The name to be used in order to specify how the `Port of Discharge` should be displayed on the `Transport Document` to match the name and/or address provided on the `Letter of Credit`.\n\n**Condition:** The order of the items in this array **MUST** be preserved as by the provider of the API.\n",
      "type": "array",
      "maxItems": 5,
      "items": {
        "type": "string",
        "maxLength": 35,
        "description": "A line of the address to be displayed on the transport document.\n"
      }
    },
    "displayedNameForPlaceOfDelivery": {
      "description": "The name to be used in order to specify how the `Place of Delivery` should be displayed on the `Transport Document` to match the name and/or address provided on the `Letter of Credit`.\n\n**Condition:** The order of the items in this array **MUST** be preserved as by the provider of the API.\n",
      "type": "array",
      "maxItems": 5,
      "items": {
        "type": "string",
        "maxLength": 35,
        "description": "A line of the address to be displayed on the transport document.\n"
      }
    },
    "shippedOnBoardDate": {
      "type": "string",
      "format": "date",
      "description": "Date when the last container that is linked to the transport document is physically loaded onboard the vessel indicated on the transport document.\n\nWhen provided on a transport document, the transportDocument is a `Shipped On Board` B/L.\n\nExactly one of `shippedOnBoard` and `receiveForShipmentDate` must be provided on an issued B/L.\n"
    },
    "displayedShippedOnBoardReceivedForShipment": {
      "type": "string",
      "pattern": "^\\S(?:.*\\S)?$",
      "maxLength": 250,
      "description": "The text to be displayed on the `Transport Document` as evidence that the goods have been received for shipment or shipped on board.\n"
    },
    "termsAndConditions": {
      "type": "string",
      "maxLength": 50000,
      "description": "Carrier terms and conditions of transport.\n"
    },
    "receiptTypeAtOrigin": {
      "type": "string",
      "maxLength": 3,
      "description": "Indicates the type of service offered at `Origin`. The options are:\n- `CY` (Container yard (incl. rail ramp))\n- `SD` (Store Door)\n- `CFS` (Container Freight Station)\n",
      "enum": [
        "CY",
        "SD",
        "CFS"
      ]
    },
    "deliveryTypeAtDestination": {
      "type": "string",
      "maxLength": 3,
      "description": "Indicates the type of service offered at `Destination`. The options are:\n\n- `CY` (Container yard (incl. rail ramp))\n- `SD` (Store Door)\n- `CFS` (Container Freight Station)\n",
      "enum": [
        "CY",
        "SD",
        "CFS"
      ]
    },
    "cargoMovementTypeAtOrigin": {
      "type": "string",
      "maxLength": 3,
      "description": "Refers to the shipment term at the **loading** of the cargo into the container. Possible values are:\n\n- `FCL` (Full Container Load)\n- `LCL` (Less than Container Load)\n"
    },
    "cargoMovementTypeAtDestination": {
      "type": "string",
      "maxLength": 3,
      "description": "Refers to the shipment term at the **unloading** of the cargo out of the container. Possible values are:\n\n- `FCL` (Full Container Load)\n- `LCL` (Less than Container Load)\n"
    },
    "issueDate": {
      "type": "string",
      "format": "date",
      "description": "Local date when the transport document has been issued.\n\nCan be omitted on draft transport documents, but must be provided when the document has been issued.\n"
    },
    "receivedForShipmentDate": {
      "type": "string",
      "format": "date",
      "description": "Date when the last container linked to the transport document is physically in the terminal (customers cleared against the intended vessel).\n\nWhen provided on a transport document, the transportDocument is a `Received For Shipment` B/L.\n\nExactly one of `shippedOnBoard` and `receiveForShipmentDate` must be provided on an issued B/L.\n"
    },
    "serviceContractReference": {
      "type": "string",
      "maxLength": 30,
      "description": "Reference number for agreement between shipper and carrier, which optionally includes a certain minimum quantity commitment (usually referred as “MQC”) of cargo that the shipper commits to over a fixed period, and the carrier commits to a certain rate or rate schedule.\n"
    },
    "contractQuotationReference": {
      "type": "string",
      "pattern": "^\\S(?:.*\\S)?$",
      "maxLength": 35,
      "description": "Information provided by the shipper to identify whether pricing for the shipment has been agreed via a contract or a quotation reference.\n"
    },
    "declaredValue": {
      "type": "number",
      "format": "float",
      "minimum": 0,
      "description": "The value of the cargo that the shipper declares in order to avoid the carrier's limitation of liability and \"Ad Valorem\" freight, i.e., freight which is calculated based on the value of the goods declared by the shipper.\n\n**Condition:** Included in the transport document upon customer request. If customers want the value to show, evidence is required, and customers need to approve additional insurance fee charge from the carrier (very exceptional).\n"
    },
    "declaredValueCurrency": {
      "type": "string",
      "pattern": "^[A-Z]{3}$",
      "minLength": 3,
      "maxLength": 3,
      "description": "The currency used for the declared value, using the 3-character code defined by [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html).\n\n**Condition:** Mandatory if `declaredValue` is provided. If `declaredValue` is not provided, this field must be empty.\n"
    },
    "carrierCode": {
      "type": "string",
      "pattern": "^\\S+$",
      "maxLength": 4,
      "description": "The `SCAC` code (provided by [NMFTA](https://nmfta.org/scac/)) or `SMDG` code (provided by [SMDG](https://smdg.org/documents/smdg-code-lists/smdg-liner-code-list/)) of the issuing carrier of the `Transport Document`. `carrierCodeListProvider` defines which list the `carrierCode` is based upon.\n"
    },
    "carrierCodeListProvider": {
      "type": "string",
      "description": "The code list provider for the `carrierCode`. Possible values are:\n- `SMDG` (Ship Message Design Group)\n- `NMFTA` (National Motor Freight Traffic Association)\n",
      "enum": [
        "SMDG",
        "NMFTA"
      ]
    },
    "carrierClauses": {
      "type": "array",
      "description": "Additional clauses for a specific shipment added by the carrier to the Bill of Lading, subject to local rules / guidelines or certain mandatory information required to be shared with the customer.\n",
      "items": {
        "type": "string",
        "pattern": "^\\S(?:.*\\S)?$",
        "maxLength": 20000,
        "description": "The content of the clause.\n"
      }
    },
    "numberOfRiderPages": {
      "type": "integer",
      "format": "int32",
      "minimum": 0,
      "description": "The number of additional pages required to contain the goods description on a transport document. Only applicable for physical transport documents.\n"
    },
    "transports": {
      "$ref": "#/$defs/Transports"
    },
    "charges": {
      "type": "array",
      "description": "A list of `Charges`\n",
      "items": {
        "$ref": "#/$defs/Charge"
      }
    },
    "placeOfIssue": {
      "$ref": "#/$defs/PlaceOfIssue"
    },
    "invoicePayableAt": {
      "$ref": "#/$defs/InvoicePayableAt"
    },
    "partyContactDetails": {
      "type": "array",
      "minItems": 1,
      "description": "The contact details of the person(s) to contact in relation to the **Transport Document** (changes, notifications etc.) \n",
      "items": {
        "$ref": "#/$defs/PartyContactDetail"
      }
    },
    "documentParties": {
      "$ref": "#/$defs/DocumentParties"
    },
    "consignmentItems": {
      "type": "array",
      "minItems": 1,
      "description": "A list of `ConsignmentItems`\n",
      "items": {
        "$ref": "#/$defs/ConsignmentItem"
      }
    },
    "utilizedTransportEquipments": {
      "type": "array",
      "minItems": 1,
      "description": "A list of `Utilized Transport Equipments` describing the equipment being used.\n",
      "items": {
        "$ref": "#/$defs/UtilizedTransportEquipment"
      }
    },
    "exportLicense": {
      "$ref": "#/$defs/ExportLicense"
    },
    "importLicense": {
      "$ref": "#/$defs/ImportLicense"
    },
    "references": {
      "type": "array",
      "description": "A list of `References`\n",
      "items": {
        "$ref": "#/$defs/Reference"
      }
    },
    "customsReferences": {
      "type": "array",
      "description": "A list of `Customs references`\n",
      "items": {
        "$ref": "#/$defs/CustomsReference"
      }
    }
  },
  "required": [
    "transportDocumentReference",
    "transportDocumentStatus",
    "transportDocumentTypeCode",
    "isShippedOnBoardType",
    "isElectronic",
    "isToOrder",
    "invoicePayableAt",
    "partyContactDetails",
    "documentParties",
    "consignmentItems",
    "utilizedTransportEquipments",
    "termsAndConditions",
    "receiptTypeAtOrigin",
    "deliveryTypeAtDestination",
    "cargoMovementTypeAtOrigin",
    "cargoMovementTypeAtDestination",
    "carrierCode",
    "carrierCodeListProvider",
    "transports"
  ],
  "$defs": {
    "ActiveReeferSettings": {
      "type": "object",
      "title": "Active Reefer Settings",
      "description": "The specifications for a Reefer equipment.\n\n**Condition:** Only applicable when `isNonOperatingReefer` is set to `false`\n",
      "properties": {
        "temperatureSetpoint": {
          "type": "number",
          "format": "float",
          "description": "Target value of the temperature for the Reefer based on the cargo requirement.\n"
        },
        "temperatureUnit": {
          "type": "string",
          "description": "The unit for temperature in Celsius or Fahrenheit\n\n- `CEL` (Celsius)\n- `FAH` (Fahrenheit)\n\n**Condition:** Mandatory if `temperatureSetpoint` is provided. If `temperatureSetpoint` is not provided, this field must be empty.\n",
          "enum": [
            "CEL",
            "FAH"
          ]
        },
        "o2Setpoint": {
          "type": "number",
          "format": "float",
          "minimum": 0,
          "maximum": 100,
          "description": "The percentage of the controlled atmosphere O<sub>2</sub> target value\n"
        },
        "co2Setpoint": {
          "type": "number",
          "format": "float",
          "minimum": 0,
          "maximum": 100,
          "description": "The percentage of the controlled atmosphere CO<sub>2</sub> target value\n"
        },
        "humiditySetpoint": {
          "type": "number",
          "format": "float",
          "minimum": 0,
          "maximum": 100,
          "description": "The percentage of the controlled atmosphere humidity target value\n"
        },
        "airExchangeSetpoint": {
          "type": "number",
          "format": "float",
          "minimum": 0,
          "description": "Target value for the air exchange rate which is the rate at which outdoor air replaces indoor air within a Reefer container\n"
        },
        "airExchangeUnit": {
          "type": "string",
          "description": "The unit for `airExchange` in metrics- or imperial- units per hour\n- `MQH` (Cubic metre per hour)\n- `FQH` (Cubic foot per hour)\n\n**Condition:** Mandatory if `airExchange` is provided. If `airExchange` is not provided, this field must be empty.\n",
          "enum": [
            "MQH",
            "FQH"
          ]
        },
        "isVentilationOpen": {
          "type": "boolean",
          "description": "If `true` the ventilation orifice is `Open` - if `false` the ventilation orifice is `closed`\n"
        },
        "isDrainholesOpen": {
          "type": "boolean",
          "description": "Is drain holes open on the container\n"
        },
        "isBulbMode": {
          "type": "boolean",
          "description": "Is special container setting for handling flower bulbs active\n"
        },
        "isColdTreatmentRequired": {
          "type": "boolean",
          "description": "Indicator whether cargo requires cold treatment prior to loading at origin or during transit, but prior arrival at POD\n"
        },
        "isControlledAtmosphereRequired": {
          "type": "boolean",
          "description": "Indicator of whether cargo requires Controlled Atmosphere.\n"
        }
      }
    },
    "Address": {
      "type": "object",
      "title": "Address",
      "description": "An object for storing address related information\n",
      "properties": {
        "street": {
          "type": "string",
          "maxLength": 70,
          "description": "The name of the street."
        },
        "streetNumber": {
          "type": "string",
          "maxLength": 50,
          "description": "The number of the street."
        },
        "floor": {
          "type": "string",
          "pattern": "^\\S(?:.*\\S)?$",
          "maxLength": 50,
          "description": "The floor of the street number.\n"
        },
        "postCode": {
          "type": "string",
          "maxLength": 10,
          "description": "The post code of the address."
        },
        "POBox": {
          "type": "string",
          "maxLength": 20,
          "description": "A numbered box at a post office where a person or business can have mail or parcels delivered."
        },
        "city": {
          "type": "string",
          "pattern": "^\\S(?:.*\\S)?$",
          "maxLength": 35,
          "description": "The name of the city.\n"
        },
        "stateRegion": {
          "type": "string",
          "maxLength": 65,
          "description": "The name of the state/region."
        },
        "countryCode": {
          "type": "string",
          "pattern": "^[A-Z]{2}$",
          "minLength": 2,
          "maxLength": 2,
          "description": "The 2 characters for the country code using [ISO 3166-1 alpha-2](https://www.iso.org/obp/ui/#iso:pub:PUB500001:en)\n"
        }
      },
      "required": [
        "street",
        "city",
        "countryCode"
      ]
    },
    "CargoGrossVolume": {
      "type": "object",
      "title": "Cargo Gross Volume",
      "description": "Calculated by multiplying the width, height, and length of the packed cargo.\n",
      "properties": {
        "value": {
          "type": "number",
          "format": "float",
          "minimum": 0,
          "exclusiveMinimum": true,
          "description": "Calculated by multiplying the width, height, and length of the packed cargo. A maximum of 4 decimals should be provided.\n"
        },
        "unit": {
          "type": "string",
          "description": "The unit of measure which can be expressed in imperial or metric terms:\n- `FTQ` (Cubic foot)\n- `MTQ` (Cubic meter)\n",
          "enum": [
            "MTQ",
            "FTQ"
          ]
        }
      },
      "required": [
        "value",
        "unit"
      ]
    },
    "CargoGrossWeight": {
      "type": "object",
      "title": "Cargo Gross Weight",
      "description": "The weight of the cargo item including packaging being carried in the container. Excludes the tare weight of the container.\n",
      "properties": {
        "value": {
          "type": "number",
          "format": "float",
          "minimum": 0,
          "exclusiveMinimum": true,
          "description": "The weight of the cargo item including packaging being carried in the container. Excludes the tare weight of the container. A maximum of 3 decimals should be provided.\n"
        },
        "unit": {
          "type": "string",
          "description": "The unit of measure which can be expressed in imperial or metric terms:\n- `KGM` (Kilograms)\n- `LBR` (Pounds)\n",
          "enum": [
            "KGM",
            "LBR"
          ]
        }
      },
      "required": [
        "value",
        "unit"
      ]
    },
    "CargoItem": {
      "type": "object",
      "title": "Cargo Item",
      "description": "A `cargoItem` is the smallest unit used by stuffing. A `cargoItem` cannot be split across containers.\n",
      "properties": {
        "equipmentReference": {
          "type": "string",
          "pattern": "^\\S(?:.*\\S)?$",
          "maxLength": 11,
          "description": "The unique identifier for the equipment, which should follow the BIC ISO Container Identification Number where possible.\nAccording to [ISO 6346](https://www.iso.org/standard/83558.html), a container identification code consists of a 4-letter prefix and a 7-digit number (composed of a 3-letter owner code, a category identifier, a serial number, and a check-digit).\n\nIf a container does not comply with [ISO 6346](https://www.iso.org/standard/83558.html), it is suggested to follow [Recommendation #2: Containers with non-ISO identification](https://smdg.org/documents/smdg-recommendations) from SMDG.\n"
        },
        "cargoGrossWeight": {
          "$ref": "#/$defs/CargoGrossWeight"
        },
        "cargoGrossVolume": {
          "$ref": "#/$defs/CargoGrossVolume"
        },
        "cargoNetWeight": {
          "$ref": "#/$defs/CargoNetWeight"
        },
        "cargoNetVolume": {
          "$ref": "#/$defs/CargoNetVolume"
        },
        "exportLicense": {
          "$ref": "#/$defs/ExportLicense"
        },
        "importLicense": {
          "$ref": "#/$defs/ImportLicense"
        },
        "outerPackaging": {
          "$ref": "#/$defs/OuterPackaging"
        },
        "nationalCommodityCodes": {
          "type": "array",
          "description": "A list of `National Commodity Codes` that apply to this `cargoItem`\n",
          "items": {
            "$ref": "#/$defs/NationalCommodityCode"
          }
        },
        "customsReferences": {
          "type": "array",
          "description": "A list of `Customs references`\n",
          "items": {
            "$ref": "#/$defs/CustomsReference"
          }
        }
      },
      "required": [
        "equipmentReference",
        "cargoGrossWeight",
        "outerPackaging"
      ]
    },
    "CargoNetVolume": {
      "type": "object",
      "title": "Cargo Net Volume",
      "description": "Calculated by multiplying the width, height, and length of the cargo, excluding packaging.\n",
      "properties": {
        "value": {
          "type": "number",
          "format": "float",
          "minimum": 0,
          "exclusiveMinimum": true,
          "description": "Calculated by multiplying the width, height, and length of the cargo, excluding packaging.\n"
        },
        "unit": {
          "type": "string",
          "description": "The unit of measure which can be expressed in imperial or metric terms:\n- `FTQ` (Cubic foot)\n- `MTQ` (Cubic meter)\n",
          "enum": [
            "MTQ",
            "FTQ"
          ]
        }
      },
      "required": [
        "value",
        "unit"
      ]
    },
    "CargoNetWeight": {
      "type": "object",
      "title": "Cargo Net Weight",
      "description": "The weight of the cargo item excluding packaging being carried in the container. Excludes the tare weight of the container.\n",
      "properties": {
        "value": {
          "type": "number",
          "format": "float",
          "minimum": 0,
          "exclusiveMinimum": true,
          "description": "The weight of the cargo item excluding packaging being carried in the container. Excludes the tare weight of the container. A maximum of 3 decimals should be provided.\n"
        },
        "unit": {
          "type": "string",
          "description": "The unit of measure which can be expressed in imperial or metric terms:\n- `KGM` (Kilograms)\n- `LBR` (Pounds)\n",
          "enum": [
            "KGM",
            "LBR"
          ]
        }
      },
      "required": [
        "value",
        "unit"
      ]
    },
    "CarriersAgentAtDestination": {
      "type": "object",
      "title": "Carrier's Agent At Destination",
      "description": "The party on the import side assigned by the carrier to whom the customer need to reach out to for cargo release.\n",
      "properties": {
        "partyName": {
          "type": "string",
          "pattern": "^\\S(?:.*\\S)?$",
          "maxLength": 70,
          "description": "Name of the party.\n"
        },
        "address": {
          "$ref": "#/$defs/Address"
        },
        "partyContactDetails": {
          "type": "array",
          "description": "A list of contact details\n",
          "items": {
            "$ref": "#/$defs/PartyContactDetail"
          }
        }
      },
      "required": [
        "partyName",
        "address",
        "partyContactDetails"
      ]
    },
    "Charge": {
      "type": "object",
      "title": "Charge",
      "description": "Addresses the monetary value of freight and other service charges for a `Booking`.\n",
      "properties": {
        "chargeName": {
          "type": "string",
          "pattern": "^\\S(?:.*\\S)?$",
          "maxLength": 50,
          "description": "Free text field describing the charge to apply\n"
        },
        "currencyAmount": {
          "type": "number",
          "format": "float",
          "minimum": 0,
          "description": "The monetary value of all freight and other service charges for a transport document, with a maximum of 2-digit decimals.\n"
        },
        "currencyCode": {
          "type": "string",
          "pattern": "^[A-Z]{3}$",
          "minLength": 3,
          "maxLength": 3,
          "description": "The currency for the charge, using a 3-character code ([ISO 4217](https://www.iso.org/iso-4217-currency-codes.html)).\n"
        },
        "paymentTermCode": {
          "type": "string",
          "description": "An indicator of whether a charge is prepaid (PRE) or collect (COL). When prepaid, the charge is the responsibility of the shipper or the Invoice payer on behalf of the shipper (if provided). When collect, the charge is the responsibility of the consignee or the Invoice payer on behalf of the consignee (if provided).\n\n- `PRE` (Prepaid)\n- `COL` (Collect)\n",
          "enum": [
            "PRE",
            "COL"
          ]
        },
        "calculationBasis": {
          "type": "string",
          "pattern": "^\\S(?:.*\\S)?$",
          "maxLength": 50,
          "description": "The code specifying the measure unit used for the corresponding unit price for this cost, such as per day, per ton, per square metre.\n"
        },
        "unitPrice": {
          "type": "number",
          "format": "float",
          "minimum": 0,
          "description": "The unit price of this charge item in the currency of the charge.\n"
        },
        "quantity": {
          "type": "number",
          "format": "float",
          "minimum": 0,
          "description": "The amount of unit for this charge item.\n"
        }
      },
      "required": [
        "chargeName",
        "currencyAmount",
        "currencyCode",
        "paymentTermCode",
        "calculationBasis",
        "unitPrice",
        "quantity"
      ]
    },
    "City": {
      "type": "object",
      "title": "City",
      "description": "An object for storing city, state/region and country related information\n",
      "properties": {
        "city": {
          "type": "string",
          "pattern": "^\\S(?:.*\\S)?$",
          "maxLength": 35,
          "description": "The name of the city.\n"
        },
        "stateRegion": {
          "type": "string",
          "maxLength": 65,
          "description": "The name of the state/region.\n"
        },
        "countryCode": {
          "type": "string",
          "pattern": "^[A-Z]{2}$",
          "minLength": 2,
          "maxLength": 2,
          "description": "The 2 characters for the country code using [ISO 3166-1 alpha-2](https://www.iso.org/obp/ui/#iso:pub:PUB500001:en)\n"
        }
      },
      "required": [
        "city",
        "countryCode"
      ]
    },
    "Consignee": {
      "type": "object",
      "title": "Consignee",
      "description": "The party to which goods are consigned in the `Master Bill of Lading`.\n\n**Condition:** Mandatory for non-negotiable BL (`isToOrder=false`)\n\n**Condition:** If a `displayedAddress` is provided, it must be included in the `Transport Document` instead of the `address`.\n",
      "properties": {
        "partyName": {
          "type": "string",
          "pattern": "^\\S(?:.*\\S)?$",
          "maxLength": 70,
          "description": "Name of the party.\n"
        },
        "typeOfPerson": {
          "type": "string",
          "maxLength": 50,
          "pattern": "^\\S(?:.*\\S)?$",
          "description": "Can be one of the following values as per the Union Customs Code art. 5(4):\n- `NATURAL_PERSON` (A person that is an individual living human being)\n- `LEGAL_PERSON` (person (including a human being and public or private organizations) that can perform legal actions, such as own a property, sue and be sued)\n- `ASSOCIATION_OF_PERSONS` (Not a legal person, but recognised under Union or National law as having the capacity to perform legal acts)\n"
        },
        "address": {
          "$ref": "#/$defs/PartyAddress"
        },
        "displayedAddress": {
          "type": "array",
          "maxItems": 6,
          "description": "The address of the party to be displayed on the `Transport Document`. The displayed address may be used to match the address provided in the `Letter of Credit`.\n\n**Conditions:** If provided:\n  - the displayed address must be included in the `Transport Doc

# --- truncated at 32 KB (107 KB total) ---
# Full source: https://artifacts.apis.io/evergreen-marine/json-schema/evergreen-marine-transport-document-schema.json