09.03.2026 16:45

Add

[POST] …/v1/customerpersonaldocument/add

Создаёт персональный документ покупателя.

Метод поддерживает два формата запроса:

  • application/json для обратной совместимости, когда файл передаётся как вложенный объект file с Base64-полем data.
  • multipart/form-data для потоковой загрузки бинарного файла.

Входные параметры

Название Тип данных Обязательность Описание
customer_id Int64 Обязательный ID покупателя
personal_doc_type_id Int64 Обязательный ID типа персонального документа
value String Обязательный Значение документа
file FileAdd Необязательный Добавляемый файл
FileAdd

Для application/json используется вложенный объект file:

Название Тип данных Обязательность Описание
name String Обязательный Наименование файла
extension String Обязательный Расширение файла
data String Обязательный Данные файла в Base64

Для multipart/form-data используются поля формы:

Название Тип данных Обязательность Описание
customer_id Int64 Обязательный ID покупателя
personal_doc_type_id Int64 Обязательный ID типа персонального документа
value String Обязательный Значение документа
file.name String Необязательный Имя файла. Если не передано, сервер возьмёт его из имени загружаемого файла
file.extension String Необязательный Расширение файла. Если не передано, сервер возьмёт его из имени загружаемого файла
file File Необязательный Бинарный поток файла

Ограничения и проверки

  • Файл можно не передавать: документ может быть создан только со значением value.
  • Если файл передан, метод принимает только один файл за запрос.
  • Для JSON-режима обязательны file.name, file.extension, file.data.
  • Для multipart/form-data при передаче бинарного file поля file.name и file.extension можно не отправлять, если они есть в имени файла.

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

{
    "customer_id": 1,
    "personal_doc_type_id": 1,
    "value": "example",
    "file": {
        "name": "example",
        "extension": "png",
        "data": "file_data"
    }
}

Пример multipart-запроса

curl -X POST "https://example.com/v1/customerpersonaldocument/add" \
  -H "Authorization: Bearer <token>" \
  -F "customer_id=1" \
  -F "personal_doc_type_id=1" \
  -F "value=example" \
  -F "file=@passport.png"

Выходные параметры

Название Тип данных Описание
new_id Int64 ID созданного персонального документа покупателя

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

{
    "ok": true,
    "result": {
        "new_id": 1
    }
}