Xsolla-logo

Создание правила фильтрации каталога

post/v2/project/{project_id}/admin/user/attribute/rule

Создает правило для пользовательских атрибутов.

SecuritybasicAuth
Request
path Parameters
project_id
required
integer

ID проекта. Вы можете найти этот параметр в Личном кабинете рядом с названием проекта.

Example: 44056
Request Body schema: application/json
name
required
string [ 1 .. 255 ] characters ^\S

Читаемое название правила. Используется для отображения правила в Личном кабинете.

is_enabled
required
boolean

Включено ли данное правило.

required
Array of type = string (objects) or Array of type = date (objects) or Array of type = number (objects)
One of:

Условия, которые сравниваются со значениями пользовательских атрибутов. Чтобы действие вступило в силу, все условия должны быть выполнены.

[ 1 .. 100 ] items
Array ([ 1 .. 100 ] items)
attribute
required
string [ 1 .. 255 ] characters ^[-_.\\d\\w]+$

Код атрибута пользователя.

operator
required
string

Тип операции, выполняемой по условию. Для типа атрибута string.

Enum: Description
eq

Равно

ne

Не равно

value
required
string <= 255 characters

Значение условия, с которым будет сравниваться значение атрибута пользователя. Тип зависит от типа атрибута.

type
required
string

Тип атрибута пользователя.

Value: "string"
can_be_missing
boolean

Считается ли условие выполненным, если этот атрибут отсутствует в атрибутах пользователя. Передайте true, чтобы показывать товар пользователям, у которых нет этого атрибута. Пользователи у которых атрибут есть, но значение не совпадает с указанным в условии, не увидят товар.false — пользователи у которых атрибут есть, но значение не совпадает с указанным в условии, или атрибута нет, не увидят товар.

required
Array of objects or objects [ 1 .. 100 ] items
Array ([ 1 .. 100 ] items)
One of:

Товары, которые видит пользователь, если переданные им значения атрибутов товаров соответствуют условиям.

item_id
required
number

ID товара.

is_satisfied_for_unauth
boolean

Отображается ли товар неавторизованным пользователям. Если true, товар отображается неавторизованным пользователям независимо от правил отображения каталога. false по умолчанию.

Responses
201

Правило успешно создано.

401

Данные для аутентификации не переданы или ошибочны. Убедитесь, что использовали аутентификацию и проверьте правильность учетных данных.

422

Ошибка валидации запроса.

Request samples
application/json
{
  • "attribute_conditions": [
    ],
  • "is_enabled": true,
  • "is_satisfied_for_unauth": false,
  • "items": [
    ],
  • "name": "Ork race armor rule"
}
Response samples
application/json
{
  • "rule_id": 1
}