> 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/dovidniki.md).

# Довідники

:link:[Початок роботи з API](https://api-portal.novapost.com/api-docs-ua)

## Отримати список часових інтервалів (JSON)

> Метод \*\*getTimeIntervals\*\* працює в моделі \*\*CommonGeneral\*\*.\
> Повертає список часових інтервалів для вибраного міста.\
> \
> Довідник рекомендується завантажувати \*\*один раз на місяць\*\* для оновлення актуальних даних.<br>

```json
{"openapi":"3.0.3","info":{"title":"API Nova Post — Common","version":"2.0.0"},"tags":[{"name":"TimeIntervals","description":"Операції, пов'язані з отриманням часових інтервалів"}],"servers":[{"url":"https://api.novaposhta.ua/v2.0/","description":"production"}],"paths":{"/json/":{"post":{"tags":["TimeIntervals"],"operationId":"getTimeIntervalsJson","summary":"Отримати список часових інтервалів (JSON)","description":"Метод **getTimeIntervals** працює в моделі **CommonGeneral**.\nПовертає список часових інтервалів для вибраного міста.\n\nДовідник рекомендується завантажувати **один раз на місяць** для оновлення актуальних даних.\n","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetTimeIntervalsJsonRequest"}}}},"responses":{"200":{"description":"Успішна відповідь (JSON)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetTimeIntervalsResponse"}}}}}}}},"components":{"schemas":{"GetTimeIntervalsJsonRequest":{"type":"object","additionalProperties":false,"required":["apiKey","modelName","calledMethod","methodProperties"],"properties":{"apiKey":{"type":"string","description":"API-ключ користувача"},"modelName":{"type":"string","enum":["CommonGeneral"],"description":"Назва моделі API"},"calledMethod":{"type":"string","enum":["getTimeIntervals"],"description":"Назва методу API"},"methodProperties":{"$ref":"#/components/schemas/GetTimeIntervalsMethodProperties"}}},"GetTimeIntervalsMethodProperties":{"type":"object","additionalProperties":false,"required":["RecipientCityRef"],"properties":{"RecipientCityRef":{"type":"string","format":"uuid","description":"Ідентифікатор (REF) міста, для якого будуть отримані часові інтервали"},"DateTime":{"type":"string","description":"Дата, за яку будуть отримані часові інтервали.\nНеобов'язковий параметр. Якщо не передано, використовується поточна дата.\nФормат: dd.mm.yyyy\n"}}},"GetTimeIntervalsResponse":{"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/TimeIntervalItem"}},"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"}}}},"TimeIntervalItem":{"type":"object","additionalProperties":false,"properties":{"Number":{"type":"string","description":"Ідентифікатор часового інтервалу"},"Start":{"type":"string","description":"Час початку інтервалу"},"End":{"type":"string","description":"Час закінчення інтервалу"}}}}}}
```

## Отримати список часових інтервалів (XML)

> Метод \*\*getTimeIntervals\*\* працює в моделі \*\*CommonGeneral\*\*.\
> Повертає список часових інтервалів для вибраного міста у форматі XML.\
> \
> Довідник рекомендується завантажувати \*\*один раз на місяць\*\* для оновлення даних.<br>

```json
{"openapi":"3.0.3","info":{"title":"API Nova Post — Common","version":"2.0.0"},"tags":[{"name":"TimeIntervals","description":"Операції, пов'язані з отриманням часових інтервалів"}],"servers":[{"url":"https://api.novaposhta.ua/v2.0/","description":"production"}],"paths":{"/xml/":{"post":{"tags":["TimeIntervals"],"operationId":"getTimeIntervalsXml","summary":"Отримати список часових інтервалів (XML)","description":"Метод **getTimeIntervals** працює в моделі **CommonGeneral**.\nПовертає список часових інтервалів для вибраного міста у форматі XML.\n\nДовідник рекомендується завантажувати **один раз на місяць** для оновлення даних.\n","requestBody":{"required":true,"content":{"application/xml":{"schema":{"$ref":"#/components/schemas/GetTimeIntervalsXmlRequest"}}}},"responses":{"200":{"description":"Успішна відповідь (XML)","content":{"application/xml":{"schema":{"$ref":"#/components/schemas/GetTimeIntervalsXmlResponse"}}}}}}}},"components":{"schemas":{"GetTimeIntervalsXmlRequest":{"type":"object","additionalProperties":false,"xml":{"name":"file"},"required":["apiKey","modelName","calledMethod","methodProperties"],"properties":{"apiKey":{"type":"string","description":"API-ключ користувача"},"modelName":{"type":"string","enum":["CommonGeneral"],"description":"Назва моделі API"},"calledMethod":{"type":"string","enum":["getTimeIntervals"],"description":"Назва методу API"},"methodProperties":{"$ref":"#/components/schemas/GetTimeIntervalsXmlMethodProperties"}}},"GetTimeIntervalsXmlMethodProperties":{"type":"object","additionalProperties":false,"xml":{"name":"methodProperties"},"required":["RecipientCityRef"],"properties":{"RecipientCityRef":{"type":"string","format":"uuid","description":"Ідентифікатор (REF) міста, для якого будуть отримані часові інтервали"},"DateTime":{"type":"string","description":"Дата, за яку будуть отримані часові інтервали.\nНеобов'язковий параметр. Якщо не передано, використовується поточна дата.\nФормат: dd.mm.yyyy\n"}}},"GetTimeIntervalsXmlResponse":{"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/TimeIntervalXmlItem"}},"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"}}}}},"TimeIntervalXmlItem":{"allOf":[{"$ref":"#/components/schemas/TimeIntervalItem"}],"xml":{"name":"item"}},"TimeIntervalItem":{"type":"object","additionalProperties":false,"properties":{"Number":{"type":"string","description":"Ідентифікатор часового інтервалу"},"Start":{"type":"string","description":"Час початку інтервалу"},"End":{"type":"string","description":"Час закінчення інтервалу"}}}}}}
```

## Отримати список типів вантажу (JSON)

> Метод \*\*getCargoTypes\*\* працює в моделі \*\*Common\*\* (або \*\*CommonGeneral\*\*).\
> Повертає список типів вантажу українською мовою.\
> \
> Довідник потрібно завантажувати \*\*один раз на місяць\*\* для оновлення даних.<br>

```json
{"openapi":"3.0.3","info":{"title":"API Nova Post — Common","version":"2.0.0"},"tags":[{"name":"CargoTypes","description":"Операції, пов'язані з отриманням типів вантажу"}],"servers":[{"url":"https://api.novaposhta.ua/v2.0/","description":"production"}],"paths":{"/json/":{"post":{"tags":["CargoTypes"],"operationId":"getCargoTypesJson","summary":"Отримати список типів вантажу (JSON)","description":"Метод **getCargoTypes** працює в моделі **Common** (або **CommonGeneral**).\nПовертає список типів вантажу українською мовою.\n\nДовідник потрібно завантажувати **один раз на місяць** для оновлення даних.\n","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCargoTypesJsonRequest"}}}},"responses":{"200":{"description":"Успішна відповідь (JSON)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCargoTypesResponse"}}}}}}}},"components":{"schemas":{"GetCargoTypesJsonRequest":{"type":"object","additionalProperties":false,"required":["apiKey","modelName","calledMethod","methodProperties"],"properties":{"apiKey":{"type":"string","description":"API-ключ користувача"},"modelName":{"type":"string","enum":["CommonGeneral","Common"],"description":"Назва моделі API"},"calledMethod":{"type":"string","enum":["getCargoTypes"],"description":"Назва методу API"},"methodProperties":{"$ref":"#/components/schemas/GetCargoTypesMethodProperties"}}},"GetCargoTypesMethodProperties":{"type":"object","additionalProperties":false,"description":"Властивості методу"},"GetCargoTypesResponse":{"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/CargoTypeItem"}},"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"}}}},"CargoTypeItem":{"type":"object","additionalProperties":false,"properties":{"Ref":{"type":"string","maxLength":36,"description":"Ідентифікатор типу вантажу"},"Description":{"type":"string","maxLength":36,"description":"Опис типу вантажу"}}}}}}
```

## Отримати список типів вантажу (XML)

> Метод \*\*getCargoTypes\*\* працює в моделі \*\*Common\*\* (або \*\*CommonGeneral\*\*).\
> Повертає список типів вантажу українською мовою.\
> \
> Довідник потрібно завантажувати \*\*один раз на місяць\*\* для оновлення даних.<br>

```json
{"openapi":"3.0.3","info":{"title":"API Nova Post — Common","version":"2.0.0"},"tags":[{"name":"CargoTypes","description":"Операції, пов'язані з отриманням типів вантажу"}],"servers":[{"url":"https://api.novaposhta.ua/v2.0/","description":"production"}],"paths":{"/xml/":{"post":{"tags":["CargoTypes"],"operationId":"getCargoTypesXml","summary":"Отримати список типів вантажу (XML)","description":"Метод **getCargoTypes** працює в моделі **Common** (або **CommonGeneral**).\nПовертає список типів вантажу українською мовою.\n\nДовідник потрібно завантажувати **один раз на місяць** для оновлення даних.\n","requestBody":{"required":true,"content":{"application/xml":{"schema":{"$ref":"#/components/schemas/GetCargoTypesXmlRequest"}}}},"responses":{"200":{"description":"Успішна відповідь (XML)","content":{"application/xml":{"schema":{"$ref":"#/components/schemas/GetCargoTypesXmlResponse"}}}}}}}},"components":{"schemas":{"GetCargoTypesXmlRequest":{"type":"object","additionalProperties":false,"xml":{"name":"file"},"required":["apiKey","modelName","calledMethod","methodProperties"],"properties":{"apiKey":{"type":"string","description":"API-ключ користувача"},"modelName":{"type":"string","enum":["CommonGeneral","Common"],"description":"Назва моделі API"},"calledMethod":{"type":"string","enum":["getCargoTypes"],"description":"Назва методу API"},"methodProperties":{"$ref":"#/components/schemas/GetCargoTypesXmlMethodProperties"}}},"GetCargoTypesXmlMethodProperties":{"type":"object","additionalProperties":false,"description":"Властивості методу","xml":{"name":"methodProperties"}},"GetCargoTypesXmlResponse":{"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/CargoTypeXmlItem"}},"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"}}}}},"CargoTypeXmlItem":{"allOf":[{"$ref":"#/components/schemas/CargoTypeItem"}],"xml":{"name":"item"}},"CargoTypeItem":{"type":"object","additionalProperties":false,"properties":{"Ref":{"type":"string","maxLength":36,"description":"Ідентифікатор типу вантажу"},"Description":{"type":"string","maxLength":36,"description":"Опис типу вантажу"}}}}}}
```

## Отримати список видів зворотної доставки вантажу (JSON)

> Метод \*\*getBackwardDeliveryCargoTypes\*\* працює в моделі \*\*Common\*\* (або \*\*CommonGeneral\*\*).\
> Повертає список видів зворотної доставки вантажу українською та російською мовами.\
> \
> Довідник потрібно завантажувати \*\*один раз на місяць\*\* для оновлення даних.<br>

```json
{"openapi":"3.0.3","info":{"title":"API Nova Post — Common","version":"2.0.0"},"tags":[{"name":"BackwardDeliveryCargoTypes","description":"Операції, пов'язані з отриманням видів зворотної доставки вантажу"}],"servers":[{"url":"https://api.novaposhta.ua/v2.0/","description":"production"}],"paths":{"/json/":{"post":{"tags":["BackwardDeliveryCargoTypes"],"operationId":"getBackwardDeliveryCargoTypesJson","summary":"Отримати список видів зворотної доставки вантажу (JSON)","description":"Метод **getBackwardDeliveryCargoTypes** працює в моделі **Common** (або **CommonGeneral**).\nПовертає список видів зворотної доставки вантажу українською та російською мовами.\n\nДовідник потрібно завантажувати **один раз на місяць** для оновлення даних.\n","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetBackwardDeliveryCargoTypesJsonRequest"}}}},"responses":{"200":{"description":"Успішна відповідь (JSON)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetBackwardDeliveryCargoTypesResponse"}}}}}}}},"components":{"schemas":{"GetBackwardDeliveryCargoTypesJsonRequest":{"type":"object","additionalProperties":false,"required":["apiKey","modelName","calledMethod","methodProperties"],"properties":{"apiKey":{"type":"string","description":"API-ключ користувача"},"modelName":{"type":"string","enum":["CommonGeneral","Common"],"description":"Назва моделі API"},"calledMethod":{"type":"string","enum":["getBackwardDeliveryCargoTypes"],"description":"Назва методу API"},"methodProperties":{"$ref":"#/components/schemas/GetBackwardDeliveryCargoTypesMethodProperties"}}},"GetBackwardDeliveryCargoTypesMethodProperties":{"type":"object","additionalProperties":false,"description":"Властивості методу"},"GetBackwardDeliveryCargoTypesResponse":{"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/BackwardDeliveryCargoTypeItem"}},"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"}}}},"BackwardDeliveryCargoTypeItem":{"type":"object","additionalProperties":false,"properties":{"Ref":{"type":"string","maxLength":36,"description":"Ідентифікатор виду зворотної доставки вантажу"},"Description":{"type":"string","maxLength":36,"description":"Опис виду зворотної доставки вантажу"}}}}}}
```

## Отримати список видів зворотної доставки вантажу (XML)

> Метод \*\*getBackwardDeliveryCargoTypes\*\* працює в моделі \*\*Common\*\* (або \*\*CommonGeneral\*\*).\
> Повертає список видів зворотної доставки вантажу українською та російською мовами у форматі XML.\
> \
> Довідник потрібно завантажувати \*\*один раз на місяць\*\* для оновлення даних.<br>

```json
{"openapi":"3.0.3","info":{"title":"API Nova Post — Common","version":"2.0.0"},"tags":[{"name":"BackwardDeliveryCargoTypes","description":"Операції, пов'язані з отриманням видів зворотної доставки вантажу"}],"servers":[{"url":"https://api.novaposhta.ua/v2.0/","description":"production"}],"paths":{"/xml/":{"post":{"tags":["BackwardDeliveryCargoTypes"],"operationId":"getBackwardDeliveryCargoTypesXml","summary":"Отримати список видів зворотної доставки вантажу (XML)","description":"Метод **getBackwardDeliveryCargoTypes** працює в моделі **Common** (або **CommonGeneral**).\nПовертає список видів зворотної доставки вантажу українською та російською мовами у форматі XML.\n\nДовідник потрібно завантажувати **один раз на місяць** для оновлення даних.\n","requestBody":{"required":true,"content":{"application/xml":{"schema":{"$ref":"#/components/schemas/GetBackwardDeliveryCargoTypesXmlRequest"}}}},"responses":{"200":{"description":"Успішна відповідь (XML)","content":{"application/xml":{"schema":{"$ref":"#/components/schemas/GetBackwardDeliveryCargoTypesXmlResponse"}}}}}}}},"components":{"schemas":{"GetBackwardDeliveryCargoTypesXmlRequest":{"type":"object","additionalProperties":false,"xml":{"name":"file"},"required":["apiKey","modelName","calledMethod","methodProperties"],"properties":{"apiKey":{"type":"string","description":"API-ключ користувача"},"modelName":{"type":"string","enum":["CommonGeneral","Common"],"description":"Назва моделі API"},"calledMethod":{"type":"string","enum":["getBackwardDeliveryCargoTypes"],"description":"Назва методу API"},"methodProperties":{"$ref":"#/components/schemas/GetBackwardDeliveryCargoTypesXmlMethodProperties"}}},"GetBackwardDeliveryCargoTypesXmlMethodProperties":{"type":"object","additionalProperties":false,"description":"Властивості методу","xml":{"name":"methodProperties"}},"GetBackwardDeliveryCargoTypesXmlResponse":{"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/BackwardDeliveryCargoTypeXmlItem"}},"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"}}}}},"BackwardDeliveryCargoTypeXmlItem":{"allOf":[{"$ref":"#/components/schemas/BackwardDeliveryCargoTypeItem"}],"xml":{"name":"item"}},"BackwardDeliveryCargoTypeItem":{"type":"object","additionalProperties":false,"properties":{"Ref":{"type":"string","maxLength":36,"description":"Ідентифікатор виду зворотної доставки вантажу"},"Description":{"type":"string","maxLength":36,"description":"Опис виду зворотної доставки вантажу"}}}}}}
```

## Отримати список видів палет (JSON)

> Метод \*\*getPalletsList\*\* працює в моделі \*\*Common\*\* (або \*\*CommonGeneral\*\*) і\
> повертає список видів палет.\
> \
> Довідник потрібно завантажувати \*\*один раз на місяць\*\* для оновлення даних.<br>

```json
{"openapi":"3.0.3","info":{"title":"API Nova Post — Common","version":"2.0.0"},"tags":[{"name":"PalletsList","description":"Операції, пов'язані з отриманням списку видів палет"}],"servers":[{"url":"https://api.novaposhta.ua/v2.0/","description":"production"}],"paths":{"/json/":{"post":{"tags":["PalletsList"],"operationId":"getPalletsListJson","summary":"Отримати список видів палет (JSON)","description":"Метод **getPalletsList** працює в моделі **Common** (або **CommonGeneral**) і\nповертає список видів палет.\n\nДовідник потрібно завантажувати **один раз на місяць** для оновлення даних.\n","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetPalletsListJsonRequest"}}}},"responses":{"200":{"description":"Успішна відповідь (JSON)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetPalletsListResponse"}}}}}}}},"components":{"schemas":{"GetPalletsListJsonRequest":{"type":"object","additionalProperties":false,"required":["apiKey","modelName","calledMethod","methodProperties"],"properties":{"apiKey":{"type":"string","description":"API-ключ користувача"},"modelName":{"type":"string","enum":["CommonGeneral","Common"],"description":"Назва моделі API"},"calledMethod":{"type":"string","enum":["getPalletsList"],"description":"Назва методу API"},"methodProperties":{"$ref":"#/components/schemas/GetPalletsListMethodProperties"}}},"GetPalletsListMethodProperties":{"type":"object","additionalProperties":false,"description":"Властивості методу"},"GetPalletsListResponse":{"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/PalletItem"}},"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"}}}},"PalletItem":{"type":"object","additionalProperties":false,"properties":{"Ref":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) палети"},"Description":{"type":"string","maxLength":36,"description":"Опис палети українською мовою"},"DescriptionRu":{"type":"string","maxLength":36,"description":"Опис палети російською мовою"},"Weight":{"type":"string","maxLength":36,"description":"Вага"}}}}}}
```

## Отримати список видів палет (XML)

> Метод \*\*getPalletsList\*\* працює в моделі \*\*Common\*\* (або \*\*CommonGeneral\*\*) і\
> повертає список видів палет у форматі XML.\
> \
> Довідник потрібно завантажувати \*\*один раз на місяць\*\* для оновлення даних.<br>

```json
{"openapi":"3.0.3","info":{"title":"API Nova Post — Common","version":"2.0.0"},"tags":[{"name":"PalletsList","description":"Операції, пов'язані з отриманням списку видів палет"}],"servers":[{"url":"https://api.novaposhta.ua/v2.0/","description":"production"}],"paths":{"/xml/":{"post":{"tags":["PalletsList"],"operationId":"getPalletsListXml","summary":"Отримати список видів палет (XML)","description":"Метод **getPalletsList** працює в моделі **Common** (або **CommonGeneral**) і\nповертає список видів палет у форматі XML.\n\nДовідник потрібно завантажувати **один раз на місяць** для оновлення даних.\n","requestBody":{"required":true,"content":{"application/xml":{"schema":{"$ref":"#/components/schemas/GetPalletsListXmlRequest"}}}},"responses":{"200":{"description":"Успішна відповідь (XML)","content":{"application/xml":{"schema":{"$ref":"#/components/schemas/GetPalletsListXmlResponse"}}}}}}}},"components":{"schemas":{"GetPalletsListXmlRequest":{"type":"object","additionalProperties":false,"xml":{"name":"file"},"required":["apiKey","modelName","calledMethod","methodProperties"],"properties":{"apiKey":{"type":"string","description":"API-ключ користувача"},"modelName":{"type":"string","enum":["CommonGeneral","Common"],"description":"Назва моделі API"},"calledMethod":{"type":"string","enum":["getPalletsList"],"description":"Назва методу API"},"methodProperties":{"$ref":"#/components/schemas/GetPalletsListXmlMethodProperties"}}},"GetPalletsListXmlMethodProperties":{"type":"object","additionalProperties":false,"description":"Властивості методу","xml":{"name":"methodProperties"}},"GetPalletsListXmlResponse":{"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/PalletXmlItem"}},"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"}}}}},"PalletXmlItem":{"allOf":[{"$ref":"#/components/schemas/PalletItem"}],"xml":{"name":"item"}},"PalletItem":{"type":"object","additionalProperties":false,"properties":{"Ref":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) палети"},"Description":{"type":"string","maxLength":36,"description":"Опис палети українською мовою"},"DescriptionRu":{"type":"string","maxLength":36,"description":"Опис палети російською мовою"},"Weight":{"type":"string","maxLength":36,"description":"Вага"}}}}}}
```

## Отримати список видів платників (JSON)

> Метод \*\*getTypesOfPayers\*\* працює в моделі \*\*Common\*\* (або \*\*CommonGeneral\*\*) \
> і використовується для завантаження даних щодо видів платників послуги доставки (відправник, одержувач, третя особа).\
> \
> Вид платника «Третя особа» можна замовити лише після укладання договору з компанією «Нова пошта».\
> \
> Довідник потрібно завантажувати \*\*один раз на місяць\*\* для оновлення даних.<br>

```json
{"openapi":"3.0.3","info":{"title":"API Nova Post — Common","version":"2.0.0"},"tags":[{"name":"TypesOfPayers","description":"Операції, пов'язані з отриманням видів платників послуги доставки"}],"servers":[{"url":"https://api.novaposhta.ua/v2.0/","description":"production"}],"paths":{"/json/":{"post":{"tags":["TypesOfPayers"],"operationId":"getTypesOfPayersJson","summary":"Отримати список видів платників (JSON)","description":"Метод **getTypesOfPayers** працює в моделі **Common** (або **CommonGeneral**) \nі використовується для завантаження даних щодо видів платників послуги доставки (відправник, одержувач, третя особа).\n\nВид платника «Третя особа» можна замовити лише після укладання договору з компанією «Нова пошта».\n\nДовідник потрібно завантажувати **один раз на місяць** для оновлення даних.\n","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetTypesOfPayersJsonRequest"}}}},"responses":{"200":{"description":"Успішна відповідь (JSON)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetTypesOfPayersResponse"}}}}}}}},"components":{"schemas":{"GetTypesOfPayersJsonRequest":{"type":"object","additionalProperties":false,"required":["apiKey","modelName","calledMethod","methodProperties"],"properties":{"apiKey":{"type":"string","description":"API-ключ користувача"},"modelName":{"type":"string","enum":["CommonGeneral","Common"],"description":"Назва моделі API"},"calledMethod":{"type":"string","enum":["getTypesOfPayers"],"description":"Назва методу API"},"methodProperties":{"$ref":"#/components/schemas/GetTypesOfPayersMethodProperties"}}},"GetTypesOfPayersMethodProperties":{"type":"object","additionalProperties":false,"description":"Властивості методу"},"GetTypesOfPayersResponse":{"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/TypeOfPayerItem"}},"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"}}}},"TypeOfPayerItem":{"type":"object","additionalProperties":false,"properties":{"Ref":{"type":"string","maxLength":36,"description":"Ідентифікатор виду платника"},"Description":{"type":"string","maxLength":36,"description":"Опис виду платника"}}}}}}
```

## Отримати список видів платників (XML)

> Метод \*\*getTypesOfPayers\*\* працює в моделі \*\*Common\*\* (або \*\*CommonGeneral\*\*) \
> і використовується для завантаження даних щодо видів платників послуги доставки (відправник, одержувач, третя особа).\
> \
> Вид платника «Третя особа» можна замовити лише після укладання договору з компанією «Нова пошта».\
> \
> Довідник потрібно завантажувати \*\*один раз на місяць\*\* для оновлення даних.<br>

```json
{"openapi":"3.0.3","info":{"title":"API Nova Post — Common","version":"2.0.0"},"tags":[{"name":"TypesOfPayers","description":"Операції, пов'язані з отриманням видів платників послуги доставки"}],"servers":[{"url":"https://api.novaposhta.ua/v2.0/","description":"production"}],"paths":{"/xml/":{"post":{"tags":["TypesOfPayers"],"operationId":"getTypesOfPayersXml","summary":"Отримати список видів платників (XML)","description":"Метод **getTypesOfPayers** працює в моделі **Common** (або **CommonGeneral**) \nі використовується для завантаження даних щодо видів платників послуги доставки (відправник, одержувач, третя особа).\n\nВид платника «Третя особа» можна замовити лише після укладання договору з компанією «Нова пошта».\n\nДовідник потрібно завантажувати **один раз на місяць** для оновлення даних.\n","requestBody":{"required":true,"content":{"application/xml":{"schema":{"$ref":"#/components/schemas/GetTypesOfPayersXmlRequest"}}}},"responses":{"200":{"description":"Успішна відповідь (XML)","content":{"application/xml":{"schema":{"$ref":"#/components/schemas/GetTypesOfPayersXmlResponse"}}}}}}}},"components":{"schemas":{"GetTypesOfPayersXmlRequest":{"type":"object","additionalProperties":false,"xml":{"name":"file"},"required":["apiKey","modelName","calledMethod","methodProperties"],"properties":{"apiKey":{"type":"string","description":"API-ключ користувача"},"modelName":{"type":"string","enum":["CommonGeneral","Common"],"description":"Назва моделі API"},"calledMethod":{"type":"string","enum":["getTypesOfPayers"],"description":"Назва методу API"},"methodProperties":{"$ref":"#/components/schemas/GetTypesOfPayersXmlMethodProperties"}}},"GetTypesOfPayersXmlMethodProperties":{"type":"object","additionalProperties":false,"description":"Властивості методу","xml":{"name":"methodProperties"}},"GetTypesOfPayersXmlResponse":{"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/TypeOfPayerXmlItem"}},"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"}}}}},"TypeOfPayerXmlItem":{"allOf":[{"$ref":"#/components/schemas/TypeOfPayerItem"}],"xml":{"name":"item"}},"TypeOfPayerItem":{"type":"object","additionalProperties":false,"properties":{"Ref":{"type":"string","maxLength":36,"description":"Ідентифікатор виду платника"},"Description":{"type":"string","maxLength":36,"description":"Опис виду платника"}}}}}}
```

## Отримати список видів платників зворотної доставки (JSON)

> Метод \*\*getTypesOfPayersForRedelivery\*\* працює в моделі \*\*Common\*\* (або \*\*CommonGeneral\*\*) \
> і використовується для завантаження даних щодо видів платників (Sender, Recipient) послуги зворотної доставки. Дані завантажуються українською та англійською мовами.\
> \
> Довідник потрібно завантажувати \*\*один раз на місяць\*\* для оновлення даних.<br>

```json
{"openapi":"3.0.3","info":{"title":"API Nova Post — Common","version":"2.0.0"},"tags":[{"name":"TypesOfPayersForRedelivery","description":"Операції, пов'язані з отриманням видів платників послуги зворотної доставки"}],"servers":[{"url":"https://api.novaposhta.ua/v2.0/","description":"production"}],"paths":{"/json/":{"post":{"tags":["TypesOfPayersForRedelivery"],"operationId":"getTypesOfPayersForRedeliveryJson","summary":"Отримати список видів платників зворотної доставки (JSON)","description":"Метод **getTypesOfPayersForRedelivery** працює в моделі **Common** (або **CommonGeneral**) \nі використовується для завантаження даних щодо видів платників (Sender, Recipient) послуги зворотної доставки. Дані завантажуються українською та англійською мовами.\n\nДовідник потрібно завантажувати **один раз на місяць** для оновлення даних.\n","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetTypesOfPayersForRedeliveryJsonRequest"}}}},"responses":{"200":{"description":"Успішна відповідь (JSON)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetTypesOfPayersForRedeliveryResponse"}}}}}}}},"components":{"schemas":{"GetTypesOfPayersForRedeliveryJsonRequest":{"type":"object","additionalProperties":false,"required":["apiKey","modelName","calledMethod","methodProperties"],"properties":{"apiKey":{"type":"string","description":"API-ключ користувача"},"modelName":{"type":"string","enum":["CommonGeneral","Common"],"description":"Назва моделі API"},"calledMethod":{"type":"string","enum":["getTypesOfPayersForRedelivery"],"description":"Назва методу API"},"methodProperties":{"$ref":"#/components/schemas/GetTypesOfPayersForRedeliveryMethodProperties"}}},"GetTypesOfPayersForRedeliveryMethodProperties":{"type":"object","additionalProperties":false,"description":"Властивості методу"},"GetTypesOfPayersForRedeliveryResponse":{"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/TypeOfPayerForRedeliveryItem"}},"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"}}}},"TypeOfPayerForRedeliveryItem":{"type":"object","additionalProperties":false,"properties":{"Ref":{"type":"string","maxLength":36,"description":"Ідентифікатор"},"Description":{"type":"string","maxLength":36,"description":"Опис"}}}}}}
```

## Отримати список видів платників зворотної доставки (XML)

> Метод \*\*getTypesOfPayersForRedelivery\*\* працює в моделі \*\*Common\*\* (або \*\*CommonGeneral\*\*) \
> і використовується для завантаження даних щодо видів платників (Sender, Recipient) послуги зворотної доставки. Дані завантажуються українською та англійською мовами.\
> \
> Довідник потрібно завантажувати \*\*один раз на місяць\*\* для оновлення даних.<br>

```json
{"openapi":"3.0.3","info":{"title":"API Nova Post — Common","version":"2.0.0"},"tags":[{"name":"TypesOfPayersForRedelivery","description":"Операції, пов'язані з отриманням видів платників послуги зворотної доставки"}],"servers":[{"url":"https://api.novaposhta.ua/v2.0/","description":"production"}],"paths":{"/xml/":{"post":{"tags":["TypesOfPayersForRedelivery"],"operationId":"getTypesOfPayersForRedeliveryXml","summary":"Отримати список видів платників зворотної доставки (XML)","description":"Метод **getTypesOfPayersForRedelivery** працює в моделі **Common** (або **CommonGeneral**) \nі використовується для завантаження даних щодо видів платників (Sender, Recipient) послуги зворотної доставки. Дані завантажуються українською та англійською мовами.\n\nДовідник потрібно завантажувати **один раз на місяць** для оновлення даних.\n","requestBody":{"required":true,"content":{"application/xml":{"schema":{"$ref":"#/components/schemas/GetTypesOfPayersForRedeliveryXmlRequest"}}}},"responses":{"200":{"description":"Успішна відповідь (XML)","content":{"application/xml":{"schema":{"$ref":"#/components/schemas/GetTypesOfPayersForRedeliveryXmlResponse"}}}}}}}},"components":{"schemas":{"GetTypesOfPayersForRedeliveryXmlRequest":{"type":"object","additionalProperties":false,"xml":{"name":"file"},"required":["apiKey","modelName","calledMethod","methodProperties"],"properties":{"apiKey":{"type":"string","description":"API-ключ користувача"},"modelName":{"type":"string","enum":["CommonGeneral","Common"],"description":"Назва моделі API"},"calledMethod":{"type":"string","enum":["getTypesOfPayersForRedelivery"],"description":"Назва методу API"},"methodProperties":{"$ref":"#/components/schemas/GetTypesOfPayersForRedeliveryXmlMethodProperties"}}},"GetTypesOfPayersForRedeliveryXmlMethodProperties":{"type":"object","additionalProperties":false,"description":"Властивості методу","xml":{"name":"methodProperties"}},"GetTypesOfPayersForRedeliveryXmlResponse":{"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/TypeOfPayerForRedeliveryXmlItem"}},"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"}}}}},"TypeOfPayerForRedeliveryXmlItem":{"allOf":[{"$ref":"#/components/schemas/TypeOfPayerForRedeliveryItem"}],"xml":{"name":"item"}},"TypeOfPayerForRedeliveryItem":{"type":"object","additionalProperties":false,"properties":{"Ref":{"type":"string","maxLength":36,"description":"Ідентифікатор"},"Description":{"type":"string","maxLength":36,"description":"Опис"}}}}}}
```

## Отримати список видів паковання (JSON)

> Метод \*\*getPackList\*\* працює в моделі \*\*Common\*\* (або \*\*CommonGeneral\*\*) \
> і використовується для завантаження даних щодо видів паковання вантажу. Опис надається українською або російською мовами.\
> \
> Довідник слід завантажувати \*\*один раз на місяць\*\* для оновлення даних.<br>

```json
{"openapi":"3.0.3","info":{"title":"API Nova Post — Common","version":"2.0.0"},"tags":[{"name":"PackList","description":"Операції, пов'язані з отриманням видів паковання вантажу"}],"servers":[{"url":"https://api.novaposhta.ua/v2.0/","description":"production"}],"paths":{"/json/":{"post":{"tags":["PackList"],"operationId":"getPackListJson","summary":"Отримати список видів паковання (JSON)","description":"Метод **getPackList** працює в моделі **Common** (або **CommonGeneral**) \nі використовується для завантаження даних щодо видів паковання вантажу. Опис надається українською або російською мовами.\n\nДовідник слід завантажувати **один раз на місяць** для оновлення даних.\n","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetPackListJsonRequest"}}}},"responses":{"200":{"description":"Успішна відповідь (JSON)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetPackListResponse"}}}}}}}},"components":{"schemas":{"GetPackListJsonRequest":{"type":"object","additionalProperties":false,"required":["apiKey","modelName","calledMethod","methodProperties"],"properties":{"apiKey":{"type":"string","description":"API-ключ користувача"},"modelName":{"type":"string","enum":["CommonGeneral","Common"],"description":"Назва моделі API"},"calledMethod":{"type":"string","enum":["getPackList"],"description":"Назва методу API"},"methodProperties":{"$ref":"#/components/schemas/GetPackListMethodProperties"}}},"GetPackListMethodProperties":{"type":"object","additionalProperties":false,"properties":{"Lengthstring":{"type":"string","description":"Довжина"},"Widthstring":{"type":"string","description":"Вага"},"Heightstring":{"type":"string","description":"Висота"},"VolumetricWeightstring":{"type":"string","description":"Об'єм"},"TypeOfPackingstring":{"type":"string","description":"Тип паковання"}}},"GetPackListResponse":{"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/PackListItem"}},"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"}}}},"PackListItem":{"type":"object","additionalProperties":false,"properties":{"Ref":{"type":"string","maxLength":36,"description":"Ідентифікатор"},"Description":{"type":"string","maxLength":36,"description":"Опис українською мовою"},"DescriptionRu":{"type":"string","maxLength":36,"description":"Опис російською мовою"},"Length":{"type":"string","maxLength":36,"description":"Довжина паковання"},"Width":{"type":"string","maxLength":36,"description":"Вага паковання"},"Height":{"type":"string","maxLength":36,"description":"Висота паковання"},"VolumetricWeight":{"type":"string","maxLength":36,"description":"Об'єм паковання"},"TypeOfPacking":{"type":"string","maxLength":36,"description":"Тип паковання (не використовується)"}}}}}}
```

## Отримати список видів паковання (XML)

> Метод \*\*getPackList\*\* працює в моделі \*\*Common\*\* (або \*\*CommonGeneral\*\*) \
> і використовується для завантаження даних щодо видів паковання вантажу. Опис надається українською або російською мовами.\
> \
> Довідник слід завантажувати \*\*один раз на місяць\*\* для оновлення даних.<br>

```json
{"openapi":"3.0.3","info":{"title":"API Nova Post — Common","version":"2.0.0"},"tags":[{"name":"PackList","description":"Операції, пов'язані з отриманням видів паковання вантажу"}],"servers":[{"url":"https://api.novaposhta.ua/v2.0/","description":"production"}],"paths":{"/xml/":{"post":{"tags":["PackList"],"operationId":"getPackListXml","summary":"Отримати список видів паковання (XML)","description":"Метод **getPackList** працює в моделі **Common** (або **CommonGeneral**) \nі використовується для завантаження даних щодо видів паковання вантажу. Опис надається українською або російською мовами.\n\nДовідник слід завантажувати **один раз на місяць** для оновлення даних.\n","requestBody":{"required":true,"content":{"application/xml":{"schema":{"$ref":"#/components/schemas/GetPackListXmlRequest"}}}},"responses":{"200":{"description":"Успішна відповідь (XML)","content":{"application/xml":{"schema":{"$ref":"#/components/schemas/GetPackListXmlResponse"}}}}}}}},"components":{"schemas":{"GetPackListXmlRequest":{"type":"object","additionalProperties":false,"xml":{"name":"file"},"required":["apiKey","modelName","calledMethod","methodProperties"],"properties":{"apiKey":{"type":"string","description":"API-ключ користувача"},"modelName":{"type":"string","enum":["CommonGeneral","Common"],"description":"Назва моделі API"},"calledMethod":{"type":"string","enum":["getPackList"],"description":"Назва методу API"},"methodProperties":{"$ref":"#/components/schemas/GetPackListXmlMethodProperties"}}},"GetPackListXmlMethodProperties":{"type":"object","additionalProperties":false,"description":"Властивості методу для XML","xml":{"name":"methodProperties"},"properties":{"Lengthstring":{"type":"string","description":"Довжина","xml":{"name":"Lengthstring"}},"Widthstring":{"type":"string","description":"Вага","xml":{"name":"Widthstring"}},"Heightstring":{"type":"string","description":"Висота","xml":{"name":"Heightstring"}},"VolumetricWeightstring":{"type":"string","description":"Об'єм","xml":{"name":"VolumetricWeightstring"}},"TypeOfPackingstring":{"type":"string","description":"Тип паковання","xml":{"name":"TypeOfPackingstring"}}}},"GetPackListXmlResponse":{"type":"object","additionalProperties":false,"xml":{"name":"root"},"required":["success","data","errors","warnings","info","messageCodes","errorCodes","warningCodes","infoCodes"],"properties":{"success":{"type":"boolean","description":"Прапор успішності виконання запиту"},"data":{"$ref":"#/components/schemas/PackListItem","xml":{"name":"data"}},"errors":{"type":"array","description":"Масив повідомлень про помилки","xml":{"name":"errors"},"items":{"type":"string","xml":{"name":"errors"}}},"warnings":{"type":"array","description":"Масив попереджень","xml":{"name":"warnings"},"items":{"type":"string","xml":{"name":"warnings"}}},"info":{"type":"array","description":"Масив інформаційних повідомлень","xml":{"name":"info"},"items":{"type":"string","xml":{"name":"info"}}},"messageCodes":{"type":"array","description":"Масив кодів інформаційних повідомлень","xml":{"name":"messageCodes"},"items":{"type":"string","xml":{"name":"messageCodes"}}},"errorCodes":{"type":"array","description":"Масив кодів помилок","xml":{"name":"errorCodes"},"items":{"type":"string","xml":{"name":"errorCodes"}}},"warningCodes":{"type":"array","description":"Масив кодів попереджень","xml":{"name":"warningCodes"},"items":{"type":"string","xml":{"name":"warningCodes"}}},"infoCodes":{"type":"array","description":"Масив кодів додаткової інформації","xml":{"name":"infoCodes"},"items":{"type":"string","xml":{"name":"infoCodes"}}}}},"PackListItem":{"type":"object","additionalProperties":false,"properties":{"Ref":{"type":"string","maxLength":36,"description":"Ідентифікатор"},"Description":{"type":"string","maxLength":36,"description":"Опис українською мовою"},"DescriptionRu":{"type":"string","maxLength":36,"description":"Опис російською мовою"},"Length":{"type":"string","maxLength":36,"description":"Довжина паковання"},"Width":{"type":"string","maxLength":36,"description":"Вага паковання"},"Height":{"type":"string","maxLength":36,"description":"Висота паковання"},"VolumetricWeight":{"type":"string","maxLength":36,"description":"Об'єм паковання"},"TypeOfPacking":{"type":"string","maxLength":36,"description":"Тип паковання (не використовується)"}}}}}}
```

## Отримати список шин і дисків (JSON)

> Метод \*\*getTiresWheelsList\*\* працює в моделі \*\*Common\*\* (або \*\*CommonGeneral\*\*) \
> і дозволяє завантажити список шин і дисків українською та російською мовами. Використовується, якщо вид вантажу — «Шини-диски».\
> \
> Необхідно зберігати копію довідників на стороні клієнта та підтримувати її в актуальному стані. \
> Рекомендується проводити оновлення довідників \*\*раз на місяць\*\*.<br>

```json
{"openapi":"3.0.3","info":{"title":"API Nova Post — Common","version":"2.0.0"},"tags":[{"name":"TiresWheelsList","description":"Операції, пов'язані з отриманням списку шин і дисків"}],"servers":[{"url":"https://api.novaposhta.ua/v2.0/","description":"production"}],"paths":{"/json/":{"post":{"tags":["TiresWheelsList"],"operationId":"getTiresWheelsListJson","summary":"Отримати список шин і дисків (JSON)","description":"Метод **getTiresWheelsList** працює в моделі **Common** (або **CommonGeneral**) \nі дозволяє завантажити список шин і дисків українською та російською мовами. Використовується, якщо вид вантажу — «Шини-диски».\n\nНеобхідно зберігати копію довідників на стороні клієнта та підтримувати її в актуальному стані. \nРекомендується проводити оновлення довідників **раз на місяць**.\n","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetTiresWheelsListJsonRequest"}}}},"responses":{"200":{"description":"Успішна відповідь (JSON)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetTiresWheelsListResponse"}}}}}}}},"components":{"schemas":{"GetTiresWheelsListJsonRequest":{"type":"object","additionalProperties":false,"required":["apiKey","modelName","calledMethod","methodProperties"],"properties":{"apiKey":{"type":"string","description":"API-ключ користувача"},"modelName":{"type":"string","enum":["CommonGeneral","Common"],"description":"Назва моделі API"},"calledMethod":{"type":"string","enum":["getTiresWheelsList"],"description":"Назва методу API"},"methodProperties":{"$ref":"#/components/schemas/GetTiresWheelsListMethodProperties"}}},"GetTiresWheelsListMethodProperties":{"type":"object","additionalProperties":false,"description":"Властивості методу (порожній об'єкт)"},"GetTiresWheelsListResponse":{"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/TiresWheelsListItem"}},"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"}}}},"TiresWheelsListItem":{"type":"object","additionalProperties":false,"properties":{"Ref":{"type":"string","maxLength":36,"description":"Ідентифікатор"},"Description":{"type":"string","maxLength":36,"description":"Опис українською мовою"},"DescriptionRu":{"type":"string","maxLength":36,"description":"Опис російською мовою"},"Weight":{"type":"string","maxLength":36,"description":"Вага"},"DescriptionType":{"type":"string","maxLength":36,"description":"Опис типу позиції (Tires/Wheels)"}}}}}}
```

## Отримати список шин і дисків (XML)

> Метод \*\*getTiresWheelsList\*\* працює в моделі \*\*Common\*\* (або \*\*CommonGeneral\*\*) \
> і дозволяє завантажити список шин і дисків українською та російською мовами. Використовується, якщо вид вантажу — «Шини-диски».\
> \
> Необхідно зберігати копію довідників на стороні клієнта та підтримувати її в актуальному стані. \
> Рекомендується проводити оновлення довідників \*\*раз на місяць\*\*.<br>

```json
{"openapi":"3.0.3","info":{"title":"API Nova Post — Common","version":"2.0.0"},"tags":[{"name":"TiresWheelsList","description":"Операції, пов'язані з отриманням списку шин і дисків"}],"servers":[{"url":"https://api.novaposhta.ua/v2.0/","description":"production"}],"paths":{"/xml/":{"post":{"tags":["TiresWheelsList"],"operationId":"getTiresWheelsListXml","summary":"Отримати список шин і дисків (XML)","description":"Метод **getTiresWheelsList** працює в моделі **Common** (або **CommonGeneral**) \nі дозволяє завантажити список шин і дисків українською та російською мовами. Використовується, якщо вид вантажу — «Шини-диски».\n\nНеобхідно зберігати копію довідників на стороні клієнта та підтримувати її в актуальному стані. \nРекомендується проводити оновлення довідників **раз на місяць**.\n","requestBody":{"required":true,"content":{"application/xml":{"schema":{"$ref":"#/components/schemas/GetTiresWheelsListXmlRequest"}}}},"responses":{"200":{"description":"Успішна відповідь (XML)","content":{"application/xml":{"schema":{"$ref":"#/components/schemas/GetTiresWheelsListXmlResponse"}}}}}}}},"components":{"schemas":{"GetTiresWheelsListXmlRequest":{"type":"object","additionalProperties":false,"xml":{"name":"file"},"required":["apiKey","modelName","calledMethod","methodProperties"],"properties":{"apiKey":{"type":"string","description":"API-ключ користувача"},"modelName":{"type":"string","enum":["CommonGeneral","Common"],"description":"Назва моделі API"},"calledMethod":{"type":"string","enum":["getTiresWheelsList"],"description":"Назва методу API"},"methodProperties":{"$ref":"#/components/schemas/GetTiresWheelsListXmlMethodProperties"}}},"GetTiresWheelsListXmlMethodProperties":{"type":"object","additionalProperties":false,"description":"Властивості методу для XML","xml":{"name":"methodProperties"}},"GetTiresWheelsListXmlResponse":{"type":"object","additionalProperties":false,"xml":{"name":"root"},"required":["success","data","errors","warnings","info","messageCodes","errorCodes","warningCodes","infoCodes"],"properties":{"success":{"type":"boolean","description":"Прапор успішності виконання запиту"},"data":{"$ref":"#/components/schemas/TiresWheelsListItem","xml":{"name":"data"}},"errors":{"type":"array","description":"Масив повідомлень про помилки","xml":{"name":"errors"},"items":{"type":"string","xml":{"name":"errors"}}},"warnings":{"type":"array","description":"Масив попереджень","xml":{"name":"warnings"},"items":{"type":"string","xml":{"name":"warnings"}}},"info":{"type":"array","description":"Масив інформаційних повідомлень","xml":{"name":"info"},"items":{"type":"string","xml":{"name":"info"}}},"messageCodes":{"type":"array","description":"Масив кодів інформаційних повідомлень","xml":{"name":"messageCodes"},"items":{"type":"string","xml":{"name":"messageCodes"}}},"errorCodes":{"type":"array","description":"Масив кодів помилок","xml":{"name":"errorCodes"},"items":{"type":"string","xml":{"name":"errorCodes"}}},"warningCodes":{"type":"array","description":"Масив кодів попереджень","xml":{"name":"warningCodes"},"items":{"type":"string","xml":{"name":"warningCodes"}}},"infoCodes":{"type":"array","description":"Масив кодів додаткової інформації","xml":{"name":"infoCodes"},"items":{"type":"string","xml":{"name":"infoCodes"}}}}},"TiresWheelsListItem":{"type":"object","additionalProperties":false,"properties":{"Ref":{"type":"string","maxLength":36,"description":"Ідентифікатор"},"Description":{"type":"string","maxLength":36,"description":"Опис українською мовою"},"DescriptionRu":{"type":"string","maxLength":36,"description":"Опис російською мовою"},"Weight":{"type":"string","maxLength":36,"description":"Вага"},"DescriptionType":{"type":"string","maxLength":36,"description":"Опис типу позиції (Tires/Wheels)"}}}}}}
```

## Отримати список описів вантажу (JSON)

> Метод \*\*getCargoDescriptionList\*\* працює в моделі \*\*Common\*\* (або \*\*CommonGeneral\*\*) \
> і дозволяє відобразити опис вантажу українською та російською мовами. \
> Доступний пошук за рядками (необов'язковий параметр).\
> \
> Необхідно зберігати копію довідників на стороні клієнта та підтримувати її в актуальному стані. \
> Рекомендується проводити оновлення довідників \*\*раз на місяць\*\*.<br>

```json
{"openapi":"3.0.3","info":{"title":"API Nova Post — Common","version":"2.0.0"},"tags":[{"name":"CargoDescriptionList","description":"Операції, пов'язані з отриманням описів вантажу"}],"servers":[{"url":"https://api.novaposhta.ua/v2.0/","description":"production"}],"paths":{"/json/":{"post":{"tags":["CargoDescriptionList"],"operationId":"getCargoDescriptionListJson","summary":"Отримати список описів вантажу (JSON)","description":"Метод **getCargoDescriptionList** працює в моделі **Common** (або **CommonGeneral**) \nі дозволяє відобразити опис вантажу українською та російською мовами. \nДоступний пошук за рядками (необов'язковий параметр).\n\nНеобхідно зберігати копію довідників на стороні клієнта та підтримувати її в актуальному стані. \nРекомендується проводити оновлення довідників **раз на місяць**.\n","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCargoDescriptionListJsonRequest"}}}},"responses":{"200":{"description":"Успішна відповідь (JSON)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCargoDescriptionListResponse"}}}}}}}},"components":{"schemas":{"GetCargoDescriptionListJsonRequest":{"type":"object","additionalProperties":false,"required":["apiKey","modelName","calledMethod","methodProperties"],"properties":{"apiKey":{"type":"string","description":"API-ключ користувача"},"modelName":{"type":"string","enum":["CommonGeneral","Common"],"description":"Назва моделі API"},"calledMethod":{"type":"string","enum":["getCargoDescriptionList"],"description":"Назва методу API"},"methodProperties":{"$ref":"#/components/schemas/GetCargoDescriptionListMethodProperties"}}},"GetCargoDescriptionListMethodProperties":{"type":"object","additionalProperties":false,"properties":{"FindByString":{"type":"string","maxLength":36,"description":"Пошук за рядками (наприклад \"абажур\")"},"Page":{"type":"string","maxLength":36,"description":"Номер сторінки (до 500 записів на сторінці)"}}},"GetCargoDescriptionListResponse":{"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/CargoDescriptionListItem"}},"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"}}}},"CargoDescriptionListItem":{"type":"object","additionalProperties":false,"properties":{"Ref":{"type":"string","maxLength":36,"description":"Ідентифікатор"},"Description":{"type":"string","maxLength":36,"description":"Опис українською мовою"},"DescriptionRu":{"type":"string","maxLength":36,"description":"Опис російською мовою"}}}}}}
```

## Отримати список описів вантажу (XML)

> Метод \*\*getCargoDescriptionList\*\* працює в моделі \*\*Common\*\* (або \*\*CommonGeneral\*\*) \
> і дозволяє відобразити опис вантажу українською та російською мовами. \
> Доступний пошук за рядками (необов'язковий параметр).\
> \
> Необхідно зберігати копію довідників на стороні клієнта та підтримувати її в актуальному стані. \
> Рекомендується проводити оновлення довідників \*\*раз на місяць\*\*.<br>

```json
{"openapi":"3.0.3","info":{"title":"API Nova Post — Common","version":"2.0.0"},"tags":[{"name":"CargoDescriptionList","description":"Операції, пов'язані з отриманням описів вантажу"}],"servers":[{"url":"https://api.novaposhta.ua/v2.0/","description":"production"}],"paths":{"/xml/":{"post":{"tags":["CargoDescriptionList"],"operationId":"getCargoDescriptionListXml","summary":"Отримати список описів вантажу (XML)","description":"Метод **getCargoDescriptionList** працює в моделі **Common** (або **CommonGeneral**) \nі дозволяє відобразити опис вантажу українською та російською мовами. \nДоступний пошук за рядками (необов'язковий параметр).\n\nНеобхідно зберігати копію довідників на стороні клієнта та підтримувати її в актуальному стані. \nРекомендується проводити оновлення довідників **раз на місяць**.\n","requestBody":{"required":true,"content":{"application/xml":{"schema":{"$ref":"#/components/schemas/GetCargoDescriptionListXmlRequest"}}}},"responses":{"200":{"description":"Успішна відповідь (XML)","content":{"application/xml":{"schema":{"$ref":"#/components/schemas/GetCargoDescriptionListXmlResponse"}}}}}}}},"components":{"schemas":{"GetCargoDescriptionListXmlRequest":{"type":"object","additionalProperties":false,"xml":{"name":"file"},"required":["apiKey","modelName","calledMethod","methodProperties"],"properties":{"apiKey":{"type":"string","description":"API-ключ користувача"},"modelName":{"type":"string","enum":["CommonGeneral","Common"],"description":"Назва моделі API"},"calledMethod":{"type":"string","enum":["getCargoDescriptionList"],"description":"Назва методу API"},"methodProperties":{"$ref":"#/components/schemas/GetCargoDescriptionListXmlMethodProperties"}}},"GetCargoDescriptionListXmlMethodProperties":{"type":"object","additionalProperties":false,"description":"Властивості методу для XML","xml":{"name":"methodProperties"},"properties":{"FindByString":{"type":"string","maxLength":36,"description":"Пошук за рядками (наприклад \"абажур\")","xml":{"name":"FindByString"}},"Page":{"type":"string","maxLength":36,"description":"Номер сторінки (до 500 записів на сторінці)","xml":{"name":"Page"}}}},"GetCargoDescriptionListXmlResponse":{"type":"object","additionalProperties":false,"xml":{"name":"root"},"required":["success","data","errors","warnings","info","messageCodes","errorCodes","warningCodes","infoCodes"],"properties":{"success":{"type":"boolean","description":"Прапор успішності виконання запиту"},"data":{"$ref":"#/components/schemas/CargoDescriptionListItem","xml":{"name":"data"}},"errors":{"type":"array","description":"Масив повідомлень про помилки","xml":{"name":"errors"},"items":{"type":"string","xml":{"name":"errors"}}},"warnings":{"type":"array","description":"Масив попереджень","xml":{"name":"warnings"},"items":{"type":"string","xml":{"name":"warnings"}}},"info":{"type":"array","description":"Масив інформаційних повідомлень","xml":{"name":"info"},"items":{"type":"string","xml":{"name":"info"}}},"messageCodes":{"type":"array","description":"Масив кодів інформаційних повідомлень","xml":{"name":"messageCodes"},"items":{"type":"string","xml":{"name":"messageCodes"}}},"errorCodes":{"type":"array","description":"Масив кодів помилок","xml":{"name":"errorCodes"},"items":{"type":"string","xml":{"name":"errorCodes"}}},"warningCodes":{"type":"array","description":"Масив кодів попереджень","xml":{"name":"warningCodes"},"items":{"type":"string","xml":{"name":"warningCodes"}}},"infoCodes":{"type":"array","description":"Масив кодів додаткової інформації","xml":{"name":"infoCodes"},"items":{"type":"string","xml":{"name":"infoCodes"}}}}},"CargoDescriptionListItem":{"type":"object","additionalProperties":false,"properties":{"Ref":{"type":"string","maxLength":36,"description":"Ідентифікатор"},"Description":{"type":"string","maxLength":36,"description":"Опис українською мовою"},"DescriptionRu":{"type":"string","maxLength":36,"description":"Опис російською мовою"}}}}}}
```

## Отримати перелік помилок (JSON)

> Метод \*\*getMessageCodeText\*\* працює в моделі \*\*Сommon\*\* (або \*\*CommonGeneral\*\*) \
> і використовується для завантаження довідника з переліком помилок. \
> Метод постійно поповнюється новим описом трьома мовами.\
> \
> Довідник слід завантажувати \*\*один раз на місяць\*\* для оновлення даних.<br>

```json
{"openapi":"3.0.3","info":{"title":"API Nova Post — Common","version":"2.0.0"},"tags":[{"name":"MessageCodeText","description":"Операції, пов'язані з отриманням переліку помилок"}],"servers":[{"url":"https://api.novaposhta.ua/v2.0/","description":"production"}],"paths":{"/json/":{"post":{"tags":["MessageCodeText"],"operationId":"getMessageCodeTextJson","summary":"Отримати перелік помилок (JSON)","description":"Метод **getMessageCodeText** працює в моделі **Сommon** (або **CommonGeneral**) \nі використовується для завантаження довідника з переліком помилок. \nМетод постійно поповнюється новим описом трьома мовами.\n\nДовідник слід завантажувати **один раз на місяць** для оновлення даних.\n","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetMessageCodeTextJsonRequest"}}}},"responses":{"200":{"description":"Успішна відповідь (JSON)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetMessageCodeTextResponse"}}}}}}}},"components":{"schemas":{"GetMessageCodeTextJsonRequest":{"type":"object","additionalProperties":false,"required":["apiKey","modelName","calledMethod","methodProperties"],"properties":{"apiKey":{"type":"string","description":"API-ключ користувача"},"modelName":{"type":"string","enum":["CommonGeneral"],"description":"Назва моделі API"},"calledMethod":{"type":"string","enum":["getMessageCodeText"],"description":"Назва методу API"},"methodProperties":{"$ref":"#/components/schemas/GetMessageCodeTextMethodProperties"}}},"GetMessageCodeTextMethodProperties":{"type":"object","additionalProperties":false,"description":"Властивості методу (порожній об'єкт)"},"GetMessageCodeTextResponse":{"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/MessageCodeTextItem"}},"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"}}}},"MessageCodeTextItem":{"type":"object","additionalProperties":false,"properties":{"MessageCode":{"type":"string","maxLength":36,"description":"Код помилки"},"MessageText":{"type":"string","maxLength":100,"description":"Опис англійською мовою"},"MessageDescriptionRU":{"type":"string","maxLength":100,"description":"Опис російською мовою"},"MessageDescriptionUA":{"type":"string","maxLength":100,"description":"Опис українською мовою"}}}}}}
```

## Отримати перелік помилок (XML)

> Метод \*\*getMessageCodeText\*\* працює в моделі \*\*Сommon\*\* (або \*\*CommonGeneral\*\*) \
> і використовується для завантаження довідника з переліком помилок. \
> Метод постійно поповнюється новим описом трьома мовами.\
> \
> Довідник слід завантажувати \*\*один раз на місяць\*\* для оновлення даних.<br>

```json
{"openapi":"3.0.3","info":{"title":"API Nova Post — Common","version":"2.0.0"},"tags":[{"name":"MessageCodeText","description":"Операції, пов'язані з отриманням переліку помилок"}],"servers":[{"url":"https://api.novaposhta.ua/v2.0/","description":"production"}],"paths":{"/xml/":{"post":{"tags":["MessageCodeText"],"operationId":"getMessageCodeTextXml","summary":"Отримати перелік помилок (XML)","description":"Метод **getMessageCodeText** працює в моделі **Сommon** (або **CommonGeneral**) \nі використовується для завантаження довідника з переліком помилок. \nМетод постійно поповнюється новим описом трьома мовами.\n\nДовідник слід завантажувати **один раз на місяць** для оновлення даних.\n","requestBody":{"required":true,"content":{"application/xml":{"schema":{"$ref":"#/components/schemas/GetMessageCodeTextXmlRequest"}}}},"responses":{"200":{"description":"Успішна відповідь (XML)","content":{"application/xml":{"schema":{"$ref":"#/components/schemas/GetMessageCodeTextXmlResponse"}}}}}}}},"components":{"schemas":{"GetMessageCodeTextXmlRequest":{"type":"object","additionalProperties":false,"xml":{"name":"file"},"required":["apiKey","modelName","calledMethod","methodProperties"],"properties":{"apiKey":{"type":"string","description":"API-ключ користувача"},"modelName":{"type":"string","enum":["CommonGeneral"],"description":"Назва моделі API"},"calledMethod":{"type":"string","enum":["getMessageCodeText"],"description":"Назва методу API"},"methodProperties":{"$ref":"#/components/schemas/GetMessageCodeTextXmlMethodProperties"}}},"GetMessageCodeTextXmlMethodProperties":{"type":"object","additionalProperties":false,"description":"Властивості методу для XML","xml":{"name":"methodProperties"}},"GetMessageCodeTextXmlResponse":{"type":"object","additionalProperties":false,"xml":{"name":"root"},"required":["success","data","errors","warnings","info","messageCodes","errorCodes","warningCodes","infoCodes"],"properties":{"success":{"type":"boolean","description":"Прапор успішності виконання запиту"},"data":{"$ref":"#/components/schemas/MessageCodeTextItem","xml":{"name":"data"}},"errors":{"type":"array","description":"Масив повідомлень про помилки","xml":{"name":"errors"},"items":{"type":"string","xml":{"name":"errors"}}},"warnings":{"type":"array","description":"Масив попереджень","xml":{"name":"warnings"},"items":{"type":"string","xml":{"name":"warnings"}}},"info":{"type":"array","description":"Масив інформаційних повідомлень","xml":{"name":"info"},"items":{"type":"string","xml":{"name":"info"}}},"messageCodes":{"type":"array","description":"Масив кодів інформаційних повідомлень","xml":{"name":"messageCodes"},"items":{"type":"string","xml":{"name":"messageCodes"}}},"errorCodes":{"type":"array","description":"Масив кодів помилок","xml":{"name":"errorCodes"},"items":{"type":"string","xml":{"name":"errorCodes"}}},"warningCodes":{"type":"array","description":"Масив кодів попереджень","xml":{"name":"warningCodes"},"items":{"type":"string","xml":{"name":"warningCodes"}}},"infoCodes":{"type":"array","description":"Масив кодів додаткової інформації","xml":{"name":"infoCodes"},"items":{"type":"string","xml":{"name":"infoCodes"}}}}},"MessageCodeTextItem":{"type":"object","additionalProperties":false,"properties":{"MessageCode":{"type":"string","maxLength":36,"description":"Код помилки"},"MessageText":{"type":"string","maxLength":100,"description":"Опис англійською мовою"},"MessageDescriptionRU":{"type":"string","maxLength":100,"description":"Опис російською мовою"},"MessageDescriptionUA":{"type":"string","maxLength":100,"description":"Опис українською мовою"}}}}}}
```

## Отримати список типів технологій доставки (JSON)

> Метод \*\*getServiceTypes\*\* працює в моделі \*\*Common\*\* (або \*\*CommonGeneral\*\*) \
> і дозволяє завантажити список типів технологій доставки: «склад-склад», «двері-двері», «склад-двері», «двері-склад» українською та російською мовами.\
> \
> Необхідно зберігати копію довідників на стороні клієнта та підтримувати її в актуальному стані. \
> Рекомендується проводити оновлення довідників \*\*раз на місяць\*\*.<br>

```json
{"openapi":"3.0.3","info":{"title":"API Nova Post — Common","version":"2.0.0"},"tags":[{"name":"ServiceTypes","description":"Операції, пов'язані з отриманням типів технологій доставки"}],"servers":[{"url":"https://api.novaposhta.ua/v2.0/","description":"production"}],"paths":{"/json/":{"post":{"tags":["ServiceTypes"],"operationId":"getServiceTypesJson","summary":"Отримати список типів технологій доставки (JSON)","description":"Метод **getServiceTypes** працює в моделі **Common** (або **CommonGeneral**) \nі дозволяє завантажити список типів технологій доставки: «склад-склад», «двері-двері», «склад-двері», «двері-склад» українською та російською мовами.\n\nНеобхідно зберігати копію довідників на стороні клієнта та підтримувати її в актуальному стані. \nРекомендується проводити оновлення довідників **раз на місяць**.\n","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetServiceTypesJsonRequest"}}}},"responses":{"200":{"description":"Успішна відповідь (JSON)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetServiceTypesResponse"}}}}}}}},"components":{"schemas":{"GetServiceTypesJsonRequest":{"type":"object","additionalProperties":false,"required":["apiKey","modelName","calledMethod","methodProperties"],"properties":{"apiKey":{"type":"string","description":"API-ключ користувача"},"modelName":{"type":"string","enum":["CommonGeneral","Common"],"description":"Назва моделі API"},"calledMethod":{"type":"string","enum":["getServiceTypes"],"description":"Назва методу API"},"methodProperties":{"$ref":"#/components/schemas/GetServiceTypesMethodProperties"}}},"GetServiceTypesMethodProperties":{"type":"object","additionalProperties":false,"description":"Властивості методу (порожній об'єкт)"},"GetServiceTypesResponse":{"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/ServiceTypeItem"}},"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"}}}},"ServiceTypeItem":{"type":"object","additionalProperties":false,"properties":{"Ref":{"type":"string","maxLength":36,"description":"Ідентифікатор технології доставки"},"Description":{"type":"string","maxLength":36,"description":"Опис"}}}}}}
```

## Отримати список типів технологій доставки (XML)

> Метод \*\*getServiceTypes\*\* працює в моделі \*\*Common\*\* (або \*\*CommonGeneral\*\*) \
> і дозволяє завантажити список типів технологій доставки: «склад-склад», «двері-двері», «склад-двері», «двері-склад» українською та російською мовами.\
> \
> Необхідно зберігати копію довідників на стороні клієнта та підтримувати її в актуальному стані. \
> Рекомендується проводити оновлення довідників \*\*раз на місяць\*\*.<br>

```json
{"openapi":"3.0.3","info":{"title":"API Nova Post — Common","version":"2.0.0"},"tags":[{"name":"ServiceTypes","description":"Операції, пов'язані з отриманням типів технологій доставки"}],"servers":[{"url":"https://api.novaposhta.ua/v2.0/","description":"production"}],"paths":{"/xml/":{"post":{"tags":["ServiceTypes"],"operationId":"getServiceTypesXml","summary":"Отримати список типів технологій доставки (XML)","description":"Метод **getServiceTypes** працює в моделі **Common** (або **CommonGeneral**) \nі дозволяє завантажити список типів технологій доставки: «склад-склад», «двері-двері», «склад-двері», «двері-склад» українською та російською мовами.\n\nНеобхідно зберігати копію довідників на стороні клієнта та підтримувати її в актуальному стані. \nРекомендується проводити оновлення довідників **раз на місяць**.\n","requestBody":{"required":true,"content":{"application/xml":{"schema":{"$ref":"#/components/schemas/GetServiceTypesXmlRequest"}}}},"responses":{"200":{"description":"Успішна відповідь (XML)","content":{"application/xml":{"schema":{"$ref":"#/components/schemas/GetServiceTypesXmlResponse"}}}}}}}},"components":{"schemas":{"GetServiceTypesXmlRequest":{"type":"object","additionalProperties":false,"xml":{"name":"file"},"required":["apiKey","modelName","calledMethod","methodProperties"],"properties":{"apiKey":{"type":"string","description":"API-ключ користувача"},"modelName":{"type":"string","enum":["CommonGeneral","Common"],"description":"Назва моделі API"},"calledMethod":{"type":"string","enum":["getServiceTypes"],"description":"Назва методу API"},"methodProperties":{"$ref":"#/components/schemas/GetServiceTypesXmlMethodProperties"}}},"GetServiceTypesXmlMethodProperties":{"type":"object","additionalProperties":false,"description":"Властивості методу для XML","xml":{"name":"methodProperties"}},"GetServiceTypesXmlResponse":{"type":"object","additionalProperties":false,"xml":{"name":"root"},"required":["success","data","errors","warnings","info","messageCodes","errorCodes","warningCodes","infoCodes"],"properties":{"success":{"type":"boolean","description":"Прапор успішності виконання запиту"},"data":{"$ref":"#/components/schemas/ServiceTypeItem","xml":{"name":"data"}},"errors":{"type":"array","description":"Масив повідомлень про помилки","xml":{"name":"errors"},"items":{"type":"string","xml":{"name":"errors"}}},"warnings":{"type":"array","description":"Масив попереджень","xml":{"name":"warnings"},"items":{"type":"string","xml":{"name":"warnings"}}},"info":{"type":"array","description":"Масив інформаційних повідомлень","xml":{"name":"info"},"items":{"type":"string","xml":{"name":"info"}}},"messageCodes":{"type":"array","description":"Масив кодів інформаційних повідомлень","xml":{"name":"messageCodes"},"items":{"type":"string","xml":{"name":"messageCodes"}}},"errorCodes":{"type":"array","description":"Масив кодів помилок","xml":{"name":"errorCodes"},"items":{"type":"string","xml":{"name":"errorCodes"}}},"warningCodes":{"type":"array","description":"Масив кодів попереджень","xml":{"name":"warningCodes"},"items":{"type":"string","xml":{"name":"warningCodes"}}},"infoCodes":{"type":"array","description":"Масив кодів додаткової інформації","xml":{"name":"infoCodes"},"items":{"type":"string","xml":{"name":"infoCodes"}}}}},"ServiceTypeItem":{"type":"object","additionalProperties":false,"properties":{"Ref":{"type":"string","maxLength":36,"description":"Ідентифікатор технології доставки"},"Description":{"type":"string","maxLength":36,"description":"Опис"}}}}}}
```

## Отримати список типів контрагентів (JSON)

> Метод \*\*getTypesOfCounterparties\*\* працює в моделі \*\*Common\*\* (або \*\*CommonGeneral\*\*) \
> і дозволяє завантажити список типів контрагентів українською та російською мовами.\
> \
> Необхідно зберігати копію довідників на стороні клієнта та підтримувати її в актуальному стані. \
> Рекомендується проводити оновлення довідників \*\*раз на місяць\*\*.<br>

```json
{"openapi":"3.0.3","info":{"title":"API Nova Post — Common","version":"2.0.0"},"tags":[{"name":"TypesOfCounterparties","description":"Операції, пов'язані з отриманням типів контрагентів"}],"servers":[{"url":"https://api.novaposhta.ua/v2.0/","description":"production"}],"paths":{"/json/":{"post":{"tags":["TypesOfCounterparties"],"operationId":"getTypesOfCounterpartiesJson","summary":"Отримати список типів контрагентів (JSON)","description":"Метод **getTypesOfCounterparties** працює в моделі **Common** (або **CommonGeneral**) \nі дозволяє завантажити список типів контрагентів українською та російською мовами.\n\nНеобхідно зберігати копію довідників на стороні клієнта та підтримувати її в актуальному стані. \nРекомендується проводити оновлення довідників **раз на місяць**.\n","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetTypesOfCounterpartiesJsonRequest"}}}},"responses":{"200":{"description":"Успішна відповідь (JSON)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetTypesOfCounterpartiesResponse"}}}}}}}},"components":{"schemas":{"GetTypesOfCounterpartiesJsonRequest":{"type":"object","additionalProperties":false,"required":["apiKey","modelName","calledMethod","methodProperties"],"properties":{"apiKey":{"type":"string","description":"API-ключ користувача"},"modelName":{"type":"string","enum":["CommonGeneral","Common"],"description":"Назва моделі API"},"calledMethod":{"type":"string","enum":["getTypesOfCounterparties"],"description":"Назва методу API"},"methodProperties":{"$ref":"#/components/schemas/GetTypesOfCounterpartiesMethodProperties"}}},"GetTypesOfCounterpartiesMethodProperties":{"type":"object","additionalProperties":false,"description":"Властивості методу (порожній об'єкт)"},"GetTypesOfCounterpartiesResponse":{"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/TypeOfCounterpartyItem"}},"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"}}}},"TypeOfCounterpartyItem":{"type":"object","additionalProperties":false,"properties":{"Ref":{"type":"string","maxLength":36,"description":"Ідентифікатор типу контрагента (наприклад, Organization/PrivatePerson)"},"Description":{"type":"string","maxLength":36,"description":"Опис"}}}}}}
```

## Отримати список типів контрагентів (XML)

> Метод \*\*getTypesOfCounterparties\*\* працює в моделі \*\*Common\*\* (або \*\*CommonGeneral\*\*) \
> і дозволяє завантажити список типів контрагентів українською та російською мовами.\
> \
> Необхідно зберігати копію довідників на стороні клієнта та підтримувати її в актуальному стані. \
> Рекомендується проводити оновлення довідників \*\*раз на місяць\*\*.<br>

```json
{"openapi":"3.0.3","info":{"title":"API Nova Post — Common","version":"2.0.0"},"tags":[{"name":"TypesOfCounterparties","description":"Операції, пов'язані з отриманням типів контрагентів"}],"servers":[{"url":"https://api.novaposhta.ua/v2.0/","description":"production"}],"paths":{"/xml/":{"post":{"tags":["TypesOfCounterparties"],"operationId":"getTypesOfCounterpartiesXml","summary":"Отримати список типів контрагентів (XML)","description":"Метод **getTypesOfCounterparties** працює в моделі **Common** (або **CommonGeneral**) \nі дозволяє завантажити список типів контрагентів українською та російською мовами.\n\nНеобхідно зберігати копію довідників на стороні клієнта та підтримувати її в актуальному стані. \nРекомендується проводити оновлення довідників **раз на місяць**.\n","requestBody":{"required":true,"content":{"application/xml":{"schema":{"$ref":"#/components/schemas/GetTypesOfCounterpartiesXmlRequest"}}}},"responses":{"200":{"description":"Успішна відповідь (XML)","content":{"application/xml":{"schema":{"$ref":"#/components/schemas/GetTypesOfCounterpartiesXmlResponse"}}}}}}}},"components":{"schemas":{"GetTypesOfCounterpartiesXmlRequest":{"type":"object","additionalProperties":false,"xml":{"name":"file"},"required":["apiKey","modelName","calledMethod","methodProperties"],"properties":{"apiKey":{"type":"string","description":"API-ключ користувача"},"modelName":{"type":"string","enum":["CommonGeneral","Common"],"description":"Назва моделі API"},"calledMethod":{"type":"string","enum":["getTypesOfCounterparties"],"description":"Назва методу API"},"methodProperties":{"$ref":"#/components/schemas/GetTypesOfCounterpartiesXmlMethodProperties"}}},"GetTypesOfCounterpartiesXmlMethodProperties":{"type":"object","additionalProperties":false,"description":"Властивості методу для XML","xml":{"name":"methodProperties"}},"GetTypesOfCounterpartiesXmlResponse":{"type":"object","additionalProperties":false,"xml":{"name":"root"},"required":["success","data","errors","warnings","info","messageCodes","errorCodes","warningCodes","infoCodes"],"properties":{"success":{"type":"boolean","description":"Прапор успішності виконання запиту"},"data":{"$ref":"#/components/schemas/TypeOfCounterpartyItem","xml":{"name":"data"}},"errors":{"type":"array","description":"Масив повідомлень про помилки","xml":{"name":"errors"},"items":{"type":"string","xml":{"name":"errors"}}},"warnings":{"type":"array","description":"Масив попереджень","xml":{"name":"warnings"},"items":{"type":"string","xml":{"name":"warnings"}}},"info":{"type":"array","description":"Масив інформаційних повідомлень","xml":{"name":"info"},"items":{"type":"string","xml":{"name":"info"}}},"messageCodes":{"type":"array","description":"Масив кодів інформаційних повідомлень","xml":{"name":"messageCodes"},"items":{"type":"string","xml":{"name":"messageCodes"}}},"errorCodes":{"type":"array","description":"Масив кодів помилок","xml":{"name":"errorCodes"},"items":{"type":"string","xml":{"name":"errorCodes"}}},"warningCodes":{"type":"array","description":"Масив кодів попереджень","xml":{"name":"warningCodes"},"items":{"type":"string","xml":{"name":"warningCodes"}}},"infoCodes":{"type":"array","description":"Масив кодів додаткової інформації","xml":{"name":"infoCodes"},"items":{"type":"string","xml":{"name":"infoCodes"}}}}},"TypeOfCounterpartyItem":{"type":"object","additionalProperties":false,"properties":{"Ref":{"type":"string","maxLength":36,"description":"Ідентифікатор типу контрагента (наприклад, Organization/PrivatePerson)"},"Description":{"type":"string","maxLength":36,"description":"Опис"}}}}}}
```

## Отримати список форм оплати (JSON)

> Метод \*\*getPaymentForms\*\* працює в моделі \*\*Common\*\* (або \*\*CommonGeneral\*\*) \
> і дозволяє завантажити список форм оплати українською та російською мовами.\
> \
> Оплачувати послуги доставки за допомогою безготівкового розрахунку можуть клієнти, \
> які уклали договір із компанією «Нова пошта».\
> \
> Необхідно зберігати копію довідників на стороні клієнта та підтримувати її в актуальному стані. \
> Рекомендується проводити оновлення довідників \*\*раз на місяць\*\*.<br>

```json
{"openapi":"3.0.3","info":{"title":"API Nova Post — Common","version":"2.0.0"},"tags":[{"name":"PaymentForms","description":"Операції, пов'язані з отриманням форм оплати"}],"servers":[{"url":"https://api.novaposhta.ua/v2.0/","description":"production"}],"paths":{"/json/":{"post":{"tags":["PaymentForms"],"operationId":"getPaymentFormsJson","summary":"Отримати список форм оплати (JSON)","description":"Метод **getPaymentForms** працює в моделі **Common** (або **CommonGeneral**) \nі дозволяє завантажити список форм оплати українською та російською мовами.\n\nОплачувати послуги доставки за допомогою безготівкового розрахунку можуть клієнти, \nякі уклали договір із компанією «Нова пошта».\n\nНеобхідно зберігати копію довідників на стороні клієнта та підтримувати її в актуальному стані. \nРекомендується проводити оновлення довідників **раз на місяць**.\n","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetPaymentFormsJsonRequest"}}}},"responses":{"200":{"description":"Успішна відповідь (JSON)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetPaymentFormsResponse"}}}}}}}},"components":{"schemas":{"GetPaymentFormsJsonRequest":{"type":"object","additionalProperties":false,"required":["apiKey","modelName","calledMethod","methodProperties"],"properties":{"apiKey":{"type":"string","description":"API-ключ користувача"},"modelName":{"type":"string","enum":["CommonGeneral","Common"],"description":"Назва моделі API"},"calledMethod":{"type":"string","enum":["getPaymentForms"],"description":"Назва методу API"},"methodProperties":{"$ref":"#/components/schemas/GetPaymentFormsMethodProperties"}}},"GetPaymentFormsMethodProperties":{"type":"object","additionalProperties":false,"description":"Властивості методу (порожній об'єкт)"},"GetPaymentFormsResponse":{"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/PaymentFormItem"}},"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"}}}},"PaymentFormItem":{"type":"object","additionalProperties":false,"properties":{"Ref":{"type":"string","maxLength":36,"description":"Ідентифікатор форми оплати (наприклад, NonCash/Cash)"},"Description":{"type":"string","maxLength":36,"description":"Опис"}}}}}}
```

## Отримати список форм оплати (XML)

> Метод \*\*getPaymentForms\*\* працює в моделі \*\*Common\*\* (або \*\*CommonGeneral\*\*) \
> і дозволяє завантажити список форм оплати українською та російською мовами.\
> \
> Оплачувати послуги доставки за допомогою безготівкового розрахунку можуть клієнти, \
> які уклали договір із компанією «Нова пошта».\
> \
> Необхідно зберігати копію довідників на стороні клієнта та підтримувати її в актуальному стані. \
> Рекомендується проводити оновлення довідників \*\*раз на місяць\*\*.<br>

```json
{"openapi":"3.0.3","info":{"title":"API Nova Post — Common","version":"2.0.0"},"tags":[{"name":"PaymentForms","description":"Операції, пов'язані з отриманням форм оплати"}],"servers":[{"url":"https://api.novaposhta.ua/v2.0/","description":"production"}],"paths":{"/xml/":{"post":{"tags":["PaymentForms"],"operationId":"getPaymentFormsXml","summary":"Отримати список форм оплати (XML)","description":"Метод **getPaymentForms** працює в моделі **Common** (або **CommonGeneral**) \nі дозволяє завантажити список форм оплати українською та російською мовами.\n\nОплачувати послуги доставки за допомогою безготівкового розрахунку можуть клієнти, \nякі уклали договір із компанією «Нова пошта».\n\nНеобхідно зберігати копію довідників на стороні клієнта та підтримувати її в актуальному стані. \nРекомендується проводити оновлення довідників **раз на місяць**.\n","requestBody":{"required":true,"content":{"application/xml":{"schema":{"$ref":"#/components/schemas/GetPaymentFormsXmlRequest"}}}},"responses":{"200":{"description":"Успішна відповідь (XML)","content":{"application/xml":{"schema":{"$ref":"#/components/schemas/GetPaymentFormsXmlResponse"}}}}}}}},"components":{"schemas":{"GetPaymentFormsXmlRequest":{"type":"object","additionalProperties":false,"xml":{"name":"file"},"required":["apiKey","modelName","calledMethod","methodProperties"],"properties":{"apiKey":{"type":"string","description":"API-ключ користувача"},"modelName":{"type":"string","enum":["CommonGeneral","Common"],"description":"Назва моделі API"},"calledMethod":{"type":"string","enum":["getPaymentForms"],"description":"Назва методу API"},"methodProperties":{"$ref":"#/components/schemas/GetPaymentFormsXmlMethodProperties"}}},"GetPaymentFormsXmlMethodProperties":{"type":"object","additionalProperties":false,"description":"Властивості методу для XML","xml":{"name":"methodProperties"}},"GetPaymentFormsXmlResponse":{"type":"object","additionalProperties":false,"xml":{"name":"root"},"required":["success","data","errors","warnings","info","messageCodes","errorCodes","warningCodes","infoCodes"],"properties":{"success":{"type":"boolean","description":"Прапор успішності виконання запиту"},"data":{"$ref":"#/components/schemas/PaymentFormItem","xml":{"name":"data"}},"errors":{"type":"array","description":"Масив повідомлень про помилки","xml":{"name":"errors"},"items":{"type":"string","xml":{"name":"errors"}}},"warnings":{"type":"array","description":"Масив попереджень","xml":{"name":"warnings"},"items":{"type":"string","xml":{"name":"warnings"}}},"info":{"type":"array","description":"Масив інформаційних повідомлень","xml":{"name":"info"},"items":{"type":"string","xml":{"name":"info"}}},"messageCodes":{"type":"array","description":"Масив кодів інформаційних повідомлень","xml":{"name":"messageCodes"},"items":{"type":"string","xml":{"name":"messageCodes"}}},"errorCodes":{"type":"array","description":"Масив кодів помилок","xml":{"name":"errorCodes"},"items":{"type":"string","xml":{"name":"errorCodes"}}},"warningCodes":{"type":"array","description":"Масив кодів попереджень","xml":{"name":"warningCodes"},"items":{"type":"string","xml":{"name":"warningCodes"}}},"infoCodes":{"type":"array","description":"Масив кодів додаткової інформації","xml":{"name":"infoCodes"},"items":{"type":"string","xml":{"name":"infoCodes"}}}}},"PaymentFormItem":{"type":"object","additionalProperties":false,"properties":{"Ref":{"type":"string","maxLength":36,"description":"Ідентифікатор форми оплати (наприклад, NonCash/Cash)"},"Description":{"type":"string","maxLength":36,"description":"Опис"}}}}}}
```

## Отримати список форм власності (JSON)

> Метод \*\*getOwnershipFormsList\*\* працює в моделі \*\*Common\*\* (або \*\*CommonGeneral\*\*) \
> і дозволяє завантажити список форм власності українською мовою.\
> \
> Необхідно зберігати копію довідників на стороні клієнта та підтримувати її в актуальному стані. \
> Рекомендується проводити оновлення довідників \*\*раз на місяць\*\*.<br>

```json
{"openapi":"3.0.3","info":{"title":"API Nova Post — Common","version":"2.0.0"},"tags":[{"name":"OwnershipForms","description":"Операції, пов'язані з отриманням форм власності"}],"servers":[{"url":"https://api.novaposhta.ua/v2.0/","description":"production"}],"paths":{"/json/":{"post":{"tags":["OwnershipForms"],"operationId":"getOwnershipFormsListJson","summary":"Отримати список форм власності (JSON)","description":"Метод **getOwnershipFormsList** працює в моделі **Common** (або **CommonGeneral**) \nі дозволяє завантажити список форм власності українською мовою.\n\nНеобхідно зберігати копію довідників на стороні клієнта та підтримувати її в актуальному стані. \nРекомендується проводити оновлення довідників **раз на місяць**.\n","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetOwnershipFormsListJsonRequest"}}}},"responses":{"200":{"description":"Успішна відповідь (JSON)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetOwnershipFormsListResponse"}}}}}}}},"components":{"schemas":{"GetOwnershipFormsListJsonRequest":{"type":"object","additionalProperties":false,"required":["apiKey","modelName","calledMethod","methodProperties"],"properties":{"apiKey":{"type":"string","description":"API-ключ користувача"},"modelName":{"type":"string","enum":["CommonGeneral","Common"],"description":"Назва моделі API"},"calledMethod":{"type":"string","enum":["getOwnershipFormsList"],"description":"Назва методу API"},"methodProperties":{"$ref":"#/components/schemas/GetOwnershipFormsListMethodProperties"}}},"GetOwnershipFormsListMethodProperties":{"type":"object","additionalProperties":false,"description":"Властивості методу (порожній об'єкт)"},"GetOwnershipFormsListResponse":{"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/OwnershipFormItem"}},"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"}}}},"OwnershipFormItem":{"type":"object","additionalProperties":false,"properties":{"Ref":{"type":"string","maxLength":36,"description":"Ідентифікатор форми власності"},"Description":{"type":"string","maxLength":36,"description":"Опис"},"FullName":{"type":"string","maxLength":36,"description":"Найменування форми власності"}}}}}}
```

## Отримати список форм власності (XML)

> Метод \*\*getOwnershipFormsList\*\* працює в моделі \*\*Common\*\* (або \*\*CommonGeneral\*\*) \
> і дозволяє завантажити список форм власності українською мовою.\
> \
> Необхідно зберігати копію довідників на стороні клієнта та підтримувати її в актуальному стані. \
> Рекомендується проводити оновлення довідників \*\*раз на місяць\*\*.<br>

```json
{"openapi":"3.0.3","info":{"title":"API Nova Post — Common","version":"2.0.0"},"tags":[{"name":"OwnershipForms","description":"Операції, пов'язані з отриманням форм власності"}],"servers":[{"url":"https://api.novaposhta.ua/v2.0/","description":"production"}],"paths":{"/xml/":{"post":{"tags":["OwnershipForms"],"operationId":"getOwnershipFormsListXml","summary":"Отримати список форм власності (XML)","description":"Метод **getOwnershipFormsList** працює в моделі **Common** (або **CommonGeneral**) \nі дозволяє завантажити список форм власності українською мовою.\n\nНеобхідно зберігати копію довідників на стороні клієнта та підтримувати її в актуальному стані. \nРекомендується проводити оновлення довідників **раз на місяць**.\n","requestBody":{"required":true,"content":{"application/xml":{"schema":{"$ref":"#/components/schemas/GetOwnershipFormsListXmlRequest"}}}},"responses":{"200":{"description":"Успішна відповідь (XML)","content":{"application/xml":{"schema":{"$ref":"#/components/schemas/GetOwnershipFormsListXmlResponse"}}}}}}}},"components":{"schemas":{"GetOwnershipFormsListXmlRequest":{"type":"object","additionalProperties":false,"xml":{"name":"file"},"required":["apiKey","modelName","calledMethod","methodProperties"],"properties":{"apiKey":{"type":"string","description":"API-ключ користувача"},"modelName":{"type":"string","enum":["CommonGeneral","Common"],"description":"Назва моделі API"},"calledMethod":{"type":"string","enum":["getOwnershipFormsList"],"description":"Назва методу API"},"methodProperties":{"$ref":"#/components/schemas/GetOwnershipFormsListXmlMethodProperties"}}},"GetOwnershipFormsListXmlMethodProperties":{"type":"object","additionalProperties":false,"description":"Властивості методу для XML","xml":{"name":"methodProperties"}},"GetOwnershipFormsListXmlResponse":{"type":"object","additionalProperties":false,"xml":{"name":"root"},"required":["success","data","errors","warnings","info","messageCodes","errorCodes","warningCodes","infoCodes"],"properties":{"success":{"type":"boolean","description":"Прапор успішності виконання запиту"},"data":{"$ref":"#/components/schemas/OwnershipFormItem","xml":{"name":"data"}},"errors":{"type":"array","description":"Масив повідомлень про помилки","xml":{"name":"errors"},"items":{"type":"string","xml":{"name":"errors"}}},"warnings":{"type":"array","description":"Масив попереджень","xml":{"name":"warnings"},"items":{"type":"string","xml":{"name":"warnings"}}},"info":{"type":"array","description":"Масив інформаційних повідомлень","xml":{"name":"info"},"items":{"type":"string","xml":{"name":"info"}}},"messageCodes":{"type":"array","description":"Масив кодів інформаційних повідомлень","xml":{"name":"messageCodes"},"items":{"type":"string","xml":{"name":"messageCodes"}}},"errorCodes":{"type":"array","description":"Масив кодів помилок","xml":{"name":"errorCodes"},"items":{"type":"string","xml":{"name":"errorCodes"}}},"warningCodes":{"type":"array","description":"Масив кодів попереджень","xml":{"name":"warningCodes"},"items":{"type":"string","xml":{"name":"warningCodes"}}},"infoCodes":{"type":"array","description":"Масив кодів додаткової інформації","xml":{"name":"infoCodes"},"items":{"type":"string","xml":{"name":"infoCodes"}}}}},"OwnershipFormItem":{"type":"object","additionalProperties":false,"properties":{"Ref":{"type":"string","maxLength":36,"description":"Ідентифікатор форми власності"},"Description":{"type":"string","maxLength":36,"description":"Опис"},"FullName":{"type":"string","maxLength":36,"description":"Найменування форми власності"}}}}}}
```

## Отримати інформацію про паковання (JSON)

> Метод \*\*getPackListSpecial\*\* працює в моделі \*\*CommonGeneral\*\*.\
> \
> Метод відображає ідентифікатори, необхідні для створення ЕН із послугою пакування. Детальніше — «Cтворити ЕН із додатковими послугами» (метод \*\*save\*\* моделі \*\*InternetDocument\*\*).\
> \
> Окремо можна отримати ідентифікатори для послуги «Пакування в поштоматі» (див. «Створити експрес-накладну з поштомата», метод \*\*save\*\* моделі \*\*InternetDocument\*\*). Для цього в параметрі запиту \`SendingFrom\` потрібно задати значення \`Postomat\`. У значенні параметра \`New\` cлід установити \`1\`.<br>

```json
{"openapi":"3.0.3","info":{"title":"API Nova Post — CommonGeneral","version":"2.0.0"},"tags":[{"name":"PackListSpecial","description":"Операції, пов'язані з отриманням інформації про паковання"}],"servers":[{"url":"https://api.novaposhta.ua/v2.0/","description":"production"}],"paths":{"/json/":{"post":{"tags":["PackListSpecial"],"operationId":"getPackListSpecialJson","summary":"Отримати інформацію про паковання (JSON)","description":"Метод **getPackListSpecial** працює в моделі **CommonGeneral**.\n\nМетод відображає ідентифікатори, необхідні для створення ЕН із послугою пакування. Детальніше — «Cтворити ЕН із додатковими послугами» (метод **save** моделі **InternetDocument**).\n\nОкремо можна отримати ідентифікатори для послуги «Пакування в поштоматі» (див. «Створити експрес-накладну з поштомата», метод **save** моделі **InternetDocument**). Для цього в параметрі запиту `SendingFrom` потрібно задати значення `Postomat`. У значенні параметра `New` cлід установити `1`.\n","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetPackListSpecialJsonRequest"}}}},"responses":{"200":{"description":"Успішна відповідь (JSON)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetPackListSpecialResponse"}}}}}}}},"components":{"schemas":{"GetPackListSpecialJsonRequest":{"type":"object","additionalProperties":false,"required":["apiKey","modelName","calledMethod","methodProperties"],"properties":{"apiKey":{"type":"string","description":"API-ключ користувача"},"modelName":{"type":"string","enum":["CommonGeneral"],"description":"Назва моделі API"},"calledMethod":{"type":"string","enum":["getPackListSpecial"],"description":"Назва методу API"},"methodProperties":{"$ref":"#/components/schemas/GetPackListSpecialMethodProperties"}}},"GetPackListSpecialMethodProperties":{"type":"object","additionalProperties":false,"properties":{"Length":{"type":"string","maxLength":36,"description":"Довжина відправлення, см"},"PackForSale":{"type":"string","maxLength":36,"enum":["0","1"],"description":"Ціна пакування (`1` — відображається, `0` — не відображається)"},"Height":{"type":"string","maxLength":36,"description":"Висота відправлення, см"},"CargoType":{"type":"string","maxLength":36,"description":"Тип вантажу (`Parcel`, `Cargo`, `Documents` тощо).\nОсобливості:\n- Якщо метод працює в спеціальному режимі (`New`=`1`), пакування недоступне для вантажів типу `Cargo`, `TiresWheels` та `Pallet`.\n- Якщо метод працює в стандартному режимі (`New`=`0`), пакування для документів відображається лише для вантажів типу `Documents`. У разі відправлення інших типів вантажу пакування для документів не включається до вибірки.\n"},"VolumetricWeight":{"type":"string","maxLength":36,"description":"Об’ємна вага відправлення, кг"},"Width":{"type":"string","maxLength":36,"description":"Ширина відправлення, см"},"New":{"type":"string","maxLength":36,"enum":["0","1"],"description":"Спеціальний режим вибору паковання:\n`0` aбо пусте значення — використовується стандартний режим вибору паковання за габаритами. Відповідь на стандартний запит містить основний перелік (масив `Filtered`), а також додаткові паковання, які не пройшли частину фільтрів (масив `Common`).\n`1` — застосовується спеціальний режим вибору паковання (наприклад, для відправлень із поштоматів). Відповідь на спеціальний запит містить лише основний перелік паковань, які відповідають фільтрам (масив `Filtered`).\n"},"SendingFrom":{"type":"string","maxLength":36,"enum":["Postomat","Doors","Warehouse"],"description":"Тип точки відправлення. Зазначається лише, якщо ввімкнуто спеціальний режим вибірки (`New`=`1`). Можливі типи:\n- Поштомат (`Postomat`)\n- Адреса (`Doors`)\n- Відділення (`Warehouse`)\n"}}},"GetPackListSpecialResponse":{"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/PackDataGroup"}},"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"}}}},"PackDataGroup":{"type":"object","additionalProperties":false,"properties":{"Filtered":{"type":"array","description":"Основний перелік паковань, відібраних за фільтрами","items":{"$ref":"#/components/schemas/PackItem"}},"Common":{"type":"array","description":"Додаткові паковання, які не пройшли частину фільтрів (повертається у стандартному режимі `New`=`0`)","items":{"$ref":"#/components/schemas/PackItem"}}}},"PackItem":{"type":"object","additionalProperties":false,"properties":{"Ref":{"type":"string","maxLength":36,"description":"Ідентифікатор паковання"},"Description":{"type":"string","description":"Опис паковання"},"DescriptionRu":{"type":"string","description":"Опис паковання російською"},"Length":{"type":"string","description":"Довжина відправлення, см (у разі пакування із поштомата дані не передаються)"},"Width":{"type":"string","description":"Ширина відправлення, см (у разі пакування із поштомата дані не передаються)"},"Height":{"type":"string","description":"Висота відправлення, см (у разі пакування із поштомата дані не передаються)"},"VolumetricWeight":{"type":"string","description":"Об'ємна вага, кг (у разі пакування із поштомата дані не передаються)"},"TypeOfPacking":{"type":"string","description":"Тип паковання"},"PackagingForPlace":{"type":"string","description":"Ознака паковання для одного місця"}}}}}}
```

## Отримати інформацію про паковання (XML)

> Метод \*\*getPackListSpecial\*\* працює в моделі \*\*CommonGeneral\*\*.\
> \
> Метод відображає ідентифікатори, необхідні для створення ЕН із послугою пакування. Детальніше — «Cтворити ЕН із додатковими послугами» (метод \*\*save\*\* моделі \*\*InternetDocument\*\*).\
> Окремо можна отримати ідентифікатори для послуги «Пакування в поштоматі» (див. «Створити експрес-накладну з поштомата», метод \*\*save\*\* моделі \*\*InternetDocument\*\*). Для цього в параметрі запиту \`SendingFrom\` потрібно задати значення \`Postomat\`. У значенні параметра \`New\` cлід установити \`1\`.<br>

```json
{"openapi":"3.0.3","info":{"title":"API Nova Post — CommonGeneral","version":"2.0.0"},"tags":[{"name":"PackListSpecial","description":"Операції, пов'язані з отриманням інформації про паковання"}],"servers":[{"url":"https://api.novaposhta.ua/v2.0/","description":"production"}],"paths":{"/xml/":{"post":{"tags":["PackListSpecial"],"operationId":"getPackListSpecialXml","summary":"Отримати інформацію про паковання (XML)","description":"Метод **getPackListSpecial** працює в моделі **CommonGeneral**.\n\nМетод відображає ідентифікатори, необхідні для створення ЕН із послугою пакування. Детальніше — «Cтворити ЕН із додатковими послугами» (метод **save** моделі **InternetDocument**).\nОкремо можна отримати ідентифікатори для послуги «Пакування в поштоматі» (див. «Створити експрес-накладну з поштомата», метод **save** моделі **InternetDocument**). Для цього в параметрі запиту `SendingFrom` потрібно задати значення `Postomat`. У значенні параметра `New` cлід установити `1`.\n","requestBody":{"required":true,"content":{"application/xml":{"schema":{"$ref":"#/components/schemas/GetPackListSpecialXmlRequest"}}}},"responses":{"200":{"description":"Успішна відповідь (XML)","content":{"application/xml":{"schema":{"$ref":"#/components/schemas/GetPackListSpecialXmlResponse"}}}}}}}},"components":{"schemas":{"GetPackListSpecialXmlRequest":{"type":"object","additionalProperties":false,"xml":{"name":"file"},"required":["apiKey","modelName","calledMethod","methodProperties"],"properties":{"apiKey":{"type":"string","description":"API-ключ користувача"},"modelName":{"type":"string","enum":["CommonGeneral"],"description":"Назва моделі API"},"calledMethod":{"type":"string","enum":["getPackListSpecial"],"description":"Назва методу API"},"methodProperties":{"$ref":"#/components/schemas/GetPackListSpecialXmlMethodProperties"}}},"GetPackListSpecialXmlMethodProperties":{"type":"object","additionalProperties":false,"xml":{"name":"methodProperties"},"properties":{"Length":{"type":"string","description":"Довжина відправлення, см"},"PackForSale":{"type":"string","description":"Ціна пакування (`1` — відображається, `0` — не відображається)"},"Height":{"type":"string","description":"Висота відправлення, см"},"CargoType":{"type":"string","description":"Тип вантажу (`Parcel`, `Cargo`, `Documents` тощо).\nОсобливості:\n- Якщо метод працює в спеціальному режимі (`New`=`1`), пакування недоступне для вантажів типу `Cargo`, `TiresWheels` та `Pallet`.\n- Якщо метод працює в стандартному режимі (`New`=`0`), пакування для документів відображається лише для вантажів типу `Documents`. У разі відправлення інших типів вантажу пакування для документів не включається до вибірки.\n"},"VolumetricWeight":{"type":"string","description":"Об’ємна вага відправлення, кг"},"Width":{"type":"string","description":"Ширина відправлення, см"},"New":{"type":"string","description":"Спеціальний режим вибору паковання:\n`0` aбо пусте значення — використовується стандартний режим вибору паковання за габаритами. Відповідь на стандартний запит містить основний перелік (масив `Filtered`), а також додаткові паковання, які не пройшли частину фільтрів (масив `Common`).\n`1` — застосовується спеціальний режим вибору паковання (наприклад, для відправлень із поштоматів). Відповідь на спеціальний запит містить лише основний перелік паковань, які відповідають фільтрам (масив `Filtered`).\n"},"SendingFrom":{"type":"string","description":"Тип точки відправлення. Зазначається лише, якщо ввімкнуто спеціальний режим вибірки (`New`=`1`). Можливі типи:\n- Поштомат (`Postomat`)\n- Адреса (`Doors`)\n- Відділення (`Warehouse`)\n"}}},"GetPackListSpecialXmlResponse":{"type":"object","additionalProperties":false,"xml":{"name":"root"},"required":["success","data","errors","warnings","info","messageCodes","errorCodes","warningCodes","infoCodes"],"properties":{"success":{"type":"boolean","description":"Прапор успішності виконання запиту"},"data":{"$ref":"#/components/schemas/PackDataGroupXml","xml":{"name":"data"}},"errors":{"type":"array","description":"Масив повідомлень про помилки","xml":{"name":"errors"},"items":{"type":"string","xml":{"name":"errors"}}},"warnings":{"type":"array","description":"Масив попереджень","xml":{"name":"warnings"},"items":{"type":"string","xml":{"name":"warnings"}}},"info":{"type":"array","description":"Масив інформаційних повідомлень","xml":{"name":"info"},"items":{"type":"string","xml":{"name":"info"}}},"messageCodes":{"type":"array","description":"Масив кодів інформаційних повідомлень","xml":{"name":"messageCodes"},"items":{"type":"string","xml":{"name":"messageCodes"}}},"errorCodes":{"type":"array","description":"Масив кодів помилок","xml":{"name":"errorCodes"},"items":{"type":"string","xml":{"name":"errorCodes"}}},"warningCodes":{"type":"array","description":"Масив кодів попереджень","xml":{"name":"warningCodes"},"items":{"type":"string","xml":{"name":"warningCodes"}}},"infoCodes":{"type":"array","description":"Масив кодів додаткової інформації","xml":{"name":"infoCodes"},"items":{"type":"string","xml":{"name":"infoCodes"}}}}},"PackDataGroupXml":{"type":"object","additionalProperties":false,"properties":{"Filtered":{"type":"object","description":"Основний перелік паковань, відібраних за фільтрами","xml":{"name":"Filtered"},"properties":{"item":{"type":"array","items":{"$ref":"#/components/schemas/PackItem"}}}},"Common":{"type":"object","description":"Додаткові паковання, які не пройшли частину фільтрів (повертається у стандартному режимі `New`=`0`)","xml":{"name":"Common"},"properties":{"item":{"type":"array","items":{"$ref":"#/components/schemas/PackItem"}}}}}},"PackItem":{"type":"object","additionalProperties":false,"properties":{"Ref":{"type":"string","maxLength":36,"description":"Ідентифікатор паковання"},"Description":{"type":"string","description":"Опис паковання"},"DescriptionRu":{"type":"string","description":"Опис паковання російською"},"Length":{"type":"string","description":"Довжина відправлення, см (у разі пакування із поштомата дані не передаються)"},"Width":{"type":"string","description":"Ширина відправлення, см (у разі пакування із поштомата дані не передаються)"},"Height":{"type":"string","description":"Висота відправлення, см (у разі пакування із поштомата дані не передаються)"},"VolumetricWeight":{"type":"string","description":"Об'ємна вага, кг (у разі пакування із поштомата дані не передаються)"},"TypeOfPacking":{"type":"string","description":"Тип паковання"},"PackagingForPlace":{"type":"string","description":"Ознака паковання для одного місця"}}}}}}
```

## Доступні часові інтервали для виклику кур’єра (JSON)

> Метод \*\*getPickupTimeIntervals\*\* працює в моделі \*\*CommonGeneral\*\* і дозволяє отримати доступні для вибору часові інтервали для візиту кур'єра.<br>

```json
{"openapi":"3.0.3","info":{"title":"API Nova Post — CommonGeneral","version":"2.0.0"},"tags":[{"name":"PickupTimeIntervals","description":"Операції, пов'язані з отриманням часових інтервалів для виклику кур'єра"}],"servers":[{"url":"https://api.novaposhta.ua/v2.0/","description":"production"}],"paths":{"/json/":{"post":{"tags":["PickupTimeIntervals"],"operationId":"getPickupTimeIntervalsJson","summary":"Доступні часові інтервали для виклику кур’єра (JSON)","description":"Метод **getPickupTimeIntervals** працює в моделі **CommonGeneral** і дозволяє отримати доступні для вибору часові інтервали для візиту кур'єра.\n","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetPickupTimeIntervalsJsonRequest"}}}},"responses":{"200":{"description":"Успішна відповідь (JSON)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetPickupTimeIntervalsJsonResponse"}}}}}}}},"components":{"schemas":{"GetPickupTimeIntervalsJsonRequest":{"type":"object","additionalProperties":false,"required":["apiKey","modelName","calledMethod","methodProperties"],"properties":{"apiKey":{"type":"string","description":"API-ключ користувача"},"modelName":{"type":"string","enum":["CommonGeneral"],"description":"Назва моделі API"},"calledMethod":{"type":"string","enum":["getPickupTimeIntervals"],"description":"Назва методу API"},"methodProperties":{"$ref":"#/components/schemas/GetPickupTimeIntervalsMethodProperties"}}},"GetPickupTimeIntervalsMethodProperties":{"type":"object","additionalProperties":false,"required":["SenderCityRef","DateTime"],"properties":{"SenderCityRef":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) міста відправника"},"DateTime":{"type":"string","maxLength":36,"description":"Дата доступних для вибору часових інтервалів"}}},"GetPickupTimeIntervalsJsonResponse":{"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/PickupTimeIntervalItem"}},"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"}}}},"PickupTimeIntervalItem":{"type":"object","additionalProperties":false,"properties":{"Number":{"type":"string","maxLength":36,"description":"Назва часового інтервалу"},"Start":{"type":"string","maxLength":36,"description":"Час початку дії часового інтервалу"},"End":{"type":"string","maxLength":36,"description":"Час завершення дії часового інтервалу"},"BoundaryTime":{"type":"string","maxLength":36,"description":"Піковий час забору посилки"}}}}}}
```

## Доступні часові інтервали для виклику кур’єра (XML)

> Метод \*\*getPickupTimeIntervals\*\* працює в моделі \*\*CommonGeneral\*\* і дозволяє отримати доступні для вибору часові інтервали для візиту кур'єра.<br>

```json
{"openapi":"3.0.3","info":{"title":"API Nova Post — CommonGeneral","version":"2.0.0"},"tags":[{"name":"PickupTimeIntervals","description":"Операції, пов'язані з отриманням часових інтервалів для виклику кур'єра"}],"servers":[{"url":"https://api.novaposhta.ua/v2.0/","description":"production"}],"paths":{"/xml/":{"post":{"tags":["PickupTimeIntervals"],"operationId":"getPickupTimeIntervalsXml","summary":"Доступні часові інтервали для виклику кур’єра (XML)","description":"Метод **getPickupTimeIntervals** працює в моделі **CommonGeneral** і дозволяє отримати доступні для вибору часові інтервали для візиту кур'єра.\n","requestBody":{"required":true,"content":{"application/xml":{"schema":{"$ref":"#/components/schemas/GetPickupTimeIntervalsXmlRequest"}}}},"responses":{"200":{"description":"Успішна відповідь (XML)","content":{"application/xml":{"schema":{"$ref":"#/components/schemas/GetPickupTimeIntervalsXmlResponse"}}}}}}}},"components":{"schemas":{"GetPickupTimeIntervalsXmlRequest":{"type":"object","additionalProperties":false,"xml":{"name":"file"},"required":["apiKey","modelName","calledMethod","methodProperties"],"properties":{"apiKey":{"type":"string","description":"API-ключ користувача"},"modelName":{"type":"string","enum":["CommonGeneral"],"description":"Назва моделі API"},"calledMethod":{"type":"string","enum":["getPickupTimeIntervals"],"description":"Назва методу API"},"methodProperties":{"$ref":"#/components/schemas/GetPickupTimeIntervalsXmlMethodProperties"}}},"GetPickupTimeIntervalsXmlMethodProperties":{"type":"object","additionalProperties":false,"xml":{"name":"methodProperties"},"required":["SenderCityRef","DateTime"],"properties":{"SenderCityRef":{"type":"string","description":"Ідентифікатор (REF) міста відправника"},"DateTime":{"type":"string","description":"Дата доступних для вибору часових інтервалів"}}},"GetPickupTimeIntervalsXmlResponse":{"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"},"items":{"$ref":"#/components/schemas/PickupTimeIntervalItem"}},"errors":{"type":"array","description":"Масив повідомлень про помилки","xml":{"name":"errors"},"items":{"type":"string","xml":{"name":"errors"}}},"warnings":{"type":"array","description":"Масив попереджень","xml":{"name":"warnings"},"items":{"type":"string","xml":{"name":"warnings"}}},"info":{"type":"array","description":"Масив інформаційних повідомлень","xml":{"name":"info"},"items":{"type":"string","xml":{"name":"info"}}},"messageCodes":{"type":"array","description":"Масив кодів інформаційних повідомлень","xml":{"name":"messageCodes"},"items":{"type":"string","xml":{"name":"messageCodes"}}},"errorCodes":{"type":"array","description":"Масив кодів помилок","xml":{"name":"errorCodes"},"items":{"type":"string","xml":{"name":"errorCodes"}}},"warningCodes":{"type":"array","description":"Масив кодів попереджень","xml":{"name":"warningCodes"},"items":{"type":"string","xml":{"name":"warningCodes"}}},"infoCodes":{"type":"array","description":"Масив кодів додаткової інформації","xml":{"name":"infoCodes"},"items":{"type":"string","xml":{"name":"infoCodes"}}}}},"PickupTimeIntervalItem":{"type":"object","additionalProperties":false,"properties":{"Number":{"type":"string","maxLength":36,"description":"Назва часового інтервалу"},"Start":{"type":"string","maxLength":36,"description":"Час початку дії часового інтервалу"},"End":{"type":"string","maxLength":36,"description":"Час завершення дії часового інтервалу"},"BoundaryTime":{"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/dovidniki.md?ask=<question>&goal=<endgoal>
```

`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.