API-Referenz v1.0

QUOTE

POST https://easylox.de/api/v1/quote 
{
    "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": 20,
          "length": 120,
          "width": 50,
          "height": 50
          },
          "amount_of_label": 1,
          "carrier": "dpd",
          "service": "standard",
          "reference_number": "ref1234356789",
          "pickup": "2020-09-08",
        }

Bedarf:

  • to Empfängerbereich
  • from Absenderabschnitt
  • package Abschnitt Frachtparameter

Für Ihre Information! Nachdem Sie mit der QUOTE-Methode ein erfolgreiches Ergebnis erhalten haben, können Sie die Bestellung mit der CREATE-Methode senden.

Wenn ein Produkt gefunden wird, das der angeforderten Bedingung entspricht, gibt die EasyLox.de-API die folgende Antwort zurück:

Response info:

  • product_id eindeutige Produktnummer im EasyLox.de-System
  • product_name eindeutiger Produktname im EasyLox.de-System
  • price_weight maximales Versandgewicht mit diesem Produkt
  • price kosten
  • currency Währung

Response

200 OK

{
          "result": 
          {
            "product_id": 1246,
            "product_name": "DPD <= Deutschland <= 20.00kg",
            "price_weight": 20,
            "price": "0.00",
            "currency": "EUR"
            },
          }

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":"dpd","service":"standard","reference_number":"ref1234356789","pickup":"2020-09-11"}' 
https://easylox.de/api/v1/quote

ORDER

POST https://easylox.de/api/v1/order 
{
  "order_id":"000000"
}

Bedarf:

  • order_id eindeutige Bestellnummer im System EasyLox.de oder delivery_id

Wenn Produkte gefunden werden, die den angeforderten Bedingungen entsprechen, gibt die EasyLox.de-API die folgende Antwort zurück:

Response info:

  • id eindeutige Bestellnummer im EasyLox.de-System
  • created_at Datum der Auftragserstellung in EasyLox.de
  • reference_number Referenznummer im System des Kunden
  • carrier_tracking_no Tracking-Nummer im System des Spediteurs
  • tracking_link Link zur Verfolgung im System des Transportunternehmens des Spediteurs
  • shipment_url Link zur Bestellung im EasyLox.de-System
  • carrier Name des Transportunternehmens des Spediteurs im EasyLox.de-System
  • service Ausgewählter Service für den Versand im EasyLox.de-System

Response

200 OK

{
            "id":"000000",
            "created_at":"2020-09-07 17:49:31 СEST",
            "reference_number":"ref1234356789",
            "carrier_tracking_no":"123456789",
            "tracking_link":"https://tracking.dpd.de/parcelstatus?query=123456789&locale=de_DE",
            "shipment_url":"http://easylox.de/shipment/000000/edit", 
            "label_url":"https://easylox.de/get_label/123456789123456789", 
            "carrier":"dpd",
            "service":"dpd_return"
          }

Beispielanforderung mit CURL

curl -u :API_KEY -H "Content-Type:  application/json" -d '{"order_id":"000000"}'  https://easylox.de/api/v1/order

PRODUCTS

POST https://easylox.de/api/v1/products 
{
  "to" :{
    "country": "DE"
  },
  "package": {
    "weight":10
  }
}

Bedarf:

  • country ISO-2-Ländercode des Empfängerlandes
  • weight Ladegewicht in Kilogramm

Wenn Produkte gefunden werden, die den angeforderten Bedingungen entsprechen, gibt die EasyLox.de-API die folgende Antwort zurück:

Response info:

  • product_id eindeutige Produktnummer im EasyLox.de-System
  • carrier_name Name des Transportunternehmens des Spediteurs im EasyLox.de-System
  • carrier_service Service für den Versand von Waren im EasyLox.de-System
  • product_name Produktname im EasyLox.de-System
  • max_weight maximales Gewicht, das mit diesem Produkt gesendet werden kann
  • price Produkt kosten
  • currency Währung
  • rules die Bedingungen, die die versendete Fracht erfüllen muss

Response

200 OK

{
            "DHL": [{
              "product_id": 2808,
              "carrier_name": "dhl",
              "carrier_service": "dhl_ftp_abholung"
              "product_name": "DHL Einzelabholung  <= Deutschland <= 31.50kg",
              "max_weight": 31.5,
              "price": "2.00",
              "currency": "EUR",
              "rules": 
              [{"val": "120",
              "option": "laenge",
              "text": "Die Länge Ihres Paketes sollte nicht mehr als sein 120 cm."},
              {"val": "60",
              "option": "breite",
              "text": "Die Breite Ihres Paketes sollte nicht mehr als sein 60 cm."},
              {"val": "60",
              "option": "hoehe",
              "text": "Die Höhe Ihres Paketes sollte nicht mehr als sein 60 cm."},
              {"val": "360",
              "option": "gurtmass",
              "text": "Die Gurtmaß Ihres Paketes sollte nicht mehr als sein 360 cm."}]},
              ]}],
            }

Beispielanforderung mit CURL

curl -u :API_KEY -H "Content-Type:  application/json" -d '{"to":{"country":"DE"},"package":{"weight":10}}' https://easylox.de/api/v1/products

PICKUP

POST https://easylox.de/api/v1/pickup 
{
 "carrier":"dhl",
 "pickup":"2020-09-07"
}

Bedarf:

  • carrier Der Name des Transportunternehmens des Spediteurs im EasyLox.de-System.
  • pickup Format YYYY-MM-DD

Wenn das angeforderte Abholdatum korrekt ist, gibt die API Folgendes zurück:

Response

200 OK

{
    "result":
    {
        "pickup_date":"2020-09-09",
        "status":"validated"
    },
}

Wenn das angeforderte Abholdatum NICHT korrekt ist und Änderungen erfordert, gibt die API Folgendes zurück:

Response

200 OK

{
    "result":
    {
        "old_pickup_date":"2020-09-07",
        "new_pickup_date":"2020-09-09",
        "status":"changed"
    },
}

Beispielanforderung mit CURL

curl -u :API_KEY -H "Content-Type:  application/json" -d '{"carrier":"dhl","pickup":"2020-09-07"}' https://easylox.de/api/v1/pickup

Fulfillment Create

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

            {
            "to": {
              "company": "Paket.ag & EasyLox GmbH",
              "first_name": "test",
              "last_name": "test"
              "street": "Mühlweg",
              "street_no": 12,
              "care_of": "",
              "city": "Schifferstadt",
              "zip_code": "67105",
              "country": "DE",
              "phone": "+4962359159957",
              "email": "test@domain.com",
              },
              "items":[
                {"sku": "11111", "amount": "1"},
                {"sku": "22222", "amount": "1"}
              ],
            "delivery_name": "my_test_delivery"
            }

Wenn das angeforderte Abholdatum korrekt ist, gibt die API Folgendes zurück:

Response

200 OK

{
"delivery_id":"123456789"
}

Datenschutz