Метод «getDocumentList», працює в моделі «InternetDocument», цей метод у відповіді виведе всі номери ЕН, які створено в даному в особистому кабінеті та їх ідентифікатори (Ref) в АРI.
У запиті у властивостях методу можна вказати дату, за яку необхідно отримати дані по ЕН у параметрі "DateTime".
Якщо не вказувати дату, система автоматично видасть Вам інформацію по всіх ЕН фактичного дня. У запиті у властивостях методу також можна вказувати проміжок дат, за які необхідно отримати дані по ЕН "DateTimeFrom" і "DateTimeTo".
Додатково впроваджена можливість вивантажувати сторінковий список, використовуючи параметр "GetFullList". Якщо 0, то працює сторінкове завантаження, якщо 1 - весь список.
Додано можливість відображення всіх ЕН зі зворотною доставкою (Грошовий переказ або Каса форпост) "RedeliveryMoney" зі значенням "1".
| Параметр | Тип | Опис |
|---|---|---|
| DateTimeFrom* | string[36] | Дата від |
| DateTimeTo* | string[36] | Дата до |
| Page | string[36] | Сторінки, до 100 записів а одній сторінці |
| GetFullList* | string[36] | Ввімкненні/вимкнення посторінкового завантаження (0- працює посторінкове завантаження, 1- весь список) |
| DateTime | string[36] | Дата створення ЕН |
{
"apiKey": "[ВАШ КЛЮЧ]",
"modelName": "InternetDocument",
"calledMethod": "getDocumentList",
"methodProperties": {"DateTimeFrom" : "дд.мм.рррр","DateTimeTo" : "дд.мм.рррр","Page" : "1","GetFullList" : "1","DateTime" : "дд.мм.рррр" }
}
Відповідь 200
Завжди повертає код 200 навіть при логічних помилках.
| Параметр | Тип | Опис |
| Ref | string[36] | Ідентифікатор (REF) ЕН |
| DateTime | string[36] | Дата створення ІД |
| PreferredDeliveryDate | string[36] | Бажана дата доставки |
| RecipientDateTime | string[36] | Дата отримання |
| EWDateCreated | string[36] | Дата створення ЕН |
| Weight | string[36] | Фактична вага |
| SeatsAmount | string[36] | Кількість місць відправлення, ціле число |
| IntDocNumber | string[36] | Номер інтернет документу |
| Cost | string[36] | Оціночна вартість |
| CitySender | string[36] | Ідентифікатор (REF) міста відправника |
| CityRecipient | string[36] | Ідентифікатор (REF) міста отримувача |
| SenderAddress | string[36] | Ідентифікатор (REF) адреси відправника |
| RecipientAddress | string[36] | Ідентифікатор (REF) адреси відправника |
| CostOnSite | string[36] | Вартість за доставку |
| PayerType | string[36] | Тип платника |
| PaymentMethod | string[36] | Форма розрахунку Cash/NonCash |
| AfterpaymentOnGoodsCost | string[36] | Зворотня доставка |
| PackingNumber | string[36] | Номер пакування |
| RejectionReason | string[36] | Опис причини нерозвозу |
| StateId | string[36] | Код статусу ЕН (дорівнює статусу трекінга) |
| StateName | string[50] | Опис статусу ЕН |
{
"success": true,
"data": [{"Ref" : "00000000-0000-0000-0000-000000000000","DateTime" : "дд.мм.рррр","PreferredDeliveryDate" : "дд.мм.рррр","RecipientDateTime" : "дд.мм.рррр","EWDateCreated" : "дд.мм.рррр","Weight" : "5","SeatsAmount" : "2","IntDocNumber" : "20400030200931","Cost" : "15000","CitySender" : "00000000-0000-0000-0000-000000000000","CityRecipient" : "00000000-0000-0000-0000-000000000000","SenderAddress" : "00000000-0000-0000-0000-000000000000","RecipientAddress" : "00000000-0000-0000-0000-000000000000","CostOnSite" : "45","PayerType" : "Sender","PaymentMethod" : "Cash","AfterpaymentOnGoodsCost" : "500","PackingNumber" : "123456","RejectionReason" : "Опис причини переадресування","StateId" : "41","StateName" : "Відправлення в місті Києві" }],
"errors": [],
"warnings": [],
"info": [],
"messageCodes": [],
"errorCodes": [],
"warningCodes": [],
"infoCodes": []
}