Ctrlk
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Довідники

Робота з довідниками

🔗Початок роботи з API

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

post

Метод getTimeIntervals працює в моделі CommonGeneral. Повертає список часових інтервалів для вибраного міста.

Довідник рекомендується завантажувати один раз на місяць для оновлення актуальних даних.

Body
apiKeystringRequired

API-ключ користувача

modelNamestring · enumRequired

Назва моделі API

Possible values:
calledMethodstring · enumRequired

Назва методу API

Possible values:
Responses
200

Успішна відповідь (JSON)

application/json
successbooleanRequired

Прапор успішності виконання запиту

errorsstring[]Required

Масив повідомлень про помилки

warningsstring[]Required

Масив попереджень

infostring[]Required

Масив інформаційних повідомлень

messageCodesstring[]Required

Масив кодів інформаційних повідомлень

errorCodesstring[]Required

Масив кодів помилок

warningCodesstring[]Required

Масив кодів попереджень

infoCodesstring[]Required

Масив кодів додаткової інформації

post/json/
POST /v2.0/json/ HTTP/1.1
Host: api.novaposhta.ua/
Content-Type: application/json
Accept: */*
Content-Length: 195

{
  "apiKey": "[ВАШ КЛЮЧ]",
  "modelName": "CommonGeneral",
  "calledMethod": "getTimeIntervals",
  "methodProperties": {
    "RecipientCityRef": "00000000-0000-0000-0000-000000000000",
    "DateTime": "18.09.2016"
  }
}
200

Успішна відповідь (JSON)

{
  "success": true,
  "data": [
    {
      "Number": "CityDeliveryTimeInterval2",
      "Start": "12:00",
      "End": "15:00"
    }
  ],
  "errors": [],
  "warnings": [],
  "info": [],
  "messageCodes": [],
  "errorCodes": [],
  "warningCodes": [],
  "infoCodes": []
}

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

post

Метод getTimeIntervals працює в моделі CommonGeneral. Повертає список часових інтервалів для вибраного міста у форматі XML.

Довідник рекомендується завантажувати один раз на місяць для оновлення даних.

Body
apiKeystringRequired

API-ключ користувача

modelNamestring · enumRequired

Назва моделі API

Possible values:
calledMethodstring · enumRequired

Назва методу API

Possible values:
Responses
200

Успішна відповідь (XML)

application/xml
successbooleanRequired

Прапор успішності виконання запиту

errorsstring[]Required

Масив повідомлень про помилки

warningsstring[]Required

Масив попереджень

infostring[]Required

Масив інформаційних повідомлень

messageCodesstring[]Required

Масив кодів інформаційних повідомлень

errorCodesstring[]Required

Масив кодів помилок

warningCodesstring[]Required

Масив кодів попереджень

infoCodesstring[]Required

Масив кодів додаткової інформації

post/xml/
POST /v2.0/xml/ HTTP/1.1
Host: api.novaposhta.ua/
Content-Type: application/xml
Accept: */*
Content-Length: 351

"<?xml version="1.0" encoding="UTF-8"?>
<file>
  <apiKey>[ВАШ КЛЮЧ]</apiKey>
  <modelName>CommonGeneral</modelName>
  <calledMethod>getTimeIntervals</calledMethod>
  <methodProperties>
    <RecipientCityRef>00000000-0000-0000-0000-000000000000</RecipientCityRef>
    <DateTime>18.09.2016</DateTime>
  </methodProperties>
</file>
"
200

Успішна відповідь (XML)

<?xml version="1.0" encoding="UTF-8"?>
<root>
  <success>true</success>
  <data>
    <item>
      <Number>CityDeliveryTimeInterval2</Number>
      <Start>12:00</Start>
      <End>15:00</End>
    </item>
  </data>
  <errors/>
  <warnings/>
  <info/>
  <messageCodes/>
  <errorCodes/>
  <warningCodes/>
  <infoCodes/>
</root>

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

post

Метод getCargoTypes працює в моделі Common (або CommonGeneral). Повертає список типів вантажу українською мовою.

Довідник потрібно завантажувати один раз на місяць для оновлення даних.

Body
apiKeystringRequired

API-ключ користувача

Example: [ВАШ КЛЮЧ]
modelNamestring · enumRequired

Назва моделі API

Example: CommonGeneralPossible values:
calledMethodstring · enumRequired

Назва методу API

Example: getCargoTypesPossible values:
methodPropertiesobject · GetCargoTypesMethodPropertiesRequired

Властивості методу

Responses
200

Успішна відповідь (JSON)

application/json
successbooleanRequired

Прапор успішності виконання запиту

errorsstring[]Required

Масив повідомлень про помилки

warningsstring[]Required

Масив попереджень

infostring[]Required

Масив інформаційних повідомлень

messageCodesstring[]Required

Масив кодів інформаційних повідомлень

errorCodesstring[]Required

Масив кодів помилок

warningCodesstring[]Required

Масив кодів попереджень

infoCodesstring[]Required

Масив кодів додаткової інформації

post/json/
POST /v2.0/json/ HTTP/1.1
Host: api.novaposhta.ua/
Content-Type: application/json
Accept: */*
Content-Length: 111

{
  "apiKey": "[ВАШ КЛЮЧ]",
  "modelName": "CommonGeneral",
  "calledMethod": "getCargoTypes",
  "methodProperties": {}
}
200

Успішна відповідь (JSON)

{
  "success": true,
  "data": [
    {
      "Ref": "Cargo",
      "Description": "Вантаж"
    }
  ],
  "errors": [],
  "warnings": [],
  "info": [],
  "messageCodes": [],
  "errorCodes": [],
  "warningCodes": [],
  "infoCodes": []
}

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

post

Метод getCargoTypes працює в моделі Common (або CommonGeneral). Повертає список типів вантажу українською мовою.

Довідник потрібно завантажувати один раз на місяць для оновлення даних.

Body
apiKeystringRequired

API-ключ користувача

modelNamestring · enumRequired

Назва моделі API

Possible values:
calledMethodstring · enumRequired

Назва методу API

Possible values:
methodPropertiesobject · GetCargoTypesXmlMethodPropertiesRequired

Властивості методу

Responses
200

Успішна відповідь (XML)

application/xml
successbooleanRequired

Прапор успішності виконання запиту

errorsstring[]Required

Масив повідомлень про помилки

warningsstring[]Required

Масив попереджень

infostring[]Required

Масив інформаційних повідомлень

messageCodesstring[]Required

Масив кодів інформаційних повідомлень

errorCodesstring[]Required

Масив кодів помилок

warningCodesstring[]Required

Масив кодів попереджень

infoCodesstring[]Required

Масив кодів додаткової інформації

post/xml/
POST /v2.0/xml/ HTTP/1.1
Host: api.novaposhta.ua/
Content-Type: application/xml
Accept: */*
Content-Length: 232

