🥇 The First Shipment
Prepared calls for copy/paste in your development environment
To allow you to start quickly, here you will find a complete call to create a shipment and receive a typical response.
Creating a shipment
You can use the example and copy/paste it into your favorite tool to test SOAP and/or REST API calls. Our test environment is prepared to work with the data in this example.
Why don't you just give it a quick try?
This is an example createShipment call for a domestic shipment. You can find it in your test client with the shipment number 1000001:
{
"clientSystemId": "Carrier Connect Client Name",
"clientIdentCode": "Host System Name",
"userName": "User Name",
"resultLanguageIsoCodes": [
"de"
],
"creationParms": {
"creationMode": "VALIDATION_OK"
},
"processParms": {
"processMode": {
"mode": "EXTENDED"
},
"documentPrepareScope": {
"scope": "ALL"
},
"workstationId": "ZPL203_A4LASER",
"documentOutputScope": {
"scope": "ALL"
},
"documentOutputMode": {
"mode": "RETURN"
},
"doCompletion": true
},
"shipment": {
"transactionId": "516513219",
"referenceNumber1": "1000001",
"carrierIdentCode": "GENERICCARRIER",
"serviceCode": "STD",
"termsOfDeliveryCode": "EXW",
"contents": "spare parts",
"shippingDate": "2025-01-10",
"shippingPt": {
"city": "Stuttgart",
"companyNumber": "1000",
"countryISOCode": "DE",
"name": "AEB SE",
"postcode": "70567",
"street": "Sigmaringer Straße 109"
},
"shippingPtContact": {
"name": "AEB Support",
"phone": "+49 711 72842 110"
},
"consignee": {
"city": "München",
"companyNumber": "2000",
"countryISOCode": "DE",
"name": "AEB München",
"postcode": "81249",
"street": "Franz-Josef-Delonge-Strasse 7"
},
"consigneeContact": {
"name": "AEB Empfang München",
"phone": "0891490267-0"
},
"goodsValue": {
"currencyIso": "EUR",
"value": 1000
},
"items": [
{
"itemTransactionId": "100015681352",
"referenceNumber1": "1000-1",
"description": "Item #1 description",
"goodsValue": {
"currencyIso": "EUR",
"value": 100
},
"grossWeight": {
"unit": "kg",
"value": 6
},
"quantity": {
"unit": "St",
"value": 10
}
}
],
"packages": [
{
"packageTransactionId": "77702167",
"packageTypeIdentCode": "PAL",
"grossWeight": {
"unit": "kg",
"value": 6.25
},
"dimensions": {
"length": 10,
"width": 10,
"height": 10,
"identCode": "cm"
}
}
]
}
}
<clientSystemId>Carrier Connect Client Name</clientSystemId>
<clientIdentCode>Host System Name</clientIdentCode>
<userName>User Name</userName>
<resultLanguageIsoCodes>
<isoCode>de</isoCode>
</resultLanguageIsoCodes>
<creationParms>
<creationMode>VALIDATION_OK</creationMode>
</creationParms>
<processParms>
<processMode>
<mode>EXTENDED</mode>
</processMode>
<documentPrepareScope>
<scope>ALL</scope>
</documentPrepareScope>
<workstationId>ZPL203_A4LASER</workstationId>
<documentOutputScope>
<scope>ALL</scope>
</documentOutputScope>
<documentOutputMode>
<mode>RETURN</mode>
</documentOutputMode>
<doCompletion>true</doCompletion>
</processParms>
<shipment>
<transactionId>516513219</transactionId>
<referenceNumber1>1000001</referenceNumber1>
<carrierIdentCode>GENERICCARRIER</carrierIdentCode>
<serviceCode>STD</serviceCode>
<termsOfDeliveryCode>EXW</termsOfDeliveryCode>
<contents>spare parts</contents>
<shippingDate>2025-01-10</shippingDate>
<shippingPt>
<city>Stuttgart</city>
<companyNumber>1000</companyNumber>
<countryISOCode>DE</countryISOCode>
<name>AEB SE</name>
<postcode>70567</postcode>
<street>Sigmaringer Straße 109</street>
</shippingPt>
<shippingPtContact>
<name>AEB Support</name>
<phone>+49 711 72842 110</phone>
</shippingPtContact>
<consignee>
<city>München</city>
<companyNumber>2000</companyNumber>
<countryISOCode>DE</countryISOCode>
<name>AEB München</name>
<postcode>81249</postcode>
<street>Franz-Josef-Delonge-Strasse 7</street>
</consignee>
<consigneeContact>
<name>AEB Empfang München</name>
<phone>0891490267-0</phone>
</consigneeContact>
<goodsValue>
<currencyIso>EUR</currencyIso>
<value>1000</value>
</goodsValue>
<items>
<item>
<itemTransactionId>100015681352</itemTransactionId>
<referenceNumber1>1000-1</referenceNumber1>
<description>Item #1 description</description>
<goodsValue>
<currencyIso>EUR</currencyIso>
<value>100</value>
</goodsValue>
<grossWeight>
<unit>kg</unit>
<value>6</value>
</grossWeight>
<quantity>
<unit>St</unit>
<value>10</value>
</quantity>
</item>
</items>
<packages>
<package>
<packageTransactionId>77702167</packageTransactionId>
<packageTypeIdentCode>PAL</packageTypeIdentCode>
<grossWeight>
<unit>kg</unit>
<value>6.25</value>
</grossWeight>
<dimensions>
<length>10</length>
<width>10</width>
<height>10</height>
<identCode>cm</identCode>
</dimensions>
</package>
</packages>
</shipment>
And here another example. This time for a third country shipment. You can find it in your test client with the shipment number 1000000:
{
"clientSystemId": "Carrier Connect Client Name",
"clientIdentCode": "Host System Name",
"userName": "User Name",
"resultLanguageIsoCodes": [
"de"
],
"creationParms": {
"creationMode": "VALIDATION_OK"
},
"processParms": {
"processMode": {
"mode": "EXTENDED"
},
"documentPrepareScope": {
"scope": "ALL"
},
"workstationId": "ZPL203_A4LASER",
"documentOutputScope": {
"scope": "ALL"
},
"documentOutputMode": {
"mode": "RETURN"
},
"doCompletion": true
},
"shipment": {
"transactionId": "516513218",
"referenceNumber1": "1000000",
"carrierIdentCode": "GENERICCARRIER",
"serviceCode": "STD",
"termsOfDeliveryCode": "EXW",
"contents": "spare parts",
"shippingDate": "2025-01-10",
"shippingPt": {
"city": "Stuttgart",
"companyNumber": "1000",
"countryISOCode": "DE",
"name": "AEB SE",
"postcode": "70567",
"street": "Sigmaringer Straße 109"
},
"shippingPtContact": {
"name": "AEB Support",
"phone": "+49 711 72842 110"
},
"consignee": {
"city": "Zürich",
"companyNumber": "3000",
"countryISOCode": "CH",
"name": "AEB Schweiz AG",
"postcode": "8005",
"street": "Sihlquai 131"
},
"consigneeContact": {
"name": "AEB Empfang Schweiz",
"phone": "+41 43 211 1060"
},
"customsValue": {
"currencyIso": "EUR",
"value": 1050
},
"goodsValue": {
"currencyIso": "EUR",
"value": 1000
},
"items": [
{
"itemTransactionId": "100015681351",
"referenceNumber1": "1000-1",
"description": "Item #1 description",
"countryOfOriginsISOCode": "DE",
"customsTariffNumber": 82054000,
"customsValue": {
"currencyIso": "EUR",
"value": 105
},
"goodsValue": {
"currencyIso": "EUR",
"value": 100
},
"grossWeight": {
"unit": "kg",
"value": 6
},
"quantity": {
"unit": "St",
"value": 10
}
}
],
"packages": [
{
"packageTransactionId": "77702165",
"packageTypeIdentCode": "CT",
"grossWeight": {
"unit": "kg",
"value": 6.25
},
"dimensions": {
"length": 10,
"width": 10,
"height": 10,
"identCode": "cm"
}
}
],
"referencesTexts": [
{
"type": "CUSTOMS_REGISTRATION_NUMBER",
"value": "MRN123456789"
},
{
"type": "INVOICE_NUMBER",
"value": "INV123456789"
}
]
}
}
<clientSystemId>Carrier Connect Client Name</clientSystemId>
<clientIdentCode>Host System Name</clientIdentCode>
<userName>User Name</userName>
<resultLanguageIsoCodes>
<isoCode>de</isoCode>
</resultLanguageIsoCodes>
<creationParms>
<creationMode>VALIDATION_OK</creationMode>
</creationParms>
<processParms>
<processMode>
<mode>EXTENDED</mode>
</processMode>
<documentPrepareScope>
<scope>ALL</scope>
</documentPrepareScope>
<workstationId>ZPL203_A4LASER</workstationId>
<documentOutputScope>
<scope>ALL</scope>
</documentOutputScope>
<documentOutputMode>
<mode>RETURN</mode>
</documentOutputMode>
<doCompletion>true</doCompletion>
</processParms>
<shipment>
<transactionId>516513218</transactionId>
<referenceNumber1>1000000</referenceNumber1>
<carrierIdentCode>GENERICCARRIER</carrierIdentCode>
<serviceCode>STD</serviceCode>
<termsOfDeliveryCode>EXW</termsOfDeliveryCode>
<contents>spare parts</contents>
<shippingDate>2025-01-10</shippingDate>
<shippingPt>
<city>Stuttgart</city>
<companyNumber>1000</companyNumber>
<countryISOCode>DE</countryISOCode>
<name>AEB SE</name>
<postcode>70567</postcode>
<street>Sigmaringer Straße 109</street>
</shippingPt>
<shippingPtContact>
<name>AEB Support</name>
<phone>+49 711 72842 110</phone>
</shippingPtContact>
<consignee>
<city>Zürich</city>
<companyNumber>3000</companyNumber>
<countryISOCode>CH</countryISOCode>
<name>AEB Schweiz AG</name>
<postcode>8005</postcode>
<street>Sihlquai 131</street>
</consignee>
<consigneeContact>
<name>AEB Empfang Schweiz</name>
<phone>+41 43 211 1060</phone>
</consigneeContact>
<customsValue>
<currencyIso>EUR</currencyIso>
<value>1050</value>
</customsValue>
<goodsValue>
<currencyIso>EUR</currencyIso>
<value>1000</value>
</goodsValue>
<items>
<item>
<itemTransactionId>100015681351</itemTransactionId>
<referenceNumber1>1000-1</referenceNumber1>
<description>Item #1 description</description>
<countryOfOriginsISOCode>DE</countryOfOriginsISOCode>
<customsTariffNumber>82054000</customsTariffNumber>
<customsValue>
<currencyIso>EUR</currencyIso>
<value>105</value>
</customsValue>
<goodsValue>
<currencyIso>EUR</currencyIso>
<value>100</value>
</goodsValue>
<grossWeight>
<unit>kg</unit>
<value>6</value>
</grossWeight>
<quantity>
<unit>St</unit>
<value>10</value>
</quantity>
</item>
</items>
<packages>
<package>
<packageTransactionId>77702165</packageTransactionId>
<packageTypeIdentCode>CT</packageTypeIdentCode>
<grossWeight>
<unit>kg</unit>
<value>6.25</value>
</grossWeight>
<dimensions>
<length>10</length>
<width>10</width>
<height>10</height>
<identCode>cm</identCode>
</dimensions>
</package>
</packages>
<referencesTexts>
<referenceText>
<type>CUSTOMS_REGISTRATION_NUMBER</type>
<value>MRN123456789</value>
</referenceText>
<referenceText>
<type>INVOICE_NUMBER</type>
<value>INV123456789</value>
</referenceText>
</referencesTexts>
</shipment>
Receiving an error
Below is an API call which will return an error. This will demonstrate the structure of an error response and will allow you to become familiar with the general behavior.
You will receive this message once you remove clientSystemId from the above request.
{
"hasErrors":"true",
"hasOnlyRetryableErrors":"false",
"hasWarnings":"false",
"messages":{
"messageType":"ERROR",
"messageIdentCode":"EMPTY_MANDATORY_FIELD",
"messageTexts":{
"languageISOCode":"en",
"text":"Client system id not filled."
},
"indentationLevel":"0"
}
}
<createShipmentResponse>
<result>
<hasErrors>true</hasErrors>
<hasOnlyRetryableErrors>false</hasOnlyRetryableErrors>
<hasWarnings>false</hasWarnings>
<messages>
<messageType>ERROR</messageType>
<messageIdentCode>EMPTY_MANDATORY_FIELD</messageIdentCode>
<messageTexts>
<languageISOCode>en</languageISOCode>
<text>Client system id not filled.</text>
</messageTexts>
<indentationLevel>0</indentationLevel>
</messages>
</result>
</createShipmentResponse>
Updated about 1 month ago
What’s Next