Золотенков

Создать покупателя

POST https://mrp.zolotenkov.ru/api/external/v1/customers

Требуемое право ключа: write:sales.customer.create

Заводит карточку контрагента. Возвращенный id — тот самый customer_id, который требует тело POST /sales-orders: до ZOL-11167 узнать его снаружи было нечем, и на пустом учете заказ покупателя оформить было не на кого. Обязателен Idempotency-Key: повтор с тем же ключом вернет прежний ответ и второй карточки не создаст.

Заголовки

  • Idempotency-Key строка обязателен

    Обязателен, до 200 символов. Повтор с тем же ключом возвращает прежний ответ и второй карточки не создает. Ответ на повтор помечен заголовком Idempotency-Replayed: true — по коду ответа повтор от первичного вызова не отличается.

Тело запроса

Формат — application/json.

  • address строка необязателен может быть пустым

    Адрес доставки по умолчанию.

  • bill_to_address строка необязателен может быть пустым

    Юридический адрес.

  • country_code строка необязателен может быть пустым

    Страна, ISO-3166-1 alpha-2. Заказ покупателя берет ее как значение по умолчанию.

  • currency строка необязателен может быть пустым

    Валюта расчетов, трехбуквенный код. По умолчанию валюта учета.

  • email строка необязателен может быть пустым
  • first_name строка необязателен может быть пустым
  • inn строка необязателен может быть пустым

    ИНН. Повтор в пределах учета отвечает 409.

  • kpp строка необязателен может быть пустым
  • last_name строка необязателен может быть пустым
  • legal_name строка необязателен может быть пустым

    Наименование под УПД.

  • notes строка необязателен может быть пустым
  • ogrn строка необязателен может быть пустым
  • phone строка необязателен может быть пустым
  • title строка обязателен

    Отображаемое имя контрагента. Единственное обязательное поле. У поставщика это же поле называется name — имена полей у двух справочников исторически разошлись, и переименование сломало бы уже выпущенные ключи.

Ответы

  • 201 Карточка покупателя создана. Повтор с прежним Idempotency-Key отвечает тем же кодом и тем же телом — новой карточки не появляется
  • 400 Некорректное тело запроса
  • 401 Ключ не передан, недействителен или отозван
  • 403 У ключа нет права write:sales.customer.create
  • 409 Idempotency-Key повторен с другим телом либо ИНН уже занят другим покупателем этого учета
  • 429 Превышена частота обращений (rate_limited) либо исчерпан суточный предел документов ключа (document_quota_exceeded). Задержка до повтора — в заголовке Retry-After