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

Digital Distribution Hub (1.0.0)

Введение

Digital Distribution Hub — новое решение Иксоллы, которое соединяет электронные и физические платежи через технологию push-платежей и e-commerce.

Данная документация включает в себя описание методов API для продуктов Внутриигровой магазин и Платежи. Используется два базовых URL-адреса:

  • https://store.xsolla.com/api для групп Общие, Каталог, Корзина и Заказ.
  • https://ps.xsolla.com для группы Уведомления.

Использование методов API из группы Каталог не требует авторизации.

Чтобы использовать методы API из групп Корзина и Заказ, вам необходимо создать токен.

Примечание

Данная документация не является полностью функциональным интерфейсом и представляет собой дизайн будущего API. В настоящее время вы можете использовать только методы из групп Каталог и Уведомления. Если вы хотите поделиться обратной связью, отправьте нам письмо по адресу techdoc@xsolla.com.
Скачать описание OpenAPI
index.json
index.yaml
Языки
Серверы
https://store.xsolla.com/api/
Mock server
https://xsolla.redocly.app/_mock/ru/api/digital-distribution-hub/

Корзина

Операции

Обновление предмета из текущей корзины

Запрос

Обновляет существующий или создает новый предмет в корзине.

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

ID проекта.

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

Артикул предмета.

Пример: booster_mega_1
Телоapplication/json
currencystring(Cart-Payment_settings_currency)

Предпочтительная валюта платежа. Используется трехбуквенное обозначение валюты согласно стандарту ISO 4217.

quantitynumber

Количество этого предмета в заказе.

По умолчанию 123
curl -i -X PUT \
  -u <username>:<password> \
  https://store.xsolla.com/api/v2/project/44056/cart/item/booster_mega_1 \
  -H 'Content-Type: application/json' \
  -d '{
    "currency": "string",
    "quantity": 123
  }'

Ответы

Корзина успешно обновлена.

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

Получение корзины по идентификатору корзины

Запрос

Возвращает корзину пользователя по идентификатору корзины.

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

ID проекта.

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

ID корзины.

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

Валюта, в которой отображаются цены (по умолчанию — USD). Используется трехбуквенное обозначение валюты согласно стандарту ISO 4217.

По умолчанию "USD"
localestring

Язык ответа. Используется двухбуквенное обозначение языка согласно стандарту ISO 639-1.

По умолчанию "en"
curl -i -X GET \
  'https://store.xsolla.com/api/v2/project/44056/cart/custom_id?currency=USD&locale=en' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Ответы

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

Телоapplication/json
cart_idstring

ID корзины.

Пример: "cart_id"
is_freeboolean

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

itemsArray of objects(Cart_inline_response_200_items)
Пример: [{"attributes":[],"description":"Take it, take it all! All of Xsollas riches in one Mega Booster.","groups":[{"external_id":"powerups","name":"Power Ups"}],"image_url":"https://cdn.xsolla.net/img/misc/images/e9f2f4a634bc96ea03b5d5ceadd7c55f.png","inventory_options":{"consumable":{"usages_count":1}},"is_free":false,"name":"Xsolla Booster Mega","price":{"amount":"50.0000000000000000","amount_without_discount":"100.0000000000000000","currency":"USD"},"quantity":123,"sku":"booster_mega_1","type":"virtual_good","virtual_item_type":"consumable","virtual_prices":[]}]
items[].​attributesArray of objects(Cart_client-attributes)

Список атрибутов и их значений, соответствующих предмету. Может использоваться для фильтрации каталога.

По умолчанию []
Пример: {"value":{"external_id":"genre","name":"Жанр","values":[{"external_id":"genre_e3364991f92e751689a68b96598a5a5a84010b85","value":"Casual"},{"external_id":"genre_eba07bfd0f982940773cba3744d97264dd58acd7","value":"Strategy"},{"external_id":"genre_b8d0c6d8f0524c2b2d79ebb93aa3cd0e8b5199a8","value":"Mobile"}]}}
items[].​attributes[].​external_idstring(Cart_admin-attribute-external_id)[ 1 .. 255 ] characters^[a-zA-Z0-9-_]+$

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

Пример: "attribute_1"
items[].​attributes[].​namestring

Название атрибута.

Пример: "Genre"
items[].​attributes[].​valuesArray of objects
items[].​attributes[].​values[].​external_idstring(Cart_value-external_id)[ 1 .. 255 ] characters^[-_.\d\w]+$

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

Пример: "attribute_value"
items[].​attributes[].​values[].​valuestring

Значение атрибута.

Пример: "Strategy"
items[].​descriptionstring
items[].​groupsArray of objects(Cart_inline_response_200_groups)
items[].​groups[].​external_idstring
items[].​groups[].​namestring
items[].​image_urlstring
items[].​is_freeboolean
items[].​namestring or null
items[].​quantityinteger
items[].​skustring
items[].​typestring
priceobject or null(Cart_inline_response_200_price)

Стоимость корзины.

Пример: "{\"amount\":\"6150.0000000000000000\",\"amount_without_discount\":\"6150.0000000000000000\",\"currency\":\"USD\"}"
price.​amountstring
По умолчанию "50.0000000000000000"
price.​amount_without_discountstring
По умолчанию "100.0000000000000000"
price.​currencystring
По умолчанию "USD"
Ответ
application/json
{
  "cart_id": "cart_id",
  "is_free": false,
  "items": [
    { … }
  ],
  "price": {
    "amount": "6150.0000000000000000",
    "amount_without_discount": "6150.0000000000000000",
    "currency": "USD"
  }
}

Удаление всех предметов из корзины по ID корзины

Запрос

Удаляет все предметы из корзины.

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

ID проекта.

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

ID корзины.

Пример: custom_id
curl -i -X PUT \
  https://store.xsolla.com/api/v2/project/44056/cart/custom_id/clear \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Ответы

Корзина успешно очищена.

Игровые ключи

Операции

Виртуальные предметы и валюта

Операции

Бандлы

Операции

Токен пользователя

Операции

Уведомления

Операции

Заказ

Операции