Перейти к содержимому

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

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

Скачать описание OpenAPI
Языки
Серверы
Mock server
https://xsolla.redocly.app/_mock/ru/api/catalog/
https://store.xsolla.com/api/
Операции
Операции
Операции
Операции
Операции
Операции
Операции
Операции

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

Операции

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

Операции

Наполнение корзины товарамиServer-side

Запрос

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

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

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

Пример: 44056
Запрос
localestring

Язык ответа. Двухбуквенный код языка в нижнем регистре в соответствии с ISO 639-1.

По умолчанию "en"
Заголовки
x-user-forstring

Идентификатор пользователя может быть передан с помощью JWT пользователя Авторизации Иксолла или токена доступа Платежей Иксолла).

Пример: ACCESS_TOKEN/LOGIN_JWT
x-user-idstring<= 32 characters

Вы можете использовать свой собственный ID пользователя при продаже корзины с играми.

Пример: UNIQUE_ID
Телоapplication/json
countrystring= 2 characters

Двухбуквенное обозначение страны в верхнем регистре согласно стандарту ISO 3166-1 alpha-2. Список стран, поддерживаемых Xsolla, приведен в документации.
Пример: country=US

Пример: "US"
currencystring= 3 characters

Валюта, в которой указаны цены товаров в корзине. Трехбуквенный код в соответствии с ISO 4217. Подробную информацию о валютах, поддерживаемых Xsolla, смотрите в документации.

Пример: "USD"
itemsArray of objectsnon-emptyобязательный
items[].​quantitynumber>= 1обязательный

Количество товара.

Пример: 2
items[].​skustringnon-emptyобязательный

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

Пример: "t-shirt"
curl -i -X PUT \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/ru/api/catalog/v2/admin/project/44056/cart/fill?locale=en' \
  -H 'Content-Type: application/json' \
  -H 'x-user-for: ACCESS_TOKEN/LOGIN_JWT' \
  -H 'x-user-id: UNIQUE_ID' \
  -d '{
    "currency": "USD",
    "items": [
      {
        "quantity": 2,
        "sku": "com.xsolla.cup01"
      },
      {
        "quantity": 1,
        "sku": "com.xsolla.t-shirt01"
      },
      {
        "quantity": 1,
        "sku": "com.xsolla.cup01"
      },
      {
        "quantity": 1,
        "sku": "com.xsolla.hat01"
      }
    ]
  }'

Ответы

Корзина с товарами успешно возвращена.

Телоapplication/json
cart_idstring

ID корзины. Передается в виде параметра запроса к прокси-странице или в виде параметра пути в API методах оплаты.

Пример: "cart_id"
is_freeboolean(value-cart_is_free)

Если true, корзина бесплатная.

По умолчанию false
Пример: false
itemsArray of objects
priceobject or null

Цена корзины.

promotionsArray of objects(Catalog_cart_promotions)

Примененные ко всей корзине акции. Массив возвращается, если:

  • Акция влияет на общую стоимость корзины при использовании промокода с настройкой Скидка на покупку.

  • К корзине добавляются бонусные товары.

Если акции на уровне заказа не применялись, возвращается пустой массив.

warningsArray of objects
Ответ
application/json
{ "cart_id": "cart_id", "is_free": false, "items": [ {}, {}, {} ], "price": { "amount": "15.97", "amount_without_discount": "22.96", "currency": "USD" }, "promotions": [ {} ], "warnings": [ {} ] }

Наполнение корзины по ID корзины товарамиServer-side

Запрос

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

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

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

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

ID корзины.

Пример: custom_id
Запрос
localestring

Язык ответа. Двухбуквенный код языка в нижнем регистре в соответствии с ISO 639-1.

По умолчанию "en"
Заголовки
x-user-forstring

Идентификатор пользователя может быть передан с помощью JWT пользователя Авторизации Иксолла или токена доступа Платежей Иксолла).

Пример: ACCESS_TOKEN/LOGIN_JWT
x-user-idstring<= 32 characters

Вы можете использовать свой собственный ID пользователя при продаже корзины с играми.

Пример: UNIQUE_ID
Телоapplication/json
countrystring= 2 characters

Двухбуквенное обозначение страны в верхнем регистре согласно стандарту ISO 3166-1 alpha-2. Список стран, поддерживаемых Xsolla, приведен в документации.
Пример: country=US

Пример: "US"
currencystring= 3 characters

Валюта, в которой указаны цены товаров в корзине. Трехбуквенный код в соответствии с ISO 4217. Подробную информацию о валютах, поддерживаемых Xsolla, смотрите в документации.

Пример: "USD"
itemsArray of objectsnon-emptyобязательный
items[].​quantitynumber>= 1обязательный

Количество товара.

Пример: 2
items[].​skustringnon-emptyобязательный

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

Пример: "t-shirt"
curl -i -X PUT \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/ru/api/catalog/v2/admin/project/44056/cart/custom_id/fill?locale=en' \
  -H 'Content-Type: application/json' \
  -H 'x-user-for: ACCESS_TOKEN/LOGIN_JWT' \
  -H 'x-user-id: UNIQUE_ID' \
  -d '{
    "currency": "USD",
    "items": [
      {
        "quantity": 2,
        "sku": "com.xsolla.cup01"
      },
      {
        "quantity": 1,
        "sku": "com.xsolla.t-shirt01"
      },
      {
        "quantity": 1,
        "sku": "com.xsolla.cup01"
      },
      {
        "quantity": 1,
        "sku": "com.xsolla.hat01"
      }
    ]
  }'

Ответы

Корзина с товарами успешно возвращена.

Телоapplication/json
cart_idstring

ID корзины. Передается в виде параметра запроса к прокси-странице или в виде параметра пути в API методах оплаты.

Пример: "cart_id"
is_freeboolean(value-cart_is_free)

Если true, корзина бесплатная.

По умолчанию false
Пример: false
itemsArray of objects
priceobject or null

Цена корзины.

promotionsArray of objects(Catalog_cart_promotions)

Примененные ко всей корзине акции. Массив возвращается, если:

  • Акция влияет на общую стоимость корзины при использовании промокода с настройкой Скидка на покупку.

  • К корзине добавляются бонусные товары.

Если акции на уровне заказа не применялись, возвращается пустой массив.

warningsArray of objects
Ответ
application/json
{ "cart_id": "cart_id", "is_free": false, "items": [ {}, {}, {} ], "price": { "amount": "15.97", "amount_without_discount": "22.96", "currency": "USD" }, "promotions": [ {} ], "warnings": [ {} ] }

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

Операции

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

Операции
Операции
Операции
Операции
Операции
Операции
Операции
Операции

Catalog

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

Операции
Операции
Операции