Додаткові послуги

Створення переадресації або повернення, зміна даних

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

Створити переадресацію

Перевірити можливість створення переадресації (JSON)

post

Метод checkPossibilityForRedirecting працює в моделі AdditionalServiceGeneral (або AdditionalService). Дозволяє перевірити можливість створення заявки на переадресацію відправлення. Метод доступний лише клієнтам-відправникам.

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: 164

{
  "apiKey": "[ВАШ КЛЮЧ]",
  "modelName": "AdditionalServiceGeneral",
  "calledMethod": "checkPossibilityForRedirecting",
  "methodProperties": {
    "Number": "20600000065609"
  }
}

200

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

{
  "success": true,
  "data": [
    {
      "Ref": "00000000-0000-0000-0000-000000000000",
      "Number": "20600000065609",
      "PayerType": "Sender",
      "PaymentMethod": "Cash",
      "WarehouseRef": "00000000-0000-0000-0000-000000000000",
      "WarehouseDescription": "Відділення №23 (до 30 кг): просп. М. Бажана, 24/1 (м. Позняки)",
      "AddressDescription": "просп. М. Бажана, 24/1 (м. Позняки)",
      "StreetDescription": "просп. М. Бажана",
      "BuildingNumber": "24/1",
      "CityRecipient": "00000000-0000-0000-0000-000000000000",
      "CityRecipientDescription": "Київ",
      "SettlementRecipient": "00000000-0000-0000-0000-000000000000",
      "SettlementRecipientDescription": "Київ",
      "SettlementType": "00000000-0000-0000-0000-000000000000",
      "CounterpartyRecipientRef": "00000000-0000-0000-0000-000000000000",
      "CounterpartyRecipientDescription": "101-10378782",
      "RecipientName": "Іванов Іван Іванович",
      "PhoneSender": "380675387254",
      "PhoneRecipient": "380991234567",
      "DocumentWeight": "1"
    }
  ],
  "errors": [],
  "warnings": [],
  "info": [],
  "messageCodes": [],
  "errorCodes": [],
  "warningCodes": [],
  "infoCodes": []
}

Перевірити можливість створення переадресації (XML)

post

Метод checkPossibilityForRedirecting працює в моделі AdditionalServiceGeneral (або AdditionalService). Дозволяє перевірити можливість створення заявки на переадресацію відправлення. Метод доступний лише клієнтам-відправникам.

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: 297

"<?xml version="1.0" encoding="UTF-8"?>
<file>
  <apiKey>[ВАШ КЛЮЧ]</apiKey>
  <modelName>AdditionalServiceGeneral</modelName>
  <calledMethod>checkPossibilityForRedirecting</calledMethod>
  <methodProperties>
    <Number>20600000065609</Number>
  </methodProperties>
</file>
"

200

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

<?xml version="1.0" encoding="UTF-8"?>
<root>
  <success>true</success>
  <data>
    <item>
      <Ref>00000000-0000-0000-0000-000000000000</Ref>
      <Number>20600000065609</Number>
      <PayerType>Sender</PayerType>
      <PaymentMethod>Cash</PaymentMethod>
      <WarehouseRef>00000000-0000-0000-0000-000000000000</WarehouseRef>
      <WarehouseDescription>Відділення №23 (до 30 кг): просп. М. Бажана, 24/1 (м. Позняки)</WarehouseDescription>
      <AddressDescription>просп. М. Бажана, 24/1 (м. Позняки)</AddressDescription>
      <StreetDescription>просп. М. Бажана</StreetDescription>
      <BuildingNumber>24/1</BuildingNumber>
      <CityRecipient>00000000-0000-0000-0000-000000000000</CityRecipient>
      <CityRecipientDescription>Київ</CityRecipientDescription>
      <SettlementRecipient>00000000-0000-0000-0000-000000000000</SettlementRecipient>
      <SettlementRecipientDescription>Київ</SettlementRecipientDescription>
      <SettlementType>00000000-0000-0000-0000-000000000000</SettlementType>
      <CounterpartyRecipientRef>00000000-0000-0000-0000-000000000000</CounterpartyRecipientRef>
      <CounterpartyRecipientDescription>101-10378782</CounterpartyRecipientDescription>
      <RecipientName>Іванов Іван Іванович</RecipientName>
      <PhoneSender>380675387254</PhoneSender>
      <PhoneRecipient>380991234567</PhoneRecipient>
      <DocumentWeight>1</DocumentWeight>
    </item>
  </data>
  <errors/>
  <warnings/>
  <info/>
  <messageCodes/>
  <errorCodes/>
  <warningCodes/>
  <infoCodes/>
</root>

Створити переадресацію відправлення (JSON)

post

Метод save працює в моделі AdditionalServiceGeneral (або AdditionalService).

Цей метод дозволяє створити заявку на переадресування відправлення на відділення або на адресу. Метод доступний тільки для клієнтів відправників.

Body

apiKeystringRequired

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

Example: [ВАШ КЛЮЧ]

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: 735

{
  "apiKey": "[ВАШ КЛЮЧ]",
  "modelName": "AdditionalServiceGeneral",
  "calledMethod": "save",
  "methodProperties": {
    "IntDocNumber": "206004560074695",
    "PaymentMethod": "Cash",
    "Note": "Довільний опис",
    "OrderType": "orderRedirecting",
    "Recipient": "00000000-0000-0000-0000-000000000000",
    "RecipientContactName": "Іванов Іван Іванович",
    "RecipientPhone": "380685024447",
    "PayerType": "Recipient",
    "Customer": "Sender",
    "ServiceType": "WarehouseWarehouse",
    "RecipientSettlement": "00000000-0000-0000-0000-000000000000",
    "RecipientSettlementStreet": "00000000-0000-0000-0000-000000000000",
    "BuildingNumber": "15",
    "NoteAddressRecipient": "Щось від свого імені",
    "RecipientWarehouse": "00000000-0000-0000-0000-000000000000"
  }
}

200

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

{
  "success": true,
  "data": [
    {
      "Number": "102-00006096",
      "Ref": "00000000-0000-0000-0000-000000000000"
    }
  ],
  "errors": [],
  "warnings": [],
  "info": [],
  "messageCodes": [],
  "errorCodes": [],
  "warningCodes": [],
  "infoCodes": []
}

Створити переадресацію відправлення (XML)

post

Метод save працює в моделі AdditionalServiceGeneral (або AdditionalService).

Цей метод дозволяє створити заявку на переадресування відправлення на відділення або на адресу. Метод доступний тільки для клієнтів відправників.

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: 1207

"<?xml version="1.0" encoding="UTF-8"?>
<file>
    <apiKey>[ВАШ КЛЮЧ]</apiKey>
    <modelName>AdditionalServiceGeneral</modelName>
    <calledMethod>save</calledMethod>
    <methodProperties>
        <IntDocNumber>206004560074695</IntDocNumber>
        <PaymentMethod>Cash</PaymentMethod>
        <Note>Довільний опис</Note>
        <OrderType>orderRedirecting</OrderType>
        <Recipient>00000000-0000-0000-0000-000000000000</Recipient>
        <RecipientContactName>Іванов Іван Іванович</RecipientContactName>
        <RecipientPhone>380685024447</RecipientPhone>
        <PayerType>Recipient</PayerType>
        <Customer>Sender</Customer>
        <ServiceType>WarehouseWarehouse</ServiceType>
        <RecipientSettlement>00000000-0000-0000-0000-000000000000</RecipientSettlement>
        <RecipientSettlementStreet>00000000-0000-0000-0000-000000000000</RecipientSettlementStreet>
        <BuildingNumber>15</BuildingNumber>
        <NoteAddressRecipient>Щось від свого імені</NoteAddressRecipient>
        <RecipientWarehouse>00000000-0000-0000-0000-000000000000</RecipientWarehouse>
    </methodProperties>
</file>
"

200

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

<?xml version="1.0" encoding="UTF-8"?>
<root>
    <success>true</success>
    <data>
        <item>
            <Number>102-00006096</Number>
            <Ref>00000000-0000-0000-0000-000000000000</Ref>
        </item>
    </data>
    <errors/>
    <warnings/>
    <info/>
    <messageCodes/>
    <errorCodes/>
    <warningCodes/>
    <infoCodes/>
</root>

Редагувати заявку на переадресацію (JSON)

post

Метод update працює в моделі AdditionalServiceGeneral (або AdditionalService).

Цей метод дозволяє редагувати вже створену заявку на переадресування відправлення. Редагувати замовлення можна, лише якщо статус замовлення OrderStatus = "Прийняте".

Метод доступний як відправнику, так і отримувачу, проте отримувач може редагувати не всі параметри.

Особливості прав редагування

Відправник може:

• Змінити платника за переадресацію (PayerType)
• Змінити спосіб оплати (PaymentMethod)
• Змінити отримувача (Recipient)
• Змінити контактні дані отримувача
• Змінити ідентифікатор відділення отримувача (RecipientWarehouse) або адресні дані отримувача:

  • Місто отримувача (CityRecipient)
  • Населений пункт отримувача (SettlementRecipient)
  • Вулицю отримувача (RecipientSettlementStreet)
  • Примітку до адреси отримувача (NoteAddressRecipient)
• Змінити примітку до замовлення (Note)

Отримувач може:

• Редагувати ідентифікатор відділення отримувача (RecipientWarehouse)
• Змінювати адресні дані отримувача:

  • Місто отримувача (CityRecipient)
  • Населений пункт отримувача (SettlementRecipient)
  • Вулицю отримувача (RecipientSettlementStreet)
  • Примітку до адреси отримувача (NoteAddressRecipient)

Body

apiKeystringRequired

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

Example: [ВАШ КЛЮЧ]

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: 916