"<?xml version="1.0" encoding="UTF-8"?>
<file>
  <apiKey>[ВАШ КЛЮЧ]</apiKey>
  <modelName>CommonGeneral</modelName>
  <calledMethod>getCargoTypes</calledMethod>
  <methodProperties>
  </methodProperties>
</file>
"
200

Успішна відповідь (XML)

<?xml version="1.0" encoding="UTF-8"?>
<root>
  <success>true</success>
  <data>
    <item>
      <Ref>Cargo</Ref>
      <Description>Вантаж</Description>
    </item>
  </data>
  <errors/>
  <warnings/>
  <info/>
  <messageCodes/>
  <errorCodes/>
  <warningCodes/>
  <infoCodes/>
</root>

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

post

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

Довідник потрібно завантажувати один раз на місяць для оновлення даних.

Body
apiKeystringRequired

API-ключ користувача

Example: [ВАШ КЛЮЧ]
modelNamestring · enumRequired

Назва моделі API

Example: CommonGeneralPossible values:
calledMethodstring · enumRequired

Назва методу API

Example: getBackwardDeliveryCargoTypesPossible values:
methodPropertiesobject · GetBackwardDeliveryCargoTypesMethodPropertiesRequired

Властивості методу

Responses
200

Успішна відповідь (JSON)

application/json
successbooleanRequired

Прапор успішності виконання запиту

errorsstring[]Required

Масив повідомлень про помилки

warningsstring[]Required

Масив попереджень

infostring[]Required

Масив інформаційних повідомлень

messageCodesstring[]Required

Масив кодів інформаційних повідомлень

errorCodesstring[]Required

Масив кодів помилок

warningCodesstring[]Required

Масив кодів попереджень

infoCodesstring[]Required

Масив кодів додаткової інформації

post/json/
POST /v2.0/json/ HTTP/1.1
Host: api.novaposhta.ua/
Content-Type: application/json
Accept: */*
Content-Length: 127

{
  "apiKey": "[ВАШ КЛЮЧ]",
  "modelName": "CommonGeneral",
  "calledMethod": "getBackwardDeliveryCargoTypes",
  "methodProperties": {}
}
200

Успішна відповідь (JSON)

{
  "success": true,
  "data": [
    {
      "Ref": "Documents",
      "Description": "Документи"
    }
  ],
  "errors": [],
  "warnings": [],
  "info": [],
  "messageCodes": [],
  "errorCodes": [],
  "warningCodes": [],
  "infoCodes": []
}

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

post

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

Довідник потрібно завантажувати один раз на місяць для оновлення даних.

Body
apiKeystringRequired

API-ключ користувача

modelNamestring · enumRequired

Назва моделі API

Possible values:
calledMethodstring · enumRequired

Назва методу API

Possible values:
methodPropertiesobject · GetBackwardDeliveryCargoTypesXmlMethodPropertiesRequired

Властивості методу

Responses
200

Успішна відповідь (XML)

application/xml
successbooleanRequired

Прапор успішності виконання запиту

errorsstring[]Required

Масив повідомлень про помилки

warningsstring[]Required

Масив попереджень

infostring[]Required

Масив інформаційних повідомлень

messageCodesstring[]Required

Масив кодів інформаційних повідомлень

errorCodesstring[]Required

Масив кодів помилок

warningCodesstring[]Required

Масив кодів попереджень

infoCodesstring[]Required

Масив кодів додаткової інформації

post/xml/
POST /v2.0/xml/ HTTP/1.1
Host: api.novaposhta.ua/
Content-Type: application/xml
Accept: */*
Content-Length: 248

"<?xml version="1.0" encoding="UTF-8"?>
<file>
  <apiKey>[ВАШ КЛЮЧ]</apiKey>
  <modelName>CommonGeneral</modelName>
  <calledMethod>getBackwardDeliveryCargoTypes</calledMethod>
  <methodProperties>
  </methodProperties>
</file>
"
200

Успішна відповідь (XML)

<?xml version="1.0" encoding="UTF-8"?>
<root>
  <success>true</success>
  <data>
    <item>
      <Ref>Documents</Ref>
      <Description>Документи</Description>
    </item>
  </data>
  <errors/>
  <warnings/>
  <info/>
  <messageCodes/>
  <errorCodes/>
  <warningCodes/>
  <infoCodes/>
</root>

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

post

Метод getPalletsList працює в моделі Common (або CommonGeneral) і повертає список видів палет.

Довідник потрібно завантажувати один раз на місяць для оновлення даних.

Body
apiKeystringRequired

API-ключ користувача

Example: [ВАШ КЛЮЧ]
modelNamestring · enumRequired

Назва моделі API

Example: CommonGeneralPossible values:
calledMethodstring · enumRequired

Назва методу API

Example: getPalletsListPossible values:
methodPropertiesobject · GetPalletsListMethodPropertiesRequired

Властивості методу

Responses
200

Успішна відповідь (JSON)

application/json
successbooleanRequired

Прапор успішності виконання запиту

errorsstring[]Required

Масив повідомлень про помилки

warningsstring[]Required

Масив попереджень

infostring[]Required

Масив інформаційних повідомлень

messageCodesstring[]Required

Масив кодів інформаційних повідомлень

errorCodesstring[]Required

Масив кодів помилок

warningCodesstring[]Required

Масив кодів попереджень

infoCodesstring[]Required

Масив кодів додаткової інформації

post/json/
POST /v2.0/json/ HTTP/1.1
Host: api.novaposhta.ua/
Content-Type: application/json
Accept: */*
Content-Length: 112

{
  "apiKey": "[ВАШ КЛЮЧ]",
  "modelName": "CommonGeneral",
  "calledMethod": "getPalletsList",
  "methodProperties": {}
}
200

Успішна відповідь (JSON)

{
  "success": true,
  "data": [
    {
      "Ref": "00000000-0000-0000-0000-000000000000",
      "Description": "Палета від 1,5 м2 до 2 м2",
      "DescriptionRu": "Паллета свыше 1,5 м2",
      "Weight": "816.00"
    }
  ],
  "errors": [],
  "warnings": [],
  "info": [],
  "messageCodes": [],
  "errorCodes": [],
  "warningCodes": [],
  "infoCodes": []
}

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

post

Метод getPalletsList працює в моделі Common (або CommonGeneral) і повертає список видів палет у форматі XML.

Довідник потрібно завантажувати один раз на місяць для оновлення даних.

Body
apiKeystringRequired

API-ключ користувача

modelNamestring · enumRequired

Назва моделі API

Possible values:
calledMethodstring · enumRequired

Назва методу API

Possible values:
methodPropertiesobject · GetPalletsListXmlMethodPropertiesRequired

Властивості методу

Responses
200

Успішна відповідь (XML)

application/xml
successbooleanRequired

Прапор успішності виконання запиту

errorsstring[]Required

Масив повідомлень про помилки

warningsstring[]Required

Масив попереджень

infostring[]Required

Масив інформаційних повідомлень

messageCodesstring[]Required

Масив кодів інформаційних повідомлень

errorCodesstring[]Required

Масив кодів помилок

warningCodesstring[]Required

Масив кодів попереджень

infoCodesstring[]Required

Масив кодів додаткової інформації

post/xml/
POST /v2.0/xml/ HTTP/1.1
Host: api.novaposhta.ua/
Content-Type: application/xml
Accept: */*
Content-Length: 233

