Виклик кур'єра

Робота із заявками на виклик кур'єра

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

Cписки заявок на виклик кур'єра

Отримати список заявок на виклик кур’єра (JSON)

post

Метод getOrdersListCourierCall працює в моделі CarCallGeneral. Цей метод дозволяє отримати перелік створених заявок на виклик кур’єра. Відображаються заявки із будь-яким статусом. Термін відображення заявок — 7 днів із дати створення.

Body

apiKeystringRequired

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

modelNamestringRequiredExample: CarCallGeneral

calledMethodstringRequiredExample: getOrdersListCourierCall

methodPropertiesobjectRequired

Порожній об'єкт параметрів

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

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

200

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

{
  "success": true,
  "data": [
    {
      "TimeIntervalDescription": "08:00 - 18:00",
      "SenderDescription": "Р.Б",
      "Status": "ReadyToDone",
      "DateTime": "10.02.2025 16:53:15",
      "FactualWeight": "0.00",
      "ContactSenderDescription": "Іванова Алла Ігорівна",
      "PreferredDeliveryDate": "11.02.2025",
      "AggregatedOrderInfo": [
        {
          "ParcelsAmount": 1,
          "ParcelsAmountByCargoType": {
            "Documents": 1,
            "Parcel": 0,
            "Cargo": 0,
            "Pallet": 0,
            "TiresWheels": 0
          },
          "SeatsAmount": 1
        }
      ],
      "AvailableActions": [
        {
          "CanCancel": true,
          "CanEdit": false
        }
      ],
      "SenderAddressDescription": "Київ, вул. Лісківська 555",
      "ContactSenderPhone": "380600000000",
      "StatusDescription": "Готово до виконання",
      "SenderSettlementRef": "e718a680-4b33-11e4-ab6d-005056801329",
      "Ref": "c1d8788a-e7be-11ef-b619-005056bdc0e9",
      "TimeInterval": "CityPickingTimeInterval6",
      "PlanedWeight": "13.00",
      "Number": "102-00265830"
    }
  ],
  "errors": [],
  "warnings": [],
  "info": [],
  "messageCodes": [],
  "errorCodes": [],
  "warningCodes": [],
  "infoCodes": []
}

Отримати список заявок на виклик кур’єра (XML)

post

Метод getOrdersListCourierCall працює в моделі CarCallGeneral. Цей метод дозволяє отримати перелік створених заявок на виклик кур’єра. Відображаються заявки із будь-яким статусом. Термін відображення заявок — 7 днів із дати створення.

Body

apiKeystringRequired

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

modelNamestringRequiredExample: CarCallGeneral

calledMethodstringRequiredExample: getOrdersListCourierCall

methodPropertiesobjectRequired

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

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

200

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

<?xml version="1.0" encoding="UTF-8"?>
<root>
    <success>true</success>
    <data>
        <TimeIntervalDescription>08:00 - 18:00</TimeIntervalDescription>
        <SenderDescription>Р.Б</SenderDescription>
        <Status>ReadyToDone</Status>
        <DateTime>10.02.2025 16:53:15</DateTime>
        <FactualWeight>"0.00"</FactualWeight>
        <ContactSenderDescription>Іванова Алла Ігорівна</ContactSenderDescription>
        <PreferredDeliveryDate>11.02.2025</PreferredDeliveryDate>
        <AggregatedOrderInfo>
            <item>
                <ParcelsAmount>1</ParcelsAmount>
                <ParcelsAmountByCargoType>
                    <Documents>1</Documents>
                    <Parcel>0</Parcel>
                    <Cargo>0</Cargo>
                    <Pallet>0</Pallet>
                    <TiresWheels>0</TiresWheels>
                </ParcelsAmountByCargoType>
                <SeatsAmount>1</SeatsAmount>
            </item>
        </AggregatedOrderInfo>
        <AvailableActions>
            <item>
                <CanCancel>true</CanCancel>
                <CanEdit>false</CanEdit>
            </item>
        </AvailableActions>
        <SenderAddressDescription>Київ, вул. Лісківська 555</SenderAddressDescription>
        <ContactSenderPhone>380600000000</ContactSenderPhone>
        <StatusDescription>Готово до виконання</StatusDescription>
        <SenderSettlementRef>e718a680-4b33-11e4-ab6d-005056801329</SenderSettlementRef>
        <Ref>c1d8788a-e7be-11ef-b619-005056bdc0e9</Ref>
        <TimeInterval>CityPickingTimeInterval6</TimeInterval>
        <PlanedWeight>"13.00"</PlanedWeight>
        <Number>102-00265830</Number>
    </data>
    <errors/>
    <warnings/>
    <info/>
    <messageCodes/>
    <errorCodes/>
    <warningCodes/>
    <infoCodes/>