{
  "apiKey": "[ВАШ КЛЮЧ]",
  "modelName": "AdditionalServiceGeneral",
  "calledMethod": "update",
  "methodProperties": {
    "PaymentMethod": "Cash",
    "NoteAddressRecipient": "Додаткова інформація про адресу отримувача",
    "Recipient": "00000000-0000-0000-0000-000000000000",
    "CityRecipient": "db5c8892-391c-11dd-90d9-001a92567626",
    "Note": "Додаткова інформація про замовлення",
    "Customer": "Sender",
    "Ref": "00000000-0000-0000-0000-000000000000",
    "RecipientContactName": "Іванов Іван Іванович",
    "IntDocNumber": "20450123456789",
    "RecipientWarehouse": "aaada586-b04f-11e8-ad0d-005056b24375",
    "RecipientPhone": "380991234567",
    "SettlementRecipient": "e71d006d-4b33-11e4-ab6d-005056801329",
    "BuildingNumber": "15",
    "RecipientSettlementStreet": "09b447c0-6470-11ea-a970-b8830365ade4",
    "ServiceType": "WarehouseWarehouse",
    "PayerType": "Sender",
    "OrderType": "orderRedirecting"
  }
}

200

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

{
  "success": true,
  "data": [
    {
      "SettlementType": "",
      "BuildingNumber": "15",
      "PhoneSender": "",
      "WarehouseDescription": "Відділення №1: вул. Ветеринарна, 22 (заїзд з вул. Європейська \"Меблевий квартал\")",
      "Number": "102-12345678",
      "PhoneRecipient": "380991234567",
      "PayerType": "Sender",
      "DocumentWeight": "",
      "SettlementRecipient": "e71d006d-4b33-11e4-ab6d-005056801329",
      "NoteAddressRecipient": "Додаткова інформація про адресу отримувача",
      "PaymentMethod": "Cash",
      "InternationalDeliveryType": "",
      "CityRecipient": "db5c8892-391c-11dd-90d9-001a92567626",
      "ServiceType": "WarehouseWarehouse",
      "SettlementRecipientDescription": "Полтава",
      "EdrpouRecipient": "",
      "AddressDescription": "м. Полтава, вул. Половки, 15",
      "CounterpartyRecipientRef": "00000000-0000-0000-0000-000000000000",
      "RecipientSettlementStreet": "09b447c0-6470-11ea-a970-b8830365ade4",
      "Ref": "00000000-0000-0000-0000-000000000000",
      "WarehouseRef": "aaada586-b04f-11e8-ad0d-005056b24375",
      "CounterpartyRecipientDescription": "Приватна особа",
      "CityRecipientDescription": "Полтава",
      "StreetDescription": "Половки",
      "RecipientName": "Іванов Іван Іванович"
    }
  ],
  "errors": [],
  "warnings": [],
  "info": [],
  "messageCodes": [],
  "errorCodes": [],
  "warningCodes": [],
  "infoCodes": []
}

Редагувати заявку на переадресацію (XML)

post

Метод update працює в моделі AdditionalServiceGeneral (або AdditionalService).

Цей метод дозволяє редагувати вже створену заявку на переадресування відправлення. Редагувати замовлення можна, лише якщо статус замовлення OrderStatus = "Прийняте".

Метод доступний як відправнику, так і отримувачу, проте отримувач може редагувати не всі параметри.

Особливості прав редагування

Відправник може:

• Змінити платника за переадресацію (PayerType)
• Змінити спосіб оплати (PaymentMethod)
• Змінити отримувача (Recipient)
• Змінити контактні дані отримувача
• Змінити ідентифікатор відділення отримувача (RecipientWarehouse) або адресні дані отримувача:

  • Місто отримувача (CityRecipient)
  • Населений пункт отримувача (SettlementRecipient)
  • Вулицю отримувача (RecipientSettlementStreet)
  • Примітку до адреси отримувача (NoteAddressRecipient)
• Змінити примітку до замовлення (Note)

Отримувач може:

• Редагувати ідентифікатор відділення отримувача (RecipientWarehouse)
• Змінювати адресні дані отримувача:

  • Місто отримувача (CityRecipient)
  • Населений пункт отримувача (SettlementRecipient)
  • Вулицю отримувача (RecipientSettlementStreet)
  • Примітку до адреси отримувача (NoteAddressRecipient)

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: 1422

"<?xml version="1.0" encoding="UTF-8"?>
<file>
    <apiKey>[ВАШ КЛЮЧ]</apiKey>
    <modelName>AdditionalServiceGeneral</modelName>
    <calledMethod>update</calledMethod>
    <methodProperties>
        <PaymentMethod>Cash</PaymentMethod>
        <NoteAddressRecipient>Додаткова інформація про адресу отримувача</NoteAddressRecipient>
        <Recipient>00000000-0000-0000-0000-000000000000</Recipient>
        <CityRecipient>db5c8892-391c-11dd-90d9-001a92567626</CityRecipient>
        <Note>Додаткова інформація про замовлення</Note>
        <Customer>Sender</Customer>
        <Ref>00000000-0000-0000-0000-000000000000</Ref>
        <RecipientContactName>Іванов Іван Іванович</RecipientContactName>
        <IntDocNumber>20450123456789</IntDocNumber>
        <RecipientWarehouse>aaada586-b04f-11e8-ad0d-005056b24375</RecipientWarehouse>
        <RecipientPhone>380991234567</RecipientPhone>
        <SettlementRecipient>e71d006d-4b33-11e4-ab6d-005056801329</SettlementRecipient>
        <BuildingNumber>15</BuildingNumber>
        <RecipientSettlementStreet>09b447c0-6470-11ea-a970-b8830365ade4</RecipientSettlementStreet>
        <ServiceType>WarehouseWarehouse</ServiceType>
        <PayerType>Sender</PayerType>
        <OrderType>orderRedirecting</OrderType>
    </methodProperties>
</file>
"

200

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

<?xml version="1.0" encoding="UTF-8"?>
<root>
    <success>true</success>
    <data>
        <item>
            <SettlementType></SettlementType>
            <BuildingNumber>15</BuildingNumber>
            <PhoneSender></PhoneSender>
            <WarehouseDescription>Відділення №1: вул. Ветеринарна, 22 (заїзд з вул. Європейська "Меблевий квартал")</WarehouseDescription>
            <Number>102-12345678</Number>
            <PhoneRecipient>380991234567</PhoneRecipient>
            <PayerType>Sender</PayerType>
            <DocumentWeight></DocumentWeight>
            <SettlementRecipient>e71d006d-4b33-11e4-ab6d-005056801329</SettlementRecipient>
            <NoteAddressRecipient>Додаткова інформація про адресу отримувача</NoteAddressRecipient>
            <PaymentMethod>Cash</PaymentMethod>
            <InternationalDeliveryType></InternationalDeliveryType>
            <CityRecipient>db5c8892-391c-11dd-90d9-001a92567626</CityRecipient>
            <ServiceType>WarehouseWarehouse</ServiceType>
            <SettlementRecipientDescription>Полтава</SettlementRecipientDescription>
            <EdrpouRecipient></EdrpouRecipient>
            <AddressDescription>м. Полтава, вул. Половки, 15</AddressDescription>
            <CounterpartyRecipientRef>00000000-0000-0000-0000-000000000000</CounterpartyRecipientRef>
            <RecipientSettlementStreet>09b447c0-6470-11ea-a970-b8830365ade4</RecipientSettlementStreet>
            <Ref>00000000-0000-0000-0000-000000000000</Ref>
            <WarehouseRef>aaada586-b04f-11e8-ad0d-005056b24375</WarehouseRef>
            <CounterpartyRecipientDescription>Приватна особа</CounterpartyRecipientDescription>
            <CityRecipientDescription>Полтава</CityRecipientDescription>
            <StreetDescription>Половки</StreetDescription>
            <RecipientName>Іванов Іван Іванович</RecipientName>
        </item>
    </data>
    <errors/>
    <warnings/>
    <info/>
    <messageCodes/>
    <errorCodes/>
    <warningCodes/>
    <infoCodes/>
</root>

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

post

Метод getRedirectionOrdersList працює в моделі AdditionalServiceGeneral (або AdditionalService).

Цей метод дозволяє отримати список створених заявок на переадресування відправлень.

Body

apiKeystringRequired

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

Example: [ВАШ КЛЮЧ]

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: 289

{
  "apiKey": "[ВАШ КЛЮЧ]",
  "modelName": "AdditionalServiceGeneral",
  "calledMethod": "getRedirectionOrdersList",
  "methodProperties": {
    "Number": "102-00010160",
    "Ref": "00000000-0000-0000-0000-000000000000",
    "BeginDate": "дд.мм.рррр",
    "EndDate": "дд.мм.рррр",
    "Page": "1",
    "Limit": "50"
  }
}

200

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

{
  "success": true,
  "data": [
    {
      "OrderRef": "00000000-0000-0000-0000-000000000000",
      "OrderNumber": "102-00010160",
      "DateTime": "дд.мм.рррр чч:хх:сс",
      "DocumentNumber": "20600000065470",
      "Note": "Опис причини переадресування",
      "CityRecipient": "Київ",
      "RecipientAddress": "Хрещатик 1, кв 1",
      "CounterpartyRecipient": "Приватна особа",
      "RecipientName": "Іванов Іван Іванович",
      "PhoneRecipient": "380675387254",
      "PayerType": "Recipient",
      "DeliveryCost": "25",
      "EstimatedDeliveryDate": "дд.мм.рррр",
      "ExpressWaybillNumber": "59000042661412",
      "ExpressWaybillStatus": "Готується до відправлення"
    }
  ],
  "errors": [],
  "warnings": [],
  "info": [],
  "messageCodes": [],
  "errorCodes": [],
  "warningCodes": [],
  "infoCodes": []
}

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

post

Метод getRedirectionOrdersList працює в моделі AdditionalServiceGeneral (або AdditionalService).

Цей метод дозволяє отримати список створених заявок на переадресування відправлень.

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: 509

"<?xml version="1.0" encoding="UTF-8"?>
<file>
    <apiKey>[ВАШ КЛЮЧ]</apiKey>
    <modelName>AdditionalServiceGeneral</modelName>
    <calledMethod>getRedirectionOrdersList</calledMethod>
    <methodProperties>
        <Number>102-00010160</Number>
        <Ref>00000000-0000-0000-0000-000000000000</Ref>
        <BeginDate>дд.мм.рррр</BeginDate>
        <EndDate>дд.мм.рррр</EndDate>
        <Page>1</Page>
        <Limit>50</Limit>
    </methodProperties>
