API für Pakete für Entwickler

1. Spediteure anhand der Sendungsnummer identifizieren (Suche)

Eine GET-Anfrage kann eine vollständige Liste aller unterstützten Spediteure der China-Pakete-Tracking-API abrufen. Dieser Endpunkt ist nützlich, um festzustellen, welche Spediteure mit einer bestimmten Sendungsnummer verknüpft sind, bevor eine Tracking-Anfrage gestartet wird.

Beispielanfrage


curl -X GET "https://developers.chinaparcels.com/api/v1/user/{USER_API_SECRET_ACCESS_KEY}/parcels/{TRACKING_NUMBER}/lookup"

Hinweis:

  • Ersetzen Sie {USER_API_SECRET_ACCESS_KEY} durch Ihren API-Geheimschlüssel aus dem Dashboard.
  • Ersetzen Sie {TRACKING_NUMBER} durch Ihre Sendungsnummer.

Beschreibung der Antwortparameter

  • error: Fehlercode, der das Ergebnis der Anfrage anzeigt (siehe Fehlercodes unten).
  • result: Ein Array mit IDs der Spediteure, die mit der Sendungsnummer übereinstimmen.

Beispielantwort


{
  "error": -1,
  "result": ["2", "4"]
}

In dieser Antwort:

  • 2 (USPS) und 4 (Royal Mail) sind die Spediteur-IDs, die mit der Sendungsnummer übereinstimmen. Sie können alle Spediteur-IDs im Abschnitt API der Spediteure einsehen.

Fehlercodes

  • -1 - Anfrage erfolgreich;
  • 0 - Benutzer nicht gefunden;
  • 1 - Guthaben erschöpft;

2. Paket nach Sendungsnummer verfolgen

Wir bieten zwei Methoden, um Ihr Paket zu verfolgen: Zuerst bestimmen wir den Spediteur automatisch mithilfe unseres Algorithmus. Alternativ können Sie den Spediteur angeben, um das Paket zu verfolgen.

2.1 Beispielanfrage mit automatischer Spediteurenerkennung


curl -X GET "https://developers.chinaparcels.com/api/v1/user/{USER_API_SECRET_ACCESS_KEY}/parcels/{TRACKING_NUMBER}/track"

Hinweis:

  • Ersetzen Sie {USER_API_SECRET_ACCESS_KEY} durch Ihren API-Geheimschlüssel aus dem Dashboard.
  • Ersetzen Sie {TRACKING_NUMBER} durch Ihre Sendungsnummer.

2.2 Beispielanfrage für die aktuelle Spediteur-ID


curl -X GET "https://developers.chinaparcels.com/api/v1/user/{USER_API_SECRET_ACCESS_KEY}/parcels/{TRACKING_NUMBER}/track/{CARRIER_ID}"

Hinweis:

  • Ersetzen Sie {USER_API_SECRET_ACCESS_KEY} durch Ihren API-Geheimschlüssel aus dem Dashboard.
  • Ersetzen Sie {TRACKING_NUMBER} durch Ihre Sendungsnummer.
  • Ersetzen Sie {CARRIER_ID} durch die Spediteur-ID aus dem Abschnitt API der Spediteure oder aus der Suche (oben).

Beschreibung der Antwortparameter

Hauptantwortobjekt

  • error: Fehlercode, der das Ergebnis der Anfrage anzeigt (siehe Fehlercodes unten).
  • result: Objekt, das Tracking-Daten und Daten des Spediteurs enthält.

Tracking-Daten (carrier_tracking_data)

Ein Array von Tracking-Ereignissen:

  • time: Zeitstempel des Ereignisses (Unix-Format).
  • info: Beschreibung des Ereignisses.
  • location: Standort, an dem das Ereignis stattgefunden hat.
  • date: Datum und Uhrzeit des Ereignisses im Format YYYY-MM-DD HH:mm:ss.

Paketdaten (parcel_other_data)

Details zum Paket:

  • postal_product: Das verwendete Postprodukt oder der Dienst (z. B. "Priority Mail Express International").
  • reference_tracking_numbers: Zusätzliches Array mit Referenz-Tracking-Nummern, falls verfügbar.
  • description: Eine vom Spediteur bereitgestellte Beschreibung des Pakets.
  • recipient: Empfängerinformationen, falls verfügbar.
  • sender: Absenderinformationen, falls verfügbar.
  • scheduled_delivery: Geschätzte Lieferinformationen des Spediteurs.
  • weight: Gewicht des Pakets.
  • dimensions: Abmessungen des Pakets.

Herkunfts- und Zielinformationen des Pakets

  • parcel_origin_country_code: ISO 3166-1 alpha-2 Ländercode des Herkunftslandes.
  • parcel_destination_country_code: ISO 3166-1 alpha-2 Ländercode des Ziellandes.

Spediteursdaten (carrier)

