API Экспресс-накладная

Работа с экспресс-накладными

Трекинг

Обновленный метод «getStatusDocuments», работает в модели «TrackingDocument», данный метод позволяет просматривать более расширенную информацию по статусу отправления. При введенном номере телефона можно получить следующую информацию: данные отправителя или получателя, номер телефона. Метод позволяет просматривать одновременно до 100 отправлений.

URL для входа https://api.novaposhta.ua/v2.0/{format}/ [json or xml]
Формат, обязательно, должен указываться нижним регистром (маленькими буквами), например https://api.novaposhta.ua/v2.0/json/


Доступность: Не требует использования API-ключа.

Актуальные статусы трекинга

Код Статус
1 Нова пошта очікує надходження від відправника
2 Видалено
3 Номер не знайдено
4 Відправлення у місті ХХXХ. (Статус для межобластных отправлений)
NEW - 41 Відправлення у місті ХХXХ. (Статус для услуг локал стандарт и локал экспресс - доставка в пределах города)
5 Відправлення прямує до міста YYYY.
6 Відправлення у місті YYYY, орієнтовна доставка до ВІДДІЛЕННЯ-XXX dd-mm.
Очікуйте додаткове повідомлення про прибуття.
7, 8 Прибув на відділення
9 Відправлення отримано
10 Відправлення отримано %DateReceived%.
Протягом доби ви одержите SMS-повідомлення про надходження грошового переказу
та зможете отримати його в касі відділення «Нова пошта».
11 Відправлення отримано %DateReceived%.
Грошовий переказ видано одержувачу.
14 Відправлення передано до огляду отримувачу
101 На шляху до одержувача
102, 103, 108 Відмова одержувача
104 Змінено адресу
105 Припинено зберігання
106 Одержано і є ТТН грошовий переказ

Try it

URL-адрес запроса

Параметры запроса

string

Форматы JSON, XML

Заголовки запросов

(дополнительный)
string
Тип формата текста, отправляемого в API.

Текст запроса

Всегда возвращает код 200 даже при логических ошибках.

Параметр Тип данных Описание
apiKey* string[36] Ваш ключ API 2.0
modelName* string Имя модели
calledMetdod* string Имя вызываемого метода
metdodProperties   Свойства метода
Documents*   Массив
DocumentNumber* string[36]; Номер электронной накладной
Phone string[36]; Номер телефона (получатель или отправитель). Позволяет получить расширенную информацию

{
    "apiKey": "[ВАШ КЛЮЧ]",
    "modelName": "TrackingDocument",
    "calledMethod": "getStatusDocuments",
    "methodProperties": {
        "Documents": [
            {
                "DocumentNumber": "20400048799000",
                "Phone":""
            },
            {
                "DocumentNumber": "20400048799001",
                "Phone":""
            }
        ]
    }
    
}
<?xml version="1.0" encoding="UTF-8"?>
<root>
   <apiKey>[ВАШ КЛЮЧ]</apiKey>
   <calledMethod>getStatusDocuments</calledMethod>
   <methodProperties>
      <Documents>
         <item>
            <DocumentNumber>20400048799000</DocumentNumber>
            <Phone></Phone>
         </item>
         <item>
            <DocumentNumber>20400048799001</DocumentNumber>
            <Phone></Phone>
         </item>
      </Documents>
   </methodProperties>
   <modelName>TrackingDocument</modelName>
</root>

Ответ 200

Всегда возвращает код 200 даже при логических ошибках.


Тело ответа на запрос

