API der Paketdienste für Entwickler

1. Vollständige Liste der Anbieter

Eine GET-Anfrage kann eine vollständige Liste aller von der China-Pakete Tracking API unterstützten Anbieter abrufen.

Beispielanfrage

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

Hinweis: Ersetzen Sie {USER_API_SECRET_ACCESS_KEY} durch Ihren einzigartigen API-Schlüssel, den Sie in Ihrem Dashboard erhalten haben.

Beschreibung der Antwortparameter

Hier ist eine detaillierte Erklärung der Antwortparameter:

• error: Fehlercode, der das Ergebnis der Anfrage angibt (siehe Fehlercodeliste).
• result: Ein Array von Objekten, das Informationen zu den Anbietern enthält.
  • carrier_id: Die eindeutige Kennung des Anbieters.
  • carrier_name: Der Name des Anbieters (z. B. "China Post", "USPS").
  • carrier_type: Die Art des Anbieters (z. B. "post", "kurier").
  • carrier_support: Gibt an, ob das Tracking unterstützt wird:
    • 1: Unterstützt.
    • 0: Nicht unterstützt.
  • carrier_country_code: Der Ländercode des Anbieters im ISO 3166-1 alpha-2-Format (z. B. "cn" für China, "us" für die Vereinigten Staaten).

Beispielantwort (Teilweise)

{
  "error": -1,
  "result": [
    {
      "carrier_id": "1",
      "carrier_name": "China Post",
      "carrier_type": "post",
      "carrier_support": "1",
      "carrier_country_code": "cn"
    },
    {
      "carrier_id": "2",
      "carrier_name": "USPS",
      "carrier_type": "post",
      "carrier_support": "1",
      "carrier_country_code": "us"
    },
    {
      "carrier_id": "3",
      "carrier_name": "Canada Post",
      "carrier_type": "post",
      "carrier_support": "1",
      "carrier_country_code": "ca"
    },
    {
      "carrier_id": "4",
      "carrier_name": "Royal Mail",
      "carrier_type": "post",
      "carrier_support": "1",
      "carrier_country_code": "gb"
    }
  ]
}

Fehlercodes

• -1 - Anfrage erfolgreich;
• 0 - Benutzer nicht gefunden;
• 1 - Kein Guthaben vorhanden;

2. Detaillierte Informationen zu einem Anbieter

Mit der Tracking-API von China Parcels kann eine GET-Anfrage gesendet werden, um detaillierte Informationen zu einem Anbieter abzurufen.

Beispielanfrage

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

Hinweis:

• Ersetzen Sie {USER_API_SECRET_ACCESS_KEY} durch Ihren einzigartigen API-Schlüssel, den Sie in Ihrem Dashboard erhalten haben.
• Ersetzen Sie {CARRIER_ID} durch die eindeutige Kennung des Anbieters, die Sie zuvor erhalten haben.

Beschreibung der Antwortparameter

• error: Fehlercode, der das Ergebnis der Anfrage angibt (siehe Fehlercodeliste).
• result: Ein Objekt, das detaillierte Informationen zum Anbieter enthält:
  • carrier_id: Die eindeutige Kennung des Anbieters.
  • carrier_name: Der Name des Anbieters (z. B. "USPS").
  • carrier_type: Die Art des Anbieters (z. B. "post", "kurier").
  • carrier_support: Gibt an, ob das Tracking unterstützt wird:
    • 1: Unterstützt.
    • 0: Nicht unterstützt.
  • carrier_website: Die offizielle Website des Anbieters.
  • carrier_email: Die Kontakt-E-Mail-Adresse des Anbieters (falls verfügbar).
  • carrier_phone: Die Kontakttelefonnummer des Anbieters (falls verfügbar).
  • carrier_country_code: Der Ländercode des Anbieters im ISO 3166-1 alpha-2-Format.
  • carrier_country_name: Der vollständige Name des Landes, in dem der Anbieter tätig ist.
  • carrier_icon_background_hex: Die Hintergrundfarbe des Anbieter-Icons (HEX-Format).
  • carrier_language_code: Der Sprachcode, der vom Anbieter in den Tracking-Daten verwendet wird (z. B. "en" für Englisch).
  • carrier_icon: Die URL zum Icon des Anbieters.
  • carrier_icon_width: Die Breite des Anbieter-Icons (in Pixel).
  • carrier_icon_height: Die Höhe des Anbieter-Icons (in Pixel).
  • carrier_thumbnail: Die URL zur Miniaturansicht des Anbieters.
  • carrier_thumbnail_width: Die Breite der Miniaturansicht (in Pixel).
  • carrier_thumbnail_height: Die Höhe der Miniaturansicht (in Pixel).

Beispielantwort

{
  "error": -1,
  "result": {
    "carrier_id": "2",
    "carrier_name": "USPS",
    "carrier_type": "post",
    "carrier_support": "1",
    "carrier_website": "https://www.usps.com",
    "carrier_email": "support@usps.com",
    "carrier_phone": "1-800-222-1811",
    "carrier_country_code": "us",
    "carrier_country_name": "United States of America",
    "carrier_icon_background_hex": "#333366",
    "carrier_language_code": "en",
    "carrier_icon": "https://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
  }
}

Fehlercodes

• -1 - Anfrage erfolgreich;
• 0 - Benutzer nicht gefunden;
• 1 - Kein Guthaben vorhanden;
• 2 - Anbieter nicht gefunden;