Trackru API

По любым возникшим вопросам, касающимся Апи интеграции, пишите на нашу почту: [email protected]

Trackru API

Получить API ключ

Для интеграции с API необходимо располагать: API Keys.

The base URL

https://api.trackru.ru/v1

При работе с API, : спользуется HTTPS соединение, а также http.

Заголовки

Для проверки и аутентификации вашего приложения (например, вашего сайта) все запросы к API должны включать ваш уникальный Trackru API ключ ( Api-Key),вы можете сгенерировать ключ авторизации Api-Key.

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

Отчет "Статусы заказов"

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

Подстатусы "Не найдено" Описание
not found001Информация получена. Заказ готов к перевозке.
not found002Нет информации об отслеживании данного заказа.

Подстатус "Исключение" Описание
exception001 Заказ отправлен ** дней без информации отслеживания, помечен как «Исключение».
exception002Заказ в пути ** дней без информации отслеживания, помечен как «Исключение».
exception003Заказ отправлен ** но не доставлен, помечен как «Исключение».
exception004Невостребованное отправление.
exception005Посылка была отправлена обратно отправителю.
exception006Посылка задержана на таможне, это запрещённый товар.
exception007Посылка утеряна или повреждена.
exception008Доставка отменена до доставки.

Список возврата параметров API

ЗначниеОписание
code Meta.code
type Meta.type
message Meta status description
id Произвольные данные, генерируемые Trackru для идентификации трекинга
tracking_number Трек-номер или номер для отслеживания
carrier_code Код службы доставки
status Статус посылки
created_at Время добавления трек-номера
updated_at Время последнего обновления статуса посылки
order_create_time Время создания заказа
title Название продукта
order_id Номер заказа
comment Ваше замечание к заказу
customer_name Имя покупателя
customer_email email покупателя
original_country Название страны происхождения
singed_by Имя получателя
lastEvent Последнее обновление статуса
lastUpdateTime Время последней информации отслеживания
destination_country Название страны назначения
itemTimeLength Время перевозки заказа
stayTimeLength Общее количество дней без обновлений с момента появления последнего обновления
origin_info Информация об отправлении предоставляется службой доставки отправителя.
ItemReceived Время обновления первого статуса
ItemDispatched Время отпракви с сортировочного центра.
DepartfromAirport Время прибытия на аэропорт.
ArrivalfromAbroad Время прибытия в страну назначения.
CustomsClearance Время передачи посылки таможне.
DestinationArrived Время прибытия в пункт назначения.
weblink Ссылка на официальный сайт службы доставки.
phone Телефон службы доставки
trackinfo Подробная информация об отслеживании
Date Дата определенного статуса
StatusDescription Основное содержание определенного статуса
Details Информация о местоположении отправления
destination_info Информация об отправлении предоставляется службой доставки получателя.

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

Мы ответим Вам одним из следующих кодов состояния.

Meta.codeMeta.type Описание
200 Success Запрос был успешно выполнен (некоторые вызовы API могут возвращать вместо этого код 201).
201 Created Запрос был успешно выполнен и ресурс был создан.
202 Bad Request Запрос был успешно выполнен, но был превышен лимит.
401 Unauthorized Ошибка аутентификации или пользователь не имеет достаточно прав для совершения запрашиваемой операции.
4001 Unauthorized Ошибочный API ключ. Проверьте его правильность. Check
4002 Unauthorized API ключ был удален. Проверьте его состояние. Check
4012 Bad Request Не ясен запрос или отсутствуют необходимые параметры.
4013 Bad Request Требуется трек-номер.
4014 Bad Request Недопустимое значение трек-номера.
4015 Bad Request Недопустимое значение "carrier_code". Проверьте его правильность здесь Check Код службы доставки
4016 Bad Request Данное отслеживание уже существует.
4017 Bad Request Данное отслеживание не существует.
4018 Bad Request Из-за рисков перегрузки данная функция требует активации службой поддержки. Свяжитесь по адресу [email protected] для уточнения дополнительной информации.
4019 Bad Request Баланс израсходован, пожалуйста, пополните счет для продолжения. Бесплатный аккаунт поддерживает до 500 номеров в месяц.
4020 Bad Request Максимум 200 за один раз.
4021 Bad Request Остатка на балансе не достаточно для совершения операции с API. Пополнить. Purchase here.
4031 No Content Запрос был успешно выполнен, но ответ пуст. Попробуйте POST /trackings/post и затем GET /trackings/get
4032 No Content Не удается определить службу доставки. Требуется указать службу доставки вручную. Получить код службы доставки.
4033 No Content Недопустимое значение "статуса".
402 Payment Required Требуется оплата.
403 Forbidden Доступ запрещен.
404 Not Found Ресурс не найден.
405 Method Not Allowed Запрашиваемый метод не поддерживается для указанного ресурса.
409 Conflict Запрос не может быть выполнен из-за конфликта.
429 Too Many Requests Превышены лимиты API. Подождите две минуты и повторите попытку.
500 Server error
503 Service Unavailable Услуга временно недоступна (возможно плановое обслуживание системы). Повторите попытку позже.

Лимит запроса

Мы применяем ограничений по количеству запросов. Имейте в виду, что если запросы превысит эти пределы, вы получите ошибку 429..

  • POST /trackings/realtime        Отслеживание в режиме реального времени: для каждого IP-адреса, максимум 3 запроса в секунду.
  • GET /trackings/get                    Список всех отслеживаний; каждый IP-адрес, максимум 1 запрос, до 2000 отслеживаний в секунду.