API перевозчиков для разработчиков

1. Полный список перевозчиков

Запрос GET может получить полный список всех перевозчиков, поддерживаемых системой отслеживания Посылки из Китая API.

Пример запроса


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

Примечание: Замените {USER_API_SECRET_ACCESS_KEY} на ваш уникальный API-ключ, полученный в панели управления.

Описание параметров ответа

Ниже приведено подробное описание параметров ответа:

error: Код ошибки, указывающий на результат запроса (см. список кодов ошибок).
result: Массив объектов, содержащих информацию о перевозчиках.
- carrier_id: Уникальный идентификатор перевозчика.
- carrier_name: Название перевозчика (например, "Почта Китая", "USPS").
- carrier_type: Тип перевозчика (например, "почта", "курьер").
- carrier_support: Указывает, поддерживается ли отслеживание:
  - 1: Поддерживается.
  - 0: Не поддерживается.
- carrier_country_code: Код страны перевозчика в формате ISO 3166-1 alpha-2 (например, "cn" для Китая, "us" для США).

Пример ответа (частичный)


{
  "error": -1,
  "result": [
    {
      "carrier_id": "1",
      "carrier_name": "Почта Китая",
      "carrier_type": "почта",
      "carrier_support": "1",
      "carrier_country_code": "cn"
    },
    {
      "carrier_id": "2",
      "carrier_name": "USPS",
      "carrier_type": "почта",
      "carrier_support": "1",
      "carrier_country_code": "us"
    },
    {
      "carrier_id": "3",
      "carrier_name": "Canada Post",
      "carrier_type": "почта",
      "carrier_support": "1",
      "carrier_country_code": "ca"
    },
    {
      "carrier_id": "4",
      "carrier_name": "Royal Mail",
      "carrier_type": "почта",
      "carrier_support": "1",
      "carrier_country_code": "gb"
    }
  ]
}

Коды ошибок

-1 - Запрос выполнен успешно;
0 - Пользователь не найден;
1 - Недостаточно средств на балансе;

2. Подробная информация о перевозчике

Запрос GET может быть отправлен для получения подробной информации о перевозчике с использованием API отслеживания China Parcels.

Пример запроса


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

Примечание:

Замените {USER_API_SECRET_ACCESS_KEY} на ваш уникальный API-ключ, полученный в панели управления.
Замените {CARRIER_ID} на уникальный идентификатор перевозчика, полученный ранее.

Описание параметров ответа

error: Код ошибки, указывающий на результат запроса (см. список кодов ошибок).
result: Объект, содержащий подробную информацию о перевозчике:
- carrier_id: Уникальный идентификатор перевозчика.
- carrier_name: Название перевозчика (например, "USPS").
- carrier_type: Тип перевозчика (например, "почта", "курьер").
- carrier_support: Указывает, поддерживается ли отслеживание:
  - 1: Поддерживается.
  - 0: Не поддерживается.
- carrier_website: Официальный веб-сайт перевозчика.
- carrier_email: Контактный email перевозчика (если доступен).
- carrier_phone: Контактный телефон перевозчика (если доступен).
- carrier_country_code: Код страны перевозчика в формате ISO 3166-1 alpha-2.
- carrier_country_name: Полное название страны перевозчика.
- carrier_icon_background_hex: Цвет фона значка перевозчика (в формате HEX).
- carrier_language_code: Код языка, используемого перевозчиком в данных отслеживания (например, "en" для английского).
- carrier_icon: URL значка перевозчика.
- carrier_icon_width: Ширина значка перевозчика (в пикселях).
- carrier_icon_height: Высота значка перевозчика (в пикселях).
- carrier_thumbnail: URL миниатюры перевозчика.
- carrier_thumbnail_width: Ширина миниатюры (в пикселях).
- carrier_thumbnail_height: Высота миниатюры (в пикселях).

Пример ответа


{
  "error": -1,
  "result": {
    "carrier_id": "2",
    "carrier_name": "USPS",
    "carrier_type": "почта",
    "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
  }
}

Коды ошибок

-1 - Запрос выполнен успешно;
0 - Пользователь не найден;
1 - Недостаточно средств на балансе;
2 - Перевозчик не найден;