Update Shipping Instructions

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/evergreen-marine/main/json-schema/evergreen-marine-update-shipping-instructions-schema.json",
  "title": "Update Shipping Instructions",
  "description": "The `Shipping Instructions` to update.\n",
  "x-generated": "2026-10-18",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/evergreen-marine-shipping-instructions-openapi.yml#/components/schemas/UpdateShippingInstructions",
  "type": "object",
  "properties": {
    "shippingInstructionsReference": {
      "type": "string",
      "pattern": "^\\S(?:.*\\S)?$",
      "maxLength": 100,
      "description": "The identifier for a `Shipping Instructions` provided by the carrier for system purposes.\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"
      ]
    },
    "originChargesPaymentTerm": {
      "$ref": "#/$defs/OriginChargesPaymentTerm"
    },
    "destinationChargesPaymentTerm": {
      "$ref": "#/$defs/DestinationChargesPaymentTerm"
    },
    "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"
      }
    },
    "placeOfIssue": {
      "$ref": "#/$defs/PlaceOfIssue"
    },
    "invoicePayableAt": {
      "$ref": "#/$defs/InvoicePayableAtShippingInstructions"
    },
    "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"
      }
    },
    "isCarriersAgentAtDestinationRequired": {
      "type": "boolean",
      "description": "Indicates whether the Carrier's agent at destination name, address and contact details should be included in the `Transport Document`.\n"
    },
    "documentParties": {
      "$ref": "#/$defs/DocumentPartiesShippingInstructions"
    },
    "isCargoDeliveredInICS2Zone": {
      "type": "boolean",
      "description": "Indicates whether cargo is delivered to EU, Norway, Switzerland or Northern Ireland.\n"
    },
    "consignmentItems": {
      "type": "array",
      "minItems": 1,
      "description": "A list of `ConsignmentItems`\n",
      "items": {
        "$ref": "#/$defs/ConsignmentItemShipper"
      }
    },
    "utilizedTransportEquipments": {
      "type": "array",
      "minItems": 1,
      "description": "A list of `Utilized Transport Equipments` describing the equipment being used.\n",
      "items": {
        "$ref": "#/$defs/UtilizedTransportEquipmentShipper"
      }
    },
    "exportLicense": {
      "$ref": "#/$defs/ExportLicenseShipper"
    },
    "importLicense": {
      "$ref": "#/$defs/ImportLicenseShipper"
    },
    "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"
      }
    },
    "advanceManifestFilings": {
      "type": "array",
      "description": "A list of `Advance Manifest Filings` specified by the Shipper to indicate whom is to do the Filing\n",
      "items": {
        "$ref": "#/$defs/AdvanceManifestFiling"
      }
    },
    "isHouseBillOfLadingsIssued": {
      "type": "boolean",
      "description": "Indicates whether one or more `House Bill of Lading(s)` have been issued.\n\n**Condition:** Mandatory if `manifestTypeCode` is `ENS`\n"
    },
    "houseBillOfLadings": {
      "type": "array",
      "description": "A list of `House Bill of Ladings` specified by the Shipper.\n",
      "items": {
        "$ref": "#/$defs/HouseBillOfLading"
      }
    },
    "requestedCarrierCertificates": {
      "type": "array",
      "description": "Certificate(s) requested by the Shipper for the Carrier to include as part of the shipment documentation pack\n",
      "items": {
        "type": "string",
        "maxLength": 100,
        "description": "Name of the certificate. Detailed information about carrier certificates can be found [here](https://dcsa.org/wp-content/uploads/2023/12/28-12-2023_Carrier-Certificates-shipment-voyage-particulars-and-vessel-particulars.pdf). Possible values are:\n- `SHIPMENT_VOYAGE_PARTICULARS_1` (Shipment-Voyage Particulars 1)\n- `SHIPMENT_VOYAGE_PARTICULARS_2` (Shipment-Voyage Particulars 2)\n- `SHIPMENT_VOYAGE_PARTICULARS_3` (Shipment-Voyage Particulars 3)\n- `SHIPMENT_VOYAGE_PARTICULARS_4` (Shipment-Voyage Particulars 4)\n- `SHIPMENT_VOYAGE_PARTICULARS_5` (Shipment-Voyage Particulars 5)\n- `SHIPMENT_VOYAGE_PARTICULARS_6` (Shipment-Voyage Particulars 6)\n- `SHIPMENT_VOYAGE_PARTICULARS_7` (Shipment-Voyage Particulars 7)\n- `VESSEL_PARTICULARS_1` (Vessel Particulars 1)\n- `VESSEL_PARTICULARS_2` (Vessel Particulars 2)\n- `VESSEL_PARTICULARS_3` (Vessel Particulars 3)\n- `VESSEL_PARTICULARS_4` (Vessel Particulars 4)\n- `VESSEL_PARTICULARS_5` (Vessel Particulars 5)\n- `VESSEL_PARTICULARS_6` (Vessel Particulars 6)\n- `VESSEL_PARTICULARS_7` (Vessel Particulars 7)\n- `VESSEL_PARTICULARS_8` (Vessel Particulars 8)\n- `VESSEL_PARTICULARS_9` (Vessel Particulars 9)\n- `VESSEL_PARTICULARS_10` (Vessel Particulars 10)\n- `VESSEL_PARTICULARS_11` (Vessel Particulars 11)\n- `VESSEL_PARTICULARS_12` (Vessel Particulars 12)\n- `VESSEL_PARTICULARS_13` (Vessel Particulars 13)\n- `VESSEL_PARTICULARS_14` (Vessel Particulars 14)\n- `VESSEL_PARTICULARS_15` (Vessel Particulars 15)\n- `VESSEL_PARTICULARS_16` (Vessel Particulars 16)\n- `VESSEL_PARTICULARS_17` (Vessel Particulars 17)\n- `VESSEL_PARTICULARS_18` (Vessel Particulars 18)\n"
      }
    },
    "requestedCarrierClauses": {
      "type": "array",
      "description": "Clauses requested by the Shipper for the Carrier to include in the `Transport Document` `Carrier clauses`\n",
      "items": {
        "type": "string",
        "maxLength": 100,
        "description": "A clause to request from the carrier. Detailed information about the carrier clauses can be found [here](https://dcsa-website.cdn.prismic.io/dcsa-website/ZvaCMbVsGrYSwERk_202409StandardisedClausesBL-Final.pdf). Possible values are:\n- `CARGO_CARGOSPECIFICS` (Cargo/Cargo specifics)\n- `VESSELCONVEYANCE_COUNTRYSPECIFIC` (Vessel conveyance/Country Specific)\n- `CARGO_RETURNOFEMPTYCONTAINER` (Cargo/Return of Empty Container)\n- `CARGO_CARGOVALUE` (Cargo/Cargo value)\n- `CARGO_REEFERTEMPERATURE` (Cargo/Reefer temperature)\n- `CARGO_CONFLICTINGTEMPERATURES_MIXEDLOADS` (Cargo/Conflicting temperatures/Mixed loads)\n- `SHIPPERSLOADSTOWWEIGHTANDCOUNT` (Shipper's Load, Stow, Weight and Count)\n- `INTRANSITCLAUSE` (In transit clause)\n"
      }
    }
  },
  "required": [
    "shippingInstructionsReference",
    "transportDocumentTypeCode",
    "isShippedOnBoardType",
    "isElectronic",
    "isToOrder",
    "freightPaymentTermCode",
    "partyContactDetails",
    "documentParties",
    "isCargoDeliveredInICS2Zone",
    "consignmentItems",
    "utilizedTransportEquipments"
  ],
  "$defs": {
    "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"
      ]
    },
    "AdvanceManifestFiling": {
      "type": "object",
      "title": "Advance Manifest Filing",
      "description": "An Advance Manifest Filing defined by a Manifest type code in combination with a country code.\n\nA small list of **potential** examples:\n\n| manifestTypeCode | countryCode | Description |\n|-----------------------|:-------------:|-------------|\n|ACI|EG|Advance Cargo Information in Egypt|\n|ACE|US|Automated Commercial Environment in the United States|\n|AFR|JP|Cargo Summary Notification (CSN)|\n|ENS|NL|Entry Summary Declaration|\n",
      "properties": {
        "manifestTypeCode": {
          "type": "string",
          "pattern": "^\\S(?:.*\\S)?$",
          "maxLength": 50,
          "description": "The Manifest type code as defined by the provider.\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"
        },
        "advanceManifestFilingsHouseBLPerformedBy": {
          "type": "string",
          "description": "Indicates whether the shipper (`SELF`) will perform the advance manifest filing(s) for the House BL directly or if the carrier (`CARRIER`) should file them on their behalf. Allowed values are:\n\n- `SELF` (filing done by the House filer)\n- `CARRIER` (the carrier does the filing)\n\nIn case of self-filing (`SELF`), the shipper can provide their `selfFilerCode` for each manifest.\n\n**Condition:** The `selfFilerCode` must be provided when `manifestTypeCode` is one of `ACE` (US) or `ACI` (CA) and the `advanceManifestFilingsHouseBLPerformedBy` is set to `SELF`.\n",
          "enum": [
            "SELF",
            "CARRIER"
          ]
        },
        "selfFilerCode": {
          "type": "string",
          "pattern": "^\\S(?:.*\\S)?$",
          "maxLength": 100,
          "description": "Code identifying the party who will submit the advance manifest filing(s) for the House BL.\n\n**Mandatory** if `manifestTypeCode` is one of `ACE` (US) or `ACI` (CA) and `advanceManifestFilingsHouseBLPerformedBy` is set to `SELF`.\n"
        },
        "identificationNumber": {
          "type": "string",
          "pattern": "^\\S(?:.*\\S)?$",
          "maxLength": 17,
          "description": "An identification number of the house filer responsible for submitting the `Advance Manifest Filing`.\n\n**Condition:** Mandatory if `manifestTypeCode` is `ENS` and `advanceManifestFilingsHouseBLPerformedBy` is `SELF`.\n"
        }
      },
      "required": [
        "manifestTypeCode",
        "advanceManifestFilingsHouseBLPerformedBy"
      ]
    },
    "Buyer": {
      "type": "object",
      "title": "Buyer",
      "description": "The buyer is the last known entity to whom the goods are sold or agreed to be sold. If the goods are to be imported otherwise than in pursuance of a purchase, the details of the owner of the goods shall be provided.\n\n**Condition:** Buyer and Seller are mandatory if `isCargoDeliveredInICS2Zone=true` and `manifesttypecode='ENS'` and `advancedManifestFilingPerformedBy='CARRIER'` and `isHouseBillofLadingsIssued=false`.\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/Address"
        },
        "identifyingCodes": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/IdentifyingCode"
          }
        },
        "taxLegalReferences": {
          "description": "A list of `Tax References` for a `Party`\n",
          "type": "array",
          "items": {
            "$ref": "#/$defs/TaxLegalReference"
          }
        },
        "partyContactDetails": {
          "type": "array",
          "description": "A list of contact details\n",
          "items": {
            "$ref": "#/$defs/PartyContactDetailWithPattern"
          }
        }
      },
      "required": [
        "partyName",
        "typeOfPerson"
      ]
    },
    "BuyerHBL": {
      "type": "object",
      "title": "Buyer (House B/L)",
      "description": "The buyer is the last known entity to whom the goods are sold or agreed to be sold. If the goods are to be imported otherwise than in pursuance of a purchase, the details of the owner of the goods shall be provided.\n\n**Condition:** Buyer and Seller are mandatory if `isCargoDeliveredInICS2Zone=true` (on House B/L level) and `manifesttypecode='ENS'` and `advancedManifestFilingPerformedBy='CARRIER'`.\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/Address"
        },
        "identifyingCodes": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/IdentifyingCode"
          }
        },
        "taxLegalReferences": {
          "description": "A list of `Tax References` for a `Party`\n",
          "type": "array",
          "items": {
            "$ref": "#/$defs/TaxLegalReference"
          }
        },
        "partyContactDetails": {
          "type": "array",
          "description": "A list of contact details\n",
          "items": {
            "$ref": "#/$defs/PartyContactDetailHBL"
          }
        }
      },
      "required": [
        "partyName",
        "typeOfPerson"
      ]
    },
    "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"
      ]
    },
    "CargoItemHBL": {
      "type": "object",
      "title": "Cargo Item (House B/L)",
      "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"
        },
        "outerPackaging": {
          "$ref": "#/$defs/OuterPackagingHBL"
        }
      },
      "required": [
        "equipmentReference",
        "cargoGrossWeight",
        "outerPackaging"
      ]
    },
    "CargoItemShipper": {
      "type": "object",
      "title": "Cargo Item (Shipper)",
      "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/ExportLicenseShipper"
        },
        "importLicense": {
          "$ref": "#/$defs/ImportLicenseShipper"
        },
        "outerPackaging": {
          "$ref": "#/$defs/OuterPackagingShipper"
        },
        "nationalCommodityCodes": {
          "type": "array",
          "description": "A list of `National Commodity Codes` that apply to this `cargoItem`\n",
          "items": {
            "$ref": "#/$defs/NationalCommodityCode"
          }
        },
        "houseBillOfLadingReference": {
          "type": "string",
          "maxLength": 20,
          "pattern": "^\\S(?:.*\\S)?$",
          "description": "Link to the House Bill of Lading this cargoItem is connected to.\n"
        },
        "customsReferences": {
          "type": "array",
          "description": "A list of `Customs references`\n",
          "items": {
            "$ref": "#/$defs/CustomsReference"
          }
        }
      },
      "required": [
        "equipmentReference",
        "cargoGrossWeight"
      ]
    },
    "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"
      ]
    },
    "ConsigneeHBL": {
      "type": "object",
      "title": "Consignee (House B/L)",
      "description": "The ultimate recipient of the cargo. It must be different from the freight forwarder, (de)consolidator, postal operator, or customs agent.\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/Address"
        },
        "identifyingCodes": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/IdentifyingCode"
          }
        },
        "taxLegalReferences": {
          "description": "A list of `Tax References` for a `Party`\n",
          "type": "array",
          "items": {
            "$ref": "#/$defs/TaxLegalReference"
          }
        },
        "partyContactDetails": {
          "type": "array",
          "description": "A list of contact details\n",
          "items": {
            "$ref": "#/$defs/PartyContactDetailHBL"
          }
        }
      },
      "required": [
        "partyName",
        "typeOfPerson"
      ]
    },
    "ConsigneeShipper": {
      "type": "object",
      "title": "Consignee (Shipper provided)",
      "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:** Either the `address` or a party `identifyingCode` must be provided in the `Shipping Instructions`. 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 Document`.\n  - for physical BL (`isElectronic=false`), it is only allowed to provide max 2 lines of 35 characters\n  - for electronic BL (`isElectronic=true`), th

# --- truncated at 32 KB (109 KB total) ---
# Full source: https://artifacts.apis.io/evergreen-marine/json-schema/evergreen-marine-update-shipping-instructions-schema.json