</root>

Отримати список заявок на виклик кур’єра з фільтрацією (JSON)

post

Метод getOrdersListCourierCall працює в моделі CarCallGeneral. Цей метод дозволяє отримати перелік заявок на виклик кур’єра. Щоб переглянути окремі елементи переліку, здійснюється пошук за визначеними фільтрами.

Body

apiKeystringRequired

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

modelNamestringRequiredExample: CarCallGeneral

calledMethodstringRequiredExample: getOrdersListCourierCall

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

{
  "apiKey": "[ВАШ КЛЮЧ]",
  "modelName": "CarCallGeneral",
  "calledMethod": "getOrdersListCourierCall",
  "methodProperties": {
    "StatusCode": "ReadyToDone",
    "ContactSenderPhone": "380674195575",
    "DateTime": "29.12.2023",
    "Page": "1",
    "Limit": "1",
    "SenderRef": "00000000-0000-0000-0000-000000000000d04",
    "Number": "102-00258214",
    "PreferredDeliveryDate": "29.12.2023"
  }
}

200

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

{
  "success": true,
  "data": [
    {
      "StatusDescription": "Готово до виконання",
      "SenderSettlementRef": "e718a680-4b33-11e4-ab6d-005056801329",
      "Ref": "c1d8788a-e7be-11ef-b619-005056bdc0e9",
      "TimeInterval": "CityPickingTimeInterval6",
      "PlanedWeight": "13.00",
      "Number": "102-00265830"
    }
  ],
  "errors": [],
  "warnings": [],
  "info": [],
  "messageCodes": [],
  "errorCodes": [],
  "warningCodes": [],
  "infoCodes": []
}

Отримати список заявок на виклик кур’єра з фільтрацією (XML)

post

Метод getOrdersListCourierCall працює в моделі CarCallGeneral. Цей метод дозволяє отримати перелік заявок на виклик кур’єра. Щоб переглянути окремі елементи переліку, здійснюється пошук за визначеними фільтрами.

Body

apiKeystringRequired

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

modelNamestringRequiredExample: CarCallGeneral

calledMethodstringRequiredExample: getOrdersListCourierCall

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

"<?xml version="1.0" encoding="UTF-8"?>
<file>
    <apiKey>[ВАШ КЛЮЧ]</apiKey>
    <modelName>CarCallGeneral</modelName>
    <calledMethod>getOrdersListCourierCall</calledMethod>
    <methodProperties>
        <StatusCode>ReadyToDone</StatusCode>
        <ContactSenderPhone>380674195575</ContactSenderPhone>
        <DateTime>29.12.2023</DateTime>
        <Page>1</Page>
        <Limit>1</Limit>
        <SenderRef>00000000-0000-0000-0000-000000000000d04</SenderRef>
        <Number>102-00258214</Number>
        <PreferredDeliveryDate>29.12.2023</PreferredDeliveryDate>
    </methodProperties>
</file>
"

200

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

