コンテンツへスキップ
/
プロモーションコードの特典を入手

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/ja/api/shop-builder/
https://store.xsolla.com/api/

管理者

操作

個人用カタログ

ユーザー属性に応じたルールを指定することができるAPIです。 ユーザーが具体的なルールの条件をすべて満たした場合、パーソナライズされたアイテムが表示されます。

パーソナライズされたプロモーションについては、プロモーションセクションを参照してください。

購入前に属性を渡すには、Xsolla Login APIを使うか、Pay Station APIを使ってトークンを生成する際にそれをuser.attributesプロパティに渡します。

操作

管理者

操作

カタログ

操作

カート（クライアント側）

操作

カート（サーバー側）

操作

決済（クライアント側）

操作

決済（サーバー側）

操作

注文

操作

無料アイテム

操作

ウェブフック

操作

先行予約

操作

マーチャント

操作

カタログ

このAPIは販売可能なアイテムや特定のアイテムを取得することができます。

操作

共通地域

操作

カタログ

操作

資格

操作

管理者

操作

通常

操作

クーポン

このAPIを使用すると、クーポンを管理できます。

操作

プロモーションコード

このAPI を使用すると、プロモーションコードを管理できます。

操作

指定したユーザーのプロモーションコード上限を取得するServer-sideAdmin

リクエスト

指定したユーザがプロモーションコードを使用できる残り回数を取得します。

User limit APIを使用すると、ユーザーがプロモーションコードを使用できる回数を制限することができます。ユーザー制限自体の設定は、管理セクションにアクセスしてください：

セキュリティ
basicAuth
パス
project_idinteger必須

プロジェクトID。このパラメータは、パブリッシャーアカウントのプロジェクト名の横にあります。

例: 44056
external_idinteger必須

プロモーションexternal ID。プロジェクト内での一意のプロモーション識別子。

例: coupon_44056_1
クエリ
user_external_idstring必須

ユーザーexternal ID

例: user_external_id=d342dad2-9d59-11e9-a384-42010aa8003f
curl -i -X GET \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/ja/api/shop-builder/v2/project/44056/admin/user/limit/promocode/external_id/coupon_44056_1?user_external_id=d342dad2-9d59-11e9-a384-42010aa8003f'

レスポンス

ユーザーのプロモーションコード制限を正常に受信しました。

ボディapplication/json
per_userobject
レスポンス
application/json
{
  "per_user": {
    "available": 9,
    "total": 10
  }
}

プロモーションコードの特典を入手Client-side

リクエスト

このコードによりプロモーションコードの特典を入手します。 ユーザーが多くのアイテムの中から1つをボーナスとして選択できるようにするために使用することができます。 通常のケースでは、プロモーションコードにボーナスとしてゲームが含まれている場合、DRMを選択します（type=unit）。

セキュリティ
XsollaLoginUserJWT
パス
project_idinteger必須

プロジェクトID。このパラメータは、パブリッシャーアカウントのプロジェクト名の横にあります。

例: 44056
promocode_codestring[ 1 .. 128 ] characters必須

大文字と小文字を区別する一意のコードです。文字と数字が含まれます。

例: SO6rew99j9
curl -i -X GET \
  https://xsolla.redocly.app/_mock/ja/api/shop-builder/v2/project/44056/promocode/code/SO6rew99j9/rewards \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

レスポンス

プロモーションコードリワードのリストは正常に受信されました。

ボディapplication/json
bonusArray of objects(Promotions_200-promo-code-bonus-reward)
discountobject or null(Promotions_200-coupon-discount-reward)

割引率。 カートの価格は、この割引率で計算された値で減少し、小数点以下2桁に四捨五入されます。

discounted_itemsArray of objects or null(Promotions_discounted_items)

プロモーションコードによる割引が適用されるアイテムリスト。

is_selectableboolean

trueの場合、ユーザーはプロモーションコードを引き換える前にボーナスを選択する必要があります。

