API de Transportadoras para Desenvolvedores

1. Lista Completa de Transportadoras

Uma solicitação GET pode recuperar uma lista completa de todas as transportadoras suportadas pela API de Rastreamento de Pacotes da China.

Exemplo de Solicitação

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

Nota: Substitua {USER_API_SECRET_ACCESS_KEY} pela sua chave de API exclusiva obtida no painel de controle.

Descrição dos Parâmetros de Resposta

Abaixo está uma explicação detalhada dos parâmetros de resposta:

• error: Código de erro que indica o resultado da solicitação (consulte a lista de códigos de erro).
• result: Uma matriz de objetos contendo informações sobre as transportadoras.
  • carrier_id: Identificador exclusivo da transportadora.
  • carrier_name: Nome da transportadora (por exemplo, "Correio da China", "USPS").
  • carrier_type: Tipo de transportadora (por exemplo, "postal", "courier").
  • carrier_support: Indica se o rastreamento é suportado:
    • 1: Suportado.
    • 0: Não suportado.
  • carrier_country_code: Código do país da transportadora no formato ISO 3166-1 alpha-2 (por exemplo, "cn" para China, "us" para Estados Unidos).

Exemplo de Resposta (Parcial)

{
  "error": -1,
  "result": [
    {
      "carrier_id": "1",
      "carrier_name": "Correio da China",
      "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 Erro

• -1 - Solicitação bem-sucedida;
• 0 - Usuário não encontrado;
• 1 - Saldo insuficiente;

2. Informações Detalhadas sobre uma Transportadora

Uma solicitação GET pode ser enviada para recuperar informações detalhadas sobre uma transportadora usando a API de Rastreamento da China Parcels.

Exemplo de Solicitação

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

Nota:

• Substitua {USER_API_SECRET_ACCESS_KEY} pela sua chave de API exclusiva obtida no painel de controle.
• Substitua {CARRIER_ID} pelo identificador exclusivo da transportadora obtido anteriormente.

Descrição dos Parâmetros de Resposta

• error: Código de erro que indica o resultado da solicitação (consulte a lista de códigos de erro).
• result: Um objeto contendo informações detalhadas sobre a transportadora:
  • carrier_id: Identificador exclusivo da transportadora.
  • carrier_name: Nome da transportadora (por exemplo, "USPS").
  • carrier_type: Tipo de transportadora (por exemplo, "postal", "courier").
  • carrier_support: Indica se o rastreamento é suportado:
    • 1: Suportado.
    • 0: Não suportado.
  • carrier_website: Site oficial da transportadora.
  • carrier_email: Endereço de e-mail da transportadora (se disponível).
  • carrier_phone: Número de telefone de contato da transportadora (se disponível).
  • carrier_country_code: Código do país da transportadora no formato ISO 3166-1 alpha-2.
  • carrier_country_name: Nome completo do país da transportadora.
  • carrier_icon_background_hex: Cor de fundo do ícone da transportadora (formato HEX).
  • carrier_language_code: Código do idioma usado pela transportadora nos dados de rastreamento (por exemplo, "en" para inglês).
  • carrier_icon: URL do ícone da transportadora.
  • carrier_icon_width: Largura do ícone da transportadora (em pixels).
  • carrier_icon_height: Altura do ícone da transportadora (em pixels).
  • carrier_thumbnail: URL da miniatura da transportadora.
  • carrier_thumbnail_width: Largura da miniatura (em pixels).
  • carrier_thumbnail_height: Altura da miniatura (em pixels).

Exemplo de Resposta

{
  "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 Erro

• -1 - Solicitação bem-sucedida;
• 0 - Usuário não encontrado;
• 1 - Saldo insuficiente;
• 2 - Transportadora não encontrada;