contractor

Добавить нового контрагента для маркировки рекламы.

Формат запроса

https://adfox.yandex.ru/api/v1
  ? object=account
  & action=<add>
  & actionObject=contractor
  & name=<string>
  & inn=<string>
  & type=<integer>
  & [countryOKSM=<string>]
  & [mobilePhone=<string>]
  & [epayNumber=<string>]
  & [regNumber=<string>]
  & [roles[]=<integer>]
  & [isRr=<integer>]
  & [isOrs=<integer>]
  & [rsUrl=<string>]

name*

Название контрагента. Вы можете использовать только русские буквы. Также можно использовать пробел и тире (не более одного пробела и/или тире между словами). Тире нельзя использовать в начале и в конце предложения.

inn*

ИНН контрагента.

type*

Тип контрагента.

Допустимые значения:

  • 0 — Юридическое лицо (РФ). Обязательно указать значение inn (10 цифр).
  • 1 — Физическое лицо (РФ). Обязательно указать значение inn (12 цифр).
  • 2 — Индивидуальный предприниматель (РФ). Обязательно указать значение inn (12 цифр).
  • 3 — Юридическое лицо (Нерезидент). Обязательно заполнить поле countryOKSM, а также одно из полей: mobilePhone или epayNumber.
  • 4 — Физическое лицо (Нерезидент). Обязательно заполнить поле countryOKSM, а также одно из полей: inn или regNumber.

Значение по умолчанию: 0.

countryOKSM

ОКСМ код страны регистрации.

Значение по умолчанию — 643.

mobilePhone

Номер телефона контрагента. Указывается в формате+[кодстраны]{номертелефона}. В номере телефона можно указать только цифры (от 1 до 50 цифр) без пробелов, тире и других знаков.

epayNumber

Номер электронного средства платежа.

regNumber

Регистрационный номер.

roles[]

Роли в которых может выступать контрагент при заключении договора.

Допустимые значения:

  • 0 — Исполнитель.
  • 1 — Заказчик.

Значение по умолчанию: roles[]=0&roles[]=1 — роль «Заказчик и Исполнитель».

isRr

Является распространителем рекламы.

Допустимые значения:

  • 0 — не является распространителем рекламы;
  • 1 — является распространителем рекламы.

Значение по умолчанию: 0.

isOrs

Является оператором рекламной системы.

Допустимые значения:

  • 0 — не является оператором рекламной системы;
  • 1 — является оператором рекламной системы.

Значение по умолчанию: 0.

rsUrl

URL рекламной системы или другая информация.

* Обязательный параметр

Формат ответа

<response>
<status>
  <code>{integer}</code>
  <ID>{integer}</ID>
</status>
</response>

Параметры ответа

code

Статус обработки запроса. Значение 0 — запрос выполнен успешно. Расшифровку смотрите в разделе Обработка ошибок.

ID

Идентификатор объекта.

Пример запроса и ответа

Запрос:

https://adfox.yandex.ru/api/v1?object=account&action=add&actionObject=contractor&name=ContractorName1&inn=1234567890&type=1&roles[]=0

Ответ:

<response>
<status>
  <code>0</code>
  <ID>3438</ID>
</status>
</response>

Другие действия с объектом

Читайте также о других действиях с объектом contractor:

Предыдущая
Следующая