<?xml version="1.0" encoding="UTF-8"?>
<root>
    <success>true</success>
    <data>
        <StatusDescription>Готово до виконання</StatusDescription>
        <SenderSettlementRef>e718a680-4b33-11e4-ab6d-005056801329</SenderSettlementRef>
        <Ref>c1d8788a-e7be-11ef-b619-005056bdc0e9</Ref>
        <TimeInterval>CityPickingTimeInterval6</TimeInterval>
        <PlanedWeight>13.00</PlanedWeight>
        <Number>102-00265830</Number>
    </data>
    <errors/>
    <warnings/>
    <info/>
    <messageCodes/>
    <errorCodes/>
    <warningCodes/>
    <infoCodes/>
</root>

Робота із заявками на виклик кур'єра

Додати документи до заявки на виклик кур’єра (JSON)

post

Метод insertDocuments працює в моделі CarCallGeneral*.

Цей метод дозволяє додавати до заявки на виклик кур’єра інтернет-документи (ІД), які будуть передані кур'єру. Підтримуються два варіанти додавання: по одному документу або масово. Основна логіка методу залишається однаковою, змінюється лише кількість доданих документів.

Детальні умови додавання документів

До заявки можливо додавати ІД від:

• різних контрагентів, які працюють в одному корпоративному кабінеті (один логін);
• одного контрагента, але відправлення створюються з різних кабінетів від різних контактних осіб цього контрагента.

Додавання інтернет-документів до заявки доступне в таких випадках:

• Заявка на виклик кур’єра має статус «Готово до виконання».
• Адреса відправника в ІД співпадає із адресою відправки у заявці на виклик кур’єра до вулиці та номеру будинку включно.
• Для заявки на виклик кур’єра ще не минули вказані дата та часовий інтервал (ЧІ).
• Кур’єр на адресі відправника, але ще не підтвердив кількість та вагу відправлень у заявці.
• Якщо до закінчення ЧІ залишилось більше 2 годин — без обмежень за вагою в інтернет-документах.
• Якщо до закінчення ЧІ залишилось менше 2 годин — вага в інтернет-документі, який необхідно додати, не повинна перевищувати 20% від планової ваги у заявці.

*Для перегляду списку доданих інтернет-документів за номером заявки на виклик кур’єра потрібно використовувати відповідний метод (див. метод getEWTemplateList моделі InternetDocument).

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

{
  "apiKey": "[ВАШ КЛЮЧ]",
  "modelName": "CarCallGeneral",
  "calledMethod": "insertDocuments",
  "methodProperties": {
    "LinkedDocuments": [
      "20450009111502",
      "20450009111503"
    ],
    "Number": "102-00258214"
  }
}

200

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

{
  "success": true,
  "data": [
    {
      "succeeded": [
        "20450009111502",
        "20450009111503"
      ],
      "Barcode": "102-00258214"
    }
  ],
  "errors": [],
  "warnings": [],
  "info": [],
  "messageCodes": [],
  "errorCodes": [],
  "warningCodes": [],
  "infoCodes": []
}

Додати документи до заявки на виклик кур’єра (XML)

post

Метод insertDocuments працює в моделі CarCallGeneral*.

Цей метод дозволяє додавати до заявки на виклик кур’єра інтернет-документи (ІД), які будуть передані кур'єру. Підтримуються два варіанти додавання: по одному документу або масово. Основна логіка методу залишається однаковою, змінюється лише кількість доданих документів.

Детальні умови додавання документів

До заявки можливо додавати ІД від:

• різних контрагентів, які працюють в одному корпоративному кабінеті (один логін);
• одного контрагента, але відправлення створюються з різних кабінетів від різних контактних осіб цього контрагента.

Додавання інтернет-документів до заявки доступне в таких випадках:

• Заявка на виклик кур’єра має статус «Готово до виконання».
• Адреса відправника в ІД співпадає із адресою відправки у заявці на виклик кур’єра до вулиці та номеру будинку включно.
• Для заявки на виклик кур’єра ще не минули вказані дата та часовий інтервал (ЧІ).
• Кур’єр на адресі відправника, але ще не підтвердив кількість та вагу відправлень у заявці.
• Якщо до закінчення ЧІ залишилось більше 2 годин — без обмежень за вагою в інтернет-документах.
• Якщо до закінчення ЧІ залишилось менше 2 годин — вага в інтернет-документі, який необхідно додати, не повинна перевищувати 20% від планової ваги у заявці.

