API de Transportistas para Desarrolladores

1. Lista Completa de Transportistas

Una solicitud GET puede recuperar una lista completa de todos los transportistas compatibles con la API de seguimiento de Paquetes de China.

Ejemplo de Solicitud

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

Nota: Sustituye {USER_API_SECRET_ACCESS_KEY} por tu clave secreta de API única desde tu panel de control.

Descripción de los Parámetros de Respuesta

Aquí tienes una explicación detallada de los parámetros de respuesta:

• error: Código de error que indica el resultado de la solicitud (consulta la lista de códigos de error).
• result: Una matriz de objetos que contiene información sobre los transportistas.
  • carrier_id: Identificador único del transportista.
  • carrier_name: Nombre del transportista (ej.: "China Post", "USPS").
  • carrier_type: Tipo de transportista (ej.: "postal", "mensajería").
  • carrier_support: Indica si el seguimiento está disponible:
    • 1: Compatible.
    • 0: No compatible.
  • carrier_country_code: Código de país del transportista en formato ISO 3166-1 alfa-2 (ej.: "cn" para China, "us" para Estados Unidos).

Ejemplo de Respuesta (Parcial)

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

Códigos de Error

• -1 - Solicitud exitosa;
• 0 - Usuario no encontrado;
• 1 - Sin saldo;

2. Información Detallada de un Transportista

Una solicitud GET puede recuperar información detallada sobre un transportista utilizando la API de Seguimiento de Paquetes de China Parcels.

Ejemplo de Solicitud

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

Nota:

• Sustituye {USER_API_SECRET_ACCESS_KEY} por tu clave secreta de API única desde tu panel de control.
• Sustituye {CARRIER_ID} por el identificador único del transportista obtenido en la solicitud anterior.

Descripción de los Parámetros de Respuesta

• error: Código de error que indica el resultado de la solicitud (consulta la lista de códigos de error).
• result: Un objeto que contiene información detallada sobre el transportista:
  • carrier_id: Identificador único del transportista.
  • carrier_name: Nombre del transportista (ej.: "USPS").
  • carrier_type: Tipo de transportista (ej.: "postal", "mensajería").
  • carrier_support: Indica si el seguimiento está disponible:
    • 1: Compatible.
    • 0: No compatible.
  • carrier_website: Sitio web oficial del transportista.
  • carrier_email: Correo electrónico de contacto del transportista (si está disponible).
  • carrier_phone: Teléfono de contacto del transportista (si está disponible).
  • carrier_country_code: Código de país del transportista en formato ISO 3166-1 alfa-2.
  • carrier_country_name: Nombre completo del país del transportista.
  • carrier_icon_background_hex: Color de fondo del icono del transportista (en formato HEX).
  • carrier_language_code: Código de idioma utilizado por el transportista en los datos de seguimiento (ej.: "en" para inglés).
  • carrier_icon: URL del icono del transportista.
  • carrier_icon_width: Anchura (en píxeles) del icono del transportista.
  • carrier_icon_height: Altura (en píxeles) del icono del transportista.
  • carrier_thumbnail: URL de la miniatura del transportista.
  • carrier_thumbnail_width: Anchura (en píxeles) de la miniatura.
  • carrier_thumbnail_height: Altura (en píxeles) de la miniatura.

Ejemplo de Respuesta

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

Códigos de Error

• -1 - Solicitud exitosa;
• 0 - Usuario no encontrado;
• 1 - Sin saldo;
• 2 - Transportista no encontrado;