Параметр Тип данных Описание
Number string[36] Номер ЭН
Redelivery string[36] Идентификатор обратной доставки. 0 - нет ОД 1 - есть ОД
RedeliverySum string[36] Сумма обратной доставки
RedeliveryNum string[36] Идентификатор нора ЭН обратной доствки
RedeliveryPayer string[36] Идентификатор плательщика обратной доставки
OwnerDocumentType string[36] Тип ЭН на основании
LastCreatedOnTheBasisDocumentType string[36] Последние изменения, тип документа
LastCreatedOnTheBasisPayerType string[36] Последние изменения, тип плательщика
LastCreatedOnTheBasisDateTime string[36] Последние изменения, дата создания
LastTransactionStatusGM string[36] Последний статус транзакции денежного перевода
LastTransactionDateTimeGM string[36] Последнее время и дата транзакции денежного перевода
DateCreated string[36] Дата создания ЭН
DocumentWeight string[36] Вес
CheckWeight string[36] Информация после контрольного взвешивания
DocumentCost string[36] Стоимость доставки
SumBeforeCheckWeight string[36] Информация до контрольного взвешивания
PayerType string[36] Идентификатор плательщика
RecipientFullName string[36] Данные ФИО получателя с накладной (при вводе телефона)
RecipientDateTime string[36] Дата, когда груз забрал получатель
ScheduledDeliveryDate string[36] Ожидаемая дата доставки
PaymentMethod string[36] Способ оплаты
CargoDescriptionString string[36] Описание посылки
CargoType string[36] Тип груза
CitySender string[36] Город отправителя
CityRecipient string[36] Город получателя
WarehouseRecipient string[36] Склад получателя
CounterpartyType string[36] Идентификатор
AfterpaymentOnGoodsCost string[36] Контроль Оплаты
ServiceType string[36] Идентификатор способа доставки
UndeliveryReasonsSubtypeDescription string[36] Описание причины неразвоза
WarehouseRecipientNumber string[36] Номер отделения получателя
LastCreatedOnTheBasisNumber string[36] Последние изменения, номер ЭН
PhoneRecipient string[36] Телефон получателя
RecipientFullNameEW string[36] Данные ФИО получателя с накладной (при вводе телефона)
WarehouseRecipientInternetAddressRef string[36] Идентификатор склада получателя
MarketplacePartnerToken string[36]
ClientBarcode string[36] Внутренний номер заказа
RecipientAddress string[36] Адрес получателя
CounterpartyRecipientDescription string[36] Описание контрагента получателя
CounterpartySenderType string[36] Тип контрагента отправителя
DateScan string[36] Дата сканировки, которая привела к формированию статуса
PaymentStatus string[36] Статус для интернет эквайринг
PaymentStatusDate string[36] Дата оплаты для интернет эквайринг
AmountToPay string[36] Сумма к оплате для интернет эквайринг
AmountPaid string[36] Оплачено для интернет эквайринг
Status string[36] Статус
StatusCode string[36] Идентификатор статуса
RefEW string[36] Идентификатор накладной для эквайринга (используется в рабочих целях)
BackwardDeliverySubTypesActions string[36] Информация по не стандартным подтипам обратной доставки
BackwardDeliverySubTypesServices string[36] Информация по не стандартным подтипам обратной доставки
UndeliveryReasons string[36] Причина неразвоза
DatePayedKeeping string[36] Дата начала платного хранения

