DHL API v1.1

Beachten: Die Zusammenarbeit mit API DHL ist nur durch Ihren eigenen Vertrag möglich!

Services

DHL STANDARD

Die Etikette wird gedruckt und sofort an den Kunden zurückgesandt, OHNE die Fracht abzuholen

POST https://easylox.de/api/v1/create

{
    "to": {
        "company": "Paket.ag & EasyLox GmbH",
        "first_name": "Christian",
        "last_name": "Rademaker",
        "street": "Mulweg",
        "street_no": "3a",
        "city": "Schifferstadt",
        "zip_code": "67105",
        "country": "DE",
        "phone": "+4962359159957",
    },
    "from": {
        "company": "Receiver Inc.",
        "first_name": "Max",
        "last_name": "Mustermann",
        "street": "Beispielstrase",
        "street_no": "123",
        "city": "Musterstadt",
        "zip_code": "48455",
        "country": "DE",
        "phone": "555-555",
    },
    "package": { 
        "weight": 5,
        "length": 30,
        "width": 20,
        "height": 10
    },
    "amount_of_label": 1,
    "carrier": "dhl",
    "service": "standard",
    "reference_number": "ref1234356789",
    "contract": "own",
}

Request info:

amount_of_label optional. Anzahl identischer Gewichte, Standard 1

Bedarf:

to Empfängerbereich
from Absenderabschnitt
package Abschnitt Frachtparameter
contract Die Zusammenarbeit mit API DHL ist nur durch Ihren eigenen Vertrag möglich!

Überprüfung der Abreise

maximale Längste Seite: 200 cm
maximale Gurtmaß: 360 Formel: (zweitlaengsteSeite + kuerzesteSeite) * 2 + laengsteSeite

Wenn die Bestellung erfolgreich erstellt wurde, gibt die EasyLox.de-API die folgende Antwort zurück:

Response info:

id eindeutige Bestellnummer im EasyLox.de-System
shipping_id Frachtnummer
shipment_url Link zur Bestellung im EasyLox.de-System
tracking_url Link zur Verfolgung des Auftragsstatus in EasyLox.de
carrier_tracking_url Link, um den Status der Bestellung im System des Transportunternehmens zu verfolgen
carrier_tracking_no Verfolgung der Frachtnummer im System des Transportunternehmens
label Link zum Etikett
price Bestellkosten

Response

200 OK

{
    "0":
    {
        "id" :859902,
        "shipping_id": "123456789123456789132456789",
        "shipment_url": "https://easylox.de/shipment/123456/edit",
        "tracking_url": "https://easylox.de/shipment/123456/tracking",
        "carrier_tracking_url": "https://www.dhl.de/de/privatkunden/pakete-empfangen/verfolgen.html?piececode=000111000111000",
        "carrier_tracking_no": "000111000111000",
        "label": "https://easylox.de/get_label/123456789123456789132456789",
        "price": "0.00"
    }
}

DHL STANDARD + RELABEL

Die Etikette wird gedruckt und sofort an den Kunden zurückgesandt, OHNE die Fracht abzuholen

POST https://easylox.de/api/v1/create

{
    "to": {
        "company": "Paket.ag & EasyLox GmbH",
        "first_name": "Christian",
        "last_name": "Rademaker",
        "street": "Mulweg",
        "street_no": "3a",
        "city": "Schifferstadt",
        "zip_code": "67105",
        "country": "DE",
        "phone": "+4962359159957",
    },
    "from": {
        "company": "Receiver Inc.",
        "first_name": "Max",
        "last_name": "Mustermann",
        "street": "Beispielstrase",
        "street_no": "123",
        "city": "Musterstadt",
        "zip_code": "48455",
        "country": "DE",
        "phone": "555-555",
    },
    "package": { 
        "weight": 5,
        "length": 30,
        "width": 20,
        "height": 10
    },
    "amount_of_label": 1,
    "carrier": "dhl",
    "service": "relabel",
    "reference_number": "ref1234356789",
    "contract": "own"
}

Request info:

amount_of_label optional. Anzahl identischer Gewichte, Standard 1

Bedarf:

to Empfängerbereich
from Absenderabschnitt
package Abschnitt Frachtparameter
contract Die Zusammenarbeit mit API DHL ist nur durch Ihren eigenen Vertrag möglich!

Überprüfung der Abreise

maximale Längste Seite: 200 cm
maximale Gurtmaß: 360 Formel: (Zweitlängste Seite + Kürzeste Seite) * 2 + Längste Seite

Wenn die Bestellung erfolgreich erstellt wurde, gibt die EasyLox.de-API die folgende Antwort zurück:

Response info:

id eindeutige Bestellnummer im EasyLox.de-System
shipping_id Frachtnummer
shipment_url Link zur Bestellung im EasyLox.de-System
tracking_url Link zur Verfolgung des Auftragsstatus in EasyLox.de
carrier_tracking_url Link, um den Status der Bestellung im System des Transportunternehmens zu verfolgen
carrier_tracking_no Verfolgung der Frachtnummer im System des Transportunternehmens
label Link zum Etikett
price Bestellkosten