Informationen zum Spediteur:

  • carrier_website: Offizielle Website des Spediteurs.
  • carrier_email: Kontakt-E-Mail des Spediteurs.
  • carrier_phone: Kontakttelefonnummer des Spediteurs.
  • carrier_type: Typ des Spediteurs (z. B. "Post", "Kurier").
  • carrier_support: Gibt an, ob der Spediteur unterstützt wird (1: Ja, 0: Nein).
  • carrier_country_name: Land, in dem der Spediteur ansässig ist.
  • carrier_icon: URL des Spediteur-Icons.
  • carrier_icon_width: Breite des Spediteur-Icons (in Pixel).
  • carrier_icon_height: Höhe des Spediteur-Icons (in Pixel).
  • carrier_thumbnail: URL des Spediteur-Thumbnails.
  • carrier_thumbnail_width: Breite des Thumbnails (in Pixel).
  • carrier_thumbnail_height: Höhe des Thumbnails (in Pixel).
  • carrier_name: Name des Spediteurs.
  • carrier_country_code: ISO 3166-1 alpha-2 Ländercode des Spediteurs.
  • carrier_language_code: Sprachcode, den der Spediteur für Tracking-Daten verwendet (z. B. "en").

Lieferprognosen

  • estimate_delivery_days: Geschätzte Anzahl von Tagen bis zur Lieferung.
  • estimate_delivery_date: Geschätztes Lieferdatum (YYYY-MM-DD) ab dem ersten Tracking-Datum.

Paketstatus

  • status: Aktueller Status des Pakets:
    • 1 - Nicht gefunden;
    • 2 - In Transit;
    • 3 - Abholung; 
    • 4 - Zugestellt;
    • 5 - Warnung;
    • 6 - Nicht zugestellt;
    • 7 - Abgelaufen.

Beispielantwort


{
  "error": -1,
  "result": {
    "carrier_tracking_data": [
      {
        "time": 1733313180,
        "info": "Zollabfertigung.",
        "location": "TÜRKEI",
        "date": "2024-12-04 11:53:00"
      },
      {
        "time": 1733313000,
        "info": "Bearbeitet durch die Einrichtung.",
        "location": "TÜRKEI",
        "date": "2024-12-04 11:50:00"
      }
    ],


    "parcel_other_data": {
      "postal_product": "Priority Mail Express International",
      "reference_tracking_numbers": [
        "REF_NUMBER_01",
        "REF_NUMBER_02"
      ],
      "description": "Beschreibung des Pakets vom Spediteur",
      "recipient": "Empfängerinformationen",
      "sender": "Absenderinformationen",
      "scheduled_delivery": "Geplante Lieferinformationen",
      "weight": "Paketgewicht",
      "dimensions": "Paketabmessungen"
    },
    "parcel_origin_country_code": "us",
    "parcel_destination_country_code": "tr",
    "status": 2,
    "carrier": {
      "carrier_website": "https://www.usps.com",
      "carrier_email": "support@usps.com",
      "carrier_phone": "1-800-222-1811",
      "carrier_type": "Post",
      "carrier_country_name": "Vereinigte Staaten von Amerika",
      "carrier_name": "USPS",


    "parcel_other_data": {
      "postal_product": "Priority Mail Express International",
      "reference_tracking_numbers": [
        "REF_NUMBER_01",
        "REF_NUMBER_02"
      ],
      "description": "Beschreibung des Pakets vom Spediteur",
      "recipient": "Empfängerinformationen",
      "sender": "Absenderinformationen",
      "scheduled_delivery": "Geplante Lieferinformationen",
      "weight": "Paketgewicht",
      "dimensions": "Paketabmessungen"
    },
    "parcel_origin_country_code": "us",
    "parcel_destination_country_code": "tr",
    "status": 2,
    "carrier": {
      "carrier_website": "https://www.usps.com",
      "carrier_email": "support@usps.com",
      "carrier_phone": "1-800-222-1811",
      "carrier_type": "Post",
      "carrier_country_name": "Vereinigte Staaten von Amerika",
      "carrier_name": "USPS",


      "carrier_icon": "http://developers.chinaparcels.com/cdn/images/carriers/icons/0002-usps.png",
      "carrier_icon_width": 256,
      "carrier_icon_height": 256,
      "carrier_thumbnail": "http://developers.chinaparcels.com/cdn/images/carriers/thumbnails/0002-usps.png",
      "carrier_thumbnail_width": 640,
      "carrier_thumbnail_height": 256,
      "carrier_country_code": "us",
      "carrier_language_code": "en"
    },
    "estimate_delivery_days": 16,
    "estimate_delivery_date": "2024-12-13"
  }
}

Fehlercodes

  • -1 - Anfrage erfolgreich;
  • 0 - Benutzer nicht gefunden;
  • 1 - Guthaben erschöpft;
  • 3 - Spediteur mit dieser Nummer nicht gefunden (für automatische Spediteurenerkennung).