Перейти к содержимому
/
Получение списка ежедневн...

Shop Builder API (2.0.0)

Overview

  • Version: 2.0.0
  • Servers: https://store.xsolla.com/api
  • Contact Us by Email
  • Contact URL: https://xsolla.com/
  • Required TLS version: 1.2

Shop Builder API provides a third-party solution for implementing the server side for your store interface. Use the endpoints to manage in-game items, in-game currencies, cart, player inventory, promotions, game library, etc.

Скачать описание OpenAPI
index.json
index.yaml
Языки
Серверы
Mock server
https://xsolla.redocly.app/_mock/ru/api/shop-builder/
https://store.xsolla.com/api/

Admin

Операции

Персонализированный каталог

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

Узнать о персонализированных акциях можно в подразделе "Скидки" раздела "Акции".

Чтобы передать атрибуты перед покупкой, вы можете использовать API Авторизации Иксолла или передать их в свойство user.attributes при генерации токена с помощью API Платежей Иксолла.

Операции

Admin

Операции

Catalog

Операции

Корзина (на стороне клиента)

Операции

Корзина (на стороне сервера)

Операции

Оплата (на стороне клиента)

Операции

Оплата (на стороне сервера)

Операции

Заказ

Операции

Бесплатные товары

Операции

Вебхуки

Операции

Предзаказы

Операции

Продавец

Операции

Catalog

Данный API позволяет получать продаваемые товары любого вида или конкретный товар.

Операции

Общие регионы

Операции

Catalog

Операции

Владение играми

Операции

Admin

Операции

Общие

Операции

Купоны

Этот API позволяет вам управлять купонами.

Операции

Промокоды

Этот API позволяет вам управлять промокодами.

Операции

Уникальный каталог предложений

Этот API позволяет вам управлять уникальными предложениями каталога.

Операции

Скидки

Этот API позволяет вам управлять скидочными акциями.

Операции

Бонусы

Этот API позволяет вам управлять бонусными акциями.

Операции

Admin

Операции

Catalog

Операции

Виртуальная оплата

Операции

Управление

Операции

Admin

Операции

Клиент

Операции

Клиент кланов

Операции

Admin

Операции

Клиент

Операции

Admin

Операции

Получение списка ежедневных наградServer-sideAdmin

Запрос

Получает список ежедневных наград для администрирования.

Примечание

Метод возвращает список элементов с учетом пагинации. Максимальное количество элементов в ответе — 50 (установлено по умолчанию). Чтобы получить доступ к следующим элементам списка, используйте параметры `limit` и `offset`. Например, при вызове метода с параметрами `limit = 25` и `offset = 100` вернется 25 элементов, начиная со 101-го в общем списке.
Безопасность
basicAuth
Путь
project_idintegerобязательный

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

Пример: 44056
Запрос
limitinteger>= 1

Лимит количества элементов на странице.

Пример: limit=50
offsetinteger>= 0

Номер элемента, с которого выполняется вывод на странице (нумерация ведется с 0).

Пример: offset=0
enabledinteger

Фильтрует элементы по флагу is_enabled.

is_expiredinteger

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

typestring

Фильтрует ежедневные награды, чтобы возвращать только указанный тип.

Перечисление"calendar_hard""rolling_skippable""rolling_unskippable"
curl -i -X GET \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/ru/api/shop-builder/v2/project/44056/admin/daily_chain?limit=50&offset=0&enabled=0&is_expired=0&type=calendar_hard'

Ответы

Список ежедневных наград успешно получен.

Телоapplication/json
has_moreboolean(Pagination_has-more)

Используется как индикатор того, что остались еще страницы.

Пример: true
itemsArray of any(admin-daily-chain-short-model)
total_items_countinteger

Общее количество ежедневных наград.

Пример: 3
Ответ
application/json
{
  "has_more": false,
  "items": [
    { … },
    { … },
    { … },
    { … },
    { … }
  ],
  "total_items_count": 3
}