*Для перегляду списку доданих інтернет-документів за номером заявки на виклик кур’єра потрібно використовувати відповідний метод (див. метод getEWTemplateList моделі InternetDocument).

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

"<?xml version="1.0" encoding="UTF-8"?>
<file>
    <apiKey>[ВАШ КЛЮЧ]</apiKey>
    <modelName>CarCallGeneral</modelName>
    <calledMethod>insertDocuments</calledMethod>
    <methodProperties>
        <LinkedDocuments>
            <item>20450009111502</item>
            <item>20450009111503</item>
        </LinkedDocuments>
        <Number>102-00258214</Number>
    </methodProperties>
</file>
"

200

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

<?xml version="1.0" encoding="UTF-8"?>
<root>
    <success>true</success>
    <data>
        <item>
            <succeeded>
                <item>20450009111502</item>
                <item>20450009111503</item>
            </succeeded>
            <Barcode>102-00258214</Barcode>
        </item>
    </data>
    <errors/>
    <warnings/>
    <info/>
    <messageCodes/>
    <errorCodes/>
    <warningCodes/>
    <infoCodes/>
</root>

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

post

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

Цей метод дозволяє отримати список наявних заявок на виклик кур’єра зі статусом «Готово до виконання», у яких ще не закінчився часовий інтервал, тобто доступних для додавання інтернет-документів.

Додаткові посилання та супутні методи

• Для перегляду списку доданих інтернет-документів за номером заявки використовується метод getEWTemplateList моделі InternetDocument.
• Для перегляду доступних часових інтервалів для виклику кур’єра використовується метод getPickupTimeIntervals моделі CommonGeneral.

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

{
  "apiKey": "[ВАШ КЛЮЧ]",
  "modelName": "CarCallGeneral",
  "calledMethod": "getAvailableOrdersList",
  "methodProperties": {
    "Number": "20400009196196"
  }
}

200

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

{
  "success": true,
  "data": [
    {
      "Number": "102-00265830",
      "Ref": "c1d8788a-e7be-11ef-b619-005056bdc0e9",
      "TimeIntervalDescription": "08:00 - 18:00",
      "PreferredDeliveryDate": "11.02.2025",
      "SenderAddressDescription": "Київ, вул. Лісківська 5"
    }
  ],
  "errors": [],
  "warnings": [],
  "info": [],
  "messageCodes": [],
  "errorCodes": [],
  "warningCodes": [],
  "infoCodes": []
}

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

post

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

Цей метод дозволяє отримати список наявних заявок на виклик кур’єра зі статусом «Готово до виконання», у яких ще не закінчився часовий інтервал, тобто доступних для додавання інтернет-документів.

Додаткові посилання та супутні методи

• Для перегляду списку доданих інтернет-документів за номером заявки використовується метод getEWTemplateList моделі InternetDocument.
• Для перегляду доступних часових інтервалів для виклику кур’єра використовується метод getPickupTimeIntervals моделі CommonGeneral.

Body

apiKeystringRequired

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

modelNamestring · enumRequired

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

Possible values:

calledMethodstring · enumRequired

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

Possible values:

Responses

200

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

application/xml

successbooleanRequired

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

errorsstring[]Required

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

warningsstring[]Required

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

infostring[]Required

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

messageCodesstring[]Required

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

errorCodesstring[]Required

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

warningCodesstring[]Required

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

infoCodesstring[]Required

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

post/xml/

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

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

200

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

<?xml version="1.0" encoding="UTF-8"?>
<root>
    <success>true</success>
    <data>
        <item>
            <Number>102-00265830</Number>
            <Ref>c1d8788a-e7be-11ef-b619-005056bdc0e9</Ref>
            <TimeIntervalDescription>08:00 - 18:00</TimeIntervalDescription>
            <PreferredDeliveryDate>11.02.2025</PreferredDeliveryDate>
            <SenderAddressDescription>Київ, вул. Лісківська 5</SenderAddressDescription>
        </item>
    </data>
    <errors/>
    <warnings/>
    <info/>
    <messageCodes/>
    <errorCodes/>
    <warningCodes/>
    <infoCodes/>
