Создать площадку мерчанта

POST 
/api/v1/marketplaces/create

Вместе с созданием площадки создаются мерчант и заявка. Если площадка или мерчант уже существует, то данные по ним обновляются.

Request

Header Parameters

X-CLIENT-SIGNATURE stringrequired
Подпись запроса
Example: sign

application/json

Body

external_id stringrequired
Possible values: [(a-z), (а-я), (0-9)]
Идентификатор заявки
Формат поля:
• Поле не пустое
• Латинские буквы (a-z)
• Кириллические буквы (а-я)
• Цифры (0-9)
• Специальные символы (//, .., , )), ]], ==, ++, -- и другие)
mcc_code stringrequired
Possible values: [4 digits]
MCC-код площадки
Формат поля:
• МСС-код должен быть числовым значением, состоящим ровно из 4 символов (цифр).
• Поле не пустое
url stringrequired
Possible values: [url]
URL площадки
Формат поля:
• Должен быть корректным URL
• Поле не пустое
name stringrequired
Possible values: <= 1024 characters
Наименование мерчанта
Формат поля:
• Латинские буквы (a-z)
• Кириллические символы (а-я)
• Цифры (0-9)
• Специальные символы (//, .., , )), ]], ==, ++, -- и другие)
• Поле не пустое
• Длина строки - до 1024 символов
tin stringrequired
Possible values: <= 20 characters
ИНН мерчанта
Формат поля:
• Латинские буквы (a-z)
• Кириллические символы (а-я)
• Специальные символы (//, .., , )), ]], ==, ++, -- и другие)
• Цифры (0-9)
• Длина строки — до 20 символов
• Поле не пустое
priority integerrequired

Possible values: [-1, 0, 1]

Приоритет мерчанта

tags string[]
Possible values: <= 60 characters
Теги площадки:
Формат поля:
• Латинские буквы (a-z)
• Кириллические символы (а-я)
• Цифры (0-9)
• Специальные символы (//, .., , )), ]], ==, ++, -- и другие)
• Длина строки - до 60 символов

Responses

201

Площадка создана

application/json

Schema

Schema

result

object

Площадка

id uuidrequired

Идентификатор площадки

merchant_id uuidrequired

Идентификатор мерчанта

decision MarketplaceDecisionStaterequired

Possible values: [none, approved, declined]

Решение по площадке

decision_applied_at date-timerequired

Время принятия решения по площадке

decision_applied_by uuidrequired

Идентификатор пользователя, который принял решение

decision_applied_full_name stringnullrequired

ФИО принявшего решение

status MarketplaceStatusrequired

Possible values: [pending, processing, ready_for_check, postponed, has_critical_changes, finished]

Статус площадки на основе сканирования

status_applied_at date-timerequired

Дата установки статуса

scan_id uuidnullablerequired

Идентификатор сканирования, связанного с площадкой

Example (from schema)

{
  "result": {
    "id": "310ebf14-d5ee-4b4f-8e99-e93f9421888d",
    "merchant_id": "2601df82-ef61-4045-b3c0-7dc4c4e40ddc",
    "decision": "none",
    "decision_applied_at": null,
    "decision_applied_by": null,
    "decision_applied_full_name": null,
    "status": "pending",
    "status_applied_at": "2024-02-29T13:33:35.818Z",
    "scan_id": "33f1a853-6c40-4887-ba81-3d50869e737d"
  }
}

400

Некорректный запрос

application/json

Schema

Schema

error

object

code numberrequired

Default value: -40001

message stringrequired

Example (from schema)

{
  "error": {
    "code": -40001,
    "message": "Подпись запроса является невалидной"
  }
}

401

Требуется авторизация

application/json

Schema

Schema

error

object

code numberrequired

Default value: -401

message stringrequired

Example (from schema)

{
  "error": {
    "code": -401,
    "message": "Требуется авторизация"
  }
}

403

Ошибка валидации

application/json

Schema

Schema

error

object

code numberrequired

Default value: -40001

message stringrequired

data

object

validation object

Example (from schema)

{
  "error": {
    "code": -40001,
    "message": "Неверный формат данных",
    "data": {
      "validation": {
        "mcc_code": [
          "Количество символов в поле mcc_code должно быть равным 4."
        ],
        "priority": [
          "Значение поля priority должно быть значением -1, 0 или 1."
        ]
      }
    }
  }
}

409

Заявка является дубликатом

application/json

Schema

Schema

error

object

code numberrequired

Default value: -409

message stringrequired

Example (from schema)

{
  "error": {
    "code": -409,
    "message": "Заявка является дубликатом"
  }
}

500

Внутренняя ошибка сервера

application/json

Schema

Schema

error

object

code numberrequired

Default value: -50000

message stringrequired

Example (from schema)

{
  "error": {
    "code": -50000,
    "message": "Внутренняя ошибка сервера"
  }
}

Loading...