{
  "success": true,
  "data": [
    {
      "Number": "59000218530814",
      "Redelivery": 0,
      "RedeliverySum": 0,
      "RedeliveryNum": "",
      "RedeliveryPayer": "",
      "OwnerDocumentType": "",
      "LastCreatedOnTheBasisDocumentType": "",
      "LastCreatedOnTheBasisPayerType": "",
      "LastCreatedOnTheBasisDateTime": "",
      "LastTransactionStatusGM": "",
      "LastTransactionDateTimeGM": "",
      "DateCreated": "18-11-2016 11:52:42",
      "DocumentWeight": 0.5,
      "CheckWeight": 0,
      "DocumentCost": 20,
      "SumBeforeCheckWeight": 0,
      "PayerType": "Recipient",
      "RecipientFullName": "ФИО",
      "RecipientDateTime": "21.11.2016 13:53:47",
      "ScheduledDeliveryDate": "19-11-2016",
      "PaymentMethod": "Cash",
      "CargoDescriptionString": "Одяг",
      "CargoType": "Cargo",
      "CitySender": "Київ",
      "CityRecipient": "Київ",
      "WarehouseRecipient": "Відділення №101 (до 15 кг), Міні-відділення: вул. Велика Васильківська, 143/2, (маг. \"Фора\")",
      "CounterpartyType": "PrivatePerson",
      "AfterpaymentOnGoodsCost": 0,
      "ServiceType": "WarehouseWarehouse",
      "UndeliveryReasonsSubtypeDescription": "",
      "WarehouseRecipientNumber": 101,
      "LastCreatedOnTheBasisNumber": "",
      "PhoneRecipient": "380ХХХХХХХХХ",
      "RecipientFullNameEW": "ФИО",
      "WarehouseRecipientInternetAddressRef": "39931b02-e1c2-11e3-8c4a-0050568002cf",
      "MarketplacePartnerToken": "",
      "ClientBarcode": "",
      "RecipientAddress": "м. Київ, Відділення №101 (до 15 кг), Міні-відділення, вул. Велика Васильківська, 143/2",
      "CounterpartyRecipientDescription": "Приватна особа",
      "CounterpartySenderType": "PrivatePerson",
      "DateScan": "0001-01-01 00:00:00",
      "PaymentStatus": "",
      "PaymentStatusDate": "",
      "AmountToPay": "",
      "AmountPaid": "",
      "Status": "Одержано",
      "StatusCode": "9",
      "RefEW": "55fbe203-ad74-11e6-b5da-005056887b8d",
      "BackwardDeliverySubTypesServices": [],
      "BackwardDeliverySubTypesActions": [],
      "UndeliveryReasons": ""
    }
  ],
  "errors": [],
  "warnings": [
    {}
  ],
  "info": [],
  "messageCodes": [],
  "errorCodes": [],
  "warningCodes": [],
  "infoCodes": []
}
<?xml version="1.0" encoding="UTF-8"?>
<root>
   <data>
      <element>
         <AfterpaymentOnGoodsCost>0</AfterpaymentOnGoodsCost>
         <BackwardDeliverySubTypesActions />
         <BackwardDeliverySubTypesServices />
         <CargoDescriptionString>Корпусні меблі</CargoDescriptionString>
         <CargoType>Cargo</CargoType>
         <CheckWeight>0</CheckWeight>
         <CityRecipient>Кривий Ріг</CityRecipient>
         <CitySender>Запоріжжя</CitySender>
         <ClientBarcode />
         <CounterpartyRecipientDescription>Приватна особа</CounterpartyRecipientDescription>
         <CounterpartySenderType>Organization</CounterpartySenderType>
         <CounterpartyType>PrivatePerson</CounterpartyType>
         <DateCreated>11-11-2016 23:58:07</DateCreated>
         <DateScan>18:45 10.11.2016</DateScan>
         <DocumentCost>155</DocumentCost>
         <DocumentWeight>54</DocumentWeight>
         <LastCreatedOnTheBasisDateTime />
         <LastCreatedOnTheBasisDocumentType />
         <LastCreatedOnTheBasisNumber />
         <LastCreatedOnTheBasisPayerType />
         <LastTransactionDateTimeGM />
         <LastTransactionStatusGM />
         <MarketplacePartnerToken />
         <Number>20400021980421</Number>
         <OwnerDocumentType />
         <PayerType>Recipient</PayerType>
         <PaymentMethod>Cash</PaymentMethod>
         <PhoneRecipient>380ХХХХХХХ</PhoneRecipient>
         <RecipientAddress>м. Кривий Ріг, вул. Колачевського Сергія (23 Лютого), 52</RecipientAddress>
         <RecipientDateTime />
         <RecipientFullName />
         <RecipientFullNameEW>Єлена Єлена </RecipientFullNameEW>
         <Redelivery>1</Redelivery>
         <RedeliveryNum />
         <RedeliveryPayer>Recipient</RedeliveryPayer>
         <RedeliverySum>1305</RedeliverySum>
         <RefEW>b70cfd03e-11e6-b5da-00568878d</RefEW>
         <ScheduledDeliveryDate>12-11-2016</ScheduledDeliveryDate>
         <ServiceType>WarehouseDoors</ServiceType>
         <Status>Готується до відправлення в м.Кривий Ріг</Status>
         <StatusCode>4</StatusCode>
         <SumBeforeCheckWeight>0</SumBeforeCheckWeight>
         <UndeliveryReasons />
         <UndeliveryReasonsSubtypeDescription />
         <WarehouseRecipient />
         <WarehouseRecipientInternetAddressRef />
         <WarehouseRecipientNumber>0</WarehouseRecipientNumber>
      </element>
   </data>
   <errorCodes />
   <errors />
   <info />
   <infoCodes />
   <messageCodes />
   <success>true</success>
   <warningCodes />
   <warnings>
      <element />
   </warnings>
</root>