レスポンス
application/json
{
  "bonus": [
    { … },
    { … }
  ],
  "discount": {
    "percent": "10.00"
  },
  "discounted_items": [
    { … }
  ],
  "is_selectable": true
}

プロモーションコードを引き換えるClient-side

リクエスト

プロモーションコードを引き換えます。 プロモーションコードを引き換えた後、ユーザーは無料でアイテムを入手したり、カートや特定のアイテムの価格を下げたりすることができます。

セキュリティ
AuthForCart
パス
project_idinteger必須

プロジェクトID。このパラメータは、パブリッシャーアカウントのプロジェクト名の横にあります。

例: 44056
ボディapplication/json
cartobject or null
coupon_codestring[ 1 .. 128 ] characters

プロモーションコードの一意のコード。文字と数字が含まれています。

デフォルト "SUMMER2021"
例: "SUMMER2021"
selected_unit_itemsobject(Promotions_selected_unit_items)

ユーザーが選択したリワード。 オブジェクトのキーはユニットのSKUで、値はユニット内の1つのアイテムのSKUです。

例: {"game_1":"game_1_steam","game_2":"game_2_playstation"}
curl -i -X POST \
  https://xsolla.redocly.app/_mock/ja/api/shop-builder/v2/project/44056/promocode/redeem \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "cart": {
      "id": "current"
    },
    "coupon_code": "SUMMER2021",
    "selected_unit_items": {
      "game_1": "game_1_steam",
      "game_2": "game_2_playstation"
    }
  }'

レスポンス

プロモーションコードは正常に引き換えされました。

ボディapplication/json
cart_idstring

カートID。

例: "cart_id"
is_freeboolean(value-is_free)

trueの場合で、アイテムは無料です。

デフォルト false
例: false
itemsArray of objects
例: [{"attributes":[],"can_be_bought":{"$ref":"../schemas/Can_be_bought.yaml"},"description":"Take it, take it all! All of Xsolla's riches in one Mega Booster.","groups":[{"external_id":"powerups","name":"Power Ups"}],"image_url":"https://cdn.xsolla.net/img/misc/images/e9f2f4a634bc96ea03b5d5ceadd7c55f.png","is_free":false,"limits":{"$ref":"../schemas/Catalog_item_limits.yaml"},"name":"Xsolla Booster Mega","periods":{"$ref":"../schemas/item-periods.yaml"},"price":{"amount":"50.0000000000000000","amount_without_discount":"100.0000000000000000","currency":"USD"},"promotions":{"$ref":"../schemas/Catalog_item_promotions.yaml"},"quantity":123,"sku":"com.xsolla.booster_mega_1","type":"virtual_good","virtual_item_type":"consumable","virtual_prices":[],"vp_rewards":{"$ref":"../schemas/reward-chain-client/client-item-value-point-reward.yaml"}}]
priceobject or null

カート価格。

例: {"amount":"6150.0000000000000000","amount_without_discount":"6150.0000000000000000","currency":"USD"}
rewardsobject(Promo_code_rewards)
レスポンス
application/json
{
  "cart_id": "cart_id",
  "is_free": false,
  "items": [
    { … },
    { … }
  ],
  "price": {
    "amount": "6150.0000000000000000",
    "amount_without_discount": "12300.0000000000000000",
    "currency": "USD"
  },
  "rewards": {
    "bonus": [ … ],
    "discount": { … },
    "discounted_items": [ … ],
    "is_selectable": false
  }
}

ユニークなカタログオファー

このAPIを使用すると、ユニークなカタログオファーを管理することができます。

操作

ディスカウント

このAPIを使用すると、割引キャンペーンを管理することができます。

操作

ボーナス

このAPIを使用すると、ボーナスプロモーションを管理できます。

操作

管理者

操作

カタログ

操作

仮想決済

操作

管理

操作

管理者

操作

クライアント

操作

クランクライアント

操作

管理者

操作

クライアント

操作

管理者

操作

クライアント

操作

管理者

操作

クライアント

操作

管理者

操作