Zum Hauptinhalt springen

Verbindung zu einer benutzerdefinierten Carrier-API herstellen

Verfasst von Maurice
Heute aktualisiert

ChannelDock bietet eine große Auswahl vorgefertigter Versanddienstleister-Integrationen, die Verkäufer und Fulfillment-Center sofort nutzen können. Da es für uns jedoch nicht möglich ist, eine Verbindung zu jeder Versandplattform zu entwickeln, haben wir eine Reihe von APIs entwickelt, die es Ihnen als Versanddienstleister ermöglichen, Versandmethoden in ChannelDock für einen bestimmten Verkäufer oder ein bestimmtes Fulfillment-Center zu erstellen.

Dieses Handbuch beschreibt die Schritte, die Sie zur Durchführung dieser Integration befolgen müssen.

Schritt 1:
API-Anmeldeinformationen erzeugen:
- Verkäufer: https://channeldock.com/portal/public/settings/api_keys
- Fulfillment-Center: https://channeldock.com/portal/public/centersettings/api_keys

Schritt 2:
Als nächstes fügen Sie die Versandmethoden hinzu, die Sie als Versanddienstleister in ChannelDock anbieten. Weitere Informationen zum Endpunkt und zur erwarteten JSON-Struktur finden Sie hier:
- Verkäufer: Postman docs
- Fulfillment-Center: Postman docs

Schritt 3:
Immer wenn ein ChannelDock-Benutzer versucht, ein Versandetikett mit Ihren Versandmethoden zu erstellen, senden wir Ihnen ein JSON-Objekt, das die Auftragsdaten und Details zur ausgewählten Versandmethode enthält. Ein Beispiel finden Sie in dieser Datei: callback_data.json

{
"order_id": 774,
"seller_id": 1223, // Das Etikett wird vom Verkäufer angefordert, wenn center_id 0 ist
"center_id": 0, // Das Etikett wird vom Center angefordert, wenn center_id nicht 0 ist
"remote_order_id": "ORD-2025-4055",
"order_date": "2025-05-13 08:49:28",
"ship_on_date": "2025-05-14",
"remote_carrier_id": "postnl_standard_001",
"carrier_code": "given carrier_code", // Wert ist in Kleinbuchstaben
"sender_details": {
"name": "John Doe",
"company_name": "Doe Logistics BV",
"street": "Keizersgracht",
"address_line_2": "Suite 301",
"country": "NL",
"house_number": "241",
"zipcode": "1016 EA",
"city": "Amsterdam",
"state_province_code": "",
"phone_number": "+31 20 123 4567",
"email": "[email protected]",
"signature_full_name": "John Doe",
"signature_initials": "JD",
"vat_number": "NL123456789B01",
"eori_number": "NL123456789000"
}
"shipping_address1": "Keizersgracht 123",
"shipping_address2": "2nd floor",
"shipping_address_supplement": "Entrance via side door",
"shipping_city": "Amsterdam",
"shipping_company": "KiteGear BV",
"shipping_country_code": "NL",
"shipping_email": "[email protected]",
"shipping_first_name": "Emma",
"shipping_house_number": "123",
"shipping_house_number_ext": "B",
"shipping_last_name": "van Dijk",
"shipping_middle_name": null,
"shipping_region": "Noord-Holland",
"shipping_street": "Keizersgracht",
"shipping_zip_code": "1015 CJ",
"shipping_address_accurate": 1,
"shipping_phone_number": "+31 6 12345678",
"shipping_service": "", // JSON-String
"billing_address1": "Keizersgracht 123",
"billing_address2": "2nd floor",
"billing_address_supplement": "Finance dept.",
"billing_city": "Amsterdam",
"billing_company": "KiteGear BV",
"billing_country_code": "NL",
"billing_email": "[email protected]",
"billing_first_name": "Emma",
"billing_house_number": "123",
"billing_house_number_ext": "B",
"billing_last_name": "van Dijk",
"billing_middle_name": null,
"billing_region": "Noord-Holland",
"billing_street": "Keizersgracht",
"billing_zip_code": "1015 CJ",
"billing_address_accurate": 1,
"billing_phone_number": "+31 20 1234567",
"total_weight": 8.0,
"total_length": 80,
"total_width": 25,
"total_height": 25,
"total_order_price": 749.95,
"total_order_currency": "EUR",
"order_products": [
{
"order_product_id": 868,
"order_product_price": 699.95,
"order_product_price_currency": "EUR",
"ean": "8719326583655",
"sku": null,
"quantity": 1,
"product_title": "North Orbit Kite 2025 - 12m",
"product_weight": "5.00",
"product_length": 80,
"product_width": 25,
"product_height": 15,
"product_hs_code": "95062900",
"remote_order_product_id": "NL-PROD-001",
"product_origin_country_code": "NL"
},
{
"order_product_id": 869,
"order_product_price": 50.00,
"order_product_price_currency": "EUR",
"ean": "8719326583617",
"sku": "TSHIRT-BLACK-M",
"quantity": 1,
"product_title": "Mystic Kite Pump Pro",
"product_weight": "3.00",
"product_length": 40,
"product_width": 10,
"product_height": 10,
"product_hs_code": "84142080",
"remote_order_product_id": "NL-PROD-002",
"product_origin_country_code": "DE"
}
]
}

Nach Erhalt dieser Daten sollen Sie ein Versandetikett-PDF erzeugen, es in Base64 kodieren und die folgende Antwort zurückgeben: callback_response.json

{
"label_id": 99999, // Ihre interne Etiketten-ID
"carrier_code": "DHL",
"tracking_number": "DHL87623654234",
"tracking_number_url": "https://dhl.com/tracking?DHL87623654234",
"pdf_content_base64": "JVBERi0xLjQKJeLjzgo8PC9UeXBlL0NhdGFsb2cvUG..."
}

Attribut

Beschreibung

label_id

Die Etiketten-ID in Ihrem System.

carrier_code

Der Versanddienstleister, der dieses Etikett erstellt hat (z. B.: DHL, PostNL, UPS).

tracking_number

Die Sendungsnummer des gleichen Versanddienstleisters, der das Etikett erstellt hat.

tracking_number_url

Der Link zur Sendungsverfolgung bei diesem Versanddienstleister.

pdf_content_base64

Die Etiketten-PDF-Datei als Base64-Text (Papierformat A6).

ChannelDock druckt dann das PDF-Etikett und sendet die Sendungsnummer an den Verkaufskanal, damit die Bestellung weiterverarbeitet werden kann.

Fehlerantwort - HTTP-Code im Bereich 400

{
"error": {
"message": "Hier eine für Menschen lesbare Fehlerbeschreibung"
}
}

Dieser Artikel wurde automatisch aus dem Englischen übersetzt.

Hat dies deine Frage beantwortet?