{"openapi":"3.0.3","info":{"title":"DCSA Components","description":"Common components for DCSA APIs and Domains. This Domain maintains common SimpleTypes, Headers and parameters used throughout all DCSA APIs and Domains.\n\nFor a history of changes in this domain - please check [GitHub](https://github.com/dcsaorg/DCSA-OpenAPI/tree/master/domain/dcsa#v300). Please also [create a GitHub issue](https://github.com/dcsaorg/DCSA-OpenAPI/issues/new) if you have any questions/comments.\n","license":{"name":"Apache 2.0","url":"http://www.apache.org/licenses/LICENSE-2.0.html"},"contact":{"name":"Digital Container Shipping Association (DCSA)","url":"https://dcsa.org","email":"info@dcsa.org"},"version":"3.0.0"},"components":{"schemas":{"addressLine":{"type":"string","maxLength":35,"description":"A single address line to be used when a B/L needs to be printed.\n","example":"Kronprincessegade 54"},"addressLineNumber":{"type":"integer","format":"int32","minimum":1,"description":"The order of items","example":1},"addressName":{"type":"string","pattern":"^\\S+(\\s+\\S+)*$","maxLength":100,"description":"Name of the address\n","example":"Henrik"},"airExchangeSetpoint":{"type":"number","format":"float","minimum":0,"description":"Target value for the air exchange rate which is the rate at which outdoor air replaces indoor air within a Reefer container\n","example":15.4},"airExchangeUnit":{"type":"string","description":"The unit for `airExchange` in metrics- or imperial- units per hour\n\n- MQH (Cubic metre per hour)\n- FQH (Cubic foot per hour)\n\n**NB:** This is a conditional field. If `airExchange` is specified then this field is required\n","enum":["MQH","FQH"],"example":"MQH"},"amendToTransportDocument":{"type":"string","pattern":"^\\S+(\\s+\\S+)*$","maxLength":20,"description":"This field can be used to reference a Transport Document that is issued (documentStatus = `ISSU`) in order to amend changes.\n\n**The field cannot be modified once set.**\n","example":"HHL51XX80YY"},"amsFilingDueDate":{"type":"string","format":"date","description":"Date when AMS filing should latest be done in the last port of call before visiting the first US port.\n","example":"2021-09-03"},"arrivalNoticeReference":{"type":"string","pattern":"^\\S+(\\s+\\S+)*$","maxLength":100,"description":"A set of unique characters provided by carrier to identify an Arrival Notice\n","example":"ABC709951"},"bargeCallSignNumber":{"type":"string","maxLength":10,"description":"A unique alphanumeric identity that belongs to the barge and is assigned by the International Telecommunication Union (ITU). It consists of a threeletter alphanumeric prefix that indicates nationality, followed by one to four characters to identify the individual vessel. For instance, vessels registered under Denmark are assigned the prefix ranges 5PA-5QZ, OUAOZZ, and XPA-XPZ. The Call Sign changes whenever a barge changes its flag.\n","example":"NCVV"},"bargeFlag":{"type":"string","pattern":"^[A-Z]{2}$","maxLength":2,"description":"The flag of the nation whose laws the barge is registered under. This is the ISO 3166 two-letter country code\n","example":"DE"},"bargeName":{"type":"string","pattern":"^\\S+(\\s+\\S+)*$","maxLength":35,"description":"The name of the Barge. If the name is not known `TBD` (To Be Decided) should be used\n","example":"King of the Seas"},"bargeOperatorCarrierCode":{"type":"string","pattern":"^\\S+(\\s+\\S+)*$","maxLength":10,"description":"The carrier who is in charge of the Barge operation based on either the SMDG or SCAC code lists\n","nullable":false,"example":"MAEU"},"bargeOperatorCarrierCodeListProvider":{"type":"string","description":"Identifies the code list provider used for the barge operator carriercodes. Possible values are:\n- SMDG (Ship Message Design Group)\n- NMFTA (National Motor Freight Traffic Association)\n","enum":["SMDG","NMFTA"],"example":"NMFTA","nullable":false},"bookingChannelReference":{"type":"string","pattern":"^\\S+(\\s+\\S+)*$","maxLength":20,"description":"Identification number provided by the platform/channel used for booking request/confirmation, ex: Inttra booking reference, or GTNexus, other. Conditional on booking channel being used\n","example":"Inttra booking reference"},"bookingRequestCreatedDateTime":{"type":"string","format":"date-time","description":"The date and time when the booking request was created\n","example":"2021-11-03T09:41:00-08:30"},"bookingRequestUpdatedDateTime":{"type":"string","format":"date-time","description":"Last date and time when the booking request was updated\n","example":"2021-11-03T09:41:00-08:30"},"calculationBasis":{"type":"string","pattern":"^\\S+(\\s+\\S+)*$","maxLength":50,"description":"The code specifying the measure unit used for the corresponding unit price for this cost, such as per day, per ton, per square metre.","example":"Per day"},"cargoGrossVolume":{"type":"number","format":"float","example":120.0,"minimum":0,"exclusiveMinimum":true,"description":"The grand total volume of the commodity\n"},"cargoGrossWeight":{"type":"number","format":"float","example":12000.0,"minimum":0,"exclusiveMinimum":true,"description":"The grand total weight of the cargo and weight per container(s) including packaging items being carried, which can be expressed in imperial or metric terms, as provided by the shipper. Excludes the tare weight of the container(s).'\n"},"cargoLineItemID":{"type":"string","pattern":"^\\S+(\\s+\\S+)*$","description":"Identifies the cargo line item (package) within the cargo. The cargo line item ID is provided by the shipper and is used to define the stuffing.\n","example":"12345678\n"},"cargoMovementTypeAtOrigin":{"type":"string","maxLength":3,"description":"Refers to the shipment term at the loading of the cargo into the container. Options are defined in the Cargo Movement Type entity.\n- FCL (Full Container Load)\n- LCL (Less than Container Load)\n- BB (Break Bulk)\n","enum":["FCL","LCL","BB"],"example":"FCL"},"cargoMovementTypeAtDestination":{"type":"string","maxLength":3,"description":"Refers to the shipment term at the unloading of the cargo out of the container. Options are defined in the Cargo Movement Type entity.\n- FCL (Full Container Load)\n- LCL (Less than Container Load)\n- BB (Break Bulk)\n","enum":["FCL","LCL","BB"],"example":"FCL"},"carrierBookingReference":{"type":"string","pattern":"^\\S+(\\s+\\S+)*$","maxLength":35,"description":"A set of unique characters provided by carrier to identify a booking.","example":"ABC709951"},"carrierBookingRequestReference":{"type":"string","pattern":"^\\S+(\\s+\\S+)*$","description":"A reference to the booking during the booking request phase\n","example":"24595eb0-5cfc-4381-9c3a-cedc1975e9aa"},"carrierCode":{"type":"string","pattern":"^\\S+(\\s+\\S+)*$","maxLength":4,"description":"The code containing the SCAC and/or the SMDG code to specify the issuing carrier.  Details about the issuer can be given in the Document Parties entity using the party function code MS.\n","example":"MMCU"},"carrierCodeListProvider":{"type":"string","description":"The provider used for identifying the issuer Code. Possible values are:\n- SMDG (Ship Message Design Group)\n- NMFTA (National Motor Freight Traffic Association) _includes SPLC (Standard Point Location Code)_\n","enum":["SMDG","NMFTA"],"example":"NMFTA"},"carrierExportVoyageNumber":{"type":"string","pattern":"^\\S+(\\s+\\S+)*$","maxLength":50,"example":"2103S","description":"The identifier of an export voyage. The carrier-specific identifier of the export Voyage.\n"},"carrierImportVoyageNumber":{"type":"string","pattern":"^\\S+(\\s+\\S+)*$","maxLength":50,"example":"2103N","description":"The identifier of an import voyage. The carrier-specific identifier of the import Voyage.\n"},"carrierInformationToConsignee":{"type":"string","pattern":"^\\S+(\\s+\\S+)*$","maxLength":500,"description":"Free text field to provide additional required information for the consignee to prepare for the shipment arrival e.g. additional required documents to prepare and present for shipment release – country specific.\n","example":"Please also provide..."},"carrierLocationReference":{"type":"string","pattern":"^\\S+(\\s+\\S+)*$","maxLength":100,"description":"A carrier specific reference to location.\n","example":"123e4567-e89b-12d3-a456-426614174000"},"carrierServiceCode":{"type":"string","pattern":"^\\S+(\\s+\\S+)*$","maxLength":11,"description":"The carrier-specific code of the service for which the schedule details are published.\n","example":"FE1"},"carrierServiceName":{"type":"string","pattern":"^\\S+(\\s+\\S+)*$","maxLength":50,"description":"The name of a service as specified by the carrier\n","example":"Great Lion Service"},"carrierVoyageNumber":{"type":"string","pattern":"^\\S+(\\s+\\S+)*$","maxLength":50,"description":"The carrier-specific identifier of the Voyage.\n","example":"2103S"},"chargeType":{"type":"string","pattern":"^\\S+(\\s+\\S+)*$","maxLength":20,"description":"Free text field describing the charge type to apply\n","example":"N/A"},"chargeTypeCode":{"type":"string","maxLength":4,"description":"Description of the charge type applied.\n","enum":["OCFR","OTHC","DTHC","ODF","DDF"],"example":"DDF"},"cityName":{"type":"string","pattern":"^\\S+(\\s+\\S+)*$","maxLength":65,"description":"The city name of the party’s address.\n","example":"København"},"clauseContent":{"type":"string","pattern":"^\\S+(\\s+\\S+)*$","description":"The content of the clause.\n","example":"It is not allowed to..."},"co2Setpoint":{"type":"number","format":"float","minimum":0,"maximum":100,"description":"The percentage of the controlled atmosphere CO<sub>2</sub> target value\n","example":25},"commodityType":{"type":"string","pattern":"^\\S+(\\s+\\S+)*$","maxLength":550,"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 instruction\n","example":"Mobile phones"},"communicationChannelCode":{"type":"string","maxLength":2,"description":"Specifying which communication channel is to be used for this booking e.g.\n- EI (EDI transmission)\n- EM (Email)\n- AO (API)\n","enum":["EI","EM","AO"],"example":"AO"},"confirmedEquipmentUnits":{"type":"integer","format":"int32","minimum":1,"description":"Number of confirmed equipment units\n","example":3},"contactName":{"type":"string","pattern":"^\\S+(\\s+\\S+)*$","maxLength":100,"description":"Name of the contact\n","example":"Henrik"},"contactPhone":{"type":"string","pattern":"^\\S+(\\s+\\S+)*$","maxLength":30,"description":"Phone number for the contact\n","example":"+45 70262970"},"containerDepositAmount":{"type":"number","format":"float","minimum":0,"description":"A specified amount that the importer is made to pay as a guarantee for the return of the container after the goods in it have been stripped.\nA maximum of 2 digits should be provided\n","example":1012.12},"contractQuotationReference":{"type":"string","pattern":"^\\S+(\\s+\\S+)*$","maxLength":35,"description":"Information provided by the shipper to identify whether pricing for the shipment has been agreed via a contract or a quotation reference. Mandatory if service contract (owner) is not provided.\n","example":"HHL1401"},"country":{"type":"string","pattern":"^\\S+(\\s+\\S+)*$","maxLength":75,"description":"The country of the party’s address.\n","example":"Denmark"},"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://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)\n","example":"DK"},"currencyAmount":{"type":"number","format":"float","minimum":0,"description":"The monetary value of all freight and other service charges for a transport document, with a maximum of 2-digit decimals.\n","example":1012.12},"currencyCode":{"type":"string","pattern":"^[A-Z]{3}$","maxLength":3,"description":"The currency for the charge, using a 3-character code (ISO 4217).\n","example":"DKK"},"customsFilingSystem":{"type":"string","pattern":"^[A-Z]{2,5}_[A-Z]{2}$","description":"Customs filing that needs to be done. The filing system needs to be specified together with the country code. Eg `ACI_CA` for the **Advance Commercial Information** used in Canada, `ACI_EG` for the **Advance Cargo Information** used in Egypt.\n\nValidation is done backEnd. For a complete list of supported Filing System please visit [GitHub](https://github.com/dcsaorg/DCSA-Information-Model/blob/master/datamodel/referencedata.d/filingsystems.csv). A subset can be seen here:\n- `ACI_CA` (Advance Commercial Information in Canada)\n- `ACI_EG` (Advance Cargo Information in Egypt)  \n- `ACE_US` (Automated Commercial Environment in the United States)\n- `AFR_JP` (Advance Filing Rule in Japan)\n","example":"ACE_US"},"customsImportDeclarationProcedure":{"type":"string","maxLength":500,"description":"Instruction on the administrative processes for submitting tax & duties declarations to the local customs agency\n","example":"The tax must be declared..."},"cutOffDateTime":{"type":"string","format":"date-time","description":"Actual cut-off time\n","example":"2019-11-12T07:41:00-08:30"},"cutOffDateTimeCode":{"type":"string","description":"Code for the cut-off time\n- DCO (Documentation cut-off)\n- VCO (VGM cut-off)\n- FCO (FCL delivery cut-off)\n- LCO (LCL delivery cut-off)\n- ECP (Empty container pick-up date and time)\n- EFC (Earliest full-container delivery date)\n","enum":["DCO","VCO","FCO","LCO","ECP","EFC"],"example":"DCO"},"dateRange":{"type":"string","format":"iso8601","description":"The time period for which schedule information is sent. The duration is populated in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) Duration format.\n","example":"P4W"},"declaredValue":{"type":"number","format":"float","minimum":0,"description":"The value of the cargo that the shipper declares 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","example":1231.1},"declaredValueCurrency":{"type":"string","pattern":"^[A-Z]{3}$","maxLength":3,"description":"The currency used for the declared value, using the 3-character code defined by ISO 4217.\n","example":"DKK"},"delayReasonCode":{"type":"string","pattern":"^\\S+(\\s+\\S+)*$","maxLength":3,"description":"Reason code for the delay. See SMDG [Code list DELAY](https://smdg.org/documents/smdg-code-lists/delay-reason-and-port-call-activity/) for a list of valid codes to be used for this attribute.\n","example":"WEA"},"deliveryTypeAtDestination":{"type":"string","maxLength":3,"description":"Indicates the type of service offered at Destination. Options are defined in the Receipt/Delivery entity.\n- CY (Container yard (incl. rail ramp))\n- SD (Store Door)\n- CFS (Container Freight Station)\n","enum":["CY","SD","CFS"],"example":"CY"},"demurrageAmount":{"type":"number","format":"float","minimum":0,"description":"A per-day fee paid by consignee to carrier after expiry of freetime for storing a full container at the equipment handling facility (i.e., terminal or railhead). Fee relates to the cargo, inside the container.\nReference to carrier website or individual charge as per service contract/agreement\n","example":150.0},"demurrageFreetime":{"type":"number","minimum":0,"description":"The number of days that the consignee has to pick up the full container before demurrage fees are charged. Reference to carrier website or individual charge as per service contract/agreement.\n","example":7},"descriptionOfGoods":{"type":"string","pattern":"^\\S+(\\s+\\S+)*$","description":"The cargo description are details which accurately and properly describe the cargo being shipped in the container(s) as provided by the shipper.","example":"300 boxes of blue shoes size 47\n"},"detentionAmount":{"type":"number","format":"float","minimum":0,"description":"A per-day fee paid by consignee to carrier for holding ('detaining') a container upon release from the carrier facility. Fee relates to the use of equipment whether full or empty.\nReference to carrier website or individual charge as per service contract/agreement.\n","example":150.0},"detentionFreetime":{"type":"number","minimum":0,"description":"The number of days that the consignee has to pick up or return the empty container before detention fees are charged. Reference to carrier website or individual charge as per service contract/agreement.\n","example":7},"dimensionUnit":{"type":"string","description":"The unit of measure which can be expressed in\n- MTR (Meter)\n- FOT (Foot)\n","example":"MTR","enum":["MTR","FOT"]},"displayedName":{"type":"string","maxLength":35,"description":"A line of the address to be displayed on the transport document.\n"},"documentReferenceNumber":{"type":"string","pattern":"^\\S+(\\s+\\S+)*$","maxLength":20,"description":"A unique number allocated by the shipping line to the transport document and the main number used for the tracking of the status of the shipment.\n","example":"H50030001L"},"documentStatus":{"type":"string","description":"The status of the document in the process. Possible values are:\n- RECE (Received)\n- DRFT (Drafted)\n- PENA (Pending Approval)\n- PENU (Pending Update)\n- PENC (Pending Confirmation)\n- CONF (Confirmed)\n- REJE (Rejected)\n- APPR (Approved)\n- ISSU (Issued)\n- SURR (Surrendered)\n- SUBM (Submitted)\n- VOID (Void)\n- CANC (Cancelled)\n- CMPL (Completed)\n","enum":["RECE","DRFT","PENA","PENU","PENC","CONF","REJE","APPR","ISSU","SURR","SUBM","VOID","CANC","CMPL"],"example":"DRFT"},"email":{"type":"string","pattern":"^(.+)@(\\\\S+)$","maxLength":100,"description":"`E-mail` address to be used\n","example":"info@dcsa.org"},"emptyIndicatorCode":{"type":"string","description":"Code to denote whether the equipment is empty or laden.","example":"EMPTY","enum":["EMPTY","LADEN"]},"equipmentReference":{"type":"string","pattern":"^\\S+(\\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, 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, it is suggested to follow [Recommendation #2: Containers with non-ISO identification](https://smdg.org/documents/smdg-recommendations) from SMDG.\n","example":"APZU4812090"},"equipmentSetpointAmbientTemperature":{"type":"number","format":"float","description":"The value of the ambient temperature set for the Reefer.\n","example":-15},"equipmentSetpointTemperature":{"type":"number","format":"float","description":"The value of the temperature set for the Reefer\n","example":-15},"equipmentSetpointO2":{"type":"number","format":"float","minimum":0,"maximum":100,"description":"The percentage value of the controlled atmosphere `O<sub>2</sub>` set for the Reefer\n","example":75.3},"equipmentSetpointCo2":{"type":"number","format":"float","minimum":0,"maximum":100,"description":"The percentage value of the controlled atmosphere `CO<sub>2</sub>` set for the Reefer\n","example":75.3},"equipmentSetpointHumidity":{"type":"number","format":"float","minimum":0,"maximum":100,"description":"The percentage value of the controlled atmosphere humidity set for the Reefer\n","example":95.6},"equipmentSetpointAirExchange":{"type":"number","format":"float","minimum":0,"description":"The value set on the container for the air exchange rate at which outdoor air replaces indoor air within a Reefer\n","example":15.4},"etaAtPlaceOfDeliveryDateTime":{"type":"string","format":"date-time","description":"An estimated date and time of arrival at `Place of Delivery` in local time\n","example":"2021-11-03T10:23:00-01:00"},"etaAtPortOfDischargeDateTime":{"type":"string","format":"date-time","description":"An estimated date and time of arrival at `Port of Discharge` in local time\n","example":"2021-11-03T10:23:00-01:00"},"eventComment":{"type":"string","pattern":"^\\S+(\\s+\\S+)*$","minLength":0,"maxLength":250,"description":"An additional Comment to a timestamp that can be shared with the receiver party.\n","example":"Delay due to bad weather"},"eventLocationDateTime":{"type":"string","format":"date-time","description":"A date when the event is taking place at the location\n","example":"2021-11-03T10:23:00-01:00"},"expectedArrivalAtPlaceOfDeliveryStartDate":{"type":"string","format":"date","description":"The start date (provided as a range together with `expectedArrivalAtPlaceOfDeliveryEndDate`) for when the shipment is expected to arrive at final destination. If vessel/voyage or `expectedDepartureDate` is not provided, this is mandatory together with `expectedArrivalAtPlaceOfDeliveryEndDate`\n","example":"2021-05-17"},"expectedArrivalAtPlaceOfDeliveryEndDate":{"type":"string","format":"date","description":"The end date (provided as a range together with `expectedArrivalAtPlaceOfDeliveryStartDate`) for when the shipment is expected to arrive at final destination. If vessel/voyage or `expectedDepartureDate` is not provided, this is mandatory together with `expectedArrivalAtPlaceOfDeliveryStartDate`\n","example":"2021-05-19"},"expectedDepartureDate":{"type":"string","format":"date","description":"The date when the shipment is expected to be loaded on board a vessel as provided by the shipper or its agent. If vessel/voyage or expected date of arrival is not provided, this is mandatory\n","example":"2021-05-17"},"exportDeclarationReference":{"type":"string","pattern":"^\\S+(\\s+\\S+)*$","maxLength":35,"description":"A government document permitting designated goods to be shipped out of the country.  Reference number assigned by an issuing authority to an Export License. The export license must be valid at time of departure. Required if Export declaration required is ‘True’.\n","example":"ABC123123"},"exportLicenseIssueDate":{"type":"string","format":"date","description":"Issue date of the export license applicable to the booking. Mandatory to provide in booking request for specific commodities\n","example":"2021-05-14"},"exportLicenseExpiryDate":{"type":"string","format":"date","description":"Expiry date of the export license applicable to the booking.\n\nMandatory to provide in booking request for specific commodities.\n","example":"2021-05-21"},"exportVoyageNumber":{"type":"string","pattern":"^\\S+(\\s+\\S+)*$","maxLength":50,"example":"2103S","description":"The identifier of an export voyage. The vessel operator-specific identifier of the export Voyage.\n"},"facilityCode":{"type":"string","pattern":"^\\S+(\\s+\\S+)*$","maxLength":6,"description":"The code used for identifying the specific facility. This code does <b>not</b> include the UN Location Code.\n","nullable":false,"example":"ADT"},"facilityCodeListProvider":{"type":"string","description":"The provider used for identifying the facility Code. Some facility codes are only defined in combination with an `UN Location Code`\n- BIC (Requires a UN Location Code)\n- SMDG (Requires a UN Location Code)\n","enum":["BIC","SMDG"],"example":"SMDG"},"facilityTypeCode":{"type":"string","description":"The code to identify the specific type of facility.\n- BORD (Border)\n- CLOC (Customer location)\n- COFS (Container freight station)\n- OFFD (Off dock storage)\n- DEPO (Depot)\n- INTE (Inland terminal)\n- POTE (Port terminal)\n- PBPL (Pilot boarding place)\n- BRTH (Berth)\n- RAMP (Ramp)\n- WAYP (Waypoint)\n","enum":["BORD","CLOC","COFS","OFFD","DEPO","INTE","POTE","PBPL","BRTH","RAMP","WAYP"],"example":"POTE"},"facilityTypeCodeOPR":{"type":"string","description":"A specialized version of the facilityCode to be used in Operations events. The code to identify the specific type of facility.\n- PBPL (Pilot boarding place)\n- BRTH (Berth)\n- ANCH (Anchorage Location)\n","enum":["PBPL","BRTH","ANCH"],"example":"BRTH"},"facilityTypeCodeTRN":{"type":"string","description":"The code to identify the specific type of facility. The code indicates which role the facility plays during the `transportCall` or during *stuffing*/*stipping*.\n- BORD (Border)\n- CLOC (Customer location)\n- COFS (Container freight station)\n- OFFD (Off dock storage)\n- DEPO (Depot)\n- INTE (Inland terminal)\n- POTE (Port terminal)\n- RAMP (Ramp)\n- WAYP (Waypoint)\n","enum":["BORD","CLOC","COFS","OFFD","DEPO","INTE","POTE","RAMP","WAYP"],"example":"POTE"},"finalDestinationExpectedArrivalDate":{"type":"string","format":"date","description":"The dates (provided as a range) for when the shipment is expected to arrive at final destination. If vessel/voyage or expected departure date or pick-up date at place of receipt is not provided, this field is mandatory\n"},"firmsCode":{"type":"string","pattern":"^[A-Z0-9]{4}$","description":"A four digit alpha-numeric identifier assigned by U.S. Customs and Border Protection and required to clear customs at the Port of Discharge.\n\n**Condition**: Only applicable to imports into USA.\n","example":"5TY7"},"floor":{"type":"string","pattern":"^\\S+(\\s+\\S+)*$","maxLength":50,"description":"The floor of the party’s street number.\n","example":"5. sal"},"HSCode":{"type":"string","pattern":"^\\d{6,10}$","minLength":6,"maxLength":10,"description":"Used by customs to classify the product being shipped.\n","example":"851712"},"humiditySetpoint":{"type":"number","format":"float","minimum":0,"maximum":100,"description":"The percentage of the controlled atmosphere humidity target value\n","example":95.6},"importLicenseReference":{"type":"string","pattern":"^\\S+(\\s+\\S+)*$","maxLength":35,"description":"A certificate, issued by countries exercising import controls, that permits importation of the articles stated in the license. Reference number assigned by an issuing authority to an Import License. The import license number must be valid at time of arrival. Required if import license required is ‘True’.\n","example":"ABC123123"},"importVoyageNumber":{"type":"string","pattern":"^\\S+(\\s+\\S+)*$","maxLength":50,"description":"The identifier of an import voyage. The vessel operator-specific identifier of the import Voyage.\n","example":"2103N"},"incoTerms":{"type":"string","description":"Transport obligations, costs and risks as agreed between buyer and seller.\n- FCA (Free Carrier)\n- FOB (Free on Board)\n","enum":["FCA","FOB"],"example":"FCA"},"isAMSACIFilingRequired":{"type":"boolean","description":"Customs filing for US (AMS) or Canadian (ACI) customs\n","example":true},"isBulbMode":{"type":"boolean","description":"Is special container setting for handling flower bulbs active\n","example":true},"isCargoProbe1Required":{"type":"boolean","description":"Is `Cargo Probe 1 Required` enabled allowing the container to emit temperatures.\n","example":true,"default":false},"isCargoProbe2Required":{"type":"boolean","description":"Is `Cargo Probe 2 Required` enabled allowing the container to emit temperatures.\n","example":true,"default":false},"isCargoProbe3Required":{"type":"boolean","description":"Is `Cargo Probe 3 Required` enabled allowing the container to emit temperatures.\n","example":true,"default":false},"isCargoProbe4Required":{"type":"boolean","description":"Is `Cargo Probe 4 Required` enabled allowing the container to emit temperatures.\n","example":true,"default":false},"isColdTreatmentRequired":{"type":"boolean","description":"Indicator whether cargo requires cold treatment prior to loading at origin or during transit, but prior arrival at POD\n","example":true},"isCustomsFilingSubmissionByShipper":{"type":"boolean","description":"Indicates whether the shipper will submit the destination customs filing directly. If `false` the shipper requests the carrier to submit the customs filing on their behalf.\n\nMandatory if AMS/ACI filing is required\n","example":true},"isDrainholesOpen":{"type":"boolean","description":"Is drainholes open on the container\n","example":true},"isElectronic":{"type":"boolean","description":"An indicator whether the transport document is electronically transferred.\n","example":true,"default":false},"isEquipmentSubstitutionAllowed":{"type":"boolean","description":"Indicates if an alternate equipment type can be provided by the carrier.\n","example":true},"isExportDeclarationRequired":{"type":"boolean","description":"Information provided by the shipper whether an export declaration is required for this particular shipment/commodity/destination.\n","example":true},"isGeneratorSetRequired":{"type":"boolean","description":"Indicator whether reefer container should have a generator set attached at time of release from depot\n","example":true},"isHighValueCargo":{"type":"boolean","description":"Cargo value exceeds USD XXX K (carrier specific)\n","example":true},"isImportLicenseRequired":{"type":"boolean","description":"Information provided by the shipper whether an import permit or license is required for this particular shipment/commodity/destination.\n","example":true},"ISOEquipmentCode":{"type":"string","pattern":"^\\S+(\\s+\\S+)*$","maxLength":4,"description":"Unique code for the different equipment size/type used for transporting commodities. The code is a concatenation of ISO Equipment Size Code and ISO Equipment Type Code A and follows the ISO 6346 standard.","example":"22GP"},"isPartialLoadAllowed":{"type":"boolean","description":"Indication whether the shipper agrees to load part of the shipment in case where not all of the cargo is delivered within cut-off.\n","example":true},"isPreCoolingRequired":{"type":"boolean","description":"Indicator whether reefer container should be pre-cooled to the temperature setting required at time of release from depot\n","example":true},"isShippedOnBoardType":{"type":"boolean","description":"Specifies whether the Transport document is a received for shipment, or shipped on board.","example":true},"isShipperOwned":{"type":"boolean","description":"Indicates whether the container is shipper owned (SOC).","example":true},"issueDate":{"type":"string","format":"date","description":"Local date when the transport document has been issued","example":"2020-12-12"},"isToBeNotified":{"type":"boolean","description":"Used to decide whether the party will be notified of the arrival of the cargo.","example":true},"isToOrder":{"type":"boolean","description":"Indicates whether the transport document is issued `to order` or not\n","example":false},"isUnderShippersResponsibility":{"type":"boolean","description":"Indicator whether mode of transportation for pre-carriage (e.g. truck, barge, rail) is under shipper's responsibility\n","example":false},"isVentilationOpen":{"type":"boolean","description":"If `true` the ventilation orifice is `Open` - if `false` the ventilation orifice is `closed`\n","example":true},"itNumber":{"type":"string","pattern":"^\\S+(\\s+\\S+)*$","maxLength":20,"description":"A number issued by U.S. Customs to track any imported goods moving inland from a Port of Discharge.\n\n**Condition**: Only applicable to imports into USA that include a `Place of Delivery`.\n","example":"500XER120"},"latitude":{"type":"string","pattern":"^[\\+-][0-9]{1,2}\\.[0-9]{1,6}$","maxLength":10,"description":"Geographic coordinate that specifies the north–south position of a point on the Earth&apos;s surface.\n","example":"48.858550"},"locationName":{"type":"string","pattern":"^\\S+(\\s+\\S+)*$","maxLength":100,"description":"The name of the location.\n","example":"Port of Amsterdam"},"longitude":{"type":"string","pattern":"^[\\+-][0-9]{1,3}\\.[0-9]{1,6}$","maxLength":11,"description":"Geographic coordinate that specifies the east–west position of a point on the Earth&apos;s surface.\n","example":"2.294492036"},"measuredAmbientTemperature":{"type":"number","format":"float","description":"The measured value of the ambient temperature of the Reefer.\n","example":-15},"measuredTemperature":{"type":"number","format":"float","description":"The measured value of the temperature of the Reefer\n","example":-15},"measuredO2":{"type":"number","format":"float","minimum":0,"maximum":100,"description":"The measured value of the controlled atmosphere `O<sub>2</sub>` value in percent\n","example":75.3},"measuredCo2":{"type":"number","format":"float","minimum":0,"maximum":100,"description":"The measured value of the controlled atmosphere `CO<sub>2</sub>` value in percent\n","example":75.3},"measuredHumidity":{"type":"number","format":"float","minimum":0,"maximum":100,"description":"The measured value of the controlled atmosphere humidity value in percent\n","example":95.6},"measuredAirExchange":{"type":"number","format":"float","minimum":0,"description":"The measured value for the air exchange rate which is the rate at which outdoor air replaces indoor air within a Reefer container\n","example":15.4},"modeOfTransport":{"type":"string","description":"The mode of transport as defined by DCSA.\n","enum":["VESSEL","RAIL","TRUCK","BARGE"],"example":"VESSEL"},"nmftaCode":{"type":"string","pattern":"^\\S+(\\s+\\S+)*$","maxLength":4,"description":"The Standard Carrier Alpha Code (SCAC) provided by NMFTA.","example":"MMCU"},"numberOfCopies":{"type":"integer","format":"int32","minimum":0,"description":"The requested number of copies of the Transport document to be issued by the carrier. Only applicable for physical documents","example":2},"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. Only applicable for physical documents","example":2},"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. Only applicable for physical documents","example":2},"numberOfOriginalsWithCharges":{"type":"integer","format":"int32","minimum":0,"description":"Number of original copies of the negotiable bill of lading that has been requested by the customer with Charges.\n","example":1},"numberOfOriginalsWithoutCharges":{"type":"integer","format":"int32","minimum":0,"description":"Number of original copies of the negotiable bill of lading that has been requested by the customer without Charges.\n","example":1},"numberOfPackages":{"type":"integer","format":"int32","minimum":1,"description":"Specifies the number of packages associated with this cargo item","example":18},"numberOfRiderPages":{"type":"integer","format":"int32","minimum":0,"description":"The number of additional pages required to contain the goods description on a transport document. Only applicable for physical transport documents.","example":2},"o2Setpoint":{"type":"number","format":"float","minimum":0,"maximum":100,"description":"The percentage of the controlled atmosphere O<sub>2</sub> target value\n","example":75.3},"packageCode":{"type":"string","pattern":"^\\S+(\\s+\\S+)*$","maxLength":3,"description":"The unique identifier for the package type","example":"5H4"},"packageNameOnBL":{"type":"string","pattern":"^\\S+(\\s+\\S+)*$","maxLength":50,"description":"To provide package description displayed on the BL\n","example":"Bags"},"partialLoadAllowed":{"type":"boolean","description":"Indication whether the shipper agrees to load part of the shipment in case where not all of the cargo is delivered within cut-off.\n","example":true},"partyFunction":{"type":"string","description":"Specifies the role of the party in the context of the given Shipping Instruction.\n- OS (Original shipper)\n- CN (Consignee)\n- COW (Invoice payer on behalf of the consignor (shipper))\n- COX (Invoice payer on behalf of the consignee)\n- MS (Document/message issuer/sender)\n- N1 (First Notify Party)\n- N2 (Second Notify Party)\n- NI (Other Notify Party)\n- DDR (Consignor's freight forwarder)\n- DDS (Consignee's freight forwarder)\n- HE (Carrier booking office (transportation office))\n- SCO (Service contract owner - Defined by DCSA)\n- BA (Booking Agency)\n- ENR (Envelope Receiver)\n","enum":["OS","CN","COW","COX","MS","N1","N2","NI","DDR","DDS","HE","SCO","BA","ENR"],"example":"DDS"},"partyName":{"type":"string","pattern":"^\\S+(\\s+\\S+)*$","maxLength":100,"description":"Name of the party.\n","example":"Asseco Denmark"},"paymentTermCode":{"type":"string","description":"Indicates whether freight & charges are due for payment before the shipment is effected, practically before the transport document is released to shipper (Prepaid) or before the shipment is finalized meaning cargo released to consignee (Collect)\n- PRE (Prepaid)\n- COL (Collect)\n","enum":["PRE","COL"],"example":"PRE"},"placeOfReceiptPickupDate":{"type":"string","format":"date","description":"The date when the shipment must be picked up by the carrier at place of receipt. Only applicable when carrier haulage is requested.\n","example":"2021-05-17"},"plannedArrivalDate":{"type":"string","format":"date","description":"The planned date of arrival.\n"},"plannedDepartureDate":{"type":"string","format":"date","description":"The planned date of departure.\n"},"portVisitReference":{"type":"string","pattern":"^\\S+(\\s+\\S+)*$","maxLength":50,"description":"The unique reference that can be used to link different `transportCallReferences` to the same port visit. The reference is provided by the port to uniquely identify a port call\n","example":"NLRTM1234589"},"postCode":{"type":"string","maxLength":50,"description":"The post code of the party’s address.","example":"1306"},"preCarriageUnderShippersResponsibility":{"type":"string","description":"Mode of transportation for pre-carriage (e.g., truck, barge, rail), under shipper&apos;s responsibility","enum":["VESSEL","RAIL","TRUCK","BARGE"]},"publicKey":{"type":"string","description":"The public key used for a digital signature.","maxLength":500,"example":"eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IkFzaW"},"quantity":{"type":"number","format":"float","minimum":0,"description":"The amount of unit for this charge item.\n","example":34.4},"receiptTypeAtOrigin":{"type":"string","maxLength":3,"description":"Indicates the type of service offered at Origin. Options are defined in the Receipt/Delivery entity.\n- CY (Container yard (incl. rail ramp))\n- SD (Store Door)\n- CFS (Container Freight Station)\n","enum":["CY","SD","CFS"],"example":"CY"},"receivedForShipmentDate":{"type":"string","format":"date","description":"Date when the last container linked to the transport document is physically in the terminal (customers cleared against the intended vessel).","example":"2020-12-12"},"reeferExtraMaterial":{"type":"string","maxLength":500,"description":"spacers, filler, board or dunnage material used to stabilize cargo and ensure optimal airflow inside the Reefer container.\n","example":"spacers"},"reeferProductName":{"type":"string","maxLength":500,"description":"Carrier specific commercial name indicating the technology service offered.\n","example":"FROZEN","readOnly":true},"referenceType":{"type":"string","description":"The reference type codes defined by DCSA.\n- FF (Freight Forwarder’s Reference)\n- SI (Shipper’s Reference)\n- PO (Purchase Order Reference)\n- CR (Customer’s Reference)\n- AAO (Consignee’s Reference)\n- ECR (Empty container release reference)\n- CSI (Customer shipment ID)\n- BPR (Booking party reference number)\n- BID (Booking Request ID)\n- EQ (Equipment Reference)\n- RUC (Registro Único del Contribuyente)\n- DUE (Declaração Única de Exportação)\n- CER (Canadian Export Reporting System)\n- AES (Automated Export System)\n\nMore details can be found on <a href=\"https://github.com/dcsaorg/DCSA-Information-Model/blob/master/datamodel/referencedata.d/referencetypes.csv\">GitHub</a>.\n","enum":["FF","SI","PO","CR","AAO","ECR","CSI","BPR","BID","EQ","RUC","DUE","CER","AES"],"example":"FF"},"referenceValue":{"type":"string","maxLength":100,"description":"The actual value of the reference. \n","example":"HHL00103004"},"requestedEquipmentUnits":{"type":"number","format":"float","minimum":0,"exclusiveMinimum":true,"description":"Number of requested equipment units. The number can represent a fraction of a container in case the same container type will be used by multiple commodities.\n","example":3.4},"requestedNumberOfOriginals":{"type":"integer","format":"int32","minimum":1,"description":"Number of original copies of the negotiable bill of lading that has been requested by the customer.\n","example":4},"returnDescription":{"type":"string","maxLength":500,"description":"Additional instruction on the return process of the container\n","example":"Please place container..."},"sealNumber":{"type":"string","maxLength":15,"description":"Identifies a seal affixed to the container."},"sealSource":{"type":"string","description":"The source of the seal, namely who has affixed the seal. This attribute links to the Seal Source ID defined in the Seal Source reference data entity.\n- CAR (Carrier)\n- SHI (Shipper)\n- PHY (Phytosanitary)\n- VET (Veterinary)\n- CUS (Customs)\n","enum":["CAR","SHI","PHY","VET","CUS"],"example":"CUS"},"sealType":{"type":"string","description":"The type of seal. This attribute links to the Seal Type ID defined in the Seal Type reference data entity.\n- KLP (Keyless padlock)\n- BLT (Bolt)\n- WIR (Wire)\n","enum":["KLP","BLT","WIR"],"example":"WIR"},"serviceContractReference":{"type":"string","maxLength":30,"description":"Reference number for agreement between shipper and carrier through which the shipper commits to provide a certain minimum quantity of cargo over a fixed period, and the carrier commits to a certain rate or rate schedule.","example":"HHL51800000"},"shipmentCreatedDateTime":{"type":"string","format":"date-time","description":"The date and time when the shipment was created (equivalent to when the Booking was confirmed).\n","example":"2021-09-03T09:03:00-02:00"},"shipmentLocationTypeCode":{"type":"string","description":"Links to the Location Type Code defined by DCSA.\n- PRE (Place of Receipt)\n- POL (Port of Loading)\n- POD (Port of Discharge)\n- PDE (Place of Delivery)\n- PCF (Pre-carriage From)\n- PSR (Pre-carriage under shipper’s responsibility)\n- OIR (Onward In-land Routing)\n- DRL (Depot release location)\n- ORI (Origin of goods)\n- IEL (Container intermediate export stop off location)\n- PTP (Prohibited transshipment port)\n- RTP (Requested transshipment port)\n- FCD (Full container drop-off location)\n- ECP (Empty container pick-up location)\n","enum":["PRE","POL","POD","PDE","PCF","PSR","OIR","DRL","ORI","IEL","PTP","RTP","FCD","ECP"],"example":"PRE"},"shipmentUpdatedDateTime":{"type":"string","format":"date-time","description":"Last date and time when the Shipment was updated.\n","example":"2021-09-03T09:03:00-02:00"},"shippedOnBoardDate":{"type":"string","format":"date","description":"Date when the last container that is linked to the transport document is physically loaded onboard the vessel indicated on the transport document.","example":"2020-12-12"},"shippingInstructionCreatedDateTime":{"type":"string","format":"date-time","description":"Date and time when the ShippingInstruction was created\n","example":"2019-11-12T07:41:00-08:30"},"shippingInstructionUpdatedDateTime":{"type":"string","format":"date-time","description":"Date and time when the ShippingInstruction was updated\n","example":"2019-11-12T07:41:00-08:30"},"shippingInstructionReference":{"type":"string","pattern":"^\\S+(\\s+\\S+)*$","maxLength":100,"description":"The identifier for a shipping instruction provided by the carrier for system purposes.\n","example":"e0559d83-00e2-438e-afd9-fdd610c1a008"},"shippingMarks":{"type":"string","description":"The identifying details of a package or the actual markings that appear on the package(s). This information is provided by the shipper."},"startDate":{"description":"The start date of the period for which schedule information is sent. The value is populated in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) Date format.","type":"string","format":"date","example":"2020-04-06"},"stateRegion":{"type":"string","maxLength":65,"description":"The state/region of the party’s address.","nullable":true,"example":"Copenhagen"},"storageAmount":{"type":"number","format":"float","minimum":0,"description":"A per-day fee paid for the occupancy of space in, or near, the port (e.g., container yard, terminal), and thus covers the cost incurred by the owner of the space.\nReference to facility (or carrier) website.\n","example":150.0},"streetName":{"type":"string","maxLength":100,"description":"The name of the street of the party’s address.","example":"Kronprinsessegade"},"streetNumber":{"type":"string","maxLength":50,"description":"The number of the street of the party’s address.","example":"54"},"submissionDateTime":{"type":"string","format":"date-time","description":"Date and time of submitting the relevant document and attributes\n","example":"2019-11-12T07:41:00-08:30"},"tareWeight":{"type":"number","format":"float","minimum":0,"exclusiveMinimum":true,"description":"The weight of an empty container (gross container weight).\n","example":4800.0},"taxReference1":{"type":"string","maxLength":20,"description":"The identifying number of the consignee or shipper (Individual or entity) used for tax purposes.","example":"CVR-25645774"},"taxReference2":{"type":"string","maxLength":20,"description":"Optional second identifying number of the consignee or shipper (Individual or entity) used for tax purposes.","example":"CVR-25645774"},"temperatureSetpoint":{"type":"number","format":"float","description":"Target value of the temperature for the Reefer based on the cargo requirement.\n","example":-15},"temperatureUnit":{"type":"string","description":"The unit for temperature in Celsius or Fahrenheit\n\n- CEL (Celsius)\n- FAH (Fahrenheit)\n","enum":["CEL","FAH"],"example":"CEL"},"transportCallReference":{"type":"string","pattern":"^\\S+(\\s+\\S+)*$","maxLength":100,"description":"A carrier definied reference to a `TransportCall`.\n\nIn the case the Means of Transport is a `Vessel` and the facility is a `Port`/`Terminal` - this reference should be considered a **Terminal Call Reference**\n","example":"987e4567"},"termsAndConditions":{"type":"string","description":"Carrier general terms and conditions for the booking.\n"},"transportCallSequenceNumber":{"type":"integer","format":"int32","description":"Transport operator&apos;s key that uniquely identifies each individual call. This key is essential to distinguish between two separate calls at the same location within one voyage.\n","example":2},"transportDocumentCreatedDateTime":{"type":"string","format":"date-time","description":"Date and time when the TransportDocument was created\n","example":"2019-11-12T07:41:00-08:30"},"transportDocumentUpdatedDateTime":{"type":"string","format":"date-time","description":"Date and time when the TransportDocument was updated\n","example":"2019-11-12T07:41:00-08:30"},"transportDocumentReference":{"type":"string","pattern":"^\\S+(\\s+\\S+)*$","maxLength":20,"description":"A unique number allocated by the shipping line to the transport document and the main number used for the tracking of the status of the shipment.\n","example":"HHL71800000"},"transportDocumentTypeCode":{"type":"string","description":"Specifies the type of the transport document\n- BOL (Bill of Lading)\n- SWB (Sea Waybill)\n","enum":["BOL","SWB"],"example":"SWB"},"transportLocationType":{"type":"string","enum":["BERTH","PBP"],"maxLength":3,"nullable":false,"description":"Code of a location to which a certain transport event is corresponding (Berth, Pilot Boarding Place)\n","example":"BERTH"},"transportPlanStage":{"type":"string","description":"Code qualifying a specific stage of transport e.g. pre-carriage, main carriage transport or on-carriage transport\n- PRC (Pre-Carriage)\n- MNC (Main Carriage Transport)\n- ONC (On-Carriage Transport)\n","enum":["PRC","MNC","ONC"],"example":"PRC"},"transportPlanStageSequenceNumber":{"type":"integer","format":"int32","description":"Sequence number of the transport plan stage\n","example":5},"unitPrice":{"type":"number","format":"float","minimum":0,"description":"The unit price of this charge item in the currency of the charge.\n","example":3456.6},"universalServiceReference":{"type":"string","pattern":"^SR\\d{5}[A-Z]$","maxLength":8,"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","example":"SR12345A"},"universalExportVoyageReference":{"type":"string","pattern":"^\\d{2}[0-9A-Z]{2}[NEWS]$","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}[NEWS]`\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 or `S`outh).\n","example":"2103N"},"universalImportVoyageReference":{"type":"string","pattern":"^\\d{2}[0-9A-Z]{2}[NEWS]$","description":"A global unique voyage reference for the import 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}[NEWS]`\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 or `S`outh).\n","example":"2103N"},"universalVoyageReference":{"type":"string","pattern":"^\\d{2}[0-9A-Z]{2}[NEWS]$","description":"A global unique voyage reference, 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}[NEWS]`\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 or `S`outh).\n","example":"2201N"},"UNLocationCode":{"type":"string","pattern":"^[A-Z]{2}[A-Z2-9]{3}$","minLength":5,"maxLength":5,"description":"The UN Location code specifying where the place is located. The pattern used must be\n- 2 characters for the country code using [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)\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://en.wikipedia.org/wiki/UN/LOCODE)\n","example":"FRPAR"},"UNLocationName":{"type":"string","pattern":"^\\S+(\\s+\\S+)*$","maxLength":70,"description":"The name of the UN Location identified by the UN location code above.\n","example":"New York"},"url":{"type":"string","pattern":"^\\S+(\\s+\\S+)*$","maxLength":100,"description":"URL for the contact","example":"https://www.dcsa.org"},"vesselCallSign":{"type":"string","pattern":"^\\S+(\\s+\\S+)*$","maxLength":10,"description":"A unique alphanumeric identity that belongs to the vessel and is assigned by the International Telecommunication Union (ITU). It consists of a threeletter alphanumeric prefix that indicates nationality, followed by one to four characters to identify the individual vessel. For instance, vessels registered under Denmark are assigned the prefix ranges 5PA-5QZ, OUAOZZ, and XPA-XPZ. The Call Sign changes whenever a vessel changes its flag.\n","example":"NCVV"},"vesselCallSignNumber":{"type":"string","pattern":"^\\S+(\\s+\\S+)*$","maxLength":10,"description":"A unique alphanumeric identity that belongs to the vessel and is assigned by the International Telecommunication Union (ITU). It consists of a threeletter alphanumeric prefix that indicates nationality, followed by one to four characters to identify the individual vessel. For instance, vessels registered under Denmark are assigned the prefix ranges 5PA-5QZ, OUAOZZ, and XPA-XPZ. The Call Sign changes whenever a vessel changes its flag.\n","example":"NCVV"},"vesselDraft":{"type":"number","format":"float","minimum":0,"exclusiveMinimum":true,"description":"The actual draft of the vessel.\n\nIf the draft is specified in feet (`FOT`) then the decimal part should be concidered as a fraction of a foot and **not** as a number of inches. E.g. 120.5 feet means 120 and a half foot (which would be 120'6\")\n","example":12.5},"vesselFlag":{"type":"string","pattern":"^\\S+$","maxLength":2,"description":"The flag of the nation whose laws the vessel is registered under. This is the ISO 3166 two-letter country code\n","example":"DE"},"vesselIMONumber":{"type":"string","pattern":"^\\d{7}$","maxLength":7,"description":"The unique reference for a registered Vessel. The reference is the International Maritime Organisation (IMO) number, also sometimes known as the Lloyd&apos;s register code, which does not change during the lifetime of the vessel\n","example":"9321483"},"vesselLOA":{"type":"number","format":"float","minimum":0,"exclusiveMinimum":true,"description":"The maximum length of a ship's hull measured parallel to the waterline (Length OverAll).\n\nIf the length is specified in feet (`FOT`) then the decimal part should be concidered as a fraction of a foot and **not** as a number of inches. E.g. 120.5 feet means 120 and a half foot (which would be 120'6\")\n","example":245.45},"vesselName":{"type":"string","pattern":"^\\S+(\\s+\\S+)*$","maxLength":35,"description":"The name of the Vessel given by the Vessel Operator and registered with IMO.\n","example":"King of the Seas"},"vesselOperatorCarrierCode":{"type":"string","pattern":"^\\S+(\\s+\\S+)*$","maxLength":10,"nullable":false,"description":"The carrier who is in charge of the vessel operation based on either the SMDG or SCAC code lists\n","example":"MAEU"},"vesselOperatorCarrierCodeListProvider":{"type":"string","description":"Identifies the code list provider used for the operator and partner carriercodes.\n","enum":["SMDG","NMFTA"],"example":"NMFTA","nullable":false},"vesselOperatorSMDGLinerCode":{"type":"string","pattern":"^\\S+(\\s+\\S+)*$","maxLength":10,"nullable":false,"description":"The carrier who is in charge of the vessel operation based on the SMDG code\n","example":"HLC"},"vesselPartnerCarrierCode":{"description":"The identifier of the vessel partner for which the current message is intended. This field allows specifying multiple, `,` (comma) separated values if there is more than one vessel partner involved.\n","type":"string","example":"MSCU,HLCU","maxLength":10,"minLength":10},"vesselPartnerCarrierCodeListProvider":{"type":"string","description":"Identifies the code list provider used for the vessel operator and partner carrier codes. If `vesselPartnerCarrierCode` is populated, the code list provider field is to be populated as well.\n","enum":["SMDG","NMFTA"],"example":"NMFTA"},"vesselType":{"type":"string","description":"Categorization of ocean-going vessels distinguished by the main cargo the vessel carries. Possible values:\n- GCGO (General cargo)\n- CONT (Container)\n- RORO (RoRo)\n- CARC (Car carrier)\n- PASS (Passenger)\n- FERY (Ferry)\n- BULK (Bulk)\n- TANK (Tanker)\n- LGTK (Liquefied gas tanker)\n- ASSI (Assistance)\n- PILO (Pilot boat)\n","enum":["GCGO","CONT","RORO","CARC","PASS","FERY","BULK","TANK","LGTK","ASSI","PILO"],"example":"CONT"},"vesselWidth":{"type":"number","format":"float","minimum":0,"exclusiveMinimum":true,"description":"Overall width of the ship measured at the widest point of the nominal waterline.\n\nIf the width is specified in feet (`FOT`) then the decimal part should be concidered as a fraction of a foot and **not** as a number of inches. E.g. 120.5 feet means 120 and a half foot (which would be 120'6\")\n","example":37.33},"volume":{"type":"number","format":"float","minimum":0,"exclusiveMinimum":true,"description":"Calculated by multiplying the width, height, and length of the packed cargo.\n","example":12.0},"volumeUnit":{"type":"string","description":"The unit of measure which can be expressed in either imperial or metric terms\n- FTQ (Cubic meter)\n- MTQ (Cubic foot)\n- LTR (Litre)\n","enum":["MTQ","FTQ","LTR"],"example":"MTQ"},"weight":{"type":"number","format":"float","minimum":0,"exclusiveMinimum":true,"description":"The total weight of the cargo including packaging items being carried in the container(s). Excludes the tare weight of the container(s).\n","example":13000.3},"weightUnit":{"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"],"example":"KGM"}},"headers":{"Current-Page":{"schema":{"type":"string","example":"https://api.dcsa.org/vX/endPoint?pageNumber=fE9mZnNldHw9NSZsaW1pdD01"},"description":"The `Current-Page` header is optional to implement. If provided it **MUST** link to the current page. The queryParameter(s) used (can be `offset` or `keyset` based) to specify the current page **MUST** be accepted when used.\n\nThe example represents a link to a `cursor` based pagination\n","required":false},"Next-Page":{"schema":{"type":"string","example":"https://api.dcsa.org/vX/endPoint?cursor=fE9mZnNldHw9NSZsaW1pdD01"},"description":"The `Next-Page` header is mandatory to implement but **MAY** be omitted in case there are not any more items in the collection for a next page. If provided it **MUST** link to the next page. The queryParameter(s) used (can be `offset` or `keyset` based) to specify the next page **MUST** be accepted when used.\n\nThe example represents a `cursor` based pagination\n","required":false},"Prev-Page":{"schema":{"type":"string","example":"https://api.dcsa.org/vX/endPoint?cursor=fE9mZnNldHw9NSZsaW1pdD01"},"description":"The `Prev-Page` header is optional to implement. If provided it **MUST** link to the previous page. The queryParameter(s) used (can be `offset` or `keyset` based) to specify the previous page **MUST** be accepted when used.\n\nThe example represents a `cursor` based pagination\n","required":false},"Last-Page":{"schema":{"type":"string","example":"https://api.dcsa.org/vX/endPoint?cursor=fE9mZnNldHw9NTkmbGltaXQ9NQ=="},"description":"The `Last-Page` header is optional to implement. If provided it **MUST** link to the last page. The queryParameter(s) used (can be `offset` or `keyset` based) to specify the last page **MUST** be accepted when used.\n\n\nThe example represents a `cursor` based pagination\n","required":false},"First-Page":{"schema":{"type":"string","example":"https://api.dcsa.org/vX/endPoint?cursor=fE9mZnNldHw9NTkmbGltaXQ9NQ=="},"description":"The `First-Page` header is optional to implement. If provided it **MUST** link to the first page. The queryParameter(s) used (can be `offset` or `keyset` based) to specify the first page **MUST** be accepted when used.\n\nThe example represents a `cursor` based pagination\n","required":false},"API-Version":{"schema":{"type":"string","example":"1.0.0"},"description":"SemVer used to indicate the version of the contract (API version) returned.\n"}},"parameters":{"Api-Version-Major":{"in":"header","name":"API-Version","required":false,"schema":{"type":"string","example":"1"},"description":"An API-Version header **MAY** be added to the request (optional); if added it **MUST** only contain **MAJOR** version. API-Version header **MUST** be aligned with the URI version.\n"},"limit":{"name":"limit","in":"query","description":"Maximum number of items to return.\n","required":false,"schema":{"type":"integer","format":"int32","minimum":1,"default":100},"example":100},"sort":{"name":"sort","in":"query","description":"A comma-separated (`,`) list of field names is used to define the sort order. To specify the sort order for each field name required, use a colon (`:`) between the field name and the keyword `ASC` (ascending) or `DESC` (descening). If the keyword is not used, ascending (`ASC`) order is applied by default.\n","required":false,"schema":{"type":"string"},"example":"carrierBookingReference:DESC"}}}}