</file>
"

200

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

<?xml version="1.0" encoding="UTF-8"?>
<root>
    <success>true</success>
    <data>
        <item>
            <OrderRef>00000000-0000-0000-0000-000000000000</OrderRef>
            <OrderNumber>102-00010160</OrderNumber>
            <DateTime>дд.мм.рррр чч:хх:сс</DateTime>
            <DocumentNumber>20600000065470</DocumentNumber>
            <Note>Опис причини переадресування</Note>
            <CityRecipient>Київ</CityRecipient>
            <RecipientAddress>Хрещатик 1, кв 1</RecipientAddress>
            <CounterpartyRecipient>Приватна особа</CounterpartyRecipient>
            <RecipientName>Іванов Іван Іванович</RecipientName>
            <PhoneRecipient>380675387254</PhoneRecipient>
            <PayerType>Recipient</PayerType>
            <DeliveryCost>25</DeliveryCost>
            <EstimatedDeliveryDate>дд.мм.рррр</EstimatedDeliveryDate>
            <ExpressWaybillNumber>59000042661412</ExpressWaybillNumber>
            <ExpressWaybillStatus>Готується до відправлення</ExpressWaybillStatus>
        </item>
    </data>
    <errors/>
    <warnings/>
    <info/>
    <messageCodes/>
    <errorCodes/>
    <warningCodes/>
    <infoCodes/>
</root>

Перевірити можливість редагування переадресації (JSON)

post

Метод checkPossibilityForRedirecting працює в моделі AdditionalServiceGeneral (або AdditionalService). Дозволяє перевірити можливість редагування вже створеної заявки на переадресування. Доступний відправнику та отримувачу з обмеженнями щодо редагованих полів.

Особливості редагування для відправника та отримувача

Метод доступний як відправнику, так і отримувачу, проте отримувач може редагувати не всі параметри. Існують такі особливості редагування:

Якщо замовник перевірки є відправником, він може:

• Змінити отримувача
• Змінити адресу доставки
• Вказати платника за переадресацію (себе, якщо вибрано безготівкову форму розрахунку, або отримувача, якщо йому доступна ця форма оплати)

Якщо замовник перевірки є отримувачем, він може редагувати лише адресу доставки.

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: 815

{
  "apiKey": "[ВАШ КЛЮЧ]",
  "modelName": "AdditionalServiceGeneral",
  "calledMethod": "checkPossibilityForRedirecting",
  "methodProperties": {
    "OrderRef": "00000000-0000-0000-0000-000000000000",
    "AddressDescription": "просп. М. Бажана, 24/1 (м. Позняки)",
    "RecipientName": "Іванов Іван Іванович",
    "PhoneSender": "380675387254",
    "StreetDescription": "просп. М. Бажана",
    "PhoneRecipient": "380991234567",
    "BuildingNumber": "24",
    "CityRecipient": "00000000-0000-0000-0000-000000000000",
    "DocumentWeight": "1",
    "SettlementRecipient": "00000000-0000-0000-0000-000000000000",
    "SettlementType": "00000000-0000-0000-0000-000000000000",
    "PayerType": "Sender",
    "PaymentMethod": "Cash",
    "CounterpartyRecipientRef": "00000000-0000-0000-0000-000000000000",
    "WarehouseRef": "00000000-0000-0000-0000-000000000000"
  }
}

200

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

{
  "success": true,
  "data": [
    {
      "PhoneSender": "380675387254",
      "BuildingNumber": "24/1",
      "PhoneRecipient": "380991234567",
      "CityRecipient": "00000000-0000-0000-0000-000000000000",
      "DocumentWeight": "1",
      "Ref": "00000000-0000-0000-0000-000000000000",
      "CityRecipientDescription": "Київ",
      "Number": "20600000065609",
      "SettlementRecipient": "00000000-0000-0000-0000-000000000000",
      "SettlementRecipientDescription": "Київ",
      "PayerType": "Sender",
      "SettlementType": "00000000-0000-0000-0000-000000000000",
      "PaymentMethod": "Cash",
      "CounterpartyRecipientRef": "00000000-0000-0000-0000-000000000000",
      "WarehouseRef": "00000000-0000-0000-0000-000000000000",
      "CounterpartyRecipientDescription": "101-10378782",
      "WarehouseDescription": "Відділення №23 (до 30 кг): просп. М. Бажана, 24/1 (м. Позняки)",
      "AddressDescription": "просп. М. Бажана, 24/1 (м. Позняки)",
      "RecipientName": "Іванов Іван Іванович",
      "StreetDescription": "просп. М. Бажана"
    }
  ],
  "errors": [],
  "warnings": [],
  "info": [],
  "messageCodes": [],
  "errorCodes": [],
  "warningCodes": [],
  "infoCodes": []
}

Перевірити можливість редагування переадресації (XML)

post

Метод checkPossibilityForRedirecting працює в моделі AdditionalServiceGeneral (або AdditionalService). Дозволяє перевірити можливість редагування вже створеної заявки на переадресування. Доступний відправнику та отримувачу з обмеженнями щодо редагованих полів.

Особливості редагування для відправника та отримувача

Метод доступний як відправнику, так і отримувачу, проте отримувач може редагувати не всі параметри. Існують такі особливості редагування:

Якщо замовник перевірки є відправником, він може:

• Змінити отримувача
• Змінити адресу доставки
• Вказати платника за переадресацію (себе, якщо вибрано безготівкову форму розрахунку, або отримувача, якщо йому доступна ця форма оплати)

Якщо замовник перевірки є отримувачем, він може редагувати лише адресу доставки.

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: 1297

"<?xml version="1.0" encoding="UTF-8"?>
<file>
    <apiKey>[ВАШ КЛЮЧ]</apiKey>
    <modelName>AdditionalServiceGeneral</modelName>
    <calledMethod>checkPossibilityForRedirecting</calledMethod>
    <methodProperties>
        <OrderRef>00000000-0000-0000-0000-000000000000</OrderRef>
        <AddressDescription>просп. М. Бажана, 24\/1 (м. Позняки)</AddressDescription>
        <RecipientName>Іванов Іван Іванович</RecipientName>
        <PhoneSender>380675387254</PhoneSender>
        <StreetDescription>просп. М. Бажана</StreetDescription>
        <PhoneRecipient>380991234567</PhoneRecipient>
        <BuildingNumber>24</BuildingNumber>
        <CityRecipient>00000000-0000-0000-0000-000000000000</CityRecipient>
        <DocumentWeight>1</DocumentWeight>
        <SettlementRecipient>00000000-0000-0000-0000-000000000000</SettlementRecipient>
        <SettlementType>00000000-0000-0000-0000-000000000000</SettlementType>
        <PayerType>Sender</PayerType>
        <PaymentMethod>Cash</PaymentMethod>
        <CounterpartyRecipientRef>00000000-0000-0000-0000-000000000000</CounterpartyRecipientRef>
        <WarehouseRef>00000000-0000-0000-0000-000000000000</WarehouseRef>
    </methodProperties>
</file>
"

200

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

<?xml version="1.0" encoding="UTF-8"?>
<root>
    <success>true</success>
    <data>
        <item>
            <PhoneSender>380675387254</PhoneSender>
            <BuildingNumber>24\/1</BuildingNumber>
            <PhoneRecipient>380991234567</PhoneRecipient>
            <CityRecipient>00000000-0000-0000-0000-000000000000</CityRecipient>
            <DocumentWeight>1</DocumentWeight>
            <Ref>00000000-0000-0000-0000-000000000000</Ref>
            <CityRecipientDescription>Київ</CityRecipientDescription>
            <Number>20600000065609</Number>
            <SettlementRecipient>00000000-0000-0000-0000-000000000000</SettlementRecipient>
            <SettlementRecipientDescription>Київ</SettlementRecipientDescription>
            <PayerType>Sender</PayerType>
            <SettlementType>00000000-0000-0000-0000-000000000000</SettlementType>
            <PaymentMethod>Cash</PaymentMethod>
            <CounterpartyRecipientRef>00000000-0000-0000-0000-000000000000</CounterpartyRecipientRef>
            <WarehouseRef>00000000-0000-0000-0000-000000000000</WarehouseRef>
            <CounterpartyRecipientDescription>101-10378782</CounterpartyRecipientDescription>
            <WarehouseDescription>Відділення №23 (до 30 кг): просп. М. Бажана, 24\/1 (м. Позняки)</WarehouseDescription>
            <AddressDescription>просп. М. Бажана, 24\/1 (м. Позняки)</AddressDescription>
            <RecipientName>Іванов Іван Іванович</RecipientName>
            <StreetDescription>просп. М. Бажана</StreetDescription>
        </item>
    </data>
    <errors/>
    <warnings/>
    <info/>
    <messageCodes/>
    <errorCodes/>
    <warningCodes/>
    <infoCodes/>
</root>

Розрахувати переадресацію (JSON)

post

Метод save працює в моделі AdditionalServiceGeneral (або AdditionalService). Цей метод дозволяє розрахувати переадресування.

Особливості використання

Запит майже ідентичний до створення заявки на переадресування. Відмінність тільки в тому, що використовується параметр OnlyGetPricing із значенням «1». Метод доступний лише для клієнтів-відправників.

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: 756

{
  "apiKey": "[ВАШ КЛЮЧ]",
  "modelName": "AdditionalServiceGeneral",
  "calledMethod": "save",
  "methodProperties": {
    "RecipientSettlement": "00000000-0000-0000-0000-000000000000",
    "Recipient": "00000000-0000-0000-0000-000000000000",
    "RecipientSettlementStreet": "00000000-0000-0000-0000-000000000000",
    "RecipientWarehouse": "00000000-0000-0000-0000-000000000000",
    "BuildingNumber": "15",
    "NoteAddressRecipient": "Щось від свого імені",
    "Customer": "Sender",
    "RecipientContactName": "Іванов Іван Іванович",
    "RecipientPhone": "380685024447",
    "IntDocNumber": "206004560074695",
    "PaymentMethod": "Cash",
    "PayerType": "Recipient",
    "Note": "Довільний опис",
    "OrderType": "orderRedirecting",
    "ServiceType": "WarehouseWarehouse",
    "OnlyGetPricing": "1"
  }
}