Response

200 OK

{
    "0":
    {
        "id" :859902,
        "shipping_id": "123456789123456789132456789",
        "shipment_url": "https://easylox.de/shipment/123456/edit",
        "tracking_url": "https://easylox.de/shipment/123456/tracking",
        "carrier_tracking_url": "https://www.dhl.de/de/privatkunden/pakete-empfangen/verfolgen.html?piececode=000111000111000",
        "carrier_tracking_no": "000111000111000",
        "label": "https://easylox.de/get_label/123456789123456789132456789",
        "price": "0.00"
    }
}

DHL ABHOLUNG

Der Fahrer bringt das Etikett am Tag der Abholung der Ladung mit

POST https://easylox.de/api/v1/create

{
    "to": {
        "company": "Paket.ag & EasyLox GmbH",
        "first_name": "Christian",
        "last_name": "Rademaker",
        "street": "Mulweg",
        "street_no": "3a",
        "city": "Schifferstadt",
        "zip_code": "67105",
        "country": "DE",
        "phone": "+4962359159957",
    },
    "from": {
        "company": "Receiver Inc.",
        "first_name": "Max",
        "last_name": "Mustermann",
        "street": "Beispielstrase",
        "street_no": "123",
        "city": "Musterstadt",
        "zip_code": "48455",
        "country": "DE",
        "phone": "555-555",
    },
    "package": { 
        "weight": 5,
        "length": 30,
        "width": 20,
        "height": 10
    },
    "amount_of_label": 1,
    "carrier": "dhl",
    "service": "dhl_ftp_tas",
    "reference_number": "ref1234356789",
    "contract": "own",
    "pickup": "2020-09-08",
}

Request info:

amount_of_label optional. Anzahl identischer Gewichte, Standard 1

Bedarf:

to Empfängerbereich
from Absenderabschnitt
package Abschnitt Frachtparameter
contract Die Zusammenarbeit mit API DHL ist nur durch Ihren eigenen Vertrag möglich!
pickup das gewünschte Datum der Abholung der Ware an der Absenderadresse

Überprüfung der Abreise

maximale Längste Seite: 200 cm
maximale Gurtmaß: 360 Formel: (Zweitlängste Seite + Kürzeste Seite) * 2 + Längste Seite

Wenn die Bestellung erfolgreich erstellt wurde, gibt die EasyLox.de-API die folgende Antwort zurück:

Response info:

id eindeutige Bestellnummer im EasyLox.de-System
shipping_id Frachtnummer
shipment_url Link zur Bestellung im EasyLox.de-System
tracking_url Link zur Verfolgung des Auftragsstatus in EasyLox.de
carrier_tracking_url Link, um den Status der Bestellung im System des Transportunternehmens zu verfolgen
carrier_tracking_no Verfolgung der Frachtnummer im System des Transportunternehmens
label Link zum Etikett
price Bestellkosten

Response

200 OK

{
    "0":
    {
        "id" :859902,
        "shipping_id": "123456789123456789132456789",
        "shipment_url": "https://easylox.de/shipment/123456/edit",
        "tracking_url": "https://easylox.de/shipment/123456/tracking",
        "carrier_tracking_url": "https://www.dhl.de/de/privatkunden/pakete-empfangen/verfolgen.html?piececode=000111000111000",
        "carrier_tracking_no": "000111000111000",
        "label": "https://easylox.de/get_label/123456789123456789132456789",
        "price": "0.00"
    }
}

Beispielanforderung mit CURL

curl -u :API_KEY -H "Content-Type:  application/json" -d '{"to": {"company": "Paket.ag & EasyLox gmbh","first_name": "christian","last_name": "rademaker","street": "mühlweg","street_no": "3a","city": "schifferstadt","zip_code": "67105","country": "de","phone": "+4962359159957","email": "it@paket.ag"},"from": {"company": "Receiver inc.","first_name": "max","last_name": "mustermann","street": "beispielstraße","street_no": "123","city": "musterstadt","zip_code": "48455","country": "de","phone": "555-555","email": "test@domain.tld"},"package": {"weight": 20,"length": 100,"width": 50,"height": 50},"amount_of_label": 1,"carrier": "dhl","service": "standard","reference_number": "ref1234356789"}' 
https://easylox.de/api/v1/create

ZOLLDEKLARATION

Wenn Sie eine Sendung in ein Land senden möchten, in dem eine Zollanmeldung erforderlich ist, können Sie dies folgendermaßen angeben. Detaillierte Informationen zu den Parametern finden Sie in unserer Dokumentation zum Erstellen einer Sendung.

POST https://easylox.de/api/v1/create

