Zum Hauptinhalt springen

Verbindung zur benutzerdefinierten Carrier-API herstellen

R
Verfasst von Rosalie Hulshof
Heute aktualisiert

ChannelDock bietet eine große Auswahl vorgefertigter Spediteur-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 Spediteurplattform zu erstellen, haben wir eine Reihe von APIs entwickelt, die es Ihnen als Spediteur ermöglichen, Versandmethoden in ChannelDock für einen bestimmten Verkäufer oder ein bestimmtes Fulfillment-Center zu erstellen.

Dieser Leitfaden beschreibt die Schritte, die Sie befolgen müssen, um diese Integration abzuschließen.

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

Schritt 2:
Der nächste Schritt ist, die Versandmethoden, die Sie als Spediteur anbieten, in ChannelDock hinzuzufügen. Weitere Informationen zum Endpunkt und zur erwarteten JSON-Struktur finden Sie hier:
- Verkäufer: Postman-Dokumentation
- Fulfillment-Center: Postman-Dokumentation

Schritt 3:
Immer wenn ein ChannelDock-Nutzer versucht, ein Versandetikett mit Ihren Versandmethoden zu erstellen, senden wir Ihnen ein JSON-Objekt mit den Bestelldaten und Details zur ausgewählten Versandmethode.

{
"order_id": 774,
"seller_id": 1223,
"center_id": 0,
"api_id": 456,
"api_description": "Bol.com - Main shop",
"channel_name": "Bol.com",
"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",
"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": "",
"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.0,
"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 als PDF erzeugen, dieses in Base64 kodieren und die folgende Antwort zurückgeben:

{
"label_id": 99999, // Your internal label id
"carrier_code": "DHL",
"tracking_number": "DHL87623654234",
"tracking_number_url": "https://dhl.com/tracking?DHL87623654234",
"pdf_content_base64": "JVBERi0xLjQKJeLjzgo8PC9UeXBlL0NhdGFsb2cvUG..."
}

Attribut

Beschreibung

label_id

Die Label-ID in Ihrem System.

carrier_code

Der Spediteur, der dieses Etikett erstellt hat (zum Beispiel: DHL, PostNL, UPS).

tracking_number

Die Sendungsnummer des selben Spediteurs, der das Etikett erstellt hat.

tracking_number_url

Der Link, um diese Sendung bei diesem Spediteur zu verfolgen.

pdf_content_base64

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

ChannelDock druckt dann das PDF-Etikett und sendet die Sendungsnummer an den Verkaufskanal, damit die Bestellung verarbeitet wird.

Fehlerantwort - HTTP-Code-Bereich 400

{
"error": {
"message": "Human readable error explanation here"
}
}

Dieser Artikel wurde automatisch aus dem Englischen übersetzt.

Hat dies deine Frage beantwortet?