200

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

{
  "success": true,
  "data": [
    {
      "Pricing": {
        "Services": [
          {
            "Service": "Переадресування в межах України",
            "Cost": 0
          }
        ],
        "Total": 0,
        "FirstDayStorage": "0000-00-00 00:00:00"
      },
      "ScheduledDeliveryDate": "2024-05-18 12:00:00"
    }
  ],
  "errors": [],
  "warnings": [],
  "info": [],
  "messageCodes": [],
  "errorCodes": [],
  "warningCodes": [],
  "infoCodes": []
}

Розрахувати переадресацію (XML)

post

Метод save працює в моделі AdditionalServiceGeneral (або AdditionalService). Цей метод дозволяє розрахувати переадресування.

Особливості використання

Запит майже ідентичний до створення заявки на переадресування. Відмінність тільки в тому, що використовується параметр OnlyGetPricing із значенням «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: 1251

"<?xml version="1.0" encoding="UTF-8"?>
<file>
    <apiKey>[ВАШ КЛЮЧ]</apiKey>
    <modelName>AdditionalServiceGeneral</modelName>
    <calledMethod>save</calledMethod>
    <methodProperties>
        <RecipientSettlement>00000000-0000-0000-0000-000000000000</RecipientSettlement>
        <Recipient>00000000-0000-0000-0000-000000000000</Recipient>
        <RecipientSettlementStreet>00000000-0000-0000-0000-000000000000</RecipientSettlementStreet>
        <RecipientWarehouse>00000000-0000-0000-0000-000000000000</RecipientWarehouse>
        <BuildingNumber>15</BuildingNumber>
        <NoteAddressRecipient>Щось від свого імені</NoteAddressRecipient>
        <Customer>Sender</Customer>
        <RecipientContactName>Іванов Іван Іванович</RecipientContactName>
        <RecipientPhone>380685024447</RecipientPhone>
        <IntDocNumber>206004560074695</IntDocNumber>
        <PaymentMethod>Cash</PaymentMethod>
        <PayerType>Recipient</PayerType>
        <Note>Довільний опис</Note>
        <OrderType>orderRedirecting</OrderType>
        <ServiceType>WarehouseWarehouse</ServiceType>
        <OnlyGetPricing>1</OnlyGetPricing>
    </methodProperties>
</file>
"

200

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

<?xml version="1.0" encoding="UTF-8"?>
<root>
    <success>true</success>
    <data>
        <item>
            <Pricing>
                <Services>
                    <item>
                        <Service>Переадресування в межах України</Service>
                        <Cost>0</Cost>
                    </item>
                </Services>
                <Total>0</Total>
                <FirstDayStorage>0000-00-00 00:00:00</FirstDayStorage>
            </Pricing>
            <ScheduledDeliveryDate>2024-05-18 12:00:00</ScheduledDeliveryDate>
        </item>
    </data>
    <errors/>
    <warnings/>
    <info/>
    <messageCodes/>
    <errorCodes/>
    <warningCodes/>
    <infoCodes/>
</root>

Створити повернення

Перевірити можливість створення повернення (JSON)

post

Метод CheckPossibilityCreateReturn працює в моделі AdditionalService (або AdditionalServiceGeneral) і дозволяє перевірити можливість створення заявки на повернення.

Метод доступний лише для клієнтів-відправників. У разі успіху повертаються блоки адрес, які можна використовувати для створення заявки.

Body

apiKeystringRequired

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

Example: [ВАШ КЛЮЧ]

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: 162

{
  "apiKey": "[ВАШ КЛЮЧ]",
  "modelName": "AdditionalServiceGeneral",
  "calledMethod": "CheckPossibilityCreateReturn",
  "methodProperties": {
    "Number": "20450520287825"
  }
}

200

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

{
  "success": true,
  "data": [
    {
      "NonCash": true,
      "City": "Київ",
      "Counterparty": "ТОВ Яблуневий сад",
      "ContactPerson": "Іванов Іван Іванович",
      "Address": "м. Київ,  вул. Хрещатик, буд. 1",
      "Phone": "380950000000",
      "Ref": "00000000-0000-0000-0000-000000000000"
    }
  ],
  "errors": [],
  "warnings": [],
  "info": [],
  "messageCodes": [],
  "errorCodes": [],
  "warningCodes": [],
  "infoCodes": []
}

Перевірити можливість створення повернення (XML)

post

Метод CheckPossibilityCreateReturn працює в моделі AdditionalService (або AdditionalServiceGeneral) і дозволяє перевірити можливість створення заявки на повернення.

Метод доступний лише для клієнтів-відправників. У разі успіху повертаються блоки адрес, які можна використовувати для створення заявки.

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: 309

"<?xml version="1.0" encoding="UTF-8"?>
<file>
    <apiKey>[ВАШ КЛЮЧ]</apiKey>
    <modelName>AdditionalServiceGeneral</modelName>
    <calledMethod>CheckPossibilityCreateReturn</calledMethod>
    <methodProperties>
        <Number>20450520287825</Number>
    </methodProperties>
</file>
"

200

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

<?xml version="1.0" encoding="UTF-8"?>
<root>
    <success>true</success>
    <data>
        <item>
            <NonCash>true</NonCash>
            <City>Київ</City>
            <Counterparty>ТОВ Яблуневий сад</Counterparty>
            <ContactPerson>Іванов Іван Іванович</ContactPerson>
            <Address>м. Київ,  вул. Хрещатик, буд. 1</Address>
            <Phone>380950000000</Phone>
            <Ref>00000000-0000-0000-0000-000000000000</Ref>
        </item>
    </data>
    <errors/>
    <warnings/>
    <info/>
    <messageCodes/>
    <errorCodes/>
    <warningCodes/>
    <infoCodes/>
</root>

Створити повернення (JSON)

post

Метод save працює в моделі AdditionalService і дозволяє створити заявку на повернення (метод доступний тільки для клієнтів відправників). Цей метод підтримує декілька варіантів повернення: на адресу відправника, на нову адресу та на нове відділення. Основна частина методу однакова для всіх випадків, але відрізняються параметри адреси у запиті.

Повернення на адресу відправлення

Необхідно вказати ідентифікатор адреси відправлення. Адреса повертається у відповіді методу CheckPossibilityCreateReturn.

Приклад:

{
  "apiKey": "[ВАШ КЛЮЧ]",
  "modelName": "AdditionalServiceGeneral",
  "calledMethod": "save",
  "methodProperties": {
    "IntDocNumber": "206004560074695",
    "PaymentMethod": "Cash",
    "Reason": "00000000-0000-0000-0000-000000000000",
    "SubtypeReason": "00000000-0000-0000-0000-000000000000",
    "Note": "Additional information",
    "OrderType": "orderCargoReturn",
    "ReturnAddressRef": "00000000-0000-0000-0000-000000000000"
  }
}

Повернення на нову адресу

Необхідно вказати параметри нової адреси.

Приклад:

{
  "apiKey": "[ВАШ КЛЮЧ]",
  "modelName": "AdditionalServiceGeneral",
  "calledMethod": "save",
  "methodProperties": {
    "IntDocNumber": "206004560074695",
    "PaymentMethod": "Cash",
    "Reason": "00000000-0000-0000-0000-000000000000",
    "SubtypeReason": "00000000-0000-0000-0000-000000000000",
    "Note": "Additional information",
    "OrderType": "orderCargoReturn",
    "RecipientSettlement": "00000000-0000-0000-0000-000000000000",
    "RecipientSettlementStreet": "00000000-0000-0000-0000-000000000000",
    "BuildingNumber": "4",
    "NoteAddressRecipient": "2"
  }
}

Повернення на нове відділення

Необхідно вказати ідентифікатор відділення для повернення. Ідентифікатор повертається у відповіді методу CheckPossibilityCreateReturn.

Приклад:

{
  "apiKey": "[ВАШ КЛЮЧ]",
  "modelName": "AdditionalServiceGeneral",
  "calledMethod": "save",
  "methodProperties": {
    "IntDocNumber": "206004560074695",
    "PaymentMethod": "Cash",
    "Reason": "00000000-0000-0000-0000-000000000000",
    "SubtypeReason": "00000000-0000-0000-0000-000000000000",
    "Note": "Additional information",
    "OrderType": "orderCargoReturn",
    "RecipientWarehouse": "00000000-0000-0000-0000-000000000000"
  }
}

Відповідь однакова у всіх випадках.

Body

apiKeystringRequired

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

Example: [ВАШ КЛЮЧ]

modelNamestring · enumRequired

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

Example: AdditionalServiceGeneralPossible values:

calledMethodstring · enumRequired

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

Example: savePossible values:

Responses

200

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

application/json

successbooleanRequired

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

Example: true

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: 633

{
  "apiKey": "[ВАШ КЛЮЧ]",
  "modelName": "AdditionalServiceGeneral",
  "calledMethod": "save",
  "methodProperties": {
    "BuildingNumber": "4",
    "NoteAddressRecipient": "2",
    "RecipientSettlement": "00000000-0000-0000-0000-000000000000",
    "RecipientWarehouse": "00000000-0000-0000-0000-000000000000",
    "IntDocNumber": "206004560074695",
    "PaymentMethod": "Cash",
    "Reason": "00000000-0000-0000-0000-000000000000",
    "SubtypeReason": "00000000-0000-0000-0000-000000000000",
    "Note": "Довільний опис",
    "OrderType": "orderCargoReturn",
    "ReturnAddressRef": "00000000-0000-0000-0000-000000000000",
    "RecipientSettlementStreet": "00000000-0000-0000-0000-000000000000"
  }
}

200

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

{
  "success": true,
  "data": [
    {
      "Number": "102-00006096",
      "Ref": "00000000-0000-0000-0000-000000000000"
    }
  ],
  "errors": [],
  "warnings": [],
  "info": [],
  "messageCodes": [],
  "errorCodes": [],
  "warningCodes": [],
  "infoCodes": []
}

Створити повернення (XML)

post