</root>

Скасувати заявку на виклик кур’єра (JSON)

post

Метод deleteCourierCall працює в моделі CarCallGeneral*.

Цей метод дозволяє скасувати заявку на виклик кур’єра. Якщо заявка скасовується менше ніж за годину до закінчення часового інтервалу та у замовника доступний безготівковий розрахунок, нараховується оплата за відміну заявки — 350 грн.

Обмеження та детальні умови скасування

Скасування заявки заборонено, якщо:

• кур’єр перебуває на адресі відправника та підтвердив кількість і вагу відправлення у заявці;
• заявка має статус «Виконано».

*Для перегляду списку доданих інтернет-документів за номером заявки на виклик кур’єра потрібно використовувати метод getEWTemplateList моделі InternetDocument.

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

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

200

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

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

Скасувати заявку на виклик кур’єра (XML)

post

Метод deleteCourierCall працює в моделі CarCallGeneral*.

Цей метод дозволяє скасувати заявку на виклик кур’єра. Якщо заявка скасовується менше ніж за годину до закінчення часового інтервалу та у замовника доступний безготівковий розрахунок, нараховується оплата за відміну заявки — 350 грн.

Обмеження та детальні умови скасування

Скасування заявки заборонено, якщо:

• кур’єр перебуває на адресі відправника та підтвердив кількість і вагу відправлення у заявці;
• заявка має статус «Виконано».

*Для перегляду списку доданих інтернет-документів за номером заявки на виклик кур’єра потрібно використовувати метод getEWTemplateList моделі InternetDocument.

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

"<?xml version="1.0" encoding="UTF-8"?>
<file>
    <apiKey>[ВАШ КЛЮЧ]</apiKey>
    <modelName>CarCallGeneral</modelName>
    <calledMethod>deleteCourierCall</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>
        <item>
            <Cost>0.00</Cost>
            <Number>102-00265906</Number>
        </item>
    </data>
    <errors/>
    <warnings/>
    <info/>
    <messageCodes/>
    <errorCodes/>
    <warningCodes/>
    <infoCodes/>
</root>

Редагувати заявку на виклик кур’єра (JSON)

post

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

Цей метод дозволяє редагувати дані вже створеної заявки на виклик кур'єра. Усі параметри заповнювати обов'язково. Після оновлення замінюються лише ті, які було модифіковано.

Обмеження та детальні умови редагування

• Заявку можна редагувати не пізніше ніж за 2 години до кінця зазначеної дати та часового інтервалу.
• Редагування заборонено, якщо кур’єр перебуває на адресі відправника та підтвердив кількість і вагу відправлень.
• Метод доступний відправнику в межах заявки, проте не всі параметри можна оновлювати. Відправник може редагувати такі параметри:

  • дату та часовий інтервал;
  • планову вагу у заявці.
• Щоб дізнатися про доступні часові інтервали для послуги «Виклик кур’єра», потрібно використовувати метод отримання доступних часових інтервалів (див. метод getPickupTimeIntervals моделі CommonGeneral).

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

{
  "apiKey": "[ВАШ КЛЮЧ]",
  "modelName": "CarCallGeneral",
  "calledMethod": "updateCourierCall",
  "methodProperties": {
    "Ref": "00000000-0000-0000-0000-000000000000",
    "PreferredDeliveryDate": "29.12.2023",
    "PlanedWeight": "120",
    "TimeInterval": "CityPickingTimeInterval3"
  }
}

200

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

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

Редагувати заявку на виклик кур’єра (XML)

post

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

Цей метод дозволяє редагувати дані вже створеної заявки на виклик кур'єра. Усі параметри заповнювати обов'язково. Після оновлення замінюються лише ті, які було модифіковано.

