API dei Corrieri per gli Sviluppatori

1. Elenco Completo dei Corrieri

Una richiesta GET può recuperare un elenco completo di tutti i corrieri supportati dall'API di tracciamento di Pacchi dalla Cina.

Esempio di Richiesta

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

Nota: Sostituisci {USER_API_SECRET_ACCESS_KEY} con la tua chiave API univoca ottenuta dal tuo pannello di controllo.

Descrizione dei Parametri di Risposta

Ecco una spiegazione dettagliata dei parametri di risposta:

• error: Codice di errore che indica il risultato della richiesta (consulta l'elenco dei codici di errore).
• result: Un array di oggetti contenenti informazioni sui corrieri.
  • carrier_id: L'identificativo univoco del corriere.
  • carrier_name: Il nome del corriere (ad esempio, "Posta Cinese", "USPS").
  • carrier_type: Il tipo di corriere (ad esempio, "postale", "corriere").
  • carrier_support: Indica se il tracciamento è supportato:
    • 1: Supportato.
    • 0: Non supportato.
  • carrier_country_code: Il codice del paese del corriere nel formato ISO 3166-1 alpha-2 (ad esempio, "cn" per Cina, "us" per Stati Uniti).

Esempio di Risposta (Parziale)

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

Codici di Errore

• -1 - Richiesta riuscita;
• 0 - Utente non trovato;
• 1 - Saldo insufficiente;

2. Informazioni Dettagliate su un Corriere

Una richiesta GET può essere inviata per ottenere informazioni dettagliate su un corriere utilizzando l'API di tracciamento di China Parcels.

Esempio di Richiesta

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

Nota:

• Sostituisci {USER_API_SECRET_ACCESS_KEY} con la tua chiave API univoca ottenuta dal tuo pannello di controllo.
• Sostituisci {CARRIER_ID} con l'identificativo univoco del corriere ottenuto precedentemente.

Descrizione dei Parametri di Risposta

• error: Codice di errore che indica il risultato della richiesta (consulta l'elenco dei codici di errore).
• result: Un oggetto contenente informazioni dettagliate sul corriere:
  • carrier_id: L'identificativo univoco del corriere.
  • carrier_name: Il nome del corriere (ad esempio, "USPS").
  • carrier_type: Il tipo di corriere (ad esempio, "postale", "corriere").
  • carrier_support: Indica se il tracciamento è supportato:
    • 1: Supportato.
    • 0: Non supportato.
  • carrier_website: Il sito ufficiale del corriere.
  • carrier_email: L'indirizzo e-mail del corriere (se disponibile).
  • carrier_phone: Il numero di telefono del corriere (se disponibile).
  • carrier_country_code: Il codice del paese del corriere nel formato ISO 3166-1 alpha-2.
  • carrier_country_name: Il nome completo del paese del corriere.
  • carrier_icon_background_hex: Il colore di sfondo dell'icona del corriere (formato HEX).
  • carrier_language_code: Il codice della lingua utilizzato dal corriere nei dati di tracciamento (ad esempio, "en" per inglese).
  • carrier_icon: L'URL dell'icona del corriere.
  • carrier_icon_width: La larghezza dell'icona del corriere (in pixel).
  • carrier_icon_height: L'altezza dell'icona del corriere (in pixel).
  • carrier_thumbnail: L'URL della miniatura del corriere.
  • carrier_thumbnail_width: La larghezza della miniatura (in pixel).
  • carrier_thumbnail_height: L'altezza della miniatura (in pixel).

Esempio di Risposta

{
  "error": -1,
  "result": {
    "carrier_id": "2",
    "carrier_name": "USPS",
    "carrier_type": "postale",
    "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
  }
}

Codici di Errore

• -1 - Richiesta riuscita;
• 0 - Utente non trovato;
• 1 - Saldo insufficiente;
• 2 - Corriere non trovato;