Метод save працює в моделі AdditionalService і дозволяє створити заявку на повернення (метод доступний тільки для клієнтів відправників). Цей метод підтримує декілька варіантів повернення: на адресу відправника, на нову адресу та на нове відділення. Основна частина методу однакова для всіх випадків, але відрізняються параметри адреси у запиті.

Повернення на адресу відправлення

Необхідно вказати ідентифікатор адреси відправлення. Адреса повертається у відповіді методу CheckPossibilityCreateReturn.

Приклад:

{
  "apiKey": "[ВАШ КЛЮЧ]",
  "modelName": "AdditionalServiceGeneral",
  "calledMethod": "save",
  "methodProperties": {
    "IntDocNumber": "206004560074695",
    "PaymentMethod": "Cash",
    "Reason": "00000000-0000-0000-0000-000000000000",
    "SubtypeReason": "00000000-0000-0000-0000-000000000000",
    "Note": "Additional information",
    "OrderType": "orderCargoReturn",
    "ReturnAddressRef": "00000000-0000-0000-0000-000000000000"
  }
}

Повернення на нову адресу

Необхідно вказати параметри нової адреси.

Приклад:

{
  "apiKey": "[ВАШ КЛЮЧ]",
  "modelName": "AdditionalServiceGeneral",
  "calledMethod": "save",
  "methodProperties": {
    "IntDocNumber": "206004560074695",
    "PaymentMethod": "Cash",
    "Reason": "00000000-0000-0000-0000-000000000000",
    "SubtypeReason": "00000000-0000-0000-0000-000000000000",
    "Note": "Additional information",
    "OrderType": "orderCargoReturn",
    "RecipientSettlement": "00000000-0000-0000-0000-000000000000",
    "RecipientSettlementStreet": "00000000-0000-0000-0000-000000000000",
    "BuildingNumber": "4",
    "NoteAddressRecipient": "2"
  }
}

Повернення на нове відділення

Необхідно вказати ідентифікатор відділення для повернення. Ідентифікатор повертається у відповіді методу CheckPossibilityCreateReturn.

Приклад:

{
  "apiKey": "[ВАШ КЛЮЧ]",
  "modelName": "AdditionalServiceGeneral",
  "calledMethod": "save",
  "methodProperties": {
    "IntDocNumber": "206004560074695",
    "PaymentMethod": "Cash",
    "Reason": "00000000-0000-0000-0000-000000000000",
    "SubtypeReason": "00000000-0000-0000-0000-000000000000",
    "Note": "Additional information",
    "OrderType": "orderCargoReturn",
    "RecipientWarehouse": "00000000-0000-0000-0000-000000000000"
  }
}

Відповідь однакова у всіх випадках.

Body

apiKeystringRequired

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

Example: [ВАШ КЛЮЧ]

modelNamestring · enumRequired

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

Example: AdditionalServiceGeneralPossible values:

calledMethodstring · enumRequired

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

Example: savePossible values:

Responses

200

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

application/xml

successbooleanRequired

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

Example: true

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: 1042

"<?xml version="1.0" encoding="UTF-8"?>
<file>
    <apiKey>[ВАШ КЛЮЧ]</apiKey>
    <modelName>AdditionalServiceGeneral</modelName>
    <calledMethod>save</calledMethod>
    <methodProperties>
        <BuildingNumber>4</BuildingNumber>
        <NoteAddressRecipient>2</NoteAddressRecipient>
        <RecipientSettlement>00000000-0000-0000-0000-000000000000</RecipientSettlement>
        <RecipientWarehouse>00000000-0000-0000-0000-000000000000</RecipientWarehouse>
        <IntDocNumber>206004560074695</IntDocNumber>
        <PaymentMethod>Cash</PaymentMethod>
        <Reason>00000000-0000-0000-0000-000000000000</Reason>
        <SubtypeReason>00000000-0000-0000-0000-000000000000</SubtypeReason>
        <Note>Довільний опис</Note>
        <OrderType>orderCargoReturn</OrderType>
        <ReturnAddressRef>00000000-0000-0000-0000-000000000000</ReturnAddressRef>
        <RecipientSettlementStreet>00000000-0000-0000-0000-000000000000</RecipientSettlementStreet>
    </methodProperties>
</file>
"

200

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

<?xml version="1.0" encoding="UTF-8"?>
<root>
    <success>true</success>
    <data>
        <item>
            <Number>102-00006096</Number>
            <Ref>00000000-0000-0000-0000-000000000000</Ref>
        </item>
    </data>
    <errors/>
    <warnings/>
    <info/>
    <messageCodes/>
    <errorCodes/>
    <warningCodes/>
    <infoCodes/>
</root>

Редагувати створене повернення (JSON)

post

Метод update працює в моделі AdditionalServiceGeneral (або AdditionalService). Цей метод дозволяє редагувати вже створену заявку на повернення відправлення.

Редагувати можна, лише якщо статус замовлення OrderStatus = "Прийняте". Клієнт передає ідентифікатор створеного замовлення (Ref) та параметри, які необхідно відредагувати.

Варіанти редагування адреси повернення

• Редагування замовлення до нового відділення: Клієнт може змінить відділення, до якого буде здійснюватися повернення. Для цього необхідно передати новий ідентифікатор відділення у параметрі RecipientWarehouse. Цей параметр використовується для зазначення нового місця доставки відправлення у межах мережі відділень.
• Редагування замовлення до нової адреси: Клієнт може змінить адресу, до якої буде здійснюватися повернення. Для цього необхідно передати нові значення для параметрів RecipientSettlement, RecipientSettlementStreet, BuildingNumber та інших, що стосуються адреси. Цей параметр використовується для зазначення нового місця доставки відправлення поза межами стандартних відділень, наприклад, на домашню або офісну адресу.

В обох випадках клієнт також може передавати інші параметри, які необхідно відредагувати, зокрема PaymentMethod, Reason, SubtypeReason тощо. У відповіді надається інформація щодо ціноутворення та запланованої дати доставки для відредагованого замовлення на повернення.

Body

apiKeystringRequired

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

Example: [ВАШ КЛЮЧ]

modelNamestring · enumRequired

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

Example: AdditionalServiceGeneralPossible values:

calledMethodstring · enumRequired

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

Example: updatePossible 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: 606

{
  "apiKey": "[ВАШ КЛЮЧ]",
  "modelName": "AdditionalServiceGeneral",
  "calledMethod": "update",
  "methodProperties": {
    "Ref": "00000000-0000-0000-0000-000000000000",
    "OnlyGetPricing": true,
    "RecipientSettlement": "00000000-0000-0000-0000-000000000000",
    "RecipientWarehouse": "00000000-0000-0000-0000-000000000000",
    "IntDocNumber": "20450123456789",
    "RecipientSettlementStreet": "00000000-0000-0000-0000-000000000000",
    "PaymentMethod": "Cash",
    "BuildingNumber": "15",
    "OrderType": "orderCargoReturn",
    "NoteAddressRecipient": "",
    "Reason": "00000000-0000-0000-0000-000000000000",
    "SubtypeReason": "00000000-0000-0000-0000-000000000000"
  }
}

200

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

{
  "success": true,
  "data": [
    {
      "ScheduledDeliveryDate": "2024-06-01 18:00:00",
      "Pricing": {
        "Services": [],
        "Total": "5.52",
        "FirstDayStorage": "0000-00-00 00:00:00"
      }
    }
  ],
  "errors": [],
  "warnings": [],
  "info": [],
  "messageCodes": [],
  "errorCodes": [],
  "warningCodes": [],
  "infoCodes": []
}

Редагувати створене повернення (XML)

post

Метод update працює в моделі AdditionalServiceGeneral (або AdditionalService). Цей метод дозволяє редагувати вже створену заявку на повернення відправлення.

Редагувати можна, лише якщо статус замовлення OrderStatus = "Прийняте". Клієнт передає ідентифікатор створеного замовлення (Ref) та параметри, які необхідно відредагувати.

Варіанти редагування адреси повернення

• Редагування замовлення до нового відділення: Клієнт може змінить відділення, до якого буде здійснюватися повернення. Для цього необхідно передати новий ідентифікатор відділення у параметрі RecipientWarehouse. Цей параметр використовується для зазначення нового місця доставки відправлення у межах мережі відділень.
• Редагування замовлення до нової адреси: Клієнт може змінить адресу, до якої буде здійснюватися повернення. Для цього необхідно передати нові значення для параметрів RecipientSettlement, RecipientSettlementStreet, BuildingNumber та інших, що стосуються адреси. Цей параметр використовується для зазначення нового місця доставки відправлення поза межами стандартних відділень, наприклад, на домашню або офісну адресу.

В обох випадках клієнт також може передавати інші параметри, які необхідно відредагувати, зокрема PaymentMethod, Reason, SubtypeReason тощо. У відповіді надається інформація щодо ціноутворення та запланованої дати доставки для відредагованого замовлення на повернення.

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: 1014

"<?xml version="1.0" encoding="UTF-8"?>
<file>
    <apiKey>[ВАШ КЛЮЧ]</apiKey>
    <modelName>AdditionalServiceGeneral</modelName>
    <calledMethod>update</calledMethod>
    <methodProperties>
        <Ref>00000000-0000-0000-0000-000000000000</Ref>
        <OnlyGetPricing>true</OnlyGetPricing>
        <RecipientSettlement>00000000-0000-0000-0000-000000000000</RecipientSettlement>
        <RecipientWarehouse>00000000-0000-0000-0000-000000000000</RecipientWarehouse>
        <IntDocNumber>20450123456789</IntDocNumber>
        <RecipientSettlementStreet>00000000-0000-0000-0000-000000000000</RecipientSettlementStreet>
        <PaymentMethod>Cash</PaymentMethod>
        <BuildingNumber>15</BuildingNumber>
        <OrderType>orderCargoReturn</OrderType>
        <NoteAddressRecipient></NoteAddressRecipient>
        <Reason>00000000-0000-0000-0000-000000000000</Reason>
        <SubtypeReason>00000000-0000-0000-0000-000000000000</SubtypeReason>
    </methodProperties>
</file>
"

200

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

