Трекінг
Отримання детальної інформації про статус відправлень
Метод getStatusDocuments у моделі TrackingDocumentGeneral (або TrackingDocument) надає можливість перегляду детальної інформації про статус відправлень. Цей метод дозволяє користувачам отримати актуальні дані щодо статусу їхніх відправлень, зокрема інформацію про відправника та одержувача.
Основні можливості методу:
Отримання даних за номером телефону: Під час введення номера телефону можна отримати інформацію про відправника та одержувача, включно з їхніми контактними даними.
Масовий перегляд відправлень: Метод дозволяє переглядати інформацію одночасно до 100 відправлень.
Актуальні статуси трекінгу: Метод відображає всі актуальні статуси трекінгу для кожного відправлення.
Доступність: Метод доступний як для авторизованих, так і для неавторизованих запитів.
Авторизований доступ має такі особливості:
Для отримання повних даних про відправлення необхідно використовувати API-ключ.
У разі успішної авторизації та валідації повертаються коректні дані відправника та одержувача.
Неавторизований доступ (без використання API-ключа) має обмежений доступ до даних. Для запитів застосовується логіка підміни — дані відправника та одержувача замінюються на дані, що належать номеру телефону із запиту.
API-ключ користувача (необов'язковий для неавторизованого доступу)
[ВАШ КЛЮЧ]Назва моделі API
Назва методу API
Успішна відповідь (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"
}
]
}
}Успішна відповідь (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": []
}Метод getStatusDocuments у моделі TrackingDocumentGeneral (або TrackingDocument) надає можливість перегляду детальної інформації про статус відправлень. Цей метод дозволяє користувачам отримати актуальні дані щодо статусу їхніх відправлень, зокрема інформацію про відправника та одержувача.
Основні можливості методу:
Отримання даних за номером телефону: Під час введення номера телефону можна отримати інформацію про відправника та одержувача, включно з їхніми контактними даними.
Масовий перегляд відправлень: Метод дозволяє переглядати інформацію одночасно до 100 відправлень.
Актуальні статуси трекінгу: Метод відображає всі актуальні статуси трекінгу для кожного відправлення.
Доступність: Метод доступний як для авторизованих, так і для неавторизованих запитів.
Авторизований доступ має такі особливості:
Для отримання повних даних про відправлення необхідно використовувати API-ключ.
У разі успішної авторизації та валідації повертаються коректні дані відправника та одержувача.
Неавторизований доступ (без використання API-ключа) має обмежений доступ до даних. Для запитів застосовується логіка підміни — дані відправника та одержувача замінюються на дані, що належать номеру телефону із запиту.
API-ключ користувача (необов'язковий для неавторизованого доступу)
Назва моделі API
Назва методу API
Успішна відповідь (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>
"Успішна відповідь (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>
Останнє оновлення