Erhalte Versandmethoden basierend auf Adresse und Paketparametern.
Gibt eine Liste der Rückgabemethoden für die/den angegebene*n Partner*in mit zusätzlichen Parametern wie Verfügbarkeit zurück.
POST /v1/shipping-methods/quote
Beispiel anfordern
{ "orderReferenceId": "EXMPL0001234", "currency": "EUR", "options": { "weightUnit": "g", "dimensionUnit": "mm", "label": { "format": "pdf" } }, "partner": { "clientName": "ExampleCustomer" }, "receiver": { "person": { "firstName": "Foo", "lastName": "Bar", "company": "", "email": "[email protected]", "phone": "01273552886" }, "address": { "country": "GB", "state": "East Sussex", "city": "Brighton", "postcode": "BN1 8YQ", "addressLine1": "11 London Rd", "addressLine2": "", "addressLine3": "", "street": "London Rd", "houseNumber": "11", "suburb": null }, "customs": { "vatNumber": null } }, "sender": { "person": { "firstName": "", "lastName": "", "company": "Example Company", "email": "[email protected]", "phone": "01666 123456" }, "address": { "country": "DE", "state": "", "city": "Donauwörth", "postcode": "86609", "addressLine1": "Am Wassergraben 11", "addressLine2": null, "addressLine3": null, "street": "Am Wassergraben", "houseNumber": "11", "suburb": null }, "customs": { "vatNumber": "DE123456789000", "iossNumber": null, "eoriNumber": "GB987654321000", "pcccNumber": null, "australianBusinessNumber": null } }, "packages": [ { "packageReferenceId": "EXMPL0001234-0-1", "grossWeight": 810, "netWeight": 760, "length": 229, "width": 200, "height": 36, "boxType": "rectangle", "volumetricWeight": 700, "items": [ { "itemReferenceId": "EXMPL0001234-0-1-ITEM1", "description": "Mug", "value": 48, "quantity": 4, "weight": 760, "hsCode": "44199090", "countryOfOrigin": "DE" } ] } ]}Beispiel für eine erfolgreiche Antwort
{ "items": [ { "carrier": { "name": "DHL", "uid": "dhl" }, "method": { "name": "DHL Global Parcel", "uid": "dhl_global_parcel", "price": 3.32, "maxShipmentDays": 5, "minShipmentDays": 2, "deliveryPaddingDays": 0 } }, { "carrier": { "name": "UPS", "uid": "ups" }, "method": { "name": "UPS Standard Tariff", "uid": "ups_standard_tariff", "price": 5.25, "maxShipmentDays": 5, "minShipmentDays": 2, "deliveryPaddingDays": 0 } } ], "count": 2}Beispiel für eine Fehlermeldung
{ "orderReferenceId": "EXMPL0001234", "code": "VALIDATION_ERROR", "message": "There are errors in submitted data", "errors": [ { "code": "NO_SUCH_CHOICE_ERROR", "reference": "options.label.format", "message": "The value you selected is not a valid choice." }, { "code": "IS_BLANK_ERROR", "reference": "receiver.address.country", "message": "This value should not be blank." } ]}Anfrage
Parameter | Typ | Beschreibung |
orderReferenceId (erforderlich) | Zeichenkette | Eindeutige ID für die Versandbestellung. Von Ihnen bereitgestellte ID. |
Währung (erforderlich) | Zeichenkette | Währung der Versandbestellung im 3-Buchstaben-Format. |
Optionen (optional) | Optionen | Optionale Parameter. |
Partner*in (optional) | Partner | Partner*in-Details. |
Empfänger*in (erforderlich) | Empfänger*in | Empfänger*innendaten. |
Absender*in (erforderlich) | Absender*in | Absenderdaten. |
Pakete (erforderlich) | Paket[] | Paketdetails. |
Optionen
Parameter | Typ | Beschreibung |
Gewichtseinheit (optional) | Zeichenkette | Gewichtseinheit. Verfügbare Optionen: g, kg, oz, lb. Standardmäßig: g. |
dimensionUnit (optional) | Zeichenkette | Längeneinheit. Verfügbare Optionen: mm, cm, in. Standardmäßig: mm. |
Etikett (optional) | Etikett | Einstellungen für das Etikettenformat. |
Etikett
Parameter | Typ | Beschreibung |
Format (optional) | Zeichenkette | Etikettenformat. Verfügbare Optionen: pdf, zpl (*). Standardmäßig: pdf. |
Hinweis: Formate, die nicht PDF sind, sind möglicherweise nicht für bestimmte Versanddienstleister aktiviert.
Partner
Parameter | Typ | Beschreibung |
Kund*innenname (optional) | Zeichenkette | Versandkundenprofil. |
Empfänger*in
Parameter | Typ | Beschreibung |
Person (erforderlich) | Empfänger*in | Persönliche Daten der empfangenden Person. |
Adresse (erforderlich) | Adresse | Adressdaten der empfangenden Person. |
Zoll (optional) | Empfänger*in Zoll | Zolldaten der empfangenden Person. |
Absender*in
Parameter | Typ | Beschreibung |
Person (erforderlich) | Absender*in | Persönliche Angaben der Absenderin oder des Absenders. |
Adresse (erforderlich) | Adresse | Adressdaten der Absender*in. |
Zoll (erforderlich für den internationalen Versand) | Absenderzoll | Zolldetails der Absender*in. |
Empfänger*in
Parameter | Typ | Beschreibung |
Vorname (erforderlich) | Zeichenkette | Vorname der empfangenden Person. |
Nachname (erforderlich) | Zeichenkette | Nachname der empfangenden Person. |
Unternehmen (optional) | Zeichenkette | Der Name des Unternehmens. |
E-Mail (optional*) | Zeichenkette | E-Mail-Adresse der Person. Diese kann für Versandbenachrichtigungen verwendet werden. |
Telefon (optional*) | Zeichenkette | Telefonnummer der Person. Diese kann für Versandbenachrichtigungen verwendet werden. |
Hinweis: *E-Mail und Telefonnummer können ein Pflichtfeld sein, abhängig vom Versanddienstleister
Absender*in
Parameter | Typ | Beschreibung |
Vorname (optional) | Zeichenkette | Vorname der sendenden Person. |
Nachname (optional) | Zeichenkette | Nachname der sendenden Person. |
Unternehmen (erforderlich) | Zeichenkette | Der Name des Absenderunternehmens. |
E-Mail (optional*) | Zeichenkette | E-Mail-Adresse der sendenden Person / des Unternehmens. |
Telefonnummer (optional*) | Zeichenkette | Telefonnummer der absendenden Person / des Unternehmens. |
Hinweis: *E-Mail und Telefonnummer können ein Pflichtfeld sein, abhängig vom Versanddienstleister
Adresse
Parameter | Typ | Beschreibung |
Land (erforderlich) | Zeichenkette | Ländercode im 2-Buchstaben-Format. |
Bundesland (optional*) | Zeichenkette | Bundesland / Landkreis / Region. |
Stadt (erforderlich) | Zeichenkette | Stadt. |
Postleitzahl (erforderlich) | Zeichenkette | Postleitzahl. |
addressLine1 (erforderlich) | Zeichenkette | Erste Zeile der Postadresse. Sollte Straße und Hausnummer enthalten. |
Adresszeile 2 (optional) | Zeichenkette | Zweite Zeile der Postadresse. Wohnungs-/Büro-/Stockwerksnummer. |
Adresszeile 3 (optional) | Zeichenkette | Dritte Zeile der Postadresse. |
Straße (optional*) | Zeichenkette | Straße (erforderlich für DE-Adressen). |
Hausnummer (optional*) | Zeichenkette | Hausnummer (erforderlich für Adressen in Deutschland). |
Vorort (optional*) | Zeichenkette | Vorort (erforderlich für AU/NZ-Adressen). |
Hinweis: *Diese optionalen Felder sind für bestimmte Länder und Versanddienstleister erforderlich.
Empfänger*inZoll
Parameter | Typ | Beschreibung |
Umsatzsteuer-Identifikationsnummer (optional) | Zeichenkette | MwSt.-Nummer der empfangenden Person. |
SenderCustoms
Parameter | Typ | Beschreibung |
Umsatzsteuer-Identifikationsnummer (optional*) | Zeichenkette | MwSt.-Nummer des Absenders. |
iossNumber (optional*) | Zeichenkette | IOSS-Nummer der Absender*in. |
EORI-Nummer (optional*) | Zeichenkette | EORI-Nummer der Absenderin oder des Absenders. |
pcccNumber (optional*) | Zeichenkette | PCCC-Nummer der Absenderin oder des Absenders. |
Australian Business Number (optional*) | Zeichenkette | Australische Unternehmensnummer der*des Absender*in. |
Hinweis: *Je nach Absender- und Empfängerland können diese Felder erforderlich sein.
Paket
Parameter | Typ | Beschreibung |
packageReferenceId (erforderlich) | Zeichenkette | Vom Partner bereitgestellte ID des Pakets. |
Bruttogewicht (erforderlich) | Zahl | Verpackungsgewicht + Artikelgewicht (standardmäßig in Gramm). |
Nettogewicht (optional) | Zahl | Gewicht der Artikel (standardmäßig in Gramm). |
Länge (erforderlich) | Zahl | Länge des Pakets (standardmäßig in mm angegeben). |
Breite (erforderlich) | Zahl | Paketbreite (standardmäßig in mm). |
Höhe (erforderlich) | Zahl | Höhe des Pakets (standardmäßig in mm angegeben). |
Volumengewicht (optional) | Zahl | Das Gewicht wird basierend auf der Größe des Pakets berechnet (standardmäßig in Gramm). |
boxType (optional) | Zeichenkette | Form der Verpackung (z. B. Rechteck, Röhre). |
Warenwert (erforderlich für den internationalen Versand) | Zahl | Gesamtwert aller Artikel im Paket (in der ausgewählten Währung). |
Artikel (erforderlich für den internationalen Versand) | Artikel[] | Liste der Artikel im Paket. |
Artikel*
Parameter | Typ | Beschreibung |
itemReferenceId (erforderlich) | Zeichenkette | Vom Partner bereitgestellte ID des Paketelements. |
Beschreibung (erforderlich) | Zeichenkette | Beschreibung des Artikels. |
Menge (erforderlich) | Zahl | Menge des Artikels. |
Wert (erforderlich) | Zahl | Wert des Artikels (in ausgewählter Währung). |
Gewicht (erforderlich) | Zahl | Gewicht des Artikels (standardmäßig in Gramm). |
HS-Code (erforderlich) | Zeichenkette | Harmonized System Code (Wiki). |
countryOfOrigin (erforderlich) | Zeichenkette | Ländercode im 2-Buchstaben-Format, in dem der Artikel produziert wurde. |
Hinweis: *Alle Artikelparameter sind nur für den internationalen Versand erforderlich.
Erfolgreiche Antwort
Parameter | Typ | Beschreibung |
Anzahl | Zahl | Anzahl der gefundenen Ergebnisse. |
Artikel | ResponseItems | Ein Array der Angebote |
ResponseItems
Parameter | Typ | Beschreibung |
Versanddienstleister | ResponseItemsCarrier | Details zum Versanddienstleister. |
Methode | ResponseItemsMethod | Details zur Versandart. |
ResponseItemsCarrier
Parameter | Typ | Beschreibung |
Versanddienstleister | Zeichenkette | Versandanbieter*in, der*die für die Bestellung verwendet wird. |
uid | Zeichenkette | Versandmethode, die für die Bestellung verwendet wurde. |
ResponseItemsMethod
Parameter | Typ | Beschreibung |
Name | Zeichenkette | Name der Versandmethode. |
uid | Zeichenkette | UID der Versandmethode. |
Preis | Zahl | Geschätzter Preis der Versandmethode für Partner*innen. |
maxShipmentDays | Zahl | Maximale Versandtage der Versandmethode. |
minShipmentDays | Zahl | Versandmethode Mindestversandtage. |
deliveryPaddingDays (optional) | Zahl | Lieferpuffer-Tage der Versandmethode. |
Fehlermeldung
Parameter | Typ | Beschreibung |
Bestellreferenznummer | Zeichenkette | Eindeutige ID für die Versandbestellung, die von Ihnen bereitgestellt wird. |
code | Zeichenkette | Fehlercode. |
Nachricht | Zeichenkette | Fehlermeldung. |
Detail (optional) | Objekt | Detaillierte Fehlermeldung (JSON-Objekt einer beliebigen Struktur). |
Fehler (optional) | ResponseErrorDetails[] | Fehlerliste. |
ResponseErrorDetails
Parameter | Typ | Beschreibung |
code | Zeichenkette | Fehlercode. |
Nachricht | Zeichenkette | Fehlermeldung |
Referenz (optional) | Zeichenkette | Referenz-ID. |
Nächster Schritt: 🔗[GCL] Logistics API - Tracking
📝 Nicht das, was Sie gesucht haben?
Helfen Sie uns, diesen Artikel zu verbessern. Senden Sie uns eine E-Mail an [email protected] – bitte geben Sie den Titel des Artikels an.