<?xml version="1.0" encoding="UTF-8"?>
<root>
    <success>true</success>
    <data>
        <item>
            <ScheduledDeliveryDate>2024-06-01 18:00:00</ScheduledDeliveryDate>
            <Pricing>
                <Services/>
                <Total>5.52</Total>
                <FirstDayStorage>0000-00-00 00:00:00</FirstDayStorage>
            </Pricing>
        </item>
    </data>
    <errors/>
    <warnings/>
    <info/>
    <messageCodes/>
    <errorCodes/>
    <warningCodes/>
    <infoCodes/>
</root>

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

post

Метод getReturnOrdersList працює в моделі AdditionalService (або AdditionalServiceGeneral) і дозволяє отримати список заявок на повернення.

Body

apiKeystringRequired

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

Example: [ВАШ КЛЮЧ]

modelNamestring · enumRequired

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

Example: AdditionalServiceGeneralPossible values:

calledMethodstring · enumRequired

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

Example: getReturnOrdersListPossible 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: 276

{
  "apiKey": "[ВАШ КЛЮЧ]",
  "modelName": "AdditionalServiceGeneral",
  "calledMethod": "getReturnOrdersList",
  "methodProperties": {
    "Number": "102-00003168",
    "Ref": "00000000-0000-0000-0000-000000000000",
    "BeginDate": "12/10/15 10:33",
    "EndDate": "12/10/15 10:33",
    "Page": "1",
    "Limit": "50"
  }
}

200

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

{
  "success": true,
  "data": [
    {
      "OrderRef": "00000000-0000-0000-0000-000000000000",
      "OrderNumber": "102-00003168",
      "OrderStatus": "Прийняте",
      "DocumentNumber": "20600000043015",
      "CounterpartyRecipient": "Комунальник",
      "ContactPersonRecipient": "Іванов Іван Іванович",
      "AddressRecipient": "Ангеліної Паші вул. 45 кв. 12",
      "DeliveryCost": "20",
      "EstimatedDeliveryDate": "12/10/15 10:33",
      "ExpressWaybillNumber": "59000042651620",
      "ExpressWaybillStatus": "Відправлення у місті Київ"
    }
  ],
  "errors": [],
  "warnings": [],
  "info": [],
  "messageCodes": [],
  "errorCodes": [],
  "warningCodes": [],
  "infoCodes": []
}

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

post

Метод getReturnOrdersList працює в моделі AdditionalService (або AdditionalServiceGeneral) і дозволяє отримати список заявок на повернення.

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: 496

"<?xml version="1.0" encoding="UTF-8"?>
<file>
    <apiKey>[ВАШ КЛЮЧ]</apiKey>
    <modelName>AdditionalServiceGeneral</modelName>
    <calledMethod>getReturnOrdersList</calledMethod>
    <methodProperties>
        <Number>102-00003168</Number>
        <Ref>00000000-0000-0000-0000-000000000000</Ref>
        <BeginDate>12/10/15 10:33</BeginDate>
        <EndDate>12/10/15 10:33</EndDate>
        <Page>1</Page>
        <Limit>50</Limit>
    </methodProperties>
</file>
"

200

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

<?xml version="1.0" encoding="UTF-8"?>
<root>
    <success>true</success>
    <data>
        <item>
            <OrderRef>00000000-0000-0000-0000-000000000000</OrderRef>
            <OrderNumber>102-00003168</OrderNumber>
            <OrderStatus>Прийняте</OrderStatus>
            <DocumentNumber>20600000043015</DocumentNumber>
            <CounterpartyRecipient>Комунальник</CounterpartyRecipient>
            <ContactPersonRecipient>Іванов Іван Іванович</ContactPersonRecipient>
            <AddressRecipient>Ангеліної Паші вул. 45 кв. 12</AddressRecipient>
            <DeliveryCost>20</DeliveryCost>
            <EstimatedDeliveryDate>12/10/15 10:33</EstimatedDeliveryDate>
            <ExpressWaybillNumber>59000042651620</ExpressWaybillNumber>
            <ExpressWaybillStatus>Відправлення у місті Київ</ExpressWaybillStatus>
        </item>
    </data>
    <errors/>
    <warnings/>
    <info/>
    <messageCodes/>
    <errorCodes/>
    <warningCodes/>
    <infoCodes/>
</root>

Розрахувати повернення (JSON)

post

Метод save працює в моделі AdditionalServiceGeneral (або AdditionalService). Цей метод дозволяє здійснити розрахунок повернення. Запит майже ідентичний до створення заявки на повернення, відмінність тільки в тому, що використовується параметр OnlyGetPricing із значенням «1». Метод доступний лише для клієнтів-відправників.

Body

apiKeystringRequired

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

Example: [ВАШ КЛЮЧ]

modelNamestring · enumRequired

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

Example: AdditionalServiceGeneralPossible values:

calledMethodstring · enumRequired

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

Example: savePossible 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: 418

{
  "apiKey": "[ВАШ КЛЮЧ]",
  "modelName": "AdditionalServiceGeneral",
  "calledMethod": "save",
  "methodProperties": {
    "Note": "Довільний опис",
    "OrderType": "orderCargoReturn",
    "ReturnAddressRef": "00000000-0000-0000-0000-000000000000",
    "IntDocNumber": "206004560074695",
    "PaymentMethod": "Cash",
    "Reason": "00000000-0000-0000-0000-000000000000",
    "OnlyGetPricing": "1",
    "SubtypeReason": "00000000-0000-0000-0000-000000000000"
  }
}

200

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

{
  "success": true,
  "data": [
    {
      "ScheduledDeliveryDate": "2024-05-18 12:00:00",
      "Pricing": {
        "Services": [
          {
            "Service": "Повернення документи",
            "Cost": 0
          }
        ],
        "Total": 0,
        "FirstDayStorage": "0000-00-00 00:00:00"
      }
    }
  ],
  "errors": [],
  "warnings": [],
  "info": [],
  "messageCodes": [],
  "errorCodes": [],
  "warningCodes": [],
  "infoCodes": []
}

Розрахувати повернення (XML)

post

Метод save працює в моделі AdditionalServiceGeneral (або AdditionalService). Цей метод дозволяє здійснити розрахунок повернення. Запит майже ідентичний до створення заявки на повернення, відмінність тільки в тому, що використовується параметр OnlyGetPricing із значенням «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: 709

"<?xml version="1.0" encoding="UTF-8"?>
<file>
    <apiKey>[ВАШ КЛЮЧ]</apiKey>
    <modelName>AdditionalServiceGeneral</modelName>
    <calledMethod>save</calledMethod>
    <methodProperties>
        <Note>Довільний опис</Note>
        <OrderType>orderCargoReturn</OrderType>
        <ReturnAddressRef>00000000-0000-0000-0000-000000000000</ReturnAddressRef>
        <IntDocNumber>206004560074695</IntDocNumber>
        <PaymentMethod>Cash</PaymentMethod>
        <Reason>00000000-0000-0000-0000-000000000000</Reason>
        <OnlyGetPricing>1</OnlyGetPricing>
        <SubtypeReason>00000000-0000-0000-0000-000000000000</SubtypeReason>
    </methodProperties>
</file>
"

200

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

<?xml version="1.0" encoding="UTF-8"?>
<root>
    <success>true</success>
    <data>
        <item>
            <ScheduledDeliveryDate>2024-05-18 12:00:00</ScheduledDeliveryDate>
            <Pricing>
                <Services>
                    <item>
                        <Service>Повернення документи</Service>
                        <Cost>0</Cost>
                    </item>
                </Services>
                <Total>0</Total>
                <FirstDayStorage>0000-00-00 00:00:00</FirstDayStorage>
            </Pricing>
        </item>
    </data>
    <errors/>
    <warnings/>
    <info/>
    <messageCodes/>
    <errorCodes/>
    <warningCodes/>
    <infoCodes/>
</root>

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

post

Метод getReturnReasons працює в моделі AdditionalService (або AdditionalServiceGeneral) і дозволяє отримати список доступних причин повернення.

Body

apiKeystringRequired

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

Example: [ВАШ КЛЮЧ]

modelNamestring · enumRequired

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

Example: AdditionalServiceGeneralPossible values:

calledMethodstring · enumRequired

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

Example: getReturnReasonsPossible values:

methodPropertiesobject · GetReturnReasonsMethodPropertiesRequired

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

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: 125

{
  "apiKey": "[ВАШ КЛЮЧ]",
  "modelName": "AdditionalServiceGeneral",
  "calledMethod": "getReturnReasons",
  "methodProperties": {}
}

200

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

{
  "success": true,
  "data": [
    {
      "Ref": "00000000-0000-0000-0000-000000000000",
      "Description": "Відмова Одержувача"
    }
  ],
  "errors": [],
  "warnings": [],
  "info": [],
  "messageCodes": [],
  "errorCodes": [],
  "warningCodes": [],
  "infoCodes": []
}

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

post

Метод getReturnReasons працює в моделі AdditionalService (або AdditionalServiceGeneral) і дозволяє отримати список доступних причин повернення.

Body

apiKeystringRequired

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

modelNamestring · enumRequired

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

Possible values:

calledMethodstring · enumRequired

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

Possible values:

methodPropertiesobject · GetReturnReasonsMethodPropertiesRequired

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

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: 256

"<?xml version="1.0" encoding="UTF-8"?>
<file>
    <apiKey>[ВАШ КЛЮЧ]</apiKey>
    <modelName>AdditionalServiceGeneral</modelName>
    <calledMethod>getReturnReasons</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>Відмова Одержувача</Description>
        </item>
    </data>
    <errors/>
    <warnings/>
    <info/>
    <messageCodes/>
    <errorCodes/>
    <warningCodes/>
    <infoCodes/>
</root>

Перевірити можливість редагування вже створеного повернення (JSON)

post

Метод CheckPossibilityCreateReturn працює в моделі AdditionalServiceGeneral і дозволяє перевірити можливість створення заявки на повернення або редагування вже створеної заявки залежно від запиту. Метод доступний лише відправнику.

Типи адрес у відповіді (параметр Type)

