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: Тип перевізника (наприклад, "post", "carrier").
- 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} на унікальний ідентифікатор перевізника, отриманий раніше.

Коди помилок

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

2. Детальна інформація про перевізника

Приклад запиту


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 - Перевізника не знайдено;