Создание ежедневной наградыServer-sideAdmin

Запрос

Создает ежедневную награду.

Безопасность
basicAuth
Путь
project_idintegerобязательный

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

Пример: 44056
Телоapplication/json
One of:

Ежедневная награда с типом calendar_hard.

date_startstring(date-time)(calendar_hard_date_start)обязательный

Дата, когда начнет действовать ежедневная награда.

Пример: "2020-04-15T18:16:00+05:00"
is_recurrentboolean(calendar_hard_is_recurrent)

Перезапускается ли ежедневная награда. Если передано значение true, ежедневная награда автоматически сбрасывается в конце периода ее действия. Следующие значения для параметров start_date и end_date рассчитываются исходя из количества уровней ежедневной награды и времени старта ежедневной награды, заданном в параметре start_date.

По умолчанию false
Пример: true
typestringобязательный

Тип ежедневной награды, который определяет, когда пользователи могут получать награды.

Перечисление ЗначениеОписание
calendar_hard

Разблокирует следующий уровень наград каждые 24 часа. Неполученные награды становятся недоступны, как только открывается награда за следующий уровень.

rolling_skippable

Разблокирует награду за следующий уровень каждые 24 часа, отсчет начинается со значения, указанного в параметре date_start. Прогресс последовательный: новая награда не откроется, пока не будет получена предыдущая. Если пользователь пропустил один или несколько дней, Если пользователь пропускает один или несколько дней, он продолжает с того уровня, где остановился; за пропущенные дни награды не полагаются.

rolling_unskippable

Разблокирует награду за следующий уровень каждые 24 часа, отсчет начинается со значения, указанного в параметре date_start. Прогресс последовательный: новая награда не откроется, пока не будет получена предыдущая. Если пользователь пропустил день, его прогресс сбрасывается и он начинает заново с первого уровня.

description(two-letter (object or null)) or (five-letter (object or null))(description-localization-object)

Объект с локализованными описаниями товара. Принимает значения в одном из двух форматов: двухбуквенный код языка в нижнем регистре (например, en) или код локали из пяти символов (например, en-US). Оба формата допустимы при отправке запроса, но в ответе всегда используется код из двух символов. Если для одного языка указаны оба варианта (например, en и en-US), будет сохранено последнее переданное значение. Полный список поддерживаемых языков приведен в документации.

One of:

Объект с локализованными описаниями товара. Принимает значения в одном из двух форматов: двухбуквенный код языка в нижнем регистре (например, en) или код локали из пяти символов (например, en-US). Оба формата допустимы при отправке запроса, но в ответе всегда используется код из двух символов. Если для одного языка указаны оба варианта (например, en и en-US), будет сохранено последнее переданное значение. Полный список поддерживаемых языков приведен в документации.

is_enabledboolean(is_enabled)обязательный
Пример: true
name(two-letter (object or null)) or (five-letter (object or null))(name-localization-object)обязательный

Объект с локализованными названиями товара. Принимает значения в одном из двух форматов: двухбуквенный код языка в нижнем регистре (например, en) или код языка из пяти символов (например, en-US). Оба формата допустимы при отправке запроса, но в ответе всегда используется двухбуквенный код языка. Если для одного языка указаны оба варианта (например, en и en-US), будет сохранено последнее переданное значение. Полный список поддерживаемых языков приведен в документации.

One of:

Объект с локализованными названиями товара. Принимает значения в одном из двух форматов: двухбуквенный код языка в нижнем регистре (например, en) или код языка из пяти символов (например, en-US). Оба формата допустимы при отправке запроса, но в ответе всегда используется двухбуквенный код языка. Если для одного языка указаны оба варианта (например, en и en-US), будет сохранено последнее переданное значение. Полный список поддерживаемых языков приведен в документации.

name.​arstring or null

Арабский

name.​bgstring or null

Болгарский

name.​cnstring or null

Китайский упрощенный

name.​csstring or null

Чешский

name.​destring or null

Немецкий

name.​enstring or null

