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

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

Получить список ЭН

Метод «getDocumentList», работает в модели «InternetDocument», этот метод в ответе выведет все номера «ЭН», которые есть в личном кабинете и их идентификаторы (Ref) в АРI.
В запросе в свойствах метода можно указать дату за которую необходимо получить данные по ЭН.
"DateTime": "21.06.2016"
Если не указывать дату, то система автоматически выдаст Вам информацию по всем ЭН фактического дня.
В запросе в свойствах метода также можно указывать промежуток дат за которые необходимо получить данные по ЭН.
"DateTimeFrom": "21.06.2016",
"DateTimeTo": "24.06.2016"

Дополнительно внедрена возможно выгружать постраничный список.
"GetFullList": "0"
Если 0, то работает постраничная загрузка, если 1 - то весь список.

New


Добавлена возможность отображения всех ЭН с обратной доставкой (Денежный перевод или Касса форпост)
"RedeliveryMoney": "1"
Добавлена возможность отображения всех актуальных ЭН (по которым не написано заявление на возврат или утилизацию) не забранных получателями посылок.
"UnassembledCargo": "1"

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


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

Try it

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

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

string

Форматы JSON, XML

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

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

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

Параметр Тип данных Описание
apiKey* string[36] Ваш ключ API 2.0
modelName* string Имя модели
calledMethod* string Имя вызываемого метода
methodProperties   Свойства метода
DateTimeFrom string Дата от
DateTimeTo string Дата по
Page string Постраничное отображение, 100 записей на 1 стр (необязательно)
GetFullList string Включение или отключение постраничной загрузки (0 - работает постраничная загрузка, 1 - весь список)
DateTime string[36] Дата создание ЕН (не обязательный параметр)
* Обозначение обязательного параметра

<?xml version="1.0" encoding="UTF-8"?>
<root>
<apiKey>[ВАШ КЛЮЧ]</apiKey>
 <modelName>InternetDocument</modelName>
 <calledMethod>getDocumentList</calledMethod>
 <methodProperties>
 <DateTimeFrom>21.06.2016</DateTimeFrom > 
<DateTimeTo>24.06.2016</DateTimeTo> 
<Page>1</Page> 
<GetFullList>0</GetFullList>
 </methodProperties>
</root>
{
   "apiKey": "[ВАШ КЛЮЧ]",
   "modelName": "InternetDocument",
   "calledMethod": "getDocumentList",
   "methodProperties": {
      "DateTimeFrom": "21.06.2016",
      "DateTimeTo": "24.06.2016",
      "Page": "1",
      "GetFullList": "0"
   }
}

Ответ 200

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


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

Параметр Тип данных Описание
Ref string[36] Идентификатор ЭН
DateTime string[36] Фактическая дата отправки
PreferredDeliveryDate string[36] Желаемая дата доставки
Weight int[36] Фактический вес
SeatsAmount int[36] Количество мест
IntDocNumber int[36] Номер интернет документа
Cost int[36] Оценочная стоимость
CitySender string[36] Идентификатор города отправителя
CityRecipient string[36] Идентификатор города получателя
SenderAddress string[36] Идентификатор адреса отправителя
RecipientAddress string[36] Идентификатор адреса получателя
CostOnSite int[36] стоимость за доставку
PayerType string[36] Плательщик доставки
PaymentMethod string[36] Тип оплаты
AfterpaymentOnGoodsCost string[36] Обратная доставка
PackingNumber string[36] Номер упаковки
RejectionReason string[36] Описание причины неразвоза

{
 "success": true,
 "data": [
 {
 "Ref": "34909b24-d206-11e4-bdb5-005056801329",
 "DateTime": "2015-03-24 00:00:00",
 "PreferredDeliveryDate": "0001-01-01 00:00:00",
 "Weight": "50.00",
 "SeatsAmount": "1",
 "IntDocNumber": "20400030200931",
 "Cost": "500.00",
"CitySender": "8d5a980d-391c-11dd-90d9-001a92567626",
 "CityRecipient": "8d5a980d-391c-11dd-90d9-001a92567626",
 "State": "00000000-0000-0000-0000-000000000000",
 "SenderAddress": "0d545ecf-e1c2-11e3-8c4a-0050568002cf",
 "RecipientAddress": "1ec09d88-e1c2-11e3-8c4a-0050568002cf",
 "CostOnSite": "141.00",
 "PayerType": "Sender",
 "PaymentMethod": "Cash",
 "AfterpaymentOnGoodsCost": "0.00",
 "PackingNumber": "4545",
 "Number": null,
 "Posted": null,
 "DeletionMark": null,
 "CargoType": null,
 "Route": null,
 "EWNumber": null,
 "Description": null,
 "SaturdayDelivery": null,
 "ExpressWaybill": null,
 "CarCall": null,
 "ServiceType": null,
 "DeliveryDateFrom": null,
 "Vip": null,
 "AdditionalInformation": null,
 "LastModificationDate": null,
 "ReceiptDate": null,
 "LoyaltyCard": null,
 "Sender": null,
 "ContactSender": null,
 "SendersPhone": null,
 "Recipient": null,
 "ContactRecipient": null,
 "RecipientsPhone": null,
 "Redelivery": null,
 "SaturdayDeliveryString": null,
 "Note": null,
 "ThirdPerson": null,
 "Forwarding": null,
 "NumberOfFloorsLifting": null,
 "StatementOfAcceptanceTransferCargoID": null,
 "StateId": 1,
 "StateName": "Замовлення в обробці",
 "RecipientFullName": null,
 "RecipientPost": null,
 "RecipientDateTime": null,
 "RejectionReason": null,
 "CitySenderDescription": "Київ",
 "CityRecipientDescription": "Київ",
 "SenderDescription": "CBS-369138 ",
 "RecipientDescription": "Тест2",
 "RecipientContactPhone": "380997579789",
 "RecipientContactPerson": "Пакитенко Микола Іванович",
 "SenderAddressDescription": "Відділення №87 (до 30 кг): вул. Княжий
Затон, 14б",
"RecipientAddressDescription": "Відділення №1: вул.
Червонопрапорна, 34 (Корчувате)",
 "Printed": "0",
 "Fulfillment": 0,
 "EstimatedDeliveryDate": "2015-03-25 00:00:00",
 "DateLastUpdatedStatus": "2015-03-24 11:52:02",
 "CreateTime": "2015-03-24 11:14:42",
 "ScanSheetNumber": "",
 "InfoRegClientBarcodes": "",
 "StatePayId": "0",
 "StatePayName": "",
 "BackwardDeliveryCargoType": ""
 }
 ],
 "errors": [],
 "warnings": [],
 "info": []
}
<?xml version="1.0" encoding="UTF-8"?>
<root>
 <success>true</success>
 <data>
 <item>
 <Ref>307e530d-d9f0-11e4-bdb5-005056801329</Ref>
 <DateTime>2015-04-04 00:00:00</DateTime>
 <PreferredDeliveryDate>0001-01-01 00:00:00</PreferredDeliveryDate>
 <Weight>0.10</Weight>
 <SeatsAmount>1</SeatsAmount>
 <IntDocNumber>20400030201092</IntDocNumber>
