API Dokumentation
Auftragsübermittlung
URL
https://www.cargointernational.de/api/shipping/new_order
Request Parameter
Variable | Typ | Info | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
userid | int(10) |
Pflicht (Kundennummer) |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
password | varchar(40) |
Pflicht API Passwort dieses können Sie hier generieren: https://www.cargointernational.de/dashboard/kd-api-key (nur aufrufbar, wenn Sie eingeloggt sind) |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
submit | price | go |
Pflicht price = erzeugt den gleichen Output wie go, nur, dass kein Auftrag ausgeführt wird. Kann zum Testen der API benutzt werden. go = wird ausgeführt |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
picup_company | varchar(35) | Optional | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
picup_firstname | varchar(35) | Pflicht | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
picup_lastname | varchar(35) | Pflicht | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
picup_street | varchar(35) | Pflicht | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
picup_postal | varchar(5) | Pflicht | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
picup_city | varchar(35) | Pflicht | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
picup_country | varchar(2) |
Aktuell wird nur ein Deutschland und Österreich Versand über die API angeboten, außer bei Parameter Angabe "carrier" DSV und UPS (Kleinpaket). Mehr hierzu unter dem Parameter "carrier" Optional Standard: DE (für Deutschland) Standard: AT (für Österreich) Länderangabe in ISO 3166 ALPHA-2 |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
picup_phone | varchar(35) | Optional | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
picup_email | varchar(255) | Optional | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
unload_company | varchar(35) | Optional | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
unload_firstname | varchar(35) | Pflicht | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
unload_lastname | varchar(35) | Pflicht | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
unload_street | varchar(35) | Pflicht | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
unload_postal | varchar(35) | Pflicht | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
unload_city | varchar(5) | Pflicht | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
unload_country | varchar(2) |
Aktuell wird nur ein Deutschland und Österreich Versand über die API angeboten, außer bei Parameter Angabe "carrier" DSV. Mehr hierzu unter dem Parameter "carrier" Optional Standard: DE (für Deutschland) Standard: AT (für Österreich) Länderangabe in ISO 3166 ALPHA-2 |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
unload_phone | varchar(35) | Optional | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
unload_email | varchar(255) | Optional | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
versandart |
Großpaket Sperrgut Einwegpalette Europalette Kleinpaket |
Pflicht | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
length [0] | int(3) |
Pflicht Angabe mehrere Packstücke: [0] = erstes Packstück [1] = zweites Packstück [2] = drittes Packstück etc. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
width [0] | int(3) |
Pflicht Angabe mehrere Packstücke: [0] = erstes Packstück [1] = zweites Packstück [2] = drittes Packstück etc. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
height [0] | int(3) |
Pflicht Angabe mehrere Packstücke: [0] = erstes Packstück [1] = zweites Packstück [2] = drittes Packstück etc. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
weight [0] | int(3) |
Pflicht Angabe mehrere Packstücke: [0] = erstes Packstück [1] = zweites Packstück [2] = drittes Packstück etc. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
valueofgoods[0] | int(5) |
Pflicht
Bedeutung: Warenwert Angabe mehrere Packstücke: [0] = erstes Packstück [1] = zweites Packstück [2] = drittes Packstück etc. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
sendungsinhalt | varchar(255) | Pflicht | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
insurance | int(5) |
Optional (Warenwertversicherung in vollen EUR) |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
sendshipping | 0 | 1 |
Pflicht 0 = keinen Versandschein per E-Mail 1 = Versandschein per E-Mail |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
reference | varchar(255) | Optional | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
express | 0 | 1 |
Optional 0 = keiner Expressversand 1 = Expressversand Nicht bei Kleinpaket Im- und Export |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
avise_unload | 0 | 1 |
Optional Telefonische Avisierung der Sendung beim Empfänger Es wird die Telefonnummer des Parameters „unload_phone“ genommen Nicht bei Kleinpaket 0 = Keine Avise 1 = Ja |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
avise_electronic_unload | 0 | 1 |
Optional SMS & Mail Avisierung der Sendung beim Empfänger Es werden Telefonnummer und E-Mail Empfängers hierfür übernommen Nicht bei Kleinpaket 0 = Keine Avise 1 = Ja |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
cash_on_delivery_value | decimal(5,2) |
Optional - Option: Nachnahme - Maximaler Betrag: 1500 - Währung ist immer in EUR - Angabe mittels Zahlen, Cent Betrag wird durch ein Komma oder Punkt getrennt. - Geht nur in Verbindung mit cash_on_delivery_iban und cash_on_delivery_bic Nicht bei Kleinpaket |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
cash_on_delivery_iban | varchar(32) |
Optional Geht nur in Verbindung mit cash_on_delivery_value und cash_on_delivery_bic Nicht bei Kleinpaket |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
cash_on_delivery_bic | varchar(11) |
Optional Geht nur in Verbindung mit cash_on_delivery_value und cash_on_delivery_iban Nicht bei Kleinpaket |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
park | 0 | 1 |
Optional Nicht bei Kleinpaket Erläuterung: Abstellerlaubnis Ware darf ohne Empfänger vor Ort abgestellt werden https://www.cargointernational.de/media/docs/abstellerlaubnis.pdf |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
picupdate | dd.mm.yyyy |
Optional (Wenn nicht gesetzt wird automatisch der nächste Werktag gesetzt) |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PicupReadyTime | hhmm |
Optional nur bei UPS Sendungen Abholzeitfenster ab Das Zeitfenster muss mind. 2 Stunden betragen. Eine Garantie der Einhaltung kann nicht gewährleistet werden. Mögliche Zeiten von 9:00 Uhr bis 12:00 Uhr (Beispiel für Abhlung ab 9:00 Uhr "0900") |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PicupCloseTime | hhmm |
Abholzeitfenster bis Optional nur bei UPS Sendungen Mögliche Zeiten von 11:00 Uhr bis 17:00 Uhr (Beispiel für Abhlung bis 13:00 Uhr "1300") |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
label_format | varchar(2) |
Optional Mögliche Formate: A4 A5 A6 |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
carrier | varchar(16) |
Ist dieser Parameter leer ist, wählt das System den günstigsten Tarif. Bei angabe wird expliziet das Produkt des Dienstleisters gebucht. Akutell selber buchbare Dienstleister: dsv UPS mögliche Länder nach ISO-Code für Im- und Export Sendungen. Dies ist beim Parameter bzw. unload_country anzugeben:
UPS mögliche Länder nach ISO-Code für Export Sendungen. Dies ist beim Parameter bzw. unload_country anzugeben:
|
Mehrere Packstücke
Sollte eine Sendung aus mehreren Packstücken bestehen, können die Parameter mit [0], [1] , [2] etc. angegeben werden.
Beispiel:
1. Packstück
Länge: 10 cm
Breite: 10 cm
Höhe: 10 cm
Gewicht: 20 kg
Warenwert: 500 EUR
2. Packstück
Länge: 30 cm
Breite: 30 cm
Höhe: 30 cm
Gewicht: 40 kg
Warenwert: 700 EUR
Der Aufbau wird in "Request Beispielcode" aufgezeigt.
Request Beispielcode
$url = 'https://www.cargointernational.de/api/shipping/new_order';
$post_data = array(
'userid' => '0000',
'password' => 'test'
'submit' => 'price',
'sendshipping' => '0',
'length[0]' => '10',
'width[0]' => '10',
'height[0]' => '10',
'weight[0]' => '20',
'valueofgoods[0]' => '500',
'length[1]' => '30',
'width[1]' => '30',
'height[1]' => '35',
'weight[1]' => '40',
'valueofgoods[1]' => '700',
'picup_company' => 'Musterfirma',
'picup_firstname' => 'Melvin',
'picup_lastname' => 'Müller',
'picup_street' => 'Leibniz. 34',
'picup_postal' => '55118',
'picup_city' => 'München',
'picup_phone' => '3838383',
'picup_email' => 'sascha@beispiel.de',
'unload_company' => 'Testfirma',
'unload_firstname' => 'Markus',
'unload_lastname' => 'Mayer',
'unload_street' => 'Test Straße 3',
'unload_postal' => '21077',
'unload_city' => 'Hamburg',
'unload_phone' => '040 838383',
'unload_email' => ‘test@beispiel.de',
'reference' => '5451212145',
'versandart' => 'Kleinpaket',
'sendungsinhalt' => 'Stuhl',
'picupdate' => '12.06.2018',
);
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS, $post_data);
echo $html = curl_exec ($ch);
curl_close ($ch);
Response
[{
"Auftragsnummer":12345,
"Label":{
"file":"xxx",
"title":"xxx",
"application":"application\/pdf"
},
"Referenznummer":"test",
"Nettopreis": "77.44",
"Abholdatum":"dd.mm.YYYY",
"Abholzeitfenster": {
"start":"2016-11-15T09:00:00+01:00",
"ende":"2016-11-15T13:00:00+01:00"
}
"NVE":["00340363397472198933","00340363397472198934"],
"PRN":2972DMQBEQK,
"DSV_ID":40257145950237781615,
}]
NVE wird nur beim Speditionsversand mit ausgegeben und ist die Sendungsverfolgungsnummer aus der Speditionswelt, welche nur dann für Sie von Nöten ist, wenn Sie ihren eigenen Versandschein konzipieren. Sollten Sie daran Interesse haben, so kontaktieren Sie bitte Ihren technischen Ansprechpartner.
PRN sofern gebucht, wird die UPS Abholnummer ausgegeben.
DSV_ID sofern es sich um einen DSV Auftrag handelt, wird die DSV Identifikationsnummer (auch BookingID genannt) mit ausgegeben.
Erros
Error Code | Fehlerbeschreibung |
0 | Login fehlerhaft |
1 | Keine Nachnahme-Option beim Kleinpaketversand. |
2 | Keine IBAN im Kundenkonto hinterlegt. Erfolgt nur, wenn das Kundenkonto kein Rechnungskonto ist |
3 | Sie haben zu viele offene Rechnungen, sodass eine Eingabe von Aufträge aktuell nicht möglich ist. Kontaktieren Sie bitte unsere Buchhaltung |
4 | Parameter picupdate fehler |
5 | Der Abholdatum ist ein Feiertag. |
6 | Abholdatum ist kein Werktag. |
7 | Abholdatum muss in der Zukunft liegen. |
8 | Geben Sie für die Avise bitte eine korrekte Telefon- oder Mobilnummer an. |
9 | Bei Expresssendungen kann leider keine Avise gebucht werden. |
20 | Parameter sendshipping muss 0 oder 1 sein |
21 | Parameter unload_company ist zu lang, max. 35 Zeichen |
22 | Parameter unload_firstname ist zu lang, max. 35 Zeichen |
23 | Parameter unload_lastnameist zu lang, max. 35 Zeichen |
24 | Parameter unload_street ist zu lang, max. 35 Zeichen |
25 | Parameter unload_city ist zu lang, max. 35 Zeichen |
26 | Parameter unload_postal ist zu lang, max. 5 Zeichen |
27 | Parameter unload_phone ist zu lang, max. 35 Zeichen |
28 | Parameter unload_email ist zu lang, max. 255 Zeichen |
29 | Angabe des Parameters unload_firstname fehlt |
30 | Angabe des Parameters unload_lastname fehlt |
31 | Angabe der Parameters unload_street ist fehlerhaft |
32 | Angabe der Parameters unload_postal Fehlt |
33 | Angabe der Parameters unload_city fehlt |
34 | Parameter picup_company ist zu lang, max. 35 Zeichen |
35 | Parameter picup_firstname ist zu lang, max. 35 Zeichen |
36 | Parameter picup_lastname ist zu lang, max. 35 Zeichen |
37 | Parameter picup_street ist zu lang, max. 35 Zeichen |
38 | Parameter picup_city ist zu lang, max. 35 Zeichen |
39 | Parameter picup_postal ist zu lang, max. 5 Zeichen |
40 | Parameter picup_phone ist zu lang, max. 35 Zeichen |
41 | Parameter picup_email ist zu lang, max. 255 Zeichen |
42 | Angabe des Parameters picup_firstname fehlt |
43 | Angabe des Parameters picup_lastname fehlt |
44 | Angabe des Parameters picup_street ist fehlerhaft |
45 | Angabe des Parameters picup_postal fehlt |
46 | Angabe des Parameters picup_city fehlt |
60 | Fehlerhafte Versandart |
61 | Sendungsinhalt fehlt |
62 | Zu den Sendungsangaben konnte kein Angebot gefunden werden |
63 | Import Fehler |
64 | Import Fehler |
80 | Maximale Länge überschritten |
81 | Maximale Breite überschritten |
82 | Maximale Höhe überschritten |
83 | Das Gewicht muss mindesten 1 kg betragen |
84 | Warenwert darf nur aus ganzen Zahlen bestehen |
85 | Länge darf nur aus Zahlen bestehen und muss mind. den Wert von 1 haben |
86 | Breite darf nur aus Zahlen bestehen und muss mind. den Wert von 1 haben |
87 | Breite darf nur aus Zahlen bestehen und muss mind. den Wert von 1 haben |
88 | Volumengewicht überschritten |
89 | Gurtmaß überschritten |
90 | Eigengewicht überschritten |
91 | Maximale Seitenlänge überschritten |
92 | Zeitfenster der Abholung muss min. 2 Stunden betragen. |
93 | PicupReadyTime muss min 9 Uhr sein. |
94 | PicupReadyTime darf max. 15 Uhr sein. |
95 | PicupCloseTime muss min. 11 Uhr sein. |
96 | PicupCloseTime darf max. 17 Uhr sein. |
97 | Fehlerhaft Uhrzeit bei PicupReadyTime oder PicupCloseTime. |
Auftrag stornieren
URL
https://www.cargointernational.de/api/shipping/cancel
Request Parameter
Variable | Typ | Info | |
userid | int(10) | Pflicht (Kundennummer) | |
password | int(10) | Pflicht (API Passwort) | |
orderid | int(10) | Pflicht | |
reason | varchar(255) | Optional |
Errors
Error Code | Fehlerbeschreibung |
0 | Kein Auftrag Ihres Kundenkontos |
1 | Storno erfolgreich |
2 | Wurde bereits storniert |
3 | Fehlerhafter Login |
4 | Storno nicht mehr möglich |
Sendungsstatus
URL
https://www.cargointernational.de/api/shipping/tracking
Request Parameter
Variable | Typ | Info |
userid | int(10) | Pflicht (Kundennummer) |
password | int(10) | Pflicht (API Passwort) |
orderid | int(10) | Pflicht (die orderid ist die "Auftragsnummer" aus dem shipping response) |
Response
Variable | Typ |
orderid | int(10) |
status_code | int(3) |
status | varchar(255) |
date | dd.mm.yyyy |
time | hh:mm |
Response -> status_code
Stauts | info |
0 | Kein Status vorhanden |
1 | Auftragsdaten sind elektronisch eingegangen |
2 | Wurde beim Versender abgeholt |
3 | Wurde zu Abholung eingeplant |
4 | Im abholenden Lager eingegangen |
5 | Auf dem Weg zum zustellenden Haus |
6 | Die Sendung wurde für die Zustellung eingeplant. Zustellung heute oder am nächsten Werktag. |
9 | Zurück zum Absender |
10 | Erfolgreich zugestellt |
99 | Auftrag wurde Storniert |
Versandlabel erneut anfragen
Versandscheine sind für mind. 30 Tage nach Auftragsübermittlung abrufbar.
URL
https://www.cargointernational.de/api/shipping/label_recovery_request
Request Parameter
Variable | Typ | Info |
userid | int(10) | Pflicht (Kundennummer) |
password | int(10) | Pflicht (API Passwort) |
orderid | int(10) | Pflicht |
Response
[{
"Label":{
"file":"xxx",
"title":"xxx",
"application":"application\/pdf"
}
}]
Errors
Error Code | Fehlerbeschreibung |
0 | Login fehlerhaft |
1 | Kein Auftrag Ihres Kundenkontos |
2 | Nicht möglich, da bereits storniert |