HomeGuidesAPI ReferenceChangelogAEB Transport & Freight ManagementLegal Notice
Guides

🌱 Create

Learn how to use the Carrier Connect API calls to programmatically CREATE new shipments or pickups.

Suggest Edits

createShipment: Create a new shipping order

The createShipment call enables you to generate a new shipping order using the data provided in the shipment request.

📘

Be aware, that if the shipment already exists, an error will be returned.

Furthermore, you can choose to apply various operations to the shipment, such as label preparation and output. It is even possible to complete the entire processing, including the assignment of a pickup.

{
	"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>

Completing the shipment

If you want to close/complete a shipment, you have to set the doCompletion parameter to true. In order to assign a shipment to a pickup it has to be closed/completed.

createPickup: Create a new pickup

The createPickup call allows you to generate a new pickup for the shipments specified in your request.

💡

Certain conditions result in error

Please note, that certain conditions may result in an error, for example, when the shipments cannot be combined into a single pickup due to different carriers being involved.

Additionally, you have the option to manifest the new pickup. This process involves sending the necessary EDI to the carrier and subsequently closing the pickup. If specified in the request, manifest documents will be printed.

{
  "clientSystemId": "YOUR_SYSTEM_ID",
  "clientIdentCode": "CCO_TEMPL",
  "userName": "WSM",
  "resultLanguageIsoCodes": [
    "en"
  ],
  "creationParms": {
    "creationMode": "ONLY_VALID_SHIPMENTS"
  },
  "pickup": {
    "transactionId": "2000006190",
    "referenceNumber1": "2000006190",
    "carrierIdentCode": "GENERICCARRIER",
    "shippingDate": "20230727",
    "shippingPt": {
       "companyNumber": "V1",
       "initFromCompanyMasterFileData": "true"
    },
    "shipments": [
      {
        "referenceNumber1": "1001"
      },
      {
        "referenceNumber1": "1002"
      },
    ]
  },
  "processParms": {
    "doManifest": false,
    "documentOutputMode": {
      "mode": "RETURN"
    },
    "workstationId": "PDF"
  }
}

<clientSystemId>YOUR_SYSTEM_ID</clientSystemId>
<clientIdentCode>CCO_TEMPL</clientIdentCode>
<userName>WSM</userName>
<resultLanguageIsoCodes>
  <isoCode>en</isoCode>
</resultLanguageIsoCodes>
<creationParms>
  <creationMode>ONLY_VALID_SHIPMENTS</creationMode>
</creationParms>
<pickup>
  <transactionId>2000006190</transactionId>
  <referenceNumber1>2000006190</referenceNumber1>
  <carrierIdentCode>GENERICCARRIER</carrierIdentCode>
  <shippingDate>20230727</shippingDate>
  <shippingPt>
    <companyNumber>V1</companyNumber>
    <initFromCompanyMasterFileData>true</initFromCompanyMasterFileData>
  </shippingPt>
  <shipments>
    <shipment>
      <referenceNumber1>1001</referenceNumber1>
    </shipment>
    <shipment>
      <referenceNumber1>1002</referenceNumber1>
    </shipment>
  </shipments>
</pickup>
<processParms>
  <doManifest>false</doManifest>
  <documentOutputMode>
    <mode>RETURN</mode>
  </documentOutputMode>
  <workstationId>PDF</workstationId>
</processParms>

Updated about 1 month ago

What’s Next

For more in depth information about specific sections of the API have a look at: