Портал для розробників-TrackingDocument-getStatusDocuments

Трекінг

Оновлений метод «getStatusDocuments» працює в моделі «TrackingDocument», цей метод дозволяє переглядати більш розширену інформацію щодо статусу відправлення.

При введеному номері телефону можна отримати наступні відомості: дані відправника або одержувача, номер телефону.

Метод дозволяє переглядати одночасно до 100 відправлень.

Доступність: Не вимагає використання API-ключа.

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

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

Текст запиту

Параметр	Тип	Опис
Documents*	array	Масив документів, який слід відстежити. У параметрі DocumentNumber вказується номер документа, а в парметрі Phone номер телефону одержувача/відправника дозволяє отримати розширену інформацію
CheckWeightMethod*	string[36]	Тип зважування, згідно якого виконувалось контрольне зважування
CalculatedWeight*	string[36]	Розрахункова вага

* Позначення обов’язкового параметру

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

                                  

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

Відповідь 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]	Останній час та дата транзакції грошового переказу
LastAmountTransferGM	string[36]	Поточне значення суми грошового переказу
DateCreated	string[36]	Дата створення ЕН
DocumentWeight	string[36]	Вага
FactualWeight	string[36]	Фактична вага з ЕН
VolumeWeight	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]	Ідентифікатор (REF) складу отримувача
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" : "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" : "","DocumentCost" : "51","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" : ""  }],
  "errors": [],
  "warnings": [],
  "info": [],
  "messageCodes": [],
  "errorCodes": [],
  "warningCodes": [],
  "infoCodes": []
}

                                   
<?xml version="1.0" encoding="UTF-8"?>
<root>
    <success>true</success>
    <data>
        <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>
        <DocumentCost>"51"</DocumentCost>
        <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>
    </data>
    <errors/>
    <warnings/>
    <info/>
    <messageCodes/>
    <errorCodes/>
    <warningCodes/>
    <infoCodes/>
</root>

Спробувати API

Трекінг

                                   
    <?xml version="1.0" encoding="UTF-8"?>
            <file>
                <apiKey>[ВАШ КЛЮЧ]</apiKey>
                <modelName>TrackingDocument</modelName>
                <calledMethod>getStatusDocuments</calledMethod>
                <methodProperties>
                    <Documents><array></array></Documents>
                    <CheckWeightMethod></CheckWeightMethod>
                    <CalculatedWeight></CalculatedWeight>
                </methodProperties>
            </file>