For the complete documentation index, see llms.txt. This page is also available as Markdown.

Трекінг

Отримання детальної інформації про статус відправлень

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

1

Відправник самостійно створив цю накладну, але ще не надав до відправки

2

Видалено

3

Номер не знайдено

4

Відправлення у місті ХХXХ (статус для міжобласних відправлень)

41

Відправлення у місті ХХXХ (статус для послуг «Локал стандарт» і «Локал експрес» — доставка в межах міста)

5

Відправлення прямує до міста YYYY

6

Відправлення у місті YYYY, орієнтовна доставка до ВІДДІЛЕННЯ-XXX dd-mm. Очікуйте додаткове повідомлення про прибуття

7

Прибув на відділення

8

Прибув на відділення (завантажено в Поштомат)

9

Відправлення отримано

10

Відправлення отримано %DateReceived%. Протягом доби ви одержите SMS-повідомлення про надходження грошового переказу та зможете отримати його в касі відділення «Нова пошта»

11

Відправлення отримано %DateReceived%. Грошовий переказ видано одержувачу

12

Нова пошта комплектує ваше відправлення

15

Відправлення вже в дорозі до України

101

На шляху до одержувача

102

Відмова від отримання (відправником створено замовлення на повернення)

103

Відмова від отримання

104

Змінено адресу

105

Припинено зберігання

106

Одержано і створено ЕН зворотної доставки

107

Відправлення переміщено з пункту видачі замовлень (PUDO) до основного відділення, яке його обслуговує

111

Невдала спроба доставки через відсутність одержувача на адресі або зв'язку з ним

112

Дата доставки перенесена одержувачем

124

Знищено внаслідок ворожої атаки

Перегляд детальної інформації про статус відправлень (JSON)

post

Метод getStatusDocuments у моделі TrackingDocumentGeneral (або TrackingDocument) надає можливість перегляду детальної інформації про статус відправлень. Цей метод дозволяє користувачам отримати актуальні дані щодо статусу їхніх відправлень, зокрема інформацію про відправника та одержувача.

Основні можливості методу:

  • Отримання даних за номером телефону: Під час введення номера телефону можна отримати інформацію про відправника та одержувача, включно з їхніми контактними даними.

  • Масовий перегляд відправлень: Метод дозволяє переглядати інформацію одночасно до 100 відправлень.

  • Актуальні статуси трекінгу: Метод відображає всі актуальні статуси трекінгу для кожного відправлення.

  • Доступність: Метод доступний як для авторизованих, так і для неавторизованих запитів.

Авторизований доступ має такі особливості:

  • Для отримання повних даних про відправлення необхідно використовувати API-ключ.

  • У разі успішної авторизації та валідації повертаються коректні дані відправника та одержувача.

Неавторизований доступ (без використання API-ключа) має обмежений доступ до даних. Для запитів застосовується логіка підміни — дані відправника та одержувача замінюються на дані, що належать номеру телефону із запиту.

Body
apiKeystringOptional

