コンテンツへスキップ
/
カートIDでカートにアイテムを入れる

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プロパティに渡します。

操作

管理者

操作

カタログ

操作

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

操作

カート（サーバー側）

操作

カートにアイテムを入れるServer-side

リクエスト

現在のカートにアイテムを入れます。カートにすでに同じSKUのアイテムがある場合、既存のアイテムは渡された値で置き換えられます。

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

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

例: 44056
クエリ
localestring

応答言語。ISO 639-1に基づく小文字の2文字言語コード。

デフォルト "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に従った2文字の大文字の国名コード。エクソーラがサポートする国の詳細情報については、ドキュメントを確認してください。
例：country=US

例: "US"
currencystring= 3 characters

カートに表示されるアイテム価格の通貨。ISO4217規格詳細については、ドキュメントを参照してください。エクソーラでサポートされている通貨。

例: "USD"
itemsArray of objectsnon-empty必須
items[].​quantitynumber>= 1必須

アイテムの数量。

例: 2
items[].​skustringnon-empty必須

一意のアイテムID。SKUには、小文字と大文字のラテン英数字、ピリオド、ダッシュ、およびアンダースコアのみが含まれます。

例: "t-shirt"
curl -i -X PUT \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/ja/api/shop-builder/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

リクエスト

カートIDによるカートにアイテムを入れます。カートにすでに同じSKUのアイテムがある場合、既存のアイテムは渡された値で置き換えられます。

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

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

例: 44056
cart_idstring必須

カートID。

例: custom_id
クエリ
localestring

応答言語。ISO 639-1に基づく小文字の2文字言語コード。

デフォルト "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に従った2文字の大文字の国名コード。エクソーラがサポートする国の詳細情報については、ドキュメントを確認してください。
例：country=US

例: "US"
currencystring= 3 characters

カートに表示されるアイテム価格の通貨。ISO4217規格詳細については、ドキュメントを参照してください。エクソーラでサポートされている通貨。

例: "USD"
itemsArray of objectsnon-empty必須
items[].​quantitynumber>= 1必須

アイテムの数量。

例: 2
items[].​skustringnon-empty必須

一意のアイテムID。SKUには、小文字と大文字のラテン英数字、ピリオド、ダッシュ、およびアンダースコアのみが含まれます。

例: "t-shirt"
curl -i -X PUT \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/ja/api/shop-builder/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": [
    { … }
  ]
}

決済（クライアント側）

操作

決済（サーバー側）

操作

注文

操作

無料アイテム

操作

ウェブフック

操作

先行予約

操作

マーチャント

操作

カタログ

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

操作

共通地域

操作

カタログ

操作

資格

操作

管理者

操作

通常

操作

クーポン

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

操作

プロモーションコード

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

操作

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

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

操作

ディスカウント

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

操作

ボーナス

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

操作

管理者

操作

カタログ

操作

仮想決済

操作

管理

操作

管理者

操作

クライアント

操作

クランクライアント

操作

管理者

操作

クライアント

操作

管理者

操作

クライアント

操作

管理者

操作

クライアント

操作

管理者

操作