Tracker API

Получение списка стран

Для получения списка стран следует отправлять GET или POST запросы на адрес:

POST https://api.moyaposylka.ru/tracker/v3/get-countries
Формат запроса

Передача параметров не требуется. Тело запроса должно быть пустым.

Формат ответа

При успешной обработке запроса сервер возвращает данные в формате JSON следующей структуры:

[
    {
        "code": "RU",
        "name": "Россия"
    },
    {
        "code": "BY",
        "name": "Республика Беларусь"
    }
]

Полный список кодов и названий стран указан на странице стран мира.

Получение списка магазинов службы доставки PickPoint

Для получения списка магазинов PickPoint следует отправлять GET или POST запросы на адрес:

POST https://api.moyaposylka.ru/tracker/v3/get-pickpoint-shops
Формат запроса

Передача параметров не требуется. Тело запроса должно быть пустым.

Формат ответа

При успешной обработке запроса сервер возвращает данные в формате JSON следующей структуры:

[
    {
        "name": "Магазин 1"
        "code": "123_456",
    },
    {
        "name": "Магазин 2",
        "code": "456_789"
    }
]

В дальнейшем, для отслеживания почтовых отправлений типа PickPoint необходимо в качестве дополнительного входного параметра передавать код интернет-магазина.

Получение списка городов-получателей транспортной компании "Энергия"

Для получения списка магазинов PickPoint следует отправлять GET или POST запросы на адрес:

POST https://api.moyaposylka.ru/tracker/v3/get-nrg-locations
Формат запроса

Передача параметров не требуется. Тело запроса должно быть пустым.

Формат ответа

При успешной обработке запроса сервер возвращает данные в формате JSON следующей структуры:

[
    {
        "id": 495,
        "name": "Москва",
    },
    {
        "id": 812,
        "name": "С.Петербург"
    }
]

В дальнейшем, для отслеживания почтовых отправлений транспортной компании "Энергия" необходимо в качестве дополнительного входного параметра передавать идентификатор города-получателя.

Определение типа почтового отправления

Для определения типа почтового отправления, поддерживаемого сервисом «Моя посылка», следует отправить POST запрос на адрес:

POST https://api.moyaposylka.ru/tracker/v3/detect-tracker-types
Формат запроса

В теле запроса необходимо передать JSON строку с номером почтового отправления следующей структуры:

{
    "number": 10000000000000
}

Формат ответа

При успешной обработке запроса сервер возвращает данные в формате JSON следующей структуры:

[
    {
        "code": "russian-post",
        "readable": "Почта России"
    }
]

где:

  • code - код типа почтового отправления;
  • readable - название почтовой или курьеской службы (на русском языке).

Сервис всегда возвращает массив объектов, даже если номеру отслеживания соответствует одна почтовая служба. Если номеру почтового отправления соответствует более одного типа, то возвращается массив из нескольких объектов.

Если по номеру почтового отправления невозможно определить поддерживаемый тип, то возвращается результат с ошибкой UNKNOWN_TRACKER_TYPE с HTTP-статусом 404:

{
    "status": 404,
    "error": "UNKNOWN_TRACKER_TYPE",
    "requestId": "313461b2",
    "data": {
        "number":"111111111"
    }
}

Запрос на получение статусов отправления

Метод предназначен для создания запроса на получение статусов почтового отправления в режиме реального времени. На основании входных параметров сервис добавляет в общую очередь запрос на получение статусов и возвращает уникальный идентификатор запроса в виде токена. Далее, используя полученный токен, необходимо получить данные по статусам почтового отправления с помощью метода get-request-info.

Все поступающие запросы обрабатываются в порядке общей очереди.

Количество запросов в сутки с одного IP-адреса ограничено.
Адрес
POST https://api.moyaposylka.ru/tracker/v3/create-request
Формат запроса

В теле запроса необходимо передать JSON строку следующей структуры:

{
    "number": "EA123456789RU",
    "type": "ems",
    "countryCode": "RU",
    "params": {

    }
}
Формат ответа

При успешной обработке запроса сервер возвращает данные в формате JSON следующей структуры:

{
    "token": "cf9e2b33f045b9932101d64bfc483dc49a78d7f0d422addf10da1cdabcfee87b"
}