"<?xml version="1.0" encoding="UTF-8"?>
<file>
  <apiKey>[ВАШ КЛЮЧ]</apiKey>
  <modelName>CommonGeneral</modelName>
  <calledMethod>getPalletsList</calledMethod>
  <methodProperties>
  </methodProperties>
</file>
"
200

Успішна відповідь (XML)

<?xml version="1.0" encoding="UTF-8"?>
<root>
  <success>true</success>
  <data>
    <item>
      <Ref>00000000-0000-0000-0000-000000000000</Ref>
      <Description>Палета від 1,5 м2 до 2 м2</Description>
      <DescriptionRu>Паллета свыше 1,5 м2</DescriptionRu>
      <Weight>816.00</Weight>
    </item>
  </data>
  <errors/>
  <warnings/>
  <info/>
  <messageCodes/>
  <errorCodes/>
  <warningCodes/>
  <infoCodes/>
</root>

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

post

Метод getTypesOfPayers працює в моделі Common (або CommonGeneral) і використовується для завантаження даних щодо видів платників послуги доставки (відправник, одержувач, третя особа).

Вид платника «Третя особа» можна замовити лише після укладання договору з компанією «Нова пошта».

Довідник потрібно завантажувати один раз на місяць для оновлення даних.

Body
apiKeystringRequired

API-ключ користувача

Example: [ВАШ КЛЮЧ]
modelNamestring · enumRequired

Назва моделі API

Example: CommonGeneralPossible values:
calledMethodstring · enumRequired

Назва методу API

Example: getTypesOfPayersPossible values:
methodPropertiesobject · GetTypesOfPayersMethodPropertiesRequired

Властивості методу

Responses
200

Успішна відповідь (JSON)

application/json
successbooleanRequired

Прапор успішності виконання запиту

errorsstring[]Required

Масив повідомлень про помилки

warningsstring[]Required

Масив попереджень

infostring[]Required

Масив інформаційних повідомлень

messageCodesstring[]Required

Масив кодів інформаційних повідомлень

errorCodesstring[]Required

Масив кодів помилок

warningCodesstring[]Required

Масив кодів попереджень

infoCodesstring[]Required

Масив кодів додаткової інформації

post/json/
POST /v2.0/json/ HTTP/1.1
Host: api.novaposhta.ua/
Content-Type: application/json
Accept: */*
Content-Length: 114

{
  "apiKey": "[ВАШ КЛЮЧ]",
  "modelName": "CommonGeneral",
  "calledMethod": "getTypesOfPayers",
  "methodProperties": {}
}
200

Успішна відповідь (JSON)

{
  "success": true,
  "data": [
    {
      "Ref": "Sender",
      "Description": "Відправник"
    }
  ],
  "errors": [],
  "warnings": [],
  "info": [],
  "messageCodes": [],
  "errorCodes": [],
  "warningCodes": [],
  "infoCodes": []
}

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

post

Метод getTypesOfPayers працює в моделі Common (або CommonGeneral) і використовується для завантаження даних щодо видів платників послуги доставки (відправник, одержувач, третя особа).

Вид платника «Третя особа» можна замовити лише після укладання договору з компанією «Нова пошта».

Довідник потрібно завантажувати один раз на місяць для оновлення даних.

Body
apiKeystringRequired

API-ключ користувача

modelNamestring · enumRequired

Назва моделі API

Possible values:
calledMethodstring · enumRequired

Назва методу API

Possible values:
methodPropertiesobject · GetTypesOfPayersXmlMethodPropertiesRequired

Властивості методу

Responses
200

Успішна відповідь (XML)

application/xml
successbooleanRequired

Прапор успішності виконання запиту

errorsstring[]Required

Масив повідомлень про помилки

warningsstring[]Required

Масив попереджень

infostring[]Required

Масив інформаційних повідомлень

messageCodesstring[]Required

Масив кодів інформаційних повідомлень

errorCodesstring[]Required

Масив кодів помилок

warningCodesstring[]Required

Масив кодів попереджень

infoCodesstring[]Required

Масив кодів додаткової інформації

post/xml/
POST /v2.0/xml/ HTTP/1.1
Host: api.novaposhta.ua/
Content-Type: application/xml
Accept: */*
Content-Length: 235

"<?xml version="1.0" encoding="UTF-8"?>
<file>
  <apiKey>[ВАШ КЛЮЧ]</apiKey>
  <modelName>CommonGeneral</modelName>
  <calledMethod>getTypesOfPayers</calledMethod>
  <methodProperties>
  </methodProperties>
</file>
"
200

Успішна відповідь (XML)

<?xml version="1.0" encoding="UTF-8"?>
<root>
  <success>true</success>
  <data>
    <item>
      <Ref>Sender</Ref>
      <Description>Відправник</Description>
    </item>
  </data>
  <errors/>
  <warnings/>
  <info/>
  <messageCodes/>
  <errorCodes/>
  <warningCodes/>
  <infoCodes/>
</root>

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

post

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

Довідник потрібно завантажувати один раз на місяць для оновлення даних.

Body
apiKeystringRequired

API-ключ користувача

Example: [ВАШ КЛЮЧ]
modelNamestring · enumRequired

Назва моделі API

Example: CommonGeneralPossible values:
calledMethodstring · enumRequired

Назва методу API

Example: getTypesOfPayersForRedeliveryPossible values:
methodPropertiesobject · GetTypesOfPayersForRedeliveryMethodPropertiesRequired

Властивості методу

Responses
200

Успішна відповідь (JSON)

application/json
successbooleanRequired

Прапор успішності виконання запиту

errorsstring[]Required

Масив повідомлень про помилки

warningsstring[]Required

Масив попереджень

infostring[]Required

Масив інформаційних повідомлень

messageCodesstring[]Required

Масив кодів інформаційних повідомлень

errorCodesstring[]Required

