ImportConsignment

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/portbase/main/json-schema/portbase-import-consignment-schema.json",
  "title": "ImportConsignment",
  "description": "All information related to the import consignment and further handling of the consignment.",
  "x-generated": "2026-10-18",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/portbase-vessel-visit-openapi.yml#/components/schemas/ImportConsignment",
  "required": [
    "cancelled",
    "consignmentMasterLevel",
    "filing",
    "status",
    "type"
  ],
  "type": "object",
  "allOf": [
    {
      "$ref": "#/$defs/com.portbase.bezoekschip.common.api.external.common.ApiConsignment"
    },
    {
      "type": "object",
      "properties": {
        "arrivalTime": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        },
        "bulkDischarges": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/com.portbase.bezoekschip.common.api.external.consignments.ApiBulkDischarge"
          }
        },
        "cancelled": {
          "type": "boolean"
        },
        "consignmentMasterLevel": {
          "$ref": "#/$defs/com.portbase.bezoekschip.common.api.external.consignments.ApiConsignmentMasterLevel"
        },
        "dischargedContainers": {
          "uniqueItems": true,
          "type": "array",
          "description": "List of containers in this consignment that have been discharged",
          "items": {
            "type": [
              "string",
              "null"
            ],
            "description": "List of containers in this consignment that have been discharged"
          }
        },
        "filing": {
          "$ref": "#/$defs/com.portbase.bezoekschip.common.api.external.consignments.filing.ApiFiling"
        },
        "functionalReferenceId": {
          "type": [
            "string",
            "null"
          ],
          "description": "Functional Reference Id that is sent to Dutch customs in order to link the consignment to inspection\nmessages (CNI/RNI messages) from Dutch customs.\nThe functional reference id is also called LRN (Local Reference Number).\n"
        },
        "status": {
          "$ref": "#/$defs/com.portbase.bezoekschip.common.api.external.consignments.status.ApiConsignmentStatus"
        },
        "transhipment": {
          "$ref": "#/$defs/com.portbase.bezoekschip.common.api.external.consignments.transhipments.ApiTranshipment"
        }
      }
    }
  ],
  "$defs": {
    "com.portbase.bezoekschip.common.api.common.visit.Country": {
      "title": "Country",
      "required": [
        "code"
      ],
      "type": "object",
      "properties": {
        "code": {
          "minLength": 1,
          "type": "string"
        },
        "name": {
          "type": [
            "string",
            "null"
          ]
        }
      }
    },
    "com.portbase.bezoekschip.common.api.consignments.enums.CL116": {
      "title": "CL116",
      "type": "string",
      "description": "    Transport charges method of payment:\n        A Payment in cash\n        B Payment by credit card\n        C Payment by cheque\n        D Other (e.g. direct debit to cash account)\n        H Electronic funds transfer\n        Y Account holder with carrier\n        Z  Not pre-paid\n",
      "enum": [
        "A",
        "B",
        "C",
        "D",
        "H",
        "Y",
        "Z"
      ]
    },
    "com.portbase.bezoekschip.common.api.consignments.enums.CL701": {
      "title": "CL701",
      "type": "string",
      "description": "Additional information code (Declaration):\n\n    N10600 Consignee Unknown\n\n    N10900 ENS lodged together with customs declaration for low value consignments\n",
      "enum": [
        "N10600",
        "N10900"
      ]
    },
    "com.portbase.bezoekschip.common.api.consignments.enums.CL703": {
      "title": "CL703",
      "type": "string",
      "description": "        Additional information type:\n    R1\tRFI request\n    R2\tRFI response\n    R4\tRFS response\n    C1\tControl recommendation\n    C2\tControl results\n    S1\tInconsistency\n",
      "enum": [
        "R1",
        "R2",
        "R4",
        "C1",
        "C2",
        "S1"
      ]
    },
    "com.portbase.bezoekschip.common.api.consignments.enums.CL704": {
      "title": "CL704",
      "type": "string",
      "description": "        Additional Supply Chain Actor Role Code:\n    CS Consolidator\n    FW Freight Forwarder\n    WH Warehouse Keeper\n",
      "enum": [
        "CS",
        "FW",
        "WH"
      ]
    },
    "com.portbase.bezoekschip.common.api.consignments.enums.CL704GoodsItem": {
      "title": "CL704GoodsItem",
      "type": "string",
      "description": "        Additional Supply Chain Actor Role Code:\n    MF Manufacturer\n",
      "enum": [
        "MF"
      ]
    },
    "com.portbase.bezoekschip.common.api.consignments.enums.CL707": {
      "title": "CL707",
      "type": "string",
      "description": "        Communication means type:\n    EM Electronic mail\n    TE Telephone\n",
      "enum": [
        "EM",
        "TE"
      ]
    },
    "com.portbase.bezoekschip.common.api.consignments.enums.CL711": {
      "title": "CL711",
      "type": "string",
      "description": "        Container supplier type code:\n    N1 Shipper supplied\n    N2 Carrier supplied\n",
      "enum": [
        "N1",
        "N2"
      ]
    },
    "com.portbase.bezoekschip.common.api.consignments.enums.CL723": {
      "title": "CL723",
      "type": "string",
      "description": "    Functional Error Codes:\n        12\tIncorrect (code) value\n        13\tMissing\n        14\tValue not supported in this position (code value constraint)\n        15\tNot supported in this position\n        19\tInvalid decimal notation\n        26\tDuplicate detected\n        35\tToo many repetitions\n        37\tInvalid type characters\n        38\tMissing digit in front of decimal sign\n        39\tElement too long (length constraint)\n        40\tElement too short (length constraint)\n        70\tInvalid Means of Transport Identification Number\n        71\tHouse consignment in a wrong state\n        72\tENS filing in a wrong state\n        80\tUnknown Transport Document Reference\n        81\tDuplicate Transport Document Reference\n        90\tUnknown MRN\n        91\tDuplicate MRN\n        92\tMessage out of sequence\n        93\tInvalid MRN\n        94\tDuplicate LRN\n        95\tUniqueness Error\n        96\tIncorrect entity reference\n        97\tNot found\n        98\tUnknown reference\n        100\tNot satisfactory data quality\n        101\tIt is not possible to add new goods items or house consignments via an ENS filing amendment\n        102\tNot allowed Unicode character\n        103\tThe date and time of arrival cannot be earlier than the date and time of departure\n        104\tElement cannot be amended\n",
      "enum": [
        "N12",
        "N13",
        "N14",
        "N15",
        "N19",
        "N26",
        "N35",
        "N37",
        "N38",
        "N39",
        "N40",
        "N70",
        "N71",
        "N72",
        "N80",
        "N81",
        "N90",
        "N91",
        "N92",
        "N93",
        "N94",
        "N95",
        "N96",
        "N97",
        "N98",
        "N100",
        "N101",
        "N102",
        "N103",
        "N104"
      ]
    },
    "com.portbase.bezoekschip.common.api.consignments.enums.CL735": {
      "title": "CL735",
      "type": "string",
      "description": "          Referral request type:\n      AMD\tRequest to amend ENS filing\nRFI\tRequest for information\nRFS\tRequest for HRCM screening\n",
      "enum": [
        "AMD",
        "RFI",
        "RFS"
      ]
    },
    "com.portbase.bezoekschip.common.api.consignments.enums.CL750": {
      "title": "CL750",
      "type": "string",
      "description": "        Type of Identification of Means of Transport:\n            N10\tIMO Ship Identification Number\n            N20\tWagon Number\n            N21\tTrain Number\n            N30\tRegistration Number of the Road Vehicle\n            N31\tRegistration Number of the Road Trailer\n            N41\tRegistration Number of the Aircraft\n            N80\tEuropean Vessel Identification Number (ENI Code)\n",
      "enum": [
        "N10",
        "N20",
        "N21",
        "N30",
        "N31",
        "N41",
        "N80"
      ]
    },
    "com.portbase.bezoekschip.common.api.consignments.enums.CL752": {
      "title": "CL752",
      "type": "string",
      "description": "        Additional information code (Subset):\n            A00\tAmendment is not possible\n            A10\tAmend Consignor name\n            A20\tAmend Consignor address\n            A30\tAmend Consignee name\n            A40\tAmend Consignee address\n            A50\tAmend number of packages\n            A60\tAmend description of goods\n            A70\tAmend gross mass\n            B00\tAdditional information cannot be provided\n            B01\tAdditional information is provided\n            B10\tProvide phone number and e-mail address(es) of Consignor\n            B20\tProvide phone number and e-mail address(es) of Consignee\n            C00\tPLACI data element is not confirmed\n            C01\tPLACI data element is confirmed\n            C10\tConfirm PLACI data elements\n            D00\tNo documents can be provided\n            D01\tDocuments are provided\n            D02\tAdditional information provided\n            D10\tProvide all available documents\n            S00\tHRCM screening not performed\n            S01\tHRCM screening performed\n            S10\tProvide information whether HRCM screening has taken place\n",
      "enum": [
        "A00",
        "A10",
        "A20",
        "A30",
        "A40",
        "A50",
        "A60",
        "A70",
        "B00",
        "B01",
        "B10",
        "B20",
        "C00",
        "C01",
        "C10",
        "D00",
        "D01",
        "D02",
        "D10",
        "S00",
        "S01",
        "S10"
      ]
    },
    "com.portbase.bezoekschip.common.api.consignments.enums.CL754": {
      "title": "CL754",
      "type": "string",
      "description": "        Transport document type:\n            C624\tForm 302\n            C625\tRhine Manifest\n            C664\tCN22 declaration according to Article 237 of the Regulation (ECC) No 2454/93\n            C665\tCN23 declaration according to Article 237 of the Regulation (ECC) No 2454/93\n            N703\tHouse waybill\n            N704\tMaster bill of lading\n            N705\tBill of lading\n            N714\tHouse bill of lading\n            N720\tConsignment note CIM\n            N722\tRoad list - SMGS\n            N730\tRoad consignment note\n            N740\tAir waybill\n            N741\tMaster airwaybill\n            N750\tMovement by post including parcel post\n            N760\tMultimodal / combined transport document\n",
      "enum": [
        "C624",
        "C625",
        "C664",
        "C665",
        "N703",
        "N704",
        "N705",
        "N714",
        "N720",
        "N722",
        "N730",
        "N740",
        "N741",
        "N750",
        "N760"
      ]
    },
    "com.portbase.bezoekschip.common.api.consignments.enums.EnsTransportDocumentType": {
      "title": "EnsTransportDocumentType",
      "type": "string",
      "description": "In case of a TSD that only contains a consignment on master level, this value should indicate the ENS transport document type.\nUsed by Dutch customs to look up at the correct level in the ENS and required when sending using filingType = 'TSD'\n\nN704 Bill of lading Master Level: Goods, equipment and parties are declared at master level \n\nN705 Straight bill of lading: Goods, equipment and parties are declared at house level \n\n",
      "enum": [
        "N704",
        "N705"
      ]
    },
    "com.portbase.bezoekschip.common.api.consignments.enums.FilingType": {
      "title": "FilingType",
      "type": "string",
      "description": "F10 Straight bill of lading for single filing. \n\nF11 Master and house bill of lading for single filing \n\nF12 Master bill of lading for multiple filing. \n\nF13 Straight bill of lading for multiple filing. \n\nF50 Road mode of transport filing. \n\nTSD Temporary Storage Declaration. \n\nNONE No declaration to customs.\n",
      "enum": [
        "F10",
        "F11",
        "F12",
        "F13",
        "F50",
        "TSD",
        "NONE"
      ]
    },
    "com.portbase.bezoekschip.common.api.consignments.enums.TransportConditionCode": {
      "title": "TransportConditionCode",
      "type": "string",
      "description": "    Used in the Port Community System of Portbase.\n\n    Code for the contractual condition for the transport of the container cargo,\n    indicating whether the carrier is only responsible for the main carriage or also for the pre and/or on-carriage, e.g. door-to-door, pier-to-pier.\n\n        27 Door-to-door : The carrier is responsible for the intermodal carriage of cargo including both the pre-carriage and the on- carriage.\n        28 Door-to-pier : The carrier is responsible for the intermodal carriage of cargo including the pre-carriage, but excluding the on-carriage.\n        29 Pier-to-door : The carrier is responsible for the intermodal carriage of cargo including the on-carriage, but excluding the pre-carriage.\n        30 Pier-to-pier : The carrier of intermodal cargo is only responsible for the main carriage.\n",
      "enum": [
        "DOOR_TO_DOOR",
        "DOOR_TO_PIER",
        "PIER_TO_DOOR",
        "PIER_TO_PIER"
      ]
    },
    "com.portbase.bezoekschip.common.api.consignments.status.EnsPointer": {
      "title": "EnsPointer",
      "required": [
        "messageElementPath"
      ],
      "type": [
        "object",
        "null"
      ],
      "properties": {
        "messageElementPath": {
          "maxLength": 512,
          "minLength": 0,
          "type": "string"
        }
      }
    },
    "com.portbase.bezoekschip.common.api.consignments.status.TemporaryStorageError": {
      "title": "TemporaryStorageError",
      "type": [
        "object",
        "null"
      ],
      "properties": {
        "description": {
          "type": [
            "string",
            "null"
          ]
        },
        "code": {
          "type": [
            "string",
            "null"
          ]
        },
        "sequenceNumber": {
          "type": [
            "string",
            "null"
          ]
        },
        "tag": {
          "type": [
            "string",
            "null"
          ]
        }
      }
    },
    "com.portbase.bezoekschip.common.api.external.common.ApiConsignment": {
      "title": "Consignment",
      "required": [
        "type"
      ],
      "type": [
        "object",
        "null"
      ],
      "properties": {
        "type": {
          "type": "string",
          "enum": [
            "Import",
            "Export"
          ]
        }
      },
      "description": "State of the consignment"
    },
    "com.portbase.bezoekschip.common.api.external.consignments.ApiActiveBorderTransportMeans": {
      "title": "ActiveBorderTransportMeans",
      "required": [
        "estimatedDateAndTimeOfArrival",
        "identificationNumber",
        "itinerary",
        "nationality",
        "typeOfIdentification",
        "typeOfMeansOfTransport"
      ],
      "type": "object",
      "properties": {
        "identificationNumber": {
          "maxLength": 35,
          "minLength": 0,
          "type": "string",
          "description": "The identification of the vehicle crossing the Union's external frontier. In case of a vessel the IMO number "
        },
        "typeOfMeansOfTransport": {
          "type": "string",
          "description": "Code for type of Means of Transport as published in UNECE CEFACT Trade Facilitation Recommendation No. 28 <a href=\"https://unece.org/trade/uncefact/cl-recommendations)\" target=\"_blank\">unece.org</a>"
        },
        "typeOfIdentification": {
          "$ref": "#/$defs/com.portbase.bezoekschip.common.api.consignments.enums.CL750"
        },
        "nationality": {
          "maxLength": 2,
          "minLength": 2,
          "type": "string",
          "description": "The country under whose flag the means of transport is registered, as published in ISO 3166.\n"
        },
        "actualDateAndTimeOfDeparture": {
          "type": [
            "string",
            "null"
          ],
          "description": "Local date and time of departure from where the goods were loaded onto the active means\nof transport which will carry them into the Union.\n",
          "format": "date-time"
        },
        "estimatedDateAndTimeOfDeparture": {
          "type": [
            "string",
            "null"
          ],
          "description": "Scheduled local date and time of departure from the place where the goods were loaded onto\nthe active means of transport which will carry them into the Union.\n",
          "format": "date-time"
        },
        "estimatedDateAndTimeOfArrival": {
          "type": "string",
          "description": "Scheduled local date and time where the active means of transport arrives in the Union\nat the first port.\n",
          "format": "date-time"
        },
        "itinerary": {
          "maxItems": 99,
          "minItems": 2,
          "type": "array",
          "description": "The countries of routing of the activeBorderTransportMeans.\nFirst country in the sequence must be the same as the place of loading.\nLast country in the sequence must be the same as the place of unloading.\nNOTE: When passing through Northern Ireland use country code \"IE\"\n",
          "items": {
            "maxLength": 2,
            "minLength": 2,
            "type": [
              "string",
              "null"
            ],
            "description": "The countries of routing of the activeBorderTransportMeans.\nFirst country in the sequence must be the same as the place of loading.\nLast country in the sequence must be the same as the place of unloading.\nNOTE: When passing through Northern Ireland use country code \"IE\"\n"
          }
        }
      },
      "description": "The active means of transport, crossing the Union's external frontier."
    },
    "com.portbase.bezoekschip.common.api.external.consignments.ApiAdditionalInformation": {
      "title": "AdditionalInformation",
      "type": [
        "object",
        "null"
      ],
      "properties": {
        "code": {
          "$ref": "#/$defs/com.portbase.bezoekschip.common.api.consignments.enums.CL701"
        },
        "text": {
          "maxLength": 512,
          "minLength": 0,
          "type": [
            "string",
            "null"
          ],
          "description": "Any information provided by the declarant that may deem useful\nfor the release for free circulation of the item concerned.\n"
        }
      },
      "description": "Special request to government from declarant to take or not to take action."
    },
    "com.portbase.bezoekschip.common.api.external.consignments.ApiAdditionalSupplyChainActor": {
      "title": "AdditionalSupplyChainActor",
      "required": [
        "identificationNumber",
        "type"
      ],
      "type": [
        "object",
        "null"
      ],
      "properties": {
        "identificationNumber": {
          "maxLength": 17,
          "minLength": 0,
          "type": "string",
          "description": "The EORI number or third country unique identification number shall be\ndeclared when such number was assigned to the party.\n"
        },
        "type": {
          "$ref": "#/$defs/com.portbase.bezoekschip.common.api.consignments.enums.CL704"
        },
        "warehouseAuthorisationNumber": {
          "type": [
            "string",
            "null"
          ],
          "description": "Enter the authorisation number of the warehouse keeper when the type is 'WH'\n"
        }
      },
      "description": " A party in the supply chain having obtained a trusted trader certificate but\n otherwise not being identified in the declarations.\n"
    },
    "com.portbase.bezoekschip.common.api.external.consignments.ApiAddress": {
      "title": "Address",
      "required": [
        "city",
        "country"
      ],
      "type": "object",
      "properties": {
        "city": {
          "maxLength": 35,
          "minLength": 0,
          "type": "string",
          "description": "Enter the city name of the party’s address."
        },
        "country": {
          "maxLength": 2,
          "minLength": 2,
          "type": "string",
          "description": "Enter the code of the country."
        },
        "subDivision": {
          "maxLength": 35,
          "minLength": 0,
          "type": [
            "string",
            "null"
          ],
          "description": "Enter a specific region or province."
        },
        "street": {
          "maxLength": 70,
          "minLength": 0,
          "type": [
            "string",
            "null"
          ],
          "description": "Enter the name of the street."
        },
        "postCode": {
          "maxLength": 17,
          "minLength": 0,
          "type": [
            "string",
            "null"
          ],
          "description": "When the country provides a postal code, this field is required.\nEnter the relevant postcode for the related address particulars.\n"
        },
        "additionalLine": {
          "maxLength": 70,
          "minLength": 0,
          "type": [
            "string",
            "null"
          ],
          "description": "Enter aditional the name of the street."
        },
        "number": {
          "maxLength": 35,
          "minLength": 0,
          "type": [
            "string",
            "null"
          ],
          "description": "Enter number of the address."
        },
        "poBox": {
          "maxLength": 70,
          "minLength": 0,
          "type": [
            "string",
            "null"
          ],
          "description": "Enter poBox."
        }
      },
      "description": "Address\n<b>Either the street and number of poBox should be filled.</b>\n"
    },
    "com.portbase.bezoekschip.common.api.external.consignments.ApiBorderTransportMeans": {
      "title": "BorderTransportMeans",
      "required": [
        "identificationNumber",
        "typeOfIdentification",
        "typeOfMeansOfTransport"
      ],
      "type": [
        "object",
        "null"
      ],
      "properties": {
        "identificationNumber": {
          "maxLength": 35,
          "minLength": 0,
          "type": "string",
          "description": "The identity of the means of transport crossing the Union's external frontier."
        },
        "typeOfIdentification": {
          "$ref": "#/$defs/com.portbase.bezoekschip.common.api.consignments.enums.CL750"
        },
        "typeOfMeansOfTransport": {
          "type": "string",
          "description": "Code for type of Means of Transport as published in UNECE CEFACT Trade Facilitation Recommendation No. 28 <a href=\"https://unece.org/trade/uncefact/cl-recommendations)\" target=\"_blank\">unece.org</a>"
        },
        "nationality": {
          "maxLength": 2,
          "minLength": 2,
          "type": [
            "string",
            "null"
          ],
          "description": "The country under whose flag the means of transport is registered, as published in ISO 3166"
        }
      },
      "description": "        The passive means of transport that is being transported by the active means of transport.\n        It must be used for all stuffed cargo which is not stuffed in a container such as unaccompanied\n        as well as accompanied transport of  trailers, swap bodies, chassis. It must also\n        be used for vehicles.\n"
    },
    "com.portbase.bezoekschip.common.api.external.consignments.ApiBulkAuthorization": {
      "title": "BulkAuthorization",
      "required": [
        "fullName",
        "shortName"
      ],
      "type": [
        "object",
        "null"
      ],
      "properties": {
        "fullName": {
          "minLength": 1,
          "type": "string",
          "description": "The full name of the organisation"
        },
        "shortName": {
          "minLength": 1,
          "type": "string",
          "description": "The short name of the organisation"
        },
        "iamConnectedId": {
          "type": [
            "string",
            "null"
          ],
          "description": "The IAM Connected id of the organisation"
        }
      }
    },
    "com.portbase.bezoekschip.common.api.external.consignments.ApiBulkDischarge": {
      "title": "BulkDischarge",
      "required": [
        "grossWeight",
        "itemNumber"
      ],
      "type": [
        "object",
        "null"
      ],
      "properties": {
        "terminalOrganisationShortName": {
          "type": [
            "string",
            "null"
          ],
          "description": "Portbase short name of the organisation associated with the terminal"
        },
        "itemNumber": {
          "type": "integer",
          "description": "The number of the item the discharge is referring to.",
          "format": "int32"
        },
        "grossWeight": {
          "minimum": 0,
          "type": "number",
          "description": "The gross weight."
        }
      },
      "description": "Discharge of bulk goods."
    },
    "com.portbase.bezoekschip.common.api.external.consignments.ApiBuyer": {
      "title": "Buyer",
      "required": [
        "address",
        "name"
      ],
      "type": "object",
      "properties": {
        "identificationNumber": {
          "maxLength": 17,
          "minLength": 0,
          "type": [
            "string",
            "null"
          ],
          "description": "The EORI number or third country unique identification number shall\nbe declared when such number was assigned to the party.\n"
        },
        "name": {
          "maxLength": 70,
          "minLength": 0,
          "type": "string",
          "description": "Enter the full name and where applicable the legal form of the party.\n"
        },
        "address": {
          "$ref": "#/$defs/com.portbase.bezoekschip.common.api.external.consignments.ApiAddress"
        },
        "communications": {
          "maxItems": 9,
          "minItems": 0,
          "type": "array",
          "items": {
            "$ref": "#/$defs/com.portbase.bezoekschip.common.api.external.consignments.ApiCommunication"
          }
        }
      },
      "description": "The buyer is the last known entity to whom the goods are sold or agreed to be sold.\nIf the goods are to be imported otherwise than in pursuance of a purchase,\nthe details of the owner of the goods shall be provided.\n"
    },
    "com.portbase.bezoekschip.common.api.external.consignments.ApiCargoCurrency": {
      "title": "CargoCurrency",
      "required": [
        "description",
        "unCode"
      ],
      "type": "object",
      "properties": {
        "unCode": {
          "minLength": 1,
          "type": "string"
        },
        "description": {
          "minLength": 1,
          "type": "string"
        }
      }
    },
    "com.portbase.bezoekschip.common.api.external.consignments.ApiCargoPackageType": {
      "title": "CargoPackageType",
      "required": [
        "bulk",
        "code",
        "name"
      ],
      "type": "object",
      "properties": {
        "code": {
          "minLength": 1,
          "type": "string"
        },
        "name": {
          "minLength": 1,
          "type": "string"
        },
        "bulk": {
          "type": "boolean"
        }
      },
      "description": "Package type as published in UNECE CEFACT Trade Facilitation Recommendation No. 21\n<a href=\"https://unece.org/trade/uncefact/cl-recommendations\" target=\"_blank\">unece.org</a>\n"
    },
    "com.portbase.bezoekschip.common.api.external.consignments.ApiCarrier": {
      "title": "Carrier",
      "required": [
        "address",
        "identificationNumber",
        "name"
      ],
      "type": [
        "object",
        "null"
      ],
      "properties": {
        "identificationNumber": {
          "maxLength": 17,
          "minLength": 0,
          "type": "string",
          "description": "The EORI number or third country unique identification number shall be declared when such number was assigned to the party."
        },
        "scacCode": {
          "maxLength": 4,
          "minLength": 0,
          "type": [
            "string",
            "null"
          ],
          "description": "The identifier of the carrier, issued by the US"
        },
        "smdgCode": {
          "maxLength": 3,
          "minLength": 0,
          "type": [
            "string",
            "null"
          ],
          "description": "The identifier of the carrier, issued by the SMDG"
        },
        "name": {
          "maxLength": 70,
          "minLength": 0,
          "type": "string"
        },
        "address": {
          "$ref": "#/$defs/com.portbase.bezoekschip.common.api.external.consignments.ApiAddress"
        },
        "communications": {
          "maxItems": 9,
          "minItems": 0,
          "type": "array",
          "items": {
            "$ref": "#/$defs/com.portbase.bezoekschip.common.api.external.consignments.ApiCommunication"
          }
        }
      }
    },
    "com.portbase.bezoekschip.common.api.external.consignments.ApiCommodity": {
      "title": "Commodity",
      "required": [
        "commodityCode",
        "descriptionOfGoods"
      ],
      "type": "object",
      "properties": {
        "descriptionOfGoods": {
          "maxLength": 512,
          "minLength": 0,
          "type": "string"
        },
        "cusCode": {
          "type": [
            "string",
            "null"
          ],
          "description": "The Customs Union and Statistics (CUS) number is the identifier assigned within the\nEuropean Customs Inventory of Chemical Substances (ECICS) to mainly chemical substances\nand preparations. See <a href=\"https://unece.org/trade/cefact/unlocode-code-list-country-and-territory\" target=\"_blank\">unece.org</a>\n"
        },
        "commodityCode": {
          "$ref": "#/$defs/com.portbase.bezoekschip.common.api.external.consignments.ApiCommodityCode"
        },
        "dangerInformation": {
          "$ref": "#/$defs/com.portbase.bezoekschip.common.api.external.consignments.ApiDangerInformation"
        }
      },
      "description": "Details about the properties of the goods"
    },
    "com.portbase.bezoekschip.common.api.external.consignments.ApiCommodityCode": {
      "title": "CommodityCode",
      "required": [
        "harmonizedSystemSubHeadingCode"
      ],
      "type": "object",
      "properties": {
        "harmonizedSystemSubHeadingCode": {
          "maxLength": 6,
          "minLength": 6,
          "type": "string",
          "description": "The Harmonized System is a standardized numerical method of classifying traded products.\nIt is used by customs authorities around the world to identify products when\nassessing duties and taxes and for gathering statistics.\nSee <a href=\"https://ec.europa.eu/taxation_customs/dds2/taric/taric_consultation.jsp?Lang=en\" target=\"_blank\">ec.europa.eu</a>\n"
        },
        "combinedNomenclatureCode": {
          "maxLength": 2,
          "minLength": 2,
          "type": [
            "string",
            "null"
          ],
          "description": "Enter the two additional digits of the Combined nomenclature code."
        }
      },
      "description": "Classification of the good item as published in TARIC. The TARIC\n(Integrated Tariff of the European Communities) database uses a classification\nsystem known as the Combined Nomenclature (CN) to categorize goods.\n"
    },
    "com.portbase.bezoekschip.common.api.external.consignments.ApiCommunication": {
      "title": "Communication",
      "required": [
        "identifier",
        "type"
      ],
      "type": [
        "object",
        "null"
      ],
      "properties": {
        "type": {
          "$ref": "#/$defs/com.portbase.bezoekschip.common.api.consignments.enums.CL707"
        },
        "identifier": {
          "maxLength": 512,
          "minLength": 1,
          "type": "string",
          "description": "Enter a telephone number or e-mail addre

# --- truncated at 32 KB (124 KB total) ---
# Full source: https://artifacts.apis.io/portbase/json-schema/portbase-import-consignment-schema.json