Api Документация отслеживание посылок Trackgo.ru

API остлеживания почтовых отправлений и посылок

По любым вопросам касающимся API интеграций(1С, CRM, CMS, плагины, расширения, виджеты) - пишите пожалйста на почту: [email protected]

Чтобы начать:

  • Сгенерируйте apikey (напишите на почту: [email protected] или зарегистируйтесь в системе)
  • При работе с API используются исключительно GET запросы, HTTP или HTTPS соединение
  • API key засылается GET параметром

Лимиты (бесплатно)

  • 1 запрос / сек
  • 30 запросов / мин
  • 200 запросов / в сутки
  • 500 запросов / в месяц

Лимиты (платно)

  • 1 запрос / сек
  • 60 запросов / мин
  • 43200 запросов / в сутки
  • 1 000 000 запросов / в месяц

Точка входа

https://tracking.trackgo.app

Метод “Tracking”

GET /api/tracking/ - отдаёт результат запрашиваемого трек-кода

Пример запроса:

https://tracking.trackgo.app/api/tracking/?track_code=80515562814782&language=en&apikey=1234567890

Описания параметров для запроса:

Параметр Описание Принимаемые значения
track_code* Запрашиваемый трек-код посылки или несколько через запятую латинские буквы, цифры, знак “-”
language* На каком языке выдать результат отслеживания en/ru
apikey* Выданный apikey
couriers Возможность указать определённую курьерскую службу или список служб через запятую Пример: russian-post,dellin,cdek Полный список алиасов курьерских служб можно посмотреть тут
new флаг new даёт воможность запросить свежую информацию принудительно, без флага информация выводится из кэша, кэш оновляется раз в 3 часа Пример: russian-post,dellin,cdek Полный список алиасов курьерских служб можно посмотреть тут

“*” - обязательное значение

Пример ответа в случае успеха:

{
    "track": {
        "track_code": "80515562814782",
        "track_codes": [],
        "combined_track_codes": [],
        "events_count": 18,
        "consolidated_track_code": null,
        "route": {
            "address_to": "Орёл",
            "to_country": "РОССИЯ",
            "address_from": "Чебоксары",
            "from_country": "РОССИЯ"
        },
        "information": {
            "sender": "Праведнов А. Г.",
            "to_index": "302027",
            "recipient": "Казначеев В. В.",
            "from_index": "302027",
            "package_type": "Посылка Обыкновенное Нестандартная"
        },
        "post_offices": [
            {
                "alias": "russian-post",
                "availability": {
                    "email": "[email protected]",
                    "phone": "8(800)1000000"
                },
                "coordinates": {
                    "latitude": "52.985298",
                    "longitude": "36.065463"
                },
                "location": {
                    "address": "Приборостроительная ул, 56",
                    "city": "Орёл",
                    "full_address": "обл Орловская, г Орёл, ул Приборостроительная, дом 56",
                    "region": "Орловская обл",
                    "settlement_or_city": "Орёл"
                },
                "value": "302027",
                "working_hours": {
                    "service": "russian-post"ь
                }
            }
        ],
        "last_event": {
            "name": {
                "original": "Получено адресатом"
            },
            "details": null,
            "date": "2021-08-25T12:38:11.000+02:00",
            "post_office": {
                "alias": "russian-post",
                "availability": {
                    "email": "[email protected]",
                    "phone": "8(800)1000000"
                },
                "coordinates": {
                    "latitude": "52.985298",
                    "longitude": "36.065463"
                },
                "location": {
                    "address": "Приборостроительная ул, 56",
                    "city": "Орёл",
                    "full_address": "обл Орловская, г Орёл, ул Приборостроительная, дом 56",
                    "region": "Орловская обл",
                    "settlement_or_city": "Орёл"
                },
                "value": "302027",
                "working_hours":
                   [
                        {
                            "begin_work_time": "08:00:00",
                            "day_id": "1",
                            "end_work_time": "20:00:00"
                        },
                        {
                            "begin_work_time": "08:00:00",
                            "day_id": "2",
                            "end_work_time": "20:00:00"
                        },
                        {
                            "begin_work_time": "08:00:00",
                            "day_id": "3",
                            "end_work_time": "20:00:00"
                        },
                        {
                            "begin_work_time": "08:00:00",
                            "day_id": "4",
                            "end_work_time": "20:00:00"
                        },
                        {
                            "begin_work_time": "08:00:00",
                            "day_id": "5",
                            "end_work_time": "20:00:00"
                        },
                        {
                            "begin_work_time": "09:00:00",
                            "day_id": "6",
                            "end_work_time": "18:00:00"
                        },
                        {
                            "begin_work_time": "09:00:00",
                            "day_id": "7",
                            "end_work_time": "14:00:00"
                        }

                                    }
            },
            "location": {
                "country": "Россия",
                "postal_code": "302027",
                "address": "Орёл"
            },
            "uuid": "9e354734-839d-40f3-a39e-820f4e34a97d",
            "service": "russian-post",
            "weight": {
                "value": "2.09",
                "measure": "kg"
            }
        },
        "status": "delivered",
        "events": [
            {
                "name": {
                    "original": "Получено адресатом"
                },
                "weight": {
                    "value": "2.09",
                    "measure": "kg"
                },
                "date": "2021-08-25T12:38:11.000+02:00",
                "location": {
                    "address": "Орёл",
                    "country": "Россия",
                    "postal_code": "302027"
                },
                "post_office": {
                    "alias": "russian-post",
                    "availability": {
                        "email": "[email protected]",
                        "phone": "8(800)1000000"
                    },
                    "coordinates": {
                        "latitude": "52.985298",
                        "longitude": "36.065463"
                    },
                    "location": {
                        "address": "Приборостроительная ул, 56",
                        "city": "Орёл",
                        "full_address": "обл Орловская, г Орёл, ул Приборостроительная, дом 56",
                        "region": "Орловская обл",
                        "settlement_or_city": "Орёл"
                    },
                    "value": "302027",
                    "working_hours": {
                        "service": "russian-post"
                    }
                },
                "service": "russian-post",
                "courier": "russian-post"
            },
            {
                "name": {
                    "original": "Ожидает адресата в месте вручения"
                },
                "weight": {
                    "value": "2.09",
                    "measure": "kg"
                },
                "date": "2021-08-25T10:21:54.000+02:00",
                "location": {
                    "address": "Орёл",
                    "country": "Россия",
                    "postal_code": "302027"
                },
                "post_office": {
                    "alias": "russian-post",
                    "availability": {
                        "email": "[email protected]",
                        "phone": "8(800)1000000"
                    },
                    "coordinates": {
                        "latitude": "52.985298",
                        "longitude": "36.065463"
                    },
                    "location": {
                        "address": "Приборостроительная ул, 56",
                        "city": "Орёл",
                        "full_address": "обл Орловская, г Орёл, ул Приборостроительная, дом 56",
                        "region": "Орловская обл",
                        "settlement_or_city": "Орёл"
                    },
                    "value": "302027",
                    "working_hours": {
                        "service": "russian-post"
                    }
                },
                "service": "russian-post",
                "courier": "russian-post"
            },
           ...
        ],
        "weight": {
            "value": "2.09",
            "measure": "kg"
        },
        "founded_couriers": [
            "russian-post"
        ],
        "detected_couriers": [
            "apc",
            "cse",
            "gls",
            "dpd-hr",
            "hermes",
            "tanais",
            "cainiao",
            "8express",
            "dpd-poland",
            "eshopworld",
            "novaposhta",
            "dpd-germany",
            "hermes-russia",
            "hermes-germany",
            "yanwen-logistics"
        ],
        "is_root_consolidated_track": false,
        "updated_at": "2021-09-09T09:53:51.981+02:00",
        "couriers": [
            {
                "name": "Russian Post",
                "alias": "russian-post",
                "image_url": "https://adminscrapper.trackgo.app/static/images/services/russian-post.jpg"
            }
        ]
    },
    "track_code": "80515562814782",
    "status": "ok",
    "ttfb": {
        "database_track": 2.1353816986083984,
        "events_translations": 13.32673692703247,
        "post_offices": 3.7791600227355957,
        "location_translations": 13.523409843444824
    }
}

