{ "openapi":"3.0.1", "info":{ "title":"TransportInstruction", "description":"Used to submit complete transport data that forms the basis for the transport and invoicing", "contact":{ "name":"Support", "url":"https://dhlpaket.se/dashboard/services/api-farm/", "email":"se.dbi@dhl.com" }, "version":"2.8.132" }, "servers":[ { "url":"https://test-api.freight-logistics.dhl.com/transportinstructionapi/v1/" } ], "security":[ { "Client key":[ ] } ], "paths":{ "/transportinstruction/sendtransportinstruction":{ "post":{ "tags":[ "TransportInstruction" ], "operationId":"TransportInstructionSendTransportInstructionPost", "requestBody":{ "content":{ "application/json-patch+json":{ "schema":{ "$ref":"#/components/schemas/Shipment" } }, "application/json":{ "schema":{ "$ref":"#/components/schemas/Shipment" } }, "text/json":{ "schema":{ "$ref":"#/components/schemas/Shipment" } }, "application/*+json":{ "schema":{ "$ref":"#/components/schemas/Shipment" } } }, "required":false }, "responses":{ "200":{ "description":"SendTransportInstruction response", "content":{ "text/plain":{ "schema":{ "$ref":"#/components/schemas/TransportInstructionResponse" } }, "application/json":{ "schema":{ "$ref":"#/components/schemas/TransportInstructionResponse" } }, "text/json":{ "schema":{ "$ref":"#/components/schemas/TransportInstructionResponse" } } } }, "400":{ "description":"SendTransportInstruction error response", "content":{ "text/plain":{ "schema":{ "$ref":"#/components/schemas/TransportInstructionErrorResponse" } }, "application/json":{ "schema":{ "$ref":"#/components/schemas/TransportInstructionErrorResponse" } }, "text/json":{ "schema":{ "$ref":"#/components/schemas/TransportInstructionErrorResponse" } } } } }, "x-codegen-request-body-name":"transportInstructionModel" } }, "/transportinstruction/ping":{ "get":{ "tags":[ "TransportInstruction" ], "responses":{ "200":{ "description":"Success", "content":{ } } } } } }, "components":{ "schemas":{ "Shipment":{ "required":[ "parties", "payerCode", "pieces", "productCode" ], "type":"object", "properties":{ "id":{ "maxLength":10, "type":"string", "description":"The shipment/tracking id: The unique global number that ensures that packages are not separated from each other during transport from one point to another. Leave empty to get it assigned automatically.", "example":"" }, "productCode":{ "maxLength":3, "type":"string", "description":"See the product documentation for available options.", "example":"103" }, "shippingDate":{ "type":"string", "format":"date" }, "pickupDate":{ "type":"string", "description":"Used with **DHL Eurapid** and **DHL EuroConnect**. The earliest pickup date. Depending on booking deadline and availability the pickup date may be altered by DHL Freight.", "format":"date" }, "requestedDeliveryDate":{ "type":"string", "description":"Required with **DHL Eurapid** and Commited Delivery Date (CDD).", "format":"date" }, "plannedDeliveryDate":{ "type":"string", "format":"date" }, "pickupInstruction":{ "maxLength":140, "type":"string" }, "deliveryInstruction":{ "maxLength":140, "type":"string" }, "totalNumberOfPieces":{ "maximum":999, "type":"integer", "format":"int32", "example":1 }, "totalWeight":{ "maximum":99999, "type":"number", "description":"The shipemnts total weight weight in kg", "format":"double", "example":19.5 }, "totalVolume":{ "maximum":999, "type":"number", "description":"The shipemnts total volume in m³", "format":"double" }, "totalLoadingMeters":{ "maximum":99, "type":"number", "description":"A loading meter (LDM) is 1 meter of the loading space of a truck’s width and full height. Usually calculated for goods that cannot be stacked on or with other goods.", "format":"double", "example":null }, "totalPalletPlaces":{ "maximum":999, "type":"number", "description":"Pallet place (PPL) is based on the dimensions of a EUR pallet: 120 × 80 cm. Usually calculated for goods that cannot be stacked on or with other goods. 1 PLL = 0.4 LDM.", "format":"double" }, "references":{ "maxItems":99, "type":"array", "items":{ "$ref":"#/components/schemas/Reference" } }, "payerCode":{ "$ref":"#/components/schemas/PayerCode" }, "parties":{ "maxItems":6, "minItems":2, "type":"array", "items":{ "$ref":"#/components/schemas/Party" } }, "pieces":{ "maxItems":999, "type":"array", "items":{ "$ref":"#/components/schemas/Piece" } }, "routingCode":{ "type":"string", "readOnly":true }, "additionalServices":{ "$ref":"#/components/schemas/AdditionalServicesDTO" }, "customsInformation":{ "$ref":"#/components/schemas/CustomsInformation" } } }, "Reference":{ "required":[ "qualifier", "value" ], "type":"object", "properties":{ "qualifier":{ "maxLength":3, "type":"string" }, "value":{ "maxLength":35, "type":"string" } } }, "PayerCode":{ "required":[ "code" ], "type":"object", "properties":{ "code":{ "maxLength":3, "type":"string", "description":"See the product documentation for available options based on selected product.", "example":"1" }, "location":{ "maxLength":17, "type":"string", "example":"" } } }, "Party":{ "required":[ "address", "name", "type" ], "type":"object", "properties":{ "id":{ "maxLength":15, "type":"string", "description":"For a consignor, consignee or freight payer the customer/agreement number. Mandatory on the part according to the payer code. For a access point, i.e. parcels shop, parcel station etc, this is the identifier of this location." }, "type":{ "maxLength":15, "type":"string", "enum":[ "Consignor", "Pickup", "Consignee", "Delivery", "AccessPoint", "FreightPayer" ] }, "vatEoriSocialSecurityNumber":{ "maxLength":20, "type":"string", "description":"EORI (Economic operators registration and identification number) used for customs-related trade within the EU.", "example":"" }, "name":{ "maxLength":35, "type":"string" }, "contactName":{ "maxLength":35, "type":"string" }, "references":{ "maxItems":99, "type":"array", "items":{ "maxLength":35, "type":"string" } }, "address":{ "$ref":"#/components/schemas/Address" }, "phone":{ "maxLength":64, "type":"string" }, "email":{ "maxLength":64, "type":"string" }, "subType":{ "maxLength":15, "type":"string", "description":"Use with access point to state if it’s a parcels shop, parcel station etc.\n \n For locationType locker, subType should be set to ParcelStation for all others to PracelShop", "enum":[ "ParcelShop", "ParcelStation" ] }, "vat":{ "$ref":"#/components/schemas/PartyVAT" } } }, "PartyVAT":{ "type":"object", "description":"According to Greece legislation for all transport to, from, and within Greece VAT or TAX ID is required.", "properties":{ "countryCode":{ "type":"string", "description":"VAT country prefix, in general the country ISO code but deviation exist like CHE foe Switzerland and EL for Greece.", "example":"FR" }, "number":{ "type":"string", "description":"The 'number' part of the VAT, can include characters depending on the countries specific format.", "example":"1X123456789" } }, "additionalProperties":false }, "AdditionalServicesDTO":{ "type":"object", "properties":{ "bookIn":{ "type":"boolean", "example":false }, "carryingHelpPickup":{ "type":"boolean", "example":false }, "carryingHelpToRoomOfChoice":{ "type":"boolean", "example":false }, "cashOnDelivery":{ "$ref":"#/components/schemas/CashOnDeliveryOptions" }, "collectionAtTerminal":{ "type":"boolean", "example":false }, "customsCustomersOwnDeclaration":{ "$ref":"#/components/schemas/CustomsCustomersOwnDeclarationOptions" }, "customsHandlingFullService":{ "type":"boolean", "example":false }, "customsHandlingStandard":{ "type":"boolean", "example":false }, "customsJointDeclaration":{ "$ref":"#/components/schemas/CustomsJointDeclarationOptions" }, "dangerousGoods":{ "type":"boolean", "example":false }, "dangerousGoodsLimitedQuantity":{ "type":"boolean", "example":false }, "deliveryAtConstructionSite":{ "type":"boolean", "example":false }, "deliveryMonitoringArrivedAtDhlTerminal":{ "$ref":"#/components/schemas/DeliveryMonitoringOptions" }, "deliveryMonitoringCollectedByReciever":{ "$ref":"#/components/schemas/DeliveryMonitoringOptions" }, "deliveryMonitoringDelivered":{ "$ref":"#/components/schemas/DeliveryMonitoringOptions" }, "deliveryMonitoringNotCollectedByReciever":{ "$ref":"#/components/schemas/DeliveryMonitoringOptions" }, "deliveryMonitoringOutForDelivery":{ "$ref":"#/components/schemas/DeliveryMonitoringOptions" }, "deliveryMonitoringPickup":{ "$ref":"#/components/schemas/DeliveryMonitoringOptions" }, "deliveryWithIdControl":{ "type":"boolean", "example":false }, "deliveryWithoutIdControl":{ "type":"boolean", "example":false }, "deliveryWithoutProofOfDelivery":{ "type":"boolean", "example":false }, "doorstepDelivery":{ "$ref":"#/components/schemas/DoorstepDeliveryOptions" }, "emptyPalletPickup":{ "type":"boolean", "example":false }, "eurPalletExchange":{ "$ref":"#/components/schemas/EURPalletExchangeOptions" }, "eveningDeliveryZoneA":{ "type":"boolean" }, "eveningDeliveryZoneB":{ "type":"boolean", "example":false }, "eveningDeliveryZoneC":{ "type":"boolean", "example":false }, "eveningDeliveryZoneD":{ "type":"boolean", "example":false }, "eveningDeliveryZoneE":{ "type":"boolean", "example":false }, "freightSubsidy":{ "$ref":"#/components/schemas/FreightSubsidyOptions" }, "greenFreight":{ "type":"boolean", "example":false }, "hardcopyProofOfDelivery":{ "$ref":"#/components/schemas/HardcopyProofOfDeliveryOptions" }, "indoorDelivery":{ "type":"boolean", "example":false }, "installation":{ "$ref":"#/components/schemas/InstallationOptions" }, "installationAdvanced":{ "$ref":"#/components/schemas/InstallationAdvancedOptions" }, "insurance":{ "$ref":"#/components/schemas/InsuranceOptions" }, "highValueShipment":{ "$ref":"#/components/schemas/HighValueShipmentOptions" }, "m20":{ "$ref":"#/components/schemas/M20Options" }, "m40":{ "$ref":"#/components/schemas/M40Options" }, "m60":{ "$ref":"#/components/schemas/M60Options" }, "nonStackable":{ "type":"boolean" }, "notification":{ "type":"boolean", "example":false }, "notificationByLetter":{ "type":"boolean", "example":false }, "onlineAppointmentBooking":{ "$ref":"#/components/schemas/OnlineAppointmentBookingOptions" }, "packagingRemoval":{ "type":"boolean", "example":false }, "preAdvice":{ "type":"boolean", "example":false }, "preAdviceByDriver":{ "$ref":"#/components/schemas/PreAdviceByDriverOptions" }, "priorityServiceG7":{ "type":"boolean", "example":false }, "priorityServiceG10":{ "type":"boolean", "example":false }, "priorityServiceG12":{ "type":"boolean", "example":false }, "removalOfReplacedGoods":{ "$ref":"#/components/schemas/RemovalOfReplacedGoodsOptions" }, "sortAndQuantity":{ "$ref":"#/components/schemas/SortAndQuantityOptions" }, "tailLiftLoading":{ "type":"boolean", "example":false }, "tailLiftUnloading":{ "type":"boolean", "example":false }, "thermoCold":{ "$ref":"#/components/schemas/ThermoColdOptions" }, "thermoWarm":{ "$ref":"#/components/schemas/ThermoWarmOptions" }, "temperatureControlled": { "$ref": "#/components/schemas/TemperatureControlledOptions" }, "timeDefiniteLoading":{ "$ref":"#/components/schemas/TimeDefiniteLoadingOptions" }, "timeDefiniteUnloading":{ "$ref":"#/components/schemas/TimeDefiniteUnloadingOptions" }, "truck":{ "type":"boolean", "example":false }, "voecSupplyVAT":{ "$ref":"#/components/schemas/VoecSupplyVATOptions" }, "weekendDelivery":{ "type":"boolean", "example":false }, "fixedDeliveryDate":{ "$ref":"#/components/schemas/FixedDeliveryDateOptions" }, "climateNeutral":{ "type":"boolean" }, "bookInWithInfo":{ "$ref":"#/components/schemas/BookInWithInfoOptions" }, "priorityServiceP10":{ "type":"boolean", "example":false }, "priorityServiceP12":{ "type":"boolean", "example":false }, "dropOffByConsignor":{ "type":"boolean", "example":false }, "personalDelivery":{ "type":"boolean", "example":false }, "preAdvicePickup":{ "type":"boolean", "example":false }, "after12Delivery":{ "type":"boolean", "example":false }, "timeSlotBookingPickup":{ "type":"boolean", "example":false }, "timeSlotBookingDelivery":{ "type":"boolean", "example":false }, "sideLoadingPickup":{ "type":"boolean", "example":false }, "sideUnloadingDelivery":{ "type":"boolean", "example":false }, "availablePickupTime":{ "$ref":"#/components/schemas/AvailablePickupTimeOptions" }, "availableDeliveryTime":{ "$ref":"#/components/schemas/AvailableDeliveryTimeOptions" }, "preAdviceByDriverPickup":{ "$ref":"#/components/schemas/PreAdviceByDriverPickupOptions" }, "indoorDeliverySpecial": { "type": "boolean" } } }, "CustomsInformation":{ "type":"object", "properties":{ "customsDocuments":{ "maxItems":999, "type":"array", "items":{ "$ref":"#/components/schemas/CustomsDocument" } }, "customsCommodities":{ "maxItems":999, "type":"array", "items":{ "$ref":"#/components/schemas/CustomsCommodity" } } } }, "Piece":{ "required":[ "numberOfPieces", "weight" ], "type":"object", "properties":{ "id":{ "type":"array", "description":"The SSCC (Serial Shipping Container Code) a unique GS1/GS1-128 numbers used to identify a logistic unit, such as a case, pallet or parcel. Leave empty to get it assigned automatically.", "example":[ ], "items":{ "maxLength":35, "type":"string" } }, "goodsType":{ "maxLength":70, "type":"string" }, "packageType":{ "maxLength":4, "type":"string", "description":"See the product documentation for available options based on selected product." }, "marksAndNumbers":{ "maxLength":17, "type":"string" }, "numberOfPieces":{ "maximum":999, "minimum":1, "type":"integer", "format":"int32" }, "weight":{ "maximum":99999, "type":"number", "description":"Item weight in kg", "format":"double" }, "volume":{ "maximum":999, "type":"number", "description":"Item volume in m³", "format":"double" }, "loadingMeters":{ "maximum":99, "type":"number", "format":"double" }, "palletPlaces":{ "maximum":999, "type":"number", "format":"double" }, "width":{ "maximum":999, "type":"number", "description":"Item width in cm", "format":"double" }, "height":{ "maximum":999, "type":"number", "description":"Item height in cm", "format":"double" }, "length":{ "maximum":9999, "type":"number", "description":"Item length in cm", "format":"double" }, "dangerousGoods":{ "oneOf":[ { "$ref":"#/components/schemas/DangerousGoods" }, { "maxItems":999, "type":"array", "items":{ "$ref":"#/components/schemas/DangerousGoods" } } ] }, "stackable":{ "type":"boolean" } } }, "AdditionalInformation":{ "type":"object", "properties":{ "code":{ "type":"string" }, "stringValue":{ "type":"string" }, "dateValue":{ "type":"string", "format":"date-time" }, "numericValue":{ "type":"number", "format":"double" } } }, "Address":{ "required":[ "cityName", "countryCode", "street" ], "type":"object", "properties":{ "street":{ "maxLength":35, "type":"string" }, "streetNumber":{ "maxLength":10, "type":"string" }, "additionalAddressInfo":{ "maxLength":35, "type":"string" }, "cityName":{ "maxLength":35, "type":"string" }, "postalCode":{ "maxLength":9, "type":"string", "description":"For Ireland county should be used as postal code, EirCode is not supported." }, "countryCode":{ "maxLength":3, "type":"string" }, "accessCode":{ "maxLength":20, "type":"string" } } }, "CashOnDeliveryOptions":{ "required":[ "amount", "currency" ], "type":"object", "properties":{ "amount":{ "type":"integer", "format":"int64" }, "bankGiroNumber":{ "maxLength":9, "type":"string" }, "plusGiroNumber":{ "maxLength":9, "type":"string" }, "reference":{ "maxLength":35, "type":"string" }, "currency":{ "maxLength":35, "type":"string" } } }, "CustomsCustomersOwnDeclarationOptions":{ "required":[ "customsId" ], "type":"object", "properties":{ "customsId":{ "maxLength":70, "type":"string" }, "customsClearanceInstruction":{ "maxLength":70, "type":"string" } } }, "CustomsJointDeclarationOptions":{ "required":[ "sfid" ], "type":"object", "properties":{ "sfid":{ "maxLength":35, "type":"string" } } }, "DeliveryMonitoringOptions":{ "type":"object", "properties":{ "email":{ "maxLength":64, "type":"string" }, "smsPhoneNumber":{ "maxLength":20, "type":"string" } } }, "DoorstepDeliveryOptions":{ "type":"object", "properties":{ "accessCode":{ "maxLength":20, "type":"string" } } }, "EURPalletExchangeOptions":{ "required":[ "quantity" ], "type":"object", "properties":{ "quantity":{ "maximum":999, "type":"integer", "format":"int32" }, "consignorPalletRegistrationNumber":{ "maxLength":6, "type":"string" }, "consigneePalletRegistrationNumber":{ "maxLength":6, "type":"string" } } }, "FreightSubsidyOptions":{ "required":[ "ncmNumber" ], "type":"object", "properties":{ "ncmNumber":{ "maximum":99999, "type":"integer", "format":"int32" } } }, "HardcopyProofOfDeliveryOptions":{ "type":"object", "properties":{ "email":{ "maxLength":64, "type":"string" } } }, "InstallationOptions":{ "required":[ "quantity" ], "type":"object", "properties":{ "quantity":{ "maximum":999, "minimum":1, "type":"integer", "format":"int32" } } }, "InstallationAdvancedOptions":{ "required":[ "quantity" ], "type":"object", "properties":{ "quantity":{ "maximum":999, "minimum":1, "type":"integer", "format":"int32" } } }, "InsuranceOptions":{ "required":[ "currency", "value" ], "type":"object", "properties":{ "value":{ "type":"number", "format":"double" }, "currency":{ "maxLength":3, "type":"string" } } }, "HighValueShipmentOptions":{ "required":[ "currency", "value" ], "type":"object", "properties":{ "value":{ "type":"number", "format":"double" }, "currency":{ "maxLength":3, "type":"string" } } }, "M20Options":{ "required":[ "quantity" ], "type":"object", "properties":{ "quantity":{ "maximum":999, "minimum":1, "type":"integer", "format":"int32" } } }, "M40Options":{ "required":[ "quantity" ], "type":"object", "properties":{ "quantity":{ "maximum":999, "minimum":1, "type":"integer", "format":"int32" } } }, "M60Options":{ "required":[ "quantity" ], "type":"object", "properties":{ "quantity":{ "maximum":999, "minimum":1, "type":"integer", "format":"int32" } } }, "OnlineAppointmentBookingOptions":{ "type":"object", "properties":{ "responseText":{ "type":"string" } } }, "PreAdviceByDriverOptions":{ "type":"object", "properties":{ "phone":{ "maxLength":64, "type":"string" } } }, "RemovalOfReplacedGoodsOptions":{ "required":[ "quantity" ], "type":"object", "properties":{ "quantity":{ "maximum":999, "minimum":1, "type":"integer", "format":"int32" } } }, "SortAndQuantityOptions":{ "required":[ "quantity", "sort" ], "type":"object", "properties":{ "sort":{ "maximum":999, "type":"number", "format":"double" }, "quantity":{ "maximum":9999, "type":"number", "format":"double" } } }, "TemperatureControlledOptions": { "required":[ "type" ], "type": "object", "properties": { "type": { "$ref": "#/components/schemas/ThermoType" }, "min": { "type": "number", "format": "double", "example":2, "description":"Required if type is **Custom**, else it should be omitted." }, "max": { "type": "number", "format": "double", "example":8, "description":"Required if type is **Custom**, else it should be omitted." } }, "additionalProperties": false }, "ThermoType": { "enum": [ "Custom", "Cold", "Ambient" ], "description":"**Cold** - the temperature during the transport chain is in the range of +2 to +8 °C. \n \n **Ambient** - the the temperature during the transport chain is in the range of +15 to +25 °C. \n \n Other temperature range after special written agreement (but not more than +25 °C). \n \n Temperature-controlled transport is carried out after special written agreement.", "type": "integer", "format": "int32" }, "ThermoColdOptions":{ "type":"object", "description":"Thermo Cold means that the temperature during the transport chain is in the range of +2 to +8 °C. Other temperature range after special written agreement (but not more than +15 °C). Temperature-controlled transport is carried out after special written agreement and must always be specified when booking.", "properties":{ "min":{ "type":"number", "format":"double", "example":2 }, "max":{ "type":"number", "format":"double", "example":8 } } }, "ThermoWarmOptions":{ "type":"object", "description":"Thermo Warm means that the goods are transported frost-free (at least +1 °C.Temperature-controlled transport is carried out after special written agreement and must always be specified when booking.", "properties":{ "min":{ "type":"number", "format":"double", "example":1 }, "max":{ "type":"number", "format":"double", "example":null } } }, "TimeDefiniteLoadingOptions":{ "required":[ "dateTime" ], "type":"object", "properties":{ "dateTime":{ "type":"string", "format":"date-time" } } }, "TimeDefiniteUnloadingOptions":{ "required":[ "dateTime" ], "type":"object", "properties":{ "dateTime":{ "type":"string", "format":"date-time" } } }, "VoecSupplyVATOptions":{ "type":"object", "description":"VOEC (VAT On E-Commerce) used with ParcelConnect to Norway.", "properties":{ "vatId":{ "maxLength":20, "type":"string" } } }, "FixedDeliveryDateOptions":{ "required":[ "date" ], "type":"object", "properties":{ "date":{ "type":"string", "format":"date" } } }, "AvailableDeliveryTimeOptions":{ "required":[ "fromTime", "toTime" ], "type":"object", "properties":{ "fromTime":{ "minLength":3, "pattern":"^(?:[01]?\\d|2[0-3])(?::[0-5]\\d){1,2}$", "type":"string", "example":"07:30" }, "toTime":{ "minLength":3, "pattern":"^(?:[01]?\\d|2[0-3])(?::[0-5]\\d){1,2}$", "type":"string", "example":"16:30" } }, "additionalProperties":false }, "AvailablePickupTimeOptions":{ "required":[ "fromTime", "toTime" ], "type":"object", "properties":{ "fromTime":{ "minLength":3, "pattern":"^(?:[01]?\\d|2[0-3])(?::[0-5]\\d){1,2}$", "type":"string", "example":"07:30" }, "toTime":{ "minLength":3, "pattern":"^(?:[01]?\\d|2[0-3])(?::[0-5]\\d){1,2}$", "type":"string", "example":"16:30" } }, "additionalProperties":false }, "PreAdviceByDriverPickupOptions":{ "required":[ "phone" ], "type":"object", "properties":{ "phone":{ "maxLength":64, "type":"string" } } }, "BookInWithInfoOptions":{ "type":"object", "properties":{ "contactDetails":{ "maxLength":64, "type":"string" }, "contactDetailsType":{ "type":"string", "enum":[ "email", "phonenumber", "externalSystem", "timeWindow", "other" ] } } }, "CustomsDocument":{ "type":"object", "properties":{ "id":{ "type":"string" }, "type":{ "type":"string", "enum":[ "CommercialInvoice", "ProformaInvoice", "ExportLicence", "T1Note", "SAD" ] }, "transportMovement":{ "type":"string", "enum":[ "Export", "Import" ] }, "invoiceDate":{ "type":"string", "format":"date" }, "invoiceCurrency":{ "maxLength":3, "type":"string" }, "invoiceAmount":{ "type":"number", "format":"double" }, "eori":{ "maxLength":20, "type":"string" } } }, "CustomsCommodity":{ "type":"object", "properties":{ "countryCodeOfOrigin":{ "maxLength":3, "type":"string" }, "customsValueCurrency":{ "maxLength":3, "type":"string" }, "customsValue":{ "type":"number", "format":"double" }, "hsItemId":{ "maxLength":38, "type":"string" }, "commodityDescription":{ "maxLength":35, "type":"string" }, "procedureCode":{ "maxLength":4, "type":"string" }, "customsClearanceInstruction":{ "maxLength":70, "type":"string" }, "netWeight":{ "type":"number", "format":"double" }, "numberOfUnits":{ "type":"integer", "format":"int32" }, "additionalInformation":{ "maxLength":44, "type":"string" }, "customsDeclarationNumberABT":{ "maxLength":70, "type":"string" }, "certificateOfOrigin":{ "maxLength":35, "type":"string" }, "certificateOfOriginFormGSP":{ "maxLength":35, "type":"string" }, "importLicence":{ "maxLength":35, "type":"string" }, "goodsDescription":{ "maxLength":35, "type":"string" } } }, "DangerousGoods":{ "required":[ "adrClass", "grossWeight", "numberOfPieces", "packageType", "properShippingName", "tunnelCode", "unNumber" ], "type":"object", "properties":{ "dgmId":{ "type":"integer", "description":"Unique ADR identification. Only relevant if you use the vendor DG Office for ADR ", "format":"int32" }, "adrClass":{ "maxLength":7, "type":"string", "description":"ADR Class is mandatory, but can be left empty for limited quantities (LQ) and excepted quantities (EQ)", "example":"4.2" }, "unNumber":{ "maxLength":4, "type":"string", "example":"1380" }, "properShippingName":{ "maxLength":45, "type":"string" }, "flashpointValue":{ "maxLength":8, "type":"string" }, "packageGroup":{ "maxLength":3, "type":"string", "description":"Official ADR package group codes I, II, III or blanks", "example":"I" }, "tunnelCode":{ "maxLength":6, "type":"string", "example":"B/E" }, "grossWeight":{ "type":"number", "format":"double" }, "quantityMeasurementUnitQualifier":{ "maxLength":3, "type":"string", "description":"kg or Ltr" }, "quantityMeasurementValue":{ "type":"number", "format":"double" }, "numberOfPieces":{ "type":"integer", "format":"int32" }, "packageType":{ "maxLength":3, "type":"string", "description":"Official ADR Packaging code", "example":"1B2" }, "officialNameTechDescription":{ "maxLength":70, "type":"string", "description":"This is the additional technical name, only when required for UN-number with N.O.S. Not Otherwise Specified, so additional chemical substance name is then required." }, "marinePollutant":{ "type":"boolean" }, "marinePollutantName":{ "maxLength":45, "type":"string" }, "exceptedQuantity":{ "type":"boolean" }, "limitedQuantity":{ "type":"boolean" }, "emptyContainer":{ "type":"boolean" }, "environmentHazardous":{ "type":"boolean" }, "waste":{ "type":"boolean" }, "netExplosiveMass": { "type": "number", "format": "double", "description":"The total mass (kg) of active explosive and pyrotechnic substances within explosive articles (Class 1)." } }, "description":"Used with **DHL Eurapid** and **DHL EuroConnect**" }, "TransportInstructionResponse":{ "type":"object", "properties":{ "status":{ "type":"string" }, "transportInstruction":{ "$ref":"#/components/schemas/Shipment" } } }, "TransportInstructionErrorResponse":{ "type":"object", "properties":{ "status":{ "type":"string" }, "validationErrors":{ "type":"array", "items":{ "$ref":"#/components/schemas/IValidationError" } }, "errorMessage":{ "type":"string" } } }, "IValidationError":{ "type":"object", "properties":{ "field":{ "type":"string", "readOnly":true }, "errorCode":{ "type":"integer", "format":"int32", "readOnly":true }, "message":{ "type":"string", "readOnly":true }, "incompatibleFields":{ "type":"array", "readOnly":true, "items":{ "type":"string" } } } } }, "securitySchemes":{ "Client key":{ "type":"apiKey", "description":"Please insert your client key", "name":"client-key", "in":"header" } } }, "x-original-swagger-version":"2.0" }