Английский

name.​esstring or null

Spanish (Spain)

name.​frstring or null

Французский

name.​hestring or null

Иврит

name.​idstring or null

Индонезийский

name.​itstring or null

Итальянский

name.​jastring or null

Японский

name.​kmstring or null

Кхмерский

name.​kostring or null

Корейский

name.​lostring or null

Лаосский

name.​mystring or null

Бирманский

name.​nestring or null

Непальский

name.​phstring or null

Филиппинский

name.​plstring or null

Польский

name.​ptstring or null

Португальский

name.​rostring or null

Румынский

name.​rustring or null

Русский

name.​thstring or null

Тайский

name.​trstring or null

Турецкий

name.​twstring or null

Китайский традиционный

name.​vistring or null

Вьетнамский

orderinteger(order)

Определяет порядок расположения.

Пример: 1
stepsArray of objects(create-daily-chain-step-model)обязательный
steps[].​itemsArray of objects(modify-daily-chain-item-model)non-emptyобязательный
steps[].​items[].​quantityinteger>= 1обязательный

Количество уровней ежедневной награды для этого артикула

steps[].​items[].​skustring(sku)[ 1 .. 255 ] characters^[a-zA-Z0-9_\-–.]*$обязательный

Уникальный ID товара. Артикул может содержать только строчные и заглавные латинские буквы, цифры, точки, тире и подчеркивания.

Пример: "booster_mega_1"
steps[].​step_numberinteger(daily_chain_step_number)>= 1обязательный

Номер уровня.

Пример: 2
curl -i -X POST \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/ru/api/shop-builder/v2/project/44056/admin/daily_chain \
  -H 'Content-Type: application/json' \
  -d '{
    "date_start": "2023-04-15T18:16:00+05:00",
    "description": {
      "en": "New daily reward short description"
    },
    "is_enabled": true,
    "name": {
      "en": "New daily reward",
      "ru": "Новая ежедневная награда"
    },
    "order": 4,
    "steps": [
      {
        "items": [
          {
            "quantity": 2,
            "sku": "vg_enabled_shown_in_store_1"
          }
        ],
        "step_number": 1
      },
      {
        "items": [
          {
            "quantity": 2,
            "sku": "bundle_enabled_shown_in_store_with_2_enabled_shown_in_store_vg"
          }
        ],
        "step_number": 2
      },
      {
        "items": [
          {
            "quantity": 2,
            "sku": "vcp_enabled_shown_in_store_1_of_10_vc_enabled_shown_in_store_1"
          }
        ],
        "step_number": 3
      },
      {
        "items": [
          {
            "quantity": 1,
            "sku": "vg_enabled_shown_in_store_1"
          }
        ],
        "step_number": 4
      },
      {
        "items": [
          {
            "quantity": 1,
            "sku": "bundle_enabled_shown_in_store_with_2_enabled_shown_in_store_vg"
          }
        ],
        "step_number": 5
      },
      {
        "items": [
          {
            "quantity": 1,
            "sku": "vcp_enabled_shown_in_store_1_of_10_vc_enabled_shown_in_store_1"
          }
        ],
        "step_number": 6
      }
    ],
    "type": "calendar_hard"
  }'

Ответы

Ежедневная награда была успешно создана.

Телоapplication/json
daily_chain_idinteger
Пример: 10
Ответ
application/json
{
  "daily_chain_id": 10
}

Удаление ежедневной наградыServer-sideAdmin

Запрос

Удаляет определенную ежедневную награду.

Безопасность
basicAuth
Путь
project_idintegerобязательный

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

Пример: 44056
daily_chain_idintegerобязательный

ID ежедневной награды.

Пример: 101
curl -i -X DELETE \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/ru/api/shop-builder/v2/project/44056/admin/daily_chain/id/101

Ответы

Ежедневная награда успешно удалена.

Тело
Ответ
Нет содержимого

Клиент

Операции

Admin

Операции

Клиент

Операции

Admin

Операции