Создание заявки

Для корректировки данных операторами в системе Universe предусмотрена возможность создания заявок через API. Данный механизм удобен для интеграции с внешними системами, в которых будет производиться создание запросов на корректировку данных.

POST <BASE_LOAD_API>/create — метод для создания новой заявки. С его помощью можно:

  • Добавлять описание к заявке;

  • Выбирать связанные записи справочника customer.

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

Обязательные

  • description — описание заявки, в котором должно быть отображено что именно требуется от операторов по корректировке Universe.

Опциональные

  • linkedRecords — ID записей справочника customer из SellOut+, которые относятся к заявке. Передаётся как массив чисел через запятую.

Тело запроса (application/json):
{
  "description": {
    "type": "string",
    "required": true,
    "minLength": 1,
    "maxLength": 2000,
    "description": "Описание заявки с указанием требуемых корректировок"
  },
  "linkedRecords": {
    "type": "array",
    "required": false,
    "items": {
      "type": "int"
    },
    "maxItems": 100,
    "description": "ID связанных записей справочника customer"
  }
}

Пример

Запрос через curl:

curl -X POST "https://app.sellout.plus/universe/api/request/create" ^
     -H "Authorization: Bearer <ваш_токен>" ^
     -H "Content-Type: application/json" ^
     -d '{
           "description": "Необходимо объединить записи",
           "linkedRecords": [8675467, 8675468]
         }'

Успешный ответ:

В случае успеха возвращает ID созданной в SellOut+ заявки на редактирование Universe.

{
    "ID_Request":2100003751
}

Коды ошибок

Код ошибки

Описание

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

400

Неверно заполненные поля

{
    "status": 400,
    "status_description": "BadRequest",
    "error_message": "Duplicate records found: 6545674. Please remove duplicates."
}

401

Не удалось авторизоваться

{
    "status": 401,
    "status_description": "Unauthorized",
    "error_message": "The request is unauthenticated."
}

404

Указанная связанная запись отсутствует в БД

{
    "status": 404,
    "status_description": "NotFound",
    "error_message": "The selected record is not in the universe database. Please refresh the data."
}

409

Наличие нескольких производителей у учётной записи SO+

{
    "status": 409,
    "status_description": "Conflict",
    "error_message": "An account for a token must have only 1 manufacturer"
}

500

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

{
   "status": 500,
   "status_description": "InternalServerError",
   "error_message": "Unexpected error occurred"
}