Обмеження та детальні умови редагування

• Заявку можна редагувати не пізніше ніж за 2 години до кінця зазначеної дати та часового інтервалу.
• Редагування заборонено, якщо кур’єр перебуває на адресі відправника та підтвердив кількість і вагу відправлень.
• Метод доступний відправнику в межах заявки, проте не всі параметри можна оновлювати. Відправник може редагувати такі параметри:

  • дату та часовий інтервал;
  • планову вагу у заявці.
• Щоб дізнатися про доступні часові інтервали для послуги «Виклик кур’єра», потрібно використовувати метод отримання доступних часових інтервалів (див. метод getPickupTimeIntervals моделі CommonGeneral).

Body

apiKeystringRequired

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

modelNamestring · enumRequired

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

Possible values:

calledMethodstring · enumRequired

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

Possible values:

Responses

200

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

application/xml

successbooleanRequired

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

errorsstring[]Required

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

warningsstring[]Required

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

infostring[]Required

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

messageCodesstring[]Required

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

errorCodesstring[]Required

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

warningCodesstring[]Required

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

infoCodesstring[]Required

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

post/xml/

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

"<?xml version="1.0" encoding="UTF-8"?>
<file>
    <apiKey>[ВАШ КЛЮЧ]</apiKey>
    <modelName>CarCallGeneral</modelName>
    <calledMethod>updateCourierCall</calledMethod>
    <methodProperties>
        <Ref>00000000-0000-0000-0000-000000000000</Ref>
        <PreferredDeliveryDate>29.12.2023</PreferredDeliveryDate>
        <PlanedWeight>120</PlanedWeight>
        <TimeInterval>CityPickingTimeInterval3</TimeInterval>
    </methodProperties>
</file>
"

200

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

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

Видалити документи із заявки на виклик кур’єра (JSON)

post

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

Цей метод дозволяє видалити із заявки на виклик кур’єра ті інтернет-документи, які не потрібно передавати кур’єру в її межах. Він підтримує кілька способів видалення: окремо (по одному) або масово. Основна частина методу однакова, відрізняється лише кількість документів, які видаляються.

Обмеження та детальні умови видалення

Заборонено видаляти інтернет-документи із заявки на виклик кур’єра, якщо:

• заявка має один зі статусів «Виконано»;
• кур’єр перебуває на адресі відправника та підтвердив кількість і вагу відправлень у заявці.

Для перегляду переліку доданих інтернет-документів за номером заявки на виклик кур’єра потрібно використовувати відповідний метод (див. метод getEWTemplateList моделі InternetDocument).

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

{
  "apiKey": "[ВАШ КЛЮЧ]",
  "modelName": "CarCallGeneral",
  "calledMethod": "removeDocuments",
  "methodProperties": {
    "LinkedDocuments": [
      "20600000179858"
    ]
  }
}

200

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

{
  "success": true,
  "data": [
    {
      "succeeded": [
        20450009111502
      ]
    }
  ],
  "errors": [],
  "warnings": [],
  "info": [],
  "messageCodes": [],
  "errorCodes": [],
  "warningCodes": [],
  "infoCodes": []
}

Видалити документи із заявки на виклик кур’єра (XML)

post

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

Цей метод дозволяє видалити із заявки на виклик кур’єра ті інтернет-документи, які не потрібно передавати кур’єру в її межах. Він підтримує кілька способів видалення: окремо (по одному) або масово. Основна частина методу однакова, відрізняється лише кількість документів, які видаляються.

Обмеження та детальні умови видалення

Заборонено видаляти інтернет-документи із заявки на виклик кур’єра, якщо:

• заявка має один зі статусів «Виконано»;
• кур’єр перебуває на адресі відправника та підтвердив кількість і вагу відправлень у заявці.

Для перегляду переліку доданих інтернет-документів за номером заявки на виклик кур’єра потрібно використовувати відповідний метод (див. метод getEWTemplateList моделі InternetDocument).

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

"<?xml version="1.0" encoding="UTF-8"?>
<file>
    <apiKey>[ВАШ КЛЮЧ]</apiKey>
    <modelName>CarCallGeneral</modelName>
    <calledMethod>removeDocuments</calledMethod>
    <methodProperties>
        <LinkedDocuments>
            <item>20600000179858</item>
        </LinkedDocuments>
    </methodProperties>
</file>
"

200

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

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

Створити заявку на виклик кур’єра (JSON)

post

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

Цей метод дозволяє створити заявку на виклик кур’єра для відправлення з адреси. Метод доступний лише для клієнтів-відправників, яким підключено послугу «Виклик кур’єра» через запит до персонального менеджера. Разом із підключенням цієї послуги встановлюється налаштування, що вимикає автоматичне створення заявки на підставі інтернет-документа (ІД) з адреси.

Обмеження та детальні умови створення

Заявку на виклик кур’єра неможливо створити, якщо:

• вже існує заявка на зазначений часовий інтервал із аналогічної адреси та від аналогічного контрагента;
• часовий інтервал уже минув або недоступний для замовлення.

Щоб отримати доступні часові інтервали для виклику кур’єра, використовується метод getPickupTimeIntervals моделі CommonGeneral.

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

{
  "apiKey": "[ВАШ КЛЮЧ]",
  "modelName": "CarCallGeneral",
  "calledMethod": "saveCourierCall",
  "methodProperties": {
    "ContactSenderRef": "00000000-0000-0000-0000-000000000000",
    "PreferredDeliveryDate": "29.12.2023",
    "PlanedWeight": "200",
    "TimeInterval": "CityPickingTimeInterval3",
    "CounterpartySender": "00000000-0000-0000-0000-000000000000",
    "AddressSenderRef": "00000000-0000-0000-0000-000000000000"
  }
}

200

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

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

Створити заявку на виклик кур’єра (XML)

post

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

Цей метод дозволяє створити заявку на виклик кур’єра для відправлення з адреси. Метод доступний лише для клієнтів-відправників, яким підключено послугу «Виклик кур’єра» через запит до персонального менеджера. Разом із підключенням цієї послуги встановлюється налаштування, що вимикає автоматичне створення заявки на підставі інтернет-документа (ІД) з адреси.

Обмеження та детальні умови створення

Заявку на виклик кур’єра неможливо створити, якщо:

• вже існує заявка на зазначений часовий інтервал із аналогічної адреси та від аналогічного контрагента;
• часовий інтервал уже минув або недоступний для замовлення.

Щоб отримати доступні часові інтервали для виклику кур’єра, використовується метод getPickupTimeIntervals моделі CommonGeneral.

Body

apiKeystringRequired

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

modelNamestring · enumRequired

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

Possible values:

calledMethodstring · enumRequired

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

Possible values:

Responses

200

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

application/xml

successbooleanRequired

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

errorsstring[]Required

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

warningsstring[]Required

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

infostring[]Required

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

messageCodesstring[]Required

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

errorCodesstring[]Required

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

warningCodesstring[]Required

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

infoCodesstring[]Required

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

post/xml/

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

"<?xml version="1.0" encoding="UTF-8"?>
<file>
    <apiKey>[ВАШ КЛЮЧ]</apiKey>
    <modelName>CarCallGeneral</modelName>
    <calledMethod>saveCourierCall</calledMethod>
    <methodProperties>
        <ContactSenderRef>00000000-0000-0000-0000-000000000000</ContactSenderRef>
        <PreferredDeliveryDate>29.12.2023</PreferredDeliveryDate>
        <PlanedWeight>"200"</PlanedWeight>
        <TimeInterval>CityPickingTimeInterval3</TimeInterval>
        <CounterpartySender>00000000-0000-0000-0000-000000000000</CounterpartySender>
        <AddressSenderRef>00000000-0000-0000-0000-000000000000</AddressSenderRef>
    </methodProperties>
</file>
"

200

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

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