` is the user token. The token identifies the user and provides access to personalized data. You can try this call using the following test token:\n```\neyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHAiOjE5NjIyMzQwNDgsImlzcyI6Imh0dHBzOi8vbG9naW4ueHNvbGxhLmNvbSIsImlhdCI6MTU2MjE0NzY0OCwidXNlcm5hbWUiOiJ4c29sbGEiLCJ4c29sbGFfbG9naW5fYWNjZXNzX2tleSI6IjA2SWF2ZHpDeEVHbm5aMTlpLUc5TmMxVWFfTWFZOXhTR3ZEVEY4OFE3RnMiLCJzdWIiOiJkMzQyZGFkMi05ZDU5LTExZTktYTM4NC00MjAxMGFhODAwM2YiLCJlbWFpbCI6InN1cHBvcnRAeHNvbGxhLmNvbSIsInR5cGUiOiJ4c29sbGFfbG9naW4iLCJ4c29sbGFfbG9naW5fcHJvamVjdF9pZCI6ImU2ZGZhYWM2LTc4YTgtMTFlOS05MjQ0LTQyMDEwYWE4MDAwNCIsInB1Ymxpc2hlcl9pZCI6MTU5MjR9.GCrW42OguZbLZTaoixCZgAeNLGH2xCeJHxl8u8Xn2aI\n```\nAlternatively, you can use a [token for opening the payment UI](/ja/api/pay-station/token/create-token).\n\n2. **Simplified mode without Authorization header.** This mode is used only for unauthorized users and can be applied only for [game key sales](/ja/doc/buy-button/how-to/set-up-authentication/#guides_buy_button_selling_items_not_authenticated_users). Instead of a token, the request must include the following headers:\n - `x-unauthorized-id` with a request ID\n - `x-user` with the user's email address encoded in Base64\n\n## Useful links\n\n- [API calls by interaction model](https://developers.xsolla.com/ja/api/catalog/)\n- [Endpoint types](https://developers.xsolla.com/ja/api/catalog/)\n- [Errors handling](https://developers.xsolla.com/ja/api/catalog/)\n- [API keys](https://developers.xsolla.com/ja/api/catalog/)\n\n# Core entity structure\n\nItems of all types (virtual items, bundles, virtual currency, and keys) use a similar data structure. Understanding the basic structure simplifies working with the API and helps you navigate the documentation more easily.\n\nNote
Some calls may include additional fields but they don't change the basic structure.
\n\n**Identification**\n\n- `merchant_id` — company ID in [Publisher Account](https://publisher.xsolla.com/)\n- `project_id` — project ID in Publisher Account\n- `sku` — item SKU, unique within the project\n\n**Store display**\n\n- `name` — item name\n- `description` — item description\n- `image_url` — image URL\n- `is_enabled` — item availability\n- `is_show_in_store` — whether the item is displayed in the catalog\n\nFor more information about managing item availability in the catalog, see the [documentation](/ja/items-catalog/catalog-features/items-availability/).\n\n**Organization**\n\n- `type` — item type, for example, a virtual item (`virtual_item`) or bundle (`bundle`)\n- `groups` — groups the item belongs to\n- `order` — display order in the catalog\n\n**Sale conditions**\n\n- `prices` — prices in real or virtual currency\n- `limits` — purchase limits\n- `periods` — availability periods\n- `regions` — regional restrictions\n\n**Example of core entity structure:**\n\n```json\n{\n \"attributes\": [],\n \"bundle_type\": \"virtual_currency_package\",\n \"content\": [\n {\n \"description\": {\n \"en\": \"Main in-game currency\"\n },\n \"image_url\": \"https://.../image.png\",\n \"name\": {\n \"en\": \"Crystals\",\n \"de\": \"Kristalle\"\n },\n \"quantity\": 500,\n \"sku\": \"com.xsolla.crystal_2\",\n \"type\": \"virtual_currency\"\n }\n ],\n \"description\": {\n \"en\": \"Crystals x500\"\n },\n \"groups\": [],\n \"image_url\": \"https://.../image.png\",\n \"is_enabled\": true,\n \"is_free\": false,\n \"is_show_in_store\": true,\n \"limits\": {\n \"per_item\": null,\n \"per_user\": null,\n \"recurrent_schedule\": null\n },\n \"long_description\": null,\n \"media_list\": [],\n \"name\": {\n \"en\": \"Medium crystal pack\"\n },\n \"order\": 1,\n \"periods\": [\n {\n \"date_from\": null,\n \"date_until\": \"2020-08-11T20:00:00+03:00\"\n }\n ],\n \"prices\": [\n {\n \"amount\": 20,\n \"country_iso\": \"US\",\n \"currency\": \"USD\",\n \"is_default\": true,\n \"is_enabled\": true\n }\n ],\n \"regions\": [],\n \"sku\": \"com.xsolla.crystal_pack_2\",\n \"type\": \"bundle\",\n \"vc_prices\": []\n}\n```\n\n# Basic purchase flow\n\nThe Xsolla API allows you to implement in-game store logic, including retrieving the item catalog, managing the cart, creating orders, and tracking their status. Depending on the integration scenario, API calls are divided into **Admin** and **Catalog** subsections, which use different [authentication schemes](/ja/api/catalog/section/authentication).\n\nThe following example shows a basic flow for setting up and operating a store, from item creation to purchase.\n\n## Create items and groups (Admin)\n\nCreate an item catalog for your store, such as virtual items, bundles, or virtual currency.\n\nExample API calls:\n- [Create virtual item](/ja/api/catalog/virtual-items-currency-admin/admin-create-virtual-item)\n- [Create bundle](/ja/api/catalog/bundles-admin/admin-create-bundle)\n- [Create virtual currency](/ja/api/catalog/virtual-items-currency-admin/admin-create-virtual-currency)\n\n## Set up promotions, chains, and limits (Admin)\n\nConfigure user acquisition and monetization tools, such as discounts, bonuses, daily rewards, or offer chains.\n\nExample API calls:\n- [Create bonus promotion](/ja/api/liveops/promotions-bonuses/create-bonus-promotion)\n- [Create daily reward](/ja/api/liveops/daily-chain-admin/admin-create-daily-chain)\n- [Create unique catalog offer promotion](/ja/api/liveops/promotions-unique-catalog-offers/admin-create-unique-catalog-offer)\n\n## Get item information (Client)\n\nConfigure item display in your application.\n\n\n
Notice\n Do not use API calls from the Admin subsection to build a user catalog. These API calls have
rate limits and aren't intended for user traffic.\n
\n\nExample API calls:\n- [Get virtual items list](/ja/api/catalog/virtual-items-currency-catalog/get-virtual-items)\n- [Get item group list](/ja/api/catalog/virtual-items-currency-catalog/get-item-groups)\n- [Get list of bundles](/ja/api/catalog/bundles-catalog/get-bundle-list)\n- [Get sellable items list](/ja/api/catalog/common-catalog/get-sellable-items)\n\n\n Note
\n By default, catalog API calls return items that are currently available in the store at the time of the request. To retrieve items that are not yet available or are no longer available, include the parameter \"show_inactive_time_limited_items\": 1 in the catalog request.\n
\n\n## Sell items\n\nYou can sell items using the following methods:\n- Fast purchase — sell one SKU multiple times.\n- Cart purchase — the user adds items to the cart, removes items, and updates quantities within a single order.\n\nIf an item is purchased using virtual currency instead of real money, use the [Create order with specified item purchased by virtual currency](/ja/api/catalog/virtual-payment/create-order-with-item-for-virtual-currency) API call. The payment UI is not required, as the charge is processed when the API call is executed.\n\nFor free item purchase, use the [Create order with specified free item](/ja/api/catalog/free-item/create-free-order-with-item) API call or the [Create order with free cart](/ja/api/catalog/free-item/create-free-order) API call. The payment UI is not required — the order is immediately set to the done status.\n\n### Fast purchase\n\nUse the client-side API call to [create an order with a specified item](/ja/api/catalog/payment-client-side/create-order-with-item). The call returns a token used to open the payment UI.\n\n\n Note
\n Discount information is available to the user only in the payment UI. Promo codes are not supported.\n
\n\n### Cart purchase\n\nCart setup and purchase can be performed on the client or on the server side.\n\n**Set up and purchase a cart on the client**\n\nImplement the logic of adding and removing items by yourself. Before calling the API for setting up a cart, you will not have information about which promotions will be applied to the purchase. This means that the total cost and details of the added bonus items will not be known.\n\nImplement the following cart logic:\n1. After the player has filled a cart, use the [Fill cart with items](/ja/api/shop-builder/operation/cart-fill/) API call. The call returns the current information about the selected items (prices before and after discounts, bonus items).\n2. Update the cart contents based on user actions:\n - To add an item or change item quantity, use the [Update cart item by cart ID](/ja/api/shop-builder/operation/put-item-by-cart-id/) API call.\n - To remove an item, use the [Delete cart item by cart ID](/ja/api/shop-builder/operation/delete-item-by-cart-id/) API call.\n\n\n Note
\n To get the current status of the cart, use the Get current user's cart API call.\n
\n\n3. Use the [Create order with all items from current cart](/ja/api/shop-builder/operation/create-order/) API call. The call returns the order ID and payment token. The newly created order is set to new status by default.\n\n**Set up and purchase a cart on the server**\n\nThis setup option may take longer for setting the cart up, since each change to the cart must be accompanied by API calls.\n\nImplement the following cart logic:\n1. After the player has filled a cart, use the [Fill cart with items](/ja/api/catalog/cart-server-side) API call. The call returns current information about the selected items (prices before and after discounts, bonus items).\n2. Use the [Create order with all items from current cart](/ja/api/shop-builder/operation/create-order/) API call. The call returns the order ID and payment token. The newly created order is set to new status by default.\n\n## Open payment UI\n\nUse the returned token to open the payment UI in a new window. Other ways to open the payment UI are described in the [documentation](/ja/payment-ui-and-flow/payment-ui/how-to-open-payment-ui/#open_payment_ui).\n\n| Action | Endpoint |\n|:--------------------------------|:--------------------------------------------------------------------------|\n| Open in production environment. | https://secure.xsolla.com/paystation4/?token={token} |\n| Open in sandbox mode. | https://sandbox-secure.xsolla.com/paystation4/?token={token} |\n\n\n
Note\n Use sandbox mode during development and testing. Test purchases don't charge real accounts. You can use
test bank cards.\n\n After the first real payment is made, a strict sandbox payment policy takes effect. A payment in sandbox mode is available only to users specified in [Publisher Account > Company settings > Users](https://publisher.xsolla.com/0/settings/users).\n\n Buying virtual currency and items for real currency is possible only after signing a license agreement with Xsolla. To do this, in [Publisher Account](https://publisher.xsolla.com/), go to **Agreements & Taxes > Agreements**, complete the agreement form, and wait for confirmation. It may take up to 3 business days to review the agreement.\n
注意
このメソッドはページ分割されたアイテムリストを返します。1 回のレスポンスで返されるアイテム数の上限とデフォルト値は50件です。それ以上のアイテムを取得する場合は、`limit`および `offset` パラメータを使用して追加のページを取得してください。例：`limit = 25`、`offset = 100`を指定した場合、全体リストの 101 件目から始まる 25 件が返されます。
",
"operationId": "admin-get-daily-chains",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/limit-query-param"
},
{
"$ref": "#/components/parameters/offset-query-param"
},
{
"$ref": "#/components/parameters/enabled-query-param"
},
{
"$ref": "#/components/parameters/is_expired-daily-chain-query-param"
},
{
"$ref": "#/components/parameters/type-daily-chain-query-param"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/200-admin-get-list-daily-chains"
},
"401": {
"$ref": "#/components/responses/401-invalid-basic-auth"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "デイリー報酬のリストを取得する",
"tags": [
"daily-chain-admin"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
},
"post": {
"description": "デイリー報酬を作成します。",
"operationId": "admin-create-daily-chain",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
}
],
"requestBody": {
"$ref": "#/components/requestBodies/create-daily-chain"
},
"responses": {
"201": {
"$ref": "#/components/responses/201-admin-create-daily-chain"
},
"401": {
"$ref": "#/components/responses/401-invalid-basic-auth"
},
"422": {
"$ref": "#/components/responses/422-admin-create-error-list"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "デイリー報酬の作成",
"tags": [
"daily-chain-admin"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
}
},
"/v2/project/{project_id}/admin/daily_chain/id/{daily_chain_id}": {
"delete": {
"description": "特定のデイリー報酬を削除します。",
"operationId": "admin-delete-daily-chain",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/daily_chain_id-path-param"
}
],
"responses": {
"204": {
"content": {},
"description": "デイリー報酬が正常に削除されました。"
},
"401": {
"$ref": "#/components/responses/401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/404-daily-chain-not-found"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "デイリー報酬の削除",
"tags": [
"daily-chain-admin"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
},
"get": {
"description": "管理用の特定のデイリー報酬を取得します。",
"operationId": "admin-get-daily-chain",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/daily_chain_id-path-param"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/200-admin-get-daily-chain"
},
"401": {
"$ref": "#/components/responses/401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/404-daily-chain-not-found"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "デイリー報酬を取得する",
"tags": [
"daily-chain-admin"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
},
"put": {
"description": "特定のデイリー報酬を更新します。",
"operationId": "admin-update-daily-chain",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/daily_chain_id-path-param"
}
],
"requestBody": {
"$ref": "#/components/requestBodies/update-daily-chain"
},
"responses": {
"204": {
"content": {},
"description": "デイリー報酬が正常に更新されました。"
},
"401": {
"$ref": "#/components/responses/401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/404-daily-chain-not-found"
},
"422": {
"$ref": "#/components/responses/422-admin-update-error-list"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "デイリー報酬を更新する",
"tags": [
"daily-chain-admin"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
}
},
"/v2/project/{project_id}/admin/daily_chain/id/{daily_chain_id}/reset": {
"post": {
"description": "デイリー報酬における全ユーザーの進行状況をリセットします。`rolling`タイプのデイリー報酬にのみ適用されます。",
"operationId": "admin-reset-daily-chain",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/daily_chain_id-path-param"
}
],
"responses": {
"204": {
"content": {},
"description": "デイリー報酬はリセットされました。"
},
"401": {
"$ref": "#/components/responses/401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/404-daily-chain-not-found"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "デイリー報酬をリセット",
"tags": [
"daily-chain-admin"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
}
},
"/v2/project/{project_id}/admin/daily_chain/id/{daily_chain_id}/toggle": {
"put": {
"description": "デイリー報酬を有効/無効にします。",
"operationId": "admin-toggle-daily-chain",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/daily_chain_id-path-param"
}
],
"responses": {
"204": {
"content": {},
"description": "デイリー報酬は有効化または無効化されました。"
},
"401": {
"$ref": "#/components/responses/401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/404-daily-chain-not-found"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "デイリー報酬のトグルを切り替える",
"tags": [
"daily-chain-admin"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
}
},
"/v2/project/{project_id}/admin/items/upsell": {
"get": {
"description": "プロジェクト内のアップセルに関する情報を取得します：アップセルが有効かどうか、アップセルのタイプ、アップセルの一部であるアイテムのSKUリスト。",
"operationId": "get-upsell-configurations-for-project-admin",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"upsell": {
"summary": "プロジェクトにはアップセルがあります",
"value": [
{
"is_enabled": true,
"items": [
{
"item_id": 1,
"name": {
"de": "Name des Artikels",
"en": "Item's name"
},
"sku": "com.xsolla.booster_mega_1",
"type": "virtual_good"
},
{
"bundle_type": "standard",
"item_id": 2,
"name": {
"de": "Name des Artikels",
"en": "Item's name"
},
"sku": "com.xsolla.booster_mega_2",
"type": "bundle"
},
{
"item_id": 3,
"name": {
"en": "Mega game"
},
"sku": "com.xsolla.mega_game_1",
"type": "unit",
"unit_items": [
{
"drm_name": "Steam",
"drm_sku": "steam_key_1",
"item_id": 4,
"name": {
"en": "Mega game steam"
},
"sku": "com.xsolla.mega_game_steam_1"
}
],
"unit_type": "game"
}
],
"type": "fixed_list"
}
]
}
},
"schema": {
"items": {
"properties": {
"is_enabled": {
"description": "プロジェクトのアップセルが有効かどうか。",
"example": true,
"type": "boolean"
},
"items": {
"description": "プロジェクトのアップセルの一部であるアイテムSKUのリスト。",
"example": [
{
"item_id": 1,
"name": {
"de": "Name des Artikels",
"en": "Item's name"
},
"sku": "com.xsolla.booster_mega_1",
"type": "virtual_good"
}
],
"items": {
"properties": {
"bundle_type": {
"$ref": "#/components/schemas/bundle_type"
},
"item_id": {
"$ref": "#/components/schemas/item_id"
},
"name": {
"$ref": "#/components/schemas/name-localization-object"
},
"sku": {
"$ref": "#/components/schemas/sku"
},
"type": {
"$ref": "#/components/schemas/item_type"
},
"unit_items": {
"description": "異なるDRMに対応したゲームキー。",
"items": {
"description": "ゲームキーアイテム。特定のプラットフォーム（steam、gogなど）のゲームを表します。",
"properties": {
"drm_name": {
"$ref": "#/components/schemas/drm_name"
},
"drm_sku": {
"$ref": "#/components/schemas/drm_sku"
},
"item_id": {
"$ref": "#/components/schemas/item_id"
},
"name": {
"$ref": "#/components/schemas/name-localization-object"
},
"sku": {
"$ref": "#/components/schemas/sku"
},
"type": {
"$ref": "#/components/schemas/item_type"
}
},
"type": "object"
},
"type": "array"
},
"unit_type": {
"$ref": "#/components/schemas/unit_type"
}
},
"type": "object"
},
"type": "array"
},
"type": {
"description": "アップセルのタイプ。",
"enum": [
"fixed_list",
"most_sellable",
"only_promotions"
],
"example": "fixed_list",
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
}
},
"description": "プロジェクトでアップセルに使用される構成に関する詳細とアイテムのリスト。"
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-client-auth"
}
},
"security": [
{
"XsollaLoginUserJWT": []
}
],
"summary": "プロジェクトのアップセル情報を入手",
"tags": [
"upsell-admin"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
},
"post": {
"description": "Creates an upsell for a project.
\n Notice
\n This API call uses a user JWT for authorization.
\n Include the token in the Authorization header in the following format: Bearer <user_JWT>. For more information about user JWT, see the Security block for this call.\n
",
"operationId": "post-upsell",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
}
],
"requestBody": {
"$ref": "#/components/requestBodies/create-upsell"
},
"responses": {
"202": {
"description": "アップセルはプロジェクト用に作成されました。"
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-client-auth"
},
"404": {
"$ref": "#/components/responses/Upsell-404-item-not-found"
},
"422": {
"$ref": "#/components/responses/Upsell-422-invalid-request"
}
},
"security": [
{
"XsollaLoginUserJWT": []
}
],
"summary": "アップセルを作成",
"tags": [
"upsell-admin"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
},
"put": {
"description": "Update an upsell for a project.
\n Notice
\n This API call uses a user JWT for authorization.
\n Include the token in the Authorization header in the following format: Bearer <user_JWT>. For more information about user JWT, see the Security block for this call.\n
",
"operationId": "put-upsell",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
}
],
"requestBody": {
"$ref": "#/components/requestBodies/update-upsell"
},
"responses": {
"202": {
"description": "プロジェクトのアップセルが更新されました。"
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-client-auth"
},
"404": {
"$ref": "#/components/responses/Upsell-404-item-not-found"
},
"422": {
"$ref": "#/components/responses/Upsell-422-invalid-request"
}
},
"security": [
{
"XsollaLoginUserJWT": []
}
],
"summary": "アップセルを更新",
"tags": [
"upsell-admin"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
}
},
"/v2/project/{project_id}/admin/items/upsell/{toggle}": {
"put": {
"description": "Changes an upsell’s status in a project to be either active or inactive.
\n Notice
\n This API call uses a user JWT for authorization.
\n Include the token in the Authorization header in the following format: Bearer <user_JWT>. For more information about user JWT, see the Security block for this call.\n
",
"operationId": "put-upsell-toggle-active-inactive",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"description": "アクティベーションステータス。",
"in": "path",
"name": "toggle",
"required": true,
"schema": {
"example": "activate",
"type": "string"
}
}
],
"responses": {
"202": {
"description": "プロジェクトのアップセルがアクティブ化/非アクティブ化にしました。"
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-client-auth"
}
},
"security": [
{
"XsollaLoginUserJWT": []
}
],
"summary": "プロジェクトのアップセルをアクティブ化/非アクティブ化",
"tags": [
"upsell-admin"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
}
},
"/v2/project/{project_id}/admin/items/value_points": {
"get": {
"description": "管理用のプロジェクト内のバリューポイントのリストを取得します。",
"operationId": "admin-get-value-points-list",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/limit-query-param"
},
{
"$ref": "#/components/parameters/offset-query-param"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/200-admin-get-value-points"
},
"401": {
"$ref": "#/components/responses/401-invalid-basic-auth"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "バリューポイントのリストを取得する",
"tags": [
"reward-chain-value-points-admin"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
},
"post": {
"description": "バリューポイントを作成します。",
"operationId": "admin-create-value-points",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
}
],
"requestBody": {
"$ref": "#/components/requestBodies/create-value-point"
},
"responses": {
"201": {
"$ref": "#/components/responses/201-admin-create-value-point"
},
"401": {
"$ref": "#/components/responses/401-invalid-basic-auth"
},
"422": {
"$ref": "#/components/responses/422-admin-create-update-rc-vp-invalid-request"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "バリューポイントを作成する",
"tags": [
"reward-chain-value-points-admin"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
}
},
"/v2/project/{project_id}/admin/items/value_points/sku/{item_sku}": {
"delete": {
"description": "SKUによって識別されるバリューポイントを削除します。",
"operationId": "admin-delete-value-point",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/item_sku-path-param"
}
],
"responses": {
"204": {
"content": {},
"description": "バリューポイントは正常に削除されました。"
},
"401": {
"$ref": "#/components/responses/401-invalid-basic-auth"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "バリューポイントを削除する",
"tags": [
"reward-chain-value-points-admin"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
},
"get": {
"description": "管理用のプロジェクト内のSKUによってバリューポイントを取得します。",
"operationId": "admin-get-value-point",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/item_sku-path-param"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/200-admin-get-value-point"
},
"401": {
"$ref": "#/components/responses/401-invalid-basic-auth"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "バリューポイントを取得する",
"tags": [
"reward-chain-value-points-admin"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
},
"put": {
"description": "SKUで特定されるバリューポイントを更新します。",
"operationId": "admin-update-value-point",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/item_sku-path-param"
}
],
"requestBody": {
"$ref": "#/components/requestBodies/create-value-point"
},
"responses": {
"204": {
"content": {},
"description": "バリューポイントは正常に更新されました。"
},
"401": {
"$ref": "#/components/responses/401-invalid-basic-auth"
},
"422": {
"$ref": "#/components/responses/422-admin-create-update-rc-vp-invalid-request"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "バリューポイントを更新する",
"tags": [
"reward-chain-value-points-admin"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
}
},
"/v2/project/{project_id}/admin/items/{value_point_sku}/value_points/rewards": {
"delete": {
"description": "すべてのアイテムからバリューポイント報酬を削除します。",
"operationId": "admin-delete-items-value-point-reward",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/value_point_sku-path-param"
}
],
"responses": {
"204": {
"content": {},
"description": "アイテムのバリューポイント報酬は正常に削除されました。"
},
"401": {
"$ref": "#/components/responses/401-invalid-basic-auth"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "アイテムからバリューポイントを削除する",
"tags": [
"reward-chain-value-points-admin"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
},
"get": {
"description": "管理用に、プロジェクト内のバリューポイントを持つすべてのアイテムリストを取得します。",
"operationId": "admin-get-items-value-point-reward",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/value_point_sku-path-param"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/200-admin-get-list-value-point-rewards"
},
"401": {
"$ref": "#/components/responses/401-invalid-basic-auth"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "バリューポイントを持つアイテムのリストを取得する",
"tags": [
"reward-chain-value-points-admin"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
},
"patch": {
"description": "SKUに基づいて、1つまたは複数のアイテムのバリューポイント数を部分的に更新します。\n\nバリューポイント更新の原則：\n * アイテムがまだバリューポイントを持っていない場合、`amount`フィールドにゼロ以外の値を送信すると、バリューポイントが作成されます。\n * アイテムがすでにバリューポイントを持っている場合、`amount`フィールドに 0 以外の値を送信すると、バリューポイントが更新されます。\n * `amount`が0に設定された場合、そのアイテムの既存のバリューポイントは削除されます。\n\n `PUT`メソッド（[アイテムにバリューポイントを設定する](https://developers.Xsolla.com/api/shop-builder/operation/admin-set-items-value-point-reward/)）とは異なり、この`PATCH`メソッドは、プロジェクト内のアイテムの既存のバリューポイントをすべて上書きするのではなく、指定されたアイテムのみを更新します。\n\n1 つのリクエストで最大100アイテムまで更新できます。重複するアイテム SKU を同じリクエストに含めることはできません。",
"operationId": "admin-patch-items-value-point-reward",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/value_point_sku-path-param"
}
],
"requestBody": {
"$ref": "#/components/requestBodies/set-item-value-point-reward-for-patch"
},
"responses": {
"204": {
"content": {},
"description": "アイテムのバリューポイント報酬が正常に更新されました。"
},
"401": {
"$ref": "#/components/responses/401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/sellable-item-by-sku_404"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "アイテムのバリューポイントを部分的に更新する",
"tags": [
"reward-chain-value-points-admin"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
},
"put": {
"description": "SKUによって1つまたは複数のアイテムにバリューポイントを割り当てます。ユーザーはこれらのアイテムを購入した後にバリューポイントを受け取ります。\n\nこのPUT要求は、プロジェクト内のアイテムの以前に設定されたすべてのバリューポイントを上書きすることに注意してください。\n\n意図しないバリューポイントの削除を避けるため、各PUTリクエストにすべてのアイテムとそれぞれのバリューポイントを含めてください。\n\n特定のアイテムのバリューポイントだけを更新し、他のアイテムのバリューポイントを保持したい場合は、GETリクエストを使って現在のバリューポイントセットを取得し、ご希望のアイテムのバリューポイントを修正し、修正したバリューポイントセットを特定のアイテムの更新されたバリューポイントと一緒に送り返す必要があります。",
"operationId": "admin-set-items-value-point-reward",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/value_point_sku-path-param"
}
],
"requestBody": {
"$ref": "#/components/requestBodies/set-item-value-point-reward"
},
"responses": {
"204": {
"content": {},
"description": "アイテムのバリューポイント報酬が正常に更新されました。"
},
"401": {
"$ref": "#/components/responses/401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/sellable-item-by-sku_404"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "アイテムのバリューポイントを設定する",
"tags": [
"reward-chain-value-points-admin"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
}
},
"/v2/project/{project_id}/admin/offer_chain": {
"get": {
"description": "管理用のオファーチェーンリストを取得します。\n注意
すべてのプロジェクトには、1つの応答で返されるアイテム数に制限があります。デフォルトおよび最大値は1応答あたり10アイテムです。より多くのデータを取得するには、ページネーションのためにlimitとoffsetクエリパラメータを使用してください。
",
"operationId": "admin-get-offer-chains",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/limit-query-param"
},
{
"$ref": "#/components/parameters/offset-query-param"
},
{
"$ref": "#/components/parameters/enabled-query-param"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/200-admin-get-list-offer-chains"
},
"401": {
"$ref": "#/components/responses/401-invalid-basic-auth"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "オファーチェーンのリストを取得する",
"tags": [
"offer-chain-admin"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
},
"post": {
"description": "オファーチェーンを作成します。",
"operationId": "admin-create-offer-chain",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
}
],
"requestBody": {
"$ref": "#/components/requestBodies/create-offer-chain"
},
"responses": {
"201": {
"$ref": "#/components/responses/201-admin-create-offer-chain"
},
"401": {
"$ref": "#/components/responses/401-invalid-basic-auth"
},
"422": {
"$ref": "#/components/responses/422-create-error-list"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "オファーチェーンを作成する",
"tags": [
"offer-chain-admin"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
}
},
"/v2/project/{project_id}/admin/offer_chain/id/{offer_chain_id}": {
"delete": {
"description": "特定のオファーチェーンを削除します。\n\n削除後：- ユーザーがすでに受け取ったすべての報酬は保持されます。
- 未完了のステップは利用不可になり、その報酬は取得できなくなります。
\n\nオファーチェーンの有効/無効切り替えるコールによるオファーチェーンの無効化とは異なり、削除は元に戻すことができず、ユーザーの進捗状況は保持されません。",
"operationId": "admin-delete-offer-chain",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/offer_chain_id-path-param"
}
],
"responses": {
"204": {
"content": {},
"description": "オファーチェーンは正常に削除されました。"
},
"401": {
"$ref": "#/components/responses/401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/404-offer-chain-not-found"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "オファーチェーンを削除する",
"tags": [
"offer-chain-admin"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
},
"get": {
"description": "管理用の特定のオファーチェーンを取得します。",
"operationId": "admin-get-offer-chain",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/offer_chain_id-path-param"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/200-admin-get-offer-chain"
},
"401": {
"$ref": "#/components/responses/401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/404-offer-chain-not-found"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "オファーチェーンを取得する",
"tags": [
"offer-chain-admin"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
},
"put": {
"description": "特定のオファーチェーンを更新するします。",
"operationId": "admin-update-offer-chain",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/offer_chain_id-path-param"
}
],
"requestBody": {
"$ref": "#/components/requestBodies/update-offer-chain"
},
"responses": {
"204": {
"content": {},
"description": "オファーチェーンは正常に更新されました。"
},
"401": {
"$ref": "#/components/responses/401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/404-offer-chain-not-found"
},
"422": {
"$ref": "#/components/responses/422-update-error-list"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "オファーチェーンを更新する",
"tags": [
"offer-chain-admin"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
}
},
"/v2/project/{project_id}/admin/offer_chain/id/{offer_chain_id}/toggle": {
"put": {
"description": "オファーチェーンを有効または無効にします。\n\nオファーチェーンが無効になると、ユーザーは一時的にアクセスできなくなりますが、進行状況は保持されます。\n\nオファーチェーンが再度有効になった後、ユーザーは中断したステップから再開できます。",
"operationId": "admin-toggle-offer-chain",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/offer_chain_id-path-param"
}
],
"responses": {
"204": {
"content": {},
"description": "オファーチェーンが無効化/有効化されました。"
},
"401": {
"$ref": "#/components/responses/401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/404-offer-chain-not-found"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "オファーチェーンの有効/無効切り替え",
"tags": [
"offer-chain-admin"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
}
},
"/v2/project/{project_id}/admin/promocode/{external_id}/activate": {
"put": {
"description": "プロモーションコードのプロモーションをアクティブ化にします。\n\n作成されたプロモーションコードのプロモーションは、デフォルトで無効になっています。\nアクティブ化されるまで、引き換えの準備ができません。\nこのエンドポイントを使用して、プロモーションコードのプロモーションを有効化またはアクティブ化します。",
"operationId": "activate-promo-code",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/external_id-promotion-path-param"
}
],
"responses": {
"204": {
"description": "プロモーションコードが正常にアクティブ化にされました。"
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/Promotions_404-admin-promocode"
},
"422": {
"$ref": "#/components/responses/Promotions_422-admin-promotion-error"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "プロモーションコードのプロモーションをアクティブ化",
"tags": [
"promotions-promo-codes"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
}
},
"/v2/project/{project_id}/admin/promocode/{external_id}/code": {
"get": {
"description": "プロモーションコードのプロモーション用のコードを取得します。",
"operationId": "get-promocode-codes",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/external_id-promotion-path-param"
},
{
"$ref": "#/components/parameters/limit-query-param"
},
{
"$ref": "#/components/parameters/offset-query-param"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/Promotions_200-promocode-code-list"
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/Promotions_404-admin-promocode"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "プロモーションコードのプロモーション用のコードを取得",
"tags": [
"promotions-promo-codes"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
},
"post": {
"description": "プロモーションコードのプロモーション用のコードを作成します。",
"operationId": "create-promo-code-code",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/external_id-promotion-path-param"
}
],
"requestBody": {
"$ref": "#/components/requestBodies/Promotions_create-coupon-promocode-code"
},
"responses": {
"201": {
"$ref": "#/components/responses/Promotions_201-coupon-promocode-code-created"
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/Promotions_404-admin-promocode"
},
"422": {
"$ref": "#/components/responses/Promotions_422-coupon-promocode-same-code-exists"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "プロモーションコードのプロモーション用のコードを作成",
"tags": [
"promotions-promo-codes"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
}
},
"/v2/project/{project_id}/admin/promocode/{external_id}/code/generate": {
"put": {
"description": "プロモーションコードのプロモーション用のコードを生成します。",
"operationId": "generate-promo-code-codes",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/external_id-promotion-path-param"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"properties": {
"count": {
"$ref": "#/components/schemas/Promotions_coupon-generate-count"
}
},
"required": [
"count"
],
"type": "object"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"count": 10
}
}
},
"schema": {
"properties": {
"count": {
"$ref": "#/components/schemas/Promotions_coupon-generate-count"
}
},
"type": "object"
}
}
},
"description": "コードが正常に生成されました。"
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/Promotions_404-admin-promocode"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "プロモーションコードのプロモーション用のコードを生成",
"tags": [
"promotions-promo-codes"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
}
},
"/v2/project/{project_id}/admin/promocode/{external_id}/deactivate": {
"put": {
"description": "プロモーションコードのプロモーションを非アクティブ化にします。\n\n作成されたプロモーションコードのプロモーションは、デフォルトで無効になっています。\nアクティブ化されるまで、引き換えの準備ができません。\nこのエンドポイントを使用して、プロモーションコードのプロモーションを無効化または非アクティブ化します。",
"operationId": "deactivate-promo-code",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/external_id-promotion-path-param"
}
],
"responses": {
"204": {
"description": "クーポンは正常に非アクティブ化されました。"
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/Promotions_404-admin-promocode"
},
"422": {
"$ref": "#/components/responses/Promotions_422-admin-promotion-error"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "プロモーションコードのプロモーションを非アクティブ化",
"tags": [
"promotions-promo-codes"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
}
},
"/v2/project/{project_id}/admin/promotion/{promotion_id}/activate": {
"put": {
"description": "プロモーションをアクティブ化にします。",
"operationId": "activate-promotion",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/promotion_id-path-param"
}
],
"responses": {
"204": {
"description": "プロモーションが正常にアクティブ化にされました。"
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-basic-auth"
},
"422": {
"$ref": "#/components/responses/Promotions_422-activate-deactivate-promotion"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "プロモーションをアクティブ化にする",
"tags": [
"promotions-common"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
}
},
"/v2/project/{project_id}/admin/promotion/{promotion_id}/deactivate": {
"put": {
"description": "プロモーションを停止にします。",
"operationId": "deactivate-promotion",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/promotion_id-path-param"
}
],
"responses": {
"204": {
"description": "プロモーションは正常に停止しました。"
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-basic-auth"
},
"422": {
"$ref": "#/components/responses/Promotions_422-activate-deactivate-promotion"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "プロモーションを停止",
"tags": [
"promotions-common"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
}
},
"/v2/project/{project_id}/admin/unique_catalog_offer/{external_id}/activate": {
"put": {
"description": "ユニークなカタログオファープロモーションをアクティブ化にします。\n作成されたユニークなカタログオファープロモーションは、デフォルトでは無効になっています。\nアクティブ化するまで引き換えることはできません。\nこのエンドポイントを使用して、クーポンプロモーションを有効化およびアクティブ化します。",
"operationId": "activate-unique-catalog-offer",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/external_id-promotion-path-param"
}
],
"responses": {
"204": {
"description": "ユニークなカタログオファーが正常にアクティブ化されました。"
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/Promotions_404-admin-coupon"
},
"422": {
"$ref": "#/components/responses/Promotions_422-admin-promotion-error"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "ユニークなカタログオファープロモーションをアクティブ化にする",
"tags": [
"promotions-unique-catalog-offers"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
}
},
"/v2/project/{project_id}/admin/unique_catalog_offer/{external_id}/code": {
"get": {
"description": "ユニークなカタログオファーコードを取得する",
"operationId": "get-unique-catalog-offer-codes",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/external_id-promotion-path-param"
},
{
"$ref": "#/components/parameters/limit-query-param"
},
{
"$ref": "#/components/parameters/offset-query-param"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/Promotions_200-unique-catalog-offer-code-list"
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/Promotions_404-admin-coupon"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "ユニークなカタログオファーコードを取得する",
"tags": [
"promotions-unique-catalog-offers"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
},
"post": {
"description": "ユニークなカタログオファーコードを作成します。",
"operationId": "create-unique-catalog-offer-code",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/external_id-promotion-path-param"
}
],
"requestBody": {
"$ref": "#/components/requestBodies/Promotions_create-coupon-promocode-code"
},
"responses": {
"201": {
"$ref": "#/components/responses/Promotions_201-coupon-promocode-code-created"
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/Promotions_404-admin-coupon"
},
"422": {
"$ref": "#/components/responses/Promotions_422-coupon-promocode-same-code-exists"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "ユニークなカタログオファーコードを作成する",
"tags": [
"promotions-unique-catalog-offers"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
}
},
"/v2/project/{project_id}/admin/unique_catalog_offer/{external_id}/code/generate": {
"put": {
"description": "ユニークなカタログオファーコードを生成します。",
"operationId": "generate-unique-catalog-offer-codes",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/external_id-promotion-path-param"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"properties": {
"count": {
"$ref": "#/components/schemas/Promotions_coupon-generate-count"
}
},
"required": [
"count"
],
"type": "object"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"count": 10
}
}
},
"schema": {
"properties": {
"count": {
"$ref": "#/components/schemas/Promotions_coupon-generate-count"
}
},
"type": "object"
}
}
},
"description": "コードが正常に生成されました。"
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/Promotions_404-admin-promocode"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "ユニークなカタログオファーコードを生成する",
"tags": [
"promotions-unique-catalog-offers"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
}
},
"/v2/project/{project_id}/admin/unique_catalog_offer/{external_id}/deactivate": {
"put": {
"description": "ユニークなカタログオファープロモーションを非アクティブ化にします。\n作成されたユニークなカタログオファープロモーションは、デフォルトでは無効になっています。\nアクティブ化するまで引き換えることはできません。\nこのエンドポイントを使用して、クーポンプロモーションを無効化および非アクティブ化します。",
"operationId": "deactivate-unique-catalog-offer",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/external_id-promotion-path-param"
}
],
"responses": {
"204": {
"description": "ユニークカタログオファーは正常に非アクティブ化されました。"
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/Promotions_404-admin-coupon"
},
"422": {
"$ref": "#/components/responses/Promotions_422-admin-promotion-error"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "ユニークカタログオファープロモーションを非アクティブ化する",
"tags": [
"promotions-unique-catalog-offers"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
}
},
"/v2/project/{project_id}/admin/user/attribute/rule": {
"get": {
"description": "ユーザー属性に適用されるすべてのルールを取得します。",
"operationId": "get-filter-rules",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/limit-query-param"
},
{
"$ref": "#/components/parameters/offset-query-param"
},
{
"$ref": "#/components/parameters/is_enabled-query-param"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"has_more": true,
"items": [
{
"attribute_conditions": [
{
"attribute": "race",
"can_be_missing": false,
"operator": "eq",
"type": "string",
"value": "ork"
}
],
"is_enabled": true,
"is_satisfied_for_unauth": false,
"items": [
{
"item_id": 1,
"name": "Ork Armor",
"sku": "com.xsolla.ork_armor_1",
"type": "virtual_good"
},
{
"bundle_type": "standard",
"item_id": 2,
"name": "Potion pack",
"sku": "com.xsolla.potion_pack_1",
"type": "bundle"
}
],
"name": "Ork race armor rule",
"rule_id": 1
}
],
"total_items_count": 20
}
}
},
"schema": {
"properties": {
"has_more": {
"description": "ルールのある別のページが存在する場合。",
"type": "boolean"
},
"items": {
"items": {
"$ref": "#/components/schemas/user-attribute_personalized-catalog"
},
"type": "array"
},
"total_items_count": {
"description": "ルールの合計数。",
"type": "number"
}
},
"type": "object"
}
}
},
"description": "ルールが正常に受信されました。"
},
"401": {
"$ref": "#/components/responses/Common_401-complex"
},
"403": {
"$ref": "#/components/responses/403-auth-header-not-sent"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "カタログフィルタルールのリストを取得",
"tags": [
"personalized-catalog"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
},
"post": {
"description": "ユーザー属性のルールを作成します。",
"operationId": "create-filter-rule",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
}
],
"requestBody": {
"$ref": "#/components/requestBodies/personalized-catalog_create-update-body"
},
"responses": {
"201": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"rule_id": 1
}
}
},
"schema": {
"properties": {
"rule_id": {
"description": "ルールID。",
"type": "number"
}
},
"type": "object"
}
}
},
"description": "ルールが正常に作成されました。"
},
"401": {
"$ref": "#/components/responses/Common_401-complex"
},
"422": {
"$ref": "#/components/responses/Common_422-body-validation"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "カタログフィルタルールを作成",
"tags": [
"personalized-catalog"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
}
},
"/v2/project/{project_id}/admin/user/attribute/rule/all": {
"get": {
"description": "クライアントサイドで検索するためのすべてのカタログルールのリストを取得します。\n注意
ルールID、名前、is_enabled
のみを返します。",
"operationId": "get-all-filter-rules",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"items": [
{
"is_enabled": true,
"is_satisfied_for_unauth": false,
"name": "Ork race armor rule",
"rule_id": 1
},
{
"is_enabled": false,
"is_satisfied_for_unauth": false,
"name": "Age",
"rule_id": 2
}
]
}
}
},
"schema": {
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/user-attribute_personalized-catalog_all"
},
"type": "array"
}
},
"type": "object"
}
}
},
"description": "ルールが正常に受信されました。"
},
"401": {
"$ref": "#/components/responses/Common_401-complex"
},
"403": {
"$ref": "#/components/responses/403-auth-header-not-sent"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "クライアントサイドで検索するためのすべてのカタログルールを取得します",
"tags": [
"personalized-catalog"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
}
},
"/v2/project/{project_id}/admin/user/attribute/rule/{rule_id}": {
"delete": {
"description": "特定のルールを削除します。",
"operationId": "delete-filter-rule-by-id",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/personalized-catalog-rule_id-path-param"
}
],
"responses": {
"204": {
"description": "削除に成功しました。"
},
"401": {
"$ref": "#/components/responses/Common_401-complex"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "カタログフィルタルールを削除",
"tags": [
"personalized-catalog"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
},
"get": {
"description": "ユーザー属性に適用される特定のルールを取得します。",
"operationId": "get-filter-rule-by-id",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/personalized-catalog-rule_id-path-param"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"attribute_conditions": [
{
"attribute": "race",
"can_be_missing": false,
"operator": "eq",
"type": "string",
"value": "ork"
}
],
"is_enabled": true,
"is_satisfied_for_unauth": true,
"items": [
{
"item_id": 1,
"name": "Ork Armor",
"sku": "com.xsolla.ork_armor_1"
}
],
"name": "Ork race armor rule",
"rule_id": 1
}
}
},
"schema": {
"$ref": "#/components/schemas/user-attribute_personalized-catalog"
}
}
},
"description": "ルールは正常に受信されました。"
},
"401": {
"$ref": "#/components/responses/Common_401-complex"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "カタログフィルタルールを取得",
"tags": [
"personalized-catalog"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
},
"patch": {
"description": "ユーザー属性に適用される特定のルールを更新します。指定されていないプロパティには、現在の値が使用されます。",
"operationId": "patch-filter-rule-by-id",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/personalized-catalog-rule_id-path-param"
}
],
"requestBody": {
"content": {
"application/json": {
"example": {
"is_enabled": false
},
"schema": {
"$ref": "#/components/schemas/user-attribute_personalized-catalog-body"
}
}
}
},
"responses": {
"204": {
"description": "更新に成功しました。"
},
"401": {
"$ref": "#/components/responses/Common_401-complex"
},
"422": {
"$ref": "#/components/responses/Common_422-body-validation"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "カタログフィルタルールを修正",
"tags": [
"personalized-catalog"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
},
"put": {
"description": "ユーザー属性に適用される特定のルールを更新します。指定されていないプロパティはデフォルト値が使用されます（プロパティが必須でない場合）。",
"operationId": "update-filter-rule-by-id",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/personalized-catalog-rule_id-path-param"
}
],
"requestBody": {
"$ref": "#/components/requestBodies/personalized-catalog_create-update-body"
},
"responses": {
"204": {
"description": "更新に成功しました。"
},
"401": {
"$ref": "#/components/responses/Common_401-complex"
},
"422": {
"$ref": "#/components/responses/Common_422-body-validation"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "カタログフィルタールールを更新",
"tags": [
"personalized-catalog"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
}
},
"/v2/project/{project_id}/admin/user/limit/coupon/external_id/{external_id}": {
"get": {
"description": "指定したユーザがクーポンを使用できる残り回数を取得します。\n\nUser limit APIを使用すると、ユーザーがクーポンを使用できる回数を制限することができます。ユーザー制限自体の設定は、管理セクションにアクセスしてください：\n* [クーポン](https://developers.xsolla.com/ja/api/shop-builder/tag/promotions-coupons/)",
"operationId": "get-coupon-user-limit",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/external_id-promotion-path-param"
},
{
"$ref": "#/components/parameters/user_external_id-query-param"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/200-admin-get-user-coupon-limits"
},
"401": {
"$ref": "#/components/responses/Common_401-invalid-basic-auth"
},
"404": {
"content": {
"application/json": {
"examples": {
"Coupon not found": {
"$ref": "#/components/examples/404-coupon-not-found"
},
"User not found": {
"$ref": "#/components/examples/404-user-not-found"
}
},
"schema": {
"properties": {
"errorCode": {
"type": "integer"
},
"errorMessage": {
"type": "string"
},
"statusCode": {
"type": "integer"
},
"transactionId": {
"type": "string"
}
},
"type": "object"
}
}
},
"description": "アイテムが見つかりません。"
},
"422": {
"content": {
"application/json": {
"examples": {
"Invalid user_external_id": {
"$ref": "#/components/examples/Promotions_422-invalid-coupon"
}
},
"schema": {
"properties": {
"errorCode": {
"type": "integer"
},
"errorMessage": {
"type": "string"
},
"errorMessageExtended": {
"type": "array"
},
"statusCode": {
"type": "integer"
},
"transactionId": {
"type": "string"
}
},
"type": "object"
}
}
},
"description": "無効なリクエストです。"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "指定したユーザーのクーポン上限を取得する",
"tags": [
"promotions-coupons"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
}
},
"/v2/project/{project_id}/admin/user/limit/promocode/external_id/{external_id}": {
"get": {
"description": "指定したユーザがプロモーションコードを使用できる残り回数を取得します。\n\nUser limit APIを使用すると、ユーザーがプロモーションコードを使用できる回数を制限することができます。ユーザー制限自体の設定は、管理セクションにアクセスしてください：\n* [プロモーションコード](https://developers.xsolla.com/ja/api/shop-builder/tag/promotions-promo-codes/)",
"operationId": "get-promo-code-user-limit",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/external_id-promotion-path-param"
},
{
"$ref": "#/components/parameters/user_external_id-query-param"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/200-admin-get-user-promo-code-limits"
},
"401": {
"$ref": "#/components/responses/Common_401-invalid-basic-auth"
},
"404": {
"content": {
"application/json": {
"examples": {
"Promo code not found": {
"$ref": "#/components/examples/404-coupon-not-found"
},
"User not found": {
"$ref": "#/components/examples/404-user-not-found"
}
},
"schema": {
"properties": {
"errorCode": {
"type": "integer"
},
"errorMessage": {
"type": "string"
},
"statusCode": {
"type": "integer"
},
"transactionId": {
"type": "string"
}
},
"type": "object"
}
}
},
"description": "アイテムが見つかりません。"
},
"422": {
"content": {
"application/json": {
"examples": {
"Invalid user_external_id": {
"$ref": "#/components/examples/Promotions_422-invalid-coupon"
}
},
"schema": {
"properties": {
"errorCode": {
"type": "integer"
},
"errorMessage": {
"type": "string"
},
"errorMessageExtended": {
"type": "array"
},
"statusCode": {
"type": "integer"
},
"transactionId": {
"type": "string"
}
},
"type": "object"
}
}
},
"description": "無効なリクエストです。"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "指定したユーザーのプロモーションコード上限を取得する",
"tags": [
"promotions-promo-codes"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
}
},
"/v2/project/{project_id}/admin/user/limit/promotion/all": {
"delete": {
"description": "して、これらのプロモーションを再度使用できるため、指定されたユーザーのすべてのプロモーションのすべての制限を更新します。\n\nUser limit API を使用すると、ユーザーがプロモーションを使用できる回数を制限できます。ユーザー制限自体を構成するには、目的のプロモーションタイプの管理セクションに移動します：\n* [割引プロモーション](https://developers.xsolla.com/ja/api/shop-builder/tag/promotions-discounts/)\n* [ボーナスプロモーション](https://developers.xsolla.com/ja/api/shop-builder/tag/promotions-bonuses/)",
"operationId": "reset-all-user-promotions-limit",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
}
],
"requestBody": {
"$ref": "#/components/requestBodies/reset-user-limits"
},
"responses": {
"200": {
"description": "プロモーション制限が正常に更新されました。"
},
"401": {
"$ref": "#/components/responses/Common_401-invalid-basic-auth"
},
"404": {
"content": {
"application/json": {
"examples": {
"User not found": {
"$ref": "#/components/examples/404-user-not-found"
}
},
"schema": {
"properties": {
"errorCode": {
"type": "integer"
},
"errorMessage": {
"type": "string"
},
"statusCode": {
"type": "integer"
},
"transactionId": {
"type": "string"
}
},
"type": "object"
}
}
},
"description": "アイテムが見つかりません。"
},
"422": {
"content": {
"application/json": {
"examples": {
"Invalid user_external_id": {
"$ref": "#/components/examples/422-user_external_id_invalid"
}
},
"schema": {
"properties": {
"errorCode": {
"type": "integer"
},
"errorMessage": {
"type": "string"
},
"errorMessageExtended": {
"type": "array"
},
"statusCode": {
"type": "integer"
},
"transactionId": {
"type": "string"
}
},
"type": "object"
}
}
},
"description": "無効なリクエストです。"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "指定したユーザーのプロモーション制限をすべて更新する",
"tags": [
"user-limits-admin"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
}
},
"/v2/project/{project_id}/admin/user/limit/promotion/id/{promotion_id}": {
"delete": {
"description": "指定されたユーザーが適用される制限内でプロモーションを使用できる残りの回数を減らします。\n\nUser limit API を使用すると、ユーザーがプロモーションを使用できる回数を制限できます。ユーザー制限自体を構成するには、目的のプロモーションタイプの管理セクションに移動します：\n* [割引プロモーション](https://developers.xsolla.com/ja/api/shop-builder/tag/promotions-discounts/)\n* [ボーナスプロモーション](https://developers.xsolla.com/ja/api/shop-builder/tag/promotions-bonuses/)",
"operationId": "remove-user-promotion-limit",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/promotion_id-path-param"
}
],
"requestBody": {
"$ref": "#/components/requestBodies/update-user-limits-strict"
},
"responses": {
"200": {
"$ref": "#/components/responses/200-admin-get-user-promotion-limits"
},
"401": {
"$ref": "#/components/responses/Common_401-invalid-basic-auth"
},
"404": {
"content": {
"application/json": {
"examples": {
"Item not found": {
"$ref": "#/components/examples/404-promotion-by-id-not-found"
},
"User not found": {
"$ref": "#/components/examples/404-user-not-found"
}
},
"schema": {
"properties": {
"errorCode": {
"type": "integer"
},
"errorMessage": {
"type": "string"
},
"statusCode": {
"type": "integer"
},
"transactionId": {
"type": "string"
}
},
"type": "object"
}
}
},
"description": "アイテムが見つかりません。"
},
"422": {
"content": {
"application/json": {
"examples": {
"Available promotion limit is out of range": {
"$ref": "#/components/examples/422-promotion-out-of-range-available-user-limit"
},
"Invalid user_external_id": {
"$ref": "#/components/examples/422-user_external_id_invalid"
},
"Promotion does not have configured user limits": {
"$ref": "#/components/examples/422-promotion-without-user-limit"
}
},
"schema": {
"properties": {
"errorCode": {
"type": "integer"
},
"errorMessage": {
"type": "string"
},
"errorMessageExtended": {
"type": "array"
},
"statusCode": {
"type": "integer"
},
"transactionId": {
"type": "string"
}
},
"type": "object"
}
}
},
"description": "無効なリクエストです。"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "指定したユーザーのプロモーション制限を減らす",
"tags": [
"user-limits-admin"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
},
"get": {
"description": "指定されたユーザーが適用される制限内でプロモーションを使用できる残りの回数を取得します。\n\nUser limit API を使用すると、ユーザーがプロモーションを使用できる回数を制限できます。ユーザー制限自体を構成するには、目的のプロモーションタイプの管理セクションに移動します：\n* [割引プロモーション](https://developers.xsolla.com/ja/api/shop-builder/tag/promotions-discounts/)\n* [ボーナスプロモーション](https://developers.xsolla.com/ja/api/shop-builder/tag/promotions-bonuses/)",
"operationId": "get-user-promotion-limit",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/promotion_id-path-param"
},
{
"$ref": "#/components/parameters/user_external_id-query-param"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/200-admin-get-user-promotion-limits"
},
"401": {
"$ref": "#/components/responses/Common_401-invalid-basic-auth"
},
"404": {
"content": {
"application/json": {
"examples": {
"Item not found": {
"$ref": "#/components/examples/404-promotion-by-id-not-found"
},
"User not found": {
"$ref": "#/components/examples/404-user-not-found"
}
},
"schema": {
"properties": {
"errorCode": {
"type": "integer"
},
"errorMessage": {
"type": "string"
},
"statusCode": {
"type": "integer"
},
"transactionId": {
"type": "string"
}
},
"type": "object"
}
}
},
"description": "アイテムが見つかりません。"
},
"422": {
"content": {
"application/json": {
"examples": {
"Invalid user_external_id": {
"$ref": "#/components/examples/422-user_external_id_invalid"
},
"Promotion does not have configured user limits": {
"$ref": "#/components/examples/422-promotion-without-user-limit"
}
},
"schema": {
"properties": {
"errorCode": {
"type": "integer"
},
"errorMessage": {
"type": "string"
},
"errorMessageExtended": {
"type": "array"
},
"statusCode": {
"type": "integer"
},
"transactionId": {
"type": "string"
}
},
"type": "object"
}
}
},
"description": "無効なリクエストです。"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "指定したユーザーのプロモーション制限を取得する",
"tags": [
"user-limits-admin"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
},
"post": {
"description": "指定されたユーザーが適用される制限内でプロモーションを使用できる残りの回数を増やします。\n\nUser limit API を使用すると、ユーザーがプロモーションを使用できる回数を制限できます。ユーザー制限自体を構成するには、目的のプロモーションタイプの管理セクションに移動します：\n* [割引プロモーション](https://developers.xsolla.com/ja/api/shop-builder/tag/promotions-discounts/)\n* [ボーナスプロモーション](https://developers.xsolla.com/ja/api/shop-builder/tag/promotions-bonuses/)",
"operationId": "add-user-promotion-limit",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/promotion_id-path-param"
}
],
"requestBody": {
"$ref": "#/components/requestBodies/update-user-limits-strict"
},
"responses": {
"200": {
"$ref": "#/components/responses/200-admin-get-user-promotion-limits"
},
"401": {
"$ref": "#/components/responses/Common_401-invalid-basic-auth"
},
"404": {
"content": {
"application/json": {
"examples": {
"Item not found": {
"$ref": "#/components/examples/404-promotion-by-id-not-found"
},
"User not found": {
"$ref": "#/components/examples/404-user-not-found"
}
},
"schema": {
"properties": {
"errorCode": {
"type": "integer"
},
"errorMessage": {
"type": "string"
},
"statusCode": {
"type": "integer"
},
"transactionId": {
"type": "string"
}
},
"type": "object"
}
}
},
"description": "アイテムが見つかりません。"
},
"422": {
"content": {
"application/json": {
"examples": {
"Available promotion limit is out of range": {
"$ref": "#/components/examples/422-promotion-out-of-range-available-user-limit"
},
"Invalid user_external_id": {
"$ref": "#/components/examples/422-user_external_id_invalid"
},
"Promotion does not have configured user limits": {
"$ref": "#/components/examples/422-promotion-without-user-limit"
}
},
"schema": {
"properties": {
"errorCode": {
"type": "integer"
},
"errorMessage": {
"type": "string"
},
"errorMessageExtended": {
"type": "array"
},
"statusCode": {
"type": "integer"
},
"transactionId": {
"type": "string"
}
},
"type": "object"
}
}
},
"description": "無効なリクエストです。"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "指定したユーザーのプロモーション制限を増やす",
"tags": [
"user-limits-admin"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
},
"put": {
"description": "プロモーションの増減後に適用される制限の中で、指定したユーザーが利用できる回数を設定します。\n\nUser limit API を使用すると、ユーザーがプロモーションを使用できる回数を制限できます。ユーザー制限自体を構成するには、目的のプロモーションタイプの管理セクションに移動します：\n* [割引プロモーション](https://developers.xsolla.com/ja/api/shop-builder/tag/promotions-discounts/)\n* [ボーナスプロモーション](https://developers.xsolla.com/ja/api/shop-builder/tag/promotions-bonuses/)",
"operationId": "set-user-promotion-limit",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/promotion_id-path-param"
}
],
"requestBody": {
"$ref": "#/components/requestBodies/update-user-limits-flexible"
},
"responses": {
"200": {
"$ref": "#/components/responses/200-admin-get-user-promotion-limits"
},
"401": {
"$ref": "#/components/responses/Common_401-invalid-basic-auth"
},
"404": {
"content": {
"application/json": {
"examples": {
"Item not found": {
"$ref": "#/components/examples/404-promotion-by-id-not-found"
},
"User not found": {
"$ref": "#/components/examples/404-user-not-found"
}
},
"schema": {
"properties": {
"errorCode": {
"type": "integer"
},
"errorMessage": {
"type": "string"
},
"statusCode": {
"type": "integer"
},
"transactionId": {
"type": "string"
}
},
"type": "object"
}
}
},
"description": "アイテムが見つかりません。"
},
"422": {
"content": {
"application/json": {
"examples": {
"Invalid user_external_id": {
"$ref": "#/components/examples/422-user_external_id_invalid"
},
"Promotion does not have configured user limits": {
"$ref": "#/components/examples/422-promotion-without-user-limit"
}
},
"schema": {
"properties": {
"errorCode": {
"type": "integer"
},
"errorMessage": {
"type": "string"
},
"errorMessageExtended": {
"type": "array"
},
"statusCode": {
"type": "integer"
},
"transactionId": {
"type": "string"
}
},
"type": "object"
}
}
},
"description": "無効なリクエストです。"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "指定したユーザーのプロモーション制限を設定する",
"tags": [
"user-limits-admin"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
}
},
"/v2/project/{project_id}/admin/user/limit/promotion/id/{promotion_id}/all": {
"delete": {
"description": "ユーザーがこのプロモーションを再度使用できるように、プロモーション制限を更新します。*user*パラメータが`null`である場合、このコールはすべてのユーザーのこの制限を更新します。\n\nUser limit API を使用すると、ユーザーがプロモーションを使用できる回数を制限できます。ユーザー制限自体を構成するには、目的のプロモーションタイプの管理セクションに移動します：\n* [割引プロモーション](https://developers.Xsolla.com/api/shop-builder/tag/promotions-discounts/)\n* [ボーナスプロモーション](https://developers.Xsolla.com/api/shop-builder/tag/promotions-bonuses/)",
"operationId": "reset-user-promotion-limit",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/promotion_id-path-param"
}
],
"requestBody": {
"$ref": "#/components/requestBodies/reset-user-limits-flexible"
},
"responses": {
"200": {
"description": "プロモーション制限が正常に更新されました。"
},
"401": {
"$ref": "#/components/responses/Common_401-invalid-basic-auth"
},
"404": {
"content": {
"application/json": {
"examples": {
"Item not found": {
"$ref": "#/components/examples/404-promotion-by-id-not-found"
},
"User not found": {
"$ref": "#/components/examples/404-user-not-found"
}
},
"schema": {
"properties": {
"errorCode": {
"type": "integer"
},
"errorMessage": {
"type": "string"
},
"statusCode": {
"type": "integer"
},
"transactionId": {
"type": "string"
}
},
"type": "object"
}
}
},
"description": "アイテムが見つかりません。"
},
"422": {
"content": {
"application/json": {
"examples": {
"Invalid user_external_id": {
"$ref": "#/components/examples/422-user_external_id_invalid"
},
"Promotion does not have configured user limits": {
"$ref": "#/components/examples/422-promotion-without-user-limit"
}
},
"schema": {
"properties": {
"errorCode": {
"type": "integer"
},
"errorMessage": {
"type": "string"
},
"errorMessageExtended": {
"type": "array"
},
"statusCode": {
"type": "integer"
},
"transactionId": {
"type": "string"
}
},
"type": "object"
}
}
},
"description": "無効なリクエストです。"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "ユーザー向けプロモーション制限を更新する",
"tags": [
"user-limits-admin"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
}
},
"/v2/project/{project_id}/coupon/code/{coupon_code}/rewards": {
"get": {
"description": "Gets coupons rewards by its code.\nCan be used to allow users to choose one of many items as a bonus.\nThe usual case is choosing a DRM if the coupon contains a game as a bonus (`type=unit`).
\n Note
\n This API call uses a user JWT for authorization.
\n Include the token in the Authorization header in the following format: Bearer <user_JWT>. For more information about user JWT, see the Security block for this call.\n
",
"operationId": "get-coupon-rewards-by-code",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/coupon_code-path-param"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/Promotions_200-coupon-rewards"
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-client-auth"
},
"403": {
"$ref": "#/components/responses/Promotions_403-auth-header"
},
"404": {
"$ref": "#/components/responses/Promotions_404-coupon"
},
"422": {
"$ref": "#/components/responses/Promotions_422-rewards"
}
},
"security": [
{
"XsollaLoginUserJWT": []
}
],
"summary": "クーポン特典を入手",
"tags": [
"promotions-coupons"
],
"x-badges": [
{
"color": "#80eaff",
"name": "Client-side"
}
]
}
},
"/v2/project/{project_id}/coupon/redeem": {
"post": {
"description": "Redeems a coupon code. The user gets a bonus after a coupon is redeemed.
\n Note
\n This API call uses a user JWT for authorization.
\n Include the token in the Authorization header in the following format: Bearer <user_JWT>. For more information about user JWT, see the Security block for this call.\n
",
"operationId": "redeem-coupon",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
}
],
"requestBody": {
"$ref": "#/components/requestBodies/Promotions_redeem-coupon-model"
},
"responses": {
"200": {
"$ref": "#/components/responses/Promotions_200-coupon-redeemed"
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-client-auth"
},
"403": {
"$ref": "#/components/responses/Promotions_403-auth-header"
},
"404": {
"$ref": "#/components/responses/Promotions_404-coupon"
},
"422": {
"$ref": "#/components/responses/Promotions_422-redeem-coupon"
}
},
"security": [
{
"XsollaLoginUserJWT": []
}
],
"summary": "クポーンコードを引き換える",
"tags": [
"promotions-coupons"
],
"x-badges": [
{
"color": "#80eaff",
"name": "Client-side"
}
]
}
},
"/v2/project/{project_id}/items/upsell": {
"get": {
"description": "Gets a list of upsell items in a project if they have already been set up.
\n Note
\n This API call uses a user JWT for authorization.
\n Include the token in the Authorization header in the following format: Bearer <user_JWT>. For more information about user JWT, see the Security block for this call.\n
",
"operationId": "get-upsell-for-project-client",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/Upsell-200-get-client-list"
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-client-auth"
}
},
"security": [
{
"XsollaLoginUserJWT": []
}
],
"summary": "プロジェクト内のアップセルアイテムのリストを取得する",
"tags": [
"upsell-client"
],
"x-badges": [
{
"color": "#80eaff",
"name": "Client-side"
}
]
}
},
"/v2/project/{project_id}/promocode/code/{promocode_code}/rewards": {
"get": {
"description": "Gets promo code rewards by its code.\nCan be used to allow users to choose one of many items as a bonus.\nThe usual case is choosing a DRM if the promo code contains a game as a bonus (`type=unit`).
\n Note
\n This API call uses a user JWT for authorization.
\n Include the token in the Authorization header in the following format: Bearer <user_JWT>. For more information about user JWT, see the Security block for this call.\n
",
"operationId": "get-promo-code-rewards-by-code",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/promocode_code-path-param"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/Promotions_200-promocode-rewards"
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-client-auth"
},
"403": {
"$ref": "#/components/responses/Promotions_403-auth-header"
},
"404": {
"$ref": "#/components/responses/Promotions_404-promo-code"
},
"422": {
"$ref": "#/components/responses/Promotions_422-rewards"
}
},
"security": [
{
"XsollaLoginUserJWT": []
}
],
"summary": "プロモーションコードの特典を入手",
"tags": [
"promotions-promo-codes"
],
"x-badges": [
{
"color": "#80eaff",
"name": "Client-side"
}
]
}
},
"/v2/project/{project_id}/promocode/redeem": {
"post": {
"description": "プロモーションコードを引き換えます。\nプロモーションコードを引き換えた後、ユーザーは無料でアイテムを入手したり、カートや特定のアイテムの価格を下げたりすることができます。",
"operationId": "redeem-promo-code",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
}
],
"requestBody": {
"$ref": "#/components/requestBodies/Promotions_redeem-promo-code-model"
},
"responses": {
"200": {
"$ref": "#/components/responses/Promotions_200-promo-code-redeemed"
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-client-auth"
},
"403": {
"$ref": "#/components/responses/Promotions_403-auth-header"
},
"404": {
"$ref": "#/components/responses/Promotions_404-promo-code"
},
"422": {
"$ref": "#/components/responses/Promotions_422-redeem-coupon"
}
},
"security": [
{
"AuthForCart": []
}
],
"summary": "プロモーションコードを引き換える",
"tags": [
"promotions-promo-codes"
],
"x-badges": [
{
"color": "#80eaff",
"name": "Client-side"
}
]
}
},
"/v2/project/{project_id}/promocode/remove": {
"put": {
"description": "プロモーションコードをカートから削除します。\nプロモーションコードを削除した後、カート内のすべてのアイテムの合計金額は、プロモーションコードによるボーナスや割引を除いて再計算されます。",
"operationId": "remove-cart-promo-code",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
}
],
"requestBody": {
"$ref": "#/components/requestBodies/Promotions_cancel-promo-code-model"
},
"responses": {
"200": {
"$ref": "#/components/responses/Promotions_200-promo-code-canceled"
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-client-auth"
},
"403": {
"$ref": "#/components/responses/Promotions_403-auth-header"
},
"422": {
"$ref": "#/components/responses/Promotions_422-cancel-promo-code"
}
},
"security": [
{
"AuthForCart": []
}
],
"summary": "カートからプロモーションコードを削除",
"tags": [
"promotions-promo-codes"
],
"x-badges": [
{
"color": "#80eaff",
"name": "Client-side"
}
]
}
},
"/v2/project/{project_id}/promotion/code/{code}/verify": {
"get": {
"description": "Determines if the code is a promo code or coupon code and if the user can apply it.
\n Note
\n This API call uses a user JWT for authorization.
\n Include the token in the Authorization header in the following format: Bearer <user_JWT>. For more information about user JWT, see the Security block for this call.\n
",
"operationId": "verify-promotion-code",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/code-path-param"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/Promotions_200-verify-promo-code"
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-client-auth"
},
"403": {
"$ref": "#/components/responses/Promotions_403-auth-header"
},
"404": {
"$ref": "#/components/responses/Promotions_404-verify-promo-code"
},
"422": {
"$ref": "#/components/responses/Promotions_422-verify-promo-code"
}
},
"security": [
{
"XsollaLoginUserJWT": []
}
],
"summary": "プロモーションコードを検証する",
"tags": [
"promotions-common"
],
"x-badges": [
{
"color": "#80eaff",
"name": "Client-side"
}
]
}
},
"/v2/project/{project_id}/user/clan/contributors/{reward_chain_id}/top": {
"get": {
"description": "Retrieves the list of top 10 contributors to the specific reward chain under the current user's clan. If a user doesn't belong to a clan, the call returns an empty array.
\n Note
\n This API call uses a user JWT for authorization.
\n Include the token in the Authorization header in the following format: Bearer <user_JWT>. For more information about user JWT, see the Security block for this call.\n
",
"operationId": "get-user-clan-top-contributors",
"parameters": [
{
"description": "プロジェクトID。",
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"example": 44056,
"type": "integer"
}
},
{
"description": "報酬チェーンID。",
"in": "path",
"name": "reward_chain_id",
"required": true,
"schema": {
"example": 101,
"type": "integer"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"clan": {
"summary": "ユーザーがクランを持っています",
"value": [
{
"contributed_amount": 555,
"name": "winner"
},
{
"contributed_amount": 398,
"name": "Rocket"
},
{
"contributed_amount": 201,
"name": "MrJoe"
},
{
"contributed_amount": 1,
"name": "beginner"
}
]
},
"without-clan": {
"summary": "ユーザーがクランに所属していません",
"value": []
}
},
"schema": {
"items": {
"properties": {
"contributed_amount": {
"description": "ユーザーが貢献したバリューポイントの量。",
"example": 100,
"type": "integer"
},
"name": {
"description": "ユーザーID。これは認証時にエクソーラに送信されるIDで、ユーザーをエクソーラログインプロジェクトにリンクします。",
"example": "Rocket",
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
}
},
"description": "クランの報酬チェーンへの貢献者トップ10リスト。"
}
},
"security": [
{
"XsollaLoginUserJWT": []
}
],
"summary": "クランの下で報酬チェーンへの貢献度トップ10を獲得する",
"tags": [
"clan-reward-chain-client"
],
"x-badges": [
{
"color": "#80eaff",
"name": "Client-side"
}
]
}
},
"/v2/project/{project_id}/user/clan/update": {
"put": {
"description": "Updates a current user's clan via user attributes. Claims all rewards from reward chains that were not claimed for a previous clan and returns them in the response. If the user was in a clan and now is not — their inclusion in the clan will be revoked. If the user changed the clan — the clan will be changed.
\n Note
\n This API call uses a user JWT for authorization.
\n Include the token in the Authorization header in the following format: Bearer <user_JWT>. For more information about user JWT, see the Security block for this call.\n
",
"operationId": "user-clan-update",
"parameters": [
{
"description": "プロジェクトID。",
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"default": 44056,
"type": "integer"
}
}
],
"responses": {
"200": {
"$ref": "#/components/responses/200-client-update-user-clan"
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-client-auth"
}
},
"security": [
{
"XsollaLoginUserJWT": []
}
],
"summary": "現在のユーザーのクランを更新する",
"tags": [
"clan-reward-chain-client"
],
"x-badges": [
{
"color": "#80eaff",
"name": "Client-side"
}
]
}
},
"/v2/project/{project_id}/user/daily_chain": {
"get": {
"description": "Client endpoint. Gets the current user's daily rewards.\nNotice
A method returns a paginated list of items. The maximum and default value is 50 items per response. To get more items from the list, use the limit and offset parameters and fetch more pages. For example, when calling a method with limit = 25 and offset = 100, the response returns 25 items starting from the 101st item in the overall list.
\n Note
\n This API call uses a user JWT for authorization.
\n Include the token in the Authorization header in the following format: Bearer <user_JWT>. For more information about user JWT, see the Security block for this call.\n
",
"operationId": "get-daily-chains-list",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/limit-query-param"
},
{
"$ref": "#/components/parameters/offset-query-param"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/200-client-get-daily-chains-list"
},
"401": {
"$ref": "#/components/responses/401-client-auth-error"
}
},
"security": [
{
"XsollaLoginUserJWT": []
}
],
"summary": "現在のユーザーのデイリー報酬を取得する",
"tags": [
"daily-chain-client"
],
"x-badges": [
{
"color": "#80eaff",
"name": "Client-side"
}
]
}
},
"/v2/project/{project_id}/user/daily_chain/{daily_chain_id}": {
"get": {
"description": "Client endpoint. Gets the current user’s daily reward by its ID.
\n Note
\n This API call uses a user JWT for authorization.
\n Include the token in the Authorization header in the following format: Bearer <user_JWT>. For more information about user JWT, see the Security block for this call.\n
",
"operationId": "get-user-daily-chain-by-id",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/daily_chain_id-path-param"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"$ref": "#/components/examples/200-client-daily-chain"
}
},
"schema": {
"$ref": "#/components/schemas/client-daily-chain-model"
}
}
},
"description": "ユーザーのデイリー報酬が正常に取得されました。"
},
"404": {
"$ref": "#/components/responses/404-daily-chain-not-found"
}
},
"security": [
{
"XsollaLoginUserJWT": []
}
],
"summary": "ID を指定して現在のユーザーのデイリー報酬を取得します。",
"tags": [
"daily-chain-client"
],
"x-badges": [
{
"color": "#80eaff",
"name": "Client-side"
}
]
}
},
"/v2/project/{project_id}/user/daily_chain/{daily_chain_id}/step/number/{step_number}/claim": {
"post": {
"description": "Client endpoint. Claims the current user's step reward from a daily reward. All steps can only be claimed in sequential order. The reward for a missed step cannot be obtained for virtual or real currency, or by watching an ad
\n Note
\n This API call uses a user JWT for authorization.
\n Include the token in the Authorization header in the following format: Bearer <user_JWT>. For more information about user JWT, see the Security block for this call.\n
",
"operationId": "claim-user-daily-chain-step-reward",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/daily_chain_id-path-param"
},
{
"$ref": "#/components/parameters/daily_chain_step_number-path-param"
}
],
"responses": {
"204": {
"description": "現在のユーザーのデイリー報酬ステップの報酬を正常に受け取りました。"
},
"401": {
"$ref": "#/components/responses/401-client-auth-error"
},
"404": {
"$ref": "#/components/responses/404-daily-chain-step-not-found"
},
"422": {
"content": {
"application/json": {
"examples": {
"invalid-step": {
"$ref": "#/components/examples/422-daily-chain-claim-error-invalid-step"
}
},
"schema": {
"$ref": "#/components/schemas/daily-chain-error-model"
}
}
},
"description": "ステップを受け取ることはできません。"
}
},
"security": [
{
"XsollaLoginUserJWT": []
}
],
"summary": "デイリー報酬ステップを受け取る",
"tags": [
"daily-chain-client"
],
"x-badges": [
{
"color": "#80eaff",
"name": "Client-side"
}
]
}
},
"/v2/project/{project_id}/user/offer_chain": {
"get": {
"description": "Gets the current user’s offer chains.\nNotice
All projects have a limit on the number of items that can be returned in a single response. The default and maximum value is 30 items per response. To get more data, use the limit and offset query parameters for pagination.
\n Note
\n This API call uses a user JWT for authorization.
\n Include the token in the Authorization header in the following format: Bearer <user_JWT>. For more information about user JWT, see the Security block for this call.\n
",
"operationId": "get-offer-chains-list",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/limit-query-param"
},
{
"$ref": "#/components/parameters/offset-query-param"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/200-client-get-offer-chains-list"
}
},
"security": [
{
"XsollaLoginUserJWT": []
}
],
"summary": "現在のユーザーのオファーチェーンを取得する",
"tags": [
"offer-chain-client"
],
"x-badges": [
{
"color": "#80eaff",
"name": "Client-side"
}
]
}
},
"/v2/project/{project_id}/user/offer_chain/{offer_chain_id}": {
"get": {
"description": "Gets the current user’s offer chain by the offer chain's ID.
\n Note
\n This API call uses a user JWT for authorization.
\n Include the token in the Authorization header in the following format: Bearer <user_JWT>. For more information about user JWT, see the Security block for this call.\n
",
"operationId": "get-user-offer-chain-by-id",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/offer_chain_id-path-param"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"$ref": "#/components/examples/200-client-offer-chain"
}
},
"schema": {
"$ref": "#/components/schemas/client-offer-chain-model"
}
}
},
"description": "ユーザーのオファーチェーンが正常に取得されました。"
},
"404": {
"$ref": "#/components/responses/404-offer-chain-not-found"
}
},
"security": [
{
"XsollaLoginUserJWT": []
}
],
"summary": "IDで現在のユーザーのオファーチェーンを取得する",
"tags": [
"offer-chain-client"
],
"x-badges": [
{
"color": "#80eaff",
"name": "Client-side"
}
]
}
},
"/v2/project/{project_id}/user/offer_chain/{offer_chain_id}/step/number/{step_number}/claim": {
"post": {
"description": "Completes the current user’s progression through the offer chain step and grants the associated reward.\n
\n Note
\n This API call uses a user JWT for authorization.
\n Include the token in the Authorization header in the following format: Bearer <user_JWT>. For more information about user JWT, see the Security block for this call.\n
",
"operationId": "claim-user-offer-chain-step-reward",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/offer_chain_id-path-param"
},
{
"$ref": "#/components/parameters/offer_chain_step_number-path-param"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"order_id": 641
}
}
},
"schema": {
"properties": {
"order_id": {
"description": "注文ID。",
"type": "integer"
}
},
"type": "object"
}
}
},
"description": "無料ステップが正常に請求され、報酬が付与されました。"
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-client-auth"
},
"404": {
"$ref": "#/components/responses/404-offer-chain-step-not-found"
},
"422": {
"content": {
"application/json": {
"examples": {
"invalid-step": {
"$ref": "#/components/examples/422-offer-chain-claim-error-invalid-step"
}
},
"schema": {
"$ref": "#/components/schemas/offer-chain-error-model"
}
}
},
"description": "このステップは請求できません。 以前のすべてのステップが完了しており、かつこのステップが無料としてマークされていることを確認してください。"
}
},
"security": [
{
"XsollaLoginUserJWT": []
}
],
"summary": "無料オファーチェーンステップを請求する",
"tags": [
"offer-chain-client"
],
"x-badges": [
{
"color": "#80eaff",
"name": "Client-side"
}
]
}
},
"/v2/project/{project_id}/user/offer_chain/{offer_chain_id}/step/number/{step_number}/order": {
"post": {
"description": "Creates an order for the item associated with the specified paid offer chain step. The created order gets the `new` order status.\n\nTo open the payment UI in a new window, use the following link: `https://secure.xsolla.com/paystation4/?token={token}`, where `{token}` is the received token.\n\nFor testing purposes, use this URL: `https://sandbox-secure.xsolla.com/paystation4/?token={token}`.\n\n\n
Notice \n This method must be used on the client side. The user's IP address is used to determine the country, which affects the currency and available payment methods. Using this method from the server side may result in incorrect currency detection and affect payment methods in
Pay Station.\n
\n\n\n
\n\n Note
\n This API call uses a user JWT for authorization.
\n Include the token in the Authorization header in the following format: Bearer <user_JWT>. For more information about user JWT, see the Security block for this call.\n
",
"operationId": "order-user-offer-chain-step-reward",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/offer_chain_id-path-param"
},
{
"$ref": "#/components/parameters/offer_chain_step_number-path-param"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/Cart-Payment_200-order-created"
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-client-auth"
},
"404": {
"$ref": "#/components/responses/404-offer-chain-step-not-found"
},
"422": {
"content": {
"application/json": {
"examples": {
"invalid-step": {
"$ref": "#/components/examples/422-offer-chain-claim-error-invalid-step"
}
},
"schema": {
"$ref": "#/components/schemas/offer-chain-error-model"
}
}
},
"description": "ステップは購入できません。"
}
},
"security": [
{
"XsollaLoginUserJWT": []
}
],
"summary": "有料のオファーチェーンステップの注文を作成する",
"tags": [
"offer-chain-client",
"payment-client-side"
],
"x-badges": [
{
"color": "#80eaff",
"name": "Client-side"
}
]
}
},
"/v2/project/{project_id}/user/reward_chain": {
"get": {
"description": "Client endpoint. Gets the current user’s reward chains.\n\n Attention
\n All projects have the limitation to the number of items that you can\n get in the response. The default and maximum value is 50 items\n per response. To get more data page by page, use limit\n and offset fields.\n
\n Note
\n This API call uses a user JWT for authorization.
\n Include the token in the Authorization header in the following format: Bearer <user_JWT>. For more information about user JWT, see the Security block for this call.\n
",
"operationId": "get-reward-chains-list",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/limit-query-param"
},
{
"$ref": "#/components/parameters/offset-query-param"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/200-client-get-reward-chains-list"
}
},
"security": [
{
"XsollaLoginUserJWT": []
}
],
"summary": "現在のユーザーの報酬チェーンを取得する",
"tags": [
"reward-chain-client"
],
"x-badges": [
{
"color": "#80eaff",
"name": "Client-side"
}
]
}
},
"/v2/project/{project_id}/user/reward_chain/{reward_chain_id}/balance": {
"get": {
"description": "Client endpoint. Gets the current user’s value point balance.
\n Note
\n This API call uses a user JWT for authorization.
\n Include the token in the Authorization header in the following format: Bearer <user_JWT>. For more information about user JWT, see the Security block for this call.\n
",
"operationId": "get-user-reward-chain-balance",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/reward_chain_id-path-param"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/200-client-get-user-reward-chain-balance"
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-client-auth"
}
},
"security": [
{
"XsollaLoginUserJWT": []
}
],
"summary": "現在のユーザーのバリューポイント残高を取得する",
"tags": [
"reward-chain-client"
],
"x-badges": [
{
"color": "#80eaff",
"name": "Client-side"
}
]
}
},
"/v2/project/{project_id}/user/reward_chain/{reward_chain_id}/step/{step_id}/claim": {
"post": {
"description": "Client endpoint. Claims the current user’s step reward from a reward chain.
\n Note
\n This API call uses a user JWT for authorization.
\n Include the token in the Authorization header in the following format: Bearer <user_JWT>. For more information about user JWT, see the Security block for this call.\n
",
"operationId": "claim-user-reward-chain-step-reward",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/reward_chain_id-path-param"
},
{
"$ref": "#/components/parameters/reward_chain_step_id-path-param"
}
],
"responses": {
"204": {
"description": "現在のユーザーのステップ報酬を報酬チェーンから取得することに成功しました。"
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-client-auth"
},
"404": {
"$ref": "#/components/responses/404-reward-chain-step-not-found"
},
"422": {
"$ref": "#/components/responses/422-reward-chain-step-reward-can-not-claimed"
}
},
"security": [
{
"XsollaLoginUserJWT": []
}
],
"summary": "ステップ報酬を請求する",
"tags": [
"reward-chain-client"
],
"x-badges": [
{
"color": "#80eaff",
"name": "Client-side"
}
]
}
},
"/v3/project/{project_id}/admin/coupon": {
"get": {
"description": "プロジェクトのクーポンプロモーションのリストを取得します。",
"operationId": "get-coupons",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/limit-query-param"
},
{
"$ref": "#/components/parameters/offset-query-param"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/Promotions_200-get-coupons"
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-basic-auth"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "クーポンプロモーションのリストを取得",
"tags": [
"promotions-coupons"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
},
"post": {
"description": "クーポンプロモーションを作成します。",
"operationId": "admin-create-coupon",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
}
],
"requestBody": {
"$ref": "#/components/requestBodies/Promotions_coupon-create"
},
"responses": {
"201": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"external_id": "coupon_external_id"
}
}
},
"schema": {
"properties": {
"external_id": {
"$ref": "#/components/schemas/Promotions_coupon-external_id"
}
},
"type": "object"
}
}
},
"description": "クーポンが正常に作成されました。"
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-basic-auth"
},
"422": {
"$ref": "#/components/responses/Promotions_422-invalid-coupon"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "クーポンプロモーションを作成",
"tags": [
"promotions-coupons"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
}
},
"/v3/project/{project_id}/admin/coupon/{external_id}": {
"delete": {
"description": "[クーポンプロモーション](https://developers.xsolla.com/ja/doc/shop-builder/features/coupons/)を削除します。削除されたプロモーション：\n* プロジェクトで設定されたプロモーションのリストから消えます。\n* アイテムカタログに適用されなくなります。\n\n削除後、プロモーションを復元することはできません。\n削除されたプロモーションのクーポンコードは、既存のプロモーションに[追加する](https://developers.xsolla.com/ja/api/shop-builder/operation/create-coupon-code/)ことができます。",
"operationId": "delete-coupon-promotion",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/external_id-promotion-path-param"
}
],
"responses": {
"204": {
"description": "クーポンプロモーションは正常に削除されました。"
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/Promotions_404-admin-coupon"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "クーポンプロモーションを削除",
"tags": [
"promotions-coupons"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
},
"get": {
"description": "指定されたクーポンプロモーションを取得します。",
"operationId": "get-coupon",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/external_id-promotion-path-param"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"bonus": [
{
"quantity": 100,
"sku": "com.xsolla.diamonds_1"
}
],
"external_id": "summer20221",
"is_enabled": true,
"name": {
"en-US": "Coupon name",
"ru-RU": "Название купона"
},
"promotion_periods": [
{
"date_from": "2020-04-15T18:16:00+05:00",
"date_until": "2020-04-25T18:16:00+05:00"
},
{
"date_from": "2020-05-15T18:16:00+05:00",
"date_until": "2020-05-25T18:16:00+05:00"
}
],
"redeem_code_limit": null,
"redeem_total_limit": 100,
"redeem_user_limit": null,
"total_limit_state": {
"available": 50,
"reserved": 10,
"used": 40
}
}
}
},
"schema": {
"$ref": "#/components/schemas/admin-promotions_200-get-coupon-promotion-model"
}
}
},
"description": "クーポンは正常に受信されました。"
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/Promotions_404-admin-coupon"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "クーポンプロモーションを取得",
"tags": [
"promotions-coupons"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
},
"put": {
"description": "クーポンプロモーションを更新しました。",
"operationId": "update-coupon-promotion",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/external_id-promotion-path-param"
}
],
"requestBody": {
"$ref": "#/components/requestBodies/Promotions_coupon-update"
},
"responses": {
"204": {
"description": "クーポンが正常に更新されました。"
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/Promotions_404-admin-coupon"
},
"422": {
"$ref": "#/components/responses/Promotions_422-invalid-coupon"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "クーポンプロモーションを更新",
"tags": [
"promotions-coupons"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
}
},
"/v3/project/{project_id}/admin/promocode": {
"get": {
"description": "プロジェクトのプロモーションコードリストを取得します。",
"operationId": "get-promo-codes",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/limit-query-param"
},
{
"$ref": "#/components/parameters/offset-query-param"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/Promotions_200-get-promocodes"
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-basic-auth"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "プロモーションコードのプロモーションのリストを取得",
"tags": [
"promotions-promo-codes"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
},
"post": {
"description": "プロモーションコードのプロモーションを作成します。",
"operationId": "create-promo-code",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
}
],
"requestBody": {
"$ref": "#/components/requestBodies/Promotions_promocode-create"
},
"responses": {
"201": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"external_id": "coupon_external_id"
}
}
},
"schema": {
"properties": {
"external_id": {
"$ref": "#/components/schemas/Promotions_coupon-external_id"
}
},
"type": "object"
}
}
},
"description": "プロモーションコードが正常に作成されました。"
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-basic-auth"
},
"422": {
"$ref": "#/components/responses/Promotions_422-invalid-coupon"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "プロモーションコードのプロモーションを作成",
"tags": [
"promotions-promo-codes"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
}
},
"/v3/project/{project_id}/admin/promocode/{external_id}": {
"delete": {
"description": "[プロモーションコードのプロモーション](https://developers.xsolla.com/ja/doc/shop-builder/features/promo-codes/)を削除します。削除されたプロモーション：\n* プロジェクトで設定されたプロモーションのリストから消える。\n* アイテムカタログとカートに適用されなくなる。\n\n削除後、プロモーションを復元することはできません。\n削除されたプロモーションのプロモーションコードを既存のプロモーションに[追加](https://developers.xsolla.com/ja/api/shop-builder/operation/create-promo-code-code/)できます。",
"operationId": "delete-promo-code",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/external_id-promotion-path-param"
}
],
"responses": {
"204": {
"description": "プロモーションコードのプロモーションは正常に削除されました。"
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/Promotions_404-admin-promocode"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "プロモーションコードのプロモーションを削除",
"tags": [
"promotions-promo-codes"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
},
"get": {
"description": "指定されたプロモーションコードを取得します。",
"operationId": "get-promo-code",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/external_id-promotion-path-param"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"simple": {
"value": {
"bonus": [
{
"quantity": 100,
"sku": "com.xsolla.diamonds_1"
}
],
"discount": {
"percent": "10.99"
},
"discounted_items": null,
"excluded_promotions": [
23,
45
],
"external_id": "summer20221",
"is_enabled": true,
"name": {
"en-US": "Coupon name",
"ru-RU": "Название купона"
},
"promotion_periods": [
{
"date_from": "2020-04-15T18:16:00+05:00",
"date_until": "2020-04-25T18:16:00+05:00"
},
{
"date_from": "2020-05-15T18:16:00+05:00",
"date_until": "2020-05-25T18:16:00+05:00"
}
],
"redeem_code_limit": 1,
"redeem_total_limit": 100,
"redeem_user_limit": null,
"total_limit_state": {
"available": 50,
"reserved": 10,
"used": 40
}
}
},
"with item price conditions": {
"value": {
"bonus": [
{
"quantity": 100,
"sku": "com.xsolla.diamonds_3"
}
],
"discount": {
"percent": "10.99"
},
"discounted_items": null,
"excluded_promotions": [
23,
45
],
"external_id": "summer20221",
"is_enabled": true,
"item_price_conditions": [
{
"operator": "gt",
"value": "10.0000"
},
{
"operator": "lt",
"value": "50.0000"
}
],
"name": {
"en-US": "Coupon name",
"ru-RU": "Название купона"
},
"promotion_periods": [
{
"date_from": "2020-04-15T18:16:00+05:00",
"date_until": "2020-04-25T18:16:00+05:00"
}
],
"redeem_code_limit": 1,
"redeem_total_limit": 100,
"redeem_user_limit": null,
"total_limit_state": {
"available": 50,
"reserved": 10,
"used": 40
}
}
},
"with price conditions": {
"value": {
"bonus": [
{
"quantity": 100,
"sku": "com.xsolla.diamonds_2"
}
],
"discount": {
"percent": "10.99"
},
"discounted_items": null,
"external_id": "summer20221",
"is_enabled": true,
"name": {
"en-US": "Coupon name",
"ru-RU": "Название купона"
},
"price_conditions": [
{
"operator": "gt",
"value": "10.0000"
},
{
"operator": "lt",
"value": "50.0000"
}
],
"promotion_periods": [
{
"date_from": "2020-04-15T18:16:00+05:00",
"date_until": "2020-04-25T18:16:00+05:00"
}
],
"redeem_code_limit": 1,
"redeem_total_limit": 100,
"redeem_user_limit": null,
"total_limit_state": {
"available": 50,
"reserved": 10,
"used": 40
}
}
}
},
"schema": {
"$ref": "#/components/schemas/Promotions_200-get-promocode-promotion-model"
}
}
},
"description": "プロモーションコードは正常に受信されました。"
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/Promotions_404-admin-promocode"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "プロモーションコードのプロモーションを取得",
"tags": [
"promotions-promo-codes"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
},
"put": {
"description": "プロモーションコードのプロモーションを更新しました。",
"operationId": "update-promo-code",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/external_id-promotion-path-param"
}
],
"requestBody": {
"$ref": "#/components/requestBodies/Promotions_promocode-update"
},
"responses": {
"204": {
"description": "プロモーションコードが正常に更新されました。"
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/Promotions_404-admin-promocode"
},
"422": {
"$ref": "#/components/responses/Promotions_422-invalid-coupon"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "プロモーションコードのプロモーションを更新",
"tags": [
"promotions-promo-codes"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
}
},
"/v3/project/{project_id}/admin/promotion": {
"get": {
"description": "プロジェクトのプロモーションリストを取得します。",
"operationId": "get-promotion-list",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/limit-query-param"
},
{
"$ref": "#/components/parameters/offset-query-param"
},
{
"$ref": "#/components/parameters/enabled-query-param"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/Promotions_200-get-promotions"
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-basic-auth"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "すべてのプロモーションリストを取得",
"tags": [
"promotions-common"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
}
},
"/v3/project/{project_id}/admin/promotion/bonus": {
"get": {
"description": "プロジェクトのボーナスプロモーションのリストを取得します。\n\nプロモーションは、ユーザーによる購入に無料のボーナスアイテムを追加します。\nプロモーションは、プロジェクト内のすべての購入、または特定のアイテムを含む購入に適用することができます。",
"operationId": "get-bonus-promotion-list",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/limit-query-param"
},
{
"$ref": "#/components/parameters/offset-query-param"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/Promotions_200-get-bonus-promotions"
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-basic-auth"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "ボーナスプロモーションのリストを取得",
"tags": [
"promotions-bonuses"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
},
"post": {
"description": "ボーナスプロモーションを作成します。\n\nプロモーションは、ユーザーによる購入に無料のボーナスアイテムを追加します。\nプロモーションは、プロジェクト内のすべての購入、または特定のアイテムを含む購入に適用することができます。",
"operationId": "create-bonus-promotion",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
}
],
"requestBody": {
"$ref": "#/components/requestBodies/Promotions_create-update-bonus-promotion"
},
"responses": {
"201": {
"$ref": "#/components/responses/Promotions_201-create-promotion"
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-basic-auth"
},
"422": {
"$ref": "#/components/responses/Promotions_422-admin-promotion-missed-bonus-property"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "ボーナスプロモーションを作成",
"tags": [
"promotions-bonuses"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
}
},
"/v3/project/{project_id}/admin/promotion/item": {
"get": {
"description": "プロジェクトのアイテムプロモーションのリストを取得します。\n\nプロモーションは、アイテムの割引（％）を提供します。\n指定したアイテムの全価格に割引が適用されます。",
"operationId": "get-item-promotion-list",
"parameters": [
{
"description": "プロジェクトID。",
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"default": 59080,
"type": "integer"
}
},
{
"description": "ページでの要素数の制限。",
"in": "query",
"name": "limit",
"required": false,
"schema": {
"type": "integer"
}
},
{
"description": "リストが生成される要素番号（カウントは0から始まります）。",
"in": "query",
"name": "offset",
"required": false,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"$ref": "#/components/responses/Promotions_200-get-item-promotions"
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-basic-auth"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "アイテムプロモーションのリストを取得",
"tags": [
"promotions-discounts"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
},
"post": {
"description": "アイテムの割引キャンペーンを作成します。\n\nキャンペーンは、アイテムの割引（％）を提供します。\n指定したアイテムの全価格に割引が適用されます。",
"operationId": "create-item-promotion",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
}
],
"requestBody": {
"$ref": "#/components/requestBodies/Promotions_create-update-item-promotion"
},
"responses": {
"201": {
"$ref": "#/components/responses/Promotions_201-create-promotion"
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-basic-auth"
},
"422": {
"$ref": "#/components/responses/Promotions_422-admin-promotion-missed-items-property"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "アイテムの割引プロモーションを作成",
"tags": [
"promotions-discounts"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
}
},
"/v3/project/{project_id}/admin/promotion/redeemable/code/{code}": {
"get": {
"description": "プロモーションコードまたはクーポンコードを取得します。",
"operationId": "get-redeemable-promotion-by-code",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/code-path-param"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/200-admin-get-redeemable-by-code"
},
"401": {
"$ref": "#/components/responses/401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/404-code-not-found"
},
"405": {
"$ref": "#/components/responses/405-method-not-found"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "コードで引き換え可能なプロモーションを入手する",
"tags": [
"promotions-common"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
}
},
"/v3/project/{project_id}/admin/promotion/{promotion_id}/bonus": {
"delete": {
"description": "[ボーナスプロモーション](https://developers.xsolla.com/ja/doc/shop-builder/features/bonuses/)を削除します。削除されたプロモーション：\n* プロジェクトで設定されたプロモーションのリストから消えます。\n* アイテムカタログとカートに適用されなくなります。\n\n削除後、プロモーションを復元することはできません。",
"operationId": "delete-bonus-promotion",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/promotion_id-path-param"
}
],
"responses": {
"204": {
"description": "プロモーションは正常に削除されました。"
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/Promotions_404-admin-promotion"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "ボーナスプロモーションを削除",
"tags": [
"promotions-bonuses"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
},
"get": {
"description": "ボーナスプロモーションを取得します。\n\nプロモーションは、ユーザーによる購入に無料のボーナスアイテムを追加します。\nプロモーションは、プロジェクト内のすべての購入、または特定のアイテムを含む購入に適用することができます。",
"operationId": "get-bonus-promotion",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/promotion_id-path-param"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/Promotions_200-admin-get-bonus-promotion"
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/Promotions_404-admin-promotion"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "ボーナスプロモーションを取得",
"tags": [
"promotions-bonuses"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
},
"put": {
"description": "プロモーションを更新します。\n\n注意
新しいデータは古いデータに置き換わります。プロモーションの一部だけを更新したい場合は、必要なデータもすべてリクエストで転送する必要があります。
\n\nプロモーションは、ユーザーによる購入に無料のボーナスアイテムを追加します。\nプロモーションは、プロジェクト内のすべての購入、または特定のアイテムを含む購入に適用することができます。",
"operationId": "update-bonus-promotion",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/promotion_id-path-param"
}
],
"requestBody": {
"$ref": "#/components/requestBodies/Promotions_create-update-bonus-promotion"
},
"responses": {
"204": {
"description": "プロモーションは正常に更新されました。"
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-basic-auth"
},
"422": {
"$ref": "#/components/responses/Promotions_422-admin-promotion-missed-bonus-property"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "ボーナスプロモーションを更新",
"tags": [
"promotions-bonuses"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
}
},
"/v3/project/{project_id}/admin/promotion/{promotion_id}/item": {
"delete": {
"description": "[割引プロモーション](https://developers.xsolla.com/ja/doc/shop-builder/features/discounts/)を削除します。削除されたプロモーション：\n* プロジェクトで設定されたプロモーションのリストから消えます。\n* アイテムカタログとカートに適用されなくなります。\n\n削除後、プロモーションは復元できません。",
"operationId": "delete-item-promotion",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/promotion_id-path-param"
}
],
"responses": {
"204": {
"description": "プロモーションは正常に削除されました。"
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/Promotions_404-admin-promotion"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "アイテムプロモーションを削除",
"tags": [
"promotions-discounts"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
},
"get": {
"description": "特定のアイテムに適用されるプロモーションを取得します。\n\nプロモーションは、商品の割引（％）を提供します。\n指定した商品の全価格に割引が適用されます。",
"operationId": "get-item-promotion",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/promotion_id-path-param"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"discount": {
"percent": "20.00"
},
"excluded_promotions": [
23,
45
],
"id": 1,
"is_enabled": true,
"items": [
{
"sku": "com.xsolla.elven_helmet_1"
},
{
"sku": "com.xsolla.elven_armor_1"
}
],
"limits": {
"per_item": null,
"per_user": {
"total": 10
},
"recurrent_schedule": {
"per_user": {
"day_of_month": null,
"day_of_week": null,
"displayable_reset_next_date": "2023-02-28T11:00:00+08:00",
"displayable_reset_start_date": "2023-02-28T11:00:00+08:00",
"interval_type": "daily",
"reset_next_date": 1677553200,
"time": "11:00:00+08:00"
}
}
},
"name": {
"en-US": "Promotion",
"ru-RU": "Акция"
},
"price_conditions": [
{
"operator": "ge",
"value": "10.0000"
},
{
"operator": "le",
"value": "50.0000"
}
],
"promotion_periods": [
{
"date_from": "2020-04-15T18:16:00+05:00",
"date_until": "2020-04-25T18:16:00+05:00"
}
]
}
}
},
"schema": {
"example": {
"discount": {
"percent": "15.00"
},
"id": 1,
"is_enabled": true,
"items": [
{
"sku": "com.xsolla.elven_sword_1"
},
{
"sku": "com.xsolla.elven_helmet_1"
},
{
"sku": "com.xsolla.elven_armor_1"
}
],
"name": {
"en-US": "Promotion",
"ru-RU": "Акция"
},
"promotion_periods": [
{
"date_from": "2020-04-15T18:16:00+05:00",
"date_until": "2020-04-25T18:16:00+05:00"
}
]
},
"properties": {
"attribute_conditions": {
"$ref": "#/components/schemas/promotion_user-attribute_conditions_model-get"
},
"discount": {
"properties": {
"percent": {
"default": "10.00",
"description": "パーセントの割引\nこのパーセントで計算された値で、アイテムの価格が下がります。",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"excluded_promotions": {
"$ref": "#/components/schemas/excluded_promotions"
},
"id": {
"description": "プロモーションID。プロジェクト内での一意のプロモーション識別子。",
"type": "integer"
},
"is_enabled": {
"$ref": "#/components/schemas/Promotions_is_enabled"
},
"items": {
"items": {
"description": "割引の対象となるアイテムのリスト。",
"properties": {
"sku": {
"default": "elven_sword",
"description": "アイテムSKU。",
"type": "string"
}
},
"type": "object"
},
"type": [
"array",
"null"
]
},
"limits": {
"$ref": "#/components/schemas/Promotions_promotion_limits_response"
},
"name": {
"additionalProperties": {
"example": {
"en-US": "Promotion",
"ru-RU": "Акция"
},
"type": "string"
},
"description": "プロモーション名。キーと値のペアを含む必要があります。\nキーは\"^[a-z]{{2}-[A-Z]{2}$\"フォーマットのロケール、値は文字列です。",
"type": "object"
},
"price_conditions": {
"$ref": "#/components/schemas/price_conditions_discount"
},
"promotion_periods": {
"$ref": "#/components/schemas/promotion_periods"
}
},
"type": "object"
}
}
},
"description": "アイテムプロモーションは正常に受信されました。"
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-basic-auth"
},
"404": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"errorCode": 9502,
"errorMessage": "[0401-9502]: Can not find promotion with ID = 111425 in project 59080",
"statusCode": 404
}
}
},
"schema": {
"properties": {
"errorCode": {
"example": 9502,
"type": "integer"
},
"errorMessage": {
"example": "[0401-9502]: Can not find promotion with ID = 111425 in project 59080",
"type": "string"
},
"statusCode": {
"example": 404,
"type": "integer"
}
},
"type": "object"
}
}
},
"description": "プロモーションが見つかりません。`promotion_id`が正しいことを確認してください。"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "アイテムプロモーションを取得",
"tags": [
"promotions-discounts"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
},
"put": {
"description": "プロモーションを更新します。\n\n注意
新しいデータは古いデータに取って代わります。プロモーションの一部だけを更新したい場合は、必要なデータもすべてリクエストで転送する必要があります。
\n\nプロモーションは、商品の割引（％）を提供します。\n指定した商品の全価格に割引が適用されます。",
"operationId": "update-item-promotion",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/promotion_id-path-param"
}
],
"requestBody": {
"$ref": "#/components/requestBodies/Promotions_create-update-item-promotion"
},
"responses": {
"204": {
"description": "プロモーションは正常に更新されました。"
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/Promotions_404-admin-promotion"
},
"422": {
"$ref": "#/components/responses/Promotions_422-admin-promotion-missed-items-property"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "アイテムプロモーションを更新する",
"tags": [
"promotions-discounts"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
}
},
"/v3/project/{project_id}/admin/reward_chain": {
"get": {
"description": "報酬チェーンのリストを取得します。\n\n注意
すべてのプロジェクトには、応答で得られるアイテムの数に制限があります。初期値および最大値は、1応答あたり10アイテムです。ページごとにより多くのデータを取得するには、LIMITとOFFSETフィールドを使用してください。
",
"operationId": "admin-get-reward-chains",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/limit-query-param"
},
{
"$ref": "#/components/parameters/offset-query-param"
},
{
"$ref": "#/components/parameters/enabled-query-param"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/200-admin-get-list-reward-chains"
},
"401": {
"$ref": "#/components/responses/401-invalid-basic-auth"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "報酬チェーンのリストを取得する",
"tags": [
"reward-chain-value-points-admin"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
},
"post": {
"description": "報酬チェーンを作成します。",
"operationId": "admin-create-reward-chain",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
}
],
"requestBody": {
"$ref": "#/components/requestBodies/create-reward-chain"
},
"responses": {
"201": {
"$ref": "#/components/responses/201-admin-create-reward-chain"
},
"401": {
"$ref": "#/components/responses/401-invalid-basic-auth"
},
"422": {
"$ref": "#/components/responses/422-admin-create-update-rc-vp-invalid-request"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "報酬チェーンを作成する",
"tags": [
"reward-chain-value-points-admin"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
}
},
"/v3/project/{project_id}/admin/reward_chain/id/{reward_chain_id}": {
"delete": {
"description": "特定の報酬チェーンを削除します。",
"operationId": "admin-delete-reward-chain",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/reward_chain_id-path-param"
}
],
"responses": {
"204": {
"$ref": "#/components/responses/204-admin-delete-reward-chain"
},
"401": {
"$ref": "#/components/responses/401-invalid-basic-auth"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "報酬チェーンを削除する",
"tags": [
"reward-chain-value-points-admin"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
},
"get": {
"description": "特定の報酬チェーンを取得します。",
"operationId": "admin-get-reward-chain",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/reward_chain_id-path-param"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/200-admin-get-reward-chain"
},
"401": {
"$ref": "#/components/responses/401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/404-admin-reward-chain-not-found"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "報酬チェーンを取得する",
"tags": [
"reward-chain-value-points-admin"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
},
"put": {
"description": "特定の報酬チェーンを更新します。",
"operationId": "admin-update-reward-chain",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/reward_chain_id-path-param"
}
],
"requestBody": {
"$ref": "#/components/requestBodies/update-reward-chain"
},
"responses": {
"204": {
"$ref": "#/components/responses/204-admin-update-reward-chain"
},
"401": {
"$ref": "#/components/responses/401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/404-admin-reward-chain-not-found"
},
"422": {
"$ref": "#/components/responses/422-admin-create-update-rc-vp-invalid-request"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "報酬チェーンを更新する",
"tags": [
"reward-chain-value-points-admin"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
}
},
"/v3/project/{project_id}/admin/reward_chain/id/{reward_chain_id}/reset": {
"post": {
"description": "Resets the value points balance and progress of all users in the reward chain.
The balance is tied to the value points type, not to a specific reward chain. If these value points are used in other chains, the balance will be reset in all chains that use these value points.
After the reset, you can update the reward chain’s validity period, and users will be able to progress through it again.
The clan balance is calculated as the sum of its members’ balances. Therefore, after the reset, the clan balance is also reset.
This request is irreversible and applies to all users of the project.\n\nNotice\n
\n You should not reset the reward chain during its validity period. In this case, users may lose earned value points before they claim their reward.\n
",
"operationId": "admin-reset-reward-chain",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/reward_chain_id-path-param"
}
],
"responses": {
"204": {
"$ref": "#/components/responses/204-admin-reset-reward-chain"
},
"401": {
"$ref": "#/components/responses/401-invalid-basic-auth"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "報酬チェーンのリセット",
"tags": [
"reward-chain-value-points-admin"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
}
},
"/v3/project/{project_id}/admin/reward_chain/id/{reward_chain_id}/toggle": {
"put": {
"description": "報酬チェーンを有効/無効にします。",
"operationId": "admin-toggle-reward-chain",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/reward_chain_id-path-param"
}
],
"responses": {
"204": {
"$ref": "#/components/responses/204-admin-toggle-reward-chain"
},
"401": {
"$ref": "#/components/responses/401-invalid-basic-auth"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "報酬チェーンの切り替え",
"tags": [
"reward-chain-value-points-admin"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
}
},
"/v3/project/{project_id}/admin/unique_catalog_offer": {
"get": {
"description": "プロジェクトのユニークなカタログオファープロモーションのリストを取得します。",
"operationId": "get-unique-catalog-offers",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/limit-query-param"
},
{
"$ref": "#/components/parameters/offset-query-param"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/Promotions_200-get-unique-catalog-offers"
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-basic-auth"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "ユニークなカタログオファープロモーションのリストを取得します。",
"tags": [
"promotions-unique-catalog-offers"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
},
"post": {
"description": "ユニークなカタログオファープロモーションを作成します。",
"operationId": "admin-create-unique-catalog-offer",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
}
],
"requestBody": {
"$ref": "#/components/requestBodies/Promotions_unique_catalog_offer-create"
},
"responses": {
"201": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"external_id": "coupon_external_id"
}
}
},
"schema": {
"properties": {
"external_id": {
"$ref": "#/components/schemas/Promotions_coupon-external_id"
}
},
"type": "object"
}
}
},
"description": "ユニークなカタログオファーが正常に作成されました。"
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-basic-auth"
},
"422": {
"$ref": "#/components/responses/Promotions_422-invalid-coupon"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "ユニークなカタログオファープロモーションを作成する",
"tags": [
"promotions-unique-catalog-offers"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
}
},
"/v3/project/{project_id}/admin/unique_catalog_offer/{external_id}": {
"delete": {
"description": "[ユニークなカタログオファープロモーション](https://developers.xsolla.com/ja/doc/shop-builder/features/unique-offer/)を削除します。削除されたプロモーション：\n* プロジェクトで設定されたプロモーションのリストから消えます。\n* アイテムカタログとカートに適用されなくなります。\n\n削除後、プロモーションは復元できません。",
"operationId": "delete-unique-catalog-offer-promotion",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/external_id-promotion-path-param"
}
],
"responses": {
"204": {
"description": "ユニークなカタログオファーは正常に削除されました。"
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/Promotions_404-admin-coupon"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "ユニークなカタログオファープロモーションを削除",
"tags": [
"promotions-unique-catalog-offers"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
},
"get": {
"description": "指定されたユニークなカタログオファープロモーションを取得します。",
"operationId": "get-unique-catalog-offer",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/external_id-promotion-path-param"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"external_id": "secret_shop",
"is_enabled": true,
"items": [
"helmet",
"sword",
"shield"
],
"name": {
"en-US": "Secret shop",
"ru-RU": "Секретный магазин"
},
"promotion_periods": [
{
"date_from": "2020-04-15T18:16:00+05:00",
"date_until": "2020-04-25T18:16:00+05:00"
},
{
"date_from": "2020-05-15T18:16:00+05:00",
"date_until": "2020-05-25T18:16:00+05:00"
}
],
"redeem_code_limit": 1,
"redeem_total_limit": 100,
"redeem_user_limit": 1,
"total_limit_state": {
"available": 50,
"reserved": 10,
"used": 40
}
}
}
},
"schema": {
"$ref": "#/components/schemas/Promotions_200-get-unique-catalog-offer-promotion-model"
}
}
},
"description": "ユニークなカタログオファーは正常に受信されました。"
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/Promotions_404-admin-coupon"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "ユニークなカタログオファープロモーションを取得",
"tags": [
"promotions-unique-catalog-offers"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
},
"put": {
"description": "ユニークカタログオファープロモーションをアップデート",
"operationId": "update-unique-catalog-offer-promotion",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/external_id-promotion-path-param"
}
],
"requestBody": {
"$ref": "#/components/requestBodies/Promotions_unique_catalog_offer-update"
},
"responses": {
"204": {
"description": "ユニークカタログオファーは正常にアップデートされました。"
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/Promotions_404-admin-coupon"
},
"422": {
"$ref": "#/components/responses/Promotions_422-invalid-coupon"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "ユニークカタログオファープロモーションをアップデート",
"tags": [
"promotions-unique-catalog-offers"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
}
}
},
"servers": [
{
"url": "https://store.xsolla.com/api"
}
],
"tags": [
{
"description": "Promotions are marketing tools designed to attract new users and increase sales. Using Xsolla API, you can configure the following promotions:\n\n* Discounts — reduced prices on selected items.\n* Bonuses — items granted to users along with their purchase.\n* Coupons — codes that allow users to receive one or more bonus items when redeeming.\n* Promo codes — codes that allow users to receive bonus items, a discount on a specific item, or a discount on the entire cart. Unlike coupons that are redeemed after the user enters them, promo codes are redeemed during a purchase (at checkout).\n* Unique offers — hidden items displayed in the catalog to users who have entered a unique offer code. If the code is not entered, the items are not displayed.\n\nExample flow for configuring a discount promotion:\n1. Create items using the calls from the **Admin** subsection of the [Virtual items and currency](/ja/api/catalog/virtual-items-currency-admin/admin-get-virtual-items-list/), [Bundles](/ja/api/catalog/bundles-admin/admin-create-bundle), or [Game keys](/ja/api/catalog/game-keys-admin) groups.\n2. Create a promotion using the [Create discount promotion for item](/ja/api/liveops/promotions-discounts/create-item-promotion/) call. In the `items` array, pass the necessary item SKUs.\n3. Set up promotion validity periods. To do this, call the [Create discount promotion for item](/ja/api/liveops/promotions-discounts/create-item-promotion/) or [Update item promotion](/ja/api/liveops/promotions-discounts/update-item-promotion/) methods, and pass the `promotion_periods` field as an array of objects where `date_from` defines the start, and `date_until` defines the end date of the validity period.\n4. Activate a promotion using the [Update item promotion](/ja/api/liveops/promotions-discounts/update-item-promotion/) call. Pass the `\"is_enabled\": true` parameter.\n5. To get information about item prices, including discounted prices, call the client API methods for getting an item catalog from the [Common > Catalog](/ja/api/catalog/tag/common-catalog/), [Virtual Items and Currency > Catalog](/ja/api/catalog/virtual-items-currency-catalog/get-virtual-items/), and [Bundles > Catalog](/ja/api/catalog/bundles-catalog/get-bundle-list/) subsections.\n\n\n\nRefer to our documentation for detailed information about configuring promotions:\n* [Discounts](https://developers.xsolla.com/ja/liveops/promotion-tools/discounts/)\n* [Bonuses](https://developers.xsolla.com/ja/liveops/promotion-tools/bonuses/)\n* [Coupons](https://developers.xsolla.com/ja/liveops/promotion-tools/coupons/)\n* [Promo codes](https://developers.xsolla.com/ja/liveops/promotion-tools/promo-codes/)\n* [Unique catalog offers](https://developers.xsolla.com/ja/liveops/promotion-tools/unique-offer/)",
"name": "promotions-overview",
"x-displayName": "Overview"
},
{
"description": "You can call API methods from this subsection to manage different types of promotions.",
"name": "promotions-common",
"x-displayName": "Common API calls"
},
{
"description": "Call API methods from this subsection to configure and manage coupon promotions.\n\n\n
Note
\n
Refer to our documentation for detailed information about coupons.
\n
\n
Note
\n
Refer to our documentation for detailed information about promo codes.
\n
\n
Note
\n
Refer to our documentation for detailed information about unique offers.
\n
\n
Note
\n
Refer to our documentation for detailed information about discounts.
\n
\n
Note
\n
Refer to our documentation for detailed information about bonuses.
\n
\n
Note\n You can use only one personalization type. To change it, follow the\n
instructions.\n
\n
Note\nDetailed information is provided:\n
\n