TrackingMore API

API key

Для использования данного API вам необходимо создать API-ключ для TrackingMore в API Keys.Получить доступ к бесплатному API.

The base URL

http://api.trackingmore.com/v2

Header

In order to verify and authenticate your application (e.g. your site), all of the requests that you make to the API must include your unique TrackingMore API Key header (Trackingmore-Api-Key), which you can generate and/or find in the TrackingMore Panel.

Content-Type: application/json
Trackingmore-Api-Key: YOUR_API_KEY

Список статусов отслеживания отправления

StringDescription
pendingНовые отправления, которые ожидают отслеживания
notfoundВ настоящее время элементы не найдены.
transitОтправление покинуло почтовое отделение и находится в пути к месту назначения
pickupОтправление выдано для доставки или прибыло в ваше отделение связи (вы можете планировать получение отправления)
deliveredОтправление успешно доставлено.
undeliveredПеревозчик осуществил неудачную попытку вручения отправления. Обычно перевозчики оставляют уведомление и производят повторную доставку.
exceptionВаше отправление оказалось в нестандартной ситуации. Скорее всего, оно было возвращено отправителю, не прошло таможенное оформление или было повреждено.
expiredОтправление находится в пути в течение длительного периода. Доставка не осуществлена.

Стандартные ответы сервера

Мы направим ответ, содержащий один из следующих кодов состояния.

CodeDescription
200OK - Успешная обработка запроса (некоторые API могут вернуть ответ 201).
201Created - Запрос успешно обработан. Указанный ресурс был создан.
202Created - Запрос был успешно обработан, но вы превысили лимит.
401Unauthorized - Ошибка авторизации или у пользователя отсутствуют права на выполнение указанной операции.
4001Unauthorized - Неправильный API-ключ.
4002Unauthorized - API-ключ был удален.
4012Bad Request - Запрос не может быть распознан или не содержит ключевых параметров.
4013Bad Request - Необходимо указать номер для отслеживания Tracking_number.
4014Bad Request - Некорректное значение поля `tracking_number`.
4015Bad Request - Некорректное значение поля `carrier_code`.
4016Bad Request - Такой номер уже существует.
4017Bad Request - Такого номера не существует.
4018Bad Request - Данная функция активируется в индивидуальном порядке из-за риска перегрузки системы. Пожалуйста, напишите на [email protected] для получения более подробной информации.
4020Bad Request - Не более 200 отправлений за один раз
4021Bad Request - Недостаточно средств. Вы не можете получить данные из API.
4031No Content - Запрос успешно обработан, однако сервер прислал пустой ответ.
4032No Content - Не удалось определить перевозчика.
4033No Content - The value of `status` is invalid.
402Payment Required - Требуется оплата.
403Forbidden - Доступ запрещен.
404Not Found - Ресурс не найден.
405Method Not Allowed - Выбранный метод не поддерживается данным ресурсом.
409Conflict - Запрос не может быть выполнен из-за возникновения конфликта.
429Too Many Requests - Превышение лимита API. Пожалуйста, подождите две минуты и повторите ваш запрос.
500Server error
503Service Unavailable - Сервис временно недоступен (например, производится плановое обслуживание системы). Попробуйте повторить запрос позднее.

Ограничение частоты запросов

Обратите внимание, что мы используем небольшое значение для ограничения частоты запросов. Превышение данного ограничения приведет к ошибке 429..

  • Отслеживание в реальном времени: не более 3 запросов в секунду с одного IP-адреса.

  • Показать все отправления. Не более 1 запроса, содержащего не более 2000 номеров, в секунду