API Услуга Изменение данных

Возможность самостоятельного оформления Клиентом услуги «Изменение данных» при использовании API.

2. Создание заявки по изменению данных

Метод «save», работает в модели «AdditionalService», этот метод позволяет создать заявку по изменению данных.
Нельзя изменить контрагента-отправителя

URL для входа https://api.novaposhta.ua/v2.0/{format}/ [json or xml]
Формат, обязательно, должен указываться нижним регистром (маленькими буквами). Например: https://api.novaposhta.ua/v2.0/json/


Доступность: Требует использования API-ключа.

Try it

URL-адрес запроса

Параметры запроса

string

Форматы JSON, XML

Заголовки запросов

(дополнительный)
string
Тип формата текста, отправляемого в API.

Текст запроса

Параметр Тип данных Описание
apiKey* string[36] Ваш ключ API 2.0
modelName* string Имя модели
calledMetdod* string Имя вызываемого метода
metdodProperties   Свойства метода
IntDocNumber* int[36] Номер документа для которого будет создавать заявка
OrderType* String[36] Изменение данных
SenderContactName String[36] Контактное лицо отправителя
SenderPhone int[36] Номер телефона отправителя
Recipient String[36] Идентификатор контрагента получатель
RecipientContactName String[36] Контрагент получатель
RecipientPhone int[36] Номер телефона получателя
PayerType String[36] Вид плательщика
PaymentMethod String[36] Форма оплаты

{  
   "apiKey":"[ВАШ КЛЮЧ]",
    "modelName":"AdditionalService",
    "calledMethod":"save",
    "methodProperties":{
    "IntDocNumber":"20600000066986",
    "OrderType":"orderChangeEW",
    "SenderContactName":"Пупкін Дмитро",
    "SenderPhone":"0664561237",
    "Recipient":"0c38cdbe-84b9-11e6-af9a-005056886752",
    "RecipientContactName":"Могильна Юлія",
    "RecipientPhone":"0674071624",
    "PayerType":"Recipient",
    "PaymentMethod":"Cash"
   }
}	

Ответ 200

Всегда возвращает код 200 даже при логических ошибках.


Тело ответа на запрос

Параметр Тип данных Описание
Ref String[36] Идентификатор заявки
Number int[36] Номер эекспрасс-накладной

{
    "success": true,
    "data": [
        {
            "Ref": "1a9111c5-a1e5-11e7-baae-005056b28cf4",
            "Number": "102-00010160"
        }
}