• OrderReturn: Поточна адреса повернення (за наявності замовлення на повернення).
• CustomReturnAddress: Нестандартна адреса повернення, що не відповідає адресі відправника з експрес-накладної (здійснюється налаштування відмінної адреси повернення від адреси відправки в експрес-накладній за типами відправлення).
• ExpressWaybill: Адреса відправника з експрес-накладної.

Body

apiKeystringRequired

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

Example: [ВАШ КЛЮЧ]

modelNamestring · enumRequired

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

Example: AdditionalServiceGeneralPossible values:

calledMethodstring · enumRequired

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

Example: CheckPossibilityCreateReturnPossible values:

Responses

200

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

application/json

successbooleanRequired

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

errorsstring[]Required

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

warningsstring[]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: 243

{
  "apiKey": "[ВАШ КЛЮЧ]",
  "modelName": "AdditionalServiceGeneral",
  "calledMethod": "CheckPossibilityCreateReturn",
  "methodProperties": {
    "Ref": "00000000-0000-0000-0000-000000000000",
    "Address": "м. Київ, площа Харківська, 10"
  }
}

200

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

{
  "success": true,
  "data": [
    {
      "NonCash": false,
      "City": "Київ",
      "Counterparty": "ТОВ Компанія",
      "Address": "м. Київ, площа Харківська, 10",
      "Phone": "380670000000",
      "Ref": "00000000-0000-0000-0000-000000000001",
      "ContactPerson": "Іванов Іван Іванович",
      "Type": "CustomReturnAddress"
    },
    {
      "NonCash": false,
      "City": "Київ",
      "Counterparty": "ТОВ Компанія",
      "ContactPerson": "Петров Петро Петрович",
      "Address": "м. Київ, Відділення №1: вул. Пирогівський шлях, 135",
      "Phone": "380500000000",
      "Ref": "00000000-0000-0000-0000-000000000000",
      "Type": "OrderReturn"
    }
  ],
  "errors": [],
  "warnings": [],
  "info": [
    {
      "PayerTypeDefault": "Recipient",
      "Number": "102-77771370"
    }
  ],
  "messageCodes": [],
  "errorCodes": [],
  "warningCodes": [],
  "infoCodes": []
}

Перевірити можливість редагування вже створеного повернення (XML)

post

Метод CheckPossibilityCreateReturn працює в моделі AdditionalServiceGeneral і дозволяє перевірити можливість створення заявки на повернення або редагування вже створеної заявки залежно від запиту. Метод доступний лише відправнику.

Типи адрес у відповіді (параметр Type)

• OrderReturn: Поточна адреса повернення (за наявності замовлення на повернення).
• CustomReturnAddress: Нестандартна адреса повернення, що не відповідає адресі відправника з експрес-накладної (здійснюється налаштування відмінної адреси повернення від адреси відправки в експрес-накладній за типами відправлення).
• ExpressWaybill: Адреса відправника з експрес-накладної.

Body

apiKeystringRequired

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

modelNamestring · enumRequired

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

Possible values:

calledMethodstring · enumRequired

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

Possible values:

Responses

200

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

application/xml

successbooleanRequired

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

errorsstring[]Required

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

warningsstring[]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: 403

"<?xml version="1.0" encoding="UTF-8"?>
<file>
    <apiKey>[ВАШ КЛЮЧ]</apiKey>
    <modelName>AdditionalServiceGeneral</modelName>
    <calledMethod>CheckPossibilityCreateReturn</calledMethod>
    <methodProperties>
        <Ref>00000000-0000-0000-0000-000000000000</Ref>
        <Address>м. Київ, площа Харківська, 10</Address>
    </methodProperties>
</file>
"

200

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

<?xml version="1.0" encoding="UTF-8"?>
<root>
    <success>true</success>
    <data>
        <element>
            <NonCash>false</NonCash>
            <City>Київ</City>
            <Counterparty>ТОВ Компанія</Counterparty>
            <Address>м. Київ, площа Харківська, 10</Address>
            <Phone>380670000000</Phone>
            <Ref>00000000-0000-0000-0000-000000000001</Ref>
            <ContactPerson>Іванов Іван Іванович</ContactPerson>
            <Type>CustomReturnAddress</Type>
        </element>
        <element>
            <NonCash>false</NonCash>
            <City>Київ</City>
            <Counterparty>ТОВ Компанія</Counterparty>
            <ContactPerson>Петров Петро Петрович</ContactPerson>
            <Address>м. Київ, Відділення №1: вул. Пирогівський шлях, 135</Address>
            <Phone>380500000000</Phone>
            <Ref>00000000-0000-0000-0000-000000000000</Ref>
            <Type>OrderReturn</Type>
        </element>
    </data>
    <errors/>
    <warnings/>
    <info>
        <element>
            <PayerTypeDefault>Recipient</PayerTypeDefault>
            <Number>102-77771370</Number>
        </element>
    </info>
    <messageCodes/>
    <errorCodes/>
    <warningCodes/>
    <infoCodes/>
</root>

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

post

Метод getReturnReasonsSubtypes працює в моделі AdditionalService (або AdditionalServiceGeneral) і дозволяє отримати список підтипів доступних причин повернення.

Body

apiKeystringRequired

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

Example: [ВАШ КЛЮЧ]

modelNamestring · enumRequired

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

Example: AdditionalServiceGeneralPossible values:

calledMethodstring · enumRequired

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

Example: getReturnReasonsSubtypesPossible 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: 183

{
  "apiKey": "[ВАШ КЛЮЧ]",
  "modelName": "AdditionalServiceGeneral",
  "calledMethod": "getReturnReasonsSubtypes",
  "methodProperties": {
    "ReasonRef": "00000000-0000-0000-0000-000000000000"
  }
}

200

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

{
  "success": true,
  "data": [
    {
      "Ref": "00000000-0000-0000-0000-000000000000",
      "Description": "Відправник відмінив доставку відправлення",
      "ReasonRef": "00000000-0000-0000-0000-000000000000"
    }
  ],
  "errors": [],
  "warnings": [],
  "info": [],
  "messageCodes": [],
  "errorCodes": [],
  "warningCodes": [],
  "infoCodes": []
}

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

post

Метод getReturnReasonsSubtypes працює в моделі AdditionalService (або AdditionalServiceGeneral) і дозволяє отримати список підтипів доступних причин повернення.

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: 333

"<?xml version="1.0" encoding="UTF-8"?>
<file>
    <apiKey>[ВАШ КЛЮЧ]</apiKey>
    <modelName>AdditionalServiceGeneral</modelName>
    <calledMethod>getReturnReasonsSubtypes</calledMethod>
    <methodProperties>
        <ReasonRef>00000000-0000-0000-0000-000000000000</ReasonRef>
    </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>Відправник відмінив доставку відправлення</Description>
            <ReasonRef>00000000-0000-0000-0000-000000000000</ReasonRef>
        </item>
    </data>
    <errors/>
    <warnings/>
    <info/>
    <messageCodes/>
    <errorCodes/>
    <warningCodes/>
    <infoCodes/>
</root>

Змінити дані

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

post

Метод getChangeEWOrdersList працює в моделі AdditionalService (або AdditionalServiceGeneral) і дозволяє отримати список заявок щодо зміни даних.

Body

apiKeystringRequired

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

Example: [ВАШ КЛЮЧ]

modelNamestring · enumRequired

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

Example: AdditionalServiceGeneralPossible values:

calledMethodstring · enumRequired

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

Example: getChangeEWOrdersListPossible 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: 286

{
  "apiKey": "[ВАШ КЛЮЧ]",
  "modelName": "AdditionalServiceGeneral",
  "calledMethod": "getChangeEWOrdersList",
  "methodProperties": {
    "Number": "102-00006096",
    "Ref": "00000000-0000-0000-0000-000000000000",
    "BeginDate": "дд.мм.рррр",
    "EndDate": "дд.мм.рррр",
    "Page": "1",
    "Limit": "50"
  }
}

200

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

{
  "success": true,
  "data": [
    {
      "OrderRef": "00000000-0000-0000-0000-000000000000",
      "OrderNumber": "102-00010160",
      "OrderStatus": "Дані в ЕН змінено",
      "DocumentNumber": "20600000066986",
      "DateTime": "дд.мм.рррр",
      "BeforeChangeSenderCounterparty": "ТОВ Яблуневий сад",
      "AfterChangeChangeSenderCounterparty": "ФОП Іванов І.І.",
      "Cost": "40",
      "BeforeChangeSenderPhone": "380675559879",
      "AfterChangeSenderPhone": "380664561237"
    }
  ],
  "errors": [],
  "warnings": [],
  "info": [],
  "messageCodes": [],
  "errorCodes": [],
  "warningCodes": [],
  "infoCodes": []
}

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

post

Метод getChangeEWOrdersList працює в моделі AdditionalService (або AdditionalServiceGeneral) і дозволяє отримати список заявок щодо зміни даних.

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: 506

"<?xml version="1.0" encoding="UTF-8"?>
<file>
    <apiKey>[ВАШ КЛЮЧ]</apiKey>
    <modelName>AdditionalServiceGeneral</modelName>
    <calledMethod>getChangeEWOrdersList</calledMethod>
    <methodProperties>
        <Number>102-00006096</Number>
        <Ref>00000000-0000-0000-0000-000000000000</Ref>
        <BeginDate>дд.мм.рррр</BeginDate>
        <EndDate>дд.мм.рррр</EndDate>
        <Page>1</Page>
        <Limit>50</Limit>
    </methodProperties>
</file>
"

200

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

<?xml version="1.0" encoding="UTF-8"?>
<root>
    <success>true</success>
    <data>
        <item>
            <OrderRef>00000000-0000-0000-0000-000000000000</OrderRef>
            <OrderNumber>102-00010160</OrderNumber>
            <OrderStatus>Дані в ЕН змінено</OrderStatus>
            <DocumentNumber>20600000066986</DocumentNumber>
            <DateTime>дд.мм.рррр</DateTime>
            <BeforeChangeSenderCounterparty>ТОВ Яблуневий сад</BeforeChangeSenderCounterparty>
            <AfterChangeChangeSenderCounterparty>ФОП Іванов І.І.</AfterChangeChangeSenderCounterparty>
            <Cost>40</Cost>
            <BeforeChangeSenderPhone>380675559879</BeforeChangeSenderPhone>
            <AfterChangeSenderPhone>380664561237</AfterChangeSenderPhone>
        </item>
    </data>
    <errors/>
    <warnings/>
    <info/>
    <messageCodes/>
    <errorCodes/>
    <warningCodes/>
    <infoCodes/>