Масив кодів помилок

warningCodesstring[]Required

Масив кодів попереджень

infoCodesstring[]Required

Масив кодів додаткової інформації

post/json/
POST /v2.0/json/ HTTP/1.1
Host: api.novaposhta.ua/
Content-Type: application/json
Accept: */*
Content-Length: 127

{
  "apiKey": "[ВАШ КЛЮЧ]",
  "modelName": "CommonGeneral",
  "calledMethod": "getTypesOfPayersForRedelivery",
  "methodProperties": {}
}
200

Успішна відповідь (JSON)

{
  "success": true,
  "data": [
    {
      "Ref": "Sender",
      "Description": "Відправник"
    }
  ],
  "errors": [],
  "warnings": [],
  "info": [],
  "messageCodes": [],
  "errorCodes": [],
  "warningCodes": [],
  "infoCodes": []
}

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

post

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

Довідник потрібно завантажувати один раз на місяць для оновлення даних.

Body
apiKeystringRequired

API-ключ користувача

modelNamestring · enumRequired

Назва моделі API

Possible values:
calledMethodstring · enumRequired

Назва методу API

Possible values:
methodPropertiesobject · GetTypesOfPayersForRedeliveryXmlMethodPropertiesRequired

Властивості методу

Responses
200

Успішна відповідь (XML)

application/xml
successbooleanRequired

Прапор успішності виконання запиту

errorsstring[]Required

Масив повідомлень про помилки

warningsstring[]Required

Масив попереджень

infostring[]Required

Масив інформаційних повідомлень

messageCodesstring[]Required

Масив кодів інформаційних повідомлень

errorCodesstring[]Required

Масив кодів помилок

warningCodesstring[]Required

Масив кодів попереджень

infoCodesstring[]Required

Масив кодів додаткової інформації

post/xml/
POST /v2.0/xml/ HTTP/1.1
Host: api.novaposhta.ua/
Content-Type: application/xml
Accept: */*
Content-Length: 248

"<?xml version="1.0" encoding="UTF-8"?>
<file>
  <apiKey>[ВАШ КЛЮЧ]</apiKey>
  <modelName>CommonGeneral</modelName>
  <calledMethod>getTypesOfPayersForRedelivery</calledMethod>
  <methodProperties>
  </methodProperties>
</file>
"
200

Успішна відповідь (XML)

<?xml version="1.0" encoding="UTF-8"?>
<root>
  <success>true</success>
  <data>
    <item>
      <Ref>Sender</Ref>
      <Description>Відправник</Description>
    </item>
  </data>
  <errors/>
  <warnings/>
  <info/>
  <messageCodes/>
  <errorCodes/>
  <warningCodes/>
  <infoCodes/>
</root>

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

post

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

Довідник слід завантажувати один раз на місяць для оновлення даних.

Body
apiKeystringRequired

API-ключ користувача

Example: [ВАШ КЛЮЧ]
modelNamestring · enumRequired

Назва моделі API

Example: CommonGeneralPossible values:
calledMethodstring · enumRequired

Назва методу API

Example: getPackListPossible values:
Responses
200

Успішна відповідь (JSON)

application/json
successbooleanRequired

Прапор успішності виконання запиту

errorsstring[]Required

Масив повідомлень про помилки

warningsstring[]Required

Масив попереджень

infostring[]Required

Масив інформаційних повідомлень

messageCodesstring[]Required

Масив кодів інформаційних повідомлень

errorCodesstring[]Required

Масив кодів помилок

warningCodesstring[]Required

Масив кодів попереджень

infoCodesstring[]Required

Масив кодів додаткової інформації

post/json/
POST /v2.0/json/ HTTP/1.1
Host: api.novaposhta.ua/
Content-Type: application/json
Accept: */*
Content-Length: 223

{
  "apiKey": "[ВАШ КЛЮЧ]",
  "modelName": "CommonGeneral",
  "calledMethod": "getPackList",
  "methodProperties": {
    "Lengthstring": "10",
    "Widthstring": "2",
    "Heightstring": "15",
    "VolumetricWeightstring": "8.54",
    "TypeOfPackingstring": ""
  }
}
200

Успішна відповідь (JSON)

{
  "success": true,
  "data": [
    {
      "Ref": "00000000-0000-0000-0000-000000000000",
      "Description": "Гофрокартон 3-шаровий",
      "DescriptionRu": "Гофрокартон 3-слойный",
      "Length": "1000.0",
      "Width": "1000.0",
      "Height": "0.0",
      "VolumetricWeight": "0.00",
      "TypeOfPacking": ""
    }
  ],
  "errors": [],
  "warnings": [],
  "info": [],
  "messageCodes": [],
  "errorCodes": [],
  "warningCodes": [],
  "infoCodes": []
}

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

post

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

Довідник слід завантажувати один раз на місяць для оновлення даних.

Body
apiKeystringRequired

API-ключ користувача

modelNamestring · enumRequired

Назва моделі API

Possible values:
calledMethodstring · enumRequired

Назва методу API

Possible values:
Responses
200

Успішна відповідь (XML)

application/xml
successbooleanRequired

Прапор успішності виконання запиту

errorsstring[]Required

Масив повідомлень про помилки

warningsstring[]Required

Масив попереджень

infostring[]Required

Масив інформаційних повідомлень

messageCodesstring[]Required

Масив кодів інформаційних повідомлень

errorCodesstring[]Required

Масив кодів помилок

warningCodesstring[]Required

Масив кодів попереджень

infoCodesstring[]Required

Масив кодів додаткової інформації

post/xml/
POST /v2.0/xml/ HTTP/1.1
Host: api.novaposhta.ua/
Content-Type: application/xml
Accept: */*
Content-Length: 476

"<?xml version="1.0" encoding="UTF-8"?>
<file>
    <apiKey>[ВАШ КЛЮЧ]</apiKey>
    <modelName>CommonGeneral</modelName>
    <calledMethod>getPackList</calledMethod>
    <methodProperties>
        <Lengthstring>10</Lengthstring>
        <Widthstring>2</Widthstring>
        <Heightstring>15</Heightstring>
        <VolumetricWeightstring>8.54</VolumetricWeightstring>
        <TypeOfPackingstring></TypeOfPackingstring>
    </methodProperties>
</file>
"
200

Успішна відповідь (XML)

<?xml version="1.0" encoding="UTF-8"?>
<root>
    <success>true</success>
    <data>
        <Ref>00000000-0000-0000-0000-000000000000</Ref>
        <Description>Гофрокартон 3-шаровий</Description>
        <DescriptionRu>Гофрокартон 3-слойный</DescriptionRu>
        <Length>1000.0</Length>
        <Width>1000.0</Width>
        <Height>0.0</Height>
        <VolumetricWeight>0.00</VolumetricWeight>
        <TypeOfPacking></TypeOfPacking>
    </data>
    <errors/>
    <warnings/>
    <info/>
    <messageCodes/>
    <errorCodes/>
    <warningCodes/>
    <infoCodes/>