API-ключ користувача (необов'язковий для неавторизованого доступу)

Example: [ВАШ КЛЮЧ]
modelNamestring · enumRequired

Назва моделі API

Possible values:
calledMethodstring · enumRequired

Назва методу API

Possible values:
Responses
200

Успішна відповідь (JSON)

application/json
successbooleanRequired

Прапор успішності виконання запиту

errorsstring[]Required

Масив повідомлень про помилки

warningsstring[]Required

Масив попереджень

infostring[]Required

Масив інформаційних повідомлень

messageCodesstring[]Required

Масив кодів інформаційних повідомлень

errorCodesstring[]Required

Масив кодів помилок

warningCodesstring[]Required

Масив кодів попереджень

infoCodesstring[]Required

Масив кодів додаткової інформації

post/json/
POST /v2.0/json/ HTTP/1.1
Host: api.novaposhta.ua/
Content-Type: application/json
Accept: */*
Content-Length: 257

{
  "apiKey": "[ВАШ КЛЮЧ]",
  "modelName": "TrackingDocumentGeneral",
  "calledMethod": "getStatusDocuments",
  "methodProperties": {
    "Documents": [
      {
        "DocumentNumber": "20400048799000",
        "Phone": "380600000000"
      },
      {
        "DocumentNumber": "20400048799001",
        "Phone": "380600000000"
      }
    ]
  }
}
200

Успішна відповідь (JSON)

{
  "success": true,
  "data": [
    {
      "PossibilityCreateReturn": true,
      "PossibilityCreateRefusal": true,
      "PossibilityChangeEW": true,
      "PossibilityCreateRedirecting": true,
      "Number": "20400048799000",
      "Redelivery": "0",
      "RedeliverySum": "0",
      "RedeliveryNum": "",
      "RedeliveryPayer": "Sender/Recipient",
      "OwnerDocumentType": "",
      "LastCreatedOnTheBasisDocumentType": "",
      "LastCreatedOnTheBasisPayerType": "",
      "LastCreatedOnTheBasisDateTime": "",
      "LastTransactionStatusGM": "",
      "LastTransactionDateTimeGM": "",
      "LastAmountTransferGM": "",
      "DateCreated": "18-11-2021 11:52:42",
      "DocumentWeight": "3",
      "FactualWeight": "3",
      "VolumeWeight": "0.1",
      "CheckWeight": "",
      "CheckWeightMethod": "",
      "DocumentCost": "51",
      "CalculatedWeight": "3",
      "SumBeforeCheckWeight": "",
      "PayerType": "Sender",
      "RecipientFullName": "ПІБ",
      "RecipientDateTime": "21.11.2021 13:53:47",
      "ScheduledDeliveryDate": "19.11.2021 13:53:47",
      "PaymentMethod": "Cash",
      "CargoDescriptionString": "Одяг",
      "CargoType": "Cargo",
      "CitySender": "Київ",
      "CityRecipient": "Київ",
      "WarehouseRecipient": "Відділення №101 (до 15 кг), Міні-відділення: вул. Велика Васильківська, 143/2, (маг. \"Фора\")",
      "CounterpartyType": "PrivatePerson",
      "AfterpaymentOnGoodsCost": "0",
      "ServiceType": "WarehouseWarehouse",
      "UndeliveryReasonsSubtypeDescription": "",
      "WarehouseRecipientNumber": "101",
      "LastCreatedOnTheBasisNumber": "",
      "PhoneRecipient": "380600000000",
      "RecipientFullNameEW": "",
      "WarehouseRecipientInternetAddressRef": "00000000-0000-0000-0000-000000000000",
      "MarketplacePartnerToken": "",
      "ClientBarcode": "",
      "RecipientAddress": "м. Київ, Відділення №101 (до 15 кг), Міні-відділення, вул. Велика Васильківська, 143/2",
      "CounterpartyRecipientDescription": "Приватна особа",
      "CounterpartySenderType": "PrivatePerson",
      "DateScan": "0001-01-01 00:00:00",
      "PaymentStatus": "",
      "PaymentStatusDate": "",
      "AmountToPay": "",
      "AmountPaid": "",
      "Status": "",
      "StatusCode": "",
      "RefEW": "00000000-0000-0000-0000-000000000000",
      "BackwardDeliverySubTypesActions": "",
      "BackwardDeliverySubTypesServices": "",
      "UndeliveryReasons": "",
      "DatePayedKeeping": "",
      "InternationalDeliveryType": "",
      "SeatsAmount": "1",
      "CardMaskedNumber": "",
      "ExpressWaybillPaymentStatus": "PaymentNotAvailable",
      "ExpressWaybillAmountToPay": "",
      "PhoneSender": "",
      "TrackingUpdateDate": "2022-06-07 13:42:56",
      "WarehouseSender": "Отделение №178 (до 30 кг): просп. Оболонский, 35",
      "DateReturnCargo": "",
      "DateMoving": "",
      "DateFirstDayStorage": "",
      "RefCityRecipient": "00000000-0000-0000-0000-000000000000",
      "RefCitySender": "00000000-0000-0000-0000-000000000000",
      "RefSettlementRecipient": "00000000-0000-0000-0000-000000000000",
      "RefSettlementSender": "00000000-0000-0000-0000-000000000000",
      "SenderAddress": "м. Київ, Відділення №178 (до 30 кг): просп. Оболонський, 35",
      "SenderFullNameEW": "Іванов Петро Миколайович",
      "AnnouncedPrice": "50000",
      "AdditionalInformationEW": "",
      "ActualDeliveryDate": "",
      "PostomatV3CellReservationNumber": "00000000-0000-0000-0000-000000000000",
      "OwnerDocumentNumber": "",
      "LastAmountReceivedCommissionGM": "",
      "DeliveryTimeframe": "",
      "CreatedOnTheBasis": "",
      "UndeliveryReasonsDate": "",
      "RecipientWarehouseTypeRef": "00000000-0000-0000-0000-000000000000",
      "WarehouseRecipientRef": "00000000-0000-0000-0000-000000000000",
      "CategoryOfWarehouse": "Branch",
      "WarehouseRecipientAddress": "Киев, Героев Днепра, 53",
      "WarehouseSenderInternetAddressRef": "00000000-0000-0000-0000-000000000000",
      "WarehouseSenderAddress": "Киев, Оболонский, 35",
      "AviaDelivery": "",
      "BarcodeRedBox": "",
      "CargoReturnRefusal": "false",
      "DaysStorageCargo": "",
      "Packaging": null,
      "PartialReturnGoods": null,
      "SecurePayment": "false",
      "PossibilityChangeCash2Card": true,
      "PossibilityChangeDeliveryIntervals": true,
      "PossibilityTermExtensio": true,
      "StorageAmount": "",
      "StoragePrice": "",
      "FreeShipping": "",
      "LoyaltyCardRecipient": ""
    }
  ],
  "errors": [],
  "warnings": [],
  "info": [],
  "messageCodes": [],
  "errorCodes": [],
  "warningCodes": [],
  "infoCodes": []
}

Перегляд детальної інформації про статус відправлень (XML)

post

Метод getStatusDocuments у моделі TrackingDocumentGeneral (або TrackingDocument) надає можливість перегляду детальної інформації про статус відправлень. Цей метод дозволяє користувачам отримати актуальні дані щодо статусу їхніх відправлень, зокрема інформацію про відправника та одержувача.

Основні можливості методу:

  • Отримання даних за номером телефону: Під час введення номера телефону можна отримати інформацію про відправника та одержувача, включно з їхніми контактними даними.

  • Масовий перегляд відправлень: Метод дозволяє переглядати інформацію одночасно до 100 відправлень.

  • Актуальні статуси трекінгу: Метод відображає всі актуальні статуси трекінгу для кожного відправлення.

  • Доступність: Метод доступний як для авторизованих, так і для неавторизованих запитів.

Авторизований доступ має такі особливості:

  • Для отримання повних даних про відправлення необхідно використовувати API-ключ.

  • У разі успішної авторизації та валідації повертаються коректні дані відправника та одержувача.

Неавторизований доступ (без використання API-ключа) має обмежений доступ до даних. Для запитів застосовується логіка підміни — дані відправника та одержувача замінюються на дані, що належать номеру телефону із запиту.

Body
apiKeystringOptional

API-ключ користувача (необов'язковий для неавторизованого доступу)

modelNamestring · enumRequired

Назва моделі API

Possible values:
calledMethodstring · enumRequired

Назва методу API

Possible values:
Responses
200

Успішна відповідь (XML)

application/xml
successbooleanRequired

Прапор успішності виконання запиту

errorsstring[]Required

Масив повідомлень про помилки

warningsstring[]Required

Масив попереджень

infostring[]Required

Масив інформаційних повідомлень

messageCodesstring[]Required

Масив кодів інформаційних повідомлень

errorCodesstring[]Required

Масив кодів помилок

warningCodesstring[]Required

Масив кодів попереджень

infoCodesstring[]Required

Масив кодів додаткової інформації

post/xml/
POST /v2.0/xml/ HTTP/1.1
Host: api.novaposhta.ua/
Content-Type: application/xml
Accept: */*
Content-Length: 602

"<?xml version="1.0" encoding="UTF-8"?>
<file>
    <apiKey>[ВАШ КЛЮЧ]</apiKey>
    <modelName>TrackingDocumentGeneral</modelName>
    <calledMethod>getStatusDocuments</calledMethod>
    <methodProperties>
        <Documents>
            <item>
                <DocumentNumber>20400048799000</DocumentNumber>
                <Phone>380600000000</Phone>
            </item>
            <item>
                <DocumentNumber>20400048799001</DocumentNumber>
                <Phone>380600000000</Phone>
            </item>
        </Documents>
    </methodProperties>
</file>
"
200

Успішна відповідь (XML)

<?xml version="1.0" encoding="UTF-8"?>
<root>
    <success>true</success>
    <data>
        <item>
            <PossibilityCreateReturn>true</PossibilityCreateReturn>
            <PossibilityCreateRefusal>true</PossibilityCreateRefusal>
            <PossibilityChangeEW>true</PossibilityChangeEW>
            <PossibilityCreateRedirecting>true</PossibilityCreateRedirecting>
            <Number>20400048799000</Number>
            <Redelivery>0</Redelivery>
            <RedeliverySum>0</RedeliverySum>
            <RedeliveryNum></RedeliveryNum>
            <RedeliveryPayer>Sender/Recipient</RedeliveryPayer>
            <OwnerDocumentType></OwnerDocumentType>
            <LastCreatedOnTheBasisDocumentType></LastCreatedOnTheBasisDocumentType>
            <LastCreatedOnTheBasisPayerType></LastCreatedOnTheBasisPayerType>
            <LastCreatedOnTheBasisDateTime></LastCreatedOnTheBasisDateTime>
            <LastTransactionStatusGM></LastTransactionStatusGM>
            <LastTransactionDateTimeGM></LastTransactionDateTimeGM>
            <LastAmountTransferGM></LastAmountTransferGM>
            <DateCreated>18-11-2021 11:52:42</DateCreated>
            <DocumentWeight>3</DocumentWeight>
            <FactualWeight>3</FactualWeight>
            <VolumeWeight>0.1</VolumeWeight>
            <CheckWeight></CheckWeight>
            <CheckWeightMethod></CheckWeightMethod>
            <DocumentCost>51</DocumentCost>
            <CalculatedWeight>3</CalculatedWeight>
            <SumBeforeCheckWeight></SumBeforeCheckWeight>
            <PayerType>Sender</PayerType>
            <RecipientFullName>ПІБ</RecipientFullName>
            <RecipientDateTime>21.11.2021 13:53:47</RecipientDateTime>
            <ScheduledDeliveryDate>19.11.2021 13:53:47</ScheduledDeliveryDate>
            <PaymentMethod>Cash</PaymentMethod>
            <CargoDescriptionString>Одяг</CargoDescriptionString>
            <CargoType>Cargo</CargoType>
            <CitySender>Київ</CitySender>
            <CityRecipient>Київ</CityRecipient>
            <WarehouseRecipient>Відділення №101 (до 15 кг), Міні-відділення: вул. Велика Васильківська, 143/2, (маг. "Фора")</WarehouseRecipient>
            <CounterpartyType>PrivatePerson</CounterpartyType>
            <AfterpaymentOnGoodsCost>0</AfterpaymentOnGoodsCost>
            <ServiceType>WarehouseWarehouse</ServiceType>
            <UndeliveryReasonsSubtypeDescription></UndeliveryReasonsSubtypeDescription>
            <WarehouseRecipientNumber>101</WarehouseRecipientNumber>
            <LastCreatedOnTheBasisNumber></LastCreatedOnTheBasisNumber>
            <PhoneRecipient>380600000000</PhoneRecipient>
            <RecipientFullNameEW></RecipientFullNameEW>
            <WarehouseRecipientInternetAddressRef>00000000-0000-0000-0000-000000000000</WarehouseRecipientInternetAddressRef>
            <MarketplacePartnerToken></MarketplacePartnerToken>
            <ClientBarcode></ClientBarcode>
            <RecipientAddress>м. Київ, Відділення №101 (до 15 кг), Міні-відділення, вул. Велика Васильківська, 143/2</RecipientAddress>
            <CounterpartyRecipientDescription>Приватна особа</CounterpartyRecipientDescription>
            <CounterpartySenderType>PrivatePerson</CounterpartySenderType>
            <DateScan>0001-01-01 00:00:00</DateScan>
            <PaymentStatus></PaymentStatus>
            <PaymentStatusDate></PaymentStatusDate>
            <AmountToPay></AmountToPay>
            <AmountPaid></AmountPaid>
            <Status></Status>
            <StatusCode></StatusCode>
            <RefEW>00000000-0000-0000-0000-000000000000</RefEW>
            <BackwardDeliverySubTypesActions></BackwardDeliverySubTypesActions>
            <BackwardDeliverySubTypesServices></BackwardDeliverySubTypesServices>
            <UndeliveryReasons></UndeliveryReasons>
            <DatePayedKeeping></DatePayedKeeping>
            <InternationalDeliveryType></InternationalDeliveryType>
            <SeatsAmount>1</SeatsAmount>
            <CardMaskedNumber></CardMaskedNumber>
            <ExpressWaybillPaymentStatus>PaymentNotAvailable</ExpressWaybillPaymentStatus>
            <ExpressWaybillAmountToPay></ExpressWaybillAmountToPay>
            <PhoneSender></PhoneSender>
            <TrackingUpdateDate>2022-06-07 13:42:56</TrackingUpdateDate>
            <WarehouseSender>Отделение №178 (до 30 кг): просп. Оболонский, 35</WarehouseSender>
            <DateReturnCargo></DateReturnCargo>
            <DateMoving></DateMoving>
            <DateFirstDayStorage></DateFirstDayStorage>
            <RefCityRecipient>00000000-0000-0000-0000-000000000000</RefCityRecipient>
            <RefCitySender>00000000-0000-0000-0000-000000000000</RefCitySender>
            <RefSettlementRecipient>00000000-0000-0000-0000-000000000000</RefSettlementRecipient>
            <RefSettlementSender>00000000-0000-0000-0000-000000000000</RefSettlementSender>
            <SenderAddress>м. Київ, Відділення №178 (до 30 кг): просп. Оболонський, 35</SenderAddress>
            <SenderFullNameEW>Іванов Петро Миколайович</SenderFullNameEW>
            <AnnouncedPrice>50000</AnnouncedPrice>
            <AdditionalInformationEW></AdditionalInformationEW>
            <ActualDeliveryDate></ActualDeliveryDate>
            <PostomatV3CellReservationNumber>00000000-0000-0000-0000-000000000000</PostomatV3CellReservationNumber>
            <OwnerDocumentNumber></OwnerDocumentNumber>
            <LastAmountReceivedCommissionGM></LastAmountReceivedCommissionGM>
            <DeliveryTimeframe></DeliveryTimeframe>
            <CreatedOnTheBasis></CreatedOnTheBasis>
            <UndeliveryReasonsDate></UndeliveryReasonsDate>
            <RecipientWarehouseTypeRef>00000000-0000-0000-0000-000000000000</RecipientWarehouseTypeRef>
            <WarehouseRecipientRef>00000000-0000-0000-0000-000000000000</WarehouseRecipientRef>
            <CategoryOfWarehouse>Branch</CategoryOfWarehouse>
            <WarehouseRecipientAddress>Киев, Героев Днепра, 53</WarehouseRecipientAddress>
            <WarehouseSenderInternetAddressRef>00000000-0000-0000-0000-000000000000</WarehouseSenderInternetAddressRef>
            <WarehouseSenderAddress>Киев, Оболонский, 35</WarehouseSenderAddress>
            <AviaDelivery></AviaDelivery>
            <BarcodeRedBox></BarcodeRedBox>
            <CargoReturnRefusal>false</CargoReturnRefusal>
            <DaysStorageCargo></DaysStorageCargo>
            <Packaging></Packaging>
            <PartialReturnGoods></PartialReturnGoods>
            <SecurePayment>false</SecurePayment>
            <PossibilityChangeCash2Card>true</PossibilityChangeCash2Card>
            <PossibilityChangeDeliveryIntervals>true</PossibilityChangeDeliveryIntervals>
            <PossibilityTermExtensio>true</PossibilityTermExtensio>
            <StorageAmount></StorageAmount>
            <StoragePrice></StoragePrice>
            <FreeShipping></FreeShipping>
            <LoyaltyCardRecipient></LoyaltyCardRecipient>
        </item>
    </data>
    <errors/>
    <warnings/>
    <info/>
    <messageCodes/>
    <errorCodes/>
    <warningCodes/>
    <infoCodes/>
</root>

Останнє оновлення