Описания полей JSON массива от API :

Поле Описание
track_code Запрашиваемый трек-код
status Статус запроса.
track_codes* Найденные дополнительный тре-коды (перемаркировка)
combined_track_codes* Если запрашиваемый трек-код является консолидированым, в массиве “combined track codes” ,будут перечислены трек-коды входящие в состав консолидированной посылки
events_count Количество найденых отслеживаемых операций
consolidated_track_code* Если запрашиваемый трек-код входит в состав консолидированной посылки, в этом поле выведется трек-код этой консолидированной посылки
route* Массив роутинга трек-кода, где: address_to* - Адрес куда следует посылка, to_country* - Страна назначения и т.д. по смыслу. address_from, from_country
information* Массив дополнительной информации от получателе и отправителе. sender* - отправитель, to_index* - индекс получателя, recipient* - Получатель(ФИО), from_index* - индекс отправителя, package_type* - тип отправления.
post_offices* Массив данных пункта выдачи посылки. alias- алиас службы, к которой относится пункт выдачи посылки. Отсальные поля по смыслу, относящиеся к пункту выдачи.
status Унифицированный статус посылки, могут быть: delivered, transit, error
events* Массив с событиями отслеживания. Массив name содержит в себе два поля original - то значение, которое отдала служба в оригинальном виде, value - то значение, которое переведено машинным переводом на язык, который был указан в параметре language. weight* - значение веса в момент получения события, measure* - мера измерения веса, date - дата события, location* - местоположение, post_office - офис обрабатывающий посылку в рамках события, service - курьерская служба, которая отдала событие.
founded_couriers Cлужбы в которых были найдены события.
detected_couriers Cлужбы, в которых осуществлялся поиск посылки.
updated_at Дата последнего получения свежих данных по трек-коду из источника(служб отслеживания).

“*” - может быть значение NULL или []

Метод “couriers”

GET /api/couriers/ - отдаёт список возможных курьерских служб для отслеживания с названиями и их алиасами

Описания параметров для запроса:

Параметр Описание
apikey* выданный apikey

В данный момент поддерживается 853 почтовые и курьерские службы

Пример ответа в случае успеха:

[
    {
        "name": "Russian Post",
        "alias": "russian-post",
        "phone": "88005553535",
        "website": "https://pochta.ru",
        "image_url": "https://tracking.trackgo.app/assets/couriers/russian-post.png"
    },
    {
        "name": "AliExpress Standard Shipping (CAINIAO)",
        "alias": "cainiao",
        "phone": "88005553535",
        "website": "https://pochta.ru",
        "image_url": "https://tracking.trackgo.app/assets/couriers/cainiao.png"
    },
    {
        "name": "China Post",
        "alias": "china-post",
        "phone": "88005553535",
        "website": "https://pochta.ru",
        "image_url": "https://tracking.trackgo.app/assets/couriers/china-post.png"
    },
    {
        "name": "4PX Express",
        "alias": "4px-express",
        "phone": "88005553535",
        "website": "https://pochta.ru",
        "image_url": "https://tracking.trackgo.app/assets/couriers/4px-express.png"
    }
    ...
    ]

Описания полей JSON массива от API :

Поле Описание
name Наименование службы на латиннице
alias alias службы необходимый для запросов по конкретной службе/службах в параметре “couriers”
phone Международный телефон курьерской службы
website Web-сайт службы
image_url Логотип службы