{
    "to": {
        "company": "Paket.ag & EasyLox GmbH",
        "first_name": "Christian",
        "last_name": "Rademaker",
        "street": "Mulweg",
        "street_no": "3a",
        "city": "Schifferstadt",
        "zip_code": "67105",
        "country": "EG",
        "phone": "+4962359159957",
    },
    "from": {
        "company": "Receiver Inc.",
        "first_name": "Max",
        "last_name": "Mustermann",
        "street": "Beispielstrase",
        "street_no": "123",
        "city": "Musterstadt",
        "zip_code": "48455",
        "country": "DE",
        "phone": "555-555",
    },
    "package": {
        "weight": 5,
        "length": 30,
        "width": 20,
        "height": 10
    },
    "customs_declaration":{
      "contents_type":"commercial_goods",
      "contents_explanation":"Alcoholic beverages",
      "currency":"EUR",
      "additional_fees": 0.0,
      "drop_off_location":"DE",
      "posting_date":"2020-12-09",
      "invoice_number":"123ABC",
      "total_value_amount":247,
        "items":[{
          "origin_country": "DE",
          "description": "Linkwood 25 years",
          "hs_tariff_number": "501293884",
          "quantity": "1",
          "value_amount": "138.50",
          "net_weight": "0.8"
      },
      {
         "origin_country": "DE",
         "description": "Caol Ila 18 years",
         "hs_tariff_number": "123384890",
         "quantity": "1",
         "value_amount": "108.50",
         "net_weight": "0.8"
      }]
     },
    "amount_of_label": 1,
    "carrier": "dhl",
    "service": "standard",
    "reference_number": "ref1234356789",
    "contract": "own",
}

Request info:

amount_of_label optional. Anzahl identischer Gewichte, Standard 1

Bedarf:

to Empfängerbereich
from Absenderabschnitt
package Abschnitt Frachtparameter
contract Die Zusammenarbeit mit API DHL ist nur durch Ihren eigenen Vertrag möglich!
customs_declaration Abschnitt der Parameter der Zollanmeldung

Überprüfung der Abreise

maximale Abmessungen (l/b/h): 120 x 60 x 60 cm
maximale Gurtmaß: 360 Formel: (zweitlaengsteSeite + kuerzesteSeite) * 2 + laengsteSeite

Datenanforderung

to country Für EU-Länder wird keine Zollanmeldung abgegeben
contents_type commercial_goods, commercial_sample, documents, gift, returned_goods>
currency EUR
contents_explanation Inhaltserklärung erforderlich
items (origin_country, description, quantity, value_amount, net_weigh) Erforderlich

Wenn die Bestellung erfolgreich erstellt wurde, gibt die EasyLox.de-API die folgende Antwort zurück:

Response info:

id eindeutige Bestellnummer im EasyLox.de-System
shipping_id Frachtnummer
shipment_url Link zur Bestellung im EasyLox.de-System
tracking_url Link zur Verfolgung des Auftragsstatus in EasyLox.de
carrier_tracking_url Link, um den Status der Bestellung im System des Transportunternehmens zu verfolgen
carrier_tracking_no Verfolgung der Frachtnummer im System des Transportunternehmens
carrier_declaration_document_url Link zum Herunterladen der Zollanmeldung
label Link zum Etikett
price Bestellkosten

Beispielanforderung mit CURL

curl -u :API_KEY -H "Content-Type:  application/json" -d '{"to": {"company": "Paket.ag & EasyLox gmbh","first_name": "christian","last_name": "rademaker","street": "mühlweg","street_no": "3a","city": "schifferstadt","zip_code": "67105","country": "eg","phone": "+4962359159957","email": "it@paket.ag"},"from": {"company": "Receiver inc.","first_name": "max","last_name": "mustermann","street": "beispielstraße","street_no": "123","city": "musterstadt","zip_code": "48455","country": "de","phone": "555-555","email": "test@domain.tld"},"package": {"weight": 20,"length": 100,"width": 50,"height": 50}, "customs_declaration":{"contents_type":"commercial_goods", "contents_explanation":"Alcoholic beverages","currency":"EUR","additional_fees": 0.0,"drop_off_location":"DE","posting_date":"2020-12-09","invoice_number":"123ABC", "total_value_amount":247,"items":[{"origin_country": "DE","description": "Linkwood 25 years","hs_tariff_number": "501293884","quantity": "1","value_amount": "138.50","net_weight": "0.8"},{"origin_country": "DE","description": "Caol Ila 18 years","hs_tariff_number": "123384890","quantity": "1","value_amount": "108.50","net_weight": "0.8"}]},"amount_of_label": 1,"carrier": "dhl","service": "standard","reference_number": "ref1234356789"}' 
https://easylox.de/api/v1/create

Response

200 OK

{
    "0":
    {
        "id" :859902,
        "shipping_id": "123456789123456789132456789",
        "shipment_url": "https://easylox.de/shipment/123456/edit",
        "tracking_url": "https://easylox.de/shipment/123456/tracking",
        "carrier_tracking_url": "https://www.dhl.de/de/privatkunden/pakete-empfangen/verfolgen.html?piececode=000111000111000",
        "carrier_tracking_no": "000111000111000",
        "carrier_declaration_document_url":"https://documents.shipcloud.io/shipments/4f47674978578b0616f6df4fc6a77498fddaf26e\/customs_declaration_document.pdf",
        "label": "https://easylox.de/get_label/123456789123456789132456789",
        "price": "0.00"
    }
}