> For the complete documentation index, see [llms.txt](https://api-portal.novapost.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://api-portal.novapost.com/api-docs-ua/zagalna-informaciya/frakht.md).
# Фрахт
:link:[*Початок роботи з API*](https://api-portal.novapost.com/api-docs-ua)
## Отримати список заявок (JSON)
> Метод \*\*getFreightList\*\* моделі \*\*Freight\*\* (або \*\*FreightGeneral\*\*) дозволяє отримати список заявок на фрахт.
```json
{"openapi":"3.0.3","info":{"title":"API Nova Post — Freight","version":"2.0.0"},"tags":[{"name":"Freight","description":"Операції, пов'язані із заявками на фрахт"}],"servers":[{"url":"https://api.novaposhta.ua/v2.0/","description":"production"}],"paths":{"/json/":{"post":{"tags":["Freight"],"operationId":"getFreightListJson","summary":"Отримати список заявок (JSON)","description":"Метод **getFreightList** моделі **Freight** (або **FreightGeneral**) дозволяє отримати список заявок на фрахт.\n","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetFreightListJsonRequest"}}}},"responses":{"200":{"description":"Успішна відповідь (JSON)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetFreightListResponse"}}}}}}}},"components":{"schemas":{"GetFreightListJsonRequest":{"type":"object","additionalProperties":false,"required":["apiKey","modelName","calledMethod","methodProperties"],"properties":{"apiKey":{"type":"string","description":"API-ключ користувача"},"modelName":{"type":"string","enum":["FreightGeneral","Freight"],"description":"Назва моделі API"},"calledMethod":{"type":"string","enum":["getFreightList"],"description":"Назва методу API"},"methodProperties":{"$ref":"#/components/schemas/GetFreightListMethodProperties"}}},"GetFreightListMethodProperties":{"type":"object","additionalProperties":false,"properties":{"Ref":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) заявки"},"Number":{"type":"string","maxLength":36,"description":"Номер заявки"},"DateTime":{"type":"string","maxLength":36,"description":"Дата створення"},"DeclaredCost":{"type":"string","maxLength":36,"description":"Оголошена вартість"},"Status":{"type":"string","maxLength":36,"description":"Статус заявки"},"DateTimeVehicleFiling":{"type":"string","maxLength":36,"description":"Дата та час подачі авто на завантаження"},"SenderSettlement":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) міста відправника із довідника getSettlements"},"RecipientSettlement":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) міста отримувача із довідника getSettlements"},"Customer":{"type":"string","maxLength":36,"description":"Замовник"},"CustomerContactName":{"type":"string","maxLength":36,"description":"Контактна особа замовника"},"CustomerPhone":{"type":"string","maxLength":36,"description":"Номер телефону замовника"},"Weight":{"type":"string","maxLength":36,"description":"Вага"},"Volume":{"type":"string","maxLength":36,"description":"Об'ємна вага"},"Page":{"type":"string","maxLength":36,"description":"Сторінка"},"Limit":{"type":"string","maxLength":36,"description":"Ліміт, кількість записів на сторінці"}}},"GetFreightListResponse":{"type":"object","additionalProperties":false,"required":["success","data","errors","warnings","info","messageCodes","errorCodes","warningCodes","infoCodes"],"properties":{"success":{"type":"boolean","description":"Прапор успішності виконання запиту"},"data":{"type":"array","description":"Масив заявок на фрахт","items":{"$ref":"#/components/schemas/FreightListItem"}},"errors":{"type":"array","description":"Масив повідомлень про помилки","items":{"type":"string"}},"warnings":{"type":"array","description":"Масив попереджень","items":{"type":"string"}},"info":{"type":"array","description":"Масив інформаційних повідомлень","items":{"type":"string"}},"messageCodes":{"type":"array","description":"Масив кодів інформаційних повідомлень","items":{"type":"string"}},"errorCodes":{"type":"array","description":"Масив кодів помилок","items":{"type":"string"}},"warningCodes":{"type":"array","description":"Масив кодів попереджень","items":{"type":"string"}},"infoCodes":{"type":"array","description":"Масив кодів додаткової інформації","items":{"type":"string"}}}},"FreightListItem":{"type":"object","additionalProperties":false,"properties":{"Ref":{"type":"string","maxLength":36,"description":"Ідентифікатор заявки"},"Number":{"type":"string","maxLength":36,"description":"Номер заявки"},"DateTime":{"type":"string","maxLength":36,"description":"Дата створення заявки"},"DeletionMark":{"type":"string","maxLength":36,"description":"Ознака, що заявку видалено (0 — заявку не видалено, 1 — заявку видалено)"},"Status":{"type":"string","maxLength":36,"description":"Статус заявки"},"DeniedReason":{"type":"string","maxLength":36,"description":"Причина спростування"},"DateTimeVehicleFiling":{"type":"string","maxLength":36,"description":"Дата та час подачі авто на завантаження"},"DateTimeVehicleDeparture":{"type":"string","maxLength":36,"description":"Дата та час виїзду авто в рейс після завантаження"},"DateTimeVehicleArrival":{"type":"string","maxLength":36,"description":"Дата і час прибуття авто"},"DateTimeVehicleUnloading":{"type":"string","maxLength":36,"description":"Дата та час вивантаження авто одержувачем"},"CargoDescriptionString":{"type":"string","maxLength":36,"description":"Опис вантажу"},"DeclaredCost":{"type":"string","maxLength":36,"description":"Заявлена вартість послуг"},"Cost":{"type":"string","maxLength":36,"description":"Оголошена вартість"},"Weight":{"type":"string","maxLength":36,"description":"Вага в кг"},"Length":{"type":"string","maxLength":36,"description":"Довжина"},"Width":{"type":"string","maxLength":36,"description":"Ширина"},"Height":{"type":"string","maxLength":36,"description":"Висота"},"Volume":{"type":"string","maxLength":36,"description":"Об'ємна вага"},"SemiTrailerType":{"type":"string","maxLength":36,"description":"Тип транспортного засобу"},"Customer":{"type":"string","maxLength":36,"description":"Замовник"},"CustomerContactName":{"type":"string","maxLength":50,"description":"Контактна особа замовника"},"CustomerPhone":{"type":"string","maxLength":36,"description":"Номер телефону замовника"},"CustomerEMail":{"type":"string","maxLength":36,"description":"Електронна скринька замовника"},"SenderSettlement":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) міста відправника із довідника getSettlements"},"SenderAddressString":{"type":"string","maxLength":36,"description":"Адреса відправника (зазначається рядком)"},"SenderString":{"type":"string","maxLength":36,"description":"Відправник"},"SenderName":{"type":"string","maxLength":50,"description":"Контактна особа відправника"},"SenderPhone":{"type":"string","maxLength":36,"description":"Номер телефону відправника"},"SenderEMail":{"type":"string","maxLength":36,"description":"Електронна скринька відправника"},"RecipientSettlement":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) міста отримувача із довідника getSettlements"},"RecipientAddressString":{"type":"string","maxLength":50,"description":"Адреса отримувача (зазначається рядком)"},"RecipientString":{"type":"string","maxLength":36,"description":"Отримувач"},"RecipientName":{"type":"string","maxLength":50,"description":"Контактна особа отримувача"},"RecipientPhone":{"type":"string","maxLength":36,"description":"Номер телефону отримувача"},"RecipientEMail":{"type":"string","maxLength":36,"description":"Електронна скринька отримувача"},"AdditionalInformation":{"type":"string","maxLength":36,"description":"Додаткова інформація"},"IntermediateStoppingPoints":{"type":"object","description":"Проміжні зупинки (індексований об'єкт з номерами зупинок як ключами)","additionalProperties":{"$ref":"#/components/schemas/IntermediateStoppingPointItem"}},"CustomerDescription":{"type":"string","maxLength":50,"description":"Опис замовника"},"SenderSettlementDescription":{"type":"string","maxLength":36,"description":"Опис населеного пункту відправника"},"RecipientSettlementDescription":{"type":"string","maxLength":36,"description":"Опис населеного пункту отримувача"}}},"IntermediateStoppingPointItem":{"type":"object","additionalProperties":false,"description":"Детальна інформація про проміжну зупинку","properties":{"Settlement":{"type":"string","format":"uuid","maxLength":36,"description":"Ідентифікатор (REF) населеного пункту"},"SettlementDescription":{"type":"string","maxLength":50,"description":"Опис/назва населеного пункту"},"AddressDescription":{"type":"string","maxLength":100,"description":"Адреса зупинки (зазначається рядком)"},"DateTimeVehicleDeparture":{"type":"string","maxLength":36,"description":"Дата та час виїзду авто"},"DateTimeVehicleArrival":{"type":"string","maxLength":36,"description":"Дата та час прибуття авто"},"ContactName":{"type":"string","maxLength":50,"description":"Контактна особа на проміжній зупинці"},"Phone":{"type":"string","maxLength":36,"description":"Номер телефону контактної особи"}}}}}}
```
## Отримати список заявок (XML)
> Метод \*\*getFreightList\*\* моделі \*\*Freight\*\* (або \*\*FreightGeneral\*\*) дозволяє отримати список заявок на фрахт.
```json
{"openapi":"3.0.3","info":{"title":"API Nova Post — Freight","version":"2.0.0"},"tags":[{"name":"Freight","description":"Операції, пов'язані із заявками на фрахт"}],"servers":[{"url":"https://api.novaposhta.ua/v2.0/","description":"production"}],"paths":{"/xml/":{"post":{"tags":["Freight"],"operationId":"getFreightListXml","summary":"Отримати список заявок (XML)","description":"Метод **getFreightList** моделі **Freight** (або **FreightGeneral**) дозволяє отримати список заявок на фрахт.\n","requestBody":{"required":true,"content":{"application/xml":{"schema":{"$ref":"#/components/schemas/GetFreightListXmlRequest"}}}},"responses":{"200":{"description":"Успішна відповідь (XML)","content":{"application/xml":{"schema":{"$ref":"#/components/schemas/GetFreightListXmlResponse"}}}}}}}},"components":{"schemas":{"GetFreightListXmlRequest":{"type":"object","additionalProperties":false,"xml":{"name":"file"},"required":["apiKey","modelName","calledMethod","methodProperties"],"properties":{"apiKey":{"type":"string","description":"API-ключ користувача"},"modelName":{"type":"string","enum":["FreightGeneral","Freight"],"description":"Назва моделі API"},"calledMethod":{"type":"string","enum":["getFreightList"],"description":"Назва методу API"},"methodProperties":{"$ref":"#/components/schemas/GetFreightListXmlMethodProperties"}}},"GetFreightListXmlMethodProperties":{"allOf":[{"$ref":"#/components/schemas/GetFreightListMethodProperties"}],"xml":{"name":"methodProperties"}},"GetFreightListMethodProperties":{"type":"object","additionalProperties":false,"properties":{"Ref":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) заявки"},"Number":{"type":"string","maxLength":36,"description":"Номер заявки"},"DateTime":{"type":"string","maxLength":36,"description":"Дата створення"},"DeclaredCost":{"type":"string","maxLength":36,"description":"Оголошена вартість"},"Status":{"type":"string","maxLength":36,"description":"Статус заявки"},"DateTimeVehicleFiling":{"type":"string","maxLength":36,"description":"Дата та час подачі авто на завантаження"},"SenderSettlement":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) міста відправника із довідника getSettlements"},"RecipientSettlement":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) міста отримувача із довідника getSettlements"},"Customer":{"type":"string","maxLength":36,"description":"Замовник"},"CustomerContactName":{"type":"string","maxLength":36,"description":"Контактна особа замовника"},"CustomerPhone":{"type":"string","maxLength":36,"description":"Номер телефону замовника"},"Weight":{"type":"string","maxLength":36,"description":"Вага"},"Volume":{"type":"string","maxLength":36,"description":"Об'ємна вага"},"Page":{"type":"string","maxLength":36,"description":"Сторінка"},"Limit":{"type":"string","maxLength":36,"description":"Ліміт, кількість записів на сторінці"}}},"GetFreightListXmlResponse":{"type":"object","additionalProperties":false,"xml":{"name":"root"},"required":["success","data","errors","warnings","info","messageCodes","errorCodes","warningCodes","infoCodes"],"properties":{"success":{"type":"boolean","description":"Прапор успішності виконання запиту"},"data":{"type":"array","description":"Масив заявок на фрахт","xml":{"name":"data","wrapped":true},"items":{"$ref":"#/components/schemas/FreightListXmlItem"}},"errors":{"type":"array","description":"Масив повідомлень про помилки","xml":{"name":"errors","wrapped":true},"items":{"type":"string","xml":{"name":"item"}}},"warnings":{"type":"array","description":"Масив попереджень","xml":{"name":"warnings","wrapped":true},"items":{"type":"string","xml":{"name":"item"}}},"info":{"type":"array","description":"Масив інформаційних повідомлень","xml":{"name":"info","wrapped":true},"items":{"type":"string","xml":{"name":"item"}}},"messageCodes":{"type":"array","description":"Масив кодів інформаційних повідомлень","xml":{"name":"messageCodes","wrapped":true},"items":{"type":"string","xml":{"name":"item"}}},"errorCodes":{"type":"array","description":"Масив кодів помилок","xml":{"name":"errorCodes","wrapped":true},"items":{"type":"string","xml":{"name":"item"}}},"warningCodes":{"type":"array","description":"Масив кодів попереджень","xml":{"name":"warningCodes","wrapped":true},"items":{"type":"string","xml":{"name":"item"}}},"infoCodes":{"type":"array","description":"Масив кодів додаткової інформації","xml":{"name":"infoCodes","wrapped":true},"items":{"type":"string","xml":{"name":"item"}}}}},"FreightListXmlItem":{"allOf":[{"$ref":"#/components/schemas/FreightListItem"}],"properties":{"IntermediateStoppingPoints":{"type":"array","description":"Проміжні зупинки","xml":{"name":"IntermediateStoppingPoints","wrapped":true},"items":{"$ref":"#/components/schemas/IntermediateStoppingPointItem","xml":{"name":"item"}}}},"xml":{"name":"item"}},"FreightListItem":{"type":"object","additionalProperties":false,"properties":{"Ref":{"type":"string","maxLength":36,"description":"Ідентифікатор заявки"},"Number":{"type":"string","maxLength":36,"description":"Номер заявки"},"DateTime":{"type":"string","maxLength":36,"description":"Дата створення заявки"},"DeletionMark":{"type":"string","maxLength":36,"description":"Ознака, що заявку видалено (0 — заявку не видалено, 1 — заявку видалено)"},"Status":{"type":"string","maxLength":36,"description":"Статус заявки"},"DeniedReason":{"type":"string","maxLength":36,"description":"Причина спростування"},"DateTimeVehicleFiling":{"type":"string","maxLength":36,"description":"Дата та час подачі авто на завантаження"},"DateTimeVehicleDeparture":{"type":"string","maxLength":36,"description":"Дата та час виїзду авто в рейс після завантаження"},"DateTimeVehicleArrival":{"type":"string","maxLength":36,"description":"Дата і час прибуття авто"},"DateTimeVehicleUnloading":{"type":"string","maxLength":36,"description":"Дата та час вивантаження авто одержувачем"},"CargoDescriptionString":{"type":"string","maxLength":36,"description":"Опис вантажу"},"DeclaredCost":{"type":"string","maxLength":36,"description":"Заявлена вартість послуг"},"Cost":{"type":"string","maxLength":36,"description":"Оголошена вартість"},"Weight":{"type":"string","maxLength":36,"description":"Вага в кг"},"Length":{"type":"string","maxLength":36,"description":"Довжина"},"Width":{"type":"string","maxLength":36,"description":"Ширина"},"Height":{"type":"string","maxLength":36,"description":"Висота"},"Volume":{"type":"string","maxLength":36,"description":"Об'ємна вага"},"SemiTrailerType":{"type":"string","maxLength":36,"description":"Тип транспортного засобу"},"Customer":{"type":"string","maxLength":36,"description":"Замовник"},"CustomerContactName":{"type":"string","maxLength":50,"description":"Контактна особа замовника"},"CustomerPhone":{"type":"string","maxLength":36,"description":"Номер телефону замовника"},"CustomerEMail":{"type":"string","maxLength":36,"description":"Електронна скринька замовника"},"SenderSettlement":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) міста відправника із довідника getSettlements"},"SenderAddressString":{"type":"string","maxLength":36,"description":"Адреса відправника (зазначається рядком)"},"SenderString":{"type":"string","maxLength":36,"description":"Відправник"},"SenderName":{"type":"string","maxLength":50,"description":"Контактна особа відправника"},"SenderPhone":{"type":"string","maxLength":36,"description":"Номер телефону відправника"},"SenderEMail":{"type":"string","maxLength":36,"description":"Електронна скринька відправника"},"RecipientSettlement":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) міста отримувача із довідника getSettlements"},"RecipientAddressString":{"type":"string","maxLength":50,"description":"Адреса отримувача (зазначається рядком)"},"RecipientString":{"type":"string","maxLength":36,"description":"Отримувач"},"RecipientName":{"type":"string","maxLength":50,"description":"Контактна особа отримувача"},"RecipientPhone":{"type":"string","maxLength":36,"description":"Номер телефону отримувача"},"RecipientEMail":{"type":"string","maxLength":36,"description":"Електронна скринька отримувача"},"AdditionalInformation":{"type":"string","maxLength":36,"description":"Додаткова інформація"},"IntermediateStoppingPoints":{"type":"object","description":"Проміжні зупинки (індексований об'єкт з номерами зупинок як ключами)","additionalProperties":{"$ref":"#/components/schemas/IntermediateStoppingPointItem"}},"CustomerDescription":{"type":"string","maxLength":50,"description":"Опис замовника"},"SenderSettlementDescription":{"type":"string","maxLength":36,"description":"Опис населеного пункту відправника"},"RecipientSettlementDescription":{"type":"string","maxLength":36,"description":"Опис населеного пункту отримувача"}}},"IntermediateStoppingPointItem":{"type":"object","additionalProperties":false,"description":"Детальна інформація про проміжну зупинку","properties":{"Settlement":{"type":"string","format":"uuid","maxLength":36,"description":"Ідентифікатор (REF) населеного пункту"},"SettlementDescription":{"type":"string","maxLength":50,"description":"Опис/назва населеного пункту"},"AddressDescription":{"type":"string","maxLength":100,"description":"Адреса зупинки (зазначається рядком)"},"DateTimeVehicleDeparture":{"type":"string","maxLength":36,"description":"Дата та час виїзду авто"},"DateTimeVehicleArrival":{"type":"string","maxLength":36,"description":"Дата та час прибуття авто"},"ContactName":{"type":"string","maxLength":50,"description":"Контактна особа на проміжній зупинці"},"Phone":{"type":"string","maxLength":36,"description":"Номер телефону контактної особи"}}}}}}
```
## Відкликати заявку (JSON)
> Метод \*\*deny\*\* працює в моделі \*\*Freight\*\* (або \*\*FreightGeneral\*\*) і дозволяє відкликати подану заявку.
```json
{"openapi":"3.0.3","info":{"title":"API Nova Post — Freight","version":"2.0.0"},"tags":[{"name":"Freight","description":"Операції, пов'язані із заявками на фрахт"}],"servers":[{"url":"https://api.novaposhta.ua/v2.0/","description":"production"}],"paths":{"/json/":{"post":{"tags":["Freight"],"operationId":"denyFreightJson","summary":"Відкликати заявку (JSON)","description":"Метод **deny** працює в моделі **Freight** (або **FreightGeneral**) і дозволяє відкликати подану заявку.\n","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DenyFreightJsonRequest"}}}},"responses":{"200":{"description":"Успішна відповідь (JSON)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DenyFreightJsonResponse"}}}}}}}},"components":{"schemas":{"DenyFreightJsonRequest":{"type":"object","additionalProperties":false,"required":["apiKey","modelName","calledMethod","methodProperties"],"properties":{"apiKey":{"type":"string","description":"API-ключ користувача"},"modelName":{"type":"string","enum":["FreightGeneral","Freight"],"description":"Назва моделі API"},"calledMethod":{"type":"string","enum":["deny"],"description":"Назва методу API"},"methodProperties":{"$ref":"#/components/schemas/DenyFreightMethodProperties"}}},"DenyFreightMethodProperties":{"type":"object","additionalProperties":false,"required":["DenyReason","Number","Ref"],"properties":{"DenyReason":{"type":"string","maxLength":36,"description":"Причина відкликання"},"Number":{"type":"string","maxLength":36,"description":"Номер заявки (передається або номер, або ідентифікатор)"},"Ref":{"type":"string","maxLength":36,"description":"Ідентифікатор заявки (передається або номер, або ідентифікатор)"}}},"DenyFreightJsonResponse":{"type":"object","additionalProperties":false,"required":["success","data","errors","warnings","info","messageCodes","errorCodes","warningCodes","infoCodes"],"properties":{"success":{"type":"boolean","description":"Прапор успішності виконання запиту"},"data":{"type":"array","description":"Масив даних відкликаної заявки","items":{"$ref":"#/components/schemas/DenyFreightItem"}},"errors":{"type":"array","description":"Масив повідомлень про помилки","items":{"type":"string"}},"warnings":{"type":"array","description":"Масив попереджень","items":{"type":"string"}},"info":{"type":"array","description":"Масив інформаційних повідомлень","items":{"type":"string"}},"messageCodes":{"type":"array","description":"Масив кодів інформаційних повідомлень","items":{"type":"string"}},"errorCodes":{"type":"array","description":"Масив кодів помилок","items":{"type":"string"}},"warningCodes":{"type":"array","description":"Масив кодів попереджень","items":{"type":"string"}},"infoCodes":{"type":"array","description":"Масив кодів додаткової інформації","items":{"type":"string"}}}},"DenyFreightItem":{"type":"object","additionalProperties":false,"properties":{"Ref":{"type":"string","maxLength":36,"description":"Ідентифікатор заявки"},"Number":{"type":"string","maxLength":36,"description":"Номер заявки"}}}}}}
```
## Відкликати заявку (XML)
> Метод \*\*deny\*\* працює в моделі \*\*Freight\*\* (або \*\*FreightGeneral\*\*) і дозволяє відкликати подану заявку.
```json
{"openapi":"3.0.3","info":{"title":"API Nova Post — Freight","version":"2.0.0"},"tags":[{"name":"Freight","description":"Операції, пов'язані із заявками на фрахт"}],"servers":[{"url":"https://api.novaposhta.ua/v2.0/","description":"production"}],"paths":{"/xml/":{"post":{"tags":["Freight"],"operationId":"denyFreightXml","summary":"Відкликати заявку (XML)","description":"Метод **deny** працює в моделі **Freight** (або **FreightGeneral**) і дозволяє відкликати подану заявку.\n","requestBody":{"required":true,"content":{"application/xml":{"schema":{"$ref":"#/components/schemas/DenyFreightXmlRequest"}}}},"responses":{"200":{"description":"Успішна відповідь (XML)","content":{"application/xml":{"schema":{"$ref":"#/components/schemas/DenyFreightXmlResponse"}}}}}}}},"components":{"schemas":{"DenyFreightXmlRequest":{"type":"object","additionalProperties":false,"xml":{"name":"file"},"required":["apiKey","modelName","calledMethod","methodProperties"],"properties":{"apiKey":{"type":"string","description":"API-ключ користувача"},"modelName":{"type":"string","enum":["FreightGeneral","Freight"],"description":"Назва моделі API"},"calledMethod":{"type":"string","enum":["deny"],"description":"Назва методу API"},"methodProperties":{"$ref":"#/components/schemas/DenyFreightXmlMethodProperties"}}},"DenyFreightXmlMethodProperties":{"allOf":[{"$ref":"#/components/schemas/DenyFreightMethodProperties"}],"xml":{"name":"methodProperties"}},"DenyFreightMethodProperties":{"type":"object","additionalProperties":false,"required":["DenyReason","Number","Ref"],"properties":{"DenyReason":{"type":"string","maxLength":36,"description":"Причина відкликання"},"Number":{"type":"string","maxLength":36,"description":"Номер заявки (передається або номер, або ідентифікатор)"},"Ref":{"type":"string","maxLength":36,"description":"Ідентифікатор заявки (передається або номер, або ідентифікатор)"}}},"DenyFreightXmlResponse":{"type":"object","additionalProperties":false,"xml":{"name":"root"},"required":["success","data","errors","warnings","info","messageCodes","errorCodes","warningCodes","infoCodes"],"properties":{"success":{"type":"boolean","description":"Прапор успішності виконання запиту"},"data":{"type":"array","description":"Масив даних відкликаної заявки","xml":{"name":"data","wrapped":true},"items":{"$ref":"#/components/schemas/DenyFreightXmlItem"}},"errors":{"type":"array","description":"Масив повідомлень про помилки","xml":{"name":"errors","wrapped":true},"items":{"type":"string","xml":{"name":"item"}}},"warnings":{"type":"array","description":"Масив попереджень","xml":{"name":"warnings","wrapped":true},"items":{"type":"string","xml":{"name":"item"}}},"info":{"type":"array","description":"Масив інформаційних повідомлень","xml":{"name":"info","wrapped":true},"items":{"type":"string","xml":{"name":"item"}}},"messageCodes":{"type":"array","description":"Масив кодів інформаційних повідомлень","xml":{"name":"messageCodes","wrapped":true},"items":{"type":"string","xml":{"name":"item"}}},"errorCodes":{"type":"array","description":"Масив кодів помилок","xml":{"name":"errorCodes","wrapped":true},"items":{"type":"string","xml":{"name":"item"}}},"warningCodes":{"type":"array","description":"Масив кодів попереджень","xml":{"name":"warningCodes","wrapped":true},"items":{"type":"string","xml":{"name":"item"}}},"infoCodes":{"type":"array","description":"Масив кодів додаткової інформації","xml":{"name":"infoCodes","wrapped":true},"items":{"type":"string","xml":{"name":"item"}}}}},"DenyFreightXmlItem":{"allOf":[{"$ref":"#/components/schemas/DenyFreightItem"}],"xml":{"name":"item"}},"DenyFreightItem":{"type":"object","additionalProperties":false,"properties":{"Ref":{"type":"string","maxLength":36,"description":"Ідентифікатор заявки"},"Number":{"type":"string","maxLength":36,"description":"Номер заявки"}}}}}}
```
## Отримати перелік заявок (JSON)
> Метод \*\*getFreight\*\* працює в моделі \*\*Freight\*\* (або \*\*FreightGeneral\*\*) і дозволяє отримати перелік заявок із фільтрацією за ідентифікатором (REF) заявки та ознакою видалення.
```json
{"openapi":"3.0.3","info":{"title":"API Nova Post — Freight","version":"2.0.0"},"tags":[{"name":"Freight","description":"Операції, пов'язані із заявками на фрахт"}],"servers":[{"url":"https://api.novaposhta.ua/v2.0/","description":"production"}],"paths":{"/json/":{"post":{"tags":["Freight"],"operationId":"getFreightJson","summary":"Отримати перелік заявок (JSON)","description":"Метод **getFreight** працює в моделі **Freight** (або **FreightGeneral**) і дозволяє отримати перелік заявок із фільтрацією за ідентифікатором (REF) заявки та ознакою видалення.\n","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetFreightJsonRequest"}}}},"responses":{"200":{"description":"Успішна відповідь (JSON)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetFreightJsonResponse"}}}}}}}},"components":{"schemas":{"GetFreightJsonRequest":{"type":"object","additionalProperties":false,"required":["apiKey","modelName","calledMethod","methodProperties"],"properties":{"apiKey":{"type":"string","description":"API-ключ користувача"},"modelName":{"type":"string","enum":["FreightGeneral","Freight"],"description":"Назва моделі API"},"calledMethod":{"type":"string","enum":["getFreight"],"description":"Назва методу API"},"methodProperties":{"$ref":"#/components/schemas/GetFreightMethodProperties"}}},"GetFreightMethodProperties":{"type":"object","additionalProperties":false,"properties":{"Ref":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) заявки"},"ShowDeleted":{"type":"string","maxLength":36,"description":"Показати видалену заявку"}}},"GetFreightJsonResponse":{"type":"object","additionalProperties":false,"required":["success","data","errors","warnings","info","messageCodes","errorCodes","warningCodes","infoCodes"],"properties":{"success":{"type":"boolean","description":"Прапор успішності виконання запиту"},"data":{"type":"array","description":"Перелік заявок","items":{"$ref":"#/components/schemas/GetFreightItem"}},"errors":{"type":"array","description":"Масив повідомлень про помилки","items":{"type":"string"}},"warnings":{"type":"array","description":"Масив попереджень","items":{"type":"string"}},"info":{"type":"array","description":"Масив інформаційних повідомлень","items":{"type":"string"}},"messageCodes":{"type":"array","description":"Масив кодів інформаційних повідомлень","items":{"type":"string"}},"errorCodes":{"type":"array","description":"Масив кодів помилок","items":{"type":"string"}},"warningCodes":{"type":"array","description":"Масив кодів попереджень","items":{"type":"string"}},"infoCodes":{"type":"array","description":"Масив кодів додаткової інформації","items":{"type":"string"}}}},"GetFreightItem":{"type":"object","description":"Перелік заявок"}}}}
```
## Отримати перелік заявок (XML)
> Метод \*\*getFreight\*\* працює в моделі \*\*Freight\*\* (або \*\*FreightGeneral\*\*) і дозволяє отримати перелік заявок із фільтрацією за ідентифікатором (REF) заявки та ознакою видалення.
```json
{"openapi":"3.0.3","info":{"title":"API Nova Post — Freight","version":"2.0.0"},"tags":[{"name":"Freight","description":"Операції, пов'язані із заявками на фрахт"}],"servers":[{"url":"https://api.novaposhta.ua/v2.0/","description":"production"}],"paths":{"/xml/":{"post":{"tags":["Freight"],"operationId":"getFreightXml","summary":"Отримати перелік заявок (XML)","description":"Метод **getFreight** працює в моделі **Freight** (або **FreightGeneral**) і дозволяє отримати перелік заявок із фільтрацією за ідентифікатором (REF) заявки та ознакою видалення.\n","requestBody":{"required":true,"content":{"application/xml":{"schema":{"$ref":"#/components/schemas/GetFreightXmlRequest"}}}},"responses":{"200":{"description":"Успішна відповідь (XML)","content":{"application/xml":{"schema":{"$ref":"#/components/schemas/GetFreightXmlResponse"}}}}}}}},"components":{"schemas":{"GetFreightXmlRequest":{"type":"object","additionalProperties":false,"xml":{"name":"file"},"required":["apiKey","modelName","calledMethod","methodProperties"],"properties":{"apiKey":{"type":"string","description":"API-ключ користувача"},"modelName":{"type":"string","enum":["FreightGeneral","Freight"],"description":"Назва моделі API"},"calledMethod":{"type":"string","enum":["getFreight"],"description":"Назва методу API"},"methodProperties":{"$ref":"#/components/schemas/GetFreightXmlMethodProperties"}}},"GetFreightXmlMethodProperties":{"allOf":[{"$ref":"#/components/schemas/GetFreightMethodProperties"}],"xml":{"name":"methodProperties"}},"GetFreightMethodProperties":{"type":"object","additionalProperties":false,"properties":{"Ref":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) заявки"},"ShowDeleted":{"type":"string","maxLength":36,"description":"Показати видалену заявку"}}},"GetFreightXmlResponse":{"type":"object","additionalProperties":false,"xml":{"name":"root"},"required":["success","data","errors","warnings","info","messageCodes","errorCodes","warningCodes","infoCodes"],"properties":{"success":{"type":"boolean","description":"Прапор успішності виконання запиту"},"data":{"type":"array","description":"Перелік заявок","xml":{"name":"data","wrapped":true},"items":{"$ref":"#/components/schemas/GetFreightXmlItem"}},"errors":{"type":"array","description":"Масив повідомлень про помилки","xml":{"name":"errors","wrapped":true},"items":{"type":"string","xml":{"name":"item"}}},"warnings":{"type":"array","description":"Масив попереджень","xml":{"name":"warnings","wrapped":true},"items":{"type":"string","xml":{"name":"item"}}},"info":{"type":"array","description":"Масив інформаційних повідомлень","xml":{"name":"info","wrapped":true},"items":{"type":"string","xml":{"name":"item"}}},"messageCodes":{"type":"array","description":"Масив кодів інформаційних повідомлень","xml":{"name":"messageCodes","wrapped":true},"items":{"type":"string","xml":{"name":"item"}}},"errorCodes":{"type":"array","description":"Масив кодів помилок","xml":{"name":"errorCodes","wrapped":true},"items":{"type":"string","xml":{"name":"item"}}},"warningCodes":{"type":"array","description":"Масив кодів попереджень","xml":{"name":"warningCodes","wrapped":true},"items":{"type":"string","xml":{"name":"item"}}},"infoCodes":{"type":"array","description":"Масив кодів додаткової інформації","xml":{"name":"infoCodes","wrapped":true},"items":{"type":"string","xml":{"name":"item"}}}}},"GetFreightXmlItem":{"allOf":[{"$ref":"#/components/schemas/GetFreightItem"}],"xml":{"name":"item"}},"GetFreightItem":{"type":"object","description":"Перелік заявок"}}}}
```
## Створити заявку на фрахт (JSON)
> Метод \*\*save\*\* працює в моделі \*\*Freight\*\* (або \*\*FreightGeneral\*\*) і дозволяє створити заявку на перевезення великої кількості вантажу.
```json
{"openapi":"3.0.3","info":{"title":"API Nova Post — Freight","version":"2.0.0"},"tags":[{"name":"Freight","description":"Операції, пов'язані із заявками на фрахт"}],"servers":[{"url":"https://api.novaposhta.ua/v2.0/","description":"production"}],"paths":{"/json/":{"post":{"tags":["Freight"],"operationId":"saveFreightJson","summary":"Створити заявку на фрахт (JSON)","description":"Метод **save** працює в моделі **Freight** (або **FreightGeneral**) і дозволяє створити заявку на перевезення великої кількості вантажу.\n","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SaveFreightJsonRequest"}}}},"responses":{"200":{"description":"Успішна відповідь (JSON)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SaveFreightJsonResponse"}}}}}}}},"components":{"schemas":{"SaveFreightJsonRequest":{"type":"object","additionalProperties":false,"required":["apiKey","modelName","calledMethod","methodProperties"],"properties":{"apiKey":{"type":"string","description":"API-ключ користувача"},"modelName":{"type":"string","enum":["FreightGeneral","Freight"],"description":"Назва моделі API"},"calledMethod":{"type":"string","enum":["save"],"description":"Назва методу API"},"methodProperties":{"$ref":"#/components/schemas/SaveFreightMethodProperties"}}},"SaveFreightMethodProperties":{"type":"object","additionalProperties":false,"required":["Customer","CustomerContactName","CustomerPhone","CustomerEMail","SenderSettlement","SenderAddressString","SenderString","SenderName","SenderPhone","SenderEMail","DateTimeVehicleFiling","DateTimeVehicleDeparture","RecipientSettlement","RecipientAddressString","RecipientString","RecipientName","RecipientPhone","RecipientEMail","DateTimeVehicleArrival","DateTimeVehicleUnloading","CargoDescriptionString","DeclaredCost","Cost","Weight","Volume","SemiTrailerType"],"properties":{"Ref":{"type":"string","maxLength":36,"description":"Ідентифікатор заявки"},"Customer":{"type":"string","maxLength":36,"description":"Ідентифікатор замовника послуги"},"CustomerContactName":{"type":"string","maxLength":36,"description":"Контактна особа замовника"},"CustomerPhone":{"type":"string","maxLength":36,"description":"Номер телефону замовника"},"CustomerEMail":{"type":"string","maxLength":36,"description":"Електронна скринька замовника"},"SenderSettlement":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) міста відправника із довідника getSettlements"},"SenderAddressString":{"type":"string","maxLength":36,"description":"Адреса відправника (зазначається рядком)"},"SenderString":{"type":"string","maxLength":50,"description":"Відправник"},"SenderName":{"type":"string","maxLength":50,"description":"Контактна особа відправника"},"SenderPhone":{"type":"string","maxLength":36,"description":"Номер телефону відправника"},"SenderEMail":{"type":"string","maxLength":36,"description":"Електронна скринька відправника"},"DateTimeVehicleFiling":{"type":"string","maxLength":36,"description":"Дата та час подачі авто на завантаження"},"DateTimeVehicleDeparture":{"type":"string","maxLength":36,"description":"Дата та час виїзду авто в рейс після завантаження"},"RecipientSettlement":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) міста отримувача із довідника getSettlements"},"RecipientAddressString":{"type":"string","maxLength":50,"description":"Адреса отримувача (зазначається рядком)"},"RecipientString":{"type":"string","maxLength":36,"description":"Отримувач"},"RecipientName":{"type":"string","maxLength":50,"description":"Контактна особа отримувача"},"RecipientPhone":{"type":"string","maxLength":36,"description":"Номер телефону отримувача"},"RecipientEMail":{"type":"string","maxLength":36,"description":"Електронна скринька отримувача"},"DateTimeVehicleArrival":{"type":"string","maxLength":36,"description":"Дата і час прибуття авто"},"DateTimeVehicleUnloading":{"type":"string","maxLength":36,"description":"Дата та час вивантаження авто одержувачем"},"IntermediateStoppingPoints":{"type":"array","description":"Проміжні точки зупинки","items":{"type":"object"}},"CargoDescriptionString":{"type":"string","maxLength":50,"description":"Опис вантажу"},"DeclaredCost":{"type":"string","maxLength":36,"description":"Заявлена вартість послуг"},"Cost":{"type":"string","maxLength":36,"description":"Оголошена вартість"},"Weight":{"type":"string","maxLength":36,"description":"Вага в кг"},"Length":{"type":"string","maxLength":36,"description":"Довжина"},"Width":{"type":"string","maxLength":36,"description":"Ширина"},"Height":{"type":"string","maxLength":36,"description":"Висота"},"Volume":{"type":"string","maxLength":36,"description":"Об'єм в метрах кубічних"},"SemiTrailerType":{"type":"string","maxLength":36,"description":"Вид транспортного засобу"},"AdditionalInformation":{"type":"string","maxLength":250,"description":"Додаткова інформація"}}},"SaveFreightJsonResponse":{"type":"object","additionalProperties":false,"required":["success","data","errors","warnings","info","messageCodes","errorCodes","warningCodes","infoCodes"],"properties":{"success":{"type":"boolean","description":"Прапор успішності виконання запиту"},"data":{"type":"array","description":"Результат створення заявки","items":{"$ref":"#/components/schemas/SaveFreightItem"}},"errors":{"type":"array","description":"Масив повідомлень про помилки","items":{"type":"string"}},"warnings":{"type":"array","description":"Масив попереджень","items":{"type":"string"}},"info":{"type":"array","description":"Масив інформаційних повідомлень","items":{"type":"string"}},"messageCodes":{"type":"array","description":"Масив кодів інформаційних повідомлень","items":{"type":"string"}},"errorCodes":{"type":"array","description":"Масив кодів помилок","items":{"type":"string"}},"warningCodes":{"type":"array","description":"Масив кодів попереджень","items":{"type":"string"}},"infoCodes":{"type":"array","description":"Масив кодів додаткової інформації","items":{"type":"string"}}}},"SaveFreightItem":{"type":"object","properties":{"Ref":{"type":"string","maxLength":36,"description":"Ідентифікатор заявки"},"Number":{"type":"string","maxLength":36,"description":"Номер заявки"}}}}}}
```
## Створити заявку на фрахт (XML)
> Метод \*\*save\*\* працює в моделі \*\*Freight\*\* (або \*\*FreightGeneral\*\*) і дозволяє створити заявку на перевезення великої кількості вантажу.
```json
{"openapi":"3.0.3","info":{"title":"API Nova Post — Freight","version":"2.0.0"},"tags":[{"name":"Freight","description":"Операції, пов'язані із заявками на фрахт"}],"servers":[{"url":"https://api.novaposhta.ua/v2.0/","description":"production"}],"paths":{"/xml/":{"post":{"tags":["Freight"],"operationId":"saveFreightXml","summary":"Створити заявку на фрахт (XML)","description":"Метод **save** працює в моделі **Freight** (або **FreightGeneral**) і дозволяє створити заявку на перевезення великої кількості вантажу.\n","requestBody":{"required":true,"content":{"application/xml":{"schema":{"$ref":"#/components/schemas/SaveFreightXmlRequest"}}}},"responses":{"200":{"description":"Успішна відповідь (XML)","content":{"application/xml":{"schema":{"$ref":"#/components/schemas/SaveFreightXmlResponse"}}}}}}}},"components":{"schemas":{"SaveFreightXmlRequest":{"type":"object","additionalProperties":false,"xml":{"name":"file"},"required":["apiKey","modelName","calledMethod","methodProperties"],"properties":{"apiKey":{"type":"string","description":"API-ключ користувача"},"modelName":{"type":"string","enum":["FreightGeneral","Freight"],"description":"Назва моделі API"},"calledMethod":{"type":"string","enum":["save"],"description":"Назва методу API"},"methodProperties":{"$ref":"#/components/schemas/SaveFreightXmlMethodProperties"}}},"SaveFreightXmlMethodProperties":{"allOf":[{"$ref":"#/components/schemas/SaveFreightMethodProperties"}],"properties":{"IntermediateStoppingPoints":{"type":"array","description":"Проміжні точки зупинки","xml":{"name":"IntermediateStoppingPoints","wrapped":true},"items":{"type":"object","xml":{"name":"item"}}}},"xml":{"name":"methodProperties"}},"SaveFreightMethodProperties":{"type":"object","additionalProperties":false,"required":["Customer","CustomerContactName","CustomerPhone","CustomerEMail","SenderSettlement","SenderAddressString","SenderString","SenderName","SenderPhone","SenderEMail","DateTimeVehicleFiling","DateTimeVehicleDeparture","RecipientSettlement","RecipientAddressString","RecipientString","RecipientName","RecipientPhone","RecipientEMail","DateTimeVehicleArrival","DateTimeVehicleUnloading","CargoDescriptionString","DeclaredCost","Cost","Weight","Volume","SemiTrailerType"],"properties":{"Ref":{"type":"string","maxLength":36,"description":"Ідентифікатор заявки"},"Customer":{"type":"string","maxLength":36,"description":"Ідентифікатор замовника послуги"},"CustomerContactName":{"type":"string","maxLength":36,"description":"Контактна особа замовника"},"CustomerPhone":{"type":"string","maxLength":36,"description":"Номер телефону замовника"},"CustomerEMail":{"type":"string","maxLength":36,"description":"Електронна скринька замовника"},"SenderSettlement":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) міста відправника із довідника getSettlements"},"SenderAddressString":{"type":"string","maxLength":36,"description":"Адреса відправника (зазначається рядком)"},"SenderString":{"type":"string","maxLength":50,"description":"Відправник"},"SenderName":{"type":"string","maxLength":50,"description":"Контактна особа відправника"},"SenderPhone":{"type":"string","maxLength":36,"description":"Номер телефону відправника"},"SenderEMail":{"type":"string","maxLength":36,"description":"Електронна скринька відправника"},"DateTimeVehicleFiling":{"type":"string","maxLength":36,"description":"Дата та час подачі авто на завантаження"},"DateTimeVehicleDeparture":{"type":"string","maxLength":36,"description":"Дата та час виїзду авто в рейс після завантаження"},"RecipientSettlement":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) міста отримувача із довідника getSettlements"},"RecipientAddressString":{"type":"string","maxLength":50,"description":"Адреса отримувача (зазначається рядком)"},"RecipientString":{"type":"string","maxLength":36,"description":"Отримувач"},"RecipientName":{"type":"string","maxLength":50,"description":"Контактна особа отримувача"},"RecipientPhone":{"type":"string","maxLength":36,"description":"Номер телефону отримувача"},"RecipientEMail":{"type":"string","maxLength":36,"description":"Електронна скринька отримувача"},"DateTimeVehicleArrival":{"type":"string","maxLength":36,"description":"Дата і час прибуття авто"},"DateTimeVehicleUnloading":{"type":"string","maxLength":36,"description":"Дата та час вивантаження авто одержувачем"},"IntermediateStoppingPoints":{"type":"array","description":"Проміжні точки зупинки","items":{"type":"object"}},"CargoDescriptionString":{"type":"string","maxLength":50,"description":"Опис вантажу"},"DeclaredCost":{"type":"string","maxLength":36,"description":"Заявлена вартість послуг"},"Cost":{"type":"string","maxLength":36,"description":"Оголошена вартість"},"Weight":{"type":"string","maxLength":36,"description":"Вага в кг"},"Length":{"type":"string","maxLength":36,"description":"Довжина"},"Width":{"type":"string","maxLength":36,"description":"Ширина"},"Height":{"type":"string","maxLength":36,"description":"Висота"},"Volume":{"type":"string","maxLength":36,"description":"Об'єм в метрах кубічних"},"SemiTrailerType":{"type":"string","maxLength":36,"description":"Вид транспортного засобу"},"AdditionalInformation":{"type":"string","maxLength":250,"description":"Додаткова інформація"}}},"SaveFreightXmlResponse":{"type":"object","additionalProperties":false,"xml":{"name":"root"},"required":["success","data","errors","warnings","info","messageCodes","errorCodes","warningCodes","infoCodes"],"properties":{"success":{"type":"boolean","description":"Прапор успішності виконання запиту"},"data":{"type":"array","description":"Результат створення заявки","xml":{"name":"data","wrapped":true},"items":{"$ref":"#/components/schemas/SaveFreightXmlItem"}},"errors":{"type":"array","description":"Масив повідомлень про помилки","xml":{"name":"errors","wrapped":true},"items":{"type":"string","xml":{"name":"item"}}},"warnings":{"type":"array","description":"Масив попереджень","xml":{"name":"warnings","wrapped":true},"items":{"type":"string","xml":{"name":"item"}}},"info":{"type":"array","description":"Масив інформаційних повідомлень","xml":{"name":"info","wrapped":true},"items":{"type":"string","xml":{"name":"item"}}},"messageCodes":{"type":"array","description":"Масив кодів інформаційних повідомлень","xml":{"name":"messageCodes","wrapped":true},"items":{"type":"string","xml":{"name":"item"}}},"errorCodes":{"type":"array","description":"Масив кодів помилок","xml":{"name":"errorCodes","wrapped":true},"items":{"type":"string","xml":{"name":"item"}}},"warningCodes":{"type":"array","description":"Масив кодів попереджень","xml":{"name":"warningCodes","wrapped":true},"items":{"type":"string","xml":{"name":"item"}}},"infoCodes":{"type":"array","description":"Масив кодів додаткової інформації","xml":{"name":"infoCodes","wrapped":true},"items":{"type":"string","xml":{"name":"item"}}}}},"SaveFreightXmlItem":{"allOf":[{"$ref":"#/components/schemas/SaveFreightItem"}],"xml":{"name":"item"}},"SaveFreightItem":{"type":"object","properties":{"Ref":{"type":"string","maxLength":36,"description":"Ідентифікатор заявки"},"Number":{"type":"string","maxLength":36,"description":"Номер заявки"}}}}}}
```
## Оновити заявку на фрахт (JSON)
> Метод \*\*update\*\* працює в моделі \*\*Freight\*\* (або \*\*FreightGeneral\*\*) і дозволяє оновити інформацію за створеною заявкою на перевезення великої кількості вантажу.
```json
{"openapi":"3.0.3","info":{"title":"API Nova Post — Freight (Update)","version":"2.0.0"},"tags":[{"name":"Freight","description":"Операції, пов'язані із заявками на фрахт"}],"servers":[{"url":"https://api.novaposhta.ua/v2.0/","description":"production"}],"paths":{"/json/":{"post":{"tags":["Freight"],"operationId":"updateFreightJson","summary":"Оновити заявку на фрахт (JSON)","description":"Метод **update** працює в моделі **Freight** (або **FreightGeneral**) і дозволяє оновити інформацію за створеною заявкою на перевезення великої кількості вантажу.\n","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateFreightJsonRequest"}}}},"responses":{"200":{"description":"Успішна відповідь (JSON)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateFreightJsonResponse"}}}}}}}},"components":{"schemas":{"UpdateFreightJsonRequest":{"type":"object","additionalProperties":false,"required":["apiKey","modelName","calledMethod","methodProperties"],"properties":{"apiKey":{"type":"string","description":"API-ключ користувача"},"modelName":{"type":"string","enum":["FreightGeneral","Freight"],"description":"Назва моделі API"},"calledMethod":{"type":"string","enum":["update"],"description":"Назва методу API"},"methodProperties":{"$ref":"#/components/schemas/UpdateFreightMethodProperties"}}},"UpdateFreightMethodProperties":{"type":"object","additionalProperties":false,"required":["Ref","Customer","CustomerContactName","CustomerPhone","CustomerEMail","SenderSettlement","SenderAddressString","SenderString","SenderName","SenderPhone","SenderEMail","DateTimeVehicleFiling","DateTimeVehicleDeparture","RecipientSettlement","RecipientAddressString","RecipientString","RecipientName","RecipientPhone","RecipientEMail","DateTimeVehicleArrival","DateTimeVehicleUnloading","CargoDescriptionString","DeclaredCost","Cost","Weight","Volume","SemiTrailerType"],"properties":{"Ref":{"type":"string","maxLength":36,"description":"Ідентифікатор заявки"},"Customer":{"type":"string","maxLength":36,"description":"Ідентифікатор замовника послуги"},"CustomerContactName":{"type":"string","maxLength":36,"description":"Контактна особа замовника"},"CustomerPhone":{"type":"string","maxLength":36,"description":"Номер телефону замовника"},"CustomerEMail":{"type":"string","maxLength":36,"description":"Електронна скринька замовника"},"SenderSettlement":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) міста відправника із довідника getSettlements"},"SenderAddressString":{"type":"string","maxLength":36,"description":"Адреса відправника (зазначається рядком)"},"SenderString":{"type":"string","maxLength":36,"description":"Відправник"},"SenderName":{"type":"string","maxLength":50,"description":"Контактна особа відправника"},"SenderPhone":{"type":"string","maxLength":36,"description":"Номер телефону відправника"},"SenderEMail":{"type":"string","maxLength":36,"description":"Електронна скринька відправника"},"DateTimeVehicleFiling":{"type":"string","maxLength":36,"description":"Дата та час подачі авто на завантаження"},"DateTimeVehicleDeparture":{"type":"string","maxLength":36,"description":"Дата та час виїзду авто в рейс після завантаження"},"RecipientSettlement":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) міста отримувача із довідника getSettlements"},"RecipientAddressString":{"type":"string","maxLength":50,"description":"Адреса отримувача (зазначається рядком)"},"RecipientString":{"type":"string","maxLength":36,"description":"Отримувач"},"RecipientName":{"type":"string","maxLength":50,"description":"Контактна особа отримувача"},"RecipientPhone":{"type":"string","maxLength":36,"description":"Номер телефону отримувача"},"RecipientEMail":{"type":"string","maxLength":36,"description":"Електронна скринька отримувача"},"DateTimeVehicleArrival":{"type":"string","maxLength":36,"description":"Дата і час прибуття авто"},"DateTimeVehicleUnloading":{"type":"string","maxLength":36,"description":"Дата та час вивантаження авто одержувачем"},"IntermediateStoppingPoints":{"type":"array","description":"Проміжні точки зупинки","items":{"type":"object"}},"CargoDescriptionString":{"type":"string","maxLength":36,"description":"Опис вантажу"},"DeclaredCost":{"type":"string","maxLength":36,"description":"Заявлена вартість послуг"},"Cost":{"type":"string","maxLength":36,"description":"Оголошена вартість"},"Weight":{"type":"string","maxLength":36,"description":"Вага в кг"},"Length":{"type":"string","maxLength":36,"description":"Довжина"},"Width":{"type":"string","maxLength":36,"description":"Ширина"},"Height":{"type":"string","maxLength":36,"description":"Висота"},"Volume":{"type":"string","maxLength":36,"description":"Об'єм в метрах кубічних"},"SemiTrailerType":{"type":"string","maxLength":36,"description":"Вид транспортного засобу"},"AdditionalInformation":{"type":"string","maxLength":250,"description":"Додаткова інформація"}}},"UpdateFreightJsonResponse":{"type":"object","additionalProperties":false,"required":["success","data","errors","warnings","info","messageCodes","errorCodes","warningCodes","infoCodes"],"properties":{"success":{"type":"boolean","description":"Прапор успішності виконання запиту"},"data":{"type":"array","description":"Результат оновлення заявки","items":{"$ref":"#/components/schemas/UpdateFreightItem"}},"errors":{"type":"array","description":"Масив повідомлень про помилки","items":{"type":"string"}},"warnings":{"type":"array","description":"Масив попереджень","items":{"type":"string"}},"info":{"type":"array","description":"Масив інформаційних повідомлень","items":{"type":"string"}},"messageCodes":{"type":"array","description":"Масив кодів інформаційних повідомлень","items":{"type":"string"}},"errorCodes":{"type":"array","description":"Масив кодів помилок","items":{"type":"string"}},"warningCodes":{"type":"array","description":"Масив кодів попереджень","items":{"type":"string"}},"infoCodes":{"type":"array","description":"Масив кодів додаткової інформації","items":{"type":"string"}}}},"UpdateFreightItem":{"type":"object","properties":{"Ref":{"type":"string","maxLength":36,"description":"Ідентифікатор заявки"},"Number":{"type":"string","maxLength":36,"description":"Номер заявки"}}}}}}
```
## Оновити заявку на фрахт (XML)
> Метод \*\*update\*\* працює в моделі \*\*Freight\*\* (або \*\*FreightGeneral\*\*) і дозволяє оновити інформацію за створеною заявкою на перевезення великої кількості вантажу.
```json
{"openapi":"3.0.3","info":{"title":"API Nova Post — Freight (Update)","version":"2.0.0"},"tags":[{"name":"Freight","description":"Операції, пов'язані із заявками на фрахт"}],"servers":[{"url":"https://api.novaposhta.ua/v2.0/","description":"production"}],"paths":{"/xml/":{"post":{"tags":["Freight"],"operationId":"updateFreightXml","summary":"Оновити заявку на фрахт (XML)","description":"Метод **update** працює в моделі **Freight** (або **FreightGeneral**) і дозволяє оновити інформацію за створеною заявкою на перевезення великої кількості вантажу.\n","requestBody":{"required":true,"content":{"application/xml":{"schema":{"$ref":"#/components/schemas/UpdateFreightXmlRequest"}}}},"responses":{"200":{"description":"Успішна відповідь (XML)","content":{"application/xml":{"schema":{"$ref":"#/components/schemas/UpdateFreightXmlResponse"}}}}}}}},"components":{"schemas":{"UpdateFreightXmlRequest":{"type":"object","additionalProperties":false,"xml":{"name":"file"},"required":["apiKey","modelName","calledMethod","methodProperties"],"properties":{"apiKey":{"type":"string","description":"API-ключ користувача"},"modelName":{"type":"string","enum":["FreightGeneral","Freight"],"description":"Назва моделі API"},"calledMethod":{"type":"string","enum":["update"],"description":"Назва методу API"},"methodProperties":{"$ref":"#/components/schemas/UpdateFreightXmlMethodProperties"}}},"UpdateFreightXmlMethodProperties":{"allOf":[{"$ref":"#/components/schemas/UpdateFreightMethodProperties"}],"properties":{"IntermediateStoppingPoints":{"type":"array","description":"Проміжні точки зупинки","xml":{"name":"IntermediateStoppingPoints","wrapped":true},"items":{"type":"object","xml":{"name":"item"}}}},"xml":{"name":"methodProperties"}},"UpdateFreightMethodProperties":{"type":"object","additionalProperties":false,"required":["Ref","Customer","CustomerContactName","CustomerPhone","CustomerEMail","SenderSettlement","SenderAddressString","SenderString","SenderName","SenderPhone","SenderEMail","DateTimeVehicleFiling","DateTimeVehicleDeparture","RecipientSettlement","RecipientAddressString","RecipientString","RecipientName","RecipientPhone","RecipientEMail","DateTimeVehicleArrival","DateTimeVehicleUnloading","CargoDescriptionString","DeclaredCost","Cost","Weight","Volume","SemiTrailerType"],"properties":{"Ref":{"type":"string","maxLength":36,"description":"Ідентифікатор заявки"},"Customer":{"type":"string","maxLength":36,"description":"Ідентифікатор замовника послуги"},"CustomerContactName":{"type":"string","maxLength":36,"description":"Контактна особа замовника"},"CustomerPhone":{"type":"string","maxLength":36,"description":"Номер телефону замовника"},"CustomerEMail":{"type":"string","maxLength":36,"description":"Електронна скринька замовника"},"SenderSettlement":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) міста відправника із довідника getSettlements"},"SenderAddressString":{"type":"string","maxLength":36,"description":"Адреса відправника (зазначається рядком)"},"SenderString":{"type":"string","maxLength":36,"description":"Відправник"},"SenderName":{"type":"string","maxLength":50,"description":"Контактна особа відправника"},"SenderPhone":{"type":"string","maxLength":36,"description":"Номер телефону відправника"},"SenderEMail":{"type":"string","maxLength":36,"description":"Електронна скринька відправника"},"DateTimeVehicleFiling":{"type":"string","maxLength":36,"description":"Дата та час подачі авто на завантаження"},"DateTimeVehicleDeparture":{"type":"string","maxLength":36,"description":"Дата та час виїзду авто в рейс після завантаження"},"RecipientSettlement":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) міста отримувача із довідника getSettlements"},"RecipientAddressString":{"type":"string","maxLength":50,"description":"Адреса отримувача (зазначається рядком)"},"RecipientString":{"type":"string","maxLength":36,"description":"Отримувач"},"RecipientName":{"type":"string","maxLength":50,"description":"Контактна особа отримувача"},"RecipientPhone":{"type":"string","maxLength":36,"description":"Номер телефону отримувача"},"RecipientEMail":{"type":"string","maxLength":36,"description":"Електронна скринька отримувача"},"DateTimeVehicleArrival":{"type":"string","maxLength":36,"description":"Дата і час прибуття авто"},"DateTimeVehicleUnloading":{"type":"string","maxLength":36,"description":"Дата та час вивантаження авто одержувачем"},"IntermediateStoppingPoints":{"type":"array","description":"Проміжні точки зупинки","items":{"type":"object"}},"CargoDescriptionString":{"type":"string","maxLength":36,"description":"Опис вантажу"},"DeclaredCost":{"type":"string","maxLength":36,"description":"Заявлена вартість послуг"},"Cost":{"type":"string","maxLength":36,"description":"Оголошена вартість"},"Weight":{"type":"string","maxLength":36,"description":"Вага в кг"},"Length":{"type":"string","maxLength":36,"description":"Довжина"},"Width":{"type":"string","maxLength":36,"description":"Ширина"},"Height":{"type":"string","maxLength":36,"description":"Висота"},"Volume":{"type":"string","maxLength":36,"description":"Об'єм в метрах кубічних"},"SemiTrailerType":{"type":"string","maxLength":36,"description":"Вид транспортного засобу"},"AdditionalInformation":{"type":"string","maxLength":250,"description":"Додаткова інформація"}}},"UpdateFreightXmlResponse":{"type":"object","additionalProperties":false,"xml":{"name":"root"},"required":["success","data","errors","warnings","info","messageCodes","errorCodes","warningCodes","infoCodes"],"properties":{"success":{"type":"boolean","description":"Прапор успішності виконання запиту"},"data":{"type":"array","description":"Результат оновлення заявки","xml":{"name":"data","wrapped":true},"items":{"$ref":"#/components/schemas/UpdateFreightXmlItem"}},"errors":{"type":"array","description":"Масив повідомлень про помилки","xml":{"name":"errors","wrapped":true},"items":{"type":"string","xml":{"name":"item"}}},"warnings":{"type":"array","description":"Масив попереджень","xml":{"name":"warnings","wrapped":true},"items":{"type":"string","xml":{"name":"item"}}},"info":{"type":"array","description":"Масив інформаційних повідомлень","xml":{"name":"info","wrapped":true},"items":{"type":"string","xml":{"name":"item"}}},"messageCodes":{"type":"array","description":"Масив кодів інформаційних повідомлень","xml":{"name":"messageCodes","wrapped":true},"items":{"type":"string","xml":{"name":"item"}}},"errorCodes":{"type":"array","description":"Масив кодів помилок","xml":{"name":"errorCodes","wrapped":true},"items":{"type":"string","xml":{"name":"item"}}},"warningCodes":{"type":"array","description":"Масив кодів попереджень","xml":{"name":"warningCodes","wrapped":true},"items":{"type":"string","xml":{"name":"item"}}},"infoCodes":{"type":"array","description":"Масив кодів додаткової інформації","xml":{"name":"infoCodes","wrapped":true},"items":{"type":"string","xml":{"name":"item"}}}}},"UpdateFreightXmlItem":{"allOf":[{"$ref":"#/components/schemas/UpdateFreightItem"}],"xml":{"name":"item"}},"UpdateFreightItem":{"type":"object","properties":{"Ref":{"type":"string","maxLength":36,"description":"Ідентифікатор заявки"},"Number":{"type":"string","maxLength":36,"description":"Номер заявки"}}}}}}
```
---
# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.
## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:
```
GET https://api-portal.novapost.com/api-docs-ua/zagalna-informaciya/frakht.md?ask=&goal=
```
`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.