Update Booking

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/evergreen-marine/main/json-schema/evergreen-marine-update-booking-schema.json",
  "title": "Update Booking",
  "x-generated": "2026-10-18",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/evergreen-marine-booking-openapi.yml#/components/schemas/UpdateBooking",
  "required": [
    "cargoMovementTypeAtDestination",
    "cargoMovementTypeAtOrigin",
    "deliveryTypeAtDestination",
    "documentParties",
    "isEquipmentSubstitutionAllowed",
    "receiptTypeAtOrigin",
    "requestedEquipments",
    "shipmentLocations"
  ],
  "type": "object",
  "properties": {
    "carrierBookingRequestReference": {
      "maxLength": 100,
      "pattern": "^\\S(?:.*\\S)?$",
      "type": "string",
      "description": "A reference to the booking during the booking request phase.\n\n**Condition:** `carrierBookingRequestReference` and/or `carrierBookingReference` must be provided\n"
    },
    "carrierBookingReference": {
      "maxLength": 35,
      "pattern": "^\\S(?:.*\\S)?$",
      "type": "string",
      "description": "The `carrierBookingReference` if know. Often this will not be known until the booking has been confirmed. Is available during a booking amendment.\n\n**Condition:** `carrierBookingRequestReference` and/or `carrierBookingReference` must be provided\n"
    },
    "receiptTypeAtOrigin": {
      "maxLength": 3,
      "type": "string",
      "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": {
      "maxLength": 3,
      "type": "string",
      "description": "Indicates the type of service offered at `Destination`. The options are:\n- `CY` (Container yard (incl. rail ramp))\n- `SD` (Store Door)\n- `CFS` (Container Freight Station)\n",
      "enum": [
        "CY",
        "SD",
        "CFS"
      ]
    },
    "cargoMovementTypeAtOrigin": {
      "maxLength": 3,
      "type": "string",
      "description": "Refers to the shipment term at the **loading** of the cargo into the container. Possible values are:\n- `FCL` (Full Container Load)\n- `LCL` (Less than Container Load)\n"
    },
    "cargoMovementTypeAtDestination": {
      "maxLength": 3,
      "type": "string",
      "description": "Refers to the shipment term at the **unloading** of the cargo out of the container. Possible values are:\n- `FCL` (Full Container Load)\n- `LCL` (Less than Container Load)\n"
    },
    "serviceContractReference": {
      "maxLength": 30,
      "type": "string",
      "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\n**Condition:** One of `serviceContractReference` or `contractQuotationReference` must be provided, but not both.\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- `PRE` (Prepaid)\n- `COL` (Collect)\n",
      "enum": [
        "PRE",
        "COL"
      ]
    },
    "originChargesPaymentTerm": {
      "$ref": "#/$defs/OriginChargesPaymentTerm"
    },
    "destinationChargesPaymentTerm": {
      "$ref": "#/$defs/DestinationChargesPaymentTerm"
    },
    "contractQuotationReference": {
      "maxLength": 35,
      "pattern": "^\\S(?:.*\\S)?$",
      "type": "string",
      "description": "Information provided by the shipper to identify whether pricing for the shipment has been agreed via a contract or a quotation reference.\n\n**Condition:** One of `contractQuotationReference` or `serviceContractReference` must be provided, but not both.\n"
    },
    "vessel": {
      "$ref": "#/$defs/Vessel"
    },
    "carrierServiceName": {
      "maxLength": 50,
      "pattern": "^\\S(?:.*\\S)?$",
      "type": "string",
      "description": "The name of a service as specified by the carrier.\n\n**Condition:** Mandatory if `carrierExportVoyageNumber` is provided and Vessel details or `carrierServiceCode` are blank\n"
    },
    "carrierServiceCode": {
      "maxLength": 11,
      "pattern": "^\\S(?:.*\\S)?$",
      "type": "string",
      "description": "The carrier specific code of the service for which the schedule details are published.\n\n**Condition:** Mandatory if `carrierExportVoyageNumber` is provided and Vessel details or `carrierServiceName` are blank\n"
    },
    "universalServiceReference": {
      "maxLength": 8,
      "minLength": 8,
      "pattern": "^SR\\d{5}[A-Z]$",
      "type": "string",
      "description": "A global unique service reference, as per DCSA standard, agreed by VSA partners for the service. The service reference must match the regular expression pattern: `SR\\d{5}[A-Z]`. The letters `SR` followed by `5 digits`, followed by a checksum-character as a capital letter from `A to Z`.\n"
    },
    "carrierExportVoyageNumber": {
      "maxLength": 50,
      "pattern": "^\\S(?:.*\\S)?$",
      "type": "string",
      "description": "The carrier specific identifier of the export Voyage.\n\n**Condition:** Mandatory if `expectedDepartureDate` or `expectedArrivalAtPlaceOfDeliveryStartDate` and `expectedArrivalAtPlaceOfDeliveryEndDate` is not provided.\n"
    },
    "universalExportVoyageReference": {
      "maxLength": 5,
      "minLength": 5,
      "pattern": "^\\d{2}[0-9A-Z]{2}[NEWSR]$",
      "type": "string",
      "description": "A global unique voyage reference for the export Voyage, as per DCSA standard, agreed by VSA partners for the voyage. The voyage reference must match the regular expression pattern: `\\d{2}[0-9A-Z]{2}[NEWSR]`\n- `2 digits` for the year\n- `2 alphanumeric characters` for the sequence number of the voyage\n- `1 character` for the direction/haul (`N`orth, `E`ast, `W`est, `S`outh or `R`oundtrip).\n"
    },
    "declaredValue": {
      "minimum": 0,
      "type": "number",
      "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",
      "format": "float"
    },
    "declaredValueCurrency": {
      "maxLength": 3,
      "minLength": 3,
      "pattern": "^[A-Z]{3}$",
      "type": "string",
      "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\n"
    },
    "carrierCode": {
      "maxLength": 4,
      "pattern": "^\\S+$",
      "type": "string",
      "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 carrier the booking request is intended for. `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"
      ]
    },
    "isPartialLoadAllowed": {
      "type": "boolean",
      "description": "Indicates whether the shipper agrees to load part of the shipment in case not all of the cargo is delivered within cut-off.\n\n**Note:** The carrier is not liable in case unable to follow the customer's instructions due to operational constraints. If this value is omitted, it may be interpreted differently by different API providers and by the same API provider in different contexts.\n"
    },
    "isExportDeclarationRequired": {
      "type": "boolean",
      "description": "Information provided by the shipper whether an export declaration is required for this particular shipment/commodity/destination.\n\n**Note:** If this property is omitted, it may be interpreted differently by different API providers and by the same API provider in different contexts.\n"
    },
    "exportDeclarationReference": {
      "maxLength": 35,
      "pattern": "^\\S(?:.*\\S)?$",
      "type": "string",
      "description": "Reference number assigned to an Export declaration typically submitted by the exporter (or the freight forwarder on behalf of the exporter) that provides detailed information about the goods being exported. It serves as a record for the exporting country's government and is used for statistical, regulatory, and compliance purposes. The export declaration must typically be submitted to the relevant customs authorities before the goods leave the exporting country.\n"
    },
    "expectedDepartureDate": {
      "type": "string",
      "description": "The date when the shipment is expected to be loaded on board a vessel as provided by the shipper or its agent.\n\n**Condition:** Mandatory if vessel/voyage/service details or `expectedArrivalAtPlaceOfDeliveryDate` is not provided.\n",
      "format": "date"
    },
    "expectedArrivalAtPlaceOfDeliveryStartDate": {
      "type": "string",
      "description": "The start date (provided as a range together with `expectedArrivalAtPlaceOfDeliveryEndDate`) for when the shipment is expected to arrive at `Place Of Delivery`.\n\n**Condition:** Mandatory if vessel/voyage/service details or `expectedDepartureDate` is not provided.\n",
      "format": "date"
    },
    "expectedArrivalAtPlaceOfDeliveryEndDate": {
      "type": "string",
      "description": "The end date (provided as a range together with `expectedArrivalAtPlaceOfDeliveryStartDate`) for when the shipment is expected to arrive at `Place Of Delivery`.\n\n**Condition:** Mandatory if vessel/voyage/service details or `expectedDepartureDate` is not provided.\n",
      "format": "date"
    },
    "transportDocumentTypeCode": {
      "type": "string",
      "description": "Specifies the type of the `Transport Document`. Possible values are:\n- `BOL` (Bill of Lading)\n- `SWB` (Sea Waybill)\n",
      "enum": [
        "BOL",
        "SWB"
      ]
    },
    "transportDocumentReference": {
      "maxLength": 20,
      "pattern": "^\\S(?:.*\\S)?$",
      "type": "string",
      "description": "A unique reference allocated by the shipping line to the `Transport Document` that the booking concerns.\n"
    },
    "bookingChannelReference": {
      "maxLength": 20,
      "pattern": "^\\S(?:.*\\S)?$",
      "type": "string",
      "description": "Identification number provided by the platform/channel used for booking request/confirmation, ex: Inttra booking reference, or GTNexus, other.\n\n**Condition:** a booking channel is being used\n"
    },
    "incoTerms": {
      "maxLength": 3,
      "type": "string",
      "description": "Transport obligations, costs and risks as agreed between buyer and seller as defined by [Incoterms Rules](https://iccwbo.org/business-solutions/incoterms-rules/).\n"
    },
    "isEquipmentSubstitutionAllowed": {
      "type": "boolean",
      "description": "Indicates if an alternate equipment type can be provided by the carrier.\n"
    },
    "invoicePayableAt": {
      "$ref": "#/$defs/InvoicePayableAt"
    },
    "placeOfBLIssue": {
      "$ref": "#/$defs/PlaceOfBLIssue"
    },
    "references": {
      "type": "array",
      "description": "A list of `References`\n",
      "items": {
        "$ref": "#/$defs/ReferenceShipper"
      }
    },
    "customsReferences": {
      "type": "array",
      "description": "A list of `Customs references`\n",
      "items": {
        "$ref": "#/$defs/CustomsReference"
      }
    },
    "documentParties": {
      "$ref": "#/$defs/DocumentPartiesReq"
    },
    "partyContactDetails": {
      "type": "array",
      "description": "The contact details of the person(s) to contact in relation to the **Booking** (changes, notifications etc.) \n",
      "items": {
        "$ref": "#/$defs/PartyContactDetail"
      }
    },
    "shipmentLocations": {
      "minItems": 1,
      "type": "array",
      "description": "A list of `Shipment Locations`\n",
      "items": {
        "$ref": "#/$defs/ShipmentLocation"
      }
    },
    "requestedEquipments": {
      "minItems": 1,
      "type": "array",
      "description": "List of `Requested Equipments`. Multiple containers can be requested within the same booking. For each Requested Equipment object with 2 or more units, it is a condition that the commodity (or list of commodities) defined within the same Requested Equipment object is the same for each requested unit.\n\n**Example:** 2 x 20' containing 50% shoes and 50% t-shirts can be requested within the same Requested Equipment object only if each 20' will contain 50% shoes and 50% t-shirts. If 1 x 20' will contain 100% shoes and the other 20' will be 100% t-shirts, 2 separate Requested Equipment objects must be defined.\n",
      "items": {
        "$ref": "#/$defs/RequestedEquipmentShipper"
      }
    }
  },
  "$defs": {
    "ActiveReeferSettings": {
      "title": "Active Reefer Settings",
      "required": [
        "temperatureSetpoint",
        "temperatureUnit"
      ],
      "type": "object",
      "properties": {
        "temperatureSetpoint": {
          "type": "number",
          "description": "Target value of the temperature for the Reefer based on the cargo requirement.\n",
          "format": "float"
        },
        "temperatureUnit": {
          "type": "string",
          "description": "The unit for temperature in Celsius or Fahrenheit\n- `CEL` (Celsius)\n- `FAH` (Fahrenheit)\n\n**Condition:** Mandatory to provide if `temperatureSetpoint` is provided\n",
          "enum": [
            "CEL",
            "FAH"
          ]
        },
        "o2Setpoint": {
          "maximum": 100,
          "minimum": 0,
          "type": "number",
          "description": "The percentage of the controlled atmosphere CO<sub>2</sub> target value\n",
          "format": "float"
        },
        "co2Setpoint": {
          "maximum": 100,
          "minimum": 0,
          "type": "number",
          "description": "The percentage of the controlled atmosphere CO<sub>2</sub> target value\n",
          "format": "float"
        },
        "humiditySetpoint": {
          "maximum": 100,
          "minimum": 0,
          "type": "number",
          "description": "The percentage of the controlled atmosphere humidity target value\n",
          "format": "float"
        },
        "airExchangeSetpoint": {
          "minimum": 0,
          "type": "number",
          "description": "Target value for the air exchange rate which is the rate at which outdoor air replaces indoor air within a Reefer container\n",
          "format": "float"
        },
        "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 to provide if `airExchange` is provided\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"
        },
        "isPreCoolingRequired": {
          "type": "boolean",
          "description": "Indicator whether reefer container should be pre-cooled to the temperature setting required at time of release from depot\n"
        },
        "isGeneratorSetRequired": {
          "type": "boolean",
          "description": "Indicator whether reefer container should have a generator set attached at time of release from depot\n"
        }
      },
      "description": "The specifications for a Reefer equipment.\n\n**Condition:** Only applicable when `isNonOperatingReefer` is set to `false`\n"
    },
    "Address": {
      "title": "Address",
      "required": [
        "city",
        "countryCode",
        "street"
      ],
      "type": "object",
      "properties": {
        "street": {
          "maxLength": 70,
          "type": "string",
          "description": "The name of the street."
        },
        "streetNumber": {
          "maxLength": 50,
          "type": "string",
          "description": "The number of the street."
        },
        "floor": {
          "maxLength": 50,
          "pattern": "^\\S(?:.*\\S)?$",
          "type": "string",
          "description": "The floor of the street number.\n"
        },
        "postCode": {
          "maxLength": 10,
          "type": "string",
          "description": "The post code."
        },
        "POBox": {
          "maxLength": 20,
          "type": "string",
          "description": "A numbered box at a post office where a person or business can have mail or parcels delivered."
        },
        "city": {
          "maxLength": 35,
          "pattern": "^\\S(?:.*\\S)?$",
          "type": "string",
          "description": "The name of the city.\n"
        },
        "stateRegion": {
          "maxLength": 65,
          "type": "string",
          "description": "The name of the state/region."
        },
        "countryCode": {
          "maxLength": 2,
          "minLength": 2,
          "pattern": "^[A-Z]{2}$",
          "type": "string",
          "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"
        }
      },
      "description": "An object for storing address related information\n"
    },
    "BookingAgent": {
      "title": "Booking Agent",
      "required": [
        "partyName"
      ],
      "type": "object",
      "properties": {
        "partyName": {
          "maxLength": 70,
          "pattern": "^\\S(?:.*\\S)?$",
          "type": "string",
          "description": "Name of the party.\n"
        },
        "address": {
          "$ref": "#/$defs/PartyAddress"
        },
        "partyContactDetails": {
          "minItems": 1,
          "type": "array",
          "description": "A list of contact details\n",
          "items": {
            "$ref": "#/$defs/PartyContactDetail"
          }
        },
        "identifyingCodes": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/IdentifyingCode"
          }
        },
        "taxLegalReferences": {
          "type": "array",
          "description": "A list of `Tax References` for a `Party`\n",
          "items": {
            "$ref": "#/$defs/TaxLegalReference"
          }
        },
        "reference": {
          "maxLength": 35,
          "pattern": "^\\S(?:.*\\S)?$",
          "type": "string",
          "description": "A reference linked to the `Booking Agent`.\n"
        }
      },
      "description": "The party placing the booking request on behalf of the customer.\n"
    },
    "CargoGrossVolume": {
      "title": "Cargo Gross Volume",
      "required": [
        "unit",
        "value"
      ],
      "type": "object",
      "properties": {
        "value": {
          "minimum": 0,
          "exclusiveMinimum": true,
          "type": "number",
          "description": "The estimated grand total volume of the cargo.\n",
          "format": "float"
        },
        "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"
          ]
        }
      },
      "description": "The estimated grand total volume of the cargo.\n"
    },
    "CargoGrossWeight": {
      "title": "Cargo Gross Weight",
      "required": [
        "unit",
        "value"
      ],
      "type": "object",
      "properties": {
        "value": {
          "minimum": 0,
          "exclusiveMinimum": true,
          "type": "number",
          "description": "The estimated grand total gross weight of the cargo, including packaging items being carried, which can be expressed in imperial or metric terms, as provided by the shipper.\n",
          "format": "float"
        },
        "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"
          ]
        }
      },
      "description": "The estimated grand total gross weight of the cargo, including packaging items being carried, which can be expressed in imperial or metric terms, as provided by the shipper.\n\n**Condition:** Mandatory if not provided on `Requested Equipment` level.\n"
    },
    "CargoGrossWeightReq": {
      "title": "Cargo Gross Weight (Requested Equipment)",
      "required": [
        "unit",
        "value"
      ],
      "type": "object",
      "properties": {
        "value": {
          "minimum": 0,
          "exclusiveMinimum": true,
          "type": "number",
          "description": "The estimated grand total gross weight of the cargo, including packaging items being carried, which can be expressed in imperial or metric terms, as provided by the shipper.\n",
          "format": "float"
        },
        "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"
          ]
        }
      },
      "description": "The estimated grand total gross weight of the cargo, including packaging items being carried, which can be expressed in imperial or metric terms, as provided by the shipper.\n\n**Condition:** Mandatory if not provided on `Commodity` level\n"
    },
    "CargoNetVolume": {
      "title": "Cargo Net Volume",
      "required": [
        "unit",
        "value"
      ],
      "type": "object",
      "properties": {
        "value": {
          "minimum": 0,
          "exclusiveMinimum": true,
          "type": "number",
          "description": "The estimated net total volume of the cargo.\n",
          "format": "float"
        },
        "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"
          ]
        }
      },
      "description": "The estimated net total volume of the cargo.\n"
    },
    "CargoNetWeight": {
      "title": "Cargo Net Weight",
      "required": [
        "unit",
        "value"
      ],
      "type": "object",
      "properties": {
        "value": {
          "minimum": 0,
          "exclusiveMinimum": true,
          "type": "number",
          "description": "The estimated grand total net weight of the cargo, excluding packaging items being carried, which can be expressed in imperial or metric terms, as provided by the shipper.\n",
          "format": "float"
        },
        "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"
          ]
        }
      },
      "description": "The estimated grand total net weight of the cargo, excluding packaging items being carried, which can be expressed in imperial or metric terms, as provided by the shipper.\n"
    },
    "CarrierBookingOffice": {
      "title": "Carrier Booking Office",
      "required": [
        "UNLocationCode",
        "partyName"
      ],
      "type": "object",
      "properties": {
        "partyName": {
          "maxLength": 70,
          "pattern": "^\\S(?:.*\\S)?$",
          "type": "string",
          "description": "Name of the party.\n"
        },
        "UNLocationCode": {
          "maxLength": 5,
          "minLength": 5,
          "pattern": "^[A-Z]{2}[A-Z2-9]{3}$",
          "type": "string",
          "description": "The UN Location code specifying where the carrier booking office is located. The pattern used must be\n\n- 2 characters for the country code using [ISO 3166-1 alpha-2](https://www.iso.org/obp/ui/#iso:pub:PUB500001:en)\n- 3 characters to code a location within that country. Letters A-Z and numbers from 2-9 can be used\n\nMore info can be found here: [UN/LOCODE](https://unece.org/trade/cefact/UNLOCODE-Download)\n"
        },
        "address": {
          "$ref": "#/$defs/Address"
        },
        "partyContactDetails": {
          "minItems": 1,
          "type": "array",
          "description": "A list of contact details\n",
          "items": {
            "$ref": "#/$defs/PartyContactDetail"
          }
        }
      },
      "description": "The carrier office responsible for processing the booking.\n"
    },
    "CommodityShipper": {
      "title": "Commodity (Shipper)",
      "required": [
        "commodityType"
      ],
      "type": "object",
      "properties": {
        "commodityType": {
          "maxLength": 550,
          "pattern": "^\\S(?:.*\\S)?$",
          "type": "string",
          "description": "High-level description of goods to be shipped which allow the carrier to confirm acceptance and commercial terms. To be replaced by \"description of goods\" upon submission of `Shipping Instructions`\n"
        },
        "HSCodes": {
          "type": "array",
          "description": "A list of `HS Codes` that apply to this `commodity`\n",
          "items": {
            "maxLength": 10,
            "minLength": 6,
            "pattern": "^\\d{6,10}$",
            "type": "string",
            "description": "Used by customs to classify the product being shipped. The type of HS code depends on country and customs requirements. The code must be at least 6 and at most 10 digits.\n\nMore information can be found here: [HS Nomenclature](https://www.wcoomd.org/en/topics/nomenclature/instrument-and-tools).\n"
          }
        },
        "nationalCommodityCodes": {
          "type": "array",
          "description": "A list of `National Commodity Codes` that apply to this `commodity`\n",
          "items": {
            "$ref": "#/$defs/NationalCommodityCode"
          }
        },
        "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"
        },
        "references": {
          "type": "array",
          "description": "A list of `References`\n",
          "items": {
            "$ref": "#/$defs/ReferenceShipper"
          }
        },
        "customsReferences": {
          "type": "array",
          "description": "A list of `Customs references`\n",
          "items": {
            "$ref": "#/$defs/CustomsReference"
          }
        }
      },
      "description": "Type of goods, defined by its commodity type\n"
    },
    "Consignee": {
      "title": "Consignee",
      "required": [
        "partyName"
      ],
      "type": "object",
      "properties": {
        "partyName": {
          "maxLength": 70,
          "pattern": "^\\S(?:.*\\S)?$",
          "type": "string",
          "description": "Name of the party.\n"
        },
        "address": {
          "$ref": "#/$defs/PartyAddress"
        },
        "partyContactDetails": {
          "minItems": 1,
          "type": "array",
          "description": "A list of contact details\n",
          "items": {
            "$ref": "#/$defs/PartyContactDetail"
          }
        },
        "identifyingCodes": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/IdentifyingCode"
          }
        },
        "taxLegalReferences": {
          "type": "array",
          "description": "A list of `Tax References` for a `Party`\n",
          "items": {
            "$ref": "#/$defs/TaxLegalReference"
          }
        },
        "reference": {
          "maxLength": 35,
          "pattern": "^\\S(?:.*\\S)?$",
          "type": "string",
          "description": "A reference linked to the `Consignee`.\n"
        },
        "purchaseOrderReferences": {
          "type": "array",
          "description": "A list of `Purchase Order Reference`s linked to the `Consignee`.\n",
          "items": {
            "maxLength": 35,
            "pattern": "^\\S(?:.*\\S)?$",
            "type": "string",
            "description": "A purchase order reference linked to the `Consignee`.\n"
          }
        }
      },
      "description": "The party to which goods are consigned in the Master Bill of Lading.\n"
    },
    "ContainerPositioning": {
      "title": "Container Positioning",
      "required": [
        "location"
      ],
      "type": "object",
      "properties": {
        "dateTime": {
          "type": "string",
          "description": "The date and time requested by the shipper for the positioning of the container(s) at the Container positioning location (`CPO`), if provided, or the Place of Receipt (`PRE`) if `CPO` location is not provided.\n",
          "format": "date-time"
        },
        "location": {
          "$ref": "#/$defs/ContainerPositioningLocation"
        }
      },
      "description": "An object to capture the `Location` together with an optional `Date and Time`.\n"
    },
    "ContainerPositioningLocation": {
      "title": "Container Positioning Location",
      "type": "object",
      "properties": {
        "locationName": {
          "maxLength": 100,
          "pattern": "^\\S(?:.*\\S)?$",
          "type": "string",
          "description": "The name of the location."
        },
        "address": {
          "$ref": "#/$defs/Address"
        },
        "facility": {
          "$ref": "#/$defs/Facility"
        },
        "UNLocationCode": {
          "maxLength": 5,
          "minLength": 5,
          "pattern": "^[A-Z]{2}[A-Z2-9]{3}$",
          "type": "string",
          "description": "The UN Location code specifying where the place is located. The pattern used must be\n\n- 2 characters for the country code using [ISO 3166-1 alpha-2](https://www.iso.org/obp/ui/#iso:pub:PUB500001:en)\n- 3 characters to code a location within that country. Letters A-Z and numbers from 2-9 can be used\n\nMore info can be found here: [UN/LOCODE](https://unece.org/trade/cefact/UNLOCODE-Download)\n"
        },
        "geoCoordinate": {
          "$ref": "#/$defs/GeoCoordinate"
        }
      },
      "description": "An object to capture the `Container Positioning Location`.\n\nThe location of the customer facility where the container(s) will be loaded.\n\n**Condition:** Only applicable to carrier haulage service at origin (`Receipt type at origin = 'SD'`).\n\nThe location can be specified in **any** of the following ways: `Address`, `Facility`, `UN Location Code` or a `GeoCoordinate`.\n\n**Condition:** It is expected that if a location is 

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