</root>

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

post

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

Необхідно зберігати копію довідників на стороні клієнта та підтримувати її в актуальному стані. Рекомендується проводити оновлення довідників раз на місяць.

Body
apiKeystringRequired

API-ключ користувача

Example: [ВАШ КЛЮЧ]
modelNamestring · enumRequired

Назва моделі API

Example: CommonGeneralPossible values:
calledMethodstring · enumRequired

Назва методу API

Example: getTiresWheelsListPossible values:
methodPropertiesobject · GetTiresWheelsListMethodPropertiesRequired

Властивості методу (порожній об'єкт)

Responses
200

Успішна відповідь (JSON)

application/json
successbooleanRequired

Прапор успішності виконання запиту

errorsstring[]Required

Масив повідомлень про помилки

warningsstring[]Required

Масив попереджень

infostring[]Required

Масив інформаційних повідомлень

messageCodesstring[]Required

Масив кодів інформаційних повідомлень

errorCodesstring[]Required

Масив кодів помилок

warningCodesstring[]Required

Масив кодів попереджень

infoCodesstring[]Required

Масив кодів додаткової інформації

post/json/
POST /v2.0/json/ HTTP/1.1
Host: api.novaposhta.ua/
Content-Type: application/json
Accept: */*
Content-Length: 116

{
  "apiKey": "[ВАШ КЛЮЧ]",
  "modelName": "CommonGeneral",
  "calledMethod": "getTiresWheelsList",
  "methodProperties": {}
}
200

Успішна відповідь (JSON)

{
  "success": true,
  "data": [
    {
      "Ref": "00000000-0000-0000-0000-000000000000",
      "Description": "Шина легкова R 13-14",
      "DescriptionRu": "Шина легковая R 13-14",
      "Weight": "14.90",
      "DescriptionType": "Tires"
    }
  ],
  "errors": [],
  "warnings": [],
  "info": [],
  "messageCodes": [],
  "errorCodes": [],
  "warningCodes": [],
  "infoCodes": []
}

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

post

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

Необхідно зберігати копію довідників на стороні клієнта та підтримувати її в актуальному стані. Рекомендується проводити оновлення довідників раз на місяць.

Body
apiKeystringRequired

API-ключ користувача

modelNamestring · enumRequired

Назва моделі API

Possible values:
calledMethodstring · enumRequired

Назва методу API

Possible values:
methodPropertiesobject · GetTiresWheelsListXmlMethodPropertiesRequired

Властивості методу для XML

Responses
200

Успішна відповідь (XML)

application/xml
successbooleanRequired

Прапор успішності виконання запиту

errorsstring[]Required

Масив повідомлень про помилки

warningsstring[]Required

Масив попереджень

infostring[]Required

Масив інформаційних повідомлень

messageCodesstring[]Required

Масив кодів інформаційних повідомлень

errorCodesstring[]Required

Масив кодів помилок

warningCodesstring[]Required

Масив кодів попереджень

infoCodesstring[]Required

Масив кодів додаткової інформації

post/xml/
POST /v2.0/xml/ HTTP/1.1
Host: api.novaposhta.ua/
Content-Type: application/xml
Accept: */*
Content-Length: 247

"<?xml version="1.0" encoding="UTF-8"?>
<file>
    <apiKey>[ВАШ КЛЮЧ]</apiKey>
    <modelName>CommonGeneral</modelName>
    <calledMethod>getTiresWheelsList</calledMethod>
    <methodProperties>
    </methodProperties>
</file>
"
200

Успішна відповідь (XML)

<?xml version="1.0" encoding="UTF-8"?>
<root>
    <success>true</success>
    <data>
        <Ref>00000000-0000-0000-0000-000000000000</Ref>
        <Description>Шина легкова R 13-14</Description>
        <DescriptionRu>Шина легковая R 13-14</DescriptionRu>
        <Weight>14.90</Weight>
        <DescriptionType>Tires</DescriptionType>
    </data>
    <errors/>
    <warnings/>
    <info/>
    <messageCodes/>
    <errorCodes/>
    <warningCodes/>
    <infoCodes/>
</root>

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

post

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

Необхідно зберігати копію довідників на стороні клієнта та підтримувати її в актуальному стані. Рекомендується проводити оновлення довідників раз на місяць.

Body
apiKeystringRequired

API-ключ користувача

modelNamestring · enumRequired

Назва моделі API

Possible values:
calledMethodstring · enumRequired

Назва методу API

Possible values:
Responses
200

Успішна відповідь (XML)

application/xml
successbooleanRequired

Прапор успішності виконання запиту

errorsstring[]Required

Масив повідомлень про помилки

warningsstring[]Required

Масив попереджень

infostring[]Required

Масив інформаційних повідомлень

messageCodesstring[]Required

Масив кодів інформаційних повідомлень

errorCodesstring[]Required

Масив кодів помилок

warningCodesstring[]Required

Масив кодів попереджень

infoCodesstring[]Required

Масив кодів додаткової інформації

post/xml/
POST /v2.0/xml/ HTTP/1.1
Host: api.novaposhta.ua/
Content-Type: application/xml
Accept: */*
Content-Length: 327

"<?xml version="1.0" encoding="UTF-8"?>
<file>
    <apiKey>[ВАШ КЛЮЧ]</apiKey>
    <modelName>CommonGeneral</modelName>
    <calledMethod>getCargoDescriptionList</calledMethod>
    <methodProperties>
        <FindByString>Вантаж</FindByString>
        <Page>1</Page>
    </methodProperties>
</file>
"
200

Успішна відповідь (XML)

<?xml version="1.0" encoding="UTF-8"?>
<root>
    <success>true</success>
    <data>
        <Ref>00000000-0000-0000-0000-000000000000</Ref>
        <Description>DVD/HD- медіаплеєр</Description>
        <DescriptionRu>DVD/HD- медіаплеєр</DescriptionRu>
    </data>
    <errors/>
    <warnings/>
    <info/>
    <messageCodes/>
    <errorCodes/>
    <warningCodes/>
    <infoCodes/>
</root>

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

post

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

Довідник слід завантажувати один раз на місяць для оновлення даних.

Body
apiKeystringRequired

API-ключ користувача

Example: [ВАШ КЛЮЧ]
modelNamestring · enumRequired

Назва моделі API

Example: CommonGeneralPossible values:
calledMethodstring · enumRequired

Назва методу API

Example: getMessageCodeTextPossible values:
methodPropertiesobject · GetMessageCodeTextMethodPropertiesRequired

Властивості методу (порожній об'єкт)

Responses
200

Успішна відповідь (JSON)

application/json
successbooleanRequired

Прапор успішності виконання запиту

errorsstring[]Required

Масив повідомлень про помилки

warningsstring[]Required

Масив попереджень

infostring[]Required

Масив інформаційних повідомлень

messageCodesstring[]Required

Масив кодів інформаційних повідомлень

errorCodesstring[]Required

Масив кодів помилок

warningCodesstring[]Required

Масив кодів попереджень

infoCodesstring[]Required

Масив кодів додаткової інформації

post/json/
POST /v2.0/json/ HTTP/1.1
Host: api.novaposhta.ua/
Content-Type: application/json
Accept: */*
Content-Length: 116

{
  "apiKey": "[ВАШ КЛЮЧ]",
  "modelName": "CommonGeneral",
  "calledMethod": "getMessageCodeText",
  "methodProperties": {}
}
200

Успішна відповідь (JSON)

{
  "success": true,
  "data": [
    {
      "MessageCode": "20000100004",
      "MessageText": "User with email exists",
      "MessageDescriptionRU": "Отсутствует пользователь с таким Email",
      "MessageDescriptionUA": "Відсутній користувач з таким Email"
    }
  ],
  "errors": [],
  "warnings": [],
  "info": [],
  "messageCodes": [],
  "errorCodes": [],
  "warningCodes": [],
  "infoCodes": []
}

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

post

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

Довідник слід завантажувати один раз на місяць для оновлення даних.

Body
apiKeystringRequired

API-ключ користувача

modelNamestring · enumRequired

Назва моделі API

Possible values:
calledMethodstring · enumRequired

Назва методу API

Possible values:
methodPropertiesobject · GetMessageCodeTextXmlMethodPropertiesRequired

Властивості методу для XML

Responses
200

Успішна відповідь (XML)

application/xml
successbooleanRequired

Прапор успішності виконання запиту

errorsstring[]Required

Масив повідомлень про помилки

warningsstring[]Required

Масив попереджень

infostring[]Required

Масив інформаційних повідомлень

messageCodesstring[]Required

Масив кодів інформаційних повідомлень

errorCodesstring[]Required

Масив кодів помилок

warningCodesstring[]Required

Масив кодів попереджень

infoCodesstring[]Required

Масив кодів додаткової інформації

post/xml/
POST /v2.0/xml/ HTTP/1.1
Host: api.novaposhta.ua/
Content-Type: application/xml
Accept: */*
Content-Length: 247

"<?xml version="1.0" encoding="UTF-8"?>
<file>
    <apiKey>[ВАШ КЛЮЧ]</apiKey>
    <modelName>CommonGeneral</modelName>
    <calledMethod>getMessageCodeText</calledMethod>
    <methodProperties>
    </methodProperties>
</file>
"
200

Успішна відповідь (XML)

<?xml version="1.0" encoding="UTF-8"?>
<root>
    <success>true</success>
    <data>
        <MessageCode>20000100004</MessageCode>
        <MessageText>User with email exists</MessageText>
        <MessageDescriptionRU>Отсутствует пользователь с таким Email</MessageDescriptionRU>
        <MessageDescriptionUA>Відсутній користувач з таким Email</MessageDescriptionUA>
    </data>
    <errors/>
    <warnings/>
    <info/>
    <messageCodes/>
    <errorCodes/>
    <warningCodes/>
    <infoCodes/>
</root>

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

post

Метод getOwnershipFormsList працює в моделі Common (або CommonGeneral) і дозволяє завантажити список форм власності українською мовою.

Необхідно зберігати копію довідників на стороні клієнта та підтримувати її в актуальному стані. Рекомендується проводити оновлення довідників раз на місяць.

Body
apiKeystringRequired

API-ключ користувача

Example: [ВАШ КЛЮЧ]
modelNamestring · enumRequired

Назва моделі API

Example: CommonGeneralPossible values:
calledMethodstring · enumRequired

Назва методу API

Example: getOwnershipFormsListPossible values:
methodPropertiesobject · GetOwnershipFormsListMethodPropertiesRequired

Властивості методу (порожній об'єкт)

Responses
200

Успішна відповідь (JSON)

application/json
successbooleanRequired

Прапор успішності виконання запиту

errorsstring[]Required

Масив повідомлень про помилки

warningsstring[]Required

Масив попереджень

infostring[]Required

Масив інформаційних повідомлень

messageCodesstring[]Required

Масив кодів інформаційних повідомлень

errorCodesstring[]Required

Масив кодів помилок

warningCodesstring[]Required

Масив кодів попереджень

infoCodesstring[]Required

Масив кодів додаткової інформації

post/json/
POST /v2.0/json/ HTTP/1.1
Host: api.novaposhta.ua/
Content-Type: application/json
Accept: */*
Content-Length: 119

{
  "apiKey": "[ВАШ КЛЮЧ]",
  "modelName": "CommonGeneral",
  "calledMethod": "getOwnershipFormsList",
  "methodProperties": {}
}
200

Успішна відповідь (JSON)

{
  "success": true,
  "data": [
    {
      "Ref": "00000000-0000-0000-0000-000000000000",
      "Description": "ООО",
      "FullName": "Общество с ограниченной ответственностью"
    }
  ],
  "errors": [],
  "warnings": [],
  "info": [],
  "messageCodes": [],
  "errorCodes": [],
  "warningCodes": [],
  "infoCodes": []
}

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

post

Метод getOwnershipFormsList працює в моделі Common (або CommonGeneral) і дозволяє завантажити список форм власності українською мовою.

Необхідно зберігати копію довідників на стороні клієнта та підтримувати її в актуальному стані. Рекомендується проводити оновлення довідників раз на місяць.

Body
apiKeystringRequired

API-ключ користувача

modelNamestring · enumRequired

Назва моделі API

Possible values:
calledMethodstring · enumRequired

Назва методу API

Possible values:
methodPropertiesobject · GetOwnershipFormsListXmlMethodPropertiesRequired

Властивості методу для XML

Responses
200

Успішна відповідь (XML)

application/xml
successbooleanRequired

Прапор успішності виконання запиту

errorsstring[]Required

Масив повідомлень про помилки

warningsstring[]Required

Масив попереджень

infostring[]Required

Масив інформаційних повідомлень

messageCodesstring[]Required

Масив кодів інформаційних повідомлень

errorCodesstring[]Required

Масив кодів помилок

warningCodesstring[]Required

Масив кодів попереджень

infoCodesstring[]Required

Масив кодів додаткової інформації

post/xml/
POST /v2.0/xml/ HTTP/1.1
Host: api.novaposhta.ua/
Content-Type: application/xml
Accept: */*
Content-Length: 250

"<?xml version="1.0" encoding="UTF-8"?>
<file>
    <apiKey>[ВАШ КЛЮЧ]</apiKey>
    <modelName>CommonGeneral</modelName>
    <calledMethod>getOwnershipFormsList</calledMethod>
    <methodProperties>
    </methodProperties>
</file>
"
200

Успішна відповідь (XML)

<?xml version="1.0" encoding="UTF-8"?>
<root>
    <success>true</success>
    <data>
        <Ref>00000000-0000-0000-0000-000000000000</Ref>
        <Description>ООО</Description>
        <FullName>Общество с ограниченной ответственностью</FullName>
    </data>
    <errors/>
    <warnings/>
    <info/>
    <messageCodes/>
    <errorCodes/>
    <warningCodes/>
    <infoCodes/>
</root>

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

post

Метод getPackListSpecial працює в моделі CommonGeneral.

Метод відображає ідентифікатори, необхідні для створення ЕН із послугою пакування. Детальніше — «Cтворити ЕН із додатковими послугами» (метод save моделі InternetDocument).

Окремо можна отримати ідентифікатори для послуги «Пакування в поштоматі» (див. «Створити експрес-накладну з поштомата», метод save моделі InternetDocument). Для цього в параметрі запиту SendingFrom потрібно задати значення Postomat. У значенні параметра New cлід установити 1.

Body
apiKeystringRequired

API-ключ користувача

Example: [ВАШ КЛЮЧ]
modelNamestring · enumRequired

Назва моделі API

Example: CommonGeneralPossible values:
calledMethodstring · enumRequired

Назва методу API

Example: getPackListSpecialPossible values:
Responses
200

Успішна відповідь (JSON)

application/json
successbooleanRequired

Прапор успішності виконання запиту

errorsstring[]Required

Масив повідомлень про помилки

warningsstring[]Required

Масив попереджень

infostring[]Required

Масив інформаційних повідомлень

messageCodesstring[]Required

Масив кодів інформаційних повідомлень

errorCodesstring[]Required

Масив кодів помилок

warningCodesstring[]Required

Масив кодів попереджень

infoCodesstring[]Required

Масив кодів додаткової інформації

post/json/
POST /v2.0/json/ HTTP/1.1
Host: api.novaposhta.ua/
Content-Type: application/json
Accept: */*
Content-Length: 262

{
  "apiKey": "[ВАШ КЛЮЧ]",
  "modelName": "CommonGeneral",
  "calledMethod": "getPackListSpecial",
  "methodProperties": {
    "Length": "100.0",
    "PackForSale": "0",
    "Height": "120.0",
    "CargoType": "Parcel",
    "VolumetricWeight": "2",
    "Width": "240.0",
    "New": "1",
    "SendingFrom": "Postomat"
  }
}
200

Успішна відповідь (JSON)

{
  "success": true,
  "data": [
    {
      "Filtered": [
        {
          "Ref": "cd00107e-2e73-41eb-9056-85a9931c6223",
          "Description": "Пакування на поштоматі",
          "DescriptionRu": " ",
          "Length": "0.0",
          "Width": "0.0",
          "Height": "0.0",
          "VolumetricWeight": "0.00",
          "TypeOfPacking": " ",
          "PackagingForPlace": "1"
        }
      ]
    }
  ],
  "errors": [],
  "warnings": [],
  "info": [],
  "messageCodes": [],
  "errorCodes": [],
  "warningCodes": [],
  "infoCodes": []
}

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

post

Метод getPackListSpecial працює в моделі CommonGeneral.

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

Body
apiKeystringRequired

API-ключ користувача

modelNamestring · enumRequired

Назва моделі API

Possible values:
calledMethodstring · enumRequired

Назва методу API

Possible values:
Responses
200

Успішна відповідь (XML)

application/xml
successbooleanRequired

Прапор успішності виконання запиту

errorsstring[]Required

Масив повідомлень про помилки

warningsstring[]Required

Масив попереджень

infostring[]Required

Масив інформаційних повідомлень

messageCodesstring[]Required

Масив кодів інформаційних повідомлень

errorCodesstring[]Required

Масив кодів помилок

warningCodesstring[]Required

Масив кодів попереджень

infoCodesstring[]Required

Масив кодів додаткової інформації

post/xml/
POST /v2.0/xml/ HTTP/1.1
Host: api.novaposhta.ua/
Content-Type: application/xml
Accept: */*
Content-Length: 533

"<?xml version="1.0" encoding="UTF-8"?>
<file>
    <apiKey>[ВАШ КЛЮЧ]</apiKey>
    <modelName>CommonGeneral</modelName>
    <calledMethod>getPackListSpecial</calledMethod>
    <methodProperties>
        <Length>100.0</Length>
        <PackForSale>0</PackForSale>
        <Height>120.0</Height>
        <CargoType>Parcel</CargoType>
        <VolumetricWeight>2</VolumetricWeight>
        <Width>240.0</Width>
        <New>1</New>
        <SendingFrom>Postomat</SendingFrom>
    </methodProperties>
</file>
"
200

Успішна відповідь (XML)

<?xml version="1.0" encoding="UTF-8"?>
<root>
    <success>true</success>
    <data>
        <Filtered>
            <item>
                <Ref>cd00107e-2e73-41eb-9056-85a9931c6223</Ref>
                <Description>Пакування на поштоматі</Description>
                <DescriptionRu> </DescriptionRu>
                <Length>0.0</Length>
                <Width>0.0</Width>
                <Height>0.0</Height>
                <VolumetricWeight>0.00</VolumetricWeight>
                <TypeOfPacking> </TypeOfPacking>
                <PackagingForPlace>1</PackagingForPlace>
            </item>
        </Filtered>
    </data>
    <errors/>
    <warnings/>
    <info/>
    <messageCodes/>
    <errorCodes/>
    <warningCodes/>
    <infoCodes/>
</root>

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

post

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

Body
apiKeystringRequired

API-ключ користувача

Example: [ВАШ КЛЮЧ]
modelNamestring · enumRequired

Назва моделі API

Example: CommonGeneralPossible values:
calledMethodstring · enumRequired

Назва методу API

Example: getPickupTimeIntervalsPossible values:
Responses
200

Успішна відповідь (JSON)

application/json
successbooleanRequired

Прапор успішності виконання запиту

errorsstring[]Required

Масив повідомлень про помилки

warningsstring[]Required

Масив попереджень

infostring[]Required

Масив інформаційних повідомлень

messageCodesstring[]Required

Масив кодів інформаційних повідомлень

errorCodesstring[]Required

Масив кодів помилок

warningCodesstring[]Required

Масив кодів попереджень

infoCodesstring[]Required

Масив кодів додаткової інформації

post/json/
POST /v2.0/json/ HTTP/1.1
Host: api.novaposhta.ua/
Content-Type: application/json
Accept: */*
Content-Length: 198

{
  "apiKey": "[ВАШ КЛЮЧ]",
  "modelName": "CommonGeneral",
  "calledMethod": "getPickupTimeIntervals",
  "methodProperties": {
    "SenderCityRef": "00000000-0000-0000-0000-000000000000",
    "DateTime": "29.12.2023"
  }
}
200

Успішна відповідь (JSON)

{
  "success": true,
  "data": [
    {
      "Number": "CityPickingTimeInterval3",
      "Start": "08:00",
      "End": "17:00",
      "BoundaryTime": "14:50"
    }
  ],
  "errors": [],
  "warnings": [],
  "info": [],
  "messageCodes": [],
  "errorCodes": [],
  "warningCodes": [],
  "infoCodes": []
}

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

post

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

Body
apiKeystringRequired

API-ключ користувача

modelNamestring · enumRequired

Назва моделі API

Possible values:
calledMethodstring · enumRequired

Назва методу API

Possible values:
Responses
200

Успішна відповідь (XML)

application/xml
successbooleanRequired

Прапор успішності виконання запиту

errorsstring[]Required

Масив повідомлень про помилки

warningsstring[]Required

Масив попереджень

infostring[]Required

Масив інформаційних повідомлень

messageCodesstring[]Required

Масив кодів інформаційних повідомлень

errorCodesstring[]Required

Масив кодів помилок

warningCodesstring[]Required

Масив кодів попереджень

infoCodesstring[]Required

Масив кодів додаткової інформації

post/xml/
POST /v2.0/xml/ HTTP/1.1
Host: api.novaposhta.ua/
Content-Type: application/xml
Accept: */*
Content-Length: 369

"<?xml version="1.0" encoding="UTF-8"?>
<file>
    <apiKey>[ВАШ КЛЮЧ]</apiKey>
    <modelName>CommonGeneral</modelName>
    <calledMethod>getPickupTimeIntervals</calledMethod>
    <methodProperties>
        <SenderCityRef>00000000-0000-0000-0000-000000000000</SenderCityRef>
        <DateTime>29.12.2023</DateTime>
    </methodProperties>
</file>
"
200

Успішна відповідь (XML)

<?xml version="1.0" encoding="UTF-8"?>
<root>
    <success>true</success>
    <data>
        <Number>CityPickingTimeInterval3</Number>
        <Start>08:00</Start>
        <End>17:00</End>
        <BoundaryTime>14:50</BoundaryTime>
    </data>
    <errors/>
    <warnings/>
    <info/>
    <messageCodes/>
    <errorCodes/>
    <warningCodes/>
    <infoCodes/>
</root>

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

post

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

Необхідно зберігати копію довідників на стороні клієнта та підтримувати її в актуальному стані. Рекомендується проводити оновлення довідників раз на місяць.

Body
apiKeystringRequired

API-ключ користувача

Example: [ВАШ КЛЮЧ]
modelNamestring · enumRequired

Назва моделі API

Example: CommonGeneralPossible values:
calledMethodstring · enumRequired

Назва методу API

Example: getServiceTypesPossible values:
methodPropertiesobject · GetServiceTypesMethodPropertiesRequired

Властивості методу (порожній об'єкт)

Responses
200

Успішна відповідь (JSON)

application/json
successbooleanRequired

Прапор успішності виконання запиту

errorsstring[]Required

Масив повідомлень про помилки

warningsstring[]Required

Масив попереджень

infostring[]Required

Масив інформаційних повідомлень

messageCodesstring[]Required

Масив кодів інформаційних повідомлень

errorCodesstring[]Required

Масив кодів помилок

warningCodesstring[]Required

Масив кодів попереджень

infoCodesstring[]Required

Масив кодів додаткової інформації

post/json/
POST /v2.0/json/ HTTP/1.1
Host: api.novaposhta.ua/
Content-Type: application/json
Accept: */*
Content-Length: 113

{
  "apiKey": "[ВАШ КЛЮЧ]",
  "modelName": "CommonGeneral",
  "calledMethod": "getServiceTypes",
  "methodProperties": {}
}
200

Успішна відповідь (JSON)

{
  "success": true,
  "data": [
    {
      "Ref": "DoorsDoors",
      "Description": "Двері-Двері"
    }
  ],
  "errors": [],
  "warnings": [],
  "info": [],
  "messageCodes": [],
  "errorCodes": [],
  "warningCodes": [],
  "infoCodes": []
}

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

post

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

Необхідно зберігати копію довідників на стороні клієнта та підтримувати її в актуальному стані. Рекомендується проводити оновлення довідників раз на місяць.

Body
apiKeystringRequired

API-ключ користувача

modelNamestring · enumRequired

Назва моделі API

Possible values:
calledMethodstring · enumRequired

Назва методу API

Possible values:
methodPropertiesobject · GetServiceTypesXmlMethodPropertiesRequired

Властивості методу для XML

Responses
200

Успішна відповідь (XML)

application/xml
successbooleanRequired

Прапор успішності виконання запиту

errorsstring[]Required

Масив повідомлень про помилки

warningsstring[]Required

Масив попереджень

infostring[]Required

Масив інформаційних повідомлень

messageCodesstring[]Required

Масив кодів інформаційних повідомлень

errorCodesstring[]Required

Масив кодів помилок

warningCodesstring[]Required

Масив кодів попереджень

infoCodesstring[]Required

Масив кодів додаткової інформації

post/xml/
POST /v2.0/xml/ HTTP/1.1
Host: api.novaposhta.ua/
Content-Type: application/xml
Accept: */*
Content-Length: 244

"<?xml version="1.0" encoding="UTF-8"?>
<file>
    <apiKey>[ВАШ КЛЮЧ]</apiKey>
    <modelName>CommonGeneral</modelName>
    <calledMethod>getServiceTypes</calledMethod>
    <methodProperties>
    </methodProperties>
</file>
"
200

Успішна відповідь (XML)

<?xml version="1.0" encoding="UTF-8"?>
<root>
    <success>true</success>
    <data>
        <Ref>DoorsDoors</Ref>
        <Description>Двері-Двері</Description>
    </data>
    <errors/>
    <warnings/>
    <info/>
    <messageCodes/>
    <errorCodes/>
    <warningCodes/>
    <infoCodes/>
</root>
ПопередняДодаткові послуги
НаступнаДруковані форми

Останнє оновлення