</root>

Створити заявку щодо зміни даних (JSON)

post

Метод save працює в моделі AdditionalService (або AdditionalServiceGeneral) і дозволяє створити заявку щодо зміни даних.

Обмеження щодо зміни даних відправника

• Зміна контрагента-відправника (SenderCounterparty) не допускається.
• Зміна ПІБ контактної особи відправника (SenderContactName) дозволена лише за відсутності післяплати.

Body

apiKeystringRequired

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

Example: [ВАШ КЛЮЧ]

modelNamestring · enumRequired

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

Example: AdditionalServiceGeneralPossible values:

calledMethodstring · enumRequired

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

Example: savePossible 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: 457

{
  "apiKey": "[ВАШ КЛЮЧ]",
  "modelName": "AdditionalServiceGeneral",
  "calledMethod": "save",
  "methodProperties": {
    "IntDocNumber": "206004560074695",
    "PaymentMethod": "Cash",
    "OrderType": "orderChangeEW",
    "SenderContactName": "Іванов Іван Іванович",
    "SenderPhone": "380685024447",
    "Recipient": "00000000-0000-0000-0000-000000000000",
    "RecipientContactName": "Іванов Іван Іванович",
    "RecipientPhone": "380685024447",
    "PayerType": "Recipient"
  }
}

200

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

{
  "success": true,
  "data": [
    {
      "Number": "102-00006096",
      "Ref": "00000000-0000-0000-0000-000000000000"
    }
  ],
  "errors": [],
  "warnings": [],
  "info": [],
  "messageCodes": [],
  "errorCodes": [],
  "warningCodes": [],
  "infoCodes": []
}

Створити заявку щодо зміни даних (XML)

post

Метод save працює в моделі AdditionalService (або AdditionalServiceGeneral) і дозволяє створити заявку щодо зміни даних.

Обмеження щодо зміни даних відправника

• Зміна контрагента-відправника (SenderCounterparty) не допускається.
• Зміна ПІБ контактної особи відправника (SenderContactName) дозволена лише за відсутності післяплати.

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: 784

"<?xml version="1.0" encoding="UTF-8"?>
<file>
    <apiKey>[ВАШ КЛЮЧ]</apiKey>
    <modelName>AdditionalServiceGeneral</modelName>
    <calledMethod>save</calledMethod>
    <methodProperties>
        <IntDocNumber>206004560074695</IntDocNumber>
        <PaymentMethod>Cash</PaymentMethod>
        <OrderType>orderChangeEW</OrderType>
        <SenderContactName>Іванов Іван Іванович</SenderContactName>
        <SenderPhone>380685024447</SenderPhone>
        <Recipient>00000000-0000-0000-0000-000000000000</Recipient>
        <RecipientContactName>Іванов Іван Іванович</RecipientContactName>
        <RecipientPhone>380685024447</RecipientPhone>
        <PayerType>Recipient</PayerType>
    </methodProperties>
</file>
"

200

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

<?xml version="1.0" encoding="UTF-8"?>
<root>
    <success>true</success>
    <data>
        <item>
            <Number>102-00006096</Number>
            <Ref>00000000-0000-0000-0000-000000000000</Ref>
        </item>
    </data>
    <errors/>
    <warnings/>
    <info/>
    <messageCodes/>
    <errorCodes/>
    <warningCodes/>
    <infoCodes/>
</root>

Перевірити можливість зміни даних (JSON)

post

Метод CheckPossibilityChangeEW працює в моделі AdditionalService (або AdditionalServiceGeneral) і дозволяє перевірити можливість створення заявки на зміну даних. У разі успіху повертаються необхідні параметри створення заявки.

Body

apiKeystringRequired

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

Example: [ВАШ КЛЮЧ]

modelNamestring · enumRequired

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

Example: AdditionalServiceGeneralPossible values:

calledMethodstring · enumRequired

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

Example: CheckPossibilityChangeEWPossible 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: 164

{
  "apiKey": "[ВАШ КЛЮЧ]",
  "modelName": "AdditionalServiceGeneral",
  "calledMethod": "CheckPossibilityChangeEW",
  "methodProperties": {
    "IntDocNumber": "20450500000012"
  }
}

200

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

{
  "success": true,
  "data": [
    {
      "CanChangeSender": true,
      "CanChangeRecipient": true,
      "CanChangePayerTypeOrPaymentMethod": true,
      "CanChangeBackwardDeliveryDocuments": true,
      "CanChangeBackwardDeliveryMoney": true,
      "CanChangeCash2Card": true,
      "CanChangeBackwardDeliveryOther": true,
      "CanChangeAfterpaymentType": true,
      "CanChangeLiftingOnFloor": true,
      "CanChangeLiftingOnFloorWithElevator": true,
      "CanChangeFillingWarranty": true,
      "SenderCounterparty": "ПП ВКФ \"КАРАТ\"",
      "ContactPersonSender": "Іванов Іван Іванович",
      "SenderPhone": "380685024447",
      "RecipientCounterparty": "Приватна особа",
      "ContactPersonRecipient": "Іванов Іван Іванович",
      "RecipientPhone": "380685024447",
      "PayerType": "Recipient",
      "PaymentMethod": "Cash"
    }
  ],
  "errors": [],
  "warnings": [],
  "info": [],
  "messageCodes": [],
  "errorCodes": [],
  "warningCodes": [],
  "infoCodes": []
}

Перевірити можливість зміни даних (XML)

post

Метод CheckPossibilityChangeEW працює в моделі AdditionalService (або AdditionalServiceGeneral) і дозволяє перевірити можливість створення заявки на зміну даних. У разі успіху повертаються необхідні параметри створення заявки.

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: 317

"<?xml version="1.0" encoding="UTF-8"?>
<file>
    <apiKey>[ВАШ КЛЮЧ]</apiKey>
    <modelName>AdditionalServiceGeneral</modelName>
    <calledMethod>CheckPossibilityChangeEW</calledMethod>
    <methodProperties>
        <IntDocNumber>20450500000012</IntDocNumber>
    </methodProperties>
</file>
"

200

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

<?xml version="1.0" encoding="UTF-8"?>
<root>
    <success>true</success>
    <data>
        <item>
            <CanChangeSender>true</CanChangeSender>
            <CanChangeRecipient>true</CanChangeRecipient>
            <CanChangePayerTypeOrPaymentMethod>true</CanChangePayerTypeOrPaymentMethod>
            <CanChangeBackwardDeliveryDocuments>true</CanChangeBackwardDeliveryDocuments>
            <CanChangeBackwardDeliveryMoney>true</CanChangeBackwardDeliveryMoney>
            <CanChangeCash2Card>true</CanChangeCash2Card>
            <CanChangeBackwardDeliveryOther>true</CanChangeBackwardDeliveryOther>
            <CanChangeAfterpaymentType>true</CanChangeAfterpaymentType>
            <CanChangeLiftingOnFloor>true</CanChangeLiftingOnFloor>
            <CanChangeLiftingOnFloorWithElevator>true</CanChangeLiftingOnFloorWithElevator>
            <CanChangeFillingWarranty>true</CanChangeFillingWarranty>
            <SenderCounterparty>ПП ВКФ "КАРАТ"</SenderCounterparty>
            <ContactPersonSender>Іванов Іван Іванович</ContactPersonSender>
            <SenderPhone>380685024447</SenderPhone>
            <RecipientCounterparty>Приватна особа</RecipientCounterparty>
            <ContactPersonRecipient>Іванов Іван Іванович</ContactPersonRecipient>
            <RecipientPhone>380685024447</RecipientPhone>
            <PayerType>Recipient</PayerType>
            <PaymentMethod>Cash</PaymentMethod>
        </item>
    </data>
    <errors/>
    <warnings/>
    <info/>
    <messageCodes/>
    <errorCodes/>
    <warningCodes/>
    <infoCodes/>
</root>

Видалити заявку (на переадресацію, повернення, зміну даних)

Видалити заявку (JSON)

post

Метод delete працює в моделі AdditionalService (або AdditionalServiceGeneral) і дозволяє видалити:

• заявку на повернення;
• заявку на зміну даних (можна видалити заявку лише зі статусом «Прийнято»);
• заявку на переадресацію.

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: 159

{
  "apiKey": "[ВАШ КЛЮЧ]",
  "modelName": "AdditionalServiceGeneral",
  "calledMethod": "delete",
  "methodProperties": {
    "Ref": "00000000-0000-0000-0000-000000000000"
  }
}

200

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

{
  "success": true,
  "data": [
    {
      "Number": "102-00003168"
    }
  ],
  "errors": [],
  "warnings": [],
  "info": [],
  "messageCodes": [],
  "errorCodes": [],
  "warningCodes": [],
  "infoCodes": []
}

Видалити заявку (XML)

post

Метод delete працює в моделі AdditionalService (або AdditionalServiceGeneral) і дозволяє видалити:

• заявку на повернення;
• заявку на зміну даних (можна видалити заявку лише зі статусом «Прийнято»);
• заявку на переадресацію.

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: 303

"<?xml version="1.0" encoding="UTF-8"?>
<file>
    <apiKey>[ВАШ КЛЮЧ]</apiKey>
    <modelName>AdditionalServiceGeneral</modelName>
    <calledMethod>delete</calledMethod>
    <methodProperties>
        <Ref>00000000-0000-0000-0000-000000000000</Ref>
    </methodProperties>
</file>
"

200

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

<?xml version="1.0" encoding="UTF-8"?>
<root>
    <success>true</success>
    <data>
        <Number>102-00003168</Number>
    </data>
    <errors/>
    <warnings/>
    <info/>
    <messageCodes/>
    <errorCodes/>
    <warningCodes/>
    <infoCodes/>
</root>