<Cost>500.00</Cost>
 <CitySender>8d5a980d-391c-11dd-90d9-001a92567626</CitySender>
 <CityRecipient>8d5a980d-391c-11dd-90d9-001a92567626</CityRecipient>
 <SenderAddress>0d545ecf-e1c2-11e3-8c4a-
0050568002cf</SenderAddress>
 <RecipientAddress>1ec09d88-e1c2-11e3-8c4a-
0050568002cf</RecipientAddress>
 <CostOnSite>45.00</CostOnSite>
 <PayerType>Sender</PayerType>
 <PaymentMethod>Cash</PaymentMethod>
 <AfterpaymentOnGoodsCost>0.00</AfterpaymentOnGoodsCost>
 <PackingNumber></PackingNumber>
 <Number></Number>
 <Posted></Posted>
 <DeletionMark></DeletionMark>
 <CargoType></CargoType>
 <Route></Route>
 <EWNumber></EWNumber>
 <Description></Description>
 <SaturdayDelivery></SaturdayDelivery>
 <ExpressWaybill></ExpressWaybill>
 <CarCall></CarCall>
 <ServiceType></ServiceType>
 <DeliveryDateFrom></DeliveryDateFrom>
 <Vip></Vip>
 <AdditionalInformation></AdditionalInformation>
 <LastModificationDate></LastModificationDate>
 <ReceiptDate></ReceiptDate>
 <LoyaltyCard></LoyaltyCard>
 <Sender></Sender>
 <ContactSender></ContactSender>
 <SendersPhone></SendersPhone>
 <Recipient></Recipient>
 <ContactRecipient></ContactRecipient>
 <RecipientsPhone></RecipientsPhone>
 <Redelivery></Redelivery>
 <SaturdayDeliveryString></SaturdayDeliveryString>
 <Note></Note>
 <ThirdPerson></ThirdPerson>
 <Forwarding></Forwarding>
 <NumberOfFloorsLifting></NumberOfFloorsLifting>

<StatementOfAcceptanceTransferCargoID></StatementOfAcceptanceTransferCargoID>
 <StateId>1</StateId>
 <StateName>Замовлення в обробці</StateName>
 <RecipientFullName></RecipientFullName>
 <RecipientPost></RecipientPost>
 <RecipientDateTime></RecipientDateTime>
 <RejectionReason></RejectionReason>
 <CitySenderDescription>Київ</CitySenderDescription>
 <CityRecipientDescription>Київ</CityRecipientDescription>
 <SenderDescription>CBS-369138</SenderDescription>
 <RecipientDescription>Тест2</RecipientDescription>
 <RecipientContactPhone>380997579789</RecipientContactPhone>
<RecipientContactPerson>Пакитенко Микола
Іванович</RecipientContactPerson>
 <SenderAddressDescription>Відділення №87 (до 30 кг): вул. Княжий
Затон, 14б</SenderAddressDescription>
 <RecipientAddressDescription>Відділення №1: вул. Червонопрапорна,
34 (Корчувате)</RecipientAddressDescription>
 <Printed>0</Printed>
 <Fulfillment>0</Fulfillment>
 <EstimatedDeliveryDate>2015-04-06 00:00:00</EstimatedDeliveryDate>
 <DateLastUpdatedStatus>2015-04-03 13:57:15</DateLastUpdatedStatus>
 <CreateTime>2015-04-03 13:57:15</CreateTime>
 <ScanSheetNumber></ScanSheetNumber>
 <InfoRegClientBarcodes></InfoRegClientBarcodes>
 <StatePayId>0</StatePayId>
 <StatePayName></StatePayName>
 <BackwardDeliveryCargoType></BackwardDeliveryCargoType>
 </item>
 </data>
 <errors></errors>
 <warnings></warnings>
 <info></info>
 </root>