Use the Booking APIs page to review Air, Land, Ocean FCL, and Ocean LCL booking integrations in one place. Start with the overview, jump to the transport mode you need, then review the sample XML and schema tables.
Select the transport mode you want to integrate with. Each page includes the SOAP request schema, a sample XML request, and the shared booking response structure.
Use this section to build an Air booking request. Start with the sample XML request, then use the schema table to check required fields, data types, cardinality, and field descriptions.
Operation: getBookingRequestAir
Use this sample as the starting point for the booking request. Replace placeholder values with customer, shipment, and authentication data before testing.
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:v1="http://www.schenker.com/Booking/v1_1">
<soapenv:Header />
<soapenv:Body>
<v1:getBookingRequestAir>
<in>
<applicationArea>
<accessKey>Insert access key here</accessKey>
<groupId>Insert user group Id here</groupId>
<requestID>Request_2099-12-31_12:00:000</requestID>
</applicationArea>
<bookingAir submitBooking="true">
<barcodeRequest start_pos="1" separated="false" directThermalMedia="false">A4</barcodeRequest>
<address>
<contactPerson>
<email>Shipper.Contact.Email@test.com</email>
</contactPerson>
<name1>Shipper Name 1</name1>
<name2>Shipper Name 2</name2>
<vatNo>Shipper_VAT</vatNo>
<customsId>Shipper_CustomsId</customsId>
<email>Shipper.General.Email@test.com</email>
<locationType>PHYSICAL</locationType>
<mobilePhone>555-12345</mobilePhone>
<personType>COMPANY</personType>
<phone>123-456-789</phone>
<postalCode>12345</postalCode>
<schenkerAddressId>SchenkerAddressId_123</schenkerAddressId>
<street>Shipper Street</street>
<city>Shipper City</city>
<countryCode>DE</countryCode>
<type>SHIPPER</type>
</address>
<address>
<contactPerson>
<email>Consignee.Contact.Email@test.com</email>
</contactPerson>
<name1>Consignee Name 1</name1>
<name2>Consignee Name 2</name2>
<vatNo>Consignee_VAT</vatNo>
<customsId>Consignee_CustomsId</customsId>
<email>Consignee.General.Email@test.com</email>
<locationType>PHYSICAL</locationType>
<mobilePhone>555-12345</mobilePhone>
<personType>COMPANY</personType>
<phone>123-456-789</phone>
<postalCode>23456</postalCode>
<schenkerAddressId>SchenkerAddressId_123</schenkerAddressId>
<street>Consignee Street</street>
<city>Consignee City</city>
<countryCode>DE</countryCode>
<type>CONSIGNEE</type>
</address>
<address>
<contactPerson>
<email>Pickup.Contact.Email@test.com</email>
</contactPerson>
<name1>Pickup Name 1</name1>
<name2>Pickup Name 2</name2>
<vatNo>Pickup_VAT</vatNo>
<customsId>Pickup_CustomsId</customsId>
<email>Pickup.General.Email@test.com</email>
<locationType>PHYSICAL</locationType>
<mobilePhone>555-12345</mobilePhone>
<personType>COMPANY</personType>
<phone>123-456-789</phone>
<postalCode>34567</postalCode>
<schenkerAddressId>SchenkerAddressId_123</schenkerAddressId>
<street>Pickup Street</street>
<city>Pickup City</city>
<countryCode>DE</countryCode>
<type>PICKUP</type>
</address>
<address>
<contactPerson>
<email>Delivery.Contact.Email@test.com</email>
</contactPerson>
<name1>Delivery Name 1</name1>
<name2>Delivery Name 2</name2>
<vatNo>Delivery_VAT</vatNo>
<customsId>Delivery_CustomsId</customsId>
<email>Delivery.General.Email@test.com</email>
<locationType>PHYSICAL</locationType>
<mobilePhone>555-12345</mobilePhone>
<personType>COMPANY</personType>
<phone>123-456-789</phone>
<postalCode>45678</postalCode>
<schenkerAddressId>SchenkerAddressId_123</schenkerAddressId>
<street>Delivery Street</street>
<city>Delivery City</city>
<countryCode>DE</countryCode>
<type>DELIVERY</type>
</address>
<address>
<contactPerson>
<email>Notify.Contact.Email@test.com</email>
</contactPerson>
<name1>Notify Name 1</name1>
<name2>Notify Name 2</name2>
<vatNo>Notify_VAT</vatNo>
<customsId>Notify_CustomsId</customsId>
<email>Notify.General.Email@test.com</email>
<locationType>PHYSICAL</locationType>
<mobilePhone>555-12345</mobilePhone>
<personType>COMPANY</personType>
<phone>123-456-789</phone>
<postalCode>56789</postalCode>
<schenkerAddressId>SchenkerAddressId_123</schenkerAddressId>
<street>Notify Street</street>
<city>Notify City</city>
<countryCode>DE</countryCode>
<type>NOTIFY</type>
</address>
<address>
<contactPerson>
<email>Invoice.Contact.Email@test.com</email>
</contactPerson>
<name1>Invoice Name 1</name1>
<name2>Invoice Name 2</name2>
<vatNo>Invoice_VAT</vatNo>
<customsId>Invoice_CustomsId</customsId>
<email>Invoice.General.Email@test.com</email>
<locationType>PHYSICAL</locationType>
<mobilePhone>555-12345</mobilePhone>
<personType>COMPANY</personType>
<phone>123-456-789</phone>
<postalCode>67890</postalCode>
<schenkerAddressId>SchenkerAddressId_123</schenkerAddressId>
<street>Invoice Street</street>
<city>Invoice City</city>
<countryCode>DE</countryCode>
<type>INVOICE</type>
</address>
<incoterm>EXW</incoterm>
<incotermLocation>IncotermLocation</incotermLocation>
<productCode>e</productCode>
<measurementType>METRIC</measurementType>
<cargoDescription>GeneralCargoDescription</cargoDescription>
<cargoInsurance>
<value>9999.99</value>
<currency>EUR</currency>
</cargoInsurance>
<customsClearance>false</customsClearance>
<customsClearanceEu>false</customsClearanceEu>
<grossWeight>1000</grossWeight>
<indoorDelivery>false</indoorDelivery>
<pickupDates>
<pickUpDateFrom>2099-01-30T09:00:00.000+00:00</pickUpDateFrom>
<pickUpDateTo>2099-01-30T18:00:00.000+00:00</pickUpDateTo>
</pickupDates>
<reference>
<number>ShipperReference_123</number>
<id>SHIPPER_REFERENCE_NUMBER</id>
</reference>
<reference>
<number>ConsigneeReference_123</number>
<id>CONSIGNEE_REFERENCE_NUMBER</id>
</reference>
<handlingInstructions>HandlingInstructions_ABC</handlingInstructions>
<neutralShipping>false</neutralShipping>
<specialCargo>false</specialCargo>
<valueOfGoods>
<value>9999.99</value>
<currency>EUR</currency>
</valueOfGoods>
<ecoNeutral>true</ecoNeutral>
<serviceType>A2A</serviceType>
<shippingInformation>
<shipmentPosition>
<dgr>false</dgr>
<cargoDesc>Shipping Line 1</cargoDesc>
<volume>4</volume>
<grossWeight>400</grossWeight>
<packageType>EP</packageType>
<pieces>3</pieces>
<stackable>true</stackable>
</shipmentPosition>
<shipmentPosition>
<dgr>false</dgr>
<cargoDesc>Shipping Line 2</cargoDesc>
<volume>12</volume>
<grossWeight>600</grossWeight>
<packageType>CI</packageType>
<pieces>5</pieces>
<stackable>false</stackable>
</shipmentPosition>
<grossWeight>1000</grossWeight>
<volume>16</volume>
</shippingInformation>
<departureAirport>ZZZ</departureAirport>
<destinationAirport>ZZZ</destinationAirport>
<precarriageType>PICKUP_REQUEST</precarriageType>
</bookingAir>
</in>
</v1:getBookingRequestAir>
</soapenv:Body>
</soapenv:Envelope>SOAP request schema for Air.
| Field Name | Data Type | Mandatory | Cardinality | Description |
|---|---|---|---|---|
<applicationArea> |
applicationAreaType | yes | 1..1 | |
<accessKey>?</accessKey> |
string(100) | yes | 1..1 | Defines the access key (user token). |
<groupId>?</groupId> |
unsignedLong | no | 0..1 | Defines the optional user group id. |
<requestID>?</requestID> |
string(500) | no | 0..1 | Defines the request id which will be returned with the response message. |
<userId>?</userId> |
string | no | 0..1 | Defines the user id for which the booking should be done. |
<groupName>?</groupName> |
string | no | 0..1 | Defines the user group name for which the booking should be done. |
<uniqueIdBlocker>?</uniqueIdBlocker> |
string | no | 0..1 | Defines the unique id blocker. |
<bookingAir |
bookingType | yes | 1..1 | |
submitBooking="?" |
boolean | yes | 1..1 | Defines if the booking shall be submitted. If false, the booking can be edited in the frontend and must be submitted manually. |
updateBooking="?" |
string | yes | 1..1 | Defines the booking to be updated. Takes a booking id as parameter. |
readyForConsolidation="?" |
boolean | no | 0..1 | Prepares the booking for later consolidation. |
returnBarcodeReferences="?"> |
boolean | no | 0..1 | Defines if the barcode references are returned in the response message. |
<barcodeRequest> |
barcodeRequestType | no | 0..1 | Option to request the barcode label for the booking. |
start_pos="?" |
positiveInt | yes, if barcodeRequest is provided | 1..1 | Defines the starting position quadrant |
separated="?" |
boolean | yes, if barcodeRequest is provided | 1..1 | Defines if the label is printed on separate pages. |
directThermalMedia="?" |
boolean | no | 0..1 | Defines if direct thermal printing is requested. |
?</barcodeRequest> |
enumeration | yes, if barcodeRequest is provided | 1..1 | Defines the label format. |
<barcodeRequestEmail> |
barcodeRequestEmailType | no | 0..1 | Option to send the barcode labels to defined email addresses. |
<email>?</email> |
string(250) | yes, if barcodeRequestEmail is provided | 1..25 | Defines the list of email addresses. |
<address> |
addressType | yes | 2..6 | Defines the list of addresses. |
<contactPerson> |
contactPersonType | no | 0..n | Defines the contact person details. |
<name>?</name> |
string(100) | no | 0..1 | Defines the name of the contact person. |
<phone>?</phone> |
string(100) | no | 0..1 | Defines the phone number of the contact person. |
<email>?</email> |
string(100) | no | 0..1 | Defines the email address of the contact person. |
<name1>?</name1> |
string(500) | yes | 1..1 | Defines the name. |
<name2>?</name2> |
string(500) | no | 0..1 | Defines the additional name. |
<customerAddressIdentifier>?</customerAddressIdentifier> |
string(100) | no | 0..1 | Defines the customer address identifier. |
<vatNo>?</vatNo> |
string(100) | no | 0..1 | Defines the customer VAT number. |
<customsId>?</customsId> |
string(100) | no | 0..1 | Defines the customs id. |
<email>?</email> |
string(250) | no | 0..1 | Defines the email address. |
<fax>?</fax> |
string(250) | no | 0..1 | Defines the fax number. |
<industry>?</industry> |
enumeration | no | 0..1 | Defines the industry. |
<locationType>?</locationType> |
enumeration | yes | 1..1 | Defines the location type. |
<mobilePhone>?</mobilePhone> |
string(250) | no | 0..1 | Defines the mobile phone number. |
<personType>?</personType> |
enumeration | yes | 1..1 | Defines the person type. |
<phone>?</phone> |
string(250) | no | 0..1 | Defines the phone number. |
<poBox>?</poBox> |
string(50) | no | 0..1 | Defines the PO box. |
<postalCode>?</postalCode> |
string(20) | no* | 0..1 | Defines the postal code. *= The postal code is mandatory for most countries. |
<stateCode>?</stateCode> |
string(5) | no | 0..1 | Defines the state code. |
<stateName>?</stateName> |
string(35) | no | 0..1 | Defines the state name. |
<preferredLanguage>?</preferredLanguage> |
string(10) | no | 0..1 | Defines the preferred language. |
<schenkerAddressId>?</schenkerAddressId> |
string(36) | no | 0..1 | Defines the Schenker address id. |
<street>?</street> |
string(1000) | yes | 1..1 | Defines the street name. |
<street2>?</street2> |
string(1000) | no | 0..1 | Defines the additional street name. |
<city>?</city> |
string(500) | yes | 1..1 | Defines the city name. |
<countryCode>?</countryCode> |
string(10) | yes | 1..1 | Defines the country code. |
<type>?</type> |
enumeration | yes | 1..1 | Defines the address type. SHIPPER and CONSIGNEE addresses are mandatory. |
<incoterm>?</incoterm> |
enumeration | yes | 1..1 | Defines the incoterm. |
<incotermLocation>?</incotermLocation> |
string(250) | yes | 1..1 | Defines the incoterm location. |
<productCode>?</productCode> |
string(10) | yes | 1..1 | Defines the product. |
<productOption>?</productOption> |
string(10) | no | 0..1 | Defines the time critical product option. |
<measurementType>?</measurementType> |
enumeration | yes | 1..1 | Defines the measurement type. |
<cargoDescription>?</cargoDescription> |
string(1000) | no | 0..1 | Defines the cargo description. |
<cargoInsurance> |
cargoInsuranceType | no | 0..1 | Defines the cargo insurance. |
<value>?</value> |
string(10,2) | yes, if cargoInsurance is provided | 1..1 | Defines the cargo insurance value. |
<currency>?</currency> |
string(3) | yes, if cargoInsurance is provided | 1..1 | Defines the cargo insurance currency. |
<cashOnDelivery> |
cashOnDeliveryType | no | 0..1 | Defines the cash on delivery. |
<value>?</value> |
string(10,2) | yes, if cashOnDelivery is provided | 1..1 | Defines the cash on delivery value. |
<currency>?</currency> |
string(3) | yes, if cashOnDelivery is provided | 1..1 | Defines the cash on delivery currency. |
<customsClearance>?</customsClearance> |
boolean | yes | 1..1 | Defines if customs clearance is required. |
<customsClearanceEu>?</customsClearanceEu> |
boolean | yes* | 0..1 | Defines if customs clearance EU is required. *= This field must be provided in case of customs clearance in European land transport. |
<exportCustomsDeclarant> |
exportCustomsDeclarantType | no | 0..1 | Defines the export customs declarant. |
<type>?</type> |
enumeration | yes, if exportCustomsDeclarant is provided | 1..1 | Defines the export customs declarant type. |
<declarantInformation> |
declarantInformationType | no | Defines the export customs declarant information. | |
<companyName>?</companyName> |
string(35) | no | 0..1 | Defines the company name. |
<street>?</street> |
string(35) | no | 0..1 | Defines the street name. |
<postalCode>?</postalCode> |
string(10) | no | 0..1 | Defines the postal code. |
<city>?</city> |
string(35) | no | 0..1 | Defines the city name. |
<countryCode>?</countryCode> |
string(10) | no | 0..1 | Defines the country code. |
<phone>?</phone> |
string(250) | no | 0..1 | Defines the phone number. |
<email>?</email> |
string(25) | no | 0..1 | Defines the email address. |
<importCustomsDeclarant> |
importCustomsDeclarantType | no | Defines the import customs declarant. | |
<type>?</type> |
enumeration | yes, if importCustomsDeclarant is provided | 1..1 | Defines the import customs declarant type. |
<declarantInformation> |
declarantInformationType | no | Defines the import customs declarant information. | |
<companyName>?</companyName> |
string(35) | no | 0..1 | Defines the company name. |
<street>?</street> |
string(35) | no | 0..1 | Defines the street name. |
<postalCode>?</postalCode> |
string(10) | no | 0..1 | Defines the postal code. |
<city>?</city> |
string(35) | no | 0..1 | Defines the city name. |
<countryCode>?</countryCode> |
string(10) | no | 0..1 | Defines the country code. |
<phone>?</phone> |
string(250) | no | 0..1 | Defines the phone number. |
<email>?</email> |
string(25) | no | 0..1 | Defines the email address. |
<file> |
fileType | no | 0..n | Defines the list of files. |
<fileSizeBytes>?</fileSizeBytes> |
int | yes | 1..1 | Defines the file size in bytes. |
<name>?</name> |
string(250) | no | 0..1 | Defines the file name. |
<type>?</type> |
string(5) | no | 0..1 | Defines the file type. |
<typeOfDocument>?</typeOfDocument> |
enumeration | no | 0..1 | Defines the type of documentation. |
<data>?</data> |
string | no | 0..1 | Defines the Base64 data. |
<grossWeight>?</grossWeight> |
string(5,2) | yes | 1..1 | Defines the total gross weight. |
<indoorDelivery>?</indoorDelivery> |
boolean | yes | 1..1 | Defines if indoor delivery is required. |
<pickupDates> |
pickupDatesType | yes | 1..1 | Defines the pickup dates. |
<pickUpDateFrom>?</pickUpDateFrom> |
dateTime | yes | 1..1 | Defines the start pickup time. |
<pickUpDateTo>?</pickUpDateTo> |
dateTime | yes | 1..1 | Defines the end pickup time. |
<reference> |
referenceType | no | 0..n | Defines the references. |
<number>?</number> |
string(100) | yes, if reference is provided | 1..1 | Defines the reference number. |
<id>?</id> |
string(100) | yes, if reference is provided | 1..1 | Defines the reference type. |
<handlingInstructions>?</handlingInstructions> |
string(2000) | no | 0..1 | Defines the handling instructions. |
<neutralShipping>?</neutralShipping> |
boolean | yes | 1..1 | Defines the business scenario in which the customer sends a booking request in the name of the ordering party. |
<specialCargo>?</specialCargo> |
boolean | yes | 1..1 | Defines if special cargo is required. |
<specialCargoDescription>?</specialCargoDescription> |
string(1000) | no | 0..1 | Defines the special cargo description. |
<valueOfGoods> |
valueOfGoodsType | no | 0..1 | Defines the value of goods. |
<value>?</value> |
string(10,2) | yes, if valueOfGoods is provided | 1..1 | Defines the cargo insurance value. |
<currency>?</currency> |
string(3) | yes, if valueOfGoods is provided | 1..1 | Defines the cargo insurance currency. |
<wayBillNumber>?</wayBillNumber> |
string(100) | no | 0..1 | Defines the waybill number. |
<barcodeReference> |
barcodeReferenceType | no | 0..n | Defines the barcode references. |
<barcode>?</barcode> |
string(100) | yes, if barcodeReference is provided | 1..1 | Defines the barcode value. |
<barcodeType>?</barcodeType> |
string(30) | yes, if barcodeReference is provided | 1..1 | Defines the barcode type. Only allowed value = SSCC. |
<ecoNeutral>?</ecoNeutral> |
boolean | no | 0..1 | Defines if the shipment is eco neutral. |
<serviceType>?</serviceType> |
enumeration | yes | 1..1 | Defines the service type. |
<shippingInformation> |
shippingInformationType | yes | 1..1 | Defines the shipping information. |
<shipmentPosition> |
shipmentPositionType | yes | 1..n | Defines the shipping position. |
<dangerousGoods> |
dangerousGoodsType | no | 0..n | Defines the dangerous goods. |
<pieces>?</pieces> |
positiveInt | yes, if dangerousGoods is provided | 1..1 | Defines the amount of pieces. |
<packageType>?</packageType> |
string(50) | yes, if dangerousGoods is provided | 1..1 | Defines the package type. |
<weightType>?</weightType> |
enumeration | yes, if dangerousGoods is provided | 1..1 | Defines the weight type. |
<weight>?</weight> |
string | yes, if dangerousGoods is provided | 1..1 | Defines the weight. |
<weightBasis>?</weightBasis> |
string | no | 0..1 | Defines the weight basis. |
<subitems> |
dangerousGoodsUnNoType | yes, if dangerousGoods is provided | 1..n | Defines the dangerous goods UN information. |
<unNo>?</unNo> |
string(4) | yes, if subitems is provided | 1..1 | Defines the dangerous goods UN number. |
<labelType>?</labelType> |
string(10) | yes, if subitems is provided | 1..1 | Defines the label type. |
<packageGroup>?</packageGroup> |
enumeration | yes, if subitems is provided | 1..1 | Defines the package group. |
<shippingName>?</shippingName> |
string(250) | yes, if subitems is provided | 1..1 | Defines the shipping name. |
<technicalName>?</technicalName> |
string(250) | no | 0..1 | Defines the technical name. |
<specialProvision>?</specialProvision> |
string(250) | no | 0..1 | Defines the special provision. |
<tunnelCode>?</tunnelCode> |
string(10) | no | 0..1 | Defines the tunnel code. |
<waste>?</waste> |
boolean | yes, if subitems is provided | 1..1 | Defines if dangerous goods is waste. |
<europeanWasteCode>?</europeanWasteCode> |
string | no | 0..1 | Defines the European waste code (if waste is set to true). |
<NEM>?</NEM> |
string | no | 0..1 | Defines the net explosive mass weight. |
<transportCategory>?</transportCategory> |
int | no | 0..1 | Defines the transport category. |
<exceptedQuantities>?</exceptedQuantities> |
boolean | yes, if subitems is provided | 1..1 | Defines if dangerous goods is excepted quantity. |
<limitedQuantity>?</limitedQuantity> |
boolean | yes, if subitems is provided | 1..1 | Defines if dangerous goods is limited quantity. |
<emptyUncleanedPackages>?</emptyUncleanedPackages> |
boolean | no | 0..1 | Defines if dangerous goods is of empty uncleaned packages. |
<marinePollutant>?</marinePollutant> |
boolean | yes, if subitems is provided | 1..1 | Defines if dangerous goods is marine pollutant. |
<subRisk1>?</subRisk1> |
boolean | no | 0..1 | Defines the sub risk 1. |
<subRisk2>?</subRisk2> |
boolean | no | 0..1 | Defines the sub risk 2. |
<subRisk3>?</subRisk3> |
boolean | no | 0..1 | Defines the sub risk 3. |
<fireworkClassification> |
fireworkClassificationType | no | 0..1 | Defines the firework classification. |
<countryCode>?</countryCode> |
string(10) | yes, if fireworkClassification is provided | 1..1 | Defines the country code. |
<reference>?</reference> |
string(100) | yes, if fireworkClassification is provided | 1..1 | Defines the firework classification reference. |
<dgr>?</dgr> |
boolean | yes | 1..1 | Defines if dangerous goods is required. |
<cargoDesc>?</cargoDesc> |
string(500) | yes | 1..1 | Defines the cargo description. |
<length>?</length> |
string(10,2) | no | 0..1 | Defines the length. |
<width>?</width> |
string(10,2) | no | 0..1 | Defines the width. |
<height>?</height> |
string(10,2) | no | 0..1 | Defines the height. |
<volume>?</volume> |
string(10,2) | yes | 1..1 | Defines the volume. |
<grossWeight>?</grossWeight> |
string(10,2) | yes | 1..1 | Defines the gross weight. |
<marksAndNumbers>?</marksAndNumbers> |
string(500) | no | 0..1 | Defines the marks and numbers. |
<hsCode>?</hsCode> |
string(13) | no | 0..1 | Defines the hs code. |
<packageLine> |
packageLineType | no | 0..n | Defines the pakage line. |
<cargoDesc>?</cargoDesc> |
string(500) | no | 0..1 | Defines the cargo description. |
<length>?</length> |
string(10,2) | no | 0..1 | Defines the length. |
<width>?</width> |
string(10,2) | no | 0..1 | Defines the width. |
<height>?</height> |
string(10,2) | no | 0..1 | Defines the height. |
<volume>?</volume> |
string(10,2) | no | 0..1 | Defines the volume. |
<grossWeight>?</grossWeight> |
string(10,2) | no | 0..1 | Defines the gross weight. |
<packageType>?</packageType> |
string(50) | yes | 1..1 | Defines the package type. |
<pieces>?</pieces> |
positiveInt | yes | 1..1 | Defines the amount of pieces. |
<stackable>?</stackable> |
boolean | yes | 1..1 | Defines if the shipping position is stackable. |
<grossWeight>?</grossWeight> |
string(10,2) | yes | 0..1 | Defines the gross weight. |
<volume>?</volume> |
string(10,2) | yes | 1..1 | Defines the volume. |
<departureAirport>?</departureAirport> |
String(3) | yes* | 0..1 | Defines the departure airport code. *= This field must be provided if the service type is A2D or A2A. |
<destinationAirport>?</destinationAirport> |
String(3) | yes* | 0..1 | Defines the departure airport code. *= This field must be provided if the service type is D2A or A2A. |
<precarriageType>?</precarriageType> |
enumeration | yes | 1..1 | Defines the precarriage type. |
SOAP response schema for Air.
| Field Name | Data Type | Mandatory | Cardinality | Description |
|---|---|---|---|---|
<applicationArea> |
applicationAreaType | yes | 1..1 | |
<requestID>?</requestID> |
string(500) | no | 0..1 | Defines the request id which if it was provided in the request message. |
<bookingId>?</bookingId> |
string(13) | yes | 1..1 | Defines the generated eSchenker booking id. |
<barcodeReference> |
barcodeReferenceType | no | Defines the list of barcode references. | |
<barcode>?</barcode> |
no | Defines the barcode. | ||
<barcodeType>?</barcodeType> |
no | Defines the barcode type. | ||
<barcodeDocument>?</barcodeDocument> |
no | Defines the barcode document in base 64 binary format. |
Use this section to build a Land booking request. Start with the sample XML request, then use the schema table to check required fields, data types, cardinality, and field descriptions.
Operation: getBookingRequestLand
Use this sample as the starting point for the booking request. Replace placeholder values with customer, shipment, and authentication data before testing.
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:v1="http://www.schenker.com/Booking/v1_1">
<soapenv:Header/>
<soapenv:Body>
<v1:getBookingRequestLand>
<in>
<applicationArea>
<accessKey>Insert access key here</accessKey>
<groupId>Insert user group Id here</groupId>
<requestID>Request_2099-12-31_12:00:000</requestID>
</applicationArea>
<bookingLand submitBooking="true">
<barcodeRequest start_pos="1" separated="false" directThermalMedia="false">A4</barcodeRequest>
<address>
<contactPerson>
<email>Shipper.Contact.Email@test.com</email>
</contactPerson>
<name1>Shipper Name 1</name1>
<name2>Shipper Name 2</name2>
<vatNo>Shipper_VAT</vatNo>
<customsId>Shipper_CustomsId</customsId>
<email>Shipper.General.Email@test.com</email>
<locationType>PHYSICAL</locationType>
<mobilePhone>555-12345</mobilePhone>
<personType>COMPANY</personType>
<phone>123-456-789</phone>
<postalCode>12345</postalCode>
<schenkerAddressId>SchenkerAddressId_123</schenkerAddressId>
<street>Shipper Street</street>
<city>Shipper City</city>
<countryCode>DE</countryCode>
<type>SHIPPER</type>
</address>
<address>
<contactPerson>
<email>Consignee.Contact.Email@test.com</email>
</contactPerson>
<name1>Consignee Name 1</name1>
<name2>Consignee Name 2</name2>
<vatNo>Consignee_VAT</vatNo>
<customsId>Consignee_CustomsId</customsId>
<email>Consignee.General.Email@test.com</email>
<locationType>PHYSICAL</locationType>
<mobilePhone>555-12345</mobilePhone>
<personType>COMPANY</personType>
<phone>123-456-789</phone>
<postalCode>23456</postalCode>
<schenkerAddressId>SchenkerAddressId_123</schenkerAddressId>
<street>Consignee Street</street>
<city>Consignee City</city>
<countryCode>DE</countryCode>
<type>CONSIGNEE</type>
</address>
<address>
<contactPerson>
<email>Pickup.Contact.Email@test.com</email>
</contactPerson>
<name1>Pickup Name 1</name1>
<name2>Pickup Name 2</name2>
<vatNo>Pickup_VAT</vatNo>
<customsId>Pickup_CustomsId</customsId>
<email>Pickup.General.Email@test.com</email>
<locationType>PHYSICAL</locationType>
<mobilePhone>555-12345</mobilePhone>
<personType>COMPANY</personType>
<phone>123-456-789</phone>
<postalCode>34567</postalCode>
<schenkerAddressId>SchenkerAddressId_123</schenkerAddressId>
<street>Pickup Street</street>
<city>Pickup City</city>
<countryCode>DE</countryCode>
<type>PICKUP</type>
</address>
<address>
<contactPerson>
<email>Delivery.Contact.Email@test.com</email>
</contactPerson>
<name1>Delivery Name 1</name1>
<name2>Delivery Name 2</name2>
<vatNo>Delivery_VAT</vatNo>
<customsId>Delivery_CustomsId</customsId>
<email>Delivery.General.Email@test.com</email>
<locationType>PHYSICAL</locationType>
<mobilePhone>555-12345</mobilePhone>
<personType>COMPANY</personType>
<phone>123-456-789</phone>
<postalCode>45678</postalCode>
<schenkerAddressId>SchenkerAddressId_123</schenkerAddressId>
<street>Delivery Street</street>
<city>Delivery City</city>
<countryCode>DE</countryCode>
<type>DELIVERY</type>
</address>
<address>
<contactPerson>
<email>Notify.Contact.Email@test.com</email>
</contactPerson>
<name1>Notify Name 1</name1>
<name2>Notify Name 2</name2>
<vatNo>Notify_VAT</vatNo>
<customsId>Notify_CustomsId</customsId>
<email>Notify.General.Email@test.com</email>
<locationType>PHYSICAL</locationType>
<mobilePhone>555-12345</mobilePhone>
<personType>COMPANY</personType>
<phone>123-456-789</phone>
<postalCode>56789</postalCode>
<schenkerAddressId>SchenkerAddressId_123</schenkerAddressId>
<street>Notify Street</street>
<city>Notify City</city>
<countryCode>DE</countryCode>
<type>NOTIFY</type>
</address>
<address>
<contactPerson>
<email>Invoice.Contact.Email@test.com</email>
</contactPerson>
<name1>Invoice Name 1</name1>
<name2>Invoice Name 2</name2>
<vatNo>Invoice_VAT</vatNo>
<customsId>Invoice_CustomsId</customsId>
<email>Invoice.General.Email@test.com</email>
<locationType>PHYSICAL</locationType>
<mobilePhone>555-12345</mobilePhone>
<personType>COMPANY</personType>
<phone>123-456-789</phone>
<postalCode>67890</postalCode>
<schenkerAddressId>SchenkerAddressId_123</schenkerAddressId>
<street>Invoice Street</street>
<city>Invoice City</city>
<countryCode>DE</countryCode>
<type>INVOICE</type>
</address>
<incoterm>EXW</incoterm>
<incotermLocation>IncotermLocation</incotermLocation>
<productCode>43</productCode>
<measurementType>METRIC</measurementType>
<cargoDescription>GeneralCargoDescription</cargoDescription>
<cargoInsurance>
<value>9999.99</value>
<currency>EUR</currency>
</cargoInsurance>
<cashOnDelivery>
<value>9999.99</value>
<currency>EUR</currency>
</cashOnDelivery>
<customsClearance>false</customsClearance>
<customsClearanceEu>false</customsClearanceEu>
<grossWeight>1000</grossWeight>
<indoorDelivery>false</indoorDelivery>
<pickupDates>
<pickUpDateFrom>2099-01-30T09:00:00.000+00:00</pickUpDateFrom>
<pickUpDateTo>2099-01-30T18:00:00.000+00:00</pickUpDateTo>
</pickupDates>
<reference>
<number>ShipperReference_123</number>
<id>SHIPPER_REFERENCE_NUMBER</id>
</reference>
<reference>
<number>ConsigneeReference_123</number>
<id>CONSIGNEE_REFERENCE_NUMBER</id>
</reference>
<handlingInstructions>HandlingInstructions_ABC</handlingInstructions>
<neutralShipping>false</neutralShipping>
<specialCargo>false</specialCargo>
<valueOfGoods>
<value>9999.99</value>
<currency>EUR</currency>
</valueOfGoods>
<ecoNeutral>true</ecoNeutral>
<serviceType>D2D</serviceType>
<shippingInformation>
<shipmentPosition>
<dgr>false</dgr>
<cargoDesc>Shipping Line 1</cargoDesc>
<volume>4</volume>
<grossWeight>400</grossWeight>
<packageType>EP</packageType>
<pieces>3</pieces>
<stackable>true</stackable>
</shipmentPosition>
<shipmentPosition>
<dangerousGoods>
<pieces>2</pieces>
<packageType>00</packageType>
<weightType>KGS</weightType>
<weight>50</weight>
<weightBasis>NET</weightBasis>
<subitems>
<unNo>2345</unNo>
<labelType>LN_3</labelType>
<packageGroup>II</packageGroup>
<shippingName>3-BROMOPROPYNE</shippingName>
<technicalName>Not required</technicalName>
<waste>false</waste>
<exceptedQuantities>false</exceptedQuantities>
<limitedQuantity>false</limitedQuantity>
<marinePollutant>false</marinePollutant>
</subitems>
</dangerousGoods>
<dgr>true</dgr>
<cargoDesc>Shipping Line 2</cargoDesc>
<volume>12</volume>
<grossWeight>600</grossWeight>
<packageType>CI</packageType>
<pieces>5</pieces>
<stackable>false</stackable>
</shipmentPosition>
<grossWeight>1000</grossWeight>
<volume>16</volume>
</shippingInformation>
<express>false</express>
<foodRelated>false</foodRelated>
<heatedTransport>false</heatedTransport>
<homeDelivery>false</homeDelivery>
<measureUnit>VOLUME</measureUnit>
<measureUnitVolume>16</measureUnitVolume>
<ownPickup>false</ownPickup>
<pharmaceuticals>false</pharmaceuticals>
<automatedFixDayDeliveryToBeAgreed>true</automatedFixDayDeliveryToBeAgreed>
<deliveryPreNoticeEmail>
<contact>John Doe</contact>
<email>Email@test.com</email>
</deliveryPreNoticeEmail>
</bookingLand>
</in>
</v1:getBookingRequestLand>
</soapenv:Body>
</soapenv:Envelope>SOAP request schema for Land.
| Field Name | Data Type | Mandatory | Cardinality | Description |
|---|---|---|---|---|
<applicationArea> |
applicationAreaType | yes | 1..1 | |
<accessKey>?</accessKey> |
string(100) | yes | 1..1 | Defines the access key (user token). |
<groupId>?</groupId> |
unsignedLong | no | 0..1 | Defines the optional user group id. |
<requestID>?</requestID> |
string(500) | no | 0..1 | Defines the request id which will be returned with the response message. |
<userId>?</userId> |
string | no | 0..1 | Defines the user id for which the booking should be done. |
<groupName>?</groupName> |
string | no | 0..1 | Defines the user group name for which the booking should be done. |
<uniqueIdBlocker>?</uniqueIdBlocker> |
string | no | 0..1 | Defines the unique id blocker. |
<bookingLand |
bookingType | yes | 1..1 | |
submitBooking="?" |
boolean | yes | 1..1 | Defines if the booking shall be submitted. If false, the booking can be edited in the frontend and must be submitted manually. |
updateBooking="?" |
string | yes | 1..1 | Defines the booking to be updated. Takes a booking id as parameter. |
readyForConsolidation="?" |
boolean | no | 0..1 | Prepares the booking for later consolidation. |
returnBarcodeReferences="?"> |
boolean | no | 0..1 | Defines if the barcode references are returned in the response message. |
<barcodeRequest> |
barcodeRequestType | no | 0..1 | Option to request the barcode label for the booking. |
start_pos="?" |
positiveInt | yes, if barcodeRequest is provided | 1..1 | Defines the starting position quadrant |
separated="?" |
boolean | yes, if barcodeRequest is provided | 1..1 | Defines if the label is printed on separate pages. |
directThermalMedia="?" |
boolean | no | 0..1 | Defines if direct thermal printing is requested. |
?</barcodeRequest> |
enumeration | yes, if barcodeRequest is provided | 1..1 | Defines the label format. |
<barcodeRequestEmail> |
barcodeRequestEmailType | no | 0..1 | Option to send the barcode labels to defined email addresses. |
<email>?</email> |
string(250) | yes, if barcodeRequestEmail is provided | 1..25 | Defines the list of email addresses. |
<address> |
addressType | yes | 2..6 | Defines the list of addresses. |
<contactPerson> |
contactPersonType | no | 0..n | Defines the contact person details. |
<name>?</name> |
string(100) | no | 0..1 | Defines the name of the contact person. |
<phone>?</phone> |
string(100) | no | 0..1 | Defines the phone number of the contact person. |
<email>?</email> |
string(100) | no | 0..1 | Defines the email address of the contact person. |
<name1>?</name1> |
string(500) | yes | 1..1 | Defines the name. |
<name2>?</name2> |
string(500) | no | 0..1 | Defines the additional name. |
<customerAddressIdentifier>?</customerAddressIdentifier> |
string(100) | no | 0..1 | Defines the customer address identifier. |
<vatNo>?</vatNo> |
string(100) | no | 0..1 | Defines the customer VAT number. |
<customsId>?</customsId> |
string(100) | no | 0..1 | Defines the customs id. |
<email>?</email> |
string(250) | no | 0..1 | Defines the email address. |
<fax>?</fax> |
string(250) | no | 0..1 | Defines the fax number. |
<industry>?</industry> |
enumeration | no | 0..1 | Defines the industry. |
<locationType>?</locationType> |
enumeration | yes | 1..1 | Defines the location type. |
<mobilePhone>?</mobilePhone> |
string(250) | no | 0..1 | Defines the mobile phone number. |
<personType>?</personType> |
enumeration | yes | 1..1 | Defines the person type. |
<phone>?</phone> |
string(250) | no | 0..1 | Defines the phone number. |
<poBox>?</poBox> |
string(50) | no | 0..1 | Defines the PO box. |
<postalCode>?</postalCode> |
string(20) | no* | 0..1 | Defines the postal code. *= The postal code is mandatory for most countries. |
<stateCode>?</stateCode> |
string(5) | no | 0..1 | Defines the state code. |
<stateName>?</stateName> |
string(35) | no | 0..1 | Defines the state name. |
<preferredLanguage>?</preferredLanguage> |
string(10) | no | 0..1 | Defines the preferred language. |
<schenkerAddressId>?</schenkerAddressId> |
string(36) | no | 0..1 | Defines the Schenker address id. |
<street>?</street> |
string(1000) | yes | 1..1 | Defines the street name. |
<street2>?</street2> |
string(1000) | no | 0..1 | Defines the additional street name. |
<city>?</city> |
string(500) | yes | 1..1 | Defines the city name. |
<countryCode>?</countryCode> |
string(10) | yes | 1..1 | Defines the country code. |
<type>?</type> |
enumeration | yes | 1..1 | Defines the address type. SHIPPER and CONSIGNEE addresses are mandatory. |
<incoterm>?</incoterm> |
enumeration | yes | 1..1 | Defines the incoterm. |
<incotermLocation>?</incotermLocation> |
string(250) | yes | 1..1 | Defines the incoterm location. |
<productCode>?</productCode> |
string(10) | yes | 1..1 | Defines the product. |
<productOption>?</productOption> |
string(10) | no | 0..1 | Defines the time critical product option. |
<measurementType>?</measurementType> |
enumeration | yes | 1..1 | Defines the measurement type. |
<cargoDescription>?</cargoDescription> |
string(1000) | no | 0..1 | Defines the cargo description. |
<cargoInsurance> |
cargoInsuranceType | no | 0..1 | Defines the cargo insurance. |
<value>?</value> |
string(10,2) | yes, if cargoInsurance is provided | 1..1 | Defines the cargo insurance value. |
<currency>?</currency> |
string(3) | yes, if cargoInsurance is provided | 1..1 | Defines the cargo insurance currency. |
<cashOnDelivery> |
cashOnDeliveryType | no | 0..1 | Defines the cash on delivery. |
<value>?</value> |
string(10,2) | yes, if cashOnDelivery is provided | 1..1 | Defines the cash on delivery value. |
<currency>?</currency> |
string(3) | yes, if cashOnDelivery is provided | 1..1 | Defines the cash on delivery currency. |
<customsClearance>?</customsClearance> |
boolean | yes | 1..1 | Defines if customs clearance is required. |
<customsClearanceEu>?</customsClearanceEu> |
boolean | yes* | 0..1 | Defines if customs clearance EU is required. *= This field must be provided in case of customs clearance in European land transport. |
<exportCustomsDeclarant> |
exportCustomsDeclarantType | yes, if customsClearanceEu is set to true | 0..1 | Defines the export customs declarant. |
<type>?</type> |
enumeration | yes, if exportCustomsDeclarant is provided | 1..1 | Defines the export customs declarant type. |
<declarantInformation> |
declarantInformationType | no | Defines the export customs declarant information. | |
<companyName>?</companyName> |
string(35) | no | 0..1 | Defines the company name. |
<street>?</street> |
string(35) | no | 0..1 | Defines the street name. |
<postalCode>?</postalCode> |
string(10) | no | 0..1 | Defines the postal code. |
<city>?</city> |
string(35) | no | 0..1 | Defines the city name. |
<countryCode>?</countryCode> |
string(10) | no | 0..1 | Defines the country code. |
<phone>?</phone> |
string(250) | no | 0..1 | Defines the phone number. |
<email>?</email> |
string(25) | no | 0..1 | Defines the email address. |
<importCustomsDeclarant> |
importCustomsDeclarantType | yes, if customsClearanceEu is set to true | Defines the import customs declarant. | |
<type>?</type> |
enumeration | yes, if importCustomsDeclarant is provided | 1..1 | Defines the import customs declarant type. |
<declarantInformation> |
declarantInformationType | no | Defines the import customs declarant information. | |
<companyName>?</companyName> |
string(35) | no | 0..1 | Defines the company name. |
<street>?</street> |
string(35) | no | 0..1 | Defines the street name. |
<postalCode>?</postalCode> |
string(10) | no | 0..1 | Defines the postal code. |
<city>?</city> |
string(35) | no | 0..1 | Defines the city name. |
<countryCode>?</countryCode> |
string(10) | no | 0..1 | Defines the country code. |
<phone>?</phone> |
string(250) | no | 0..1 | Defines the phone number. |
<email>?</email> |
string(25) | no | 0..1 | Defines the email address. |
<file> |
fileType | no | 0..n | Defines the list of files. |
<fileSizeBytes>?</fileSizeBytes> |
int | yes | 1..1 | Defines the file size in bytes. |
<name>?</name> |
string(250) | no | 0..1 | Defines the file name. |
<type>?</type> |
string(5) | no | 0..1 | Defines the file type. |
<typeOfDocument>?</typeOfDocument> |
enumeration | no | 0..1 | Defines the type of documentation. |
<data>?</data> |
string | no | 0..1 | Defines the Base64 data. |
<grossWeight>?</grossWeight> |
string(5,2) | yes | 1..1 | Defines the total gross weight. |
<indoorDelivery>?</indoorDelivery> |
boolean | yes | 1..1 | Defines if indoor delivery is required. |
<pickupDates> |
pickupDatesType | yes | 1..1 | Defines the pickup dates. |
<pickUpDateFrom>?</pickUpDateFrom> |
dateTime | yes | 1..1 | Defines the start pickup time. |
<pickUpDateTo>?</pickUpDateTo> |
dateTime | yes | 1..1 | Defines the end pickup time. |
<reference> |
referenceType | no | 0..n | Defines the references. |
<number>?</number> |
string(100) | yes, if reference is provided | 1..1 | Defines the reference number. |
<id>?</id> |
string(100) | yes, if reference is provided | 1..1 | Defines the reference type. |
<handlingInstructions>?</handlingInstructions> |
string(2000) | no | 0..1 | Defines the handling instructions. |
<pickupHandlingInstructions>?</pickupHandlingInstructions> |
string(2000) | no | 0..1 | Defines the pickup handling instructions. |
<deliveryHandlingInstructions>?</deliveryHandlingInstructions> |
string(2000) | no | 0..1 | Defines the delivery handling instructions. |
<neutralShipping>?</neutralShipping> |
boolean | yes | 1..1 | Defines the business scenario in which the customer sends a booking request in the name of the ordering party. |
<specialCargo>?</specialCargo> |
boolean | yes | 1..1 | Defines if special cargo is required. |
<specialCargoDescription>?</specialCargoDescription> |
string(1000) | no | 0..1 | Defines the special cargo description. |
<valueOfGoods> |
valueOfGoodsType | no | 0..1 | Defines the value of goods. |
<value>?</value> |
string(10,2) | yes, if valueOfGoods is provided | 1..1 | Defines the cargo insurance value. |
<currency>?</currency> |
string(3) | yes, if valueOfGoods is provided | 1..1 | Defines the cargo insurance currency. |
<wayBillNumber>?</wayBillNumber> |
string(100) | no | 0..1 | Defines the waybill number. |
<barcodeReference> |
barcodeReferenceType | no | 0..n | Defines the barcode references. |
<barcode>?</barcode> |
string(100) | yes, if barcodeReference is provided | 1..1 | Defines the barcode value. |
<barcodeType>?</barcodeType> |
string(30) | yes, if barcodeReference is provided | 1..1 | Defines the barcode type. Only allowed value = SSCC. |
<ecoNeutral>?</ecoNeutral> |
boolean | no | 0..1 | Defines if the shipment is eco neutral. |
<serviceType>?</serviceType> |
enumeration | yes | 1..1 | Defines the service type. Only allowed value = D2D. |
<incotermDestinationType>?</incotermDestinationType> |
enumeration | no | 0..1 | Defines the incoterm destination type. |
<shippingInformation> |
shippingInformationType | yes | 1..1 | Defines the shipping information. |
<shipmentPosition> |
shipmentPositionType | yes | 1..n | Defines the shipping position. |
<dangerousGoods> |
dangerousGoodsType | no | 0..n | Defines the dangerous goods. |
<pieces>?</pieces> |
positiveInt | yes, if dangerousGoods is provided | 1..1 | Defines the amount of pieces. |
<packageType>?</packageType> |
string(50) | yes, if dangerousGoods is provided | 1..1 | Defines the package type. |
<weightType>?</weightType> |
enumeration | yes, if dangerousGoods is provided | 1..1 | Defines the weight type. |
<weight>?</weight> |
string | yes, if dangerousGoods is provided | 1..1 | Defines the weight. |
<weightBasis>?</weightBasis> |
string | no | 0..1 | Defines the weight basis. |
<subitems> |
dangerousGoodsUnNoType | yes, if dangerousGoods is provided | 1..n | Defines the dangerous goods UN information. |
<unNo>?</unNo> |
string(4) | yes, if subitems is provided | 1..1 | Defines the dangerous goods UN number. |
<labelType>?</labelType> |
string(10) | yes, if subitems is provided | 1..1 | Defines the label type. |
<packageGroup>?</packageGroup> |
enumeration | yes, if subitems is provided | 1..1 | Defines the package group. |
<shippingName>?</shippingName> |
string(250) | yes, if subitems is provided | 1..1 | Defines the shipping name. |
<technicalName>?</technicalName> |
string(250) | no | 0..1 | Defines the technical name. |
<specialProvision>?</specialProvision> |
string(250) | no | 0..1 | Defines the special provision. |
<tunnelCode>?</tunnelCode> |
string(10) | no | 0..1 | Defines the tunnel code. |
<waste>?</waste> |
boolean | yes, if subitems is provided | 1..1 | Defines if dangerous goods is waste. |
<europeanWasteCode>?</europeanWasteCode> |
string | no | 0..1 | Defines the European waste code (if waste is set to true). |
<NEM>?</NEM> |
string | no | 0..1 | Defines the net explosive mass weight. |
<transportCategory>?</transportCategory> |
int | no | 0..1 | Defines the transport category. |
<exceptedQuantities>?</exceptedQuantities> |
boolean | yes, if subitems is provided | 1..1 | Defines if dangerous goods is excepted quantity. |
<limitedQuantity>?</limitedQuantity> |
boolean | yes, if subitems is provided | 1..1 | Defines if dangerous goods is limited quantity. |
<emptyUncleanedPackages>?</emptyUncleanedPackages> |
boolean | no | 0..1 | Defines if dangerous goods is of empty uncleaned packages. |
<marinePollutant>?</marinePollutant> |
boolean | yes, if subitems is provided | 1..1 | Defines if dangerous goods is marine pollutant. |
<subRisk1>?</subRisk1> |
boolean | no | 0..1 | Defines the sub risk 1. |
<subRisk2>?</subRisk2> |
boolean | no | 0..1 | Defines the sub risk 2. |
<subRisk3>?</subRisk3> |
boolean | no | 0..1 | Defines the sub risk 3. |
<fireworkClassification> |
fireworkClassificationType | no | 0..1 | Defines the firework classification. |
<countryCode>?</countryCode> |
string(10) | yes, if fireworkClassification is provided | 1..1 | Defines the country code. |
<reference>?</reference> |
string(100) | yes, if fireworkClassification is provided | 1..1 | Defines the firework classification reference. |
<dgr>?</dgr> |
boolean | yes | 1..1 | Defines if dangerous goods is required. |
<cargoDesc>?</cargoDesc> |
string(500) | yes | 1..1 | Defines the cargo description. |
<length>?</length> |
string(10,2) | no | 0..1 | Defines the length. |
<width>?</width> |
string(10,2) | no | 0..1 | Defines the width. |
<height>?</height> |
string(10,2) | no | 0..1 | Defines the height. |
<volume>?</volume> |
string(10,2) | yes | 1..1 | Defines the volume. |
<grossWeight>?</grossWeight> |
string(10,2) | yes | 1..1 | Defines the gross weight. |
<marksAndNumbers>?</marksAndNumbers> |
string(500) | no | 0..1 | Defines the marks and numbers. |
<hsCode>?</hsCode> |
string(13) | no | 0..1 | Defines the hs code. |
<packageLine> |
packageLineType | no | 0..n | Defines the pakage line. |
<cargoDesc>?</cargoDesc> |
string(500) | no | 0..1 | Defines the cargo description. |
<length>?</length> |
string(10,2) | no | 0..1 | Defines the length. |
<width>?</width> |
string(10,2) | no | 0..1 | Defines the width. |
<height>?</height> |
string(10,2) | no | 0..1 | Defines the height. |
<volume>?</volume> |
string(10,2) | no | 0..1 | Defines the volume. |
<grossWeight>?</grossWeight> |
string(10,2) | no | 0..1 | Defines the gross weight. |
<packageType>?</packageType> |
string(50) | yes | 1..1 | Defines the package type. |
<pieces>?</pieces> |
positiveInt | yes | 1..1 | Defines the amount of pieces. |
<stackable>?</stackable> |
boolean | yes | 1..1 | Defines if the shipping position is stackable. |
<grossWeight>?</grossWeight> |
string(10,2) | yes | 0..1 | Defines the gross weight. |
<volume>?</volume> |
string(10,2) | yes | 1..1 | Defines the volume. |
<preAdviseToConsignee> |
preAdviseToConsigneeType | no | 0..1 | Defines the preadvise to consignee contact. |
<contact>?</contact> |
string(1000) | yes, if preAdviseToConsignee is provided | 1..1 | Defines the name. |
<phone>?</phone> |
string(1000) | yes, if preAdviseToConsignee is provided | 1..1 | Defines the phone number. |
<deliveryDateConsignee> |
deliveryDateConsigneeType | no | 0..1 | Defines the delivery date consignee information. |
<deliveryDate>?</deliveryDate> |
dateTime | yes, if deliveryDateConsignee is provided | 1..1 | Defines delivery date consignee. |
<deliveryType>?</deliveryType> |
enumeration | yes, if deliveryDateConsignee is provided | 1..1 | Defines delivery date consignee type. |
<timeFrom>?</timeFrom> |
string | no | 0..1 | Defines delivery date consignee time FROM (00:00 upto 23:59) when type TIME is selected |
<timeTo>?</timeTo> |
string | no | 0..1 | Defines delivery date consignee time TO (00:00 upto 23:59) when type TIME is selected |
<express>?</express> |
boolean | yes | 1..1 | Defines if the shipment is express. |
<foodRelated>?</foodRelated> |
boolean | yes | 1..1 | Defines if the shipment is food related. |
<heatedTransport>?</heatedTransport> |
boolean | yes | 1..1 | Defines if the shipment is a heated transport. |
<homeDelivery>?</homeDelivery> |
boolean | yes | 1..1 | Defines if the shipment is a home delivery. |
<measureUnit>?</measureUnit> |
enumeration | yes | 1..1 | Defines the settlement basis. |
<measureUnitLoadingMeters>?</measureUnitLoadingMeters> |
string(5,2) | no | 0..1 | Defines the measure unit loading meters. |
<measureUnitPalletSpace>?</measureUnitPalletSpace> |
string(9,2) | no | 0..1 | Defines the measure unit pallet space. |
<measureUnitPieces>?</measureUnitPieces> |
positiveInt | no | 0..1 | Defines the measure unit pieces. |
<measureUnitVolume>?</measureUnitVolume> |
string(9,2) | no | 0..1 | Defines the measure unit volume. |
<ownPickup>?</ownPickup> |
boolean | yes | 1..1 | Defines if the shipment requires own pickup. |
<pharmaceuticals>?</pharmaceuticals> |
boolean | no | 0..1 | Defines if the shipment is pharmaceuticals. |
<driverPreAdvise> |
driverPreAdviseType | no | 0..1 | Defines the driver preadvise contact. |
<contact>?</contact> |
string(1000) | yes, if driverPreAdvise is provided | 1..1 | Defines the name. |
<phone>?</phone> |
string(1000) | yes, if driverPreAdvise is provided | 1..1 | Defines the phone number. |
<transportTemperature> |
transportTemperatureType | no | 0..1 | Defines if the shipment requires a transport temperature. |
<temperatureFrom>?</temperatureFrom> |
Int | yes, if transportTemperature is provided | 1..1 | Defines the min temperature. |
<temperatureTo>?</temperatureTo> |
Int | yes, if transportTemperature is provided | 1..1 | Defines the max temperature. |
<returnPallet> |
returnPalletType | no | 0..1 | Defines the return pallet information. |
<pieces>?</pieces> |
positiveInt | yes, if returnPallet is provided | 1..1 | Defines the number of pieces. |
<loadingDevice> |
LoadingDeviceType | no | 0..1 | Defines the loading device information. |
<pieces>?</pieces> |
positiveInt | yes, if loadingDevice is provided | 1..1 | Defines the number of pieces. |
<preAdviseToConsigneeEmail>?</preAdviseToConsigneeEmail> |
String(80) | no | 0..1 | Defines the preadvise to consignee email contact. |
<frostFree>?</frostFree> |
boolean | no | 0..1 | Defines if the shipment requires to be frost free. |
<preNotice> |
preNoticeType | no | 0..1 | Defines the prenotice contact. |
<contact>?</contact> |
string(1000) | yes, if preNotice is provided | 1..1 | Defines the name. |
<phone>?</phone> |
string(1000) | yes, if preNotice is provided | 1..1 | Defines the phone number. |
<deliveryDateFixToBeAgreed> |
deliveryDateFixToBeAgreedType | no | 0..1 | Defines the delivery date fix to be agreed contact. |
<contact>?</contact> |
string(1000) | yes, if deliveryDateFixToBeAgreed is provided | 1..1 | Defines the name. |
<phone>?</phone> |
string(1000) | yes, if deliveryDateFixToBeAgreed is provided | 1..1 | Defines the phone number. |
<customData>?</customData> |
string(1000) | no | 0..1 | Defines the vehicle type.J100 |
<preadviseToPickup> |
preadviseToPickupType | no | 0..1 | Defines the preadvise to pickup contact. |
<contact>?</contact> |
string(1000) | yes, if preadviseToPickup is provided | 1..1 | Defines the name. |
<phone>?</phone> |
string(1000) | yes, if preadviseToPickup is provided | 1..1 | Defines the phone number. |
<equipment> |
equipmentType | no | 0..1 | Defines the equipment. |
<vehicleType>?</vehicleType> |
enumeration | no | 0..1 | Defines the vehicle type. |
<formatType>?</formatType> |
enumeration | no | 0..1 | Defines the format type. |
<bodyType>?</bodyType> |
enumeration | no | 0..1 | Defines the body type. |
<technologyType>?</technologyType> |
enumeration | no | 0..1 | Defines the technology type. |
<loadSecuringEquipment> |
loadSecuringEquipmentType | no | 0..4 | Defines the load securing equipment. |
<type>?</type> |
enumeration | yes, if loadSecuringEquipment is provided | 1..1 | Defines the type. |
<quantity>?</quantity> |
positiveInt | yes, if loadSecuringEquipment is provided | 1..1 | Defines the quantity. |
<palletExchange>?</palletExchange> |
boolean | no | 0..1 | Defines if the shipment requires pallet exchange. |
<mixedLoadingRestriction>?</mixedLoadingRestriction> |
boolean | no | 0..1 | Defines if the shipment has mixed loading restrictions. |
<mixedLoadingRestrictionDescription>?</mixedLoadingRestrictionDescription> |
String | no | 0..1 | Defines the mixed loading restrictions. |
<transShipmentRestriction>?</transShipmentRestriction> |
boolean | no | 0..1 | Defines if the shipment has trans shipment restrictions. |
<liftingPlatform>?</liftingPlatform> |
enumeration | no | 0..2 | Defines if the shipment requires a tail lift platform at pickup and/or delivery. |
<ekaerNumber>?</ekaerNumber> |
String(15) | no | 0..1 | Defines the ekaer number. |
<printCmrEmail>?</printCmrEmail> |
String(250) | no | 0..1 | Defines if cmr will be sent on confirmation from the responsible Schenker office. |
<sentApplicable> |
sentApplicableType | no | 0..1 | Defines if the shipment is applicable for sent. |
<sentNumber>?</sentNumber> |
String(14) | yes, if sentApplicable is provided | 1..1 | Defines the sent number. |
<sentCarrierUpdateKey>?</sentCarrierUpdateKey> |
String(7) | yes, if sentApplicable is provided | 1..1 | Defines the sent carrier update key. |
<longGoods>?</longGoods> |
enumeration | no | 0..1 | Defines if the shipment has long goods. |
<nextDayCollection>?</nextDayCollection> |
boolean | no | 0..1 | Defines if a next day collection is requested. |
<proofOfDelivery>?</proofOfDelivery> |
boolean | no | 0..1 | Defines if a proof of delivery is requested. |
<preNoticePickup> |
preNoticeContactType | no | 0..1 | Defines the prenotice pickup contact. |
<contactPerson>?</contactPerson> |
string(500) | yes, if preNoticePickup is provided | 1..1 | Defines the name. |
<phone>?</phone> |
string(250) | yes, if preNoticePickup is provided | 1..1 | Defines the phone number. |
<email>?</email> |
string(250) | yes, if preNoticePickup is provided | 1..1 | Defines the email address. |
<preNoticeDelivery> |
preNoticeDeliveryType | no | 0..1 | Defines the prenotice delivery contact. |
<contactPerson>?</contactPerson> |
string(500) | yes, if preNoticeDelivery is provided | 1..1 | Defines the name. |
<phone>?</phone> |
string(250) | yes, if preNoticeDelivery is provided | 1..1 | Defines the phone number. |
<email>?</email> |
string(250) | yes, if preNoticeDelivery is provided | 1..1 | Defines the email address. |
<fixDayPickup>?</fixDayPickup> |
boolean | no | 0..1 | Defines if the shipment requires a fix day pickup. |
<timeWindowPickup>?</timeWindowPickup> |
enumeration | no | 0..1 | Defines the time window for the pickup. |
<timeWindowDelivery>?</timeWindowDelivery> |
enumeration | no | 0..1 | Defines the time window for the delivery. |
<specialLoadingSpecification>?</specialLoadingSpecification> |
enumeration | no | 0..6 | Defines the special loading specification. |
<partloadPickedUp>?</partloadPickedUp> |
boolean | no | 0..1 | Defines if partloadPickedUp is requested. |
<giroservice>?</giroservice> |
boolean | no | 0..1 | Defines if giroservice is requested. |
<giroserviceNetFreightSurcharge>?</giroserviceNetFreightSurcharge> |
boolean | no | 0..1 | Defines if giroserviceNetFreightSurcharge is requested. |
<giroserviceRegularShippingSurcharge>?</giroserviceRegularShippingSurcharge> |
boolean | no | 0..1 | Defines if giroserviceRegularShippingSurcharge is requested. |
<schenkerSpecial>?</schenkerSpecial> |
boolean | no | 0..1 | Defines if schenkerSpecial is requested. |
<reshipping>?</reshipping> |
boolean | no | 0..1 | Defines if reshipping is requested. |
<privateDeliveryInside>?</privateDeliveryInside> |
boolean | no | 0..1 | Defines if privateDeliveryInside is requested. |
<privateDeliveryAtWork>?</privateDeliveryAtWork> |
boolean | no | 0..1 | Defines if privateDeliveryAtWork is requested. |
<privateDeliveryInsideReturnablePackaging>?</privateDeliveryInsideReturnablePackaging> |
boolean | no | 0..1 | Defines if privateDeliveryInsideReturnablePackaging is requested. |
<privateDeliveryInsideReturnOfOldDevice>?</privateDeliveryInsideReturnOfOldDevice> |
boolean | no | 0..1 | Defines if privateDeliveryInsideReturnOfOldDevice is requested. |
<privateDeliveryInsideReturnablePackagingOldDevice>?</privateDeliveryInsideReturnablePackagingOldDevice> |
boolean | no | 0..1 | Defines if privateDeliveryInsideReturnablePackagingOldDevice is requested. |
<returnShipment>?</returnShipment> |
boolean | no | 0..1 | Defines if returnShipment is requested. |
<dispersionAgreement>?</dispersionAgreement> |
boolean | no | 0..1 | Defines if dispersionAgreement is requested. |
<customsClearanceImportShipmentSentToCustomsWarehouse>?</customsClearanceImportShipmentSentToCustomsWarehouse> |
boolean | no | 0..1 | Defines if customsClearanceImportShipmentSentToCustomsWarehouse is requested. |
<refrigerated>?</refrigerated> |
boolean | no | 0..1 | Defines if refrigerated is requested. |
<volumeGoods>?</volumeGoods> |
boolean | no | 0..1 | Defines if volumeGoods is requested. |
<return>?</return> |
boolean | no | 0..1 | Defines if return is requested. |
<automatedFixDayPickupToBeAgreed> |
automatedFixDayPickupToBeAgreedType | no | Defines the automated fix day pickup to be agreed contact. | |
<contact>?</contact> |
string(500) | yes, if automatedFixDayPickupToBeAgreed is provided | 1..1 | Defines the name. |
<email>?</email> |
string(250) | yes, if automatedFixDayPickupToBeAgreed is provided | 1..1 | Defines the email address. |
<phone>?</phone> |
string(250) | yes, if automatedFixDayPickupToBeAgreed is provided | 1..1 | Defines the phone number. |
<automatedFixDayDeliveryToBeAgreed>?</automatedFixDayDeliveryToBeAgreed> |
boolean | no | 0..1 | Defines if automated fix day delivery to be agreed is requested. |
<deliveryPreNoticeSms> |
deliveryPreNoticeSmsType | no | 0..1 | Defines the delivery prenotice sms contact. |
<contact>?</contact> |
string(500) | yes, if deliveryPreNoticeSms is provided | 1..1 | Defines the name. |
<phone>?</phone> |
string(250) | yes, if deliveryPreNoticeSms is provided | 1..1 | Defines the phone number. |
<deliveryPreNoticeEmail> |
deliveryPreNoticeEmailType | no | 0..1 | Defines the delivery prenotice email contact. |
<contact>?</contact> |
string(500) | yes, if deliveryPreNoticeEmail is provided | 1..1 | Defines the name. |
<email>?</email> |
string(250) | yes, if deliveryPreNoticeEmail is provided | 1..1 | Defines the email address. |
<assistanceDriverDelivery>?</assistanceDriverDelivery> |
boolean | no | 0..1 | Defines if assistanceDriverDelivery is requested. |
<assistanceDriverPickup>?</assistanceDriverPickup> |
boolean | no | 0..1 | Defines if assistanceDriverPickup is requested. |
<indoorPickup>?</indoorPickup> |
boolean | no | 0..1 | Defines if indoorPickup is requested. |
<unmannedLocationDelivery>?</unmannedLocationDelivery> |
boolean | no | 0..1 | Defines if unmannedLocationDelivery is requested. |
<unmannedLocationPickup>?</unmannedLocationPickup> |
boolean | no | 0..1 | Defines if unmannedLocationPickup is requested. |
<craneServiceDelivery>?</craneServiceDelivery> |
boolean | no | 0..1 | Defines if craneServiceDelivery is requested. |
<craneServicePickup>?</craneServicePickup> |
boolean | no | 0..1 | Defines if craneServicePickup is requested. |
<recycling>?</recycling> |
positiveInt | no | 0..1 | Defines the amount of products for recycling. |
<removalAndRecyclingOfPackagingMaterial>?</removalAndRecyclingOfPackagingMaterial> |
boolean | no | 0..1 | Defines if removalAndRecyclingOfPackagingMaterial is requested. |
<sar>?</sar> |
boolean | no | 0..1 | Defines if sar is requested. |
<pharma>?</pharma> |
boolean | no | 0..1 | Defines if pharma is requested. |
<pallet>?</pallet> |
boolean | no | 0..1 | Defines if pallet is requested. |
<weCare>?</weCare> |
boolean | no | 0..1 | Defines if weCare is requested. |
<expressFr>?</expressFr> |
boolean | no | 0..1 | Defines if expressFr is requested. |
<tailLift>?</tailLift> |
boolean | no | 0..1 | Defines if tailLift is requested. |
<forkLift>?</forkLift> |
boolean | no | 0..1 | Defines if forkLift is requested. |
<transportstraps>?</transportstraps> |
boolean | no | 0..1 | Defines if transportstraps is requested. |
<specialVehicle>?</specialVehicle> |
boolean | no | 0..1 | Defines if special vehicle transportation is requested. |
<roadLimit12>?</roadLimit12> |
boolean | no | 0..1 | Defines if roadLimit12 is requested (Road limitation only for trucks up to 12t). |
<roadLimit35>?</roadLimit35> |
boolean | no | 0..1 | Defines if roadLimit35 is requested (Road limitation only for trucks up to 3,5t). |
<unpavedSite>?</unpavedSite> |
boolean | no | 0..1 | Defines if unpavedSite is requested. |
<semiTrailer>?</semiTrailer> |
boolean | no | 0..1 | Defines if semiTrailer is requested. |
<heightAbove22>?</heightAbove22> |
boolean | no | 0..1 | Defines if heightAbove22 is requested. |
<collectionOrder>?</collectionOrder> |
boolean | no | 0..1 | Defines if collectionOrder is requested. |
<carryInService>?</carryInService> |
boolean | no | 0..1 | Defines if carryInService is requested. |
<nonStandardElementsPL>?</nonStandardElementsPL> |
enumeration | no | 0..5 | Defines if nonStandardElementsPL is requested. |
<unloadingService>?</unloadingService> |
boolean | no | 0..1 | Defines if unloadingService is requested. |
<eveningDelivery>?</eveningDelivery> |
boolean | no | 0..1 | Defines if eveningDelivery is requested. |
<sendWaybillCopy>?</sendWaybillCopy> |
boolean | no | 0..1 | Defines if sendWaybillCopy is requested. |
<deliveryTill10amPL>?</deliveryTill10amPL> |
boolean | no | 0..1 | Defines if deliveryTill10amPL is requested. |
<preAdviceToRetailChains>?</preAdviceToRetailChains> |
boolean | no | 0..1 | Defines if preAdviceToRetailChains is requested. |
<saturdayDeliveryPL>?</saturdayDeliveryPL> |
boolean | no | 0..1 | Defines if saturdayDeliveryPL is requested. |
<pickupAtSchenkerTerminal>?</pickupAtSchenkerTerminal> |
boolean | no | 0..1 | Defines if pickupAtSchenkerTerminal is requested. |
<frozen>?</frozen> |
boolean | no | 0..1 | Defines if frozen is requested. |
<plusPickup> |
plusPickupType | no | 0..1 | Defines the plusPickup contact. |
<contact>?</contact> |
string(500) | yes, if PlusPickup is provided | 1..1 | Defines the name. |
<email>?</email> |
string(250) | yes, if PlusPickup is provided | 1..1 | Defines the email address. |
<phone>?</phone> |
string(250) | yes, if PlusPickup is provided | 1..1 | Defines the phone number. |
<returnDocumentPL> |
returnDocumentPLType | no | 0..1 | Defines the returnDocumentPL information. |
<serviceType>?</serviceType> |
enumeration | yes, if returnDocumentPL is provided | 1..1 | Specifies return documents service type: AM - scan and archive by DB Schenker, AN - scan and return original documents |
<document> |
documentType | yes, if returnDocumentPL is provided | 1..n | Defines the returnDocumentPL item. |
<documentType>?</documentType> |
string(250) | yes | 1..1 | Defines the return document type. |
<documentDescription>?</documentDescription> |
string(300) | yes | 1..1 | Defines the return document description. |
<uitApplicable>?</uitApplicable> |
string(14) | no | 0..1 | Defines the UIT number. |
<dualUse>?</dualUse> |
boolean | no | 0..1 | Defines if dual use is requested. |
<exchangeableLoadingDevice>?</exchangeableLoadingDevice> |
boolean | no | 0..1 | Defines if exchangeableLoadingDevice is requested. |
<electronicReturnOfDocument>?</electronicReturnOfDocument> |
boolean | no | 0..1 | Defines if electronicReturnOfDocument is requested. If requested, please also include in the request at least 1 file upload segment (please refer to line 96 for details) with type = pdf and typeOfDocument=Customer Delivery Note |
SOAP response schema for Land.
| Field Name | Data Type | Mandatory | Cardinality | Description |
|---|---|---|---|---|
<applicationArea> |
applicationAreaType | yes | 1..1 | |
<requestID>?</requestID> |
string(500) | no | 0..1 | Defines the request id which if it was provided in the request message. |
<bookingId>?</bookingId> |
string(13) | yes | 1..1 | Defines the generated eSchenker booking id. |
<barcodeReference> |
barcodeReferenceType | no | Defines the list of barcode references. | |
<barcode>?</barcode> |
no | Defines the barcode. | ||
<barcodeType>?</barcodeType> |
no | Defines the barcode type. | ||
<barcodeDocument>?</barcodeDocument> |
no | Defines the barcode document in base 64 binary format. |
Use this section to build an Ocean FCL booking request. Start with the sample XML request, then use the schema table to check required fields, data types, cardinality, and field descriptions.
Operation: getBookingRequestOceanFCL
Use this sample as the starting point for the booking request. Replace placeholder values with customer, shipment, and authentication data before testing.
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:v1="http://www.schenker.com/Booking/v1_1">
<soapenv:Header />
<soapenv:Body>
<v1:getBookingRequestOceanFCL>
<in>
<applicationArea>
<accessKey>Insert access key here</accessKey>
<groupId>Insert user group Id here</groupId>
<requestID>Request_2099-12-31_12:00:000</requestID>
</applicationArea>
<bookingOceanFCL submitBooking="true">
<address>
<contactPerson>
<email>Shipper.Contact.Email@test.com</email>
</contactPerson>
<name1>Shipper Name 1</name1>
<name2>Shipper Name 2</name2>
<vatNo>Shipper_VAT</vatNo>
<customsId>Shipper_CustomsId</customsId>
<email>Shipper.General.Email@test.com</email>
<locationType>PHYSICAL</locationType>
<mobilePhone>555-12345</mobilePhone>
<personType>COMPANY</personType>
<phone>123-456-789</phone>
<postalCode>12345</postalCode>
<schenkerAddressId>SchenkerAddressId_123</schenkerAddressId>
<street>Shipper Street</street>
<city>Shipper City</city>
<countryCode>DE</countryCode>
<type>SHIPPER</type>
</address>
<address>
<contactPerson>
<email>Consignee.Contact.Email@test.com</email>
</contactPerson>
<name1>Consignee Name 1</name1>
<name2>Consignee Name 2</name2>
<vatNo>Consignee_VAT</vatNo>
<customsId>Consignee_CustomsId</customsId>
<email>Consignee.General.Email@test.com</email>
<locationType>PHYSICAL</locationType>
<mobilePhone>555-12345</mobilePhone>
<personType>COMPANY</personType>
<phone>123-456-789</phone>
<postalCode>23456</postalCode>
<schenkerAddressId>SchenkerAddressId_123</schenkerAddressId>
<street>Consignee Street</street>
<city>Consignee City</city>
<countryCode>DE</countryCode>
<type>CONSIGNEE</type>
</address>
<address>
<contactPerson>
<email>Pickup.Contact.Email@test.com</email>
</contactPerson>
<name1>Pickup Name 1</name1>
<name2>Pickup Name 2</name2>
<vatNo>Pickup_VAT</vatNo>
<customsId>Pickup_CustomsId</customsId>
<email>Pickup.General.Email@test.com</email>
<locationType>PHYSICAL</locationType>
<mobilePhone>555-12345</mobilePhone>
<personType>COMPANY</personType>
<phone>123-456-789</phone>
<postalCode>34567</postalCode>
<schenkerAddressId>SchenkerAddressId_123</schenkerAddressId>
<street>Pickup Street</street>
<city>Pickup City</city>
<countryCode>DE</countryCode>
<type>PICKUP</type>
</address>
<address>
<contactPerson>
<email>Delivery.Contact.Email@test.com</email>
</contactPerson>
<name1>Delivery Name 1</name1>
<name2>Delivery Name 2</name2>
<vatNo>Delivery_VAT</vatNo>
<customsId>Delivery_CustomsId</customsId>
<email>Delivery.General.Email@test.com</email>
<locationType>PHYSICAL</locationType>
<mobilePhone>555-12345</mobilePhone>
<personType>COMPANY</personType>
<phone>123-456-789</phone>
<postalCode>45678</postalCode>
<schenkerAddressId>SchenkerAddressId_123</schenkerAddressId>
<street>Delivery Street</street>
<city>Delivery City</city>
<countryCode>DE</countryCode>
<type>DELIVERY</type>
</address>
<address>
<contactPerson>
<email>Notify.Contact.Email@test.com</email>
</contactPerson>
<name1>Notify Name 1</name1>
<name2>Notify Name 2</name2>
<vatNo>Notify_VAT</vatNo>
<customsId>Notify_CustomsId</customsId>
<email>Notify.General.Email@test.com</email>
<locationType>PHYSICAL</locationType>
<mobilePhone>555-12345</mobilePhone>
<personType>COMPANY</personType>
<phone>123-456-789</phone>
<postalCode>56789</postalCode>
<schenkerAddressId>SchenkerAddressId_123</schenkerAddressId>
<street>Notify Street</street>
<city>Notify City</city>
<countryCode>DE</countryCode>
<type>NOTIFY</type>
</address>
<address>
<contactPerson>
<email>Invoice.Contact.Email@test.com</email>
</contactPerson>
<name1>Invoice Name 1</name1>
<name2>Invoice Name 2</name2>
<vatNo>Invoice_VAT</vatNo>
<customsId>Invoice_CustomsId</customsId>
<email>Invoice.General.Email@test.com</email>
<locationType>PHYSICAL</locationType>
<mobilePhone>555-12345</mobilePhone>
<personType>COMPANY</personType>
<phone>123-456-789</phone>
<postalCode>67890</postalCode>
<schenkerAddressId>SchenkerAddressId_123</schenkerAddressId>
<street>Invoice Street</street>
<city>Invoice City</city>
<countryCode>DE</countryCode>
<type>INVOICE</type>
</address>
<incoterm>EXW</incoterm>
<incotermLocation>IncotermLocation</incotermLocation>
<productCode>fcl</productCode>
<measurementType>METRIC</measurementType>
<cargoDescription>GeneralCargoDescription</cargoDescription>
<cargoInsurance>
<value>9999.99</value>
<currency>EUR</currency>
</cargoInsurance>
<customsClearance>false</customsClearance>
<customsClearanceEu>false</customsClearanceEu>
<grossWeight>1000</grossWeight>
<indoorDelivery>false</indoorDelivery>
<pickupDates>
<pickUpDateFrom>2099-01-30T09:00:00.000+00:00</pickUpDateFrom>
<pickUpDateTo>2099-01-30T18:00:00.000+00:00</pickUpDateTo>
</pickupDates>
<reference>
<number>ShipperReference_123</number>
<id>SHIPPER_REFERENCE_NUMBER</id>
</reference>
<reference>
<number>ConsigneeReference_123</number>
<id>CONSIGNEE_REFERENCE_NUMBER</id>
</reference>
<handlingInstructions>HandlingInstructions_ABC</handlingInstructions>
<neutralShipping>false</neutralShipping>
<specialCargo>false</specialCargo>
<valueOfGoods>
<value>9999.99</value>
<currency>EUR</currency>
</valueOfGoods>
<ecoNeutral>true</ecoNeutral>
<serviceType>P2P</serviceType>
<container>
<containerType>45GP</containerType>
<containerNo>ABCD1234567</containerNo>
<positioningDate>2099-01-30T09:00:00.000+00:00</positioningDate>
<sealNumber>123456</sealNumber>
<positioningAddress>
<contactPerson>
<email>Container.Contact.Email@test.com</email>
</contactPerson>
<name1>Container Name 1</name1>
<name2>Container Name 2</name2>
<vatNo>Container_VAT</vatNo>
<customsId>Container_CustomsId</customsId>
<email>Container.General.Email@test.com</email>
<locationType>PHYSICAL</locationType>
<mobilePhone>555-12345</mobilePhone>
<personType>COMPANY</personType>
<phone>123-456-789</phone>
<postalCode>67890</postalCode>
<schenkerAddressId>SchenkerAddressId_123</schenkerAddressId>
<street>Container Street</street>
<city>Container City</city>
<countryCode>DE</countryCode>
<type>POS_CONTAINER</type>
</positioningAddress>
<shippingInformation>
<shipmentPosition>
<dgr>false</dgr>
<cargoDesc>Shipping Line 1</cargoDesc>
<volume>4</volume>
<grossWeight>400</grossWeight>
<packageType>EP</packageType>
<pieces>3</pieces>
<stackable>true</stackable>
</shipmentPosition>
<shipmentPosition>
<dgr>false</dgr>
<cargoDesc>Shipping Line 2</cargoDesc>
<volume>12</volume>
<grossWeight>600</grossWeight>
<packageType>CI</packageType>
<pieces>5</pieces>
<stackable>false</stackable>
</shipmentPosition>
<grossWeight>1000</grossWeight>
<volume>16</volume>
</shippingInformation>
</container>
<portDischarge>DEHAM</portDischarge>
<portLoading>DEHAM</portLoading>
<precarriageType>PICKUP_REQUEST</precarriageType>
<latestDeliveryDate>2099-01-30T09:00:00.000+00:00</latestDeliveryDate>
</bookingOceanFCL>
</in>
</v1:getBookingRequestOceanFCL>
</soapenv:Body>
</soapenv:Envelope>SOAP request schema for Ocean FCL.
| Field Name | Data Type | Mandatory | Cardinality | Description |
|---|---|---|---|---|
<applicationArea> |
applicationAreaType | yes | 1..1 | |
<accessKey>?</accessKey> |
string(100) | yes | 1..1 | Defines the access key (user token). |
<groupId>?</groupId> |
unsignedLong | no | 0..1 | Defines the optional user group id. |
<requestID>?</requestID> |
string(500) | no | 0..1 | Defines the request id which will be returned with the response message. |
<userId>?</userId> |
string | no | 0..1 | Defines the user id for which the booking should be done. |
<groupName>?</groupName> |
string | no | 0..1 | Defines the user group name for which the booking should be done. |
<uniqueIdBlocker>?</uniqueIdBlocker> |
string | no | 0..1 | Defines the unique id blocker. |
<bookingOceanFCL |
bookingType | yes | 1..1 | |
submitBooking="?" |
boolean | yes | 1..1 | Defines if the booking shall be submitted. If false, the booking can be edited in the frontend and must be submitted manually. |
updateBooking="?" |
string | yes | 1..1 | Defines the booking to be updated. Takes a booking id as parameter. |
readyForConsolidation="?" |
boolean | no | 0..1 | Prepares the booking for later consolidation. |
returnBarcodeReferences="?"> |
boolean | no | 0..1 | Defines if the barcode references are returned in the response message. |
<barcodeRequest> |
barcodeRequestType | no | 0..1 | Option to request the barcode label for the booking. |
start_pos="?" |
positiveInt | yes, if barcodeRequest is provided | 1..1 | Defines the starting position quadrant |
separated="?" |
boolean | yes, if barcodeRequest is provided | 1..1 | Defines if the label is printed on separate pages. |
directThermalMedia="?" |
boolean | no | 0..1 | Defines if direct thermal printing is requested. |
?</barcodeRequest> |
enumeration | yes, if barcodeRequest is provided | 1..1 | Defines the label format. |
<barcodeRequestEmail> |
barcodeRequestEmailType | no | 0..1 | Option to send the barcode labels to defined email addresses. |
<email>?</email> |
string(250) | yes, if barcodeRequestEmail is provided | 1..25 | Defines the list of email addresses. |
<address> |
addressType | yes | 2..6 | Defines the list of addresses. |
<contactPerson> |
contactPersonType | no | 0..n | Defines the contact person details. |
<name>?</name> |
string(100) | no | 0..1 | Defines the name of the contact person. |
<phone>?</phone> |
string(100) | no | 0..1 | Defines the phone number of the contact person. |
<email>?</email> |
string(100) | no | 0..1 | Defines the email address of the contact person. |
<name1>?</name1> |
string(500) | yes | 1..1 | Defines the name. |
<name2>?</name2> |
string(500) | no | 0..1 | Defines the additional name. |
<customerAddressIdentifier>?</customerAddressIdentifier> |
string(100) | no | 0..1 | Defines the customer address identifier. |
<vatNo>?</vatNo> |
string(100) | no | 0..1 | Defines the customer VAT number. |
<customsId>?</customsId> |
string(100) | no | 0..1 | Defines the customs id. |
<email>?</email> |
string(250) | no | 0..1 | Defines the email address. |
<fax>?</fax> |
string(250) | no | 0..1 | Defines the fax number. |
<industry>?</industry> |
enumeration | no | 0..1 | Defines the industry. |
<locationType>?</locationType> |
enumeration | yes | 1..1 | Defines the location type. |
<mobilePhone>?</mobilePhone> |
string(250) | no | 0..1 | Defines the mobile phone number. |
<personType>?</personType> |
enumeration | yes | 1..1 | Defines the person type. |
<phone>?</phone> |
string(250) | no | 0..1 | Defines the phone number. |
<poBox>?</poBox> |
string(50) | no | 0..1 | Defines the PO box. |
<postalCode>?</postalCode> |
string(20) | no* | 0..1 | Defines the postal code. *= The postal code is mandatory for most countries. |
<stateCode>?</stateCode> |
string(5) | no | 0..1 | Defines the state code. |
<stateName>?</stateName> |
string(35) | no | 0..1 | Defines the state name. |
<preferredLanguage>?</preferredLanguage> |
string(10) | no | 0..1 | Defines the preferred language. |
<schenkerAddressId>?</schenkerAddressId> |
string(36) | no | 0..1 | Defines the Schenker address id. |
<street>?</street> |
string(1000) | yes | 1..1 | Defines the street name. |
<street2>?</street2> |
string(1000) | no | 0..1 | Defines the additional street name. |
<city>?</city> |
string(500) | yes | 1..1 | Defines the city name. |
<countryCode>?</countryCode> |
string(10) | yes | 1..1 | Defines the country code. |
<type>?</type> |
enumeration | yes | 1..1 | Defines the address type. SHIPPER and CONSIGNEE addresses are mandatory. |
<incoterm>?</incoterm> |
enumeration | yes | 1..1 | Defines the incoterm. |
<incotermLocation>?</incotermLocation> |
string(250) | yes | 1..1 | Defines the incoterm location. |
<productCode>?</productCode> |
string(10) | yes | 1..1 | Defines the product. |
<productOption>?</productOption> |
string(10) | no | 0..1 | Defines the time critical product option. |
<measurementType>?</measurementType> |
enumeration | yes | 1..1 | Defines the measurement type. |
<cargoDescription>?</cargoDescription> |
string(1000) | no | 0..1 | Defines the cargo description. |
<cargoInsurance> |
cargoInsuranceType | no | 0..1 | Defines the cargo insurance. |
<value>?</value> |
string(10,2) | yes, if cargoInsurance is provided | 1..1 | Defines the cargo insurance value. |
<currency>?</currency> |
string(3) | yes, if cargoInsurance is provided | 1..1 | Defines the cargo insurance currency. |
<cashOnDelivery> |
cashOnDeliveryType | no | 0..1 | Defines the cash on delivery. |
<value>?</value> |
string(10,2) | yes, if cashOnDelivery is provided | 1..1 | Defines the cash on delivery value. |
<currency>?</currency> |
string(3) | yes, if cashOnDelivery is provided | 1..1 | Defines the cash on delivery currency. |
<customsClearance>?</customsClearance> |
boolean | yes | 1..1 | Defines if customs clearance is required. |
<customsClearanceEu>?</customsClearanceEu> |
boolean | yes* | 0..1 | Defines if customs clearance EU is required. *= This field must be provided in case of customs clearance in European land transport. |
<exportCustomsDeclarant> |
exportCustomsDeclarantType | no | 0..1 | Defines the export customs declarant. |
<type>?</type> |
enumeration | yes, if exportCustomsDeclarant is provided | 1..1 | Defines the export customs declarant type. |
<declarantInformation> |
declarantInformationType | no | Defines the export customs declarant information. | |
<companyName>?</companyName> |
string(35) | no | 0..1 | Defines the company name. |
<street>?</street> |
string(35) | no | 0..1 | Defines the street name. |
<postalCode>?</postalCode> |
string(10) | no | 0..1 | Defines the postal code. |
<city>?</city> |
string(35) | no | 0..1 | Defines the city name. |
<countryCode>?</countryCode> |
string(10) | no | 0..1 | Defines the country code. |
<phone>?</phone> |
string(250) | no | 0..1 | Defines the phone number. |
<email>?</email> |
string(25) | no | 0..1 | Defines the email address. |
<importCustomsDeclarant> |
importCustomsDeclarantType | no | Defines the import customs declarant. | |
<type>?</type> |
enumeration | yes, if importCustomsDeclarant is provided | 1..1 | Defines the import customs declarant type. |
<declarantInformation> |
declarantInformationType | no | Defines the import customs declarant information. | |
<companyName>?</companyName> |
string(35) | no | 0..1 | Defines the company name. |
<street>?</street> |
string(35) | no | 0..1 | Defines the street name. |
<postalCode>?</postalCode> |
string(10) | no | 0..1 | Defines the postal code. |
<city>?</city> |
string(35) | no | 0..1 | Defines the city name. |
<countryCode>?</countryCode> |
string(10) | no | 0..1 | Defines the country code. |
<phone>?</phone> |
string(250) | no | 0..1 | Defines the phone number. |
<email>?</email> |
string(25) | no | 0..1 | Defines the email address. |
<file> |
fileType | no | 0..n | Defines the list of files. |
<fileSizeBytes>?</fileSizeBytes> |
int | yes | 1..1 | Defines the file size in bytes. |
<name>?</name> |
string(250) | no | 0..1 | Defines the file name. |
<type>?</type> |
string(5) | no | 0..1 | Defines the file type. |
<typeOfDocument>?</typeOfDocument> |
enumeration | no | 0..1 | Defines the type of documentation. |
<data>?</data> |
string | no | 0..1 | Defines the Base64 data. |
<grossWeight>?</grossWeight> |
string(5,2) | yes | 1..1 | Defines the total gross weight. |
<indoorDelivery>?</indoorDelivery> |
boolean | yes | 1..1 | Defines if indoor delivery is required. |
<pickupDates> |
pickupDatesType | yes | 1..1 | Defines the pickup dates. |
<pickUpDateFrom>?</pickUpDateFrom> |
dateTime | yes | 1..1 | Defines the start pickup time. |
<pickUpDateTo>?</pickUpDateTo> |
dateTime | yes | 1..1 | Defines the end pickup time. |
<reference> |
referenceType | no | 0..n | Defines the references. |
<number>?</number> |
string(100) | yes, if reference is provided | 1..1 | Defines the reference number. |
<id>?</id> |
string(100) | yes, if reference is provided | 1..1 | Defines the reference type. |
<handlingInstructions>?</handlingInstructions> |
string(2000) | no | 0..1 | Defines the handling instructions. |
<neutralShipping>?</neutralShipping> |
boolean | yes | 1..1 | Defines the business scenario in which the customer sends a booking request in the name of the ordering party. |
<specialCargo>?</specialCargo> |
boolean | yes | 1..1 | Defines if special cargo is required. |
<specialCargoDescription>?</specialCargoDescription> |
string(1000) | no | 0..1 | Defines the special cargo description. |
<valueOfGoods> |
valueOfGoodsType | no | 0..1 | Defines the value of goods. |
<value>?</value> |
string(10,2) | yes, if valueOfGoods is provided | 1..1 | Defines the cargo insurance value. |
<currency>?</currency> |
string(3) | yes, if valueOfGoods is provided | 1..1 | Defines the cargo insurance currency. |
<wayBillNumber>?</wayBillNumber> |
string(100) | no | 0..1 | Defines the waybill number. |
<barcodeReference> |
barcodeReferenceType | no | 0..n | Defines the barcode references. |
<barcode>?</barcode> |
string(100) | yes, if barcodeReference is provided | 1..1 | Defines the barcode value. |
<barcodeType>?</barcodeType> |
string(30) | yes, if barcodeReference is provided | 1..1 | Defines the barcode type. Only allowed value = SSCC. |
<ecoNeutral>?</ecoNeutral> |
boolean | no | 0..1 | Defines if the shipment is eco neutral. |
<serviceType>?</serviceType> |
enumeration | yes | 1..1 | Defines the service type. |
<container> |
containerType | yes | 1..n | Defines the container information. |
<containerType>?</containerType> |
String(50) | yes | 1..1 | Defines the container type. |
<containerNo>?</containerNo> |
String(100) | no | 0..1 | Defines the container number. |
<positioningDate>?</positioningDate> |
dateTime | yes | 1..1 | Defines the positioning date. |
<sealNumber>?</sealNumber> |
String(100) | no | 0..1 | Defines the seal number. |
<positioningAddress> |
positioningAddressType | yes | 1..1 | Defines the container positioning information. |
<contactPerson> |
contactPersonType | no | 0..n | Defines the contact person details. |
<name>?</name> |
string(100) | yes, if contactPerson is provided | 0..1 | Defines the name of the contact person. |
<phone>?</phone> |
string(100) | yes, if contactPerson is provided | 0..1 | Defines the phone number of the contact person. |
<email>?</email> |
string(100) | yes, if contactPerson is provided | 0..1 | Defines the email address of the contact person. |
<name1>?</name1> |
string(500) | yes | 1..1 | Defines the name. |
<name2>?</name2> |
string(500) | no | 0..1 | Defines the additional name. |
<customerAddressIdentifier>?</customerAddressIdentifier> |
string(100) | no | 0..1 | Defines the customer address identifier. |
<vatNo>?</vatNo> |
string(100) | no | 0..1 | Defines the customer VAT number. |
<customsId>?</customsId> |
string(100) | no | 0..1 | Defines the customs id. |
<email>?</email> |
string(250) | no | 0..1 | Defines the email address. |
<fax>?</fax> |
string(250) | no | 0..1 | Defines the fax number. |
<industry>?</industry> |
enumeration | no | 0..1 | Defines the industry. |
<locationType>?</locationType> |
enumeration | yes | 1..1 | Defines the location type. |
<mobilePhone>?</mobilePhone> |
string(250) | no | 0..1 | Defines the mobile phone number. |
<personType>?</personType> |
enumeration | yes | 1..1 | Defines the person type. |
<phone>?</phone> |
string(250) | no | 0..1 | Defines the phone number. |
<poBox>?</poBox> |
string(50) | no | 0..1 | Defines the PO box. |
<postalCode>?</postalCode> |
string(20) | no* | 0..1 | Defines the postal code. *= The postal code is mandatory for most countries. |
<stateCode>?</stateCode> |
string(5) | no | 0..1 | Defines the state code. |
<stateName>?</stateName> |
string(35) | no | 0..1 | Defines the state name. |
<preferredLanguage>?</preferredLanguage> |
string(10) | no | 0..1 | Defines the preferred language. |
<schenkerAddressId>?</schenkerAddressId> |
string(36) | no | 0..1 | Defines the Schenker address id. |
<street>?</street> |
string(1000) | yes | 1..1 | Defines the street name. |
<street2>?</street2> |
string(1000) | no | 0..1 | Defines the additional street name. |
<city>?</city> |
string(500) | yes | 1..1 | Defines the city name. |
<countryCode>?</countryCode> |
string(10) | yes | 1..1 | Defines the country code. |
<type>?</type> |
enumeration | yes | 1..1 | Defines the address type. Only allowed value = POS_CONTAINER. |
<shippingInformation> |
shippingInformationType | yes | 1..1 | Defines the shipping information. |
<shipmentPosition> |
shipmentPositionType | yes | 1..n | Defines the shipping position. |
<dangerousGoods> |
dangerousGoodsType | no | 0..n | Defines the dangerous goods. |
<pieces>?</pieces> |
positiveInt | yes, if dangerousGoods is provided | 1..1 | Defines the amount of pieces. |
<packageType>?</packageType> |
string(50) | yes, if dangerousGoods is provided | 1..1 | Defines the package type. |
<weightType>?</weightType> |
enumeration | yes, if dangerousGoods is provided | 1..1 | Defines the weight type. |
<weight>?</weight> |
string | yes, if dangerousGoods is provided | 1..1 | Defines the weight. |
<weightBasis>?</weightBasis> |
string | no | 0..1 | Defines the weight basis. |
<subitems> |
dangerousGoodsUnNoType | yes, if dangerousGoods is provided | 1..n | Defines the dangerous goods UN information. |
<unNo>?</unNo> |
string(4) | yes, if subitems is provided | 1..1 | Defines the dangerous goods UN number. |
<labelType>?</labelType> |
string(10) | yes, if subitems is provided | 1..1 | Defines the label type. |
<packageGroup>?</packageGroup> |
enumeration | yes, if subitems is provided | 1..1 | Defines the package group. |
<shippingName>?</shippingName> |
string(250) | yes, if subitems is provided | 1..1 | Defines the shipping name. |
<technicalName>?</technicalName> |
string(250) | no | 0..1 | Defines the technical name. |
<specialProvision>?</specialProvision> |
string(250) | no | 0..1 | Defines the special provision. |
<tunnelCode>?</tunnelCode> |
string(10) | no | 0..1 | Defines the tunnel code. |
<waste>?</waste> |
boolean | yes, if subitems is provided | 1..1 | Defines if dangerous goods is waste. |
<europeanWasteCode>?</europeanWasteCode> |
string | no | 0..1 | Defines the European waste code (if waste is set to true). |
<NEM>?</NEM> |
string | no | 0..1 | Defines the net explosive mass weight. |
<transportCategory>?</transportCategory> |
int | no | 0..1 | Defines the transport category. |
<exceptedQuantities>?</exceptedQuantities> |
boolean | yes, if subitems is provided | 1..1 | Defines if dangerous goods is excepted quantity. |
<limitedQuantity>?</limitedQuantity> |
boolean | yes, if subitems is provided | 1..1 | Defines if dangerous goods is limited quantity. |
<emptyUncleanedPackages>?</emptyUncleanedPackages> |
boolean | no | 0..1 | Defines if dangerous goods is of empty uncleaned packages. |
<marinePollutant>?</marinePollutant> |
boolean | yes, if subitems is provided | 1..1 | Defines if dangerous goods is marine pollutant. |
<subRisk1>?</subRisk1> |
boolean | no | 0..1 | Defines the sub risk 1. |
<subRisk2>?</subRisk2> |
boolean | no | 0..1 | Defines the sub risk 2. |
<subRisk3>?</subRisk3> |
boolean | no | 0..1 | Defines the sub risk 3. |
<fireworkClassification> |
fireworkClassificationType | no | 0..1 | Defines the firework classification. |
<countryCode>?</countryCode> |
string(10) | yes, if fireworkClassification is provided | 1..1 | Defines the country code. |
<reference>?</reference> |
string(100) | yes, if fireworkClassification is provided | 1..1 | Defines the firework classification reference. |
<dgr>?</dgr> |
boolean | yes | 1..1 | Defines if dangerous goods is required. |
<cargoDesc>?</cargoDesc> |
string(500) | yes | 1..1 | Defines the cargo description. |
<length>?</length> |
string(10,2) | no | 0..1 | Defines the length. |
<width>?</width> |
string(10,2) | no | 0..1 | Defines the width. |
<height>?</height> |
string(10,2) | no | 0..1 | Defines the height. |
<volume>?</volume> |
string(10,2) | yes | 1..1 | Defines the volume. |
<grossWeight>?</grossWeight> |
string(10,2) | yes | 1..1 | Defines the gross weight. |
<marksAndNumbers>?</marksAndNumbers> |
string(500) | no | 0..1 | Defines the marks and numbers. |
<hsCode>?</hsCode> |
string(13) | no | 0..1 | Defines the hs code. |
<packageLine> |
packageLineType | no | 0..n | Defines the pakage line. |
<cargoDesc>?</cargoDesc> |
string(500) | no | 0..1 | Defines the cargo description. |
<length>?</length> |
string(10,2) | no | 0..1 | Defines the length. |
<width>?</width> |
string(10,2) | no | 0..1 | Defines the width. |
<height>?</height> |
string(10,2) | no | 0..1 | Defines the height. |
<volume>?</volume> |
string(10,2) | no | 0..1 | Defines the volume. |
<grossWeight>?</grossWeight> |
string(10,2) | no | 0..1 | Defines the gross weight. |
<packageType>?</packageType> |
string(50) | yes | 1..1 | Defines the package type. |
<pieces>?</pieces> |
positiveInt | yes | 1..1 | Defines the amount of pieces. |
<stackable>?</stackable> |
boolean | yes | 1..1 | Defines if the shipping position is stackable. |
<grossWeight>?</grossWeight> |
string(10,2) | yes | 0..1 | Defines the gross weight. |
<volume>?</volume> |
string(10,2) | yes | 1..1 | Defines the volume. |
<portDischarge>?</portDischarge> |
string(5) | yes* | 0..1 | Defines the port of discharge. *= This field must be provided if the service type is D2P or P2P. |
<portLoading>?</portLoading> |
string(5) | yes* | 0..1 | Defines the port of loading. *= This field must be provided if the service type is P2D or P2P. |
<positioningType>?</positioningType> |
enumeration | no | 0..1 | Defines the container positioning type. |
<latestDeliveryDate>?</latestDeliveryDate> |
dateTime | yes | 0..1 | Defines the latest delivery date. |
SOAP response schema for Ocean FCL.
| Field Name | Data Type | Mandatory | Cardinality | Description |
|---|---|---|---|---|
<applicationArea> |
applicationAreaType | yes | 1..1 | |
<requestID>?</requestID> |
string(500) | no | 0..1 | Defines the request id which if it was provided in the request message. |
<bookingId>?</bookingId> |
string(13) | yes | 1..1 | Defines the generated eSchenker booking id. |
<barcodeReference> |
barcodeReferenceType | no | Defines the list of barcode references. | |
<barcode>?</barcode> |
no | Defines the barcode. | ||
<barcodeType>?</barcodeType> |
no | Defines the barcode type. | ||
<barcodeDocument>?</barcodeDocument> |
no | Defines the barcode document in base 64 binary format. |
Use this section to build an Ocean LCL booking request. Start with the sample XML request, then use the schema table to check required fields, data types, cardinality, and field descriptions.
Operation: getBookingRequestOceanLCL
Use this sample as the starting point for the booking request. Replace placeholder values with customer, shipment, and authentication data before testing.
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:v1="http://www.schenker.com/Booking/v1_1">
<soapenv:Header />
<soapenv:Body>
<v1:getBookingRequestOceanLCL>
<in>
<applicationArea>
<accessKey>Insert access key here</accessKey>
<groupId>Insert user group Id here</groupId>
<requestID>Request_2099-12-31_12:00:000</requestID>
</applicationArea>
<bookingOceanLCL submitBooking="true">
<address>
<contactPerson>
<email>Shipper.Contact.Email@test.com</email>
</contactPerson>
<name1>Shipper Name 1</name1>
<name2>Shipper Name 2</name2>
<vatNo>Shipper_VAT</vatNo>
<customsId>Shipper_CustomsId</customsId>
<email>Shipper.General.Email@test.com</email>
<locationType>PHYSICAL</locationType>
<mobilePhone>555-12345</mobilePhone>
<personType>COMPANY</personType>
<phone>123-456-789</phone>
<postalCode>12345</postalCode>
<schenkerAddressId>SchenkerAddressId_123</schenkerAddressId>
<street>Shipper Street</street>
<city>Shipper City</city>
<countryCode>DE</countryCode>
<type>SHIPPER</type>
</address>
<address>
<contactPerson>
<email>Consignee.Contact.Email@test.com</email>
</contactPerson>
<name1>Consignee Name 1</name1>
<name2>Consignee Name 2</name2>
<vatNo>Consignee_VAT</vatNo>
<customsId>Consignee_CustomsId</customsId>
<email>Consignee.General.Email@test.com</email>
<locationType>PHYSICAL</locationType>
<mobilePhone>555-12345</mobilePhone>
<personType>COMPANY</personType>
<phone>123-456-789</phone>
<postalCode>23456</postalCode>
<schenkerAddressId>SchenkerAddressId_123</schenkerAddressId>
<street>Consignee Street</street>
<city>Consignee City</city>
<countryCode>DE</countryCode>
<type>CONSIGNEE</type>
</address>
<address>
<contactPerson>
<email>Pickup.Contact.Email@test.com</email>
</contactPerson>
<name1>Pickup Name 1</name1>
<name2>Pickup Name 2</name2>
<vatNo>Pickup_VAT</vatNo>
<customsId>Pickup_CustomsId</customsId>
<email>Pickup.General.Email@test.com</email>
<locationType>PHYSICAL</locationType>
<mobilePhone>555-12345</mobilePhone>
<personType>COMPANY</personType>
<phone>123-456-789</phone>
<postalCode>34567</postalCode>
<schenkerAddressId>SchenkerAddressId_123</schenkerAddressId>
<street>Pickup Street</street>
<city>Pickup City</city>
<countryCode>DE</countryCode>
<type>PICKUP</type>
</address>
<address>
<contactPerson>
<email>Delivery.Contact.Email@test.com</email>
</contactPerson>
<name1>Delivery Name 1</name1>
<name2>Delivery Name 2</name2>
<vatNo>Delivery_VAT</vatNo>
<customsId>Delivery_CustomsId</customsId>
<email>Delivery.General.Email@test.com</email>
<locationType>PHYSICAL</locationType>
<mobilePhone>555-12345</mobilePhone>
<personType>COMPANY</personType>
<phone>123-456-789</phone>
<postalCode>45678</postalCode>
<schenkerAddressId>SchenkerAddressId_123</schenkerAddressId>
<street>Delivery Street</street>
<city>Delivery City</city>
<countryCode>DE</countryCode>
<type>DELIVERY</type>
</address>
<address>
<contactPerson>
<email>Notify.Contact.Email@test.com</email>
</contactPerson>
<name1>Notify Name 1</name1>
<name2>Notify Name 2</name2>
<vatNo>Notify_VAT</vatNo>
<customsId>Notify_CustomsId</customsId>
<email>Notify.General.Email@test.com</email>
<locationType>PHYSICAL</locationType>
<mobilePhone>555-12345</mobilePhone>
<personType>COMPANY</personType>
<phone>123-456-789</phone>
<postalCode>56789</postalCode>
<schenkerAddressId>SchenkerAddressId_123</schenkerAddressId>
<street>Notify Street</street>
<city>Notify City</city>
<countryCode>DE</countryCode>
<type>NOTIFY</type>
</address>
<address>
<contactPerson>
<email>Invoice.Contact.Email@test.com</email>
</contactPerson>
<name1>Invoice Name 1</name1>
<name2>Invoice Name 2</name2>
<vatNo>Invoice_VAT</vatNo>
<customsId>Invoice_CustomsId</customsId>
<email>Invoice.General.Email@test.com</email>
<locationType>PHYSICAL</locationType>
<mobilePhone>555-12345</mobilePhone>
<personType>COMPANY</personType>
<phone>123-456-789</phone>
<postalCode>67890</postalCode>
<schenkerAddressId>SchenkerAddressId_123</schenkerAddressId>
<street>Invoice Street</street>
<city>Invoice City</city>
<countryCode>DE</countryCode>
<type>INVOICE</type>
</address>
<incoterm>EXW</incoterm>
<incotermLocation>IncotermLocation</incotermLocation>
<productCode>lcl</productCode>
<measurementType>METRIC</measurementType>
<cargoDescription>GeneralCargoDescription</cargoDescription>
<cargoInsurance>
<value>9999.99</value>
<currency>EUR</currency>
</cargoInsurance>
<customsClearance>false</customsClearance>
<customsClearanceEu>false</customsClearanceEu>
<grossWeight>1000</grossWeight>
<indoorDelivery>false</indoorDelivery>
<pickupDates>
<pickUpDateFrom>2099-01-30T09:00:00.000+00:00</pickUpDateFrom>
<pickUpDateTo>2099-01-30T18:00:00.000+00:00</pickUpDateTo>
</pickupDates>
<reference>
<number>ShipperReference_123</number>
<id>SHIPPER_REFERENCE_NUMBER</id>
</reference>
<reference>
<number>ConsigneeReference_123</number>
<id>CONSIGNEE_REFERENCE_NUMBER</id>
</reference>
<handlingInstructions>HandlingInstructions_ABC</handlingInstructions>
<neutralShipping>false</neutralShipping>
<specialCargo>false</specialCargo>
<valueOfGoods>
<value>9999.99</value>
<currency>EUR</currency>
</valueOfGoods>
<ecoNeutral>true</ecoNeutral>
<serviceType>P2P</serviceType>
<shippingInformation>
<shipmentPosition>
<dgr>false</dgr>
<cargoDesc>Shipping Line 1</cargoDesc>
<volume>4</volume>
<grossWeight>400</grossWeight>
<packageType>EP</packageType>
<pieces>3</pieces>
<stackable>true</stackable>
</shipmentPosition>
<shipmentPosition>
<dgr>false</dgr>
<cargoDesc>Shipping Line 2</cargoDesc>
<volume>12</volume>
<grossWeight>600</grossWeight>
<packageType>CI</packageType>
<pieces>5</pieces>
<stackable>false</stackable>
</shipmentPosition>
<grossWeight>1000</grossWeight>
<volume>16</volume>
</shippingInformation>
<portDischarge>DEHAM</portDischarge>
<portLoading>DEHAM</portLoading>
<precarriageType>PICKUP_REQUEST</precarriageType>
<latestDeliveryDate>2099-01-30T09:00:00.000+00:00</latestDeliveryDate>
</bookingOceanLCL>
</in>
</v1:getBookingRequestOceanLCL>
</soapenv:Body>
</soapenv:Envelope>SOAP request schema for Ocean LCL.
| Field Name | Data Type | Mandatory | Cardinality | Description |
|---|---|---|---|---|
<applicationArea> |
applicationAreaType | yes | 1..1 | |
<accessKey>?</accessKey> |
string(100) | yes | 1..1 | Defines the access key (user token). |
<groupId>?</groupId> |
unsignedLong | no | 0..1 | Defines the optional user group id. |
<requestID>?</requestID> |
string(500) | no | 0..1 | Defines the request id which will be returned with the response message. |
<userId>?</userId> |
string | no | 0..1 | Defines the user id for which the booking should be done. |
<groupName>?</groupName> |
string | no | 0..1 | Defines the user group name for which the booking should be done. |
<uniqueIdBlocker>?</uniqueIdBlocker> |
string | no | 0..1 | Defines the unique id blocker. |
<bookingOceanLCL |
bookingType | yes | 1..1 | |
submitBooking="?" |
boolean | yes | 1..1 | Defines if the booking shall be submitted. If false, the booking can be edited in the frontend and must be submitted manually. |
updateBooking="?" |
string | yes | 1..1 | Defines the booking to be updated. Takes a booking id as parameter. |
readyForConsolidation="?" |
boolean | no | 0..1 | Prepares the booking for later consolidation. |
returnBarcodeReferences="?"> |
boolean | no | 0..1 | Defines if the barcode references are returned in the response message. |
<barcodeRequest> |
barcodeRequestType | no | 0..1 | Option to request the barcode label for the booking. |
start_pos="?" |
positiveInt | yes, if barcodeRequest is provided | 1..1 | Defines the starting position quadrant |
separated="?" |
boolean | yes, if barcodeRequest is provided | 1..1 | Defines if the label is printed on separate pages. |
directThermalMedia="?" |
boolean | no | 0..1 | Defines if direct thermal printing is requested. |
?</barcodeRequest> |
enumeration | yes, if barcodeRequest is provided | 1..1 | Defines the label format. |
<barcodeRequestEmail> |
barcodeRequestEmailType | no | 0..1 | Option to send the barcode labels to defined email addresses. |
<email>?</email> |
string(250) | yes, if barcodeRequestEmail is provided | 1..25 | Defines the list of email addresses. |
<address> |
addressType | yes | 2..6 | Defines the list of addresses. |
<contactPerson> |
contactPersonType | no | 0..n | Defines the contact person details. |
<name>?</name> |
string(100) | no | 0..1 | Defines the name of the contact person. |
<phone>?</phone> |
string(100) | no | 0..1 | Defines the phone number of the contact person. |
<email>?</email> |
string(100) | no | 0..1 | Defines the email address of the contact person. |
<name1>?</name1> |
string(500) | yes | 1..1 | Defines the name. |
<name2>?</name2> |
string(500) | no | 0..1 | Defines the additional name. |
<customerAddressIdentifier>?</customerAddressIdentifier> |
string(100) | no | 0..1 | Defines the customer address identifier. |
<vatNo>?</vatNo> |
string(100) | no | 0..1 | Defines the customer VAT number. |
<customsId>?</customsId> |
string(100) | no | 0..1 | Defines the customs id. |
<email>?</email> |
string(250) | no | 0..1 | Defines the email address. |
<fax>?</fax> |
string(250) | no | 0..1 | Defines the fax number. |
<industry>?</industry> |
enumeration | no | 0..1 | Defines the industry. |
<locationType>?</locationType> |
enumeration | yes | 1..1 | Defines the location type. |
<mobilePhone>?</mobilePhone> |
string(250) | no | 0..1 | Defines the mobile phone number. |
<personType>?</personType> |
enumeration | yes | 1..1 | Defines the person type. |
<phone>?</phone> |
string(250) | no | 0..1 | Defines the phone number. |
<poBox>?</poBox> |
string(50) | no | 0..1 | Defines the PO box. |
<postalCode>?</postalCode> |
string(20) | no* | 0..1 | Defines the postal code. *= The postal code is mandatory for most countries. |
<stateCode>?</stateCode> |
string(5) | no | 0..1 | Defines the state code. |
<stateName>?</stateName> |
string(35) | no | 0..1 | Defines the state name. |
<preferredLanguage>?</preferredLanguage> |
string(10) | no | 0..1 | Defines the preferred language. |
<schenkerAddressId>?</schenkerAddressId> |
string(36) | no | 0..1 | Defines the Schenker address id. |
<street>?</street> |
string(1000) | yes | 1..1 | Defines the street name. |
<street2>?</street2> |
string(1000) | no | 0..1 | Defines the additional street name. |
<city>?</city> |
string(500) | yes | 1..1 | Defines the city name. |
<countryCode>?</countryCode> |
string(10) | yes | 1..1 | Defines the country code. |
<type>?</type> |
enumeration | yes | 1..1 | Defines the address type. SHIPPER and CONSIGNEE addresses are mandatory. |
<incoterm>?</incoterm> |
enumeration | yes | 1..1 | Defines the incoterm. |
<incotermLocation>?</incotermLocation> |
string(250) | yes | 1..1 | Defines the incoterm location. |
<productCode>?</productCode> |
string(10) | yes | 1..1 | Defines the product. |
<productOption>?</productOption> |
string(10) | no | 0..1 | Defines the time critical product option. |
<measurementType>?</measurementType> |
enumeration | yes | 1..1 | Defines the measurement type. |
<cargoDescription>?</cargoDescription> |
string(1000) | no | 0..1 | Defines the cargo description. |
<cargoInsurance> |
cargoInsuranceType | no | 0..1 | Defines the cargo insurance. |
<value>?</value> |
string(10,2) | yes, if cargoInsurance is provided | 1..1 | Defines the cargo insurance value. |
<currency>?</currency> |
string(3) | yes, if cargoInsurance is provided | 1..1 | Defines the cargo insurance currency. |
<cashOnDelivery> |
cashOnDeliveryType | no | 0..1 | Defines the cash on delivery. |
<value>?</value> |
string(10,2) | yes, if cashOnDelivery is provided | 1..1 | Defines the cash on delivery value. |
<currency>?</currency> |
string(3) | yes, if cashOnDelivery is provided | 1..1 | Defines the cash on delivery currency. |
<customsClearance>?</customsClearance> |
boolean | yes | 1..1 | Defines if customs clearance is required. |
<customsClearanceEu>?</customsClearanceEu> |
boolean | yes* | 0..1 | Defines if customs clearance EU is required. *= This field must be provided in case of customs clearance in European land transport. |
<exportCustomsDeclarant> |
exportCustomsDeclarantType | no | 0..1 | Defines the export customs declarant. |
<type>?</type> |
enumeration | yes, if exportCustomsDeclarant is provided | 1..1 | Defines the export customs declarant type. |
<declarantInformation> |
declarantInformationType | no | Defines the export customs declarant information. | |
<companyName>?</companyName> |
string(35) | no | 0..1 | Defines the company name. |
<street>?</street> |
string(35) | no | 0..1 | Defines the street name. |
<postalCode>?</postalCode> |
string(10) | no | 0..1 | Defines the postal code. |
<city>?</city> |
string(35) | no | 0..1 | Defines the city name. |
<countryCode>?</countryCode> |
string(10) | no | 0..1 | Defines the country code. |
<phone>?</phone> |
string(250) | no | 0..1 | Defines the phone number. |
<email>?</email> |
string(25) | no | 0..1 | Defines the email address. |
<importCustomsDeclarant> |
importCustomsDeclarantType | no | Defines the import customs declarant. | |
<type>?</type> |
enumeration | yes, if importCustomsDeclarant is provided | 1..1 | Defines the import customs declarant type. |
<declarantInformation> |
declarantInformationType | no | Defines the import customs declarant information. | |
<companyName>?</companyName> |
string(35) | no | 0..1 | Defines the company name. |
<street>?</street> |
string(35) | no | 0..1 | Defines the street name. |
<postalCode>?</postalCode> |
string(10) | no | 0..1 | Defines the postal code. |
<city>?</city> |
string(35) | no | 0..1 | Defines the city name. |
<countryCode>?</countryCode> |
string(10) | no | 0..1 | Defines the country code. |
<phone>?</phone> |
string(250) | no | 0..1 | Defines the phone number. |
<email>?</email> |
string(25) | no | 0..1 | Defines the email address. |
<file> |
fileType | no | 0..n | Defines the list of files. |
<fileSizeBytes>?</fileSizeBytes> |
int | yes | 1..1 | Defines the file size in bytes. |
<name>?</name> |
string(250) | no | 0..1 | Defines the file name. |
<type>?</type> |
string(5) | no | 0..1 | Defines the file type. |
<typeOfDocument>?</typeOfDocument> |
enumeration | no | 0..1 | Defines the type of documentation. |
<data>?</data> |
string | no | 0..1 | Defines the Base64 data. |
<grossWeight>?</grossWeight> |
string(5,2) | yes | 1..1 | Defines the total gross weight. |
<indoorDelivery>?</indoorDelivery> |
boolean | yes | 1..1 | Defines if indoor delivery is required. |
<pickupDates> |
pickupDatesType | yes | 1..1 | Defines the pickup dates. |
<pickUpDateFrom>?</pickUpDateFrom> |
dateTime | yes | 1..1 | Defines the start pickup time. |
<pickUpDateTo>?</pickUpDateTo> |
dateTime | yes | 1..1 | Defines the end pickup time. |
<reference> |
referenceType | no | 0..n | Defines the references. |
<number>?</number> |
string(100) | yes, if reference is provided | 1..1 | Defines the reference number. |
<id>?</id> |
string(100) | yes, if reference is provided | 1..1 | Defines the reference type. |
<handlingInstructions>?</handlingInstructions> |
string(2000) | no | 0..1 | Defines the handling instructions. |
<neutralShipping>?</neutralShipping> |
boolean | yes | 1..1 | Defines the business scenario in which the customer sends a booking request in the name of the ordering party. |
<specialCargo>?</specialCargo> |
boolean | yes | 1..1 | Defines if special cargo is required. |
<specialCargoDescription>?</specialCargoDescription> |
string(1000) | no | 0..1 | Defines the special cargo description. |
<valueOfGoods> |
valueOfGoodsType | no | 0..1 | Defines the value of goods. |
<value>?</value> |
string(10,2) | yes, if valueOfGoods is provided | 1..1 | Defines the cargo insurance value. |
<currency>?</currency> |
string(3) | yes, if valueOfGoods is provided | 1..1 | Defines the cargo insurance currency. |
<wayBillNumber>?</wayBillNumber> |
string(100) | no | 0..1 | Defines the waybill number. |
<barcodeReference> |
barcodeReferenceType | no | 0..n | Defines the barcode references. |
<barcode>?</barcode> |
string(100) | yes, if barcodeReference is provided | 1..1 | Defines the barcode value. |
<barcodeType>?</barcodeType> |
string(30) | yes, if barcodeReference is provided | 1..1 | Defines the barcode type. Only allowed value = SSCC. |
<ecoNeutral>?</ecoNeutral> |
boolean | no | 0..1 | Defines if the shipment is eco neutral. |
<serviceType>?</serviceType> |
enumeration | yes | 1..1 | Defines the service type. |
<shippingInformation> |
shippingInformationType | yes | 1..1 | Defines the shipping information. |
<shipmentPosition> |
shipmentPositionType | yes | 1..n | Defines the shipping position. |
<dangerousGoods> |
dangerousGoodsType | no | 0..n | Defines the dangerous goods. |
<pieces>?</pieces> |
positiveInt | yes, if dangerousGoods is provided | 1..1 | Defines the amount of pieces. |
<packageType>?</packageType> |
string(50) | yes, if dangerousGoods is provided | 1..1 | Defines the package type. |
<weightType>?</weightType> |
enumeration | yes, if dangerousGoods is provided | 1..1 | Defines the weight type. |
<weight>?</weight> |
string | yes, if dangerousGoods is provided | 1..1 | Defines the weight. |
<weightBasis>?</weightBasis> |
string | no | 0..1 | Defines the weight basis. |
<subitems> |
dangerousGoodsUnNoType | yes, if dangerousGoods is provided | 1..n | Defines the dangerous goods UN information. |
<unNo>?</unNo> |
string(4) | yes, if subitems is provided | 1..1 | Defines the dangerous goods UN number. |
<labelType>?</labelType> |
string(10) | yes, if subitems is provided | 1..1 | Defines the label type. |
<packageGroup>?</packageGroup> |
enumeration | yes, if subitems is provided | 1..1 | Defines the package group. |
<shippingName>?</shippingName> |
string(250) | yes, if subitems is provided | 1..1 | Defines the shipping name. |
<technicalName>?</technicalName> |
string(250) | no | 0..1 | Defines the technical name. |
<specialProvision>?</specialProvision> |
string(250) | no | 0..1 | Defines the special provision. |
<tunnelCode>?</tunnelCode> |
string(10) | no | 0..1 | Defines the tunnel code. |
<waste>?</waste> |
boolean | yes, if subitems is provided | 1..1 | Defines if dangerous goods is waste. |
<europeanWasteCode>?</europeanWasteCode> |
string | no | 0..1 | Defines the European waste code (if waste is set to true). |
<NEM>?</NEM> |
string | no | 0..1 | Defines the net explosive mass weight. |
<transportCategory>?</transportCategory> |
int | no | 0..1 | Defines the transport category. |
<exceptedQuantities>?</exceptedQuantities> |
boolean | yes, if subitems is provided | 1..1 | Defines if dangerous goods is excepted quantity. |
<limitedQuantity>?</limitedQuantity> |
boolean | yes, if subitems is provided | 1..1 | Defines if dangerous goods is limited quantity. |
<emptyUncleanedPackages>?</emptyUncleanedPackages> |
boolean | no | 0..1 | Defines if dangerous goods is of empty uncleaned packages. |
<marinePollutant>?</marinePollutant> |
boolean | yes, if subitems is provided | 1..1 | Defines if dangerous goods is marine pollutant. |
<subRisk1>?</subRisk1> |
boolean | no | 0..1 | Defines the sub risk 1. |
<subRisk2>?</subRisk2> |
boolean | no | 0..1 | Defines the sub risk 2. |
<subRisk3>?</subRisk3> |
boolean | no | 0..1 | Defines the sub risk 3. |
<fireworkClassification> |
fireworkClassificationType | no | 0..1 | Defines the firework classification. |
<countryCode>?</countryCode> |
string(10) | yes, if fireworkClassification is provided | 1..1 | Defines the country code. |
<reference>?</reference> |
string(100) | yes, if fireworkClassification is provided | 1..1 | Defines the firework classification reference. |
<dgr>?</dgr> |
boolean | yes | 1..1 | Defines if dangerous goods is required. |
<cargoDesc>?</cargoDesc> |
string(500) | yes | 1..1 | Defines the cargo description. |
<length>?</length> |
string(10,2) | no | 0..1 | Defines the length. |
<width>?</width> |
string(10,2) | no | 0..1 | Defines the width. |
<height>?</height> |
string(10,2) | no | 0..1 | Defines the height. |
<volume>?</volume> |
string(10,2) | yes | 1..1 | Defines the volume. |
<grossWeight>?</grossWeight> |
string(10,2) | yes | 1..1 | Defines the gross weight. |
<marksAndNumbers>?</marksAndNumbers> |
string(500) | no | 0..1 | Defines the marks and numbers. |
<hsCode>?</hsCode> |
string(13) | no | 0..1 | Defines the hs code. |
<packageLine> |
packageLineType | no | 0..n | Defines the pakage line. |
<cargoDesc>?</cargoDesc> |
string(500) | no | 0..1 | Defines the cargo description. |
<length>?</length> |
string(10,2) | no | 0..1 | Defines the length. |
<width>?</width> |
string(10,2) | no | 0..1 | Defines the width. |
<height>?</height> |
string(10,2) | no | 0..1 | Defines the height. |
<volume>?</volume> |
string(10,2) | no | 0..1 | Defines the volume. |
<grossWeight>?</grossWeight> |
string(10,2) | no | 0..1 | Defines the gross weight. |
<packageType>?</packageType> |
string(50) | yes | 1..1 | Defines the package type. |
<pieces>?</pieces> |
positiveInt | yes | 1..1 | Defines the amount of pieces. |
<stackable>?</stackable> |
boolean | yes | 1..1 | Defines if the shipping position is stackable. |
<grossWeight>?</grossWeight> |
string(10,2) | yes | 0..1 | Defines the gross weight. |
<volume>?</volume> |
string(10,2) | yes | 1..1 | Defines the volume. |
<portDischarge>?</portDischarge> |
string(5) | yes* | 0..1 | Defines the port of discharge. *= This field must be provided if the service type is D2P or P2P. |
<portLoading>?</portLoading> |
string(5) | yes* | 0..1 | Defines the port of loading. *= This field must be provided if the service type is P2D or P2P. |
<precarriageType>?</precarriageType> |
enumeration | no | 0..1 | Defines the precarriage type. |
<latestDeliveryDate>?</latestDeliveryDate> |
dateTime | yes | 0..1 | Defines the latest delivery date. |
SOAP response schema for Ocean LCL.
| Field Name | Data Type | Mandatory | Cardinality | Description |
|---|---|---|---|---|
<applicationArea> |
applicationAreaType | yes | 1..1 | |
<requestID>?</requestID> |
string(500) | no | 0..1 | Defines the request id which if it was provided in the request message. |
<bookingId>?</bookingId> |
string(13) | yes | 1..1 | Defines the generated eSchenker booking id. |
<barcodeReference> |
barcodeReferenceType | no | Defines the list of barcode references. | |
<barcode>?</barcode> |
no | Defines the barcode. | ||
<barcodeType>?</barcodeType> |
no | Defines the barcode type. | ||
<barcodeDocument>?</barcodeDocument> |
no | Defines the barcode document in base 64 binary format. |