` is the user token. The token identifies the user and provides access to personalized data. Alternatively, you can use a [token for opening the payment UI](/ko/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](/ko/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/ko/api/catalog/)\n- [Endpoint types](https://developers.xsolla.com/ko/api/catalog/)\n- [Errors handling](https://developers.xsolla.com/ko/api/catalog/)\n- [API keys](https://developers.xsolla.com/ko/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](/ko/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](/ko/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](/ko/api/catalog/virtual-items-currency-admin/admin-create-virtual-item)\n- [Create bundle](/ko/api/catalog/bundles-admin/admin-create-bundle)\n- [Create virtual currency](/ko/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](/ko/api/liveops/promotions-bonuses/create-bonus-promotion)\n- [Create daily reward](/ko/api/liveops/daily-chain-admin/admin-create-daily-chain)\n- [Create unique catalog offer promotion](/ko/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](/ko/api/catalog/virtual-items-currency-catalog/get-virtual-items)\n- [Get item group list](/ko/api/catalog/virtual-items-currency-catalog/get-item-groups)\n- [Get list of bundles](/ko/api/catalog/bundles-catalog/get-bundle-list)\n- [Get sellable items list](/ko/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](/ko/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](/ko/api/catalog/free-item/create-free-order-with-item) API call or the [Create order with free cart](/ko/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](/ko/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](/ko/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](/ko/api/shop-builder/operation/put-item-by-cart-id/) API call.\n - To remove an item, use the [Delete cart item by cart ID](/ko/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](/ko/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](/ko/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](/ko/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](/ko/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
알림
이 메서드는 페이지 매김된 아이템 목록을 반환합니다. 최대 및 기본 값은 응답당 아이템 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에 의해 하나 이상의 아이템에 대한 가치 포인트 수를 부분적으로 업데이트합니다. 사용자는 지정된 아이템을 구매한 후 이러한 가치 포인트를 받게 됩니다.\n\n가치 포인트 업데이트의 원칙:\n * 아이템에 아직 가치 포인트가 없는 경우 `amount` 필드에 0이 아닌 값을 보내면 가치 포인트가 생성됩니다.\n * 아이템에 이미 가치 포인트가 있는 경우 `amount` 필드에 0이 아닌 값을 보내면 가치 포인트가 업데이트됩니다.\n * `amount`를 0으로 설정하면 해당 아이템에 대한 기존 가치 포인트가 삭제됩니다.\n\n`PUT` 메서드([아이템에 대한 가치 포인트 설정](https://developers.xsolla.com/ko/api/shop-builder/operation/admin-set-items-value-point-reward/))와 달리 이 `PATCH` 메서드는 프로젝트의 아이템에 대한 모든 기존 가치 포인트를 덮어쓰지 않고 지정된 아이템만 업데이트합니다.\n\n단일 요청으로 최대 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별로 가치 포인트를 할당합니다. 사용자가 이러한 아이템을 구매하면 가치 포인트를 받습니다.\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참고
모든 프로젝트에서 단일 응답에 반환할 수 있는 아이템 수는 제한되어 있습니다. 기본값 및 최댓값은 응답당 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\n사용자 제한 API를 사용하면 사용자가 쿠폰을 사용할 수 있는 횟수를 제한할 수 있습니다. 사용자 제한 자체를 구성하려면 관리 섹션으로 이동합니다.\n* [쿠폰](https://developers.xsolla.com/ko/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\n사용자 제한 API를 사용하면 사용자가 프로모션 코드를 사용할 수 있는 횟수를 제한할 수 있습니다. 사용자 제한 자체를 구성하려면 관리 섹션으로 이동합니다.\n* [프로모션 코드](https://developers.xsolla.com/ko/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\n사용자 제한 API를 사용하면 사용자가 프로모션을 사용할 수 있는 횟수를 제한할 수 있습니다. 사용자 제한 자체를 구성하려면 원하는 프로모션 유형의 관리 섹션으로 이동합니다.\n* [할인 프로모션](https://developers.xsolla.com/ko/api/shop-builder/tag/promotions-discounts/)\n* [보너스 프로모션](https://developers.xsolla.com/ko/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\n사용자 제한 API를 사용하면 사용자가 프로모션을 사용할 수 있는 횟수를 제한할 수 있습니다. 사용자 제한 자체를 구성하려면 원하는 프로모션 유형의 관리 섹션으로 이동합니다.\n* [할인 프로모션](https://developers.xsolla.com/ko/api/shop-builder/tag/promotions-discounts/)\n* [보너스 프로모션](https://developers.xsolla.com/ko/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\n사용자 제한 API를 사용하면 사용자가 프로모션을 사용할 수 있는 횟수를 제한할 수 있습니다. 사용자 제한 자체를 구성하려면 원하는 프로모션 유형의 관리 섹션으로 이동합니다.\n* [할인 프로모션](https://developers.xsolla.com/ko/api/shop-builder/tag/promotions-discounts/)\n* [보너스 프로모션](https://developers.xsolla.com/ko/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\n사용자 제한 API를 사용하면 사용자가 프로모션을 사용할 수 있는 횟수를 제한할 수 있습니다. 사용자 제한 자체를 구성하려면 원하는 프로모션 유형의 관리 섹션으로 이동합니다.\n* [할인 프로모션](https://developers.xsolla.com/ko/api/shop-builder/tag/promotions-discounts/)\n* [보너스 프로모션](https://developers.xsolla.com/ko/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\n사용자 제한 API를 사용하면 사용자가 프로모션을 사용할 수 있는 횟수를 제한할 수 있습니다. 사용자 제한 자체를 구성하려면 원하는 프로모션 유형의 관리 섹션으로 이동합니다.\n* [할인 프로모션](https://developers.xsolla.com/ko/api/shop-builder/tag/promotions-discounts/)\n* [보너스 프로모션](https://developers.xsolla.com/ko/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\n사용자 제한 API를 사용하면 사용자가 프로모션을 사용할 수 있는 횟수를 제한할 수 있습니다. 사용자 제한 자체를 구성하려면 원하는 프로모션 유형의 관리 섹션으로 이동합니다.\n* [할인 프로모션](https://developers.xsolla.com/ko/api/shop-builder/tag/promotions-discounts/)\n* [보너스 프로모션](https://developers.xsolla.com/ko/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/ko/doc/shop-builder/features/coupons/)을 삭제합니다. 삭제된 프로모션:\n * 프로젝트에 설정된 프로모션 목록에서 사라집니다.\n * 더 이상 아이템 카탈로그에 적용되지 않습니다. 사용자는 이 프로모션으로 보너스 아이템을 얻을 수 없습니다.\n\n 삭제한 후에는 프로모션을 복원할 수 없습니다.\n 삭제된 프로모션의 쿠폰 코드는 기존 프로모션에 [추가](https://developers.xsolla.com/ko/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/ko/doc/shop-builder/features/promo-codes/)을 삭제합니다. 삭제된 프로모션:\n * 프로젝트에 설정된 프로모션 목록에서 사라집니다.\n * 아이템 카탈로그 및 장바구니에는 더 이상 적용되지 않습니다. 사용자는 이 프로모션을 사용하여 보너스 아이템을 얻거나 아이템을 구매할 수 없습니다.\n\n 삭제한 후에는 프로모션을 복원할 수 없습니다.\n 삭제된 프로모션의 프로모션 코드는 기존 프로모션에 [추가](https://developers.xsolla.com/ko/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/ko/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/ko/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주의
모든 프로젝트에는 응답에서 얻을 수 있는 아이템 수에 제한이 있습니다. 기본값과 최대값은 응답당 10개 아이템입니다. 페이지별로 더 많은 데이터 페이지를 가져오려면 한계 및 오프셋 필드를 사용합니다.
",
"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/ko/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](/ko/api/catalog/virtual-items-currency-admin/admin-get-virtual-items-list/), [Bundles](/ko/api/catalog/bundles-admin/admin-create-bundle), or [Game keys](/ko/api/catalog/game-keys-admin) groups.\n2. Create a promotion using the [Create discount promotion for item](/ko/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](/ko/api/liveops/promotions-discounts/create-item-promotion/) or [Update item promotion](/ko/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](/ko/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](/ko/api/catalog/tag/common-catalog/), [Virtual Items and Currency > Catalog](/ko/api/catalog/virtual-items-currency-catalog/get-virtual-items/), and [Bundles > Catalog](/ko/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/ko/liveops/promotion-tools/discounts/)\n* [Bonuses](https://developers.xsolla.com/ko/liveops/promotion-tools/bonuses/)\n* [Coupons](https://developers.xsolla.com/ko/liveops/promotion-tools/coupons/)\n* [Promo codes](https://developers.xsolla.com/ko/liveops/promotion-tools/promo-codes/)\n* [Unique catalog offers](https://developers.xsolla.com/ko/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