где:

  • token - уникальный токен, по которому в дальнейшем слудет получить результаты по статусам почтового отправления.

Получение статусов почтового отправления по запросу

Для того, чтобы получить результаты по статусам почтового отправления на основании ранее успешно сформированного запроса, следует отправить POST запрос на адрес:

POST https://api.moyaposylka.ru/tracker/v3/get-request-info
Формат запроса

В теле запроса необходимо передать JSON строку следующей структуры:

{
    "token": "cf9e2b33f045b9932101d64bfc483dc49a78d7f0d422addf10da1cdabcfee87b"
}
Формат ответа

При успешной обработке запроса сервер возвращает актуальные статусы почтового отправления в формате JSON.

Получение статусов существующего почтового отправления

Для того, чтобы получить статусы почтового отправления, ранее зарегистрированного в сервисе «Моя посылка», следует отправить POST запрос на адрес:

POST https://api.moyaposylka.ru/tracker/v3/get-tracker-statuses

Сервер возвращает последние известные системе статусы только тех почтовых отправлений, которые отслеживаются зарегистрированными пользователями, либо добавленные в систему с помощью запроса на получение статусов. При этом статусы могут быть не полными, если отправление не отслеживается системой.

Формат запроса
Полное описание входных параметров.
Формат ответа

При успешной обработке запроса сервер возвращает актуальные статусы почтового отправления в формате JSON.

Получение списка отслеживаемых пользователем почтовых отправлений

Требуется авторизация.
POST https://api.moyaposylka.ru/tracker/v3/get-user-trackers
Формат запроса
{
    "isArchived": false,
    "filter": "all",
    "query": "поисковый запрос",
    "tags": ["тэг"],
    "pageable": {
        "page": 1,
        "perPage": 25
    }
}

где:

Добавление номера для отслеживания

Требуется авторизация.
POST https://api.moyaposylka.ru/tracker/v3/add-tracker
Формат запроса
{
    "number": "EA123456789RU",
    "type": "ems",
    "countryCode": "RU",
    "params": {
        "pin": "1111",
        "shop": "123",
        "locationId": 123
    },
    "name": "Моя посылка",
    "email": "user@example.com",
    "url": "https://moyaposylka.ru",
    "notes": "Примечания к посылке",
    "countdownDate": "2016-01-01 00:01"
    "countdownMessage": "Это сообщение появится в интерфейсе, если истечет время обратного отсчета",
    "tags": [
        "Посылка из Китая", "Моя посылка"
    ]
}

где:

Формат ответа

При успешном выполнении запроса сервис возвращает HTTP код 200 и пустое тело ответа.

Удаление номера из отслеживания

Требуется авторизация.
POST https://api.moyaposylka.ru/tracker/v3/remove-tracker
Формат запроса
Полное описание входных параметров.

Изменение названия номера отслеживания

Требуется авторизация.
POST https://api.moyaposylka.ru/tracker/v3/change-tracker-name

Изменение меток у номера отслеживания

Требуется авторизация.
POST https://api.moyaposylka.ru/tracker/v3/change-tracker-tags

Изменение описания номера отслеживания

Требуется авторизация.
POST https://api.moyaposylka.ru/tracker/v3/change-tracker-notes

Изменение дополнительного адреса оповещений номера отслеживания

Требуется авторизация.
POST https://api.moyaposylka.ru/tracker/v3/change-tracker-email

Изменение времени обратного отсчета номера отслеживания

Требуется авторизация.
POST https://api.moyaposylka.ru/tracker/v3/change-tracker-countdown-date

Перемещение номера отслеживания в архив

Требуется авторизация.
POST https://api.moyaposylka.ru/tracker/v3/move-tracker-to-archive
Формат запроса
Полное описание входных параметров.

Изменение статуса номера отслеживания на доставленный

Требуется авторизация.
POST https://api.moyaposylka.ru/tracker/v3/mark-tracker-as-delivered
Формат запроса
Полное описание входных параметров.

Возобновление отслеживания номера

Требуется авторизация.
POST https://api.moyaposylka.ru/tracker/v3/renew-tracker
Формат запроса
Полное описание входных параметров.