API Контрагенты

Работа с данными Контрагента

Создать Контрагента

Метод «save», работает в модели «Counterparty», этот метод используется при создании Контрагента получателя.
Все данные вносятся только на Украинском языке.
Рекомендуеться проводить обновление справочников раз в месяц.

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 Имя модели
calledMethod* string Имя вызываемого метода
methodProperties string Свойства метода
CityRef * string[36] Идентификатор города
FirstName* string[36] Имя
MiddleName * string[36] Отчество
LastName* string[36] Фамилия Контактного лица
Phone* string[36] Телефон Контактного лица
Email * string[36] Имейл
CounterpartyType * string[36] Тип контрагента
CounterpartyProperty * string[36] Свойства контрагента
* Обозначение обязательного параметра

{
    "apiKey": "[ВАШ КЛЮЧ]",
    "modelName": "Counterparty",
    "calledMethod": "save",
    "methodProperties": {
        "CityRef": "db5c88d7-391c-11dd-90d9-001a92567626",
        "FirstName": "Фелікс",
        "MiddleName": "Едуардович",
        "LastName": "Яковлєв",
        "Phone": "0997979789",
        "Email": "",
        "CounterpartyType": "PrivatePerson",
        "CounterpartyProperty": "Recipient"
    }
}
<?xml version="1.0" encoding="UTF-8"?>
<file>
<apiKey>[ВАШ КЛЮЧ]</apiKey>
 <calledMethod>save</calledMethod>
 <methodProperties>
 <CityRef>db5c88d7-391c-11dd-90d9-001a92567626</CityRef>
 <CounterpartyProperty>Recipient</CounterpartyProperty>
 <CounterpartyType>PrivatePerson</CounterpartyType>
 <Email />
 <FirstName>Фелікс</FirstName>
 <LastName>Яковлєв</LastName>
 <MiddleName>Едуардович</MiddleName>
 <Phone>0997979789</Phone>
 </methodProperties>
 <modelName>Counterparty</modelName>
</file>

Ответ 200

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


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

Параметр Тип данных Описание
Ref string[36] Идинтификатор контактного лица
Description string[50] Описание контрагента на украинском языке
FirstName string[36] Имя
MiddleName string[36] Отчество
LastName string[36] Фамилия
Counterparty string[36]
OwnershipForm string[36] Идентификатор формы собственности
OwnershipFormDescription string[36] Описание формы собственности
EDRPOU string[36] Код ЕДРПОУ
CounterpartyType string[36] Тип контрагента (организация)
ContactPerson
Description string[50] Описание контактного лица контрагента на украинском языке
Ref string[36] Идинтификатор контактного лица
LastName string[36] Фамилия
FirstName string[36] Имя
MiddleName string[36] Отчество

{
    "success": true,
    "data": [
        {
            "Ref": "c9a6aec1-141b-11e5-ad08-005056801333",
            "Description": "Яковлєв Фелікс Едуардович",
            "FirstName": "Фелікс",
            "MiddleName": "Едуардович",
            "LastName": "Яковлєв",
            "Counterparty": "00000000-0000-0000-0000-000000000000",
            "OwnershipForm": "",
            "OwnershipFormDescription": "",
            "EDRPOU": "",
            "CounterpartyType": "PrivatePerson",
            "ContactPerson": {
                "success": true,
                "data": [
                    {
                        "Description": "Яковлєв Фелікс Едуардович",
                        "Ref": "c9aefd26-141b-11e5-ad08-005056801333",
                        "LastName": "Яковлєв",
                        "FirstName": "Фелікс",
                        "MiddleName": "Едуардович"
                    }
                ],
                "errors": [],
                "warnings": [],
                "info": []
            }
        }
    ],
    "errors": [],
    "warnings": {
        "DuplicateValidate": "Counterparty is not unique"
    },
    "info": []
}
<root>
	<success>true</success>
	<data>
		<item>
			<Ref>c220df80-1354-11e5-ad08-005056801333</Ref>
			<Description>Яковлєв Фелікс Едуардович</Description>
			<FirstName>Фелікс</FirstName>
			<MiddleName>Едуардович</MiddleName>
			<LastName>Яковлєв</LastName>
			<Counterparty>00000000-0000-0000-0000-000000000000</Counterparty>
			<OwnershipForm></OwnershipForm>
			<OwnershipFormDescription></OwnershipFormDescription>
			<EDRPOU></EDRPOU>
			<CounterpartyType>PrivatePerson</CounterpartyType>
			<ContactPerson>
				<success>true</success>
				<data>
					<item>
						<Description>Яковлєв Фелікс Едуардович</Description>
						<Ref>c226639d-1354-11e5-ad08-005056801333</Ref>
						<LastName>Яковлєв</LastName>
						<FirstName>Фелікс</FirstName>
						<MiddleName>Едуардович</MiddleName>
					</item>
				</data>
				<errors />
				<warnings />
				<info />
			</ContactPerson>
		</item>
	</data>
	<errors />
	<warnings>
		<DuplicateValidate>Counterparty is not unique</DuplicateValidate>
	</warnings>
	<info />
</root>