ParcelTrack API

ParcelTrack API

Get API key

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

The base URL

https://api.parceltrack.ru/v1

Note : "http" is also supported.

Headers

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 Trackru API Key header (Api-Key), which you can generate and/or find in the Api-Key.

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

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

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

Notfound SubStatus Description
not found001Information Received/info received. The package is about to be picked up.
not found002There is no tracking information for this package.

Exception SubStatus Description
exception001Tracking number added more than ** with no tracking info, marked as "Exception".
exception002Package in transit for ** with no marked as "Exception".
exception003Tracking number added more than ** but not delivered, marked as "Exception".
exception004The package is unclaimed.
exception005The package was sent back to the sender.
exception006The package is retained by customs because it's prohibited goods.
exception007The package is damaged, lost or discarded.
exception008The package is canceled before delivering.

API Parameter Return List

StringDescription
code Meta.code
type Meta.type
message Meta status description
id A random data generated by ParcelTrack to identify a tracking
tracking_number Package tracking number
carrier_code Courier code
status Package status
created_at Time a tracking number was added
updated_at Latest time a tracking number was updated
order_create_time Time an order was created
title Product title
order_id Order ID
comment Your remark to a shipment
customer_name Customer name
customer_email Customer email
original_country Origin country name
singed_by Recipient name
lastEvent Latest tracking info
lastUpdateTime Time of latest tracking info
destination_country Destination country name
itemTimeLength Transportation time of a shipment
stayTimeLength Total days no update since the time last tracking info appeared
origin_info Tracking info from origin courier
ItemReceived Time of a first tracking info appeared
ItemDispatched Time of departure from outward office of exchange
DepartfromAirport Time of arrival at airport
ArrivalfromAbroad Time of arrival at destination country
CustomsClearance Time a package was handed over to customs
DestinationArrived Time of arrival at delivery office
weblink Courier official website link
phone Courier phone number
trackinfo Details of package tracking info
Date Time of a specific piece of tracking info
StatusDescription Main contents of a piece of tracking info
Details Location info appeared in a specific piece of tracking info
destination_info Tracking info from destination courier

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

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

Meta.codeMeta.typeDescription
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 Необходимо указать номер для отслеживания Tracking_number.
4014 Bad Request Некорректное значение поля `tracking_number`.
4015 Bad Request Некорректное значение поля `carrier_code`. Check courier code
4016 Bad Request Такой номер уже существует.
4017 Bad Request Такого номера не существует.
4018 Bad Request Данная функция активируется в индивидуальном порядке из-за риска перегрузки системы. Пожалуйста, напишите на service@trackingmore.org для получения более подробной информации.
4019 Bad Request Your balance is not enough, please recharge in time, free account can add up to 500 single numbers per month.
4020 Bad Request Не более 200 отправлений за один раз
4021 Bad Request Недостаточно средств. Вы не можете получить данные из API. Purchase
4031 No Content Запрос успешно обработан, однако сервер прислал пустой ответ. Please try POST /trackings/post and then GET /trackings/get
4032 No Content Не удалось определить перевозчика. Assign your shipment a courier instead of by auto detection. Get courier code
4033 No Content The value of `status` is invalid.
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        Отслеживание в реальном времени: не более 3 запросов в секунду с одного IP-адреса.
  • GET /trackings/get                    Список всех трекинги; Каждый IP, максимум 1 запрос с до 2000 трекинги в секунду.