{ "openapi": "3.1.0", "info": { "description": "# Overview\n\n- **Version:** 2.0.0\n- **Servers:** `https://store.xsolla.com/api`\n- [Contact Us by Email](mailto:integration@xsolla.com)\n- **Contact URL:** https://xsolla.com/\n- **Required TLS version:** 1.2\n\nThe Catalog API allows you to configure a catalog of in-game items on the Xsolla side and display the catalog to users in your store.\n\nThe API allows you to manage the following catalog entities:\n\n* **Virtual items** — in-game items such as weapons, skins, boosters.\n* **Virtual currency** — virtual money used to purchase virtual goods.\n* **Virtual currency packages** — predefined bundles of virtual currency.\n* **Bundles** — combined packages of virtual items, currency, or game keys sold as a single SKU.\n* **Game keys** — keys for games and DLCs distributed via platforms like Steam or other DRM providers.\n* **Groups** — logical groupings for organizing and sorting items within the catalog.\n\n## API calls\n\nThe API is divided into the following groups:\n\n* **Admin** — calls for creating, updating, deleting, and configuring catalog items and groups. Authenticated via [basic access authentication](https://developers.xsolla.com/ko/payment-ui-and-flow/payment-ui/how-to-get-payment-token/#payments_solution_get_user_auth_token_basic_auth) with your merchant or project credentials. Not intended for storefront use.\n* **Catalog** — calls for retrieving items and building custom storefronts for end users. Designed to handle high-load scenarios. Support optional user JWT authorization to return personalized data such as user-specific limits and active promotions.\n\n# Authentication\n\nAPI calls require authentication either on behalf of a user or on behalf of a project. The authentication scheme used is specified in the **Security** section in the description of each call.\n\n## Authentication using user's JWT\n\nUser's JWT authentication is used when a request is sent from a browser, mobile application, or game. By default, the `XsollaLoginUserJWT` scheme is applied. For details on how to create a token, see the [Xsolla Login API documentation](/ko/api/login/authentication-schemes#getting-user-token).\n\nThe token is passed in the `Authorization` header in the following format: `Authorization: Bearer `, where `` is the user token. The token identifies the user and provides access to personalized data.\n\n또는 [결제 UI를 여는 토큰](/ko/api/pay-station/token/create-token)을 사용할 수 있습니다.\n\n## Basic HTTP authentication\n\nBasic HTTP authentication is used for server-to-server interactions, when an API call is sent directly from your server rather than from a user's browser or mobile application. HTTP Basic authentication with an [API key](/ko/api/getting-started/#api_keys_overview) is typically used.\n\n
Note

The API key is confidential and must not be stored or used in client applications.
\n\nWith basic server-side authentication, all API requests must include the following header:\n\n- for `basicAuth` — `Authorization: Basic `, where `your_authorization_basic_key` is the `project_id:api_key` pair encoded in Base64\n- for `basicMerchantAuth` — `Authorization: Basic `, where `your_authorization_basic_key` is the `merchant_id:api_key` pair encoded in Base64\n\nYou can find the parameter values in [Publisher Account](https://publisher.xsolla.com/):\n\n- `merchant_id` is displayed:\n - In **Company settings > Company**.\n - In the URL in the browser address bar on any Publisher Account page. The URL has the following format: `https://publisher.xsolla.com/`.\n- `project_id` is displayed:\n - Next to the project name in Publisher Account.\n - In the URL in the browser address bar when working on a project in Publisher Account. The URL has the following format: `https://publisher.xsolla.com//projects/`.\n- `api_key` is shown in Publisher Account only at the time of creation and must be stored securely on your side. You can create an API key in the following sections:\n - [Company settings > API keys](https://publisher.xsolla.com/0/settings/api_key)\n - [Project settings > API key](https://publisher.xsolla.com/0/projects/0/edit/api_key)\n\n
Notice

If a required API call doesn't include the project_id path parameter, use an API key that is valid across all company projects for authorization.
\n\nFor more information about working with API keys, see the [API references](/ko/api/getting-started/#api_keys_overview).\n\n## Authentication with guest access support\n\n이 `AuthForCart` 인증 체계는 장바구니 구매에 사용되며 두 가지 모드를 지원합니다.\n\n1. **Authentication with a user's JWT.** The token is passed in the `Authorization` header in the following format: `Authorization: Bearer `, where `` is the user token. The token identifies the user and provides access to personalized data.\nAlternatively, 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- [Webhooks](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\n
Note

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\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
\n\nTo enable or disable sandbox mode, change the value of the `sandbox` parameter in the request for fast purchase and cart purchase. Sandbox mode is off by default.\n\nPossible order statuses:\n- `new` — order created\n- `paid` — payment received\n- `done` — item delivered\n- `canceled` — order canceled\n- `expired` — order expired\n\nTrack order status using one of the following methods:\n- [webhooks configured on your server](/ko/virtual-goods/own-ui/server-side-token-generation/set-up-order-tracking/#payments_integration_order_tracking)\n- [short-polling](/ko/virtual-goods/own-ui/client-side-token-generation/set-up-order-tracking/#guides_shop_builder_integrate_store_get_order_status_via_short_polling)\n- [WebSocket API](/ko/virtual-goods/own-ui/client-side-token-generation/set-up-order-tracking/#guides_shop_builder_integrate_store_get_order_status_via_websocket_api)\n\n## Useful links\n\n- Authentication\n- [API calls by interaction model](/ko/api/catalog/section/authentication)\n- [Payment testing](/ko/dev-resources/testing/general-info/#general_overview)\n- [Set up order status tracking](/ko/virtual-goods/own-ui/client-side-token-generation/set-up-order-tracking/?link=200-api#payments_integration_order_tracking)\n- [Webhooks](/ko/webhooks/overview)\n- [Rate limits](/ko/api/login/rate-limits)\n- [Errors handling](/ko/api/getting-started/#api_errors_handling)\n- [API keys](/ko/api/getting-started/#api_keys_overview)\n\n# Pagination\n\nAPI calls that return large sets of records (for example, when building a catalog) return data in pages. Pagination is a mechanism that limits the number of items returned in a single API response and allows you to retrieve subsequent pages sequentially.\n\nUse the following parameters to control the number of returned items:\n\n- `limit` — number of items per page\n- `offset` — index of the first item on the page (numbering starts from 0)\n- `has_more` — indicates whether another page is available\n- `total_items_count` — total number of items\n\nExample request:\n\n```\nGET /items?limit=20&offset=40\n```\n\nResponse example:\n\n```json\n{\n \"items\": [...],\n \"has_more\": true,\n \"total_items_count\": 135\n}\n```\n\nIt is recommended to send subsequent requests until the response returns `has_more = false`.\n\n# Date and time format\n\nDates and time values are passed in the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.\n\nThe following are supported:\n\n- UTC offset\n- `null` value when there is no time restriction for displaying an item\n- [Unix timestamp](https://www.unixtimestamp.com/) (in seconds) used in some fields\n\nFormat: `YYYY-MM-DDTHH:MM:SS±HH:MM`\n\nExample: `2026-03-16T10:00:00+03:00`\n\n# Localization\n\nXsolla supports localization of user-facing fields such as item name and description. Localized values are passed as an object where the language code is used as the key. The full list of supported languages is available in the [documentation](/ko/doc/shop-builder/references/supported-languages/).\n\n**Supported fields**\n\nLocalization can be specified for the following parameters:\n\n- `name`\n- `description`\n- `long_description`\n\n**Locale format**\n\nThe locale key can be specified in one of the following formats:\n\n- Two-letter language code: `en`, `ru`\n- Five-letter language code: `en-US`, `ru-RU`, `de-DE`\n\n**Examples**\n\nExample with a two-letter language code:\n\n```json\n{\n \"name\": {\n \"en\": \"Starter Pack\",\n \"ru\": \"Стартовый набор\"\n }\n}\n```\n\nExample with a five-letter language code:\n\n```json\n{\n \"description\": {\n \"en-US\": \"Premium bundle\",\n \"de-DE\": \"Premium-Paket\"\n }\n}\n```\n\n# Country and currency determination\n\nThe user's country determines catalog prices, the payment currency, and available payment methods\nin the payment UI. Depending on the API call, the country is determined as follows:\n
    \n
  • In client-side API calls,\n the country is determined by the IP address of the request.
    • \n
  • In server-side API calls,\n the country is determined by the value of the user.country.value parameter or by the user's IP address\n from the X-User-Ip header. If both are passed, the user.country.value parameter takes precedence.
    • \n
\n\n
\n Note

\n Only IPv4 addresses are supported for country determination.\n Passing an IPv6 address may result in incorrect country\n and currency detection. If you use the server-side API call and cannot provide the user's IPv4 address,\n pass the country in the user.country.value parameter.\n
\n\n# Error response format\n\nIf an error occurs, the API returns an HTTP status and a JSON response body. The full list of store-related errors is available in the [documentation](/ko/dev-resources/references/errors/store-errors/).\n\n**Response example:**\n\n```json\n{\n \"errorCode\": 1102,\n \"errorMessage\": \"Validation error\",\n \"statusCode\": 422,\n \"transactionId\": \"c9e1a...\"\n}\n```\n\n- `errorCode` — error code.\n- `errorMessage` — short error description.\n- `statusCode` — HTTP response status.\n- `transactionId` — request ID. Returned only in some cases.\n- `errorMessageExtended` — additional error details, such as request parameters. Returned only in some cases.\n\n**Extended response example:**\n\n```json\n{\n \"errorCode\": 7001,\n \"errorMessage\": \"Chain not found\",\n \"errorMessageExtended\": {\n \"chain_id\": \"test_chain_id\",\n \"project_id\": \"test_project_id\",\n \"step_number\": 2\n },\n \"statusCode\": 404\n}\n```\n\n**Common HTTP status codes**\n\n- `400` — invalid request\n- `401` — authentication error\n- `403` — insufficient permissions\n- `404` — resource not found\n- `422` — validation error\n- `429` — rate limit exceeded\n\n**Recommendations**\n\n- Handle the HTTP status and the response body together.\n- Use `errorCode` to process errors related to application logic.\n- Use `transactionId` to identify requests more quickly when analyzing errors.", "version": "2.0.0", "title": "카탈로그 API" }, "servers": [ { "url": "https://store.xsolla.com/api" } ], "tags": [ { "name": "virtual-items-currency-overview", "x-displayName": "개요", "description": "가상 아이템과 인게임 재화를 사용하여 인게임 스토어를 구축하고 사용자에게 어떻게 디스플레이할지를 구성할 수 있습니다. 다음과 같은 아이템 유형이 제공됩니다:\n\n* 가상 아이템 - 무기, 스킨, 부스터와 같은 인게임 상품. 실제 돈이나 가상 머니로 판매할 수 있습니다.\n* 가상 머니 - 가상 아이템을 구매하는 데 사용되는 인게임 화폐. 실제 돈이나 인게임 재화로 판매할 수 있습니다.\n* 인게임 재화 패키지 - 고정된 양의 인게임 재화. 실제 돈이나 인게임 재화로 판매할 수 있습니다.\n\n그룹은 카탈로그에서 아이템을 구성하는 데 사용됩니다. 아이템을 논리적으로 그룹화하고 디스플레이 방식을 관리할 수 있습니다.\n\nAdmin 하위 섹션의 API 호출을 사용하여 아이템을 생성, 업데이트 및 삭제하세요.\n\nCatalog 하위 섹션의 API 호출을 사용하여 아이템 목록을 검색하고 사용자에게 디스플레이하세요.\n\n
\n 알림

\n 스토어 카탈로그를 작성하는 데 Admin 하위 섹션의 API 호출을 사용하지 마세요.\n
\n\n
\n\n
\n 참고

\n 가상 아이템 목록 가져오기 API 호출은 가격 및 특성을 포함한 자세한 아이템 데이터를 반환하며, 페이지 매김을 지원합니다. 스토어프론트에서 카탈로그 페이지를 표시하는 데 사용하세요.\n

\n 모든 가상 아이템 목록 가져오기 API 호출은 페이지 매김 없이 아이템 SKU, 이름, 설명, 그룹 ID 및 이름을 반환합니다. 클라이언트 측 검색 또는 색인에 사용하세요.\n
\n\n
\n\n인게임 재화로 구매할 경우, [인게임 재화로 구매한 지정된 아이템으로 주문 생성](/ko/api/catalog/virtual-payment/create-order-with-item-for-virtual-currency) API 호출을 사용하세요. 결제 UI는 필요하지 않으며, API 호출이 실행될 때 청구가 처리됩니다.\n\n인게임 재화를 사용한 구매 절차 예시:\n\n![인게임 재화를 사용한 구매 절차 예시](https://cdn.xsolla.net/developers/current/images/api_docs/virtual-items-currency-overview.png)" }, { "name": "virtual-items-currency-admin", "x-displayName": "관리자" }, { "name": "virtual-items-currency-catalog", "x-displayName": "카탈로그" }, { "name": "virtual-payment", "x-displayName": "가상 결제" }, { "name": "game-keys-overview", "x-displayName": "개요", "description": "게임 키는 게임 플랫폼에서 사용자가 게임이나 DLC에 접근할 수 있도록 해주는 일회용 고유 영숫자 코드입니다. [직접 링크](/ko/sell-games/set-up-selling-game-keys/#guides_game_sales_selling_game_keys_selling_via_direct_link), [스토어 UI](/ko/sell-games/set-up-selling-game-keys/#guides_game_sales_selling_game_keys_selling_via_store_ui), 또는 [위젯](/ko/sell-games/set-up-selling-game-keys/#guides_game_sales_selling_items_develop_buttons)을 통해 게임 키를 판매할 수 있습니다. 또한 [지역 제한 설정](/ko/items-catalog/catalog-features/regional-restrictions/)을 통해 특정 국가에서만 게임 키를 판매하도록 설정할 수 있습니다. 자세한 내용은 [게임 키 패키지](https://developers.xsolla.com/ko/items-catalog/items-type/set-up-modules/) 섹션을 참조해 주세요.\n\n게임 키를 판매하는 데 사용자 인증은 필요하지 않습니다. 키는 사용자가 결제 시 지정한 이메일 주소로 발송됩니다. 추가 시나리오를 활성화하기 위해 인증을 구성할 수 있습니다. [사용자 맞춤 설정](/ko/liveops/liveops-management/personalization-tutorial/), [구매 제한](/ko/items-catalog/catalog-features/items-catalog-number-limits/), 또는 [자격 시스템](/ko/sell-games/how-to/entitlement-system/). 자세한 내용은 [게임 키 판매 시 인증 설정 방법](/ko/sell-games/how-to/set-up-authentication/) 섹션을 참조해 주세요.\n\n게임 키 판매 절차:\n\n1. [게임 생성](/ko/api/catalog/game-keys-admin/admin-create-game) API 호출을 사용하여 게임을 생성합니다.\n2. 지역 제한을 구성합니다.\n3. [코드 업로드](/ko/api/catalog/game-keys-admin/admin-upload-codes-by-sku) API 호출을 사용하여 게임 키 패키지에 키를 업로드하고 구매가 가능하게 합니다.\n4. [게임 목록 가져오기](/ko/api/catalog/game-keys-catalog/get-games-list) API 호출을 사용하여 사용자의 지역에 맞는 가격이 포함된 게임 카탈로그를 표시합니다.\n5. 주문을 생성합니다. 빠른 구매를 위해 게임 키 SKU를 전달하여 [현재 장바구니의 모든 아이템으로 주문 생성](/ko/api/catalog/payment-client-side/create-order-with-item) API 호출을 사용할 수 있습니다. 응답으로 결제 UI를 열기 위한 토큰이 반환됩니다.\n6. 주문 결제를 위해 결제 UI 열기를 구현합니다.\n\n결제 성공 알림을 실시간으로 받고 사용자에게 아이템을 전달하려면, [웹훅](/ko/webhooks/section/osnovnye-polozheniya) 등을 사용하여 주문 상태 추적을 설정하세요. 키는 사용자가 결제 시 지정한 이메일로 전송되며, 주문 상태가 `done`으로 변경됩니다.\n\n![게임 키](https://cdn.xsolla.net/developers/current/images/api_docs/game-keys.svg)" }, { "name": "game-keys-catalog", "x-displayName": "카탈로그" }, { "name": "game-keys-entitlement", "x-displayName": "권한" }, { "name": "game-keys-admin", "x-displayName": "관리자" }, { "name": "bundles-overview", "x-displayName": "개요", "description": "번들은 하나의 단위로 판매되는 아이템 세트입니다. 번들에는 가상 아이템, 인게임 재화, 인게임 재화 패키지, 게임 키 및 기타 번들이 포함될 수 있습니다. 번들을 활용하여 스타터 팩, 시즌 한정 혜택 및 특별 상품을 구성해 보세요.\n\n번들을 처리하려면 다음 API 호출 그룹을 사용하세요.\n\n* 번들을 생성, 업데이트, 삭제하고 번들의 표시 여부를 관리하려면 관리자 섹션의 API 호출을 사용하세요.\n* 번들을 불러오려면 카탈로그 섹션의 API 호출을 사용하세요.\n\n구매 한도는 번들을 생성하거나 업데이트할 때 `limits` 개체를 통해 구성됩니다. 자세한 내용은 [한도](/ko/api/catalog/limits-overview) 개요를 참조해 주세요. [지역 제한](https://developers.xsolla.com/ko/items-catalog/catalog-features/regional-restrictions/)을 설정하여 특정 국가에서만 아이템을 판매할 수도 있습니다.\n\n
\n 참고

\n 번들 구성에 대한 자세한 내용은 번들 섹션을 참조해 주세요.\n
\n\n
\n\n번들 관리 시나리오:\n\n1. [번들 생성](/ko/api/catalog/bundles-admin/admin-create-bundle) API 호출을 사용하여 번들을 생성합니다. 생성한 번들을 확인하려면 [번들 가져오기](/ko/api/catalog/bundles-admin/admin-get-bundle) API 호출을 사용합니다. 프로젝트의 모든 번들을 검색하려면 [번들 목록 가져오기](/ko/api/catalog/bundles-admin/admin-get-bundle-list) API 호출을 사용합니다.\n2. 필요한 경우 [번들 업데이트](/ko/api/catalog/bundles-admin/admin-update-bundle) API 호출을 사용하여 번들 콘텐츠 또는 설정을 수정합니다.\n3. [번들 목록 가져오기](/ko/api/catalog/bundles-catalog/get-bundle-list), [지정한 번들 가져오기](/ko/api/catalog/bundles-catalog/get-bundle) 또는 [지정한 그룹별 번들 목록 가져오기](/ko/api/catalog/bundles-catalog/get-bundle-list-in-group) API 호출을 사용하여 스토어프론트에서 번들 표시 로직을 구현합니다.\n4. [장바구니 및 결제](/ko/api/catalog/cart-and-payment-overview) 섹션을 사용하여 주문을 생성합니다. 예를 들어 빠른 구매의 경우 번들 SKU를 전달하여 [지정한 아이템으로 주문 생성](/ko/api/catalog/payment-client-side/create-order-with-item) API 호출을 사용할 수 있습니다. 응답에는 결제 UI를 여는 데 필요한 토큰이 포함됩니다.\n5. 주문을 결제하기 위해 결제 UI 열기를 구현합니다.\n6. [웹훅](https://developers.xsolla.com/ko/webhooks/overview) 등을 사용하여 주문 상태 추적을 설정하면 성공적으로 결제된 아이템에 대한 데이터를 신속하게 수신하고 사용자에게 제공할 수 있습니다.\n\n![번들 관리 시나리오](https://cdn.xsolla.net/developers/current/images/api_docs/bundles.png)" }, { "name": "bundles-admin", "x-displayName": "관리자" }, { "name": "bundles-catalog", "x-displayName": "카탈로그" }, { "name": "cart-and-payment-overview", "x-displayName": "개요", "description": "장바구니는 여러 아이템을 하나의 주문으로 결합할 수 있는 구매 매커니즘입니다. 사용자는 실제 통화로 모든 유형의 아이템을 원하는 수량만큼 구매할 수 있으며, [프로모션 코드](https://developers.xsolla.com/ko/api/liveops/promotions-promo-codes)도 사용할 수 있습니다.\n\n장바구니는 엑솔라 측에 저장됩니다. 세션 간 장바구니 저장은 사용자의 인증 여부에 따라 달라집니다.\n * 인증된 사용자의 경우, 같은 사용자를 대신하여 요청이 전송되는 한 장바구니가 특정 사용자와 연결되어 세션 간에 저장됩니다.\n\n * [미인증 사용자](/ko/api/catalog/section/authentication/authentication-with-guest-access-support)의 경우, 장바구니 저장은 `x-unauthorized-id` 헤더 전달 여부에 따라 달라집니다. 미인증 사용자의 장바구니를 세션 간에 저장하려면 모든 요청에서 동일한 `x-unauthorized-id`를 전달합니다. 이 옵션은 게임 키 판매에만 사용할 수 있습니다.\n\n장바구니는 두 가지 방식, 즉 [사용자의 JWT](https://developers.xsolla.com/ko/api/catalog/section/authentication/authentication-using-user's-jwt)를 통해 자동으로 식별하거나 장바구니 ID(`cart_id`)로 식별할 수 있습니다.\n\n장바구니 관리는 클라이언트 측과 서버 측 모두에서 가능합니다.\n\n서버 측에서는 사용자 세션을 복원할 때와 같이 장바구니에 아이템을 채울 수 있습니다. 클라이언트 측에서 가능한 작업은 다음과 같습니다:\n\n* 현재 사용자의 장바구니 또는 ID로 장바구니 가져오기\n* 장바구니 채우기\n* 장바구니의 아이템 업데이트\n* 장바구니에서 아이템 삭제\n\n장바구니에서 아이템을 구매하려면 주문 생성을 위한 클라이언트 및 서버 호출을 사용합니다.\n\n장바구니의 유효 기간(TTL)은 기본적으로 72시간입니다. 새 아이템이 추가되는 등 콘텐츠가 변경되면 TTL이 연장됩니다.\n\n결제가 성공적으로 완료되어도 장바구니는 자동으로 비워지지 않습니다. 장바구니를 비우려면 다음 클라이언트 측 API 호출을 사용합니다.\n * [장바구니 ID로 모든 장바구니 아이템 삭제하기](/ko/api/catalog/cart-client-side/cart-clear-by-id).\n\n * [현재 장바구니에서 모든 장바구니 아이템 삭제하기](/ko/api/catalog/cart-client-side/cart-clear).\n\n * [장바구니 ID로 장바구니 아이템 삭제하기](/ko/api/catalog/cart-client-side/delete-item-by-cart-id) 및 [현재 장바구니에서 장바구니 아이템 삭제하기](/ko/api/catalog/cart-client-side/delete-item) - 장바구니에서 마지막 아이템을 삭제하면 장바구니가 비워집니다.\n\n장바구니 사용 시나리오:\n\n1. 사용자가 아이템을 선택할 스토어 UI를 구현합니다.\n\n2. 사용자가 스토어에서 아이템을 선택하면 해당 아이템을 장바구니에 추가합니다(예: [아이템으로 장바구니 채우기](https://developers.xsolla.com/ko/api/catalog/cart-client-side/cart-fill) 호출 사용). 아이템 배열에서 SKU와 필요한 아이템 수량을 전달해야 합니다.\n\n3. 장바구니 보기 UI를 구현합니다. 사용자가 장바구니로 이동하면 [현재 사용자의 장바구니 가져오기](https://developers.xsolla.com/ko/api/catalog/cart-client-side/get-user-cart) 호출을 사용하여 장바구니의 콘텐츠를 표시합니다. 응답은 할인 및 적용된 프로모션을 포함한 아이템의 최종 가격 정보를 반환합니다.\n\n4. 주문을 결제하기 위해 결제 UI 열기를 구현합니다. 예를 들어 [특정 장바구니의 모든 아이템으로 주문 생성](https://developers.xsolla.com/ko/api/catalog/payment-client-side/create-order-by-cart-id) 호출을 사용할 수 있습니다. 응답은 결제 UI를 여는 데 필요한 토큰을 반환합니다.\n\n5. [웹훅](https://developers.xsolla.com/ko/webhooks/) 등을 사용하여 주문 상태 추적을 구성하면 성공적으로 결제된 아이템에 대한 데이터를 신속하게 수신하고 사용자에게 제공할 수 있습니다.\n\n
\n

참고

\n

인게임 및 온라인에서 아이템을 판매하려면통합 가이드를 참조하세요.

\n
\n\n![장바구니 및 결제 절차](https://cdn.xsolla.net/developers/current/images/api_docs/cart-payment-flow.svg)" }, { "name": "order-life-cycle", "x-displayName": "주문 수명 주기", "description": "주문 수명 주기를 이해하면 [주문을 추적](https://developers.xsolla.com/ko/virtual-goods/own-ui/client-side-token-generation/set-up-order-tracking/?tabs=100-trackOrderOnClient_200-api&_xm=4170963201673921623))하고 아이템 배송과 같은 구매 후 로직을 올바르게 구현하는 데 도움이 됩니다.\n\n주문은 다음 단계들을 거칩니다:\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
상태설명참고
new 주문이 생성되었습니다. 시스템은 결제 확인을 기다리고 있습니다.거래 상태 설명은 페이 스테이션 API 문서에서 확인할 수 있습니다.
paid 주문 대금이 결제되었으며(거래 상태가 done로 변경됨), 해당 아이템을 사용자에게 제공할 수 있습니다. 결제가 확인될 때까지 주문은 new 상태로 남아 있습니다.
done 아이템이 사용자에게 부여됩니다. -
canceled 결제가 환불됩니다. 거래 상태가 refunded로 변경될 때 주문이 이 상태로 이동합니다.
expired 한정 아이템, 프로모션 코드 또는 프로모션에 대한 새 주문을 생성하면 해당 아이템이 포함된 기존 미결제 주문은 모두 expired 상태로 변경됩니다. 가장 최근에 주문한 상품에 대해서만 결제가 가능합니다. 사용자가 만료된 주문에 대해 비용 결제를 시도하면 2002 오류가 표시되며 결제가 실패합니다.
\n\n![주문 수명 주기](https://cdn.xsolla.net/developers/current/images/api_docs/order-life-cycle.svg)\n\n
\n

참고

\n

사용자가 결제를 완료하는 도중에 주문 상태가 expired로 변경되었으나 결제가 성공적으로 완료된 경우, 주문 상태는 expired에서 paid로 변경됩니다. 이는 결제 시 해당 주문 품목의 구매 한도를 초과하지 않는 경우에만 적용됩니다.

\n
" }, { "name": "cart-client-side", "x-displayName": "장바구니(클라이언트 측)", "description": "이 섹션의 호출을 사용하여 클라이언트 측에서 장바구니를 관리합니다." }, { "name": "cart-server-side", "x-displayName": "장바구니(서버 측)", "description": "이 섹션의 호출을 사용하여 서버 측에서 장바구니를 관리합니다." }, { "name": "payment-client-side", "x-displayName": "결제(클라이언트 측)", "description": "이 섹션의 호출을 사용하여 클라이언트 측에서 결제 토큰을 생성합니다." }, { "name": "payment-server-side", "x-displayName": "결제(서버 측)", "description": "이 섹션의 호출을 사용하여 서버 측에서 결제 토큰을 생성합니다." }, { "name": "order", "x-displayName": "주문", "description": "이 섹션의 호출을 사용하여 주문에 대한 정보를 얻습니다." }, { "name": "free-item", "x-displayName": "무료 아이템", "description": "이 섹션의 호출을 사용하여 사용자에게 무료 아이템을 제공하세요." }, { "name": "limits-overview", "x-displayName": "개요", "description": "구매 한도를 통해 단일 사용자 또는 모든 사용자가 구매할 수 있는 아이템 수량을 제한할 수 있습니다. 또한 예약된 한도 재설정을 구성할 수 있습니다.\n\n한도는 엑솔라 측에 저장되며 [관리자 페이지](https://publisher.xsolla.com/0/projects/0/storefront/virtual-items) 또는 다음 API 호출의 `limits` 객체를 통해 개별 아이템 수준에서 구성됩니다:\n* [가상 아이템 생성](/ko/api/catalog/virtual-items-currency-admin/admin-create-virtual-item)\n* [게임 생성](/ko/api/catalog/game-keys-admin/admin-create-game)\n* [가상 머니 생성](/ko/api/catalog/virtual-items-currency-admin/admin-create-virtual-currency)\n* [인게임 재화 패키지 생성](/ko/api/catalog/virtual-items-currency-admin/admin-create-virtual-currency-package)\n* [번들 생성](/ko/api/catalog/bundles-admin/admin-create-bundle)\n\n한도 정보는 아이템 카탈로그를 가져오는 다음 API 호출의 `items.limits` 객체에 반환됩니다:\n* [가상 아이템 목록 가져오기](/ko/api/catalog/virtual-items-currency-catalog/get-virtual-items)\n* [가상 머니 목록 가져오기](/ko/api/catalog/virtual-items-currency-catalog/get-virtual-currency)\n* [인게임 재화 패키지 목록 가져오기](/ko/api/catalog/virtual-items-currency-catalog/get-virtual-currency-packages)\n* [번들 목록 가져오기](/ko/api/catalog/bundles-catalog/get-bundle-list)\n* [게임 목록 가져오기](/ko/api/catalog/game-keys-catalog/get-games-list)\n\n**한도** 그룹의 **관리** 하위 섹션에 있는 API 호출은 현재 한도의 상태를 검색하고 특정 사용자에 대해 업데이트할 수 있도록 합니다. 예를 들어, 퀘스트 완료 후 카운터를 재설정하거나 남은 수량을 수동으로 조정할 수 있습니다.\n\n
\n 참고

\n 카탈로그에서 한도를 구성하는 방법에 대한 자세한 정보는 아이템 구매 한도 섹션을 참조하세요.\n
\n\n## 한도 유형\n\n다음 한도 유형을 구성할 수 있습니다:\n* [limits.per_item](/ko/api/catalog/virtual-items-currency-admin/admin-create-virtual-item#virtual-items-currency-admin/admin-create-virtual-item/t=request&path=limits/per_item) — 글로벌 아이템 구매 한도. 모든 사용자가 총 구매할 수 있는 최대 수량을 정의합니다.\n* [limits.per_user](/ko/api/catalog/virtual-items-currency-admin/admin-create-virtual-item#virtual-items-currency-admin/admin-create-virtual-item/t=request&path=limits/per_user) — 단일 사용자에 대한 구매 한도:\n * 인증되지 않은 사용자는 구매할 수 있는 최대 아이템 수량을 항상 볼 수 있습니다.\n * 인증된 사용자는 활성 한도가 적용된 남은 수량을 볼 수 있습니다.\n\n`limits.per_user`에 대해 다음 추가 설정이 가능합니다:\n* [limits.recurrent_schedule](/ko/api/catalog/virtual-items-currency-admin/admin-get-virtual-currencies-list#virtual-items-currency-admin/admin-get-virtual-currencies-list/t=response&c=200&path=items/limits/recurrent_schedule) - 예약된 한도 재설정 기간: 일간, 주간 또는 월간.\n* [limits.per_user.limit_exceeded_visibility](/ko/api/catalog/virtual-items-currency-admin/admin-get-virtual-currencies-list#virtual-items-currency-admin/admin-get-virtual-currencies-list/t=response&c=200&path=items/limits/per_user/limit_exceeded_visibility) - 구매 한도에 도달한 후에도 아이템이 카탈로그에 계속 표시되는지 여부. `limits.recurrent_schedule`이 구성된 경우에만 사용 가능합니다.\n\n## 구매 한도 구성 및 적용 시나리오\n\n아래 예시는 특정 사용자에 대한 구매 한도를 구성하는 시나리오를 설명합니다. 아이템은 `limit_exceeded_visibility: hide`로 구성되어 있으며, 한도에 도달하면 다음 예정된 재설정까지 카탈로그를 검색하는 API 호출에서 더 이상 반환되지 않습니다.\n\n1. **Admin** 하위 섹션의 [가상 아이템 및 가상 머니](/ko/api/catalog/virtual-items-currency-admin/admin-get-virtual-items-list/), [번들](/ko/api/catalog/bundles-admin/admin-create-bundle), 또는 [게임 키](/ko/api/catalog/game-keys-admin) 그룹의 API 호출을 사용하여 아이템을 생성하고 `limits` 객체를 전달합니다.\n\n```json\n{\n \"limits\": {\n \"per_user\": {\n \"total\": 5,\n \"limit_exceeded_visibility\": \"hide\"\n },\n \"recurrent_schedule\": {\n \"per_user\": {\n \"interval_type\": \"weekly\",\n \"time\": \"10:00:00+08:00\",\n \"day_of_week\": 5\n }\n }\n }\n}\n```\n\n2. 인증되지 않은 사용자에 대해 카탈로그를 요청합니다 - 응답은 사용자가 구매할 수 있는 최대 아이템 수량을 반환합니다.\n3. 사용자가 로그인합니다.\n4. 사용자의 인증 데이터를 사용하여 카탈로그를 요청합니다 - 응답은 적용된 활성 한도가 있는 남은 아이템 수량을 반환합니다.\n5. 사용자가 아이템을 선택하고 구매를 진행합니다.\n6. 결제가 성공적으로 완료되면, 엑솔라는 `per_user` 값을 업데이트합니다. `per_user`가 `0`에 도달하면, 해당 사용자를 위한 카탈로그를 검색하는 API 호출에서 더 이상 아이템이 반환되지 않습니다.\n7. **Management** 하위 섹션의 API 호출을 사용하여 한도를 업데이트할 수 있습니다: [사용자의 모든 구매 한도 새로 고침](/ko/api/catalog/user-limits-admin/reset-all-user-items-limit/), [특정 값 설정](/ko/api/catalog/user-limits-admin/set-user-item-limit/), [증가](/ko/api/catalog/user-limits-admin/add-user-item-limit/), 또는 [사용 가능한 수량 감소](/ko/api/catalog/user-limits-admin/remove-user-item-limit/).\n8. 사용자의 인증 데이터를 사용하여 다음 카탈로그 요청 시 `items.limits`에서 업데이트된 한도 값을 검색하고 사용자에게 표시합니다.\n\n![아이템 한도](https://cdn.xsolla.net/developers/current/images/api_docs/api-item-limits.png)" }, { "name": "user-limits-admin", "x-displayName": "관리" }, { "name": "connector-admin", "x-displayName": "관리자" }, { "name": "common-pre-orders", "x-displayName": "선주문" }, { "name": "common-merchant", "x-displayName": "판매자" }, { "name": "common-catalog", "x-displayName": "카탈로그", "description": "이 API를 사용하면 모든 종류의 판매할 수 있는 아이템 또는 특정 아이템을 가져올 수 있습니다." }, { "name": "common-regions", "x-displayName": "공통 지역", "description": "지역별 판매 제한을 사용하면 특정 국가 또는 국가 그룹에서 아이템 가용성을 관리할 수 있습니다. 예를 들어 라이선스 제한으로 특정 국가에서만 게임을 판매할 수 있습니다.\n\n제한은 지역을 사용하여 구성합니다. 각 지역은 하나의 `region_id` 식별자 아래 하나 이상의 국가를 그룹화합니다. 아이템을 하나 이상의 지역에 연결할 수 있습니다.\n\n아이템 가용성은 다음과 같이 결정됩니다.\n\n* 아이템에 지역이 지정되지 않은 경우 모든 국가에서 구매할 수 있습니다.\n* 아이템에 지역이 지정되어 있고 사용자의 국가가 해당 지역에 포함된 경우 이 사용자는 해당 아이템을 구매할 수 있습니다.\n* 아이템에 지역이 지정되어 있지만 사용자의 국가가 어느 지역에도 포함되지 않은 경우 이 사용자는 해당 아이템을 구매할 수 없습니다.\n\n**카탈로그** 하위 섹션의 API 호출을 통해 카탈로그를 요청할 때 사용자의 국가는 `country` 매개 변수로 전달됩니다. 이 매개 변수를 전달하지 않으면 사용자의 IP 주소를 기준으로 국가가 결정됩니다.\n\n사용자의 국가는 카탈로그 요청 시와 주문 생성 시 두 번 아이템의 지역과 대조하여 확인됩니다. 구매할 수 없는 아이템은 카탈로그 응답에 포함되지 않으며, 해당 아이템이 포함된 주문은 생성되지 않습니다.\n\n**공통 지역** 그룹의 API 호출을 사용하여 지역을 생성, 업데이트 및 삭제를 진행합니다.\n\n지역별 판매 제한 설정 절차:\n\n1. 국가 목록을 지정하고 [지역 생성](https://developers.xsolla.com/ko/api/catalog/common-regions/admin-create-region/) API 호출을 사용하여 지역을 생성합니다. 응답으로 다음 단계에 필요한 `region_id`가 반환됩니다.\n2. 가상 아이템의 `region_id`를 `regions` 배열에 전달하여 아이템을 [생성](https://developers.xsolla.com/ko/api/catalog/virtual-items-currency-admin/admin-create-virtual-item/)하거나 [업데이트](https://developers.xsolla.com/ko/api/catalog/virtual-items-currency-admin/admin-update-virtual-item/)하고 지역에 연결합니다.\n3. **카탈로그** 하위 섹션의 API 호출(예: [가상 아이템 목록 가져오기](https://developers.xsolla.com/ko/api/catalog/virtual-items-currency-catalog/get-virtual-items) API 호출)을 사용하여 사용자에게 카탈로그를 표시합니다. 사용자의 국가는 `country` 매개 변수로 결정되며, 이 매개 변수를 제공하지 않으면 사용자의 IP 주소를 기준으로 결정됩니다. 사용자의 국가에서 구매할 수 없는 아이템은 카탈로그 응답에 포함되지 않습니다.\n4. 사용자가 아이템 또는 장바구니 결제를 진행하면 주문을 생성합니다:\n * 아이템이 장바구니에 추가된 경우 [특정 장바구니의 모든 아이템으로 주문 생성](https://developers.xsolla.com/ko/api/catalog/payment-client-side/create-order) 또는 [현재 장바구니의 모든 아이템으로 주문 생성](https://developers.xsolla.com/ko/api/catalog/payment-client-side/create-order) API 호출을 사용합니다.\n * 단일 아이템을 바로 구매하는 경우 [특정 아이템으로 주문 생성](https://developers.xsolla.com/ko/api/catalog/payment-client-side/create-order-with-item) API 호출을 사용하고 아이템 SKU를 전달합니다.\n\n 응답에는 결제 UI를 여는 데 사용할 토큰이 포함됩니다.\n\n
\n 참고

\n엑솔라는 사용자의 국가가 아이템에 지정된 지역에 포함되어 있는지 확인합니다. 해당 국가가 아이템의 지역에 포함되어 있지 않으면 주문을 생성할 수 없습니다.\n
\n\n
\n\n5. 주문 결제를 위해 결제 UI를 여는 기능을 구현합니다.\n\n![공통 지역](https://cdn.xsolla.net/developers/current/images/api_docs/api-regions.svg)" }, { "name": "attribute-admin", "x-displayName": "관리자" }, { "name": "item-groups-admin", "x-displayName": "관리자" }, { "name": "item-groups-catalog", "x-displayName": "카탈로그" }, { "name": "common-webhooks", "x-displayName": "웹훅" } ], "paths": { "/v2/project/{project_id}/admin/items/virtual_items": { "get": { "summary": "가상 아이템 목록 가져오기", "description": "관리를 위해 프로젝트 내부의 가상 아이템 목록을 가져옵니다.\n\n
참고

상점 카탈로그를 작성에 이 엔드포인트를 사용하지 마세요.
", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/limit-query-param" }, { "$ref": "#/components/parameters/offset-query-param" } ], "tags": [ "virtual-items-currency-admin" ], "operationId": "admin-get-virtual-items-list", "x-badges": [ { "name": "Server-side", "color": "#95ff80" }, { "name": "Admin", "color": "#d7dee0" } ], "security": [ { "basicAuth": [] } ], "responses": { "200": { "$ref": "#/components/responses/Virtual-Items-Currency_200-admin-get-virtual-items" }, "401": { "$ref": "#/components/responses/Virtual-Items-Currency_401-invalid-basic-auth" } } }, "post": { "summary": "가상 아이템 생성하기", "description": "가상 아이템을 생성합니다.", "security": [ { "basicAuth": [] } ], "operationId": "admin-create-virtual-item", "x-badges": [ { "name": "Server-side", "color": "#95ff80" }, { "name": "Admin", "color": "#d7dee0" } ], "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" } ], "tags": [ "virtual-items-currency-admin" ], "requestBody": { "description": "
\n 참고

\n 요청 본문 구조에는 지역별 가격 책정, 구매 한도, 기간 한정 가용성과 같은 고급 사용 사례를 위한 선택적 매개 변수가 포함되어 있습니다. 기본 아이템을 생성하려면 sku, name 및 description 매개 변수를 지정하십시오. 인게임 재화로 가격을 설정하려면 prices 매개 변수를, 인게임 재화로 설정하려면 vc_prices매개 변수를 지정하십시오. 아이템을 무료로 제공하려면 is_free: true를 설정하십시오.\n
\n\n
", "$ref": "#/components/requestBodies/Virtual-Items-Currency_admin-create-virtual-item" }, "responses": { "201": { "$ref": "#/components/responses/Virtual-Items-Currency_201-created" }, "422": { "$ref": "#/components/responses/Virtual-Items-Currency_422-invalid-request" } } } }, "/v2/project/{project_id}/admin/items/virtual_items/group/external_id/{external_id}": { "get": { "summary": "지정한 그룹 외부 ID로 가상 아이템 목록 가져오기", "description": "관리를 위해 그룹 내부의 가상 아이템 목록을 가져옵니다.\n\n
참고

상점 카탈로그를 작성에 이 엔드포인트를 사용하지 마세요.
", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/external_id-group-path-param" }, { "$ref": "#/components/parameters/limit-query-param" }, { "$ref": "#/components/parameters/offset-query-param" } ], "tags": [ "virtual-items-currency-admin" ], "operationId": "admin-get-virtual-items-list-by-group-external-id", "x-badges": [ { "name": "Server-side", "color": "#95ff80" }, { "name": "Admin", "color": "#d7dee0" } ], "security": [ { "basicAuth": [] } ], "responses": { "200": { "$ref": "#/components/responses/Virtual-Items-Currency_200-admin-get-virtual-items-by-group" }, "401": { "$ref": "#/components/responses/Virtual-Items-Currency_401-invalid-basic-auth" } } } }, "/v2/project/{project_id}/admin/items/virtual_items/group/id/{group_id}": { "get": { "summary": "지정한 그룹 ID로 가상 아이템 목록 가져오기", "description": "관리를 위해 그룹 내부의 가상 아이템 목록을 가져옵니다.\n\n
참고

상점 카탈로그를 작성에 이 엔드포인트를 사용하지 마세요.
", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/group_id-path-param" }, { "$ref": "#/components/parameters/limit-query-param" }, { "$ref": "#/components/parameters/offset-query-param" } ], "tags": [ "virtual-items-currency-admin" ], "operationId": "admin-get-virtual-items-list-by-group-id", "x-badges": [ { "name": "Server-side", "color": "#95ff80" }, { "name": "Admin", "color": "#d7dee0" } ], "security": [ { "basicAuth": [] } ], "responses": { "200": { "$ref": "#/components/responses/Virtual-Items-Currency_200-admin-get-virtual-items-by-group" }, "401": { "$ref": "#/components/responses/Virtual-Items-Currency_401-invalid-basic-auth" } } } }, "/v2/project/{project_id}/admin/items/virtual_items/sku/{item_sku}": { "get": { "summary": "가상 아이템 가져오기", "description": "관리를 위해 프로젝트 내부의 가상 아이템을 가져옵니다.\n\n
참고

상점 카탈로그를 작성에 이 엔드포인트를 사용하지 마세요.
", "operationId": "admin-get-virtual-item", "x-badges": [ { "name": "Server-side", "color": "#95ff80" }, { "name": "Admin", "color": "#d7dee0" } ], "security": [ { "basicAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/item_sku-path-param" } ], "tags": [ "virtual-items-currency-admin" ], "responses": { "200": { "$ref": "#/components/responses/Virtual-Items-Currency_200-admin-get-item" }, "401": { "$ref": "#/components/responses/Virtual-Items-Currency_401-invalid-basic-auth" } } }, "put": { "summary": "가상 아이템 업데이트", "description": "가상 아이템을 업데이트합니다.", "operationId": "admin-update-virtual-item", "x-badges": [ { "name": "Server-side", "color": "#95ff80" }, { "name": "Admin", "color": "#d7dee0" } ], "security": [ { "basicAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/item_sku-path-param" } ], "tags": [ "virtual-items-currency-admin" ], "requestBody": { "description": "
\n 참고

\n 요청 본문 구조에는 지역별 가격 책정, 구매 한도, 기간 한정 가용성과 같은 고급 사용 사례를 위한 선택적 매개 변수가 포함되어 있습니다.\n
\n\n
\n\n
\n 주의

\n 업데이트할 필요가 없는 매개 변수를 포함하여 모든 아이템 매개 변수를 전달하십시오. 요청에서 생략된 매개 변수는 제거됩니다.\n
\n\n
", "$ref": "#/components/requestBodies/Virtual-Items-Currency_admin-create-virtual-item" }, "responses": { "204": { "description": "가상 아이템을 성공적으로 업데이트했습니다.", "content": {} }, "401": { "$ref": "#/components/responses/Virtual-Items-Currency_401-invalid-basic-auth" }, "422": { "$ref": "#/components/responses/Virtual-Items-Currency_422-invalid-request" } } }, "delete": { "summary": "가상 아이템 삭제", "description": "가상 아이템을 삭제합니다.", "operationId": "admin-delete-virtual-item", "x-badges": [ { "name": "Server-side", "color": "#95ff80" }, { "name": "Admin", "color": "#d7dee0" } ], "security": [ { "basicAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/item_sku-path-param" } ], "tags": [ "virtual-items-currency-admin" ], "responses": { "204": { "description": "가상 아이템을 성공적으로 삭제했습니다.", "content": {} }, "401": { "$ref": "#/components/responses/Virtual-Items-Currency_401-invalid-basic-auth" } } } }, "/v2/project/{project_id}/admin/items/virtual_currency": { "get": { "summary": "인게임 재화 목록 가져오기", "description": "관리를 위해 프로젝트 내부의 인게임 재화 목록을 가져옵니다.\n\n
참고

상점 카탈로그를 작성에 이 엔드포인트를 사용하지 마세요.
", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/limit-query-param" }, { "$ref": "#/components/parameters/offset-query-param" } ], "tags": [ "virtual-items-currency-admin" ], "operationId": "admin-get-virtual-currencies-list", "x-badges": [ { "name": "Server-side", "color": "#95ff80" }, { "name": "Admin", "color": "#d7dee0" } ], "security": [ { "basicAuth": [] } ], "responses": { "200": { "$ref": "#/components/responses/Virtual-Items-Currency_200-admin-get-virtual-currencies" }, "401": { "$ref": "#/components/responses/Virtual-Items-Currency_401-invalid-basic-auth" } } }, "post": { "summary": "인게임 재화 생성하기", "operationId": "admin-create-virtual-currency", "security": [ { "basicAuth": [] } ], "x-badges": [ { "name": "Server-side", "color": "#95ff80" }, { "name": "Admin", "color": "#d7dee0" } ], "description": "인게임 재화를 생성합니다.", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" } ], "tags": [ "virtual-items-currency-admin" ], "requestBody": { "$ref": "#/components/requestBodies/Virtual-Items-Currency_admin-create-virtual-currency" }, "responses": { "201": { "$ref": "#/components/responses/Virtual-Items-Currency_201-created" }, "422": { "$ref": "#/components/responses/Virtual-Items-Currency_422-invalid-request" } } } }, "/v2/project/{project_id}/admin/items/virtual_currency/sku/{virtual_currency_sku}": { "get": { "summary": "인게임 재화 가져오기", "description": "관리를 위해 프로젝트 내부의 인게임 재화를 가져옵니다.\n\n
참고

상점 카탈로그를 작성에 이 엔드포인트를 사용하지 마세요.
", "operationId": "admin-get-virtual-currency", "security": [ { "basicAuth": [] } ], "x-badges": [ { "name": "Server-side", "color": "#95ff80" }, { "name": "Admin", "color": "#d7dee0" } ], "tags": [ "virtual-items-currency-admin" ], "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/virtual_currency_sku-path-param" } ], "responses": { "200": { "$ref": "#/components/responses/Virtual-Items-Currency_200-admin-get-virtual-currency" }, "401": { "$ref": "#/components/responses/Virtual-Items-Currency_401-invalid-basic-auth" }, "404": { "$ref": "#/components/responses/Virtual-Items-Currency_404-item" } } }, "put": { "summary": "인게임 재화 업데이트", "description": "인게임 재화를 업데이트합니다.", "operationId": "admin-update-virtual-currency", "x-badges": [ { "name": "Server-side", "color": "#95ff80" }, { "name": "Admin", "color": "#d7dee0" } ], "security": [ { "basicAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/virtual_currency_sku-path-param" } ], "tags": [ "virtual-items-currency-admin" ], "requestBody": { "$ref": "#/components/requestBodies/Virtual-Items-Currency_admin-create-virtual-currency" }, "responses": { "204": { "description": "인게임 재화를 성공적으로 업데이트했습니다.", "content": {} }, "401": { "$ref": "#/components/responses/Virtual-Items-Currency_401-invalid-basic-auth" }, "422": { "$ref": "#/components/responses/Virtual-Items-Currency_422-invalid-request" } } }, "delete": { "summary": "인게임 재화 삭제", "description": "인게임 재화를 삭제합니다.", "operationId": "admin-delete-virtual-currency", "x-badges": [ { "name": "Server-side", "color": "#95ff80" }, { "name": "Admin", "color": "#d7dee0" } ], "security": [ { "basicAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/virtual_currency_sku-path-param" } ], "tags": [ "virtual-items-currency-admin" ], "responses": { "204": { "description": "인게임 재화를 성공적으로 삭제했습니다.", "content": {} }, "401": { "$ref": "#/components/responses/Virtual-Items-Currency_401-invalid-basic-auth" } } } }, "/v2/project/{project_id}/admin/items/virtual_currency/package": { "get": { "summary": "인게임 재화 패키지 목록 가져오기(관리자)", "description": "관리를 위해 프로젝트 내부의 인게임 재화 목록을 가져옵니다.\n\n
참고

상점 카탈로그를 작성에 이 엔드포인트를 사용하지 마세요.
", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/limit-query-param" }, { "$ref": "#/components/parameters/offset-query-param" } ], "tags": [ "virtual-items-currency-admin" ], "operationId": "admin-get-virtual-currency-packages-list", "x-badges": [ { "name": "Server-side", "color": "#95ff80" }, { "name": "Admin", "color": "#d7dee0" } ], "security": [ { "basicAuth": [] } ], "responses": { "200": { "$ref": "#/components/responses/Virtual-Items-Currency_200-admin-get-virtual-currency-packages" }, "401": { "$ref": "#/components/responses/Virtual-Items-Currency_401-invalid-basic-auth" } } }, "post": { "summary": "인게임 재화 패키지 생성하기", "description": "인게임 재화 패키지를 생성합니다.", "security": [ { "basicAuth": [] } ], "operationId": "admin-create-virtual-currency-package", "x-badges": [ { "name": "Server-side", "color": "#95ff80" }, { "name": "Admin", "color": "#d7dee0" } ], "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" } ], "tags": [ "virtual-items-currency-admin" ], "requestBody": { "$ref": "#/components/requestBodies/Virtual-Items-Currency_admin-create-virtual-currency-package" }, "responses": { "201": { "$ref": "#/components/responses/Virtual-Items-Currency_201-created" }, "401": { "$ref": "#/components/responses/Virtual-Items-Currency_401-invalid-basic-auth" }, "422": { "$ref": "#/components/responses/Virtual-Items-Currency_422-invalid-request" } } } }, "/v2/project/{project_id}/admin/items/virtual_currency/package/sku/{item_sku}": { "put": { "summary": "인게임 재화 패키지 업데이트", "description": "인게임 재화 패키지 업데이트", "operationId": "admin-update-virtual-currency-package", "x-badges": [ { "name": "Server-side", "color": "#95ff80" }, { "name": "Admin", "color": "#d7dee0" } ], "security": [ { "basicAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/item_sku-path-param" } ], "tags": [ "virtual-items-currency-admin" ], "requestBody": { "$ref": "#/components/requestBodies/Virtual-Items-Currency_admin-create-virtual-currency-package" }, "responses": { "204": { "description": "가상 아이템을 성공적으로 업데이트했습니다." }, "401": { "$ref": "#/components/responses/Virtual-Items-Currency_401-invalid-basic-auth" }, "422": { "$ref": "#/components/responses/Virtual-Items-Currency_422-invalid-request" } } }, "delete": { "summary": "인게임 재화 패키지 삭제", "description": "인게임 재화 패키지를 삭제합니다.", "operationId": "admin-delete-virtual-currency-package", "x-badges": [ { "name": "Server-side", "color": "#95ff80" }, { "name": "Admin", "color": "#d7dee0" } ], "security": [ { "basicAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/item_sku-path-param" } ], "tags": [ "virtual-items-currency-admin" ], "responses": { "204": { "description": "인게임 재화 패키지를 성공적으로 업데이트했습니다." }, "401": { "$ref": "#/components/responses/Virtual-Items-Currency_401-invalid-basic-auth" } } }, "get": { "summary": "인게임 재화 패키지 가져오기", "description": "관리를 위해 프로젝트 내부의 인게임 재화 패키지를 가져옵니다.\n\n
참고

상점 카탈로그를 작성에 이 엔드포인트를 사용하지 마세요.
", "operationId": "admin-get-virtual-currency-package", "x-badges": [ { "name": "Server-side", "color": "#95ff80" }, { "name": "Admin", "color": "#d7dee0" } ], "security": [ { "basicAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/item_sku-path-param" } ], "tags": [ "virtual-items-currency-admin" ], "responses": { "200": { "$ref": "#/components/responses/Virtual-Items-Currency_200-admin-get-virtual-currency-package" }, "401": { "$ref": "#/components/responses/Virtual-Items-Currency_401-invalid-basic-auth" } } } }, "/v2/project/{project_id}/items/virtual_items": { "get": { "summary": "가상 아이템 목록 가져오기", "description": "카탈로그 작성을 위해 아이템 목록을 가져옵니다.\n\n
\n 공지

\n 모든 프로젝트에는 응답에서 가져올 수 있는 아이템 수에 제한이 있습니다. 기본값 및 최대값은 응답당 50개 아이템입니다. 페이지별로 더 많은 데이터를 얻으려면 limit 및 offset 입력란을 사용하세요.\n
\n\n
\n\n
\n 참고

\n 이 API 호출은 인증 없이 사용될 때 일반적인 아이템 카탈로그 데이터를 반환합니다. 인증을 사용하여 아이템과 관련된 제한 및 프로모션과 같은 개인화된 사용자 데이터를 검색하세요. 이를 위해 Authorization 헤더에 사용자 JWT를 전달하십시오. 사용자 JWT에 대한 자세한 내용은 이 호출의 보안 블록을 참조하십시오.\n
\n\n
참고: 클라이언트 측 검색 또는 인덱싱을 위한 모든 가상 아이템 목록 가져오기 API 호출을 참조하세요.", "security": [ { "XsollaLoginUserJWT": [] } ], "operationId": "get-virtual-items", "x-badges": [ { "name": "Client-side", "color": "#80eaff" } ], "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/limit-query-param" }, { "$ref": "#/components/parameters/offset-query-param" }, { "$ref": "#/components/parameters/locale-query-param" }, { "$ref": "#/components/parameters/additional_fields-query-param" }, { "$ref": "#/components/parameters/country-query-param" }, { "$ref": "#/components/parameters/promo_code-query-param" }, { "$ref": "#/components/parameters/show_inactive_time_limited_items-query-param" } ], "tags": [ "virtual-items-currency-catalog" ], "responses": { "200": { "$ref": "#/components/responses/Virtual-Items-Currency_200-get-items-list" } } } }, "/v2/project/{project_id}/items/virtual_items/sku/{item_sku}": { "get": { "summary": "SKU별로 가상 아이템 가져오기", "description": "카탈로그 빌드를 위해 SKU별로 가상 아이템을 가져옵니다.\n\n
\n 알림

\n 이 API 호출은 인증 없이 사용될 때 일반적인 아이템 카탈로그 데이터를 반환합니다. 인증을 사용하여 아이템과 관련된 한도 및 프로모션과 같은 사용자 맞춤형 데이터를 검색하세요. 이를 위해 Authorization 헤더에 사용자 JWT를 전달하세요. 사용자 JWT에 대한 자세한 내용은 이 호출의 보안 블록을 참조하세요.\n
", "operationId": "get-virtual-items-sku", "x-badges": [ { "name": "Client-side", "color": "#80eaff" } ], "security": [ { "XsollaLoginUserJWT": [] } ], "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/item_sku-path-param" }, { "$ref": "#/components/parameters/locale-query-param" }, { "$ref": "#/components/parameters/country-query-param" }, { "$ref": "#/components/parameters/show_inactive_time_limited_items-query-param" }, { "$ref": "#/components/parameters/additional_fields-query-param" } ], "tags": [ "virtual-items-currency-catalog" ], "responses": { "200": { "$ref": "#/components/responses/Virtual-Items-Currency_200-get-item-by-sku" }, "404": { "$ref": "#/components/responses/Virtual-Items-Currency_404-item" } } } }, "/v2/project/{project_id}/items/virtual_items/all": { "get": { "summary": "모든 가상 아이템 목록 가져오기", "description": "클라이언트 측 검색을 위한 모든 가상 아이템 목록을 가져옵니다.\n\n
\n 알림

\n 아이템 SKU, 이름, 그룹 및 설명만 반환합니다.\n
\n\n
\n\n
\n 참고

\n 이 API 호출은 인증 없이 사용될 때 일반적인 아이템 카탈로그 데이터를 반환합니다. 인증을 사용하여 아이템과 관련된 제한 및 프로모션과 같은 개인화된 사용자 데이터를 검색하세요. 이를 위해 Authorization 헤더에 사용자 JWT를 전달하십시오. 사용자 JWT에 대한 자세한 내용은 이 호출의 보안 블록을 참조하십시오.\n
\n\n
참고: 페이지 매김을 통해 자세한 아이템 데이터를 검색하기 위한 가상 아이템 목록 가져오기 API 호출을 참조하세요.", "security": [ { "XsollaLoginUserJWT": [] } ], "operationId": "get-all-virtual-items", "x-badges": [ { "name": "Client-side", "color": "#80eaff" } ], "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/locale-query-param" }, { "$ref": "#/components/parameters/promo_code-query-param" } ], "tags": [ "virtual-items-currency-catalog" ], "responses": { "200": { "$ref": "#/components/responses/Virtual-Items-Currency_200-get-all-items-list" } } } }, "/v2/project/{project_id}/items/virtual_currency": { "get": { "summary": "인게임 재화 목록 가져오기", "description": "카탈로그 작성을 위해 인게임 재화 목록을 가져옵니다.\n\n
\n 주의

\n 모든 프로젝트에는 응답에서 가져올 수 있는 항목 수에 제한이 있습니다. 기본 및 최대 값은 응답당 50개 항목입니다. 페이지별로 더 많은 데이터를 얻으려면 limit 및 offset 입력란을 사용하세요.\n
\n\n
\n\n
\n 참고

\n 이 API 호출은 인증 없이 사용될 때 일반적인 아이템 카탈로그 데이터를 반환합니다. 인증을 사용하여 아이템과 관련된 제한 및 프로모션과 같은 개인화된 사용자 데이터를 검색하세요. 이를 위해 Authorization 헤더에 사용자 JWT를 전달하십시오. 사용자 JWT에 대한 자세한 내용은 이 호출의 보안 블록을 참조하십시오.\n
", "security": [ { "XsollaLoginUserJWT": [] } ], "operationId": "get-virtual-currency", "x-badges": [ { "name": "Client-side", "color": "#80eaff" } ], "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/limit-query-param" }, { "$ref": "#/components/parameters/offset-query-param" }, { "$ref": "#/components/parameters/locale-query-param" }, { "$ref": "#/components/parameters/additional_fields-query-param" }, { "$ref": "#/components/parameters/country-query-param" }, { "$ref": "#/components/parameters/promo_code-query-param" }, { "$ref": "#/components/parameters/show_inactive_time_limited_items-query-param" } ], "tags": [ "virtual-items-currency-catalog" ], "responses": { "200": { "$ref": "#/components/responses/Virtual-Items-Currency_200-get-virtual-currency-list" } } } }, "/v2/project/{project_id}/items/virtual_currency/sku/{virtual_currency_sku}": { "get": { "summary": "SKU별로 인게임 재화 가져오기", "description": "카탈로그 빌드를 위해 SKU별로 인게임 재화를 가져옵니다.\n\n
\n 참고

\n 이 API 호출은 인증 없이 사용될 때 일반적인 아이템 카탈로그 데이터를 반환합니다. 인증을 사용하여 아이템과 관련된 제한 및 프로모션과 같은 개인화된 사용자 데이터를 검색하세요. 이를 위해 Authorization 헤더에 사용자 JWT를 전달하십시오. 사용자 JWT에 대한 자세한 내용은 이 호출의 보안 블록을 참조하십시오.\n
", "operationId": "get-virtual-currency-sku", "x-badges": [ { "name": "Client-side", "color": "#80eaff" } ], "security": [ { "XsollaLoginUserJWT": [] } ], "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/virtual_currency_sku-path-param" }, { "$ref": "#/components/parameters/locale-query-param" }, { "$ref": "#/components/parameters/country-query-param" }, { "$ref": "#/components/parameters/show_inactive_time_limited_items-query-param" }, { "$ref": "#/components/parameters/additional_fields-query-param" } ], "tags": [ "virtual-items-currency-catalog" ], "responses": { "200": { "$ref": "#/components/responses/Virtual-Items-Currency_200-get-virtual-currency" } } } }, "/v2/project/{project_id}/items/virtual_currency/package": { "get": { "summary": "인게임 재화 패키지 목록 가져오기", "description": "카탈로그 작성을 위해 인게임 재화 패키지 목록을 가져옵니다.\n\n
\n 주의

\n 모든 프로젝트에는 응답에서 가져올 수 있는 항목 수에 제한이 있습니다. 기본 및 최대 값은 응답당 50개 항목입니다. 페이지별로 더 많은 데이터를 얻으려면 limit 및 offset 입력란을 사용하세요.\n
\n\n
\n\n
\n 참고

\n 이 API 호출은 인증 없이 사용될 때 일반적인 아이템 카탈로그 데이터를 반환합니다. 인증을 사용하여 아이템과 관련된 제한 및 프로모션과 같은 개인화된 사용자 데이터를 검색하세요. 이를 위해 Authorization 헤더에 사용자 JWT를 전달하십시오. 사용자 JWT에 대한 자세한 내용은 이 호출의 보안 블록을 참조하십시오.\n
", "security": [ { "XsollaLoginUserJWT": [] } ], "operationId": "get-virtual-currency-package", "x-badges": [ { "name": "Client-side", "color": "#80eaff" } ], "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/limit-query-param" }, { "$ref": "#/components/parameters/offset-query-param" }, { "$ref": "#/components/parameters/locale-query-param" }, { "$ref": "#/components/parameters/additional_fields-query-param" }, { "$ref": "#/components/parameters/country-query-param" }, { "$ref": "#/components/parameters/promo_code-query-param" }, { "$ref": "#/components/parameters/show_inactive_time_limited_items-query-param" } ], "tags": [ "virtual-items-currency-catalog" ], "responses": { "200": { "$ref": "#/components/responses/Virtual-Items-Currency_200-get-virtual-currency-packages-list" } } } }, "/v2/project/{project_id}/items/virtual_currency/package/sku/{virtual_currency_package_sku}": { "get": { "summary": "SKU별 인게임 재화 패키지 받기", "description": "카탈로그를 작성하기 위해 SKU별로 가상 재화 패키지를 가져옵니다.\n\n
\n 참고

\n 이 API 호출은 인증 없이 사용될 때 일반적인 아이템 카탈로그 데이터를 반환합니다. 인증을 사용하여 아이템과 관련된 제한 및 프로모션과 같은 개인화된 사용자 데이터를 검색하세요. 이를 위해 Authorization 헤더에 사용자 JWT를 전달하십시오. 사용자 JWT에 대한 자세한 내용은 이 호출의 보안 블록을 참조하십시오.\n
", "operationId": "get-virtual-currency-package-sku", "x-badges": [ { "name": "Client-side", "color": "#80eaff" } ], "security": [ { "XsollaLoginUserJWT": [] } ], "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/virtual_currency_package_sku-path-param" }, { "$ref": "#/components/parameters/locale-query-param" }, { "$ref": "#/components/parameters/country-query-param" }, { "$ref": "#/components/parameters/show_inactive_time_limited_items-query-param" }, { "$ref": "#/components/parameters/additional_fields-query-param" } ], "tags": [ "virtual-items-currency-catalog" ], "responses": { "200": { "$ref": "#/components/responses/Virtual-Items-Currency_200-get-virtual-currency-package" } } } }, "/v2/project/{project_id}/items/virtual_items/group/{external_id}": { "get": { "summary": "지정한 그룹으로 아이템 목록 가져오기", "description": "카탈로그 작성을 위해 지정된 그룹에서 아이템 목록을 가져옵니다.\n\n
\n 주의

\n 모든 프로젝트에는 응답에서 가져올 수 있는 항목 수에 제한이 있습니다. 기본 및 최대 값은 응답당 50개 항목입니다. 페이지별로 더 많은 데이터를 얻으려면 limit 및 offset 입력란을 사용하세요.\n
\n\n
\n\n
\n 참고

\n 이 API 호출은 인증 없이 사용될 때 일반적인 아이템 카탈로그 데이터를 반환합니다. 인증을 사용하여 아이템과 관련된 제한 및 프로모션과 같은 개인화된 사용자 데이터를 검색하세요. 이를 위해 Authorization 헤더에 사용자 JWT를 전달하십시오. 사용자 JWT에 대한 자세한 내용은 이 호출의 보안 블록을 참조하십시오.\n
", "operationId": "get-virtual-items-group", "x-badges": [ { "name": "Client-side", "color": "#80eaff" } ], "security": [ { "XsollaLoginUserJWT": [] } ], "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/external_id-group-path-param" }, { "$ref": "#/components/parameters/limit-query-param" }, { "$ref": "#/components/parameters/offset-query-param" }, { "$ref": "#/components/parameters/locale-query-param" }, { "$ref": "#/components/parameters/additional_fields-query-param" }, { "$ref": "#/components/parameters/country-query-param" }, { "$ref": "#/components/parameters/promo_code-query-param" }, { "$ref": "#/components/parameters/show_inactive_time_limited_items-query-param" } ], "tags": [ "virtual-items-currency-catalog" ], "responses": { "200": { "$ref": "#/components/responses/Virtual-Items-Currency_200-get-items-by-group-id" }, "404": { "$ref": "#/components/responses/Virtual-Items-Currency_404-item-group" } } } }, "/v2/project/{project_id}/items/virtual_currency/group/{external_id}": { "get": { "summary": "지정한 그룹으로 인게임 재화 목록 가져오기", "description": "카탈로그 작성을 위해 지정한 그룹에서 인게임 재화 목록을 가져옵니다.\n\n
\n 주의

\n 모든 프로젝트에는 응답에서 가져올 수 있는 항목 수에 제한이 있습니다. 기본 및 최대 값은 응답당 50개 항목입니다. 페이지별로 더 많은 데이터를 얻으려면 limit 및 offset 입력란을 사용하세요.\n
\n\n
\n\n
\n 참고

\n 이 API 호출은 인증 없이 사용될 때 일반적인 아이템 카탈로그 데이터를 반환합니다. 인증을 사용하여 아이템과 관련된 제한 및 프로모션과 같은 개인화된 사용자 데이터를 검색하세요. 이를 위해 Authorization 헤더에 사용자 JWT를 전달하십시오. 사용자 JWT에 대한 자세한 내용은 이 호출의 보안 블록을 참조하십시오.\n
", "operationId": "get-virtual-currency-group", "x-badges": [ { "name": "Client-side", "color": "#80eaff" } ], "security": [ { "XsollaLoginUserJWT": [] } ], "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/external_id-group-path-param" }, { "$ref": "#/components/parameters/limit-query-param" }, { "$ref": "#/components/parameters/offset-query-param" }, { "$ref": "#/components/parameters/locale-query-param" }, { "$ref": "#/components/parameters/additional_fields-query-param" }, { "$ref": "#/components/parameters/country-query-param" }, { "$ref": "#/components/parameters/promo_code-query-param" }, { "$ref": "#/components/parameters/show_inactive_time_limited_items-query-param" } ], "tags": [ "virtual-items-currency-catalog" ], "responses": { "200": { "$ref": "#/components/responses/Virtual-Items-Currency_200-get-virtual-currency-by-group-id" }, "404": { "$ref": "#/components/responses/Virtual-Items-Currency_404-item-group" } } } }, "/v2/project/{project_id}/items/virtual_currency/package/group/{external_id}": { "get": { "summary": "지정한 그룹으로 인게임 재화 패키지 목록 가져오기", "description": "카탈로그 작성을 위해 지정한 그룹에서 인게임 재화 패키지 목록을 가져옵니다.\n\n
\n 주의

\n 모든 프로젝트에는 응답에서 가져올 수 있는 항목 수에 제한이 있습니다. 기본 및 최대 값은 응답당 50개 항목입니다. 페이지별로 더 많은 데이터를 얻으려면 limit 및 offset 입력란을 사용하세요.\n
\n\n
\n\n
\n 참고

\n 이 API 호출은 인증 없이 사용될 때 일반적인 아이템 카탈로그 데이터를 반환합니다. 인증을 사용하여 아이템과 관련된 제한 및 프로모션과 같은 개인화된 사용자 데이터를 검색하세요. 이를 위해 Authorization 헤더에 사용자 JWT를 전달하십시오. 사용자 JWT에 대한 자세한 내용은 이 호출의 보안 블록을 참조하십시오.\n
", "operationId": "get-virtual-currency-package-group", "x-badges": [ { "name": "Client-side", "color": "#80eaff" } ], "security": [ { "XsollaLoginUserJWT": [] } ], "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/external_id-group-path-param" }, { "$ref": "#/components/parameters/limit-query-param" }, { "$ref": "#/components/parameters/offset-query-param" }, { "$ref": "#/components/parameters/locale-query-param" }, { "$ref": "#/components/parameters/additional_fields-query-param" }, { "$ref": "#/components/parameters/country-query-param" }, { "$ref": "#/components/parameters/promo_code-query-param" }, { "$ref": "#/components/parameters/show_inactive_time_limited_items-query-param" } ], "tags": [ "virtual-items-currency-catalog" ], "responses": { "200": { "$ref": "#/components/responses/Virtual-Items-Currency_200-get-virtual-currency-packages-by-group-id" }, "404": { "$ref": "#/components/responses/Virtual-Items-Currency_404-item-group" } } } }, "/v2/project/{project_id}/items/groups": { "get": { "summary": "아이템 그룹 목록 가져오기", "description": "페이지 매김 없이 카탈로그를 작성하기 위한 아이템 그룹 목록을 검색합니다.\n\n
Note

In general, the use of catalog of items is available without authorization.
Only authorized users can get a personalized catalog.
", "operationId": "get-item-groups", "x-badges": [ { "name": "Client-side", "color": "#80eaff" } ], "security": [], "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/locale-query-param" }, { "$ref": "#/components/parameters/with_geo-query-param" } ], "tags": [ "item-groups-catalog" ], "responses": { "200": { "$ref": "#/components/responses/Virtual-Items-Currency_200-get-items-groups" } } } }, "/v2/project/{project_id}/admin/items/groups": { "get": { "summary": "아이템 그룹 목록 가져오기", "description": "프로젝트 내의 모든 아이템 그룹 목록을 페이지 매김 없이 가져옵니다. 관리 목적으로 사용됩니다.\n\n
참고

스토어 카탈로그를 작성에 이 엔드포인트를 사용하지 마세요. 대신 아이템 그룹 목록 가져오기 클라이언트 측 엔드포인트를 사용하세요.
", "operationId": "admin-get-item-group-list", "x-badges": [ { "name": "Server-side", "color": "#95ff80" }, { "name": "Admin", "color": "#d7dee0" } ], "security": [ { "basicAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" } ], "tags": [ "item-groups-admin" ], "responses": { "200": { "$ref": "#/components/responses/ItemGroup_200-admin-get-group-list" }, "401": { "$ref": "#/components/responses/ItemGroup_401-invalid-basic-auth" } } }, "post": { "summary": "아이템 그룹 생성하기", "description": "프로젝트 내에 아이템 그룹을 생성합니다.\n카탈로그 작성을 위해 아이템 그룹을 가져오려면 아이템 그룹 목록 가져오기 클라이언트 측 엔드포인트를 사용하세요.", "operationId": "admin-create-item-group", "x-badges": [ { "name": "Server-side", "color": "#95ff80" }, { "name": "Admin", "color": "#d7dee0" } ], "security": [ { "basicAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" } ], "tags": [ "item-groups-admin" ], "requestBody": { "$ref": "#/components/requestBodies/ItemGroup_create" }, "responses": { "201": { "$ref": "#/components/responses/ItemGroup_201-admin-create-group" }, "401": { "$ref": "#/components/responses/ItemGroup_401-invalid-basic-auth" }, "422": { "$ref": "#/components/responses/ItemGroup_422-create-update" } } } }, "/v2/project/{project_id}/admin/items/groups/{external_id}": { "get": { "summary": "외부 ID로 아이템 그룹 가져오기", "description": "관리 목적으로 외부 ID로 아이템 그룹을 가져옵니다.\n\n
참고

스토어 카탈로그를 작성에 이 엔드포인트를 사용하지 마세요. 대신 아이템 그룹 목록 가져오기 클라이언트 측 엔드포인트를 사용하세요.
", "operationId": "admin-get-item-group", "x-badges": [ { "name": "Server-side", "color": "#95ff80" }, { "name": "Admin", "color": "#d7dee0" } ], "security": [ { "basicAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/external_id-group-path-param" } ], "tags": [ "item-groups-admin" ], "responses": { "200": { "$ref": "#/components/responses/ItemGroup_200-admin-get-group" }, "401": { "$ref": "#/components/responses/ItemGroup_401-invalid-basic-auth" }, "404": { "$ref": "#/components/responses/ItemGroup_404-group-not-found" } } }, "put": { "summary": "아이템 그룹 업데이트", "description": "외부 ID로 아이템 그룹을 업데이트합니다.", "operationId": "admin-update-item-group", "x-badges": [ { "name": "Server-side", "color": "#95ff80" }, { "name": "Admin", "color": "#d7dee0" } ], "security": [ { "basicAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/external_id-group-path-param" } ], "tags": [ "item-groups-admin" ], "requestBody": { "$ref": "#/components/requestBodies/ItemGroup_update" }, "responses": { "204": { "$ref": "#/components/responses/ItemGroup_204-admin-update-group" }, "401": { "$ref": "#/components/responses/ItemGroup_401-invalid-basic-auth" }, "404": { "$ref": "#/components/responses/ItemGroup_404-group-not-found" }, "422": { "$ref": "#/components/responses/ItemGroup_422-create-update" } } }, "delete": { "summary": "아이템 그룹 삭제", "description": "외부 ID로 아이템 그룹을 삭제합니다.", "operationId": "admin-delete-item-group", "x-badges": [ { "name": "Server-side", "color": "#95ff80" }, { "name": "Admin", "color": "#d7dee0" } ], "security": [ { "basicAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/external_id-group-path-param" } ], "tags": [ "item-groups-admin" ], "responses": { "204": { "$ref": "#/components/responses/ItemGroup_204-admin-delete-group" }, "401": { "$ref": "#/components/responses/ItemGroup_401-invalid-basic-auth" }, "404": { "$ref": "#/components/responses/ItemGroup_404-group-not-found" }, "422": { "$ref": "#/components/responses/ItemGroup_422-delete" } } } }, "/v2/project/{project_id}/admin/items/{item_type}/groups": { "get": { "summary": "아이템 유형으로 필터링된 아이템 그룹 목록 가져오기", "description": "아이템 유형으로 필터링하여 아이템 그룹 목록을 가져옵니다. 지정된 유형의 아이템만 해당 그룹에 포함됩니다. 이는 [아이템 그룹 목록 가져오기](/ko/api/catalog/item-groups-admin/admin-get-item-group-list) 엔드포인트와 유사하지만, 아이템을 집계할 때 유형이 추가 필터링으로 적용된다는 점이 다릅니다.", "operationId": "admin-get-item-group-list-by-item-type", "x-badges": [ { "name": "Server-side", "color": "#95ff80" }, { "name": "Admin", "color": "#d7dee0" } ], "security": [ { "basicAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/item_type-group-path-param" } ], "tags": [ "item-groups-admin" ], "responses": { "200": { "$ref": "#/components/responses/ItemGroup_200-admin-get-group-list-by-item-type" }, "401": { "$ref": "#/components/responses/ItemGroup_401-invalid-basic-auth" } } } }, "/v2/project/{project_id}/admin/items/{item_type}/groups/{external_id}": { "get": { "summary": "아이템 유형으로 필터링된 외부 ID로 아이템 그룹 가져오기", "description": "외부 ID로 아이템 그룹을 가져옵니다. 지정된 유형의 아이템만 해당 그룹에 포함됩니다. 이는 [외부 ID로 아이템 그룹 가져오기](/ko/api/catalog/item-groups-admin/admin-get-item-group) 엔드포인트와 유사하지만, 아이템을 집계할 때 유형이 추가 필터링으로 적용된다는 점이 다릅니다.", "operationId": "admin-get-item-group-by-item-type", "x-badges": [ { "name": "Server-side", "color": "#95ff80" }, { "name": "Admin", "color": "#d7dee0" } ], "security": [ { "basicAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/item_type-group-path-param" }, { "$ref": "#/components/parameters/external_id-group-path-param" } ], "tags": [ "item-groups-admin" ], "responses": { "200": { "$ref": "#/components/responses/ItemGroup_200-admin-get-group-by-item-type" }, "401": { "$ref": "#/components/responses/ItemGroup_401-invalid-basic-auth" }, "404": { "$ref": "#/components/responses/ItemGroup_404-group-not-found" } } } }, "/v2/project/{project_id}/admin/group/order": { "put": { "summary": "아이템 그룹 재정렬", "description": "프로젝트 내 아이템 그룹의 표시 순서를 설정합니다. 그룹의 새로운 순서 값을 포함한 목록을 전달하세요.", "operationId": "admin-reorder-item-groups", "x-badges": [ { "name": "Server-side", "color": "#95ff80" }, { "name": "Admin", "color": "#d7dee0" } ], "security": [ { "basicAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" } ], "tags": [ "item-groups-admin" ], "requestBody": { "$ref": "#/components/requestBodies/ItemGroup_order" }, "responses": { "204": { "$ref": "#/components/responses/ItemGroup_204-admin-reorder-groups" }, "401": { "$ref": "#/components/responses/ItemGroup_401-invalid-basic-auth" }, "404": { "$ref": "#/components/responses/ItemGroup_404-reorder-groups-not-found" }, "422": { "$ref": "#/components/responses/ItemGroup_422-ordering" } } } }, "/v2/project/{project_id}/admin/group/{external_id}/order/item": { "put": { "summary": "그룹 내 아이템 재정렬(외부 ID 기준)", "description": "외부 ID로 식별된 그룹 내 아이템의 표시 순서를 설정합니다. 아이템의 새로운 순서 값을 포함한 배열을 전달하세요.", "operationId": "admin-reorder-items-in-group", "x-badges": [ { "name": "Server-side", "color": "#95ff80" }, { "name": "Admin", "color": "#d7dee0" } ], "security": [ { "basicAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/external_id-group-path-param" } ], "tags": [ "item-groups-admin" ], "requestBody": { "$ref": "#/components/requestBodies/ItemGroup_item_order" }, "responses": { "204": { "$ref": "#/components/responses/ItemGroup_204-admin-reorder-items" }, "401": { "$ref": "#/components/responses/ItemGroup_401-invalid-basic-auth" }, "404": { "$ref": "#/components/responses/ItemGroup_404-reorder-items-by-external-id-not-found" }, "422": { "$ref": "#/components/responses/ItemGroup_422-ordering" } } } }, "/v2/project/{project_id}/admin/group/id/{id}/order/item": { "put": { "summary": "그룹 내 아이템 재정렬(ID 기준)", "description": "내부 숫자 ID로 식별된 그룹 내 아이템의 표시 순서를 설정합니다. 아이템의 새로운 순서 값을 포함한 목록을 전달하세요.", "operationId": "admin-reorder-items-in-group-by-id", "x-badges": [ { "name": "Server-side", "color": "#95ff80" }, { "name": "Admin", "color": "#d7dee0" } ], "security": [ { "basicAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/id-group-path-param" } ], "tags": [ "item-groups-admin" ], "requestBody": { "$ref": "#/components/requestBodies/ItemGroup_item_order" }, "responses": { "204": { "$ref": "#/components/responses/ItemGroup_204-admin-reorder-items" }, "401": { "$ref": "#/components/responses/ItemGroup_401-invalid-basic-auth" }, "404": { "$ref": "#/components/responses/ItemGroup_404-reorder-items-by-id-not-found" }, "422": { "$ref": "#/components/responses/ItemGroup_422-ordering" } } } }, "/v2/project/{project_id}/payment/item/{item_sku}/virtual/{virtual_currency_sku}": { "post": { "summary": "특정 아이템을 인게임 재화로 구매하는 주문 생성", "description": "인게임 재화를 사용하여 아이템 구매를 생성합니다.
\n\n
\n 참고

\n 이 API 호출은 인증 없이 사용될 때 일반적인 아이템 카탈로그 데이터를 반환합니다. 인증을 사용하여 아이템과 관련된 제한 및 프로모션과 같은 개인화된 사용자 데이터를 검색하세요. 이를 위해 Authorization 헤더에 사용자 JWT를 전달하십시오. 사용자 JWT에 대한 자세한 내용은 이 호출의 보안 블록을 참조하십시오.\n
", "operationId": "create-order-with-item-for-virtual-currency", "x-badges": [ { "name": "Client-side", "color": "#80eaff" } ], "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/item_sku-path-param" }, { "$ref": "#/components/parameters/virtual_currency_sku-path-param" }, { "$ref": "#/components/parameters/platform-query-param" } ], "tags": [ "virtual-payment" ], "security": [ { "XsollaLoginUserJWT": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "custom_parameters": { "$ref": "#/components/schemas/Cart-Payment_custom_parameters" } } }, "example": { "custom_parameters": { "array_param": [ { "object1": { "param": "https://xsolla.com" }, "property": { "int_property": 112, "string_property": "xsolla" } }, { "object2": { "param": "https://developers.xsolla.com/ko" }, "property": { "int_property": 112, "string_property": "email@example.com" } } ], "object_param": { "key": "value" }, "bool_param": true, "int_param": 100, "null_param": null } } } } }, "responses": { "200": { "$ref": "#/components/responses/Virtual-Items-Currency_200-quick-purchase" }, "404": { "$ref": "#/components/responses/Virtual-Items-Currency_404-item" }, "422": { "$ref": "#/components/responses/Virtual-Items-Currency_422-not-enough-virtual-currency" } } } }, "/v2/project/{project_id}/items/game": { "get": { "summary": "게임 목록 가져오기", "description": "카탈로그 작성을 위해 게임 목록을 가져옵니다.\n\n
\n 주의

\n 모든 프로젝트에는 응답에서 가져올 수 있는 항목 수에 제한이 있습니다. 기본 및 최대 값은 응답당 50개 항목입니다. 페이지별로 더 많은 데이터를 얻으려면 limit 및 offset 입력란을 사용하세요.\n
\n\n
\n\n
\n 참고

\n 이 API 호출은 인증 없이 사용될 때 일반적인 아이템 카탈로그 데이터를 반환합니다. 인증을 사용하여 아이템과 관련된 제한 및 프로모션과 같은 개인화된 사용자 데이터를 검색하세요. 이를 위해 Authorization 헤더에 사용자 JWT를 전달하십시오. 사용자 JWT에 대한 자세한 내용은 이 호출의 보안 블록을 참조하십시오.\n
", "security": [ { "XsollaLoginUserJWT": [] } ], "tags": [ "game-keys-catalog" ], "operationId": "get-games-list", "x-badges": [ { "name": "Client-side", "color": "#80eaff" } ], "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/limit-query-param" }, { "$ref": "#/components/parameters/offset-query-param" }, { "$ref": "#/components/parameters/locale-query-param" }, { "$ref": "#/components/parameters/additional_fields-query-param" }, { "$ref": "#/components/parameters/country-query-param" }, { "$ref": "#/components/parameters/promo_code-query-param" }, { "$ref": "#/components/parameters/show_inactive_time_limited_items-query-param" } ], "responses": { "200": { "$ref": "#/components/responses/Game-Keys_200-get-games-catalog" } } } }, "/v2/project/{project_id}/items/game/group/{external_id}": { "get": { "summary": "지정한 그룹으로 게임 목록 가져오기", "description": "카탈로그 작성을 위해 지정된 그룹에서 게임 목록을 가져옵니다.\n\n
\n 주의

\n 모든 프로젝트에는 응답에서 가져올 수 있는 항목 수에 제한이 있습니다. 기본 및 최대 값은 응답당 50개 항목입니다. 페이지별로 더 많은 데이터를 얻으려면 limit 및 offset 입력란을 사용하세요.\n
\n\n
\n\n
\n 참고

\n 이 API 호출은 인증 없이 사용될 때 일반적인 아이템 카탈로그 데이터를 반환합니다. 인증을 사용하여 아이템과 관련된 제한 및 프로모션과 같은 개인화된 사용자 데이터를 검색하세요. 이를 위해 Authorization 헤더에 사용자 JWT를 전달하십시오. 사용자 JWT에 대한 자세한 내용은 이 호출의 보안 블록을 참조하십시오.\n
", "security": [ { "XsollaLoginUserJWT": [] } ], "tags": [ "game-keys-catalog" ], "operationId": "get-games-group", "x-badges": [ { "name": "Client-side", "color": "#80eaff" } ], "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/external_id-group-path-param" }, { "$ref": "#/components/parameters/limit-query-param" }, { "$ref": "#/components/parameters/offset-query-param" }, { "$ref": "#/components/parameters/locale-query-param" }, { "$ref": "#/components/parameters/additional_fields-query-param" }, { "$ref": "#/components/parameters/country-query-param" }, { "$ref": "#/components/parameters/promo_code-query-param" }, { "$ref": "#/components/parameters/show_inactive_time_limited_items-query-param" } ], "responses": { "200": { "$ref": "#/components/responses/Game-Keys_200-get-games-catalog" } } } }, "/v2/project/{project_id}/items/game/sku/{item_sku}": { "get": { "summary": "카탈로그에 게임 가져오기", "description": "카탈로그용 게임을 가져옵니다.\n\n
\n 참고

\n 이 API 호출은 인증 없이 사용될 때 일반적인 아이템 카탈로그 데이터를 반환합니다. 인증을 사용하여 아이템과 관련된 제한 및 프로모션과 같은 개인화된 사용자 데이터를 검색하세요. 이를 위해 Authorization 헤더에 사용자 JWT를 전달하십시오. 사용자 JWT에 대한 자세한 내용은 이 호출의 보안 블록을 참조하십시오.\n
", "tags": [ "game-keys-catalog" ], "operationId": "get-game-by-sku", "x-badges": [ { "name": "Client-side", "color": "#80eaff" } ], "security": [ { "XsollaLoginUserJWT": [] } ], "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "name": "item_sku", "in": "path", "required": true, "description": "아이템 SKU입니다.", "schema": { "type": "string", "default": "full_game_1" } }, { "$ref": "#/components/parameters/locale-query-param" }, { "$ref": "#/components/parameters/additional_fields-query-param" }, { "$ref": "#/components/parameters/country-query-param" }, { "$ref": "#/components/parameters/promo_code-query-param" }, { "$ref": "#/components/parameters/show_inactive_time_limited_items-query-param" } ], "responses": { "200": { "description": "게임을 성공적으로 수신했습니다.", "content": { "application/json": { "schema": { "type": "object", "description": "게임 정보가 있는 개체입니다.", "properties": { "sku": { "type": "string", "example": "game_01", "description": "고유 아이템 ID입니다. SKU는 소문자 및 대문자 라틴 영숫자, 마침표, 대시 및 밑줄만 포함할 수 있습니다." }, "name": { "type": "string", "example": "Game name", "description": "아이템 이름입니다." }, "groups": { "$ref": "#/components/schemas/items_client_groups_response" }, "attributes": { "$ref": "#/components/schemas/Game-Keys_schemas-client-attributes" }, "type": { "type": "string", "example": "unit", "description": "아이템의 유형: `virtual_good`/`virtual_currency`/`bundle`/`physical_good`/`unit`." }, "unit_type": { "type": "string", "example": "game", "description": "유닛의 유형: `game`." }, "description": { "type": "string", "example": "Game description", "description": "아이템 설명입니다." }, "image_url": { "type": "string", "example": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png", "description": "이미지 URL입니다." }, "promotions": { "$ref": "#/components/schemas/Catalog_item_promotions" }, "unit_items": { "type": "array", "items": { "type": "object", "properties": { "sku": { "type": "string", "example": "game_01", "description": "고유 아이템 ID입니다. SKU는 소문자 및 대문자 라틴 영숫자, 마침표, 대시 및 밑줄만 포함할 수 있습니다." }, "type": { "type": "string", "example": "game_key", "description": "아이템의 유형: `game_key`." }, "is_free": { "$ref": "#/components/schemas/value-is_free" }, "price": { "type": "object", "description": "아이템 가격입니다.", "properties": { "amount": { "type": "string", "example": "2.9900", "description": "할인된 아이템 가격입니다." }, "amount_without_discount": { "type": "string", "example": "2.9900", "description": "아이템 가격입니다." }, "currency": { "type": "string", "example": "USD", "description": "아이템 가격 통화입니다. [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)에 따른 3자리 코드입니다." } } }, "virtual_prices": { "$ref": "#/components/schemas/client_virtual_prices_response" }, "can_be_bought": { "$ref": "#/components/schemas/Can_be_bought" }, "drm_name": { "type": "string", "example": "Steam", "description": "DRM 이름입니다." }, "drm_sku": { "type": "string", "example": "steam", "description": "고유 DRM ID입니다. SKU는 소문자 및 대문자 라틴 영숫자, 마침표, 대시 및 밑줄만 포함할 수 있습니다." }, "has_keys": { "type": "boolean", "example": false, "description": "`true`인 경우 게임 키에 판매용 키가 있습니다." }, "is_pre_order": { "type": "boolean", "example": true, "description": "`true`인 경우 사전 판매 게임 키이며 출시 날짜가 전달되지 않은 상태입니다." }, "release_date": { "type": [ "string", "null" ], "example": "2020-08-11T10:00:00+03:00", "description": "ISO 8601 형식으로 된 게임 키 출시 날짜입니다." }, "promotions": { "$ref": "#/components/schemas/Catalog_item_promotions" }, "limits": { "$ref": "#/components/schemas/Catalog_item_limits" }, "periods": { "$ref": "#/components/schemas/item-periods" }, "vp_rewards": { "$ref": "#/components/schemas/client-item-value-point-reward" } } } } } }, "examples": { "response": { "value": { "sku": "com.xsolla.game_1", "name": "Game name", "groups": [ { "external_id": "all", "name": "All games", "item_order_in_group": 2 }, { "external_id": "Xsolla", "name": "Xsolla games", "item_order_in_group": 1 } ], "type": "unit", "unit_type": "game", "description": "Game description", "image_url": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png", "attributes": [ { "external_id": "OS", "name": "OS", "values": [ { "external_id": "9d5c5efb7c0f00a00fe4e3583f1215b0050bc723", "value": "Windows" } ] }, { "external_id": "genre", "name": "Genre", "values": [ { "external_id": "9c5774997fc072b973bd5c231075c13841413f62", "value": "Casual, Logic" } ] } ], "promotions": [], "unit_items": [ { "sku": "com.xsolla.game_key_01", "type": "game_key", "is_free": false, "price": { "amount": "30.5", "amount_without_discount": "30.5", "currency": "USD" }, "virtual_prices": [], "can_be_bought": true, "drm_name": "Steam", "drm_sku": "steam_key_1", "has_keys": true, "is_pre_order": true, "release_date": "2020-08-11T10:00:00+03:00", "promotions": [], "limits": null, "periods": [ { "date_from": "2020-08-11T10:00:00+03:00", "date_until": "2020-08-11T20:00:00+03:00" } ], "vp_rewards": [ { "item_id": 175232, "sku": "com.xsolla.value_point_1", "amount": 130, "name": "Value point", "image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg" }, { "item_id": 186321, "sku": "com.xsolla.clan_value_point_1", "amount": 50, "name": "Clan Reward VP 1", "image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg", "is_clan": true } ] }, { "sku": "com.xsolla.game_key_02", "type": "game_key", "is_free": false, "price": { "amount": "30.5", "amount_without_discount": "30.5", "currency": "USD" }, "virtual_prices": [], "can_be_bought": true, "drm_name": "Origin", "drm_sku": "origin_key_1", "has_keys": false, "is_pre_order": false, "release_date": null, "promotions": [], "limits": null, "periods": [], "vp_rewards": [] } ] } } } } } }, "404": { "description": "게임을 찾을 수 없습니다.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "example": 404 }, "errorCode": { "type": "integer", "example": 4001 }, "errorMessage": { "type": "string", "example": "[0401-4001]: Item with sku = 'game_1' not found" } } }, "examples": { "response": { "value": { "statusCode": 404, "errorCode": 4001, "errorMessage": "[0401-4001]: Item with sku = 'game_1' not found" } } } } } } } } }, "/v2/project/{project_id}/items/game/key/sku/{item_sku}": { "get": { "summary": "카탈로그에 게임 키 가져오기", "description": "카탈로그에 대한 게임 키를 가져옵니다.\n\n
\n 참고

\n 이 API 호출은 인증 없이 사용될 때 일반적인 아이템 카탈로그 데이터를 반환합니다. 인증을 사용하여 아이템과 관련된 제한 및 프로모션과 같은 개인화된 사용자 데이터를 검색하세요. 이를 위해 Authorization 헤더에 사용자 JWT를 전달하십시오. 사용자 JWT에 대한 자세한 내용은 이 호출의 보안 블록을 참조하십시오.\n
", "tags": [ "game-keys-catalog" ], "operationId": "get-game-key-by-sku", "x-badges": [ { "name": "Client-side", "color": "#80eaff" } ], "security": [ { "XsollaLoginUserJWT": [] } ], "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "name": "item_sku", "in": "path", "required": true, "description": "아이템 SKU입니다.", "schema": { "type": "string", "default": "xsollus_basic_edition_steam" } }, { "$ref": "#/components/parameters/locale-query-param" }, { "$ref": "#/components/parameters/additional_fields-query-param" }, { "$ref": "#/components/parameters/country-query-param" }, { "$ref": "#/components/parameters/promo_code-query-param" }, { "$ref": "#/components/parameters/show_inactive_time_limited_items-query-param" } ], "responses": { "200": { "description": "게임 키를 성공적으로 수신했습니다.", "content": { "application/json": { "schema": { "type": "object", "description": "Object with game key information.", "example": { "sku": "com.xsolla.game_1", "name": "Game name", "groups": [ { "external_id": "all", "name": "All games", "item_order_in_group": 2 }, { "external_id": "Xsolla", "name": "Xsolla games", "item_order_in_group": 1 } ], "type": "game_key", "description": "Game description", "image_url": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png", "attributes": [ { "external_id": "OS", "name": "OS", "values": [ { "external_id": "9d5c5efb7c0f00a00fe4e3583f1215b0050bc723", "value": "Windows" } ] }, { "external_id": "genre", "name": "Genre", "values": [ { "external_id": "23fda05111c125608af8f1fa0e99db45a10ea1cc", "value": "Horror" } ] } ], "is_free": false, "price": { "amount": "30.5", "amount_without_discount": "30.5", "currency": "USD" }, "virtual_prices": [], "can_be_bought": true, "drm_name": "Steam", "drm_sku": "steam_key_1", "has_keys": true, "is_pre_order": true, "release_date": "2020-08-11T10:00:00+03:00", "promotions": [], "limits": null, "periods": [ { "date_from": "2020-08-11T10:00:00+03:00", "date_until": "2020-08-11T20:00:00+03:00" } ] }, "properties": { "sku": { "type": "string", "example": "com.xsolla.game_01", "description": "고유 아이템 ID입니다. SKU는 소문자 및 대문자 라틴 영숫자, 마침표, 대시 및 밑줄만 포함할 수 있습니다." }, "name": { "type": "string", "example": "Game name", "description": "아이템 이름입니다." }, "groups": { "$ref": "#/components/schemas/items_client_groups_response" }, "attributes": { "$ref": "#/components/schemas/Game-Keys_schemas-client-attributes" }, "type": { "type": "string", "example": "game_key", "description": "아이템의 유형: `game_key`." }, "description": { "type": "string", "example": "Game description", "description": "아이템 설명입니다." }, "image_url": { "type": "string", "example": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png", "description": "이미지 URL입니다." }, "is_free": { "$ref": "#/components/schemas/value-is_free" }, "price": { "type": "object", "description": "아이템 가격입니다.", "properties": { "amount": { "type": "string", "example": "2.9900", "description": "할인된 아이템 가격입니다." }, "amount_without_discount": { "type": "string", "example": "2.9900", "description": "아이템 가격입니다." }, "currency": { "type": "string", "example": "USD", "description": "아이템 가격 통화입니다. [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)에 따른 3자리 코드입니다." } } }, "virtual_prices": { "$ref": "#/components/schemas/client_virtual_prices_response" }, "can_be_bought": { "$ref": "#/components/schemas/Can_be_bought" }, "drm_name": { "type": "string", "example": "Steam", "description": "DRM 이름입니다." }, "drm_sku": { "type": "string", "example": "steam_key_1", "description": "고유 DRM ID입니다. SKU는 소문자 및 대문자 라틴 영숫자, 마침표, 대시 및 밑줄만 포함할 수 있습니다." }, "has_keys": { "type": "boolean", "example": false, "description": "`true`인 경우 게임 키에 판매용 키가 있습니다." }, "is_pre_order": { "type": "boolean", "example": true, "description": "`true`인 경우 사전 판매 게임 키이며 출시 날짜가 전달되지 않은 상태입니다." }, "release_date": { "type": "string", "example": "2020-08-11T10:00:00+03:00", "description": "ISO 8601 형식으로 된 게임 키 출시 날짜입니다." }, "promotions": { "$ref": "#/components/schemas/Catalog_item_promotions" }, "limits": { "$ref": "#/components/schemas/Catalog_item_limits" }, "periods": { "$ref": "#/components/schemas/item-periods" } } }, "examples": { "response": { "value": { "sku": "com.xsolla.game_1", "name": "Game name", "groups": [ { "external_id": "all", "name": "All games" }, { "external_id": "Xsolla", "name": "Xsolla games" } ], "type": "game_key", "description": "Game description", "image_url": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png", "attributes": [ { "external_id": "OS", "name": "OS", "values": [ { "external_id": "9d5c5efb7c0f00a00fe4e3583f1215b0050bc723", "value": "Windows" } ] }, { "external_id": "genre", "name": "Genre", "values": [ { "external_id": "23fda05111c125608af8f1fa0e99db45a10ea1cc", "value": "Horror" } ] } ], "is_free": false, "price": { "amount": "30.5", "amount_without_discount": "30.5", "currency": "USD" }, "virtual_prices": [], "can_be_bought": true, "drm_name": "Steam", "drm_sku": "steam_key_1", "has_keys": true, "is_pre_order": true, "release_date": "2020-08-11T10:00:00+03:00", "promotions": [], "limits": null, "periods": [ { "date_from": "2020-08-11T10:00:00+03:00", "date_until": "2020-08-11T20:00:00+03:00" } ] } } } } } }, "404": { "description": "게임 키를 찾을 수 없습니다.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "example": 404 }, "errorCode": { "type": "integer", "example": 4001 }, "errorMessage": { "type": "string", "example": "[0401-4001]: Item with sku = 'game_key_1' not found" } } }, "examples": { "response": { "value": { "statusCode": 404, "errorCode": 4001, "errorMessage": "[0401-4001]: Item with sku = 'game_key_1' not found" } } } } } } } } }, "/v2/project/{project_id}/items/game/key/group/{external_id}": { "get": { "summary": "지정한 그룹으로 게임 키 목록 가져오기", "description": "카탈로그 작성을 위해 지정된 그룹에서 게임 키를 가져옵니다.\n\n
\n 주의

\n 모든 프로젝트에는 응답에서 가져올 수 있는 항목 수에 제한이 있습니다. 기본 및 최대 값은 응답당 50개 항목입니다. 페이지별로 더 많은 데이터를 얻으려면 limit 및 offset 입력란을 사용하세요.\n
\n\n
\n\n
\n 참고

\n 이 API 호출은 인증 없이 사용될 때 일반적인 아이템 카탈로그 데이터를 반환합니다. 인증을 사용하여 아이템과 관련된 제한 및 프로모션과 같은 개인화된 사용자 데이터를 검색하세요. 이를 위해 Authorization 헤더에 사용자 JWT를 전달하십시오. 사용자 JWT에 대한 자세한 내용은 이 호출의 보안 블록을 참조하십시오.\n
", "security": [ { "XsollaLoginUserJWT": [] } ], "tags": [ "game-keys-catalog" ], "operationId": "get-game-keys-group", "x-badges": [ { "name": "Client-side", "color": "#80eaff" } ], "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/external_id-group-path-param" }, { "$ref": "#/components/parameters/limit-query-param" }, { "$ref": "#/components/parameters/offset-query-param" }, { "$ref": "#/components/parameters/locale-query-param" }, { "$ref": "#/components/parameters/additional_fields-query-param" }, { "$ref": "#/components/parameters/country-query-param" }, { "$ref": "#/components/parameters/promo_code-query-param" }, { "$ref": "#/components/parameters/show_inactive_time_limited_items-query-param" } ], "responses": { "200": { "$ref": "#/components/responses/Game-Keys_200-get-game-keys-by-group-catalog" } } } }, "/v2/project/{project_id}/items/game/drm": { "get": { "summary": "DRM 목록 가져오기", "description": "사용 가능한 DRM 목록을 가져옵니다.", "tags": [ "game-keys-catalog" ], "operationId": "get-drm-list", "x-badges": [ { "name": "Client-side", "color": "#80eaff" } ], "security": [], "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" } ], "responses": { "200": { "$ref": "#/components/responses/Game-Keys_200-get-drm-list" } } } }, "/v2/project/{project_id}/admin/items/game": { "post": { "summary": "게임 생성하기", "description": "프로젝트에서 게임을 생성합니다.", "operationId": "admin-create-game", "x-badges": [ { "name": "Server-side", "color": "#95ff80" }, { "name": "Admin", "color": "#d7dee0" } ], "tags": [ "game-keys-admin" ], "security": [ { "basicAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" } ], "requestBody": { "$ref": "#/components/requestBodies/Game-Keys_create-update-game-model" }, "responses": { "201": { "description": "게임을 성공적으로 생성했습니다.", "content": { "application/json": { "schema": { "type": "object", "properties": { "item_id": { "type": "integer", "example": 101 }, "sku": { "type": "string", "example": "com.xsolla.game_1" } } }, "examples": { "response": { "value": { "item_id": 101, "sku": "com.xsolla.game_1" } } } } } }, "401": { "$ref": "#/components/responses/Game-Keys_401-invalid-basic-auth" }, "422": { "$ref": "#/components/responses/Game-Keys_422-invalid-request" } } }, "get": { "summary": "게임 목록 가져오기(관리자)", "description": "관리를 위해 프로젝트 내부의 게임 목록을 가져옵니다.\n게임은 사용자가 구매할 수 있는 게임 키로 구성되어 있습니다.\n\n
참고

상점 카탈로그를 작성에 이 엔드포인트를 사용하지 마세요.
", "operationId": "admin-get-game-list", "x-badges": [ { "name": "Server-side", "color": "#95ff80" }, { "name": "Admin", "color": "#d7dee0" } ], "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/limit-query-param" }, { "$ref": "#/components/parameters/offset-query-param" }, { "$ref": "#/components/parameters/promo_code-query-param" } ], "tags": [ "game-keys-admin" ], "security": [ { "basicAuth": [] } ], "responses": { "200": { "$ref": "#/components/responses/Game-Keys_200-admin-get-games-list" }, "401": { "$ref": "#/components/responses/Game-Keys_401-invalid-basic-auth" } } } }, "/v2/project/{project_id}/admin/items/game/sku/{item_sku}": { "get": { "summary": "게임 가져오기(관리자)", "description": "관리를 위해 게임을 가져옵니다.\n게임은 사용자가 구매할 수 있는 게임 키로 구성되어 있습니다.\n\n
참고

상점 카탈로그를 작성에 이 엔드포인트를 사용하지 마세요.
", "operationId": "admin-get-game-by-sku", "x-badges": [ { "name": "Server-side", "color": "#95ff80" }, { "name": "Admin", "color": "#d7dee0" } ], "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/item_sku-path-param" }, { "$ref": "#/components/parameters/promo_code-query-param" } ], "tags": [ "game-keys-admin" ], "security": [ { "basicAuth": [] } ], "responses": { "200": { "$ref": "#/components/responses/Game-Keys_200-admin-get-game-by-sku" }, "401": { "$ref": "#/components/responses/Game-Keys_401-invalid-basic-auth" }, "404": { "description": "게임을 찾을 수 없습니다.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "example": 404 }, "errorCode": { "type": "integer", "example": 4001 }, "errorMessage": { "type": "string", "example": "[0401-4001]: Item with sku = 'game_1' not found" } } }, "examples": { "response": { "value": { "statusCode": 404, "errorCode": 4001, "errorMessage": "[0401-4001]: Item with sku = 'game_1' not found" } } } } } } } }, "put": { "summary": "SKU로 게임 업데이트", "description": "SKU로 프로젝트에 있는 게임을 업데이트합니다.", "operationId": "admin-update-game-by-sku", "x-badges": [ { "name": "Server-side", "color": "#95ff80" }, { "name": "Admin", "color": "#d7dee0" } ], "tags": [ "game-keys-admin" ], "security": [ { "basicAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/item_sku-path-param" } ], "requestBody": { "$ref": "#/components/requestBodies/Game-Keys_create-update-game-model" }, "responses": { "201": { "description": "게임을 성공적으로 업데이트했습니다." }, "401": { "$ref": "#/components/responses/Game-Keys_401-invalid-basic-auth" }, "404": { "description": "게임을 찾을 수 없습니다.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "example": 404 }, "errorCode": { "type": "integer", "example": 4001 }, "errorMessage": { "type": "string", "example": "[0401-4001]: Item with sku = 'game_1' not found" } } }, "examples": { "response": { "value": { "statusCode": 404, "errorCode": 4001, "errorMessage": "[0401-4001]: Item with sku = 'game_1' not found" } } } } } }, "422": { "$ref": "#/components/responses/Game-Keys_422-invalid-request" } } }, "delete": { "summary": "SKU로 게임 삭제", "description": "SKU로 프로젝트에 있는 게임을 삭제합니다.", "operationId": "admin-delete-game-by-sku", "x-badges": [ { "name": "Server-side", "color": "#95ff80" }, { "name": "Admin", "color": "#d7dee0" } ], "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/item_sku-path-param" } ], "tags": [ "game-keys-admin" ], "security": [ { "basicAuth": [] } ], "responses": { "204": { "description": "게임을 성공적으로 삭제했습니다." }, "401": { "$ref": "#/components/responses/Game-Keys_401-invalid-basic-auth" } } } }, "/v2/project/{project_id}/admin/items/game/id/{item_id}": { "get": { "summary": "ID로 게임 가져오기(관리자)", "description": "관리를 위해 게임을 가져옵니다.\n게임은 사용자가 구매할 수 있는 게임 키로 구성되어 있습니다.\n\n
참고

상점 카탈로그를 작성에 이 엔드포인트를 사용하지 마세요.
", "operationId": "admin-get-game-by-id", "x-badges": [ { "name": "Server-side", "color": "#95ff80" }, { "name": "Admin", "color": "#d7dee0" } ], "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/item_id-path-param" }, { "$ref": "#/components/parameters/promo_code-query-param" } ], "tags": [ "game-keys-admin" ], "security": [ { "basicAuth": [] } ], "responses": { "200": { "$ref": "#/components/responses/Game-Keys_200-admin-get-game-by-sku" }, "401": { "$ref": "#/components/responses/Game-Keys_401-invalid-basic-auth" }, "404": { "description": "게임을 찾을 수 없습니다.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "example": 404 }, "errorCode": { "type": "integer", "example": 4001 }, "errorMessage": { "type": "string", "example": "[0401-4001]: Item with id = 1 not found" } } }, "examples": { "response": { "value": { "statusCode": 404, "errorCode": 4001, "errorMessage": "[0401-4001]: Item with id = 1 not found" } } } } } } } }, "put": { "summary": "ID로 게임 업데이트", "description": "프로젝트의 게임을 ID로 업데이트합니다.", "operationId": "admin-update-game-by-id", "x-badges": [ { "name": "Server-side", "color": "#95ff80" }, { "name": "Admin", "color": "#d7dee0" } ], "tags": [ "game-keys-admin" ], "security": [ { "basicAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/item_id-path-param" } ], "requestBody": { "$ref": "#/components/requestBodies/Game-Keys_create-update-game-model" }, "responses": { "201": { "description": "게임을 성공적으로 업데이트했습니다." }, "401": { "$ref": "#/components/responses/Game-Keys_401-invalid-basic-auth" }, "404": { "description": "게임을 찾을 수 없습니다.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "example": 404 }, "errorCode": { "type": "integer", "example": 4001 }, "errorMessage": { "type": "string", "example": "[0401-4001]: Item with id = 1 not found" } } }, "examples": { "response": { "value": { "statusCode": 404, "errorCode": 4001, "errorMessage": "[0401-4001]: Item with id = 1 not found" } } } } } }, "422": { "$ref": "#/components/responses/Game-Keys_422-invalid-request" } } }, "delete": { "summary": "ID로 게임 삭제", "description": "ID로 프로젝트의 게임을 삭제합니다.", "operationId": "admin-delete-game-by-id", "x-badges": [ { "name": "Server-side", "color": "#95ff80" }, { "name": "Admin", "color": "#d7dee0" } ], "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/item_id-path-param" } ], "tags": [ "game-keys-admin" ], "security": [ { "basicAuth": [] } ], "responses": { "204": { "description": "게임을 성공적으로 삭제했습니다." }, "401": { "$ref": "#/components/responses/Game-Keys_401-invalid-basic-auth" } } } }, "/v2/project/{project_id}/admin/items/game/key/upload/sku/{item_sku}": { "post": { "summary": "코드 업로드", "description": "게임 키 SKU로 코드를 업로드합니다.", "operationId": "admin-upload-codes-by-sku", "x-badges": [ { "name": "Server-side", "color": "#95ff80" }, { "name": "Admin", "color": "#d7dee0" } ], "tags": [ "game-keys-admin" ], "security": [ { "basicAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/item_sku-path-param" } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "file": { "type": "string", "format": "binary", "description": "File with codes." }, "region_id": { "type": "integer", "description": "지역 ID입니다." } }, "required": [ "file" ], "example": { "file": "keys.txt", "region_id": 1 } } } }, "required": true }, "responses": { "200": { "$ref": "#/components/responses/Game-Keys_200-session-information" }, "401": { "$ref": "#/components/responses/Game-Keys_401-invalid-basic-auth" }, "404": { "description": "게임 키 또는 지역을 찾을 수 없습니다.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "example": 404 }, "errorCode": { "type": "integer", "example": 4001 }, "errorMessage": { "type": "string", "example": "[0401-4001]: Item with sku = 'game_1' not found" } } }, "examples": { "response": { "value": { "statusCode": 404, "errorCode": 4001, "errorMessage": "[0401-4001]: Item with sku = 'game_1' not found" } } } } } } } } }, "/v2/project/{project_id}/admin/items/game/key/upload/id/{item_id}": { "post": { "summary": "ID로 코드 업로드", "description": "게임 키 ID로 코드를 업로드합니다.", "operationId": "admin-upload-codes-by-id", "x-badges": [ { "name": "Server-side", "color": "#95ff80" }, { "name": "Admin", "color": "#d7dee0" } ], "tags": [ "game-keys-admin" ], "security": [ { "basicAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/item_id-path-param" } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "file": { "type": "string", "format": "binary", "description": "File with codes." }, "region_id": { "type": "integer", "description": "지역 ID입니다." } }, "required": [ "file" ], "example": { "file": "keys.txt", "region_id": 1 } } } } }, "responses": { "200": { "$ref": "#/components/responses/Game-Keys_200-session-information" }, "401": { "$ref": "#/components/responses/Game-Keys_401-invalid-basic-auth" }, "404": { "description": "게임 키 또는 지역을 찾을 수 없습니다.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "example": 404 }, "errorCode": { "type": "integer", "example": 4001 }, "errorMessage": { "type": "string", "example": "[0401-4001]: Item with sku = 'game_1' not found" } } }, "examples": { "response": { "value": { "statusCode": 404, "errorCode": 4001, "errorMessage": "[0401-4001]: Item with sku = 'game_1' not found" } } } } } } } } }, "/v2/project/{project_id}/admin/items/game/key/upload/session/{session_id}": { "get": { "summary": "세션 정보를 로드하는 코드 가져오기", "description": "세션 정보를 로드하는 코드를 가져옵니다.", "operationId": "admin-get-codes-session", "x-badges": [ { "name": "Server-side", "color": "#95ff80" }, { "name": "Admin", "color": "#d7dee0" } ], "tags": [ "game-keys-admin" ], "security": [ { "basicAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "name": "session_id", "in": "path", "required": true, "description": "세션 ID입니다.", "schema": { "type": "string", "default": "fc7105b6e8ee01339582970b37697242" } } ], "responses": { "200": { "$ref": "#/components/responses/Game-Keys_200-session-information" }, "401": { "$ref": "#/components/responses/Game-Keys_401-invalid-basic-auth" }, "404": { "description": "코드 로드 세션을 찾을 수 없습니다." } } } }, "/v2/project/{project_id}/admin/items/game/key/request/sku/{item_sku}": { "get": { "summary": "코드 가져오기", "description": "게임 키 SKU로 특정 수의 코드를 가져옵니다.", "operationId": "admin-get-codes-by-sku", "x-badges": [ { "name": "Server-side", "color": "#95ff80" }, { "name": "Admin", "color": "#d7dee0" } ], "tags": [ "game-keys-admin" ], "security": [ { "basicAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/item_sku-path-param" }, { "$ref": "#/components/parameters/user_email-query-param" }, { "$ref": "#/components/parameters/quantity-query-param" }, { "$ref": "#/components/parameters/reason-query-param" }, { "$ref": "#/components/parameters/region_id-query-param" } ], "responses": { "200": { "$ref": "#/components/responses/Game-Keys_200-get-codes" }, "401": { "$ref": "#/components/responses/Game-Keys_401-invalid-basic-auth" }, "404": { "description": "게임 키 또는 지역을 찾을 수 없습니다.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "example": 404 }, "errorCode": { "type": "integer", "example": 4001 }, "errorMessage": { "type": "string", "example": "[0401-4001]: Item with sku = 'game_1' not found" } } }, "examples": { "response": { "value": { "statusCode": 404, "errorCode": 4001, "errorMessage": "[0401-4001]: Item with sku = 'game_1' not found" } } } } } } } } }, "/v2/project/{project_id}/admin/items/game/key/request/id/{item_id}": { "get": { "summary": "ID로 코드 가져오기", "description": "게임 키 ID로 특정 수의 코드를 가져옵니다.", "operationId": "admin-get-codes-by-id", "x-badges": [ { "name": "Server-side", "color": "#95ff80" }, { "name": "Admin", "color": "#d7dee0" } ], "tags": [ "game-keys-admin" ], "security": [ { "basicAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/item_id-path-param" }, { "$ref": "#/components/parameters/user_email-query-param" }, { "$ref": "#/components/parameters/quantity-query-param" }, { "$ref": "#/components/parameters/reason-query-param" }, { "$ref": "#/components/parameters/region_id-query-param" } ], "responses": { "200": { "$ref": "#/components/responses/Game-Keys_200-get-codes" }, "401": { "$ref": "#/components/responses/Game-Keys_401-invalid-basic-auth" }, "404": { "description": "게임 키 또는 지역을 찾을 수 없습니다.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "example": 404 }, "errorCode": { "type": "integer", "example": 4001 }, "errorMessage": { "type": "string", "example": "[0401-4001]: Item with sku = 'game_1' not found" } } }, "examples": { "response": { "value": { "statusCode": 404, "errorCode": 4001, "errorMessage": "[0401-4001]: Item with sku = 'game_1' not found" } } } } } } } } }, "/v2/project/{project_id}/admin/items/game/key/delete/sku/{item_sku}": { "delete": { "summary": "코드 삭제하기", "description": "게임 키 SKU로 모든 코드를 삭제합니다.", "operationId": "admin-delete-codes-by-sku", "x-badges": [ { "name": "Server-side", "color": "#95ff80" }, { "name": "Admin", "color": "#d7dee0" } ], "tags": [ "game-keys-admin" ], "security": [ { "basicAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/item_sku-path-param" }, { "$ref": "#/components/parameters/user_email-query-param" }, { "$ref": "#/components/parameters/reason-query-param" }, { "$ref": "#/components/parameters/region_id-query-param" } ], "responses": { "200": { "$ref": "#/components/responses/Game-Keys_200-get-codes" }, "401": { "$ref": "#/components/responses/Game-Keys_401-invalid-basic-auth" }, "404": { "description": "게임 키 또는 지역을 찾을 수 없습니다.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "example": 404 }, "errorCode": { "type": "integer", "example": 4001 }, "errorMessage": { "type": "string", "example": "[0401-4001]: Item with sku = 'game_1' not found" } } }, "examples": { "response": { "value": { "statusCode": 404, "errorCode": 4001, "errorMessage": "[0401-4001]: Item with sku = 'game_1' not found" } } } } } } } } }, "/v2/project/{project_id}/admin/items/game/key/delete/id/{item_id}": { "delete": { "summary": "ID로 코드 삭제하기", "description": "게임 키 ID로 모든 코드를 삭제합니다.", "operationId": "admin-delete-codes-by-id", "x-badges": [ { "name": "Server-side", "color": "#95ff80" }, { "name": "Admin", "color": "#d7dee0" } ], "tags": [ "game-keys-admin" ], "security": [ { "basicAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/item_id-path-param" }, { "$ref": "#/components/parameters/user_email-query-param" }, { "$ref": "#/components/parameters/reason-query-param" }, { "$ref": "#/components/parameters/region_id-query-param" } ], "responses": { "200": { "$ref": "#/components/responses/Game-Keys_200-get-codes" }, "401": { "$ref": "#/components/responses/Game-Keys_401-invalid-basic-auth" }, "404": { "description": "게임 키 또는 지역을 찾을 수 없습니다.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "example": 404 }, "errorCode": { "type": "integer", "example": 4001 }, "errorMessage": { "type": "string", "example": "[0401-4001]: Item with sku = 'game_1' not found" } } }, "examples": { "response": { "value": { "statusCode": 404, "errorCode": 4001, "errorMessage": "[0401-4001]: Item with sku = 'game_1' not found" } } } } } } } } }, "/v2/project/{project_id}/entitlement": { "get": { "tags": [ "game-keys-entitlement" ], "operationId": "get-user-games", "x-badges": [ { "name": "Client-side", "color": "#80eaff" } ], "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/limit-query-param" }, { "$ref": "#/components/parameters/offset-query-param" }, { "$ref": "#/components/parameters/sandbox-query-param" }, { "$ref": "#/components/parameters/additional_fields-entitlement-query-param" } ], "responses": { "200": { "$ref": "#/components/responses/Game-Keys_200-user-entitlement-list" }, "401": { "$ref": "#/components/responses/Game-Keys_401-invalid-basic-auth" } }, "summary": "사용자가 소유한 게임 목록 가져오기", "description": "사용자가 소유한 게임 목록을 가져옵니다. 응답에 특정 사용자가 소유한 게임 배열이 포함됩니다.\n\n
\n 주의

\n 모든 프로젝트에는 응답에서 가져올 수 있는 항목 수에 제한이 있습니다. 기본 및 최대 값은 응답당 50개 항목입니다. 페이지별로 더 많은 데이터를 얻으려면 limit 및 offset 입력란을 사용하세요.\n
\n\n
\n\n
\n 참고

\n 이 API 호출은 인증 없이 사용될 때 일반적인 아이템 카탈로그 데이터를 반환합니다. 인증을 사용하여 아이템과 관련된 제한 및 프로모션과 같은 개인화된 사용자 데이터를 검색하세요. 이를 위해 Authorization 헤더에 사용자 JWT를 전달하십시오. 사용자 JWT에 대한 자세한 내용은 이 호출의 보안 블록을 참조하십시오.\n
", "security": [ { "XsollaLoginUserJWT": [] } ] } }, "/v2/project/{project_id}/entitlement/redeem": { "post": { "tags": [ "game-keys-entitlement" ], "operationId": "redeem-game-pin-code", "x-badges": [ { "name": "Client-side", "color": "#80eaff" } ], "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" } ], "responses": { "201": { "description": "성공적으로 사용했습니다." }, "403": { "$ref": "#/components/responses/Game-Keys_403-auth-header-not-sent" }, "404": { "description": "게임 코드를 찾을 수 없습니다. `code`와 `project_id`가 올바른지 확인합니다.", "content": { "application/json": { "schema": { "properties": { "statusCode": { "type": "integer", "example": 404 }, "errorCode": { "type": "integer", "example": 4603 }, "errorMessage": { "type": "string", "example": "[0401-4603]: Game code not found." }, "transactionId": { "type": "string", "example": "x-x-x-x-transactionId-mock-x-x-x" } }, "type": "object" }, "examples": { "Game code not found": { "$ref": "#/components/examples/404-game-code-not-found" } } } } }, "422": { "description": "잘못된 요청입니다.", "content": { "application/json": { "schema": { "properties": { "statusCode": { "type": "integer", "example": 422 }, "errorCode": { "type": "integer", "example": 5103 }, "errorMessage": { "type": "string", "example": "[0401-5103]: Selected drm is not drmfree." }, "transactionId": { "type": "string", "example": "x-x-x-x-transactionId-mock-x-x-x" } }, "type": "object" }, "examples": { "DRM is not DRM free": { "$ref": "#/components/examples/422-drm-is-not-drm-free" }, "User already has entitlement": { "$ref": "#/components/examples/422-user-already-has-entitlement" }, "Game is in pre-order state": { "value": { "statusCode": 422, "errorCode": 5106, "errorMessage": "[0401-5106]: Item: game_sku is in pre-order state and can not be redeemed", "transactionId": "transaction id" } }, "Game code is already activated": { "value": { "statusCode": 422, "errorCode": 5107, "errorMessage": "[0401-5107]: Game code has been already activated", "transactionId": "transaction id" } } } } } } }, "summary": "클라이언트로 게임 코드 사용하기", "description": "제공된 게임 코드로 권한을 부여합니다.\n\n
\n 알림

\n DRM이 없는 플랫폼에서만 코드를 사용할 수 있습니다.\n
\n\n
\n\n
\n 참고

\n 이 API 호출은 인증 없이 사용될 때 일반적인 아이템 카탈로그 데이터를 반환합니다. 인증을 사용하여 아이템과 관련된 제한 및 프로모션과 같은 개인화된 사용자 데이터를 검색하세요. 이를 위해 Authorization 헤더에 사용자 JWT를 전달하십시오. 사용자 JWT에 대한 자세한 내용은 이 호출의 보안 블록을 참조하십시오.\n
", "security": [ { "XsollaLoginUserJWT": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "code" ], "properties": { "code": { "type": "string", "example": "AAAA-BBBB-CCCC-DDDD", "description": "Game code." }, "sandbox": { "type": "boolean", "example": false, "default": false, "description": "Redeem game code in the sandbox mode. The option is available for those users who are specified in the list of company users." } } } } }, "required": true } } }, "/v2/project/{project_id}/admin/entitlement/grant": { "post": { "tags": [ "game-keys-entitlement" ], "operationId": "grant-entitlement-admin", "x-badges": [ { "name": "Server-side", "color": "#95ff80" }, { "name": "Admin", "color": "#d7dee0" } ], "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" } ], "responses": { "200": { "description": "권한이 부여되었습니다." }, "403": { "$ref": "#/components/responses/Game-Keys_403-auth-header-not-sent" }, "404": { "description": "게임 코드를 찾을 수 없습니다. `code`와 `project_id`가 올바른지 확인합니다.", "content": { "application/json": { "schema": { "properties": { "statusCode": { "type": "integer", "example": 404 }, "errorCode": { "type": "integer", "example": 4603 }, "errorMessage": { "type": "string", "example": "[0401-4603]: Game code not found." }, "transactionId": { "type": "string", "example": "x-x-x-x-transactionId-mock-x-x-x" } }, "type": "object" }, "examples": { "Game code not found": { "$ref": "#/components/examples/404-game-code-not-found" }, "Game not found": { "value": { "statusCode": 404, "errorCode": 4604, "errorMessage": "[0401-4604]: Game not found.", "transactionId": "transaction id" } } } } } }, "422": { "description": "잘못된 요청입니다.", "content": { "application/json": { "schema": { "properties": { "statusCode": { "type": "integer", "example": 422 }, "errorCode": { "type": "integer", "example": 5103 }, "errorMessage": { "type": "string", "example": "[0401-5103]: Selected drm is not drmfree." }, "transactionId": { "type": "string", "example": "x-x-x-x-transactionId-mock-x-x-x" } }, "type": "object" }, "examples": { "DRM is not DRM free": { "$ref": "#/components/examples/422-drm-is-not-drm-free" }, "User already has entitlement": { "$ref": "#/components/examples/422-user-already-has-entitlement" } } } } } }, "summary": "권한 부여(관리자)", "description": "사용자에게 권한을 부여합니다.\n\n
주의

DRM Free 플랫폼용 게임 코드 또는 게임에만 권한을 부여할 수 있습니다.
", "security": [ { "basicAuth": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "user_external_id", "game", "drm", "mode" ], "properties": { "user_external_id": { "type": "string", "example": "user-external-id", "description": "Unique user identifier." }, "game": { "type": "object", "required": [ "sku" ], "properties": { "sku": { "$ref": "#/components/schemas/Game-Keys_game_sku" } }, "example": { "game": { "sku": "com.xsolla.game_1" } }, "description": "Object with game properties." }, "drm": { "type": "object", "required": [ "sku" ], "properties": { "sku": { "$ref": "#/components/schemas/Game-Keys_drm_sku" } }, "example": { "drm": { "sku": "com.xsolla.key_1" } }, "description": "Object with DRM properties." }, "code": { "type": [ "string", "null" ], "example": "AAAA-BBBB-CCCC-DDDD", "description": "Game code of the game." }, "mode": { "type": "string", "enum": [ "default", "sandbox" ], "example": "default", "description": "What type of entitlements should be granted. If the parameter is set to `sandbox`, the entitlement will be granted to the user in the sandbox mode. If the parameter is set to `default`, the entitlement will be granted to the user in the live mode." }, "user_country": { "type": [ "string", "null" ], "example": "US", "description": "User's country." } }, "example": { "user_external_id": "user-external-id", "game": { "sku": "com.xsolla.game_1" }, "drm": { "sku": "com.xsolla.key_1" }, "code": "AAAA-BBBB-CCCC-DDDD", "mode": "default", "user_country": "US" } } } }, "required": true } } }, "/v2/project/{project_id}/admin/entitlement/revoke": { "post": { "tags": [ "game-keys-entitlement" ], "operationId": "revoke-entitlement-admin", "x-badges": [ { "name": "Server-side", "color": "#95ff80" }, { "name": "Admin", "color": "#d7dee0" } ], "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" } ], "responses": { "204": { "description": "성공적으로 취소했습니다." }, "403": { "$ref": "#/components/responses/Game-Keys_403-auth-header-not-sent" }, "422": { "description": "잘못된 요청입니다.", "content": { "application/json": { "schema": { "properties": { "statusCode": { "type": "integer", "example": 422 }, "errorCode": { "type": "integer", "example": 5103 }, "errorMessage": { "type": "string", "example": "[0401-5103]: Selected drm is not drmfree." }, "transactionId": { "type": "string", "example": "x-x-x-x-transactionId-mock-x-x-x" } }, "type": "object" }, "examples": { "DRM is not DRM free": { "value": { "statusCode": 422, "errorCode": 5103, "errorMessage": "[0401-5103]: Selected drm is not drmfree.", "transactionId": "transaction id" } } } } } } }, "summary": "권한 취소(관리자)", "description": "사용자의 권한을 취소합니다.\n\n
주의

DRM Free 플랫폼용 게임 코드 또는 게임만 취소할 수 있습니다.
", "security": [ { "basicAuth": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "user_external_id", "game", "drm", "mode" ], "properties": { "user_external_id": { "type": "string", "example": "user-external-id", "description": "Unique user identifier." }, "game": { "type": "object", "required": [ "sku" ], "properties": { "sku": { "$ref": "#/components/schemas/Game-Keys_game_sku" } }, "example": { "game": { "sku": "com.xsolla.game_1" } }, "description": "Object with game properties." }, "drm": { "type": "object", "required": [ "sku" ], "properties": { "sku": { "$ref": "#/components/schemas/Game-Keys_drm_sku" } }, "example": { "drm": { "sku": "com.xsolla.key_1" } }, "description": "Object with DRM properties." }, "mode": { "type": "string", "enum": [ "default", "sandbox" ], "example": "default", "description": "What type of entitlements should be revoked. If the parameter is set to `sandbox`, the entitlement will be revoked from the user in the sandbox mode. If the parameter is set to `default`, the entitlement will be revoked from the user in the live mode." } }, "example": { "user_external_id": "user-external-id", "game": { "sku": "com.xsolla.game_1" }, "drm": { "sku": "com.xsolla.key_1" }, "mode": "default" } } } }, "required": true } } }, "/v2/project/{project_id}/admin/items/bundle": { "get": { "summary": "번들 목록 가져오기", "description": "관리를 위해 프로젝트 내부의 번들 목록을 가져옵니다.\n\n
참고

상점 카탈로그를 작성에 이 엔드포인트를 사용하지 마세요.
", "operationId": "admin-get-bundle-list", "x-badges": [ { "name": "Server-side", "color": "#95ff80" }, { "name": "Admin", "color": "#d7dee0" } ], "security": [ { "basicAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/limit-query-param" }, { "$ref": "#/components/parameters/offset-query-param" } ], "tags": [ "bundles-admin" ], "responses": { "200": { "$ref": "#/components/responses/Bundles_200-admin-get-bundle-list" }, "401": { "$ref": "#/components/responses/Bundles_401-invalid-basic-auth" } } }, "post": { "summary": "번들 생성하기", "description": "단일 단위로 판매되는 아이템 세트인 번들을 생성합니다. 번들에는 가상 아이템, 인게임 재화 패키지, 게임 키 및 기타 번들이 포함될 수 있습니다. 자세한 내용은 [번들](https://developers.xsolla.com/ko/items-catalog/items-type/bundles/) 섹션을 참조하십시오.\n\n
공지

content 배열의 모든 아이템은 프로젝트에 미리 생성되어 있어야 합니다. 지정한 SKU가 존재하지 않으면 시스템에서 오류를 반환합니다.
", "security": [ { "basicAuth": [] } ], "operationId": "admin-create-bundle", "x-badges": [ { "name": "Server-side", "color": "#95ff80" }, { "name": "Admin", "color": "#d7dee0" } ], "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" } ], "tags": [ "bundles-admin" ], "requestBody": { "$ref": "#/components/requestBodies/Bundles_bundle" }, "responses": { "201": { "$ref": "#/components/responses/Bundles_201-admin-create-bundle" }, "401": { "$ref": "#/components/responses/Bundles_401-invalid-basic-auth" }, "422": { "$ref": "#/components/responses/Bundles_422-invalid-request" } } } }, "/v2/project/{project_id}/admin/items/bundle/group/id/{group_id}": { "get": { "summary": "지정한 그룹 ID로 번들 목록 가져오기", "description": "관리 목적으로 그룹 내 번들 목록을 가져옵니다.\n\n
참고

상점 카탈로그를 작성에 이 엔드포인트를 사용하지 마세요.
", "operationId": "admin-get-bundle-list-in-group-by-id", "x-badges": [ { "name": "Server-side", "color": "#95ff80" }, { "name": "Admin", "color": "#d7dee0" } ], "security": [ { "basicAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/group_id-path-param" }, { "$ref": "#/components/parameters/limit-query-param" }, { "$ref": "#/components/parameters/offset-query-param" } ], "tags": [ "bundles-admin" ], "responses": { "200": { "$ref": "#/components/responses/Bundles_200-admin-get-bundle-list-in-group" }, "401": { "$ref": "#/components/responses/Bundles_401-invalid-basic-auth" } } } }, "/v2/project/{project_id}/admin/items/bundle/group/external_id/{external_id}": { "get": { "summary": "지정한 그룹 외부 ID로 번들 목록 가져오기", "description": "관리 목적으로 그룹 내 번들 목록을 가져옵니다.\n\n
참고

상점 카탈로그를 작성에 이 엔드포인트를 사용하지 마세요.
", "operationId": "admin-get-bundle-list-in-group-by-external-id", "x-badges": [ { "name": "Server-side", "color": "#95ff80" }, { "name": "Admin", "color": "#d7dee0" } ], "security": [ { "basicAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/external_id-group-path-param" }, { "$ref": "#/components/parameters/limit-query-param" }, { "$ref": "#/components/parameters/offset-query-param" } ], "tags": [ "bundles-admin" ], "responses": { "200": { "$ref": "#/components/responses/Bundles_200-admin-get-bundle-list-in-group" }, "401": { "$ref": "#/components/responses/Bundles_401-invalid-basic-auth" } } } }, "/v2/project/{project_id}/admin/items/bundle/sku/{sku}": { "put": { "summary": "번들 업데이트", "description": "번들을 업데이트합니다. 이 호출은 번들을 완전히 대체합니다 변경하려는 필드뿐만 아니라 요청 본문의 모든 필수 필드를 전달합니다. 자세한 내용은 [번들](https://developers.xsolla.com/ko/items-catalog/items-type/bundles/) 섹션을 참조하십시오.\n\n
공지

content 배열의 모든 아이템은 프로젝트에 미리 생성되어 있어야 합니다. 지정한 SKU가 존재하지 않으면 시스템에서 오류를 반환합니다.
", "operationId": "admin-update-bundle", "x-badges": [ { "name": "Server-side", "color": "#95ff80" }, { "name": "Admin", "color": "#d7dee0" } ], "security": [ { "basicAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/sku-path-param" } ], "tags": [ "bundles-admin" ], "requestBody": { "$ref": "#/components/requestBodies/Bundles_bundle" }, "responses": { "204": { "$ref": "#/components/responses/Bundles_204-admin-update-bundle" }, "401": { "$ref": "#/components/responses/Bundles_401-invalid-basic-auth" }, "422": { "$ref": "#/components/responses/Bundles_422-invalid-request" } } }, "delete": { "summary": "번들 삭제", "description": "번들을 삭제합니다.", "operationId": "admin-delete-bundle", "x-badges": [ { "name": "Server-side", "color": "#95ff80" }, { "name": "Admin", "color": "#d7dee0" } ], "security": [ { "basicAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/sku-path-param" } ], "tags": [ "bundles-admin" ], "responses": { "204": { "$ref": "#/components/responses/Bundles_204-admin-delete-bundle" }, "401": { "$ref": "#/components/responses/Bundles_401-invalid-basic-auth" } } }, "get": { "summary": "번들 가져오기", "description": "관리를 위해 프로젝트 내부의 번들을 가져옵니다.\n\n
참고

상점 카탈로그를 작성에 이 엔드포인트를 사용하지 마세요.
", "operationId": "admin-get-bundle", "x-badges": [ { "name": "Server-side", "color": "#95ff80" }, { "name": "Admin", "color": "#d7dee0" } ], "security": [ { "basicAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/sku-path-param" } ], "tags": [ "bundles-admin" ], "responses": { "200": { "$ref": "#/components/responses/Bundles_200-admin-get-bundle" }, "401": { "$ref": "#/components/responses/Bundles_401-invalid-basic-auth" } } } }, "/v2/project/{project_id}/admin/items/bundle/sku/{sku}/show": { "put": { "summary": "카탈로그에 번들 표시", "description": "카탈로그에 번들을 표시합니다.", "operationId": "admin-show-bundle", "x-badges": [ { "name": "Server-side", "color": "#95ff80" }, { "name": "Admin", "color": "#d7dee0" } ], "security": [ { "basicAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/sku-path-param" } ], "tags": [ "bundles-admin" ], "responses": { "204": { "$ref": "#/components/responses/Bundles_204-admin-show-bundle" }, "401": { "$ref": "#/components/responses/Bundles_401-invalid-basic-auth" } } } }, "/v2/project/{project_id}/admin/items/bundle/sku/{sku}/hide": { "put": { "summary": "카탈로그에서 번들 숨기기", "description": "카탈로그에서 번들을 숨깁니다.", "operationId": "admin-hide-bundle", "x-badges": [ { "name": "Server-side", "color": "#95ff80" }, { "name": "Admin", "color": "#d7dee0" } ], "security": [ { "basicAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/sku-path-param" } ], "tags": [ "bundles-admin" ], "responses": { "204": { "$ref": "#/components/responses/Bundles_204-admin-hide-bundle" }, "401": { "$ref": "#/components/responses/Bundles_401-invalid-basic-auth" } } } }, "/v2/project/{project_id}/items/bundle": { "get": { "summary": "번들 목록 가져오기", "description": "카탈로그 작성을 위해 번들 목록을 가져옵니다.\n\n
\n 주의

\n 모든 프로젝트에는 응답에서 가져올 수 있는 항목 수에 제한이 있습니다. 기본 및 최대 값은 응답당 50개 항목입니다. 페이지별로 더 많은 데이터를 얻으려면 limit 및 offset 입력란을 사용하세요.\n
\n\n
\n\n
\n 참고

\n 이 API 호출은 인증 없이 사용될 때 일반적인 아이템 카탈로그 데이터를 반환합니다. 인증을 사용하여 아이템과 관련된 제한 및 프로모션과 같은 개인화된 사용자 데이터를 검색하세요. 이를 위해 Authorization 헤더에 사용자 JWT를 전달하십시오. 사용자 JWT에 대한 자세한 내용은 이 호출의 보안 블록을 참조하십시오.\n
", "security": [ { "XsollaLoginUserJWT": [] } ], "operationId": "get-bundle-list", "x-badges": [ { "name": "Client-side", "color": "#80eaff" } ], "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/limit-query-param" }, { "$ref": "#/components/parameters/offset-query-param" }, { "$ref": "#/components/parameters/locale-query-param" }, { "$ref": "#/components/parameters/additional_fields-query-param" }, { "$ref": "#/components/parameters/country-query-param" }, { "$ref": "#/components/parameters/promo_code-query-param" }, { "$ref": "#/components/parameters/show_inactive_time_limited_items-query-param" } ], "tags": [ "bundles-catalog" ], "responses": { "200": { "$ref": "#/components/responses/Bundles_200-get-bundle-list" } } } }, "/v2/project/{project_id}/items/bundle/sku/{sku}": { "get": { "summary": "지정한 번들 가져오기", "description": "지정된 번들을 가져옵니다.\n\n
\n 참고

\n 이 API 호출은 인증 없이 사용될 때 일반적인 아이템 카탈로그 데이터를 반환합니다. 인증을 사용하여 아이템과 관련된 제한 및 프로모션과 같은 개인화된 사용자 데이터를 검색하세요. 이를 위해 Authorization 헤더에 사용자 JWT를 전달하십시오. 사용자 JWT에 대한 자세한 내용은 이 호출의 보안 블록을 참조하십시오.\n
", "operationId": "get-bundle", "x-badges": [ { "name": "Client-side", "color": "#80eaff" } ], "security": [ { "XsollaLoginUserJWT": [] } ], "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/sku-path-param" }, { "$ref": "#/components/parameters/promo_code-query-param" }, { "$ref": "#/components/parameters/show_inactive_time_limited_items-query-param" }, { "$ref": "#/components/parameters/additional_fields-query-param" } ], "tags": [ "bundles-catalog" ], "responses": { "200": { "description": "지정한 번들을 성공적으로 수신했습니다.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Bundles_client_bundle" }, "examples": { "response": { "$ref": "#/components/examples/Bundles_200-get-bundle" } } } } } } } }, "/v2/project/{project_id}/items/bundle/group/{external_id}": { "get": { "summary": "지정한 그룹으로 번들 목록 가져오기", "description": "카탈로그 작성을 위해 그룹 내 번들 목록을 가져옵니다.\n\n
\n 주의

\n 모든 프로젝트에는 응답에서 가져올 수 있는 항목 수에 제한이 있습니다. 기본 및 최대 값은 응답당 50개 항목입니다. 페이지별로 더 많은 데이터를 얻으려면 limit 및 offset 입력란을 사용하세요.\n
\n\n
\n\n
\n 참고

\n 이 API 호출은 인증 없이 사용될 때 일반적인 아이템 카탈로그 데이터를 반환합니다. 인증을 사용하여 아이템과 관련된 제한 및 프로모션과 같은 개인화된 사용자 데이터를 검색하세요. 이를 위해 Authorization 헤더에 사용자 JWT를 전달하십시오. 사용자 JWT에 대한 자세한 내용은 이 호출의 보안 블록을 참조하십시오.\n
", "security": [ { "XsollaLoginUserJWT": [] } ], "operationId": "get-bundle-list-in-group", "x-badges": [ { "name": "Client-side", "color": "#80eaff" } ], "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/external_id-group-path-param" }, { "$ref": "#/components/parameters/limit-query-param" }, { "$ref": "#/components/parameters/offset-query-param" }, { "$ref": "#/components/parameters/locale-query-param" }, { "$ref": "#/components/parameters/additional_fields-query-param" }, { "$ref": "#/components/parameters/country-query-param" }, { "$ref": "#/components/parameters/promo_code-query-param" }, { "$ref": "#/components/parameters/show_inactive_time_limited_items-query-param" } ], "tags": [ "bundles-catalog" ], "responses": { "200": { "$ref": "#/components/responses/Bundles_200-get-bundle-list" } } } }, "/v2/project/{project_id}/cart/{cart_id}": { "get": { "summary": "장바구니 ID로 장바구니 가져오기", "description": "장바구니 ID로 사용자의 장바구니를 반환합니다.", "operationId": "get-cart-by-id", "x-badges": [ { "name": "Client-side", "color": "#80eaff" } ], "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/cart_id-path-param" }, { "$ref": "#/components/parameters/currency-query-param" }, { "$ref": "#/components/parameters/locale-query-param" } ], "tags": [ "cart-client-side" ], "responses": { "200": { "$ref": "#/components/responses/Cart-Payment_200-get-cart-json-model" } }, "security": [ { "AuthForCart": [] } ] } }, "/v2/project/{project_id}/cart": { "get": { "summary": "현재 사용자의 장바구니 가져오기", "description": "현재 사용자의 장바구니를 반환합니다.", "operationId": "get-user-cart", "x-badges": [ { "name": "Client-side", "color": "#80eaff" } ], "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/currency-query-param" }, { "$ref": "#/components/parameters/locale-query-param" } ], "tags": [ "cart-client-side" ], "responses": { "200": { "$ref": "#/components/responses/Cart-Payment_200-get-cart-json-model" } }, "security": [ { "AuthForCart": [] } ] } }, "/v2/project/{project_id}/cart/{cart_id}/clear": { "put": { "summary": "장바구니 ID로 모든 장바구니 아이템 삭제하기", "description": "모든 장바구니 아이템을 삭제합니다.", "operationId": "cart-clear-by-id", "x-badges": [ { "name": "Client-side", "color": "#80eaff" } ], "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/cart_id-path-param" } ], "tags": [ "cart-client-side" ], "responses": { "204": { "description": "장바구니 아이템이 성공적으로 삭제되었습니다." } }, "security": [ { "AuthForCart": [] } ] } }, "/v2/project/{project_id}/cart/clear": { "put": { "summary": "현재 장바구니에서 모든 장바구니 아이템 삭제", "description": "모든 장바구니 아이템을 삭제합니다.", "operationId": "cart-clear", "x-badges": [ { "name": "Client-side", "color": "#80eaff" } ], "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" } ], "tags": [ "cart-client-side" ], "responses": { "204": { "description": "장바구니 아이템이 성공적으로 삭제되었습니다." } }, "security": [ { "AuthForCart": [] } ] } }, "/v2/project/{project_id}/cart/fill": { "put": { "summary": "아이템으로 장바구니 채우기", "description": "장바구니를 아이템으로 채웁니다. 장바구니에 동일한 SKU를 가진 아이템이 이미 있으면 기존 아이템이 전달된 값으로 교체됩니다.", "operationId": "cart-fill", "x-badges": [ { "name": "Client-side", "color": "#80eaff" } ], "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" } ], "tags": [ "cart-client-side" ], "security": [ { "AuthForCart": [] } ], "requestBody": { "$ref": "#/components/requestBodies/Cart-Payment_fill-cart-json-model" }, "responses": { "200": { "$ref": "#/components/responses/Cart-Payment_200-fill-cart-json-model" } } } }, "/v2/project/{project_id}/cart/{cart_id}/fill": { "put": { "summary": "아이템으로 특정 장바구니 채우기", "description": "특정 장바구니를 아이템으로 채웁니다. 장바구니에 동일한 SKU를 가진 아이템이 이미 있으면 기존 아이템의 위치가 전달된 값으로 교체됩니다.", "operationId": "cart-fill-by-id", "x-badges": [ { "name": "Client-side", "color": "#80eaff" } ], "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/cart_id-path-param" } ], "tags": [ "cart-client-side" ], "security": [ { "AuthForCart": [] } ], "requestBody": { "$ref": "#/components/requestBodies/Cart-Payment_fill-cart-json-model" }, "responses": { "200": { "$ref": "#/components/responses/Cart-Payment_200-fill-cart-json-model" } } } }, "/v2/project/{project_id}/cart/{cart_id}/item/{item_sku}": { "put": { "summary": "장바구니 ID로 장바구니 아이템 업데이트하기", "description": "기존 장바구니 아이템을 업데이트하거나 장바구니에서 아이템을 생성합니다.", "operationId": "put-item-by-cart-id", "x-badges": [ { "name": "Client-side", "color": "#80eaff" } ], "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/cart_id-path-param" }, { "$ref": "#/components/parameters/item_sku-path-param" } ], "tags": [ "cart-client-side" ], "security": [ { "AuthForCart": [] } ], "requestBody": { "$ref": "#/components/requestBodies/Cart-Payment_put-item-by-cart-idJsonModel" }, "responses": { "204": { "description": "장바구니를 성공적으로 업데이트했습니다." }, "404": { "$ref": "#/components/responses/Cart-Payment_404-item" }, "422": { "$ref": "#/components/responses/Cart-Payment_422-non-negative-quantity" } } }, "delete": { "summary": "장바구니 ID로 장바구니 아이템 삭제하기", "description": "장바구니에서 아이템을 제거합니다.", "operationId": "delete-item-by-cart-id", "x-badges": [ { "name": "Client-side", "color": "#80eaff" } ], "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/cart_id-path-param" }, { "$ref": "#/components/parameters/item_sku-path-param" } ], "tags": [ "cart-client-side" ], "security": [ { "AuthForCart": [] } ], "responses": { "204": { "description": "장바구니에서 아이템을 성공적으로 삭제했습니다." }, "404": { "$ref": "#/components/responses/Cart-Payment_404-item" } } } }, "/v2/project/{project_id}/cart/item/{item_sku}": { "put": { "summary": "현재 장바구니에서 장바구니 아이템 업데이트", "description": "기존 장바구니 아이템을 업데이트하거나 장바구니에서 아이템을 생성합니다.", "operationId": "put-item", "x-badges": [ { "name": "Client-side", "color": "#80eaff" } ], "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/item_sku-path-param" } ], "tags": [ "cart-client-side" ], "security": [ { "AuthForCart": [] } ], "requestBody": { "$ref": "#/components/requestBodies/Cart-Payment_put-item-by-cart-idJsonModel" }, "responses": { "204": { "description": "장바구니를 성공적으로 업데이트했습니다." }, "404": { "$ref": "#/components/responses/Cart-Payment_404-item" }, "422": { "$ref": "#/components/responses/Cart-Payment_422-can-put-only-virtual-good-to-cart" } } }, "delete": { "summary": "현재 장바구니에서 장바구니 아이템 삭제", "description": "장바구니에서 아이템을 제거합니다.", "operationId": "delete-item", "x-badges": [ { "name": "Client-side", "color": "#80eaff" } ], "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/item_sku-path-param" } ], "tags": [ "cart-client-side" ], "security": [ { "AuthForCart": [] } ], "responses": { "204": { "description": "장바구니에서 아이템을 성공적으로 삭제했습니다." }, "404": { "$ref": "#/components/responses/Cart-Payment_404-item" } } } }, "/v2/project/{project_id}/payment/cart/{cart_id}": { "post": { "summary": "특정 장바구니의 모든 아이템으로 주문 생성", "description": "클라이언트-서버 연동에 사용됩니다. 특정 장바구니의 모든 아이템으로 주문을 생성하고 이에 대한 결제 토큰을 생성합니다. 생성된 주문은 `new` 주문 상태를 가져옵니다.\n\n클라이언트 IP는 사용자의 국가를 확인하는 데 사용되며, 해당 통화 및 주문에 사용 사용할 수 있는 결제 방식을 적용하는 데 사용됩니다.\n\n결제 UI를 새 창에서 열려면 `https://secure.xsolla.com/paystation4/?token={token}` 링크를 사용합니다. 여기서 `{token}`은 수신한 토큰입니다.\n\n테스트를 진행할 때에는 `https://sandbox-secure.xsolla.com/paystation4/?token={token}` URL을 사용합니다.\n\n
참고

이 방식은 IP를 사용하여 사용자의 국가를 확인하고 주문에 사용할 통화를 선택하므로 서버 측이 아닌 클라이언트 측에서만 이 방식을 사용해야 합니다. 서버 측에서 이 방식을 사용하면 통화가 잘못 결정되어 페이 스테이션의 결제 방식에 영향을 줄 수 있습니다.
", "operationId": "create-order-by-cart-id", "x-badges": [ { "name": "Client-side", "color": "#80eaff" } ], "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/cart_id-path-param" } ], "tags": [ "payment-client-side" ], "security": [ { "AuthForCart": [] } ], "requestBody": { "$ref": "#/components/requestBodies/Cart-Payment_create-order-by-cart-idJsonModel" }, "responses": { "200": { "$ref": "#/components/responses/Cart-Payment_200-order-created" }, "422": { "$ref": "#/components/responses/Cart-Payment_422-invalid-cart" } } } }, "/v2/project/{project_id}/payment/cart": { "post": { "summary": "현재 장바구니의 모든 아이템을 사용하는 주문 생성", "description": "클라이언트-서버 연동에 사용됩니다. 특정 장바구니의 모든 아이템으로 주문을 생성하고 이에 대한 결제 토큰을 생성합니다. 생성된 주문은 `new` 주문 상태를 가져옵니다.\n\n클라이언트 IP는 사용자의 국가를 확인하는 데 사용되며, 해당 통화 및 주문에 사용 사용할 수 있는 결제 방식을 적용하는 데 사용됩니다.\n\n결제 UI를 새 창에서 열려면 `https://secure.xsolla.com/paystation4/?token={token}` 링크를 사용합니다. 여기서 `{token}`은 수신한 토큰입니다.\n\n테스트를 진행할 때에는 `https://sandbox-secure.xsolla.com/paystation4/?token={token}` URL을 사용합니다.\n\n
참고

이 방식은 IP를 사용하여 사용자의 국가를 확인하고 주문에 사용할 통화를 선택하므로 서버 측이 아닌 클라이언트 측에서만 이 방식을 사용해야 합니다. 서버 측에서 이 방식을 사용하면 통화가 잘못 결정되어 페이 스테이션의 결제 방식에 영향을 줄 수 있습니다.
", "operationId": "create-order", "x-badges": [ { "name": "Client-side", "color": "#80eaff" } ], "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" } ], "tags": [ "payment-client-side" ], "security": [ { "AuthForCart": [] } ], "requestBody": { "$ref": "#/components/requestBodies/Cart-Payment_create-order-by-cart-idJsonModel" }, "responses": { "200": { "$ref": "#/components/responses/Cart-Payment_200-order-created" }, "422": { "$ref": "#/components/responses/Cart-Payment_422-invalid-cart" } } } }, "/v2/project/{project_id}/payment/item/{item_sku}": { "post": { "summary": "특정 아이템을 사용하는 주문 생성", "description": "클라이언트-서버 통합에 사용됩니다. 지정된 아이템으로 주문을 생성하고 결제 토큰을 생성합니다. 생성된 주문은 `new` 주문 상태를 갖습니다.\n\n클라이언트 IP는 사용자의 국가를 확인하는 데 사용되며, 해당 통화 및 주문에 사용 사용할 수 있는 결제 방식을 적용하는 데 사용됩니다.\n\n결제 UI를 새 창에서 열려면 `https://secure.xsolla.com/paystation4/?token={token}` 링크를 사용합니다. 여기서 `{token}`은 수신한 토큰입니다.\n\n테스트를 진행할 때에는 `https://sandbox-secure.xsolla.com/paystation4/?token={token}` URL을 사용합니다.\n\n
참고

이 방식은 IP를 사용하여 사용자의 국가를 확인하고 주문에 사용할 통화를 선택하므로 서버 측이 아닌 클라이언트 측에서만 이 방식을 사용해야 합니다. 서버 측에서 이 방식을 사용하면 통화가 잘못 결정되어 페이 스테이션의 결제 방식에 영향을 줄 수 있습니다.
\n\n
\n\n
\n Notice

\n 이 API 호출은 인증을 위해 사용자 JWT를 사용합니다.

\n Authorization 헤더에 Bearer <user_JWT> 형식으로 토큰을 포함하세요. 사용자 JWT에 대한 자세한 내용은 이 호출의 보안 블록을 참조하세요.\n
", "operationId": "create-order-with-item", "x-badges": [ { "name": "Client-side", "color": "#80eaff" } ], "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/item_sku-path-param" } ], "tags": [ "payment-client-side" ], "security": [ { "XsollaLoginUserJWT": [] } ], "requestBody": { "$ref": "#/components/requestBodies/Cart-Payment_create-order-with-specified-item-idJsonModel" }, "responses": { "200": { "$ref": "#/components/responses/Cart-Payment_200-order-created" }, "404": { "$ref": "#/components/responses/Cart-Payment_404-create-order-with-item-not-found-errors" }, "422": { "$ref": "#/components/responses/Cart-Payment_422-create-order-with-item-invalid" } } } }, "/v2/project/{project_id}/free/cart": { "post": { "summary": "무료 장바구니로 주문 생성하기", "description": "무료 장바구니의 모든 아이템으로 주문을 생성합니다. 생성된 주문은 `done` 주문 상태를 가져옵니다.", "operationId": "create-free-order", "x-badges": [ { "name": "Client-side", "color": "#80eaff" } ], "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" } ], "tags": [ "free-item" ], "security": [ { "AuthForCart": [] } ], "requestBody": { "$ref": "#/components/requestBodies/Cart-Payment_create-order-by-cart-idJsonModel" }, "responses": { "200": { "$ref": "#/components/responses/Cart-Free_200-order-created" }, "422": { "$ref": "#/components/responses/Cart-Payment_422-invalid-cart" } } } }, "/v2/project/{project_id}/free/cart/{cart_id}": { "post": { "summary": "특정 무료 장바구니로 주문 생성하기", "description": "특정 무료 장바구니의 모든 아이템으로 주문을 생성합니다. 생성된 주문은 `done` 주문 상태를 가져옵니다.", "operationId": "create-free-order-by-cart-id", "x-badges": [ { "name": "Client-side", "color": "#80eaff" } ], "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/cart_id-path-param" } ], "tags": [ "free-item" ], "security": [ { "AuthForCart": [] } ], "requestBody": { "$ref": "#/components/requestBodies/Cart-Payment_create-order-by-cart-idJsonModel" }, "responses": { "200": { "$ref": "#/components/responses/Cart-Free_200-order-created" }, "422": { "$ref": "#/components/responses/Cart-Payment_422-invalid-cart" } } } }, "/v2/project/{project_id}/free/item/{item_sku}": { "post": { "summary": "지정한 무료 아이템으로 주문 생성하기", "description": "지정된 무료 아이템으로 주문을 생성합니다. 생성된 주문은 `done` 주문 상태를 갖게 됩니다.
\n\n
\n 참고

\n 이 API 호출은 인증 없이 사용될 때 일반적인 아이템 카탈로그 데이터를 반환합니다. 인증을 사용하여 아이템과 관련된 제한 및 프로모션과 같은 개인화된 사용자 데이터를 검색하세요. 이를 위해 Authorization 헤더에 사용자 JWT를 전달하십시오. 사용자 JWT에 대한 자세한 내용은 이 호출의 보안 블록을 참조하십시오.\n
", "operationId": "create-free-order-with-item", "x-badges": [ { "name": "Client-side", "color": "#80eaff" } ], "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/item_sku-path-param" } ], "tags": [ "free-item" ], "security": [ { "XsollaLoginUserJWT": [] } ], "requestBody": { "$ref": "#/components/requestBodies/Cart-Payment_create-order-with-specified-item-idJsonModel" }, "responses": { "200": { "$ref": "#/components/responses/Cart-Free_200-order-created" }, "422": { "$ref": "#/components/responses/Cart-Payment_422-invalid-item" } } } }, "/v2/project/{project_id}/order/{order_id}": { "get": { "summary": "주문 가져오기", "description": "지정한 주문을 검색합니다.", "operationId": "get-order", "x-badges": [ { "name": "Client-side", "color": "#80eaff" } ], "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/order_id-path-param" } ], "tags": [ "order" ], "security": [ { "AuthForCart": [] } ], "responses": { "200": { "$ref": "#/components/responses/Cart-Payment_200-get-order" }, "404": { "$ref": "#/components/responses/Cart-Payment_404-get-order" } } } }, "/v3/project/{project_id}/admin/order/search": { "post": { "summary": "지정된 기간의 주문 목록 가져오기", "description": "가장 빠른 생성 날짜부터 최근 생성 날짜 순으로 정렬된 주문 목록을 검색합니다.", "operationId": "admin-order-search", "x-badges": [ { "name": "Server-side", "color": "#95ff80" }, { "name": "Admin", "color": "#d7dee0" } ], "tags": [ "order" ], "security": [ { "basicAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" } ], "requestBody": { "$ref": "#/components/requestBodies/admin-order-search" }, "responses": { "200": { "$ref": "#/components/responses/200-admin-order-search" }, "401": { "$ref": "#/components/responses/401-invalid-basic-auth" } } } }, "/v3/project/{project_id}/admin/payment/token": { "post": { "operationId": "admin-create-payment-token", "x-badges": [ { "name": "Server-side", "color": "#95ff80" } ], "summary": "구매용 결제 토큰 생성하기", "description": "주문 및 주문에 대한 지불 토큰을 생성합니다. 주문은 요청 본문에 전달된 아이템에 기반하여 생성됩니다.\n\n결제 UI를 새 창에서 열려면 `https://secure.xsolla.com/paystation4/?token={token}` 링크를 사용합니다. 여기서 `{token}`은 수신한 토큰입니다.\n\n테스트를 진행할 때에는 `https://sandbox-secure.xsolla.com/paystation4/?token={token}` URL을 사용합니다.\n\n
참고\n

\n user.country.value 매개 변수는 주문에 대한 통화를 선택하는 데 사용됩니다. 사용자의 국가를 알 수 없는 경우, 대신\n X-User-Ip 헤더의 사용자 IP를 제공할 수 있습니다.
이 메서드가 적절히 작동하기 위해서는 두 가지 옵션 중 하나가 필요합니다.
선택한 통화는 페이 스테이션의 결제 방식에 사용됩니다.\n
", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" } ], "tags": [ "payment-server-side" ], "security": [ { "basicAuth": [] } ], "requestBody": { "$ref": "#/components/requestBodies/Cart-Payment_admin-create-payment-token" }, "responses": { "201": { "$ref": "#/components/responses/Cart-Payment_201-admin-create-payment-token" }, "401": { "$ref": "#/components/responses/Cart-Payment_401-invalid-basic-auth" }, "422": { "$ref": "#/components/responses/Cart-Payment_422-admin-create-payment-token" } } } }, "/v2/admin/project/{project_id}/cart/fill": { "put": { "summary": "아이템으로 장바구니 채우기", "description": "현재 장바구니를 아이템으로 채웁니다. 장바구니에 동일한 SKU를 가진 아이템이 이미 있으면 기존 아이템이 전달된 값으로 교체됩니다.", "operationId": "admin-cart-fill", "x-badges": [ { "name": "Server-side", "color": "#95ff80" } ], "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/locale-query-param" }, { "$ref": "#/components/parameters/x-user-for-header" }, { "$ref": "#/components/parameters/x-user-id-header" } ], "tags": [ "cart-server-side" ], "security": [ { "basicAuth": [] } ], "requestBody": { "$ref": "#/components/requestBodies/Cart-Payment_admin-fill-cart-json-model" }, "responses": { "200": { "$ref": "#/components/responses/Cart-Payment_200-admin-fill-cart-json-model" }, "401": { "$ref": "#/components/responses/Cart-Payment_401-invalid-basic-auth" }, "404": { "$ref": "#/components/responses/Cart-Payment_404-user" }, "422": { "$ref": "#/components/responses/Cart-Payment_422-invalid-cart" } } } }, "/v2/admin/project/{project_id}/cart/{cart_id}/fill": { "put": { "summary": "장바구니 ID를 사용하는 장바구니 아이템으로 채우기", "description": "장바구니 ID별로 장바구니를 아이템으로 채웁니다. 장바구니에 동일한 SKU를 가진 아이템이 이미 있으면 기존 아이템이 전달된 값으로 교체됩니다.", "operationId": "admin-fill-cart-by-id", "x-badges": [ { "name": "Server-side", "color": "#95ff80" } ], "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/cart_id-path-param" }, { "$ref": "#/components/parameters/locale-query-param" }, { "$ref": "#/components/parameters/x-user-for-header" }, { "$ref": "#/components/parameters/x-user-id-header" } ], "tags": [ "cart-server-side" ], "security": [ { "basicAuth": [] } ], "requestBody": { "$ref": "#/components/requestBodies/Cart-Payment_admin-fill-cart-json-model" }, "responses": { "200": { "$ref": "#/components/responses/Cart-Payment_200-admin-fill-cart-json-model" }, "401": { "$ref": "#/components/responses/Cart-Payment_401-invalid-basic-auth" }, "404": { "$ref": "#/components/responses/Cart-Payment_404-user" }, "422": { "$ref": "#/components/responses/Cart-Payment_422-invalid-cart" } } } }, "/v2/project/{project_id}/admin/user/limit/item/all": { "delete": { "tags": [ "user-limits-admin" ], "security": [ { "basicAuth": [] } ], "operationId": "reset-all-user-items-limit", "x-badges": [ { "name": "Server-side", "color": "#95ff80" }, { "name": "Admin", "color": "#d7dee0" } ], "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" } ], "summary": "지정된 사용자의 모든 구매 제한 설정 새로고침", "description": "지정된 사용자가 해당 아이템을 다시 구매할 수 있도록 모든 아이템의 모든 구매 한도를 새로고침합니다.\n\n사용자 제한 API를 사용하면 제한된 수량만 아이템을 판매할 수 있습니다. 구매 한도를 구성하려면 원하는 아이템 유형 모듈의 관리 섹션으로 이동합니다.\n* [게임 키](https://developers.xsolla.com/ko/api/shop-builder/operation/admin-create-game/)\n* [가상 아이템 및 인게임 재화](https://developers.xsolla.com/ko/api/shop-builder/operation/admin-get-virtual-items-list/)\n* [번들](https://developers.xsolla.com/ko/api/shop-builder/operation/admin-get-bundle-list/)", "responses": { "200": { "description": "제한 설정을 성공적으로 새로고침했습니다." }, "401": { "$ref": "#/components/responses/Common_401-invalid-basic-auth" }, "404": { "description": "아이템을 찾을 수 없습니다.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer" }, "errorCode": { "type": "integer" }, "errorMessage": { "type": "string" }, "transactionId": { "type": "string" } } }, "examples": { "User not found": { "value": { "statusCode": 404, "errorCode": 5008, "errorMessage": "[0401-5008]: Could not find User" } } } } } }, "422": { "description": "잘못된 요청입니다.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer" }, "errorCode": { "type": "integer" }, "errorMessage": { "type": "string" }, "errorMessageExtended": { "type": "array", "items": { "type": "object", "properties": { "property": { "type": "string" }, "message": { "type": "string" } } } }, "transactionId": { "type": "string" } } }, "examples": { "Invalid user_external_id": { "value": { "statusCode": 404, "errorCode": 1102, "errorMessage": "[0401-1102]: Unprocessable Entity", "errorMessageExtended": [ { "property": "user_external_id", "message": "Must be at least 1 characters long" }, { "property": "user_external_id", "message": "Does not match the regex pattern ^\\S+$" } ] } } } } } } }, "requestBody": { "$ref": "#/components/requestBodies/reset-user-limits" } } }, "/v2/project/{project_id}/admin/user/limit/item/sku/{item_sku}/all": { "delete": { "tags": [ "user-limits-admin" ], "security": [ { "basicAuth": [] } ], "operationId": "reset-user-item-limit", "x-badges": [ { "name": "Server-side", "color": "#95ff80" }, { "name": "Admin", "color": "#d7dee0" } ], "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/item_sku-path-param" } ], "summary": "구매 한도 새로고침", "description": "사용자가 아이템을 다시 구입할 수 있도록 아이템의 구매 한도를 새로고침합니다. *user* 매개변수가 `null`인 경우 이 호출은 모든 사용자에 대해 이 제한을 새로고침합니다.\n\n사용자 제한 API를 사용하면 제한된 수량만 아이템을 판매할 수 있습니다. 구매 한도를 구성하려면 원하는 아이템 유형 모듈의 관리 섹션으로 이동합니다.\n* [게임 키](https://developers.xsolla.com/ko/api/shop-builder/operation/admin-create-game/)\n* [가상 아이템 및 인게임 재화](https://developers.xsolla.com/ko/api/shop-builder/operation/admin-get-virtual-items-list/)\n* [번들](https://developers.xsolla.com/ko/api/shop-builder/operation/admin-get-bundle-list/)", "responses": { "200": { "description": "제한 설정을 성공적으로 새로고침했습니다." }, "401": { "$ref": "#/components/responses/Common_401-invalid-basic-auth" }, "404": { "description": "아이템을 찾을 수 없습니다.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer" }, "errorCode": { "type": "integer" }, "errorMessage": { "type": "string" }, "transactionId": { "type": "string" } } }, "examples": { "Item not found": { "$ref": "#/components/examples/404-item-by-sku-not-found" }, "User not found": { "$ref": "#/components/examples/404-user-not-found" } } } } }, "422": { "description": "잘못된 요청입니다.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer" }, "errorCode": { "type": "integer" }, "errorMessage": { "type": "string" }, "errorMessageExtended": { "type": "array" }, "transactionId": { "type": "string" } } }, "examples": { "Invalid user_external_id": { "$ref": "#/components/examples/422-user_external_id_invalid" }, "Item does not have configured user limits": { "$ref": "#/components/examples/422-item-without-user-limit" } } } } } }, "requestBody": { "$ref": "#/components/requestBodies/reset-user-limits-flexible" } } }, "/v2/project/{project_id}/admin/user/limit/item/sku/{item_sku}": { "get": { "tags": [ "user-limits-admin" ], "security": [ { "basicAuth": [] } ], "operationId": "get-user-item-limit", "x-badges": [ { "name": "Server-side", "color": "#95ff80" }, { "name": "Admin", "color": "#d7dee0" } ], "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/item_sku-path-param" }, { "$ref": "#/components/parameters/user_external_id-query-param" } ], "summary": "지정된 사용자가 사용할 수 있는 아이템의 수량을 가져옵니다", "description": "적용된 한도 내에서 지정된 사용자에게 제공할 수 있는 남은 아이템 수를 가져옵니다.\n\n사용자 제한 API를 사용하면 제한된 수량만 아이템을 판매할 수 있습니다. 구매 한도를 구성하려면 원하는 아이템 유형 모듈의 관리 섹션으로 이동합니다.\n* [게임 키](https://developers.xsolla.com/ko/api/shop-builder/operation/admin-create-game/)\n* [가상 아이템 및 인게임 재화](https://developers.xsolla.com/ko/api/shop-builder/operation/admin-get-virtual-items-list/)\n* [번들](https://developers.xsolla.com/ko/api/shop-builder/operation/admin-get-bundle-list/)", "responses": { "200": { "$ref": "#/components/responses/200-admin-get-user-item-limits" }, "401": { "$ref": "#/components/responses/Common_401-invalid-basic-auth" }, "404": { "description": "아이템을 찾을 수 없습니다.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer" }, "errorCode": { "type": "integer" }, "errorMessage": { "type": "string" }, "transactionId": { "type": "string" } } }, "examples": { "Item not found": { "$ref": "#/components/examples/404-item-by-sku-not-found" }, "User not found": { "$ref": "#/components/examples/404-user-not-found" } } } } }, "422": { "description": "잘못된 요청입니다.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer" }, "errorCode": { "type": "integer" }, "errorMessage": { "type": "string" }, "errorMessageExtended": { "type": "array" }, "transactionId": { "type": "string" } } }, "examples": { "Invalid user_external_id": { "$ref": "#/components/examples/422-user_external_id_invalid" }, "Item does not have configured user limits": { "$ref": "#/components/examples/422-item-without-user-limit" } } } } } } }, "post": { "tags": [ "user-limits-admin" ], "security": [ { "basicAuth": [] } ], "operationId": "add-user-item-limit", "x-badges": [ { "name": "Server-side", "color": "#95ff80" }, { "name": "Admin", "color": "#d7dee0" } ], "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/item_sku-path-param" } ], "summary": "지정된 사용자가 사용할 수 있는 아이템의 수량을 늘립니다", "description": "적용된 제한 설정 내에서 지정된 사용자가 사용할 수 있는 남은 아이템 개수를 늘립니다.\n\n사용자 제한 API를 사용하면 제한된 수량만 아이템을 판매할 수 있습니다. 구매 한도를 구성하려면 원하는 아이템 유형 모듈의 관리 섹션으로 이동합니다.\n* [게임 키](https://developers.xsolla.com/ko/api/shop-builder/operation/admin-create-game/)\n* [가상 아이템 및 인게임 재화](https://developers.xsolla.com/ko/api/shop-builder/operation/admin-get-virtual-items-list/)\n* [번들](https://developers.xsolla.com/ko/api/shop-builder/operation/admin-get-bundle-list/)", "responses": { "200": { "$ref": "#/components/responses/200-admin-get-user-item-limits" }, "401": { "$ref": "#/components/responses/Common_401-invalid-basic-auth" }, "404": { "description": "아이템을 찾을 수 없습니다.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer" }, "errorCode": { "type": "integer" }, "errorMessage": { "type": "string" }, "transactionId": { "type": "string" } } }, "examples": { "Item not found": { "$ref": "#/components/examples/404-item-by-sku-not-found" }, "User not found": { "$ref": "#/components/examples/404-user-not-found" } } } } }, "422": { "description": "잘못된 요청입니다.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer" }, "errorCode": { "type": "integer" }, "errorMessage": { "type": "string" }, "errorMessageExtended": { "type": "array" }, "transactionId": { "type": "string" } } }, "examples": { "Invalid user_external_id": { "$ref": "#/components/examples/422-user_external_id_invalid" }, "Item does not have configured user limits": { "$ref": "#/components/examples/422-item-without-user-limit" }, "Available item limit is out of range": { "$ref": "#/components/examples/422-item-out-of-range-available-user-limit" } } } } } }, "requestBody": { "$ref": "#/components/requestBodies/update-user-limits-strict" } }, "put": { "tags": [ "user-limits-admin" ], "security": [ { "basicAuth": [] } ], "operationId": "set-user-item-limit", "x-badges": [ { "name": "Server-side", "color": "#95ff80" }, { "name": "Admin", "color": "#d7dee0" } ], "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/item_sku-path-param" } ], "summary": "지정된 사용자가 사용할 수 있는 아이템의 수량을 설정합니다", "description": "지정된 사용자가 제한 설정이 증가되거나 감소된 후 적용된 제한 설정 내에서 구매할 수 있는 아이템 개수를 설정합니다.\n\n사용자 제한 API를 사용하면 제한된 수량만 아이템을 판매할 수 있습니다. 구매 한도를 구성하려면 원하는 아이템 유형 모듈의 관리 섹션으로 이동합니다.\n* [게임 키](https://developers.xsolla.com/ko/api/shop-builder/operation/admin-create-game/)\n* [가상 아이템 및 인게임 재화](https://developers.xsolla.com/ko/api/shop-builder/operation/admin-get-virtual-items-list/)\n* [번들](https://developers.xsolla.com/ko/api/shop-builder/operation/admin-get-bundle-list/)", "responses": { "200": { "$ref": "#/components/responses/200-admin-get-user-item-limits" }, "401": { "$ref": "#/components/responses/Common_401-invalid-basic-auth" }, "404": { "description": "아이템을 찾을 수 없습니다.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer" }, "errorCode": { "type": "integer" }, "errorMessage": { "type": "string" }, "transactionId": { "type": "string" } } }, "examples": { "Item not found": { "$ref": "#/components/examples/404-item-by-sku-not-found" }, "User not found": { "$ref": "#/components/examples/404-user-not-found" } } } } }, "422": { "description": "잘못된 요청입니다.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer" }, "errorCode": { "type": "integer" }, "errorMessage": { "type": "string" }, "errorMessageExtended": { "type": "array" }, "transactionId": { "type": "string" } } }, "examples": { "Invalid user_external_id": { "$ref": "#/components/examples/422-user_external_id_invalid" }, "Item does not have configured user limits": { "$ref": "#/components/examples/422-item-without-user-limit" } } } } } }, "requestBody": { "$ref": "#/components/requestBodies/update-user-limits-flexible" } }, "delete": { "tags": [ "user-limits-admin" ], "security": [ { "basicAuth": [] } ], "operationId": "remove-user-item-limit", "x-badges": [ { "name": "Server-side", "color": "#95ff80" }, { "name": "Admin", "color": "#d7dee0" } ], "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/item_sku-path-param" } ], "summary": "지정된 사용자가 사용할 수 있는 아이템 개수를 줄입니다", "description": "적용된 제한 설정 내에서 지정된 사용자가 사용할 수 있는 남은 아이템 개수를 줄입니다.\n\n사용자 제한 API를 사용하면 제한된 수량만 아이템을 판매할 수 있습니다. 구매 한도를 구성하려면 원하는 아이템 유형 모듈의 관리 섹션으로 이동합니다.\n* [게임 키](https://developers.xsolla.com/ko/api/shop-builder/operation/admin-create-game/)\n* [가상 아이템 및 인게임 재화](https://developers.xsolla.com/ko/api/shop-builder/operation/admin-get-virtual-items-list/)\n* [번들](https://developers.xsolla.com/ko/api/shop-builder/operation/admin-get-bundle-list/)", "responses": { "200": { "$ref": "#/components/responses/200-admin-get-user-item-limits" }, "401": { "$ref": "#/components/responses/Common_401-invalid-basic-auth" }, "404": { "description": "아이템을 찾을 수 없습니다.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer" }, "errorCode": { "type": "integer" }, "errorMessage": { "type": "string" }, "transactionId": { "type": "string" } } }, "examples": { "Item not found": { "$ref": "#/components/examples/404-item-by-sku-not-found" }, "User not found": { "$ref": "#/components/examples/404-user-not-found" } } } } }, "422": { "description": "잘못된 요청입니다.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer" }, "errorCode": { "type": "integer" }, "errorMessage": { "type": "string" }, "errorMessageExtended": { "type": "array" }, "transactionId": { "type": "string" } } }, "examples": { "Invalid user_external_id": { "$ref": "#/components/examples/422-user_external_id_invalid" }, "Item does not have configured user limits": { "$ref": "#/components/examples/422-item-without-user-limit" }, "Available item limit is out of range": { "$ref": "#/components/examples/422-item-out-of-range-available-user-limit" } } } } } }, "requestBody": { "$ref": "#/components/requestBodies/update-user-limits-strict" } } }, "/v1/projects/{project_id}/import/from_external_file": { "post": { "tags": [ "connector-admin" ], "operationId": "import-items-from-external-file", "summary": "JSON 파일을 통해 아이템 가져오기", "description": "지정된 URL을 통해 JSON 파일에서 스토어로 아이템을 가져옵니다. JSON 파일에서 가져오기에 대한 자세한 정보는 [설명서](https://developers.xsolla.com/ko/doc/shop-builder/how-to/json-import/)를 참조하세요.", "servers": [ { "url": "https://connector.xsolla.com" } ], "x-badges": [ { "name": "Server-side", "color": "#95ff80" }, { "name": "Admin", "color": "#d7dee0" } ], "responses": { "201": { "description": "파일을 성공적으로 가져와서 처리 중입니다.", "content": { "application/json": { "schema": { "type": "object", "properties": { "import_id": { "type": "string", "example": "af9f3638a16e11ef880da2cd677d2d24", "description": "Import operation ID. If you encounter difficulties importing the JSON file, report this ID to your Customer Success Manager or send an email to csm@xsolla.com." } } } } } }, "401": { "$ref": "#/components/responses/401-invalid-basic-auth" }, "422": { "$ref": "#/components/responses/connector-422-validation-failed" } }, "security": [ { "basicAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" } ], "requestBody": { "$ref": "#/components/requestBodies/connector-import-items-body" } } }, "/v1/admin/projects/{project_id}/connectors/import_items/import/status": { "get": { "tags": [ "connector-admin" ], "operationId": "get-items-import-status", "summary": "아이템 가져오기 상태 검색", "description": "프로젝트로 아이템을 가져오는 진행률에 대한 정보를 검색합니다. 이 API 호출은 API 또는 관리자 페이지 API를 통해 수행된 마지막 가져오기에 대한 데이터를 검색합니다.", "servers": [ { "url": "https://connector.xsolla.com" } ], "x-badges": [ { "name": "Server-side", "color": "#95ff80" }, { "name": "Admin", "color": "#d7dee0" } ], "responses": { "200": { "$ref": "#/components/responses/200-items-import-status-model" }, "401": { "$ref": "#/components/responses/401-invalid-basic-auth" } }, "security": [ { "basicAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" } ] } }, "/v2/project/{project_id}/admin/webhook/version": { "put": { "tags": [ "common-webhooks" ], "security": [ { "basicAuth": [] } ], "operationId": "update-webhook-version", "x-badges": [ { "name": "Server-side", "color": "#95ff80" }, { "name": "Admin", "color": "#d7dee0" } ], "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" } ], "summary": "웹훅 버전 업데이트", "description": "프로젝트의 웹훅 버전을 업데이트합니다. 버전 2에서는 `items` 배열에 추가 매개 변수가 포함됩니다.\n\n웹훅에 대한 자세한 내용은 [주문 상태 추적 설정](https://developers.xsolla.com/ko/doc/shop-builder/integration-guide/set-up-webhooks/)을 참조해 주세요.", "responses": { "204": { "description": "웹훅 버전이 업데이트되었습니다." }, "401": { "$ref": "#/components/responses/Common_401-invalid-basic-auth" }, "422": { "description": "요청 유효성 검사 오류입니다.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/422-invalid-request-extended" }, "examples": { "response": { "value": { "statusCode": 422, "errorCode": 1102, "errorMessage": "[0401-1102]: Unprocessable Entity", "errorMessageExtended": [ { "property": "version", "message": "Must have a minimum value of 1" } ], "transactionId": "da145238620011eb8e24fe6913ff226a" } } } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "version": { "type": "integer", "description": "Webhook version. Version 1 is used by default. In version 2, the `items` array includes the following parameters: `is_free`, `is_bonus`, and `is_bundle_content` parameters.", "enum": [ 1, 2 ], "example": 2 } }, "required": [ "version" ] }, "example": { "version": 2 } } } } } }, "/v2/project/{project_id}/admin/items/pre_order/limit/item/sku/{item_sku}": { "get": { "tags": [ "common-pre-orders" ], "security": [ { "basicAuth": [] } ], "operationId": "get-pre-order-limit", "x-badges": [ { "name": "Server-side", "color": "#95ff80" }, { "name": "Admin", "color": "#d7dee0" } ], "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/item_sku-path-param" } ], "summary": "아이템의 사전 판매 제한에 대한 정보 가져오기", "description": "아이템의 사전 판매 수량 제한을 가져옵니다.\n\n사전 판매 제한 API를 사용하면 제한된 수량의 아이템을 판매할 수 있습니다. 사전 판매를 구성하려면 원하는 아이템 모듈의 관리자 섹션으로 이동합니다.\n* [게임 키](https://developers.xsolla.com/ko/api/shop-builder/operation/admin-create-game/)\n* [가상 아이템 및 인게임 재화](https://developers.xsolla.com/ko/api/shop-builder/operation/admin-get-virtual-items-list/)\n* [번들](https://developers.xsolla.com/ko/api/shop-builder/operation/admin-get-bundle-list/)\n\n이 엔드포인트의 별칭:\n* /v2/project/{project_id}/admin/items/pre_order/limit/item/id/{item_id}", "responses": { "200": { "description": "아이템 사전 판매 제한에 대한 정보를 성공적으로 수신했습니다.", "content": { "application/json": { "schema": { "type": "object", "properties": { "item_id": { "type": "integer", "example": 1 }, "sku": { "type": "string", "example": "com.xsolla.item_1" }, "is_pre_order_limit_enabled": { "type": "boolean", "example": true }, "available": { "type": "integer", "example": 431 }, "reserved": { "type": "integer", "example": 13 }, "sold": { "type": "integer", "example": 556 } } }, "examples": { "response": { "value": { "item_id": 1, "sku": "com.xsolla.item_1", "is_pre_order_limit_enabled": true, "available": 431, "reserved": 13, "sold": 556 } } } } } }, "401": { "$ref": "#/components/responses/Common_401-invalid-basic-auth" }, "404": { "description": "아이템을 찾을 수 없습니다." } } }, "post": { "tags": [ "common-pre-orders" ], "security": [ { "basicAuth": [] } ], "operationId": "add-pre-order-limit", "x-badges": [ { "name": "Server-side", "color": "#95ff80" }, { "name": "Admin", "color": "#d7dee0" } ], "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/item_sku-path-param" } ], "summary": "아이템 사전 판매 제한에 수량 추가하기", "description": "아이템의 사전 판매 수량 제한에 수량을 추가합니다.\n\n사전 판매 제한 API를 사용하면 제한된 수량의 아이템을 판매할 수 있습니다. 사전 판매를 구성하려면 원하는 아이템 모듈의 관리자 섹션으로 이동합니다.\n* [게임 키](https://developers.xsolla.com/ko/api/shop-builder/operation/admin-create-game/)\n* [가상 아이템 및 인게임 재화](https://developers.xsolla.com/ko/api/shop-builder/operation/admin-get-virtual-items-list/)\n* [번들](https://developers.xsolla.com/ko/api/shop-builder/operation/admin-get-bundle-list/)\n\n이 엔드포인트의 별칭:\n* /v2/project/{project_id}/admin/items/pre_order/limit/item/id/{item_id}", "responses": { "201": { "description": "제한할 수량이 성공적으로 추가했습니다." }, "401": { "$ref": "#/components/responses/Common_401-invalid-basic-auth" }, "404": { "description": "아이템을 찾을 수 없습니다." } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "quantity": { "type": "integer", "description": "Quantity to add." } }, "required": [ "quantity" ] }, "example": { "quantity": 100000 } } } } }, "put": { "tags": [ "common-pre-orders" ], "security": [ { "basicAuth": [] } ], "operationId": "set-pre-order-limit", "x-badges": [ { "name": "Server-side", "color": "#95ff80" }, { "name": "Admin", "color": "#d7dee0" } ], "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/item_sku-path-param" } ], "summary": "아이템의 사전 판매 수량 제한 설정", "description": "아이템의 사전 판매 수량 제한에 대한 수량을 설정합니다.\n\n사전 판매 제한 API를 사용하면 제한된 수량의 아이템을 판매할 수 있습니다. 사전 판매를 구성하려면 원하는 아이템 모듈의 관리자 섹션으로 이동합니다.\n* [게임 키](https://developers.xsolla.com/ko/api/shop-builder/operation/admin-create-game/)\n* [가상 아이템 및 인게임 재화](https://developers.xsolla.com/ko/api/shop-builder/operation/admin-get-virtual-items-list/)\n* [번들](https://developers.xsolla.com/ko/api/shop-builder/operation/admin-get-bundle-list/)\n\n이 엔드포인트의 별칭:\n* /v2/project/{project_id}/admin/items/pre_order/limit/item/id/{item_id}", "responses": { "204": { "description": "제한할 수량을 성공적으로 설정했습니다." }, "401": { "$ref": "#/components/responses/Common_401-invalid-basic-auth" }, "404": { "description": "아이템을 찾을 수 없습니다." } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "quantity": { "type": "integer", "description": "Quantity to set." } }, "required": [ "quantity" ] }, "example": { "quantity": 100000 } } } } }, "delete": { "tags": [ "common-pre-orders" ], "security": [ { "basicAuth": [] } ], "operationId": "remove-pre-order-limit", "x-badges": [ { "name": "Server-side", "color": "#95ff80" }, { "name": "Admin", "color": "#d7dee0" } ], "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/item_sku-path-param" } ], "summary": "아이템의 사전 판매 수량 제한 제거", "description": "아이템의 사전 판매 수량 제한을 제거합니다.\n\n사전 판매 제한 API를 사용하면 제한된 수량의 아이템을 판매할 수 있습니다. 사전 판매를 구성하려면 원하는 아이템 모듈의 관리자 섹션으로 이동합니다.\n* [게임 키](https://developers.xsolla.com/ko/api/shop-builder/operation/admin-create-game/)\n* [가상 아이템 및 인게임 재화](https://developers.xsolla.com/ko/api/shop-builder/operation/admin-get-virtual-items-list/)\n* [번들](https://developers.xsolla.com/ko/api/shop-builder/operation/admin-get-bundle-list/)\n\n이 엔드포인트의 별칭:\n* /v2/project/{project_id}/admin/items/pre_order/limit/item/id/{item_id}", "responses": { "204": { "description": "제한한 수량 설정을 성공적으로 제거했습니다." }, "401": { "$ref": "#/components/responses/Common_401-invalid-basic-auth" }, "404": { "description": "아이템을 찾을 수 없습니다." } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "quantity": { "type": "integer", "description": "Quantity to remove." } }, "required": [ "quantity" ] }, "example": { "quantity": 100000 } } } } } }, "/v2/project/{project_id}/admin/items/pre_order/limit/item/sku/{item_sku}/toggle": { "put": { "tags": [ "common-pre-orders" ], "security": [ { "basicAuth": [] } ], "operationId": "toggle-pre-order-limit", "x-badges": [ { "name": "Server-side", "color": "#95ff80" }, { "name": "Admin", "color": "#d7dee0" } ], "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/item_sku-path-param" } ], "summary": "아이템의 사전 판매 제한 토글", "description": "아이템의 사전 주문 제한을 활성화/비활성화합니다.\n\n사전 판매 제한 API를 사용하면 제한된 수량의 아이템을 판매할 수 있습니다. 사전 판매를 구성하려면 원하는 아이템 모듈의 관리자 섹션으로 이동합니다.\n* [게임 키](https://developers.xsolla.com/ko/api/shop-builder/operation/admin-create-game/)\n* [가상 아이템 및 인게임 재화](https://developers.xsolla.com/ko/api/shop-builder/operation/admin-get-virtual-items-list/)\n* [번들](https://developers.xsolla.com/ko/api/shop-builder/operation/admin-get-bundle-list/)\n\n이 엔드포인트의 별칭:\n* /v2/project/{project_id}/admin/items/pre_order/limit/item/id/{item_id}", "responses": { "204": { "description": "한도가 비활성화/활성화되었습니다." }, "401": { "$ref": "#/components/responses/Common_401-invalid-basic-auth" }, "404": { "description": "아이템을 찾을 수 없습니다." } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "is_pre_order_limit_enabled": { "type": "boolean" } }, "required": [ "is_pre_order_limit_enabled" ] }, "example": { "is_pre_order_limit_enabled": true } } } } } }, "/v2/project/{project_id}/admin/items/pre_order/limit/item/sku/{item_sku}/all": { "delete": { "tags": [ "common-pre-orders" ], "security": [ { "basicAuth": [] } ], "operationId": "remove-all-pre-order-limit", "x-badges": [ { "name": "Server-side", "color": "#95ff80" }, { "name": "Admin", "color": "#d7dee0" } ], "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/item_sku-path-param" } ], "summary": "아이템의 모든 사전 판매 수량 제한 제거", "description": "아이템의 모든 사전 판매 수량 제한을 제거합니다.\n\n사전 판매 제한 API를 사용하면 제한된 수량의 아이템을 판매할 수 있습니다. 사전 판매를 구성하려면 원하는 아이템 모듈의 관리자 섹션으로 이동합니다.\n* [게임 키](https://developers.xsolla.com/ko/api/shop-builder/operation/admin-create-game/)\n* [가상 아이템 및 인게임 재화](https://developers.xsolla.com/ko/api/shop-builder/operation/admin-get-virtual-items-list/)\n* [번들](https://developers.xsolla.com/ko/api/shop-builder/operation/admin-get-bundle-list/)\n\n이 엔드포인트의 별칭:\n* /v2/project/{project_id}/admin/items/pre_order/limit/item/id/{item_id}", "responses": { "204": { "description": "한도를 성공적으로 제거했습니다." }, "401": { "$ref": "#/components/responses/Common_401-invalid-basic-auth" }, "404": { "description": "아이템을 찾을 수 없습니다." } } } }, "/v2/merchant/{merchant_id}/projects": { "get": { "tags": [ "common-merchant" ], "operationId": "get-projects", "x-badges": [ { "name": "Server-side", "color": "#95ff80" }, { "name": "Admin", "color": "#d7dee0" } ], "security": [ { "basicMerchantAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/limit-query-param" }, { "$ref": "#/components/parameters/offset-query-param" }, { "$ref": "#/components/parameters/merchant_id-path-param" } ], "summary": "프로젝트 가져오기", "description": "판매자의 프로젝트 목록을 가져옵니다.\n\n
\n

참고

이 API 호출에는 project_id path 매개 변수가 포함되어 있지 않으므로 회사의 모든 프로젝트에서 유효한 API 키를 사용하여 권한 부여를 설정해야 합니다.

\n
", "responses": { "200": { "description": "프로젝트 정보를 성공적으로 수신했습니다.", "content": { "application/json": { "schema": { "type": "object", "properties": { "total_items_count": { "type": "integer", "example": 3 }, "has_more": { "type": "boolean", "example": true }, "items": { "type": "array", "properties": { "project_id": { "type": "integer", "example": 17558 } } } } }, "examples": { "response": { "value": { "total_items_count": 2, "has_more": false, "items": [ { "project_id": 17558 }, { "project_id": 17559 } ] } } } } } }, "401": { "description": "기본 인증이 전달되지 않았거나 잘못되었습니다. 기본 인증 또는 올바른 자격 증명을 사용했는지 확인해야 합니다." }, "422": { "description": "잘못된 `limit` 또는 `offset` 쿼리 매개 변수입니다." } } } }, "/v2/project/{project_id}/items": { "get": { "summary": "판매할 수 있는 아이템 목록 가져오기", "description": "카탈로그 작성을 위해 판매할 수 있는 아이템 목록을 가져옵니다.\n\n
\n 주의

\n 모든 프로젝트에는 응답에서 가져올 수 있는 항목 수에 제한이 있습니다. 기본 및 최대 값은 응답당 50개 항목입니다. 페이지별로 더 많은 데이터를 얻으려면 limit 및 offset 입력란을 사용하세요.\n
\n\n
\n\n
\n 참고

\n 이 API 호출은 인증 없이 사용될 때 일반적인 아이템 카탈로그 데이터를 반환합니다. 인증을 사용하여 아이템과 관련된 제한 및 프로모션과 같은 개인화된 사용자 데이터를 검색하세요. 이를 위해 Authorization 헤더에 사용자 JWT를 전달하십시오. 사용자 JWT에 대한 자세한 내용은 이 호출의 보안 블록을 참조하십시오.\n
", "security": [ { "XsollaLoginUserJWT": [] } ], "operationId": "get-sellable-items", "x-badges": [ { "name": "Client-side", "color": "#80eaff" } ], "parameters": [ { "$ref": "#/components/parameters/project_id_59080-path-param" }, { "$ref": "#/components/parameters/limit-query-param" }, { "$ref": "#/components/parameters/offset-query-param" }, { "$ref": "#/components/parameters/locale-query-param" }, { "$ref": "#/components/parameters/additional_fields-query-param" }, { "$ref": "#/components/parameters/country-query-param" }, { "$ref": "#/components/parameters/promo_code-query-param" }, { "$ref": "#/components/parameters/show_inactive_time_limited_items-query-param" } ], "tags": [ "common-catalog" ], "responses": { "200": { "$ref": "#/components/responses/sellable_items_200-get-items-list" } } } }, "/v2/project/{project_id}/items/id/{item_id}": { "get": { "summary": "ID를 사용하여 판매 가능한 아이템 가져오기", "description": "ID로 판매 가능한 아이템을 가져옵니다.\n\n
\n 참고

\n 이 API 호출은 인증 없이 사용될 때 일반적인 아이템 카탈로그 데이터를 반환합니다. 인증을 사용하여 아이템과 관련된 제한 및 프로모션과 같은 개인화된 사용자 데이터를 검색하세요. 이를 위해 Authorization 헤더에 사용자 JWT를 전달하십시오. 사용자 JWT에 대한 자세한 내용은 이 호출의 보안 블록을 참조하십시오.\n
", "operationId": "get-sellable-item-by-id", "x-badges": [ { "name": "Client-side", "color": "#80eaff" } ], "security": [ { "XsollaLoginUserJWT": [] } ], "parameters": [ { "$ref": "#/components/parameters/project_id_59080-path-param" }, { "$ref": "#/components/parameters/item_id_59080-path-param" }, { "$ref": "#/components/parameters/promo_code-query-param" }, { "$ref": "#/components/parameters/show_inactive_time_limited_items-query-param" }, { "$ref": "#/components/parameters/additional_fields-query-param" } ], "tags": [ "common-catalog" ], "responses": { "200": { "$ref": "#/components/responses/sellable_items_200-get-item-by-id" }, "404": { "$ref": "#/components/responses/sellable-item-by-id_404" } } } }, "/v2/project/{project_id}/items/sku/{sku}": { "get": { "summary": "SKU로 판매할 수 있는 아이템 가져오기", "description": "카탈로그를 작성하기 위해 SKU별로 판매 가능한 항목을 가져옵니다.\n\n
\n 참고

\n 이 API 호출은 인증 없이 사용될 때 일반적인 아이템 카탈로그 데이터를 반환합니다. 인증을 사용하여 아이템과 관련된 제한 및 프로모션과 같은 개인화된 사용자 데이터를 검색하세요. 이를 위해 Authorization 헤더에 사용자 JWT를 전달하십시오. 사용자 JWT에 대한 자세한 내용은 이 호출의 보안 블록을 참조하십시오.\n
", "operationId": "get-sellable-item-by-sku", "x-badges": [ { "name": "Client-side", "color": "#80eaff" } ], "security": [ { "XsollaLoginUserJWT": [] } ], "parameters": [ { "$ref": "#/components/parameters/project_id_59080-path-param" }, { "$ref": "#/components/parameters/item_sku_59080-path-param" }, { "$ref": "#/components/parameters/promo_code-query-param" }, { "$ref": "#/components/parameters/show_inactive_time_limited_items-query-param" }, { "$ref": "#/components/parameters/additional_fields-query-param" } ], "tags": [ "common-catalog" ], "responses": { "200": { "$ref": "#/components/responses/sellable_items_200-get-item-by-id" }, "404": { "$ref": "#/components/responses/sellable-item-by-sku_404" } } } }, "/v2/project/{project_id}/items/group/{external_id}": { "get": { "summary": "지정한 그룹으로 판매할 수 있는 아이템 목록 가져오기", "description": "카탈로그 작성을 위해 지정된 그룹에서 판매할 수 있는 아이템 목록을 가져옵니다.\n\n
\n 주의

\n 모든 프로젝트에는 응답에서 가져올 수 있는 항목 수에 제한이 있습니다. 기본 및 최대 값은 응답당 50개 항목입니다. 페이지별로 더 많은 데이터를 얻으려면 limit 및 offset 입력란을 사용하세요.\n
\n\n
\n\n
\n 참고

\n 이 API 호출은 인증 없이 사용될 때 일반적인 아이템 카탈로그 데이터를 반환합니다. 인증을 사용하여 아이템과 관련된 제한 및 프로모션과 같은 개인화된 사용자 데이터를 검색하세요. 이를 위해 Authorization 헤더에 사용자 JWT를 전달하십시오. 사용자 JWT에 대한 자세한 내용은 이 호출의 보안 블록을 참조하십시오.\n
", "security": [ { "XsollaLoginUserJWT": [] } ], "operationId": "get-sellable-items-group", "x-badges": [ { "name": "Client-side", "color": "#80eaff" } ], "parameters": [ { "$ref": "#/components/parameters/project_id_59080-path-param" }, { "$ref": "#/components/parameters/external_id_59080-group-path-param" }, { "$ref": "#/components/parameters/limit-query-param" }, { "$ref": "#/components/parameters/offset-query-param" }, { "$ref": "#/components/parameters/locale-query-param" }, { "$ref": "#/components/parameters/additional_fields-query-param" }, { "$ref": "#/components/parameters/country-query-param" }, { "$ref": "#/components/parameters/promo_code-query-param" }, { "$ref": "#/components/parameters/show_inactive_time_limited_items-query-param" } ], "tags": [ "common-catalog" ], "responses": { "200": { "$ref": "#/components/responses/sellable_items_200-get-items-by-group-id" }, "404": { "$ref": "#/components/responses/Virtual-Items-Currency_404-item-group" } } } }, "/v2/project/{project_id}/admin/region": { "get": { "summary": "지역 목록 가져오기", "description": "지역 목록을 가져옵니다.\n\n지역을 사용하여 지역 제한을 관리할 수 있습니다.", "operationId": "admin-get-regions", "x-badges": [ { "name": "Server-side", "color": "#95ff80" }, { "name": "Admin", "color": "#d7dee0" } ], "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" } ], "tags": [ "common-regions" ], "security": [ { "basicAuth": [] } ], "responses": { "200": { "$ref": "#/components/responses/200-admin-get-regions-list" }, "401": { "$ref": "#/components/responses/401-invalid-basic-auth" } } }, "post": { "summary": "지역 생성하기", "description": "지역을 생성합니다.\n\n지역을 사용하여 지역 제한을 관리할 수 있습니다.", "security": [ { "basicAuth": [] } ], "operationId": "admin-create-region", "x-badges": [ { "name": "Server-side", "color": "#95ff80" }, { "name": "Admin", "color": "#d7dee0" } ], "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" } ], "tags": [ "common-regions" ], "requestBody": { "$ref": "#/components/requestBodies/create-update-region" }, "responses": { "201": { "$ref": "#/components/responses/201-admin-create-region" }, "401": { "$ref": "#/components/responses/401-invalid-basic-auth" } } } }, "/v2/project/{project_id}/admin/region/{region_id}": { "get": { "summary": "지역 가져오기", "description": "특정 지역을 가져옵니다.\n\n지역을 사용하여 지역 제한을 관리할 수 있습니다.", "operationId": "admin-get-region", "x-badges": [ { "name": "Server-side", "color": "#95ff80" }, { "name": "Admin", "color": "#d7dee0" } ], "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/region_id-path-param" } ], "tags": [ "common-regions" ], "security": [ { "basicAuth": [] } ], "responses": { "200": { "$ref": "#/components/responses/200-admin-get-region" }, "401": { "$ref": "#/components/responses/401-invalid-basic-auth" }, "404": { "$ref": "#/components/responses/404-region-not-found" } } }, "put": { "summary": "지역 업데이트", "description": "특정 지역을 업데이트합니다.\n\n지역을 사용하여 지역 제한을 관리할 수 있습니다.", "security": [ { "basicAuth": [] } ], "operationId": "admin-update-region", "x-badges": [ { "name": "Server-side", "color": "#95ff80" }, { "name": "Admin", "color": "#d7dee0" } ], "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/region_id-path-param" } ], "tags": [ "common-regions" ], "requestBody": { "$ref": "#/components/requestBodies/create-update-region" }, "responses": { "204": { "$ref": "#/components/responses/204-admin-update-region" }, "401": { "$ref": "#/components/responses/401-invalid-basic-auth" }, "404": { "$ref": "#/components/responses/404-region-not-found" } } }, "delete": { "summary": "지역 삭제", "description": "특정 지역을 삭제합니다.", "security": [ { "basicAuth": [] } ], "operationId": "admin-delete-region", "x-badges": [ { "name": "Server-side", "color": "#95ff80" }, { "name": "Admin", "color": "#d7dee0" } ], "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/region_id-path-param" } ], "tags": [ "common-regions" ], "responses": { "204": { "$ref": "#/components/responses/204-admin-delete-region" }, "401": { "$ref": "#/components/responses/401-invalid-basic-auth" }, "404": { "$ref": "#/components/responses/404-region-not-found" } } } }, "/v2/project/{project_id}/admin/attribute": { "get": { "summary": "특성 목록 가져오기(관리자)", "description": "관리 대상 프로젝트에서 특성 목록을 가져옵니다.", "operationId": "admin-get-attribute-list", "x-badges": [ { "name": "Server-side", "color": "#95ff80" }, { "name": "Admin", "color": "#d7dee0" } ], "security": [ { "basicAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/limit-query-param" }, { "$ref": "#/components/parameters/offset-query-param" } ], "tags": [ "attribute-admin" ], "responses": { "200": { "$ref": "#/components/responses/200-admin-get-attribute-list-response" }, "401": { "$ref": "#/components/responses/401-invalid-basic-auth" } } }, "post": { "summary": "특성 생성하기", "description": "특성을 생성합니다.", "security": [ { "basicAuth": [] } ], "operationId": "admin-create-attribute", "x-badges": [ { "name": "Server-side", "color": "#95ff80" }, { "name": "Admin", "color": "#d7dee0" } ], "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" } ], "tags": [ "attribute-admin" ], "requestBody": { "$ref": "#/components/requestBodies/create-update-attribute" }, "responses": { "201": { "$ref": "#/components/responses/201-admin-create-attribute" }, "401": { "$ref": "#/components/responses/401-invalid-basic-auth" }, "422": { "$ref": "#/components/responses/422-validation-failed" } } } }, "/v2/project/{project_id}/admin/attribute/{external_id}": { "put": { "summary": "특성 업데이트", "description": "특성을 업데이트합니다.", "operationId": "admin-update-attribute", "x-badges": [ { "name": "Server-side", "color": "#95ff80" }, { "name": "Admin", "color": "#d7dee0" } ], "security": [ { "basicAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/external_id-attr-path-param" } ], "tags": [ "attribute-admin" ], "requestBody": { "$ref": "#/components/requestBodies/create-update-attribute" }, "responses": { "204": { "$ref": "#/components/responses/204-admin-update-attribute" }, "401": { "$ref": "#/components/responses/401-invalid-basic-auth" }, "422": { "$ref": "#/components/responses/422-validation-failed" } } }, "get": { "summary": "지정된 특성 가져오기", "description": "지정된 특성을 가져옵니다.", "operationId": "admin-get-attribute", "x-badges": [ { "name": "Server-side", "color": "#95ff80" }, { "name": "Admin", "color": "#d7dee0" } ], "security": [ { "basicAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/external_id-attr-path-param" } ], "tags": [ "attribute-admin" ], "responses": { "200": { "$ref": "#/components/responses/200-admin-get-attribute" }, "401": { "$ref": "#/components/responses/401-invalid-basic-auth" }, "404": { "$ref": "#/components/responses/404-attribute-not-found" } } }, "delete": { "summary": "특성 삭제", "description": "특성을 삭제합니다.\n\n
참고

아이템 특성을 삭제하면 해당 아이템의 모든 데이터와 아이템 연결을 잃게 됩니다.
", "operationId": "delete-attribute", "x-badges": [ { "name": "Server-side", "color": "#95ff80" }, { "name": "Admin", "color": "#d7dee0" } ], "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/external_id-attr-path-param" } ], "tags": [ "attribute-admin" ], "security": [ { "basicAuth": [] } ], "responses": { "204": { "description": "특성을 성공적으로 삭제했습니다." }, "401": { "$ref": "#/components/responses/401-invalid-basic-auth" } } } }, "/v2/project/{project_id}/admin/attribute/{external_id}/value": { "post": { "summary": "특성 값 생성하기", "description": "특성 값을 생성합니다.\n\n
주의

모든 프로젝트는 특성 값의 수를 제한합니다. 기본값과 최대값은 특성당 20개입니다.
", "operationId": "admin-create-attribute-value", "security": [ { "basicAuth": [] } ], "x-badges": [ { "name": "Server-side", "color": "#95ff80" }, { "name": "Admin", "color": "#d7dee0" } ], "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/external_id-attr-path-param" } ], "requestBody": { "$ref": "#/components/requestBodies/create-update-attribute-value" }, "tags": [ "attribute-admin" ], "responses": { "201": { "$ref": "#/components/responses/201-admin-create-attribute-value" }, "401": { "$ref": "#/components/responses/401-invalid-basic-auth" }, "403": { "$ref": "#/components/responses/403-auth-header-not-sent" }, "404": { "$ref": "#/components/responses/404-attribute-not-found" }, "422": { "$ref": "#/components/responses/422-create-update-attribute-value" } } }, "delete": { "summary": "모든 특성 값 삭제", "description": "특성의 모든 값을 삭제합니다.\n\n
참고

특성 값을 삭제하면 특성과 아이템 사이의 모든 연결이 끊어집니다. 아이템의 특성 값을 변경하려면 값을 삭제하고 새 값을 생성하는 대신특성 값 업데이트 API 호출을 사용하십시오.
", "operationId": "admin-delete-all-attribute-value", "security": [ { "basicAuth": [] } ], "x-badges": [ { "name": "Server-side", "color": "#95ff80" }, { "name": "Admin", "color": "#d7dee0" } ], "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/external_id-attr-path-param" } ], "tags": [ "attribute-admin" ], "responses": { "204": { "description": "특성 값을 성공적으로 삭제했습니다." }, "401": { "$ref": "#/components/responses/401-invalid-basic-auth" }, "403": { "$ref": "#/components/responses/403-auth-header-not-sent" } } } }, "/v2/project/{project_id}/admin/attribute/{external_id}/value/{value_external_id}": { "put": { "summary": "특성 값 업데이트", "description": "특성 값을 업데이트합니다.", "operationId": "admin-update-attribute-value", "security": [ { "basicAuth": [] } ], "x-badges": [ { "name": "Server-side", "color": "#95ff80" }, { "name": "Admin", "color": "#d7dee0" } ], "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/value_external_id-path-param" }, { "$ref": "#/components/parameters/external_id-attr-path-param" } ], "requestBody": { "$ref": "#/components/requestBodies/create-update-attribute-value" }, "tags": [ "attribute-admin" ], "responses": { "204": { "description": "특성 값을 성공적으로 업데이트했습니다." }, "401": { "$ref": "#/components/responses/401-invalid-basic-auth" }, "403": { "$ref": "#/components/responses/403-auth-header-not-sent" }, "404": { "$ref": "#/components/responses/404-attribute-value-not-found" }, "422": { "$ref": "#/components/responses/422-create-update-attribute-value" } } }, "delete": { "summary": "특성 값 삭제", "description": "특성 값을 삭제합니다.\n\n
참고

특성 값을 삭제하면 특성과 아이템 사이의 모든 연결이 끊어집니다. 아이템의 특성 값을 변경하려면 값을 삭제하고 새 값을 생성하는 대신특성 값 업데이트 API 호출을 사용하십시오.
", "operationId": "admin-delete-attribute-value", "security": [ { "basicAuth": [] } ], "x-badges": [ { "name": "Server-side", "color": "#95ff80" }, { "name": "Admin", "color": "#d7dee0" } ], "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/value_external_id-path-param" }, { "$ref": "#/components/parameters/external_id-attr-path-param" } ], "tags": [ "attribute-admin" ], "responses": { "204": { "description": "특성 값을 성공적으로 삭제했습니다." }, "401": { "$ref": "#/components/responses/401-invalid-basic-auth" }, "403": { "$ref": "#/components/responses/403-auth-header-not-sent" } } } } }, "components": { "securitySchemes": { "basicAuth": { "type": "http", "description": "서버 측 호출은 `basicAuth` 인증 체계를 사용합니다. API에 대한 모든 요청은 `Authorization: Basic ` 헤더를 포함해야 하며, 여기에서 `your_authorization_basic_key`는 Base64 표준에 따라 인코딩된 `project_id:api_key` 쌍입니다.\n\n필요한 경우 `project_id` 대신 `merchant_id`를 사용할 수 있습니다. 기능에는 영향을 미치지 않습니다.\n\n다음과 같이 매개 변수 값을 확인하려면 [관리자 페이지](https://publisher.xsolla.com/)로 이동합니다.\n\n* `merchant_id`는 다음 위치에 표시됩니다:\n * **Company settings > Company** 섹션\n * 관리자 페이지의 모든 페이지에서 브라우저 주소 표시줄의 URL. URL 형식은 다음과 같습니다: `https://publisher.xsolla.com/`.\n* `api_key`는 생성 시 관리자 페이지에서 한 번만 표시되며, 귀하의 측에서 저장해야 합니다. 새 키는 다음 섹션에서 생성할 수 있습니다:\n * [Company settings > API keys](https://publisher.xsolla.com/0/settings/api_key)\n * [Project settings > API keys](https://publisher.xsolla.com/0/projects/0/edit/api_key)\n\n{% html name=\"div\" attrs={\"class\": \"notice\"} %}\n**Notice**\n\n필수 API 호출에 `project_id` 경로 매개 변수가 포함되어 있지 않으면, 모든 회사 프로젝트에 대해 유효한 API 키를 사용하여 인증하세요.\n{% /html %}\n\n* `project_id`는 다음 위치에 표시됩니다:\n * 프로젝트 이름 옆의 관리자 페이지.\n * 관리자 페이지에서 프로젝트 작업 시 브라우저 주소 표시줄의 URL. URL 형식은 다음과 같습니다: `https://publisher.xsolla.com//projects/`.\n\nAPI 키 작업에 대한 자세한 정보는 [API 레퍼런스](https://developers.xsolla.com/ko/api/getting-started/#api_keys_overview)를 참조하세요.", "scheme": "basic" }, "XsollaLoginUserJWT": { "type": "http", "scheme": "bearer", "bearerFormat": "JWT", "description": "클라이언트 측 호출은 `XsollaLoginUserJWT` 인증 체계를 사용합니다. 요청에는 Bearer `` 형식으로 `Authorization` 헤더에 사용자의 JWT를 포함해야 합니다. 이 토큰은 사용자를 식별하고 개인화된 데이터에 대한 액세스 를 제공합니다. 토큰 생성 방법에 대한 자세한 내용은 [엑솔라 로그인 API 문서](/ko/api/login/authentication-schemes#getting-user-token)를 참조하십시오.\n\n또는 [결제 UI를 여는 토큰](/ko/api/pay-station/token/create-token)을 사용할 수 있습니다." }, "AuthForCart": { "type": "http", "scheme": "bearer", "description": "이 `AuthForCart` 인증 체계는 장바구니 구매에 사용되며 두 가지 모드를 지원합니다.\n\n1. 사용자의 JWT로 인증합니다. 토큰은 인증 헤더에 `Authorization: Bearer ` 형식으로 전달되며, ``는 사용자 토큰입니다. 이 토큰은 사용자를 식별하고 사용자 맞춤 설정된 데이터에 대한 액세스를 제공합니다.\n\n또는 [결제 UI를 여는 토큰](/ko/api/pay-station/token/create-token)을 사용할 수 있습니다.\n\n2. `Authorization` 헤더가 없는 간소화된 모드. 이 모드는 인증되지 않은 사용자만 사용하며, [게임 키 판매](/ko/doc/buy-button/how-to/set-up-authentication/#guides_buy_button_selling_items_not_authenticated_users)에만 적용할 수 있습니다. 토큰 대신 요청에 다음 헤더를 포함해야 합니다.\n* 요청 ID와 `x-unauthorized-id`\n* Base64로 인코딩된 사용자의 이메일 주소와 `x-user`." }, "basicMerchantAuth": { "type": "http", "description": "서버 측 호출은 `basicMerchantAuth` 인증 체계를 사용합니다. 모든 API 요청에는 `Authorization: Basic ` 헤더가 포함되어야 하며, 여기서 `your_authorization_basic_key`는 Base64 표준에 따라 인코딩된 `merchant_id:api_key` 쌍입니다.\n\n다음과 같이 매개 변수 값을 확인하려면 [관리자 페이지](https://publisher.xsolla.com/)로 이동합니다.\n\n* `merchant_id`는 다음 위치에 표시됩니다:\n * **Company settings > Company** 섹션\n * 관리자 페이지의 모든 페이지에서 브라우저 주소 표시줄의 URL에 표시됩니다. URL 형식은 다음과 같습니다: `https://publisher.xsolla.com/`\n* `api_key`는 생성 시 관리자 페이지에 한 번만 표시되며, 귀하의 측에서 저장해야 합니다. 새로운 키는 [Company settings > API keys](https://publisher.xsolla.com/0/settings/api_key) 섹션에서 생성할 수 있습니다.\n\nAPI 키 작업에 대한 자세한 정보는 [API 레퍼런스](https://developers.xsolla.com/ko/api/getting-started/#api_keys_overview)를 참조하세요.", "scheme": "basic" } }, "parameters": { "project_id-path-param": { "name": "project_id", "in": "path", "required": true, "description": "프로젝트 ID. 이 매개 변수는 프로젝트 이름 옆의 [관리자 페이지](https://publisher.xsolla.com/0/projects/0/)에서 또는 프로젝트 작업 시 브라우저 주소 표시줄에서 확인할 수 있습니다. URL 형식은 다음과 같습니다: `https://publisher.xsolla.com//projects/`.", "schema": { "type": "integer", "example": 44056 } }, "limit-query-param": { "name": "limit", "in": "query", "example": 50, "required": false, "description": "페이지 요소 개수 제한입니다.", "schema": { "type": "integer", "example": 50, "minimum": 1 } }, "offset-query-param": { "name": "offset", "in": "query", "required": false, "example": 0, "description": "목록이 생성된 요소의 개수입니다(개수는 0부터 시작함).", "schema": { "type": "integer", "example": 0, "minimum": 0 } }, "external_id-group-path-param": { "name": "external_id", "in": "path", "required": true, "description": "생성 시 지정된 [외부 아이템 그룹 ID](/ko/api/catalog/item-groups-admin/admin-create-item-group#item-groups-admin/admin-create-item-group/t=request&path=external_id)입니다.", "schema": { "type": "string", "example": "weapons" } }, "group_id-path-param": { "name": "group_id", "in": "path", "required": true, "description": "그룹 ID입니다.", "schema": { "type": "integer", "example": 10 } }, "item_sku-path-param": { "name": "item_sku", "in": "path", "required": true, "description": "아이템 SKU입니다.", "schema": { "type": "string", "example": "booster_mega_1" } }, "virtual_currency_sku-path-param": { "name": "virtual_currency_sku", "in": "path", "required": true, "description": "인게임 재화 SKU입니다.", "schema": { "type": "string", "example": "crystal" } }, "locale-query-param": { "name": "locale", "in": "query", "required": false, "description": "응답 언어. ISO 639-1 표준에 따른 소문자 두 글자 언어 코드(예: `en`)입니다. `name` 및 `description`과 같은 현지화 입력란에서는 다섯 글자 로케일 코드(예: `en-US`)를 사용할 수 있지만, 응답에서는 두 글자 코드로 정규화됩니다. 지원되는 언어의 전체 목록은 [문서](https://developers.xsolla.com/ko/doc/shop-builder/references/supported-languages/)에서 확인할 수 있습니다.", "schema": { "type": "string", "default": "en" } }, "additional_fields-query-param": { "name": "additional_fields[]", "in": "query", "required": false, "description": "응답에 포함할 추가 필드입니다. 기본적으로 이러한 필드는 반환되지 않습니다. 포함하려면 필수 값을 전달해야 합니다.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "media_list", "order", "long_description", "custom_attributes", "item_order_in_group" ] } } }, "country-query-param": { "name": "country", "in": "query", "required": false, "description": "[ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)에 따른 2자리 대문자 국가 코드입니다. [엑솔라에서 지원하는 국가](https://developers.xsolla.com/ko/doc/shop-builder/references/supported-countries/) 및 [국가 판별 프로세스](https://developers.xsolla.com/ko/doc/shop-builder/features/pricing-policy/#pricing_policy_country_determination)에 대한 자세한 정보는 설명서를 확인하십시오.", "schema": { "type": "string", "example": "US" } }, "promo_code-query-param": { "name": "promo_code", "in": "query", "required": false, "description": "고유한 대/소문자 구분 코드입니다. 문자와 숫자를 포함합니다.", "schema": { "type": "string", "example": "WINTER2021", "minLength": 1, "maxLength": 128 } }, "show_inactive_time_limited_items-query-param": { "name": "show_inactive_time_limited_items", "in": "query", "required": false, "description": "사용자가 사용할 수 없는 사용기간 제한 아이템을 표시합니다. 해당 아이템의 사용기간이 아직 시작되지 않았거나 이미 만료되었습니다.", "schema": { "type": "integer", "example": 1, "default": 0 } }, "virtual_currency_package_sku-path-param": { "name": "virtual_currency_package_sku", "in": "path", "required": true, "description": "인게임 재화 패키지 SKU입니다.", "schema": { "type": "string", "example": "crystal-pack" } }, "with_geo-query-param": { "name": "with_geo", "in": "query", "required": false, "description": "응답 헤더에 사용자의 로케일 및 국가 정보를 포함할지 여부입니다. `true`로 설정하면 응답에 `X-User-Locale-Code` 및 `X-User-Country-Code` 헤더가 포함됩니다. ", "schema": { "type": "boolean", "default": false } }, "item_type-group-path-param": { "name": "item_type", "in": "path", "required": true, "description": "그룹을 필터링하는 데 사용되는 아이템 유형입니다. ``items_count` 어떤 아이템이 포함될지 결정합니다. `/`가 포함된 값(예: `virtual_currency/package` 또는 `game/key`)은 URL 인코딩 처리되어야 합니다(예: `virtual_currency2Fpackage`). ", "schema": { "type": "string", "enum": [ "virtual_items", "virtual_currency", "virtual_currency/package", "game/key", "bundle", "game", "value_points", "subscription_plans" ], "example": "virtual_items" } }, "id-group-path-param": { "name": "id", "in": "path", "required": true, "description": "엑솔라에서 할당한 아이템 그룹 ID입니다.", "schema": { "type": "integer", "example": 1 } }, "platform-query-param": { "name": "platform", "in": "query", "required": false, "description": "`Xsolla`(기본값), `playstation_network`, `xbox_live`, `pc_standalone`, `nintendo_shop`, `google_play`, `app_store_ios`, `android_standalone`, `ios_standalone`, `android_other`, `ios_other`, `pc_other` 등 사용자가 플레이하는 퍼블리싱 플랫폼입니다.", "schema": { "type": "string", "enum": [ "playstation_network", "xbox_live", "xsolla", "pc_standalone", "nintendo_shop", "google_play", "app_store_ios", "android_standalone", "ios_standalone", "android_other", "ios_other", "pc_other" ], "default": "xsolla" } }, "item_id-path-param": { "name": "item_id", "in": "path", "required": true, "description": "아이템 ID입니다.", "schema": { "type": "string", "example": "656" } }, "user_email-query-param": { "name": "user_email", "in": "query", "required": true, "description": "사용자 이메일입니다.", "schema": { "type": "string", "example": "email@email.com" } }, "quantity-query-param": { "name": "quantity", "in": "query", "required": true, "description": "코드 수량입니다.", "schema": { "type": "integer", "example": 100 } }, "reason-query-param": { "name": "reason", "in": "query", "required": true, "description": "코드 수신 코드입니다.", "schema": { "type": "string", "example": "Very important" } }, "region_id-query-param": { "name": "region_id", "in": "query", "required": false, "description": "지역 ID입니다.", "schema": { "type": "integer", "default": 1 } }, "sandbox-query-param": { "name": "sandbox", "in": "query", "required": false, "description": "반환해야 하는 자격 유형입니다. 매개 변수를 1로 설정하면 사용자가 샌드박스 모드에서 받은 권한만 반환됩니다. 매개 변수가 전달되지 않거나 0으로 설정된 경우 사용자가 라이브 모드에서 받은 권한만 반환됩니다.", "schema": { "type": "integer", "default": 0 } }, "additional_fields-entitlement-query-param": { "name": "additional_fields[]", "in": "query", "required": false, "description": "추가 필드 목록입니다. 이러한 필드는 요청에서 보내는 경우 응답에 포함됩니다. 사용할 수 있는 필드는 `attributes`입니다.", "schema": { "type": "array", "items": { "type": "string" } } }, "sku-path-param": { "name": "sku", "in": "path", "required": true, "description": "번들 SKU입니다.", "schema": { "type": "string", "example": "kg_1" } }, "cart_id-path-param": { "name": "cart_id", "in": "path", "required": true, "description": "장바구니 ID입니다.", "schema": { "type": "string", "example": "custom_id" } }, "currency-query-param": { "name": "currency", "in": "query", "required": false, "description": "장바구니에 표시되는 아이템 가격 통화입니다. [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)에 따른 3자리 통화 코드입니다. [엑솔라에서 지원하는 통화](https://developers.xsolla.com/ko/doc/pay-station/references/supported-currencies/)에 대한 자세한 정보는 설명서를 확인하십시오.", "schema": { "type": "string", "default": "USD" } }, "order_id-path-param": { "name": "order_id", "in": "path", "required": true, "description": "주문 ID입니다.", "schema": { "type": "string", "example": "656" } }, "x-user-for-header": { "in": "header", "name": "x-user-for", "example": "ACCESS_TOKEN/LOGIN_JWT", "schema": { "type": "string" }, "required": false, "description": "사용자 식별자는 엑솔라 로그인 사용자 JWT 또는 [페이 스테이션 액세스 토큰](https://developers.xsolla.com/ko/pay-station-api/current/token/create-token)을 사용하여 전송할 수 있습니다." }, "x-user-id-header": { "in": "header", "name": "x-user-id", "example": "UNIQUE_ID", "schema": { "maxLength": 32, "type": "string" }, "required": false, "description": "게임이 포함된 장바구니를 판매할 때 자신의 사용자 ID를 사용할 수 있습니다." }, "user_external_id-query-param": { "name": "user_external_id", "in": "query", "required": true, "description": "사용자 외부 ID", "schema": { "type": "string", "example": "d342dad2-9d59-11e9-a384-42010aa8003f" } }, "merchant_id-path-param": { "name": "merchant_id", "in": "path", "required": true, "description": "판매자 ID입니다.", "schema": { "type": "integer", "example": 121212 } }, "project_id_59080-path-param": { "name": "project_id", "in": "path", "required": true, "description": "프로젝트 ID입니다. 이 매개 변수는 [관리자 페이지](https://publisher.xsolla.com/)의 프로젝트 이름 옆에서 확인할 수 있습니다.", "schema": { "type": "integer", "example": 59080 } }, "item_id_59080-path-param": { "name": "item_id", "in": "path", "required": true, "description": "아이템 ID입니다.", "schema": { "type": "string", "example": "259774" } }, "item_sku_59080-path-param": { "name": "sku", "in": "path", "required": true, "description": "아이템 SKU입니다.", "schema": { "type": "string", "example": "electric_shield" } }, "external_id_59080-group-path-param": { "name": "external_id", "in": "path", "required": true, "description": "그룹 외부 ID입니다.", "schema": { "type": "string", "default": "armour" } }, "region_id-path-param": { "name": "region_id", "in": "path", "required": true, "description": "지역 ID입니다. 프로젝트 내부의 고유 지역 식별자입니다.", "schema": { "type": "integer", "example": 42 } }, "external_id-attr-path-param": { "name": "external_id", "in": "path", "required": true, "description": "특성 외부 ID입니다.", "schema": { "type": "string", "example": "attribute_id" } }, "value_external_id-path-param": { "name": "value_external_id", "in": "path", "required": true, "description": "특성 값 외부 ID입니다.", "schema": { "type": "string", "pattern": "^[-_\\.\\d\\w]+$", "example": "value_id" } } }, "schemas": { "Virtual-Items-Currency_sku": { "type": "string", "minLength": 1, "maxLength": 255, "pattern": "^[a-zA-Z0-9_\\-–.]*$", "example": "booster_mega_1", "description": "고유 아이템 ID입니다. SKU는 소문자 및 대문자 라틴 영숫자, 마침표, 대시 및 밑줄만 포함할 수 있습니다." }, "admin-attribute-external_id": { "type": "string", "minLength": 1, "maxLength": 255, "pattern": "^[a-zA-Z0-9-_]+$", "example": "attribute_1", "description": "고유 특성 ID입니다. `external_id`는 소문자 및 대문자 라틴 영숫자, 대시 및 밑줄만 포함할 수 있습니다." }, "admin-attribute-name": { "type": "object", "description": "특성의 이름에 대한 현지화가 있는 개체입니다. 키는 ISO 3166-1에 따라 지정되어 있습니다.", "additionalProperties": { "type": "string" }, "example": { "en": "Genre", "de": "Genre" }, "default": { "en": "Genre", "de": "Genre" } }, "value-external_id": { "type": "string", "minLength": 1, "maxLength": 255, "pattern": "^[-_.\\d\\w]+$", "example": "attribute_value", "description": "특성의 고유한 값 ID입니다. `external_id`에는 소문자 라틴어 영숫자, 대시, 밑줄만 사용할 수 있습니다." }, "value-name": { "type": "object", "description": "값의 이름에 대한 현지화가 있는 개체입니다. 키는 ISO 3166-1에 따라 지정되어 있습니다.", "additionalProperties": { "type": "string" }, "example": { "en": "Strategy", "de": "Strategie" }, "default": { "en": "Strategy", "de": "Strategie" } }, "attribute-value": { "type": "object", "required": [ "value", "external_id" ], "properties": { "external_id": { "$ref": "#/components/schemas/value-external_id" }, "value": { "$ref": "#/components/schemas/value-name" } }, "example": { "external_id": "value_external_id", "name": { "en": "Value 1", "de": "Wert 1" } } }, "attribute": { "type": "object", "required": [ "external_id", "values" ], "properties": { "external_id": { "$ref": "#/components/schemas/admin-attribute-external_id" }, "name": { "$ref": "#/components/schemas/admin-attribute-name" }, "values": { "type": "array", "items": { "$ref": "#/components/schemas/attribute-value" }, "example": [ { "external_id": "strategy", "value": { "en": "Strategy", "de": "Strategie" } }, { "external_id": "action", "value": { "en": "Action", "de": "Aktion" } } ] } }, "example": { "external_id": "attribute_external_id", "name": { "en": "Attribute name", "de": "Attributname" }, "values": [ { "external_id": "value_1", "name": { "en": "value 1", "de": "wert 1" } }, { "external_id": "value_2", "name": { "en": "value 2", "de": "wert 2" } } ] } }, "Virtual-Items-Currency_schemas-admin-attributes": { "type": "array", "description": "특성 목록입니다.", "items": { "$ref": "#/components/schemas/attribute" } }, "Virtual-Items-Currency_admin-attributes": { "allOf": [ { "$ref": "#/components/schemas/Virtual-Items-Currency_schemas-admin-attributes" }, { "description": "특성 목록입니다." } ] }, "two-letter-locale": { "type": [ "object", "null" ], "description": "두 글자 소문자 언어 코드입니다.", "title": "두 글자", "properties": { "en": { "type": [ "string", "null" ], "description": "영어" }, "ar": { "type": [ "string", "null" ], "description": "아랍어" }, "bg": { "type": [ "string", "null" ], "description": "불가리아어" }, "cn": { "type": [ "string", "null" ], "description": "중국어(간체)" }, "cs": { "type": [ "string", "null" ], "description": "체코어" }, "de": { "type": [ "string", "null" ], "description": "독일어" }, "es": { "type": [ "string", "null" ], "description": "스페인어(스페인)" }, "fr": { "type": [ "string", "null" ], "description": "프랑스어" }, "he": { "type": [ "string", "null" ], "description": "히브리어" }, "it": { "type": [ "string", "null" ], "description": "이탈리아어" }, "ja": { "type": [ "string", "null" ], "description": "일본어" }, "ko": { "type": [ "string", "null" ], "description": "한국어" }, "pl": { "type": [ "string", "null" ], "description": "폴란드어" }, "pt": { "type": [ "string", "null" ], "description": "포르투칼어" }, "ro": { "type": [ "string", "null" ], "description": "로마니아어" }, "ru": { "type": [ "string", "null" ], "description": "러시아어" }, "th": { "type": [ "string", "null" ], "description": "태국어" }, "tr": { "type": [ "string", "null" ], "description": "터키어" }, "tw": { "type": [ "string", "null" ], "description": "중국어(번체)" }, "vi": { "type": [ "string", "null" ], "description": "베트남어" }, "km": { "type": [ "string", "null" ], "description": "크메르어" }, "id": { "type": [ "string", "null" ], "description": "인도네시아어" }, "lo": { "type": [ "string", "null" ], "description": "라오스어" }, "my": { "type": [ "string", "null" ], "description": "버마어" }, "ph": { "type": [ "string", "null" ], "description": "필리핀어" }, "ne": { "type": [ "string", "null" ], "description": "네팔어" } } }, "five-letter-locale": { "type": [ "object", "null" ], "description": "다섯 글자 로케일 코드.", "title": "다섯 글자", "properties": { "en-US": { "type": [ "string", "null" ], "description": "영어" }, "ar-AE": { "type": [ "string", "null" ], "description": "아랍어" }, "bg-BG": { "type": [ "string", "null" ], "description": "불가리아어" }, "zh-CN": { "type": [ "string", "null" ], "description": "중국어(간체)" }, "cs-CZ": { "type": [ "string", "null" ], "description": "체코어" }, "de-DE": { "type": [ "string", "null" ], "description": "독일어" }, "es-ES": { "type": [ "string", "null" ], "description": "스페인어(스페인)" }, "fr-FR": { "type": [ "string", "null" ], "description": "프랑스어" }, "he-IL": { "type": [ "string", "null" ], "description": "히브리어" }, "it-IT": { "type": [ "string", "null" ], "description": "이탈리아어" }, "ja-JP": { "type": [ "string", "null" ], "description": "일본어" }, "ko-KR": { "type": [ "string", "null" ], "description": "한국어" }, "pl-PL": { "type": [ "string", "null" ], "description": "폴란드어" }, "pt-BR": { "type": [ "string", "null" ], "description": "포르투갈어(브라질)" }, "ro-RO": { "type": [ "string", "null" ], "description": "로마니아어" }, "ru-RU": { "type": [ "string", "null" ], "description": "러시아어" }, "th-TH": { "type": [ "string", "null" ], "description": "태국어" }, "tr-TR": { "type": [ "string", "null" ], "description": "터키어" }, "zh-TW": { "type": [ "string", "null" ], "description": "중국어(번체)" }, "vi-VN": { "type": [ "string", "null" ], "description": "베트남어" }, "km-KH": { "type": [ "string", "null" ], "description": "크메르어" }, "id-ID": { "type": [ "string", "null" ], "description": "인도네시아어" }, "lo-LA": { "type": [ "string", "null" ], "description": "라오스어" }, "my-MM": { "type": [ "string", "null" ], "description": "버마어" }, "ph-PH": { "type": [ "string", "null" ], "description": "필리핀어" }, "ne-NP": { "type": [ "string", "null" ], "description": "네팔어" } } }, "name-localization-object": { "type": [ "object", "null" ], "description": "아이템 이름에 대한 현지화가 있는 개체입니다. 두 글자 소문자 언어 코드(예: `en`) 또는 다섯 글자 언어 코드(예: `en-US`) 두 가지 형식 중 하나로 되어 있는 값을 허용합니다. 두 형식 모두 입력으로 허용되지만 응답은 두 글자 소문자 언어 코드를 반환합니다. 동일한 언어에 대한 두 옵션(예: `en` 및 `en-US`)이 모두 제공되면 마지막으로 제공된 값이 저장됩니다. 지원되는 언어의 전체 목록은 [문서](/ko/doc/shop-builder/references/supported-languages/)에서 확인할 수 있습니다.", "anyOf": [ { "$ref": "#/components/schemas/two-letter-locale" }, { "$ref": "#/components/schemas/five-letter-locale" } ] }, "description-localization-object": { "type": [ "object", "null" ], "description": "아이템 설명에 대한 현지화가 있는 개체입니다. 두 글자 소문자 언어 코드(예: `en`) 또는 다섯 글자 로케일 코드(예: `en-US`) 두 가지 형식 중 하나로 되어 있는 값을 허용합니다. 두 형식 모두 입력으로 허용되지만 응답은 두 글자 소문자 언어 코드를 반환합니다. 동일한 언어에 대한 두 옵션(예: `en` 및 `en-US`)이 모두 제공되면 마지막으로 제공된 값이 저장됩니다. 지원되는 언어의 전체 목록은 [문서](/ko/doc/shop-builder/references/supported-languages/)에서 확인할 수 있습니다.", "anyOf": [ { "$ref": "#/components/schemas/two-letter-locale" }, { "$ref": "#/components/schemas/five-letter-locale" } ] }, "long-description-localization-object": { "type": [ "object", "null" ], "description": "아이템의 긴 설명에 대한 현지화가 있는 개체입니다. 두 글자 소문자 언어 코드(예: `en`) 또는 5자 로케일 코드(예 `en-US`: ) 두 가지 형식 중 하나로 값을 허용합니다. 두 형식 모두 입력으로 허용되지만 응답은 두 글자 소문자 언어 코드를 반환합니다. 동일한 언어에 대한 두 변수(예: `en` 및 `en-US`)가 모두 제공되면 마지막으로 제공된 값이 저장됩니다. 지원되는 언어의 전체 목록은 [문서](/ko/doc/shop-builder/references/supported-languages/)에서 확인할 수 있습니다.", "anyOf": [ { "$ref": "#/components/schemas/two-letter-locale" }, { "$ref": "#/components/schemas/five-letter-locale" } ] }, "Virtual-Items-Currency_admin-groups-response": { "type": "array", "example": [ { "external_id": "horror", "name": { "en": "Horror" } } ], "default": [], "description": "아이템이 속한 그룹입니다.", "items": { "type": "object", "properties": { "external_id": { "type": "string", "example": "horror" }, "name": { "type": "object", "description": "아이템의 이름입니다. 키가 \"^[a-z]{2}\" 형식의 로케일인\n키/값 쌍을 포함해야 하며 값은 문자열입니다.", "example": { "en": "Horror", "de": "Horror" }, "default": { "en": "Horror" }, "additionalProperties": { "type": "string" } } } } }, "Virtual-Items-Currency_admin-media_list": { "type": "array", "example": [ { "type": "image", "url": "https://cdn3.xsolla.com/img/misc/images/71ab1e12126f2103e1868076f0acb21a.jpg" } ], "description": "스크린샷, 게임 플레이 동영상 등과 같은 아이템의 추가 자산입니다.", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "image", "video" ], "example": "image", "description": "미디어 유형: `image`/`video`." }, "url": { "type": "string", "example": "https://cdn3.xsolla.com/img/misc/images/71ab1e12126f2103e1868076f0acb21a.jpg", "description": "리소스 파일입니다." } } } }, "Virtual-Items-Currency_type": { "type": "string", "description": "아이템의 유형: `virtual_good`/`virtual_currency`/`bundle`/`physical_good`/`unit`." }, "Virtual-Items_admin-prices": { "type": "array", "items": { "type": "object", "required": [ "amount", "currency" ], "properties": { "amount": { "description": "금액.", "type": "number", "exclusiveMinimum": 0 }, "currency": { "type": "string", "example": "USD", "description": "아이템 가격 통화입니다. [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)에 따른 3자리 코드입니다. [엑솔라에서 지원하는 통화](https://developers.xsolla.com/ko/doc/pay-station/references/supported-currencies/)에 대한 자세한 내용은 설명서를 확인하십시오." }, "country_iso": { "type": "string", "description": "[ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)에 따른 2자리 대문자 국가 코드입니다. [엑솔라에서 지원하는 국가](https://developers.xsolla.com/ko/doc/shop-builder/references/supported-countries/)에 대한 자세한 정보는 설명서를 확인하십시오.
예: `country=US`", "example": "US" }, "is_default": { "type": "boolean", "default": false }, "is_enabled": { "type": "boolean", "default": true } }, "example": { "currency": "USD", "amount": 10.5, "is_default": true, "is_enabled": true } } }, "Virtual-Items-Currency_schemas-sku": { "type": "string", "example": "bundle_1", "description": "고유 아이템 ID입니다. SKU는 소문자 및 대문자 라틴 영숫자, 마침표, 대시 및 밑줄만 포함할 수 있습니다." }, "Virtual-Items-Currency_admin-get-vc_prices": { "type": "array", "items": { "type": "object", "required": [ "sku", "amount" ], "properties": { "sku": { "$ref": "#/components/schemas/Virtual-Items-Currency_schemas-sku" }, "amount": { "description": "금액.", "type": "number", "exclusiveMinimum": 0 }, "is_default": { "type": "boolean", "default": false } }, "example": { "sku": "com.xsolla.gold_1", "amount": 10, "is_default": true } } }, "Virtual-Items-Currency_admin-image_url": { "type": "string", "description": "이미지 URL. 결제 UI에서 이미지가 올바르게 표시되고 빠르게 로드되도록 하려면 다음 이미지 및 URL 가이드라인을 확인하세요:
  • 지원되는 형식: WebP(권장), PNG, JPG.
  • 파일 크기: 50KB 이하(WebP의 경우) 또는 150KB 이하(PNG 및 JPG의 경우).
  • 이미지 크기: 280 x 280 픽셀.
  • 색 공간: sRGB.
  • 프로토콜: 버전 관리된 URL에 대해 장기 캐싱이 적용된 HTTPS.
" }, "value-is_free": { "type": "boolean", "example": false, "default": false, "description": "아이템이 무료인지 여부입니다." }, "value-is_paid_randomized_reward": { "type": "boolean", "example": false, "default": false, "description": "아이템이 예를 들어, 루트 박스와 같이 무작위로 지급되었는지 여부." }, "Virtual-Items-Currency_order": { "type": "integer", "example": 1, "default": 1, "description": "카탈로그 내 아이템 표시 순서입니다. 값이 클수록 목록에서 해당 아이템이 더 아래쪽에 표시됩니다. 값이 동일한 경우, 아이템이 생성 날짜 순으로 정렬되며, 보다 최근에 생성된 아이템이 더 위쪽에 표시됩니다." }, "Virtual-Items-Currency_is_enabled": { "type": "boolean", "example": true, "default": true, "description": "해당 아이템이 구매 가능한지 여부입니다. `false`인 경우, 해당 아이템은 스토어에서 구매할 수 없으며 번들 상품이나 마케팅 캠페인을 통해서도 획득할 수 없습니다. 아이템 구매 가능 여부에 대한 자세한 내용은 [문서](https://developers.xsolla.com/ko/items-catalog/catalog-features/items-availability/)를 참조하세요." }, "Virtual-Items-Currency_is_show_in_store": { "type": "boolean", "example": true, "default": false, "description": "해당 아이템이 카탈로그에 표시되는지 여부입니다. `false`이고 `is_enabled: true`인 경우, 해당 아이템은 카탈로그에 표시되지 않지만 번들 상품의 일부로 제공되거나 마케팅 캠페인 내에서 이용할 수 있습니다. 아이템 제공 여부에 대한 자세한 내용은 [문서](https://developers.xsolla.com/ko/items-catalog/catalog-features/items-availability/)를 참조하십시오." }, "Virtual-Items-Currency_admin-regions": { "description": "해당 아이템을 이용할 수 있는 지역 목록입니다. 목록이 비어 있거나 전달되지 않은 경우, 해당 아이템은 모든 지역에 제공됩니다.", "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "minimum": 1, "example": 1, "description": "프로젝트 내의 지역 ID입니다.\n\n자세한 내용은 [지역별 판매 제한 관련 문서](https://developers.xsolla.com/ko/items-catalog/catalog-features/regional-restrictions/)와 [지역 관리 API 호출](https://developers.xsolla.com/ko/api/catalog/common-regions)을 참조하십시오." } } } }, "limit_exceeded_visibility": { "type": "string", "example": "show", "enum": [ "show", "hide" ], "description": "구매 한도에 도달한 후 다음 한도 재설정 때까지 카탈로그 내 아이템의 표시 여부를 결정합니다.\n\n`recurrent_schedule` 배열에서 반복 한도 재설정이 구성된 아이템에 적용됩니다.\n\n구매 한도에 도달한 후, 한도 초기화를 구성하지 않았다면`limit_exceeded_visibility` 값과 관계없이 해당 아이템은 카탈로그에 표시되지 않습니다.\n\n사용 가능한 값: - `show` - 구매 한도에 도달한 이후에도 카탈로그 검색 API 호출 시 해당 아이템이 반환됩니다. 클라이언트 측 카탈로그 검색 API 호출에서 한도에 도달하면, 해당 아이템은 `can_be_bought: false` 플래그와 함께 반환됩니다. 다음 재설정 날짜는 `reset_next_date`에 반환됩니다. - `hide` - 구매 한도에 도달한 후, 한도가 재설정될 때까지 해당 아이템은 카탈로그 검색 API 호출에서 반환되지 않습니다.", "default": "show" }, "admin_recurrent_schedule_response": { "type": [ "object", "null" ], "description": "새로고침 기간을 제한합니다.", "properties": { "per_user": { "type": [ "object", "null" ], "description": "사용자 제한 새로고침 기간입니다.", "oneOf": [ { "type": "object", "title": "interval_type = 일일", "description": "일일 사용자 유형 제한 설정을 새로고침합니다.", "properties": { "interval_type": { "type": "string", "description": "반복 새로고침 기간 유형입니다.", "enum": [ "daily" ] }, "time": { "type": "string", "description": "원하는 시간대의 제한 시간 새로고침 시간입니다(시간 단위로 반올림).", "format": "full-time", "example": "11:00:00+03:00" }, "reset_next_date": { "type": "integer", "description": "새로고침 제한 설정이 적용되는 날짜 및 시간입니다(Unix 타임스탬프)", "example": 1677553200 }, "displayable_reset_start_date": { "description": "첫 번째 제한 설정을 새로고침하는 날짜 및 시간입니다(ISO 8601).", "type": "string", "format": "date-time", "example": "2023-02-28T11:00:00+08:00" }, "displayable_reset_next_date": { "description": "제한 설정을 재설정해야 하는 날짜 및 시간입니다(ISO 8601).", "type": "string", "format": "date-time", "example": "2023-02-28T11:00:00+08:00" } } }, { "type": "object", "title": "interval_type = 주간", "description": "주간 사용자 유형 제한 설정을 새로고침합니다.", "properties": { "interval_type": { "type": "string", "description": "반복 새로고침 기간 유형입니다.", "enum": [ "weekly" ] }, "day_of_week": { "type": [ "integer", "null" ], "description": "제한을 새로고침하는 요일입니다. 여기서 1은 월요일이고 7은 일요일입니다. `weekly` 제한 설정 새로고침 기간 유형만 `null`이 아닙니다.", "minimum": 1, "maximum": 7 }, "time": { "type": "string", "description": "원하는 시간대의 제한 시간 새로고침 시간입니다(시간 단위로 반올림).", "format": "full-time", "example": "11:00:00+03:00" }, "reset_next_date": { "type": "integer", "description": "새로고침 제한 설정이 적용되는 날짜 및 시간입니다(Unix 타임스탬프)", "example": 1677553200 }, "displayable_reset_start_date": { "description": "첫 번째 제한 설정을 새로고침하는 날짜 및 시간입니다(ISO 8601).", "type": "string", "format": "date-time", "example": "2023-02-28T11:00:00+08:00" }, "displayable_reset_next_date": { "description": "제한 설정을 재설정해야 하는 날짜 및 시간입니다(ISO 8601).", "type": "string", "format": "date-time", "example": "2023-02-28T11:00:00+08:00" } } }, { "type": "object", "title": "interval_type = 월간", "description": "월간 사용자 제한 설정 새로고침 유형입니다.", "properties": { "interval_type": { "type": "string", "description": "반복 새로고침 기간 유형입니다.", "enum": [ "monthly" ] }, "day_of_month": { "type": [ "integer", "null" ], "description": "제한 설정을 새로고침하는 날짜입니다. 해당 월의 일수가 짧아 선택한 날짜가 없으면 해당 월의 마지막 날에 새로고침합니다. `monthly` 제한 설정 새로고침 기간 유형만 `null`이 아닙니다.", "minimum": 1, "maximum": 31 }, "time": { "type": "string", "description": "원하는 시간대의 제한 시간 새로고침 시간입니다(시간 단위로 반올림).", "format": "full-time", "example": "11:00:00+03:00" }, "reset_next_date": { "type": "integer", "description": "새로고침 제한 설정이 적용되는 날짜 및 시간입니다(Unix 타임스탬프)", "example": 1677553200 }, "displayable_reset_start_date": { "description": "첫 번째 제한 설정을 새로고침하는 날짜 및 시간입니다(ISO 8601).", "type": "string", "format": "date-time", "example": "2023-02-28T11:00:00+08:00" }, "displayable_reset_next_date": { "description": "제한 설정을 재설정해야 하는 날짜 및 시간입니다(ISO 8601).", "type": "string", "format": "date-time", "example": "2023-02-28T11:00:00+08:00" } } }, { "type": "object", "title": "interval_type = 시간", "description": "사용자 제한이 지정된 시간 간격(시간 단위)으로 재설정됩니다.", "properties": { "interval_type": { "type": "string", "description": "반복 새로고침 기간 유형입니다.", "enum": [ "hourly" ] }, "hours_interval": { "type": "integer", "description": "제한 업데이트 간격(시간).

카운트다운은 아이템이 스토어에 처음 표시된 이후부터 시작되며, 이는 date_from 매개 변수에 명시된 대로 진행니다.

예를 들어, `date_from = \"2025-11-15T18:15:00+05:00\"`이고 `hours_interval = 2`인 경우, 해당 아이템의 구매 제한은 `\"2025-11-15T20:15:00+05:00\"`부터 2시간마다 갱신됩니다.", "minimum": 1, "maximum": 10000 }, "reset_next_date": { "type": "integer", "description": "새로고침 제한 설정이 적용되는 날짜 및 시간입니다(Unix 타임스탬프)", "example": 1677553200 }, "displayable_reset_start_date": { "description": "첫 번째 제한 설정을 새로고침하는 날짜 및 시간입니다(ISO 8601).", "type": "string", "format": "date-time", "example": "2023-02-28T11:00:00+08:00" }, "displayable_reset_next_date": { "description": "제한 설정을 재설정해야 하는 날짜 및 시간입니다(ISO 8601).", "type": "string", "format": "date-time", "example": "2023-02-28T11:00:00+08:00" } } } ] } } }, "admin-item-limit-response": { "type": [ "object", "null" ], "description": "아이템 제한 사항입니다.", "properties": { "per_user": { "type": [ "object", "null" ], "description": "개별 사용자에 대한 아이템 제한 사항입니다.", "properties": { "total": { "type": "integer", "description": "사용자 한 명이 구매할 수 있는 최대 아이템 수량입니다." }, "limit_exceeded_visibility": { "$ref": "#/components/schemas/limit_exceeded_visibility" } } }, "per_item": { "type": [ "object", "null" ], "description": "전역 항목 제한 사항입니다.", "properties": { "total": { "type": "integer", "description": "모든 사용자가 구매할 수 있는 최대 아이템 수량." }, "available": { "type": "integer", "description": "모든 사용자가 구매할 수 있는 남은 아이템 수량." }, "reserved": { "type": "integer" }, "sold": { "type": "integer" } } }, "recurrent_schedule": { "$ref": "#/components/schemas/admin_recurrent_schedule_response" } } }, "item-periods-response": { "type": "array", "description": "아이템 판매 기간입니다.", "items": { "type": "object", "properties": { "date_from": { "type": [ "string", "null" ], "format": "date-time", "example": "2020-08-11T10:00:00+03:00", "description": "지정된 아이템을 판매할 수 있는 날짜입니다." }, "date_until": { "type": [ "string", "null" ], "format": "date-time", "example": "2020-08-11T20:00:00+03:00", "description": "지정된 아이템을 판매할 수 없게 되는 날짜입니다. `null`일 수 있습니다." } } } }, "item-custom-attributes-response": { "type": "object", "description": "아이템 특성 및 값이 포함된 JSON 개체입니다.", "format": "json" }, "Virtual-Items-Currency_admin-virtual-item": { "type": "object", "properties": { "sku": { "$ref": "#/components/schemas/Virtual-Items-Currency_sku" }, "attributes": { "$ref": "#/components/schemas/Virtual-Items-Currency_admin-attributes" }, "name": { "$ref": "#/components/schemas/name-localization-object" }, "description": { "$ref": "#/components/schemas/description-localization-object" }, "long_description": { "$ref": "#/components/schemas/long-description-localization-object" }, "groups": { "$ref": "#/components/schemas/Virtual-Items-Currency_admin-groups-response" }, "media_list": { "$ref": "#/components/schemas/Virtual-Items-Currency_admin-media_list" }, "type": { "$ref": "#/components/schemas/Virtual-Items-Currency_type" }, "prices": { "$ref": "#/components/schemas/Virtual-Items_admin-prices" }, "vc_prices": { "$ref": "#/components/schemas/Virtual-Items-Currency_admin-get-vc_prices" }, "image_url": { "$ref": "#/components/schemas/Virtual-Items-Currency_admin-image_url" }, "is_free": { "$ref": "#/components/schemas/value-is_free" }, "is_paid_randomized_reward": { "$ref": "#/components/schemas/value-is_paid_randomized_reward" }, "order": { "$ref": "#/components/schemas/Virtual-Items-Currency_order" }, "is_enabled": { "$ref": "#/components/schemas/Virtual-Items-Currency_is_enabled" }, "is_show_in_store": { "$ref": "#/components/schemas/Virtual-Items-Currency_is_show_in_store" }, "regions": { "$ref": "#/components/schemas/Virtual-Items-Currency_admin-regions" }, "limits": { "$ref": "#/components/schemas/admin-item-limit-response" }, "periods": { "$ref": "#/components/schemas/item-periods-response" }, "custom_attributes": { "$ref": "#/components/schemas/item-custom-attributes-response" } } }, "Virtual-Items-Currency_schemas-admin-image_url": { "type": "string", "example": "https://image.example.com", "description": "이미지 URL. 결제 UI에서 이미지가 올바르게 표시되고 빠르게 로드되도록 하려면 다음 이미지 및 URL 가이드라인을 확인하세요:
  • 지원되는 형식: WebP(권장), PNG, JPG.
  • 파일 크기: 50KB 이하(WebP의 경우) 또는 150KB 이하(PNG 및 JPG의 경우).
  • 이미지 크기: 280 x 280 픽셀.
  • 색 공간: sRGB.
  • 프로토콜: 버전 관리된 URL에 대해 장기 캐싱이 적용된 HTTPS.
" }, "Virtual-Items-Currency_admin-groups-create": { "type": "array", "description": "해당 아이템이 속한 [그룹 외부 ID](/ko/api/catalog/item-groups-admin/admin-get-item-group-list/#!path=groups/external_id&t=response) 목록입니다.\n\n예시: [\"horror\", \"action\"]", "items": { "type": "string", "properties": { "external_id": { "type": "string", "example": "accessory" }, "name": { "type": "string", "example": "Accessory" } } } }, "admin-post-put-attribute-item": { "type": "object", "required": [ "external_id", "values" ], "maxItems": 6, "properties": { "external_id": { "$ref": "#/components/schemas/admin-attribute-external_id" }, "name": { "$ref": "#/components/schemas/admin-attribute-name" }, "values": { "type": "array", "description": "
주의. 각 특성 당 6개 이상의 값을 생성할 수 없습니다. 제한을 초과하려고 하면 오류가 발생합니다.
", "items": { "$ref": "#/components/schemas/attribute-value" }, "example": [ { "external_id": "strategy", "value": { "en": "Strategy", "de": "Strategie" } }, { "external_id": "action", "value": { "en": "Action", "de": "Aktion" } } ] } } }, "Virtual-Items-Currency_admin-post-put-attributes": { "type": "array", "maxItems": 20, "description": "특성 목록입니다.\n\n
주의. 아이템에 20개 이상의 특성을 지정할 수 없습니다. 제한을 초과하려고 하면 오류가 발생합니다.
", "items": { "$ref": "#/components/schemas/admin-post-put-attribute-item" } }, "Virtual-Items-Currency_admin-create-vc_prices": { "description": "인게임 재화 가격 목록입니다.", "type": [ "array", "null" ], "items": { "type": "object", "properties": { "sku": { "$ref": "#/components/schemas/Virtual-Items-Currency_schemas-sku" }, "amount": { "type": "integer", "description": "인게임 재화로 표시된 아이템 가격입니다." }, "is_default": { "type": "boolean", "default": false, "description": "인게임 재화의 기본 가격인지 여부입니다." }, "is_enabled": { "type": "boolean", "default": true, "description": "이 가격이 카탈로그에 표시하거나 아이템을 구매할 때 사용되는지 여부입니다. `false`인 경우, 해당 가격은 사용되지 않습니다." } }, "required": [ "amount", "sku", "is_default", "is_enabled" ], "example": { "sku": "com.xsolla.gold_1", "amount": 10, "is_default": true, "is_enabled": true } } }, "limit_per_user": { "description": "개별 사용자에 대한 아이템 제한 사항입니다.", "anyOf": [ { "type": "null", "description": "사용자당 아이템 구매 제한이 없습니다." }, { "type": "integer", "description": "사용자 한 명이 구매할 수 있는 최대 아이템 수량입니다.", "example": 5 }, { "type": "object", "description": "자세한 구매 한도 설정입니다.", "properties": { "total": { "type": "integer", "description": "사용자 한 명이 구매할 수 있는 최대 아이템 수량입니다.", "example": 5 }, "limit_exceeded_visibility": { "$ref": "#/components/schemas/limit_exceeded_visibility" } } } ] }, "limit_per_item": { "type": [ "integer", "null" ], "description": "전역 항목 제한 사항입니다.", "example": 10 }, "per_user_daily": { "type": "object", "title": "interval_type = 일일", "description": "일일 사용자 유형 제한 설정을 새로고침합니다.", "properties": { "interval_type": { "type": "string", "description": "반복 새로고침 기간입니다.", "enum": [ "daily" ] }, "time": { "type": "string", "description": "원하는 시간대의 제한 시간 새로고침 시간입니다(시간 단위로 반올림).", "pattern": "((0[0-9]|1[0-9]|2[0-3]):00:00)(\\+|-)(0[0-9]|1[0-9]|2[0-3]):([0-5][0-9])", "example": "02:00:00+03:00" } }, "required": [ "interval_type", "time" ] }, "per_user_weekly": { "type": "object", "title": "interval_type = 주간", "description": "주간 사용자 유형 제한 설정을 새로고침합니다.", "properties": { "interval_type": { "type": "string", "description": "반복 새로고침 기간입니다.", "enum": [ "weekly" ] }, "day_of_week": { "type": "integer", "description": "제한을 새로고침하는 요일입니다. 여기서 1은 월요일이고 7은 일요일입니다.", "minimum": 1, "maximum": 7 }, "time": { "type": "string", "description": "원하는 시간대의 제한 시간 새로고침 시간입니다(시간 단위로 반올림).", "pattern": "((0[0-9]|1[0-9]|2[0-3]):00:00)(\\+|-)(0[0-9]|1[0-9]|2[0-3]):([0-5][0-9])", "example": "11:00:00+03:00" } } }, "per_user_monthly": { "type": "object", "title": "interval_type = 월간", "description": "월간 사용자 제한 설정 새로고침 유형입니다.", "properties": { "interval_type": { "type": "string", "description": "반복 새로고침 기간입니다.", "enum": [ "monthly" ] }, "day_of_month": { "type": "integer", "description": "제한 설정을 새로고침하는 날짜입니다. 해당 월의 일수가 짧아 선택한 날짜가 없으면 해당 월의 마지막 날에 새로고침합니다.", "minimum": 1, "maximum": 31 }, "time": { "type": "string", "description": "원하는 시간대의 제한 시간 새로고침 시간입니다(시간 단위로 반올림).", "pattern": "((0[0-9]|1[0-9]|2[0-3]):00:00)(\\+|-)(0[0-9]|1[0-9]|2[0-3]):([0-5][0-9])", "example": "23:00:00+03:00" } }, "required": [ "interval_type", "time", "day_of_month" ] }, "interval_type_hourly": { "type": "string", "description": "반복 새로고침 기간입니다.", "enum": [ "hourly" ] }, "hours_interval": { "type": "integer", "minimum": 1, "maximum": 10000 }, "per_user_hourly_vi": { "type": "object", "title": "interval_type = 시간", "properties": { "interval_type": { "$ref": "#/components/schemas/interval_type_hourly" }, "hours_interval": { "allOf": [ { "$ref": "#/components/schemas/hours_interval" }, { "description": "한도가 재설정되는 시간 간격(시간).

카운트다운은 date_from 매개 변수에서 시작됩니다.

예를 들어, `date_start = \"2025-11-15T18:15:00+05:00\"`이고 `hours_interval = 2`인 경우, 이 아이템의 구매 한도는 `\"2025-11-15T20:15:00+05:00\"`부터 2시간마다 재설정됩니다." } ] } }, "required": [ "interval_type", "hours_interval" ] }, "virtual_item_recurrent_schedule": { "type": [ "object", "null" ], "description": "새로고침 기간을 제한합니다.", "properties": { "per_user": { "description": "지정된 시간 간격(시간 단위)마다 구매 한도가 재설정됩니다.", "oneOf": [ { "$ref": "#/components/schemas/per_user_daily" }, { "$ref": "#/components/schemas/per_user_weekly" }, { "$ref": "#/components/schemas/per_user_monthly" }, { "$ref": "#/components/schemas/per_user_hourly_vi" } ] } } }, "Virtual-Item-item-limit": { "type": "object", "description": "아이템 제한 사항입니다.", "properties": { "per_user": { "$ref": "#/components/schemas/limit_per_user" }, "per_item": { "$ref": "#/components/schemas/limit_per_item" }, "recurrent_schedule": { "$ref": "#/components/schemas/virtual_item_recurrent_schedule" } } }, "item-periods": { "type": [ "array", "null" ], "description": "아이템 판매 기간입니다.", "items": { "type": "object", "properties": { "date_from": { "type": "string", "format": "date-time", "example": "2020-08-11T10:00:00+03:00", "description": "지정된 아이템을 판매할 수 있는 날짜입니다." }, "date_until": { "type": [ "string", "null" ], "format": "date-time", "example": "2020-08-11T20:00:00+03:00", "description": "지정된 아이템을 판매할 수 없게 되는 날짜입니다. `null`일 수 있습니다." } } } }, "item-custom-attributes": { "type": "object", "description": "아이템 특성과 값이 포함된 JSON 개체입니다. 특성을 사용하면 아이템을 사용할 수 있는 플레이어의 레벨과 같은 추가 정보를 아이템에 추가할 수 있습니다. 특성은 게임의 내부 논리를 강화하며 전용 GET 메소드와 웹훅을 통해 이용할 수 있습니다.", "format": "json", "maxLength": 500 }, "Virtual-Items-Currency_admin-create-virtual-item": { "type": "object", "properties": { "sku": { "$ref": "#/components/schemas/Virtual-Items-Currency_sku" }, "name": { "$ref": "#/components/schemas/name-localization-object" }, "description": { "$ref": "#/components/schemas/description-localization-object" }, "long_description": { "$ref": "#/components/schemas/long-description-localization-object" }, "image_url": { "$ref": "#/components/schemas/Virtual-Items-Currency_schemas-admin-image_url" }, "media_list": { "$ref": "#/components/schemas/Virtual-Items-Currency_admin-media_list" }, "groups": { "$ref": "#/components/schemas/Virtual-Items-Currency_admin-groups-create" }, "attributes": { "$ref": "#/components/schemas/Virtual-Items-Currency_admin-post-put-attributes" }, "prices": { "$ref": "#/components/schemas/Virtual-Items_admin-prices" }, "vc_prices": { "$ref": "#/components/schemas/Virtual-Items-Currency_admin-create-vc_prices" }, "is_enabled": { "$ref": "#/components/schemas/Virtual-Items-Currency_is_enabled" }, "is_show_in_store": { "$ref": "#/components/schemas/Virtual-Items-Currency_is_show_in_store" }, "is_free": { "$ref": "#/components/schemas/value-is_free" }, "is_paid_randomized_reward": { "$ref": "#/components/schemas/value-is_paid_randomized_reward" }, "order": { "$ref": "#/components/schemas/Virtual-Items-Currency_order" }, "regions": { "$ref": "#/components/schemas/Virtual-Items-Currency_admin-regions" }, "limits": { "$ref": "#/components/schemas/Virtual-Item-item-limit" }, "periods": { "$ref": "#/components/schemas/item-periods" }, "custom_attributes": { "$ref": "#/components/schemas/item-custom-attributes" } } }, "Virtual-Items-Currency_422-invalid-request": { "type": "object", "properties": { "statusCode": { "type": "integer", "example": 422 }, "errorCode": { "type": "integer", "example": 1102 }, "errorMessage": { "type": "string", "example": "[0401-1102]: Unprocessable Entity. The property `property_name` is required" }, "transactionId": { "type": "string", "example": "x-x-x-x-transactionId-mock-x-x-x" }, "errorMessageExtended": { "type": "array" } } }, "Virtual-Items-Currency_admin-prices": { "type": "array", "items": { "type": "object", "required": [ "amount", "currency" ], "properties": { "currency": { "type": "string", "example": "USD", "description": "아이템 가격 통화입니다. [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)에 따른 3자리 코드입니다. [엑솔라에서 지원하는 통화](https://developers.xsolla.com/ko/doc/pay-station/references/supported-currencies/)에 대한 자세한 내용은 설명서를 확인하십시오." }, "amount": { "type": "number", "exclusiveMinimum": 0, "example": 10.5, "description": "실제 화폐로 표시된 아이템 가격입니다." }, "is_default": { "type": "boolean", "default": false, "description": "실제 통화로 표시되는 기본 가격인지 여부입니다. 가격 설정에 대한 자세한 내용은 [문서](https://developers.xsolla.com/ko/items-catalog/catalog-features/pricing-policy/#pricing_policy_country_determination)를 참조하십시오." }, "is_enabled": { "type": "boolean", "default": true, "example": true, "description": "이 가격이 카탈로그에 표시하거나 아이템을 구매할 때 사용되는지 여부입니다. `false`로 설정하면 해당 가격은 사용되지 않으며 다른 가격이 적용됩니다. 가격 설정에 대한 자세한 내용은 [문서](https://developers.xsolla.com/ko/items-catalog/catalog-features/pricing-policy/#pricing_policy_country_determination)를 참조하십시오." }, "country_iso": { "type": [ "string", "null" ], "example": "US", "description": "이 가격을 사용할 수 있는 국가입니다. [ISO 3166-1 alpha 2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)에 따른 2자리 글자 코드입니다." } }, "example": { "currency": "USD", "amount": 10.5, "is_default": true, "is_enabled": true, "country_iso": "US" } } }, "Virtual-Items-Currency_admin-virtual-currency": { "type": "object", "properties": { "sku": { "$ref": "#/components/schemas/Virtual-Items-Currency_sku" }, "name": { "$ref": "#/components/schemas/name-localization-object" }, "description": { "$ref": "#/components/schemas/description-localization-object" }, "long_description": { "$ref": "#/components/schemas/long-description-localization-object" }, "groups": { "$ref": "#/components/schemas/Virtual-Items-Currency_admin-groups-response" }, "attributes": { "$ref": "#/components/schemas/Virtual-Items-Currency_admin-attributes" }, "media_list": { "$ref": "#/components/schemas/Virtual-Items-Currency_admin-media_list" }, "type": { "$ref": "#/components/schemas/Virtual-Items-Currency_type" }, "prices": { "$ref": "#/components/schemas/Virtual-Items-Currency_admin-prices" }, "vc_prices": { "$ref": "#/components/schemas/Virtual-Items-Currency_admin-get-vc_prices" }, "image_url": { "$ref": "#/components/schemas/Virtual-Items-Currency_admin-image_url" }, "is_enabled": { "$ref": "#/components/schemas/Virtual-Items-Currency_is_enabled" }, "is_free": { "$ref": "#/components/schemas/value-is_free" }, "is_paid_randomized_reward": { "$ref": "#/components/schemas/value-is_paid_randomized_reward" }, "order": { "$ref": "#/components/schemas/Virtual-Items-Currency_order" }, "is_show_in_store": { "$ref": "#/components/schemas/Virtual-Items-Currency_is_show_in_store" }, "regions": { "$ref": "#/components/schemas/Virtual-Items-Currency_admin-regions" }, "limits": { "$ref": "#/components/schemas/admin-item-limit-response" }, "periods": { "$ref": "#/components/schemas/item-periods-response" }, "custom_attributes": { "$ref": "#/components/schemas/item-custom-attributes-response" } } }, "per_user_hourly_vc": { "type": "object", "title": "interval_type = 시간", "properties": { "interval_type": { "$ref": "#/components/schemas/interval_type_hourly" }, "hours_interval": { "allOf": [ { "$ref": "#/components/schemas/hours_interval" }, { "description": "한도가 재설정되는 시간 간격(시간).

카운트다운은 date_from 매개 변수에서 시작됩니다.

예를 들어, `date_start = \"2025-11-15T18:15:00+05:00\"`이고 `hours_interval = 2`인 경우, 이 아이템의 구매 한도는 `\"2025-11-15T20:15:00+05:00\"`부터 2시간마다 재설정됩니다." } ] } }, "required": [ "interval_type", "hours_interval" ] }, "virtual_currency_recurrent_schedule": { "type": [ "object", "null" ], "description": "새로고침 기간을 제한합니다.", "properties": { "per_user": { "description": "지정된 시간 간격(시간 단위)마다 구매 한도가 재설정됩니다.", "oneOf": [ { "$ref": "#/components/schemas/per_user_daily" }, { "$ref": "#/components/schemas/per_user_weekly" }, { "$ref": "#/components/schemas/per_user_monthly" }, { "$ref": "#/components/schemas/per_user_hourly_vc" } ] } } }, "Virtual-Currency-item-limit": { "type": "object", "description": "아이템 제한 사항입니다.", "properties": { "per_user": { "$ref": "#/components/schemas/limit_per_user" }, "per_item": { "$ref": "#/components/schemas/limit_per_item" }, "recurrent_schedule": { "$ref": "#/components/schemas/virtual_currency_recurrent_schedule" } } }, "Virtual-Items-Currency_admin-create-virtual-currency": { "type": "object", "required": [ "sku", "name" ], "properties": { "sku": { "$ref": "#/components/schemas/Virtual-Items-Currency_sku" }, "name": { "$ref": "#/components/schemas/name-localization-object" }, "description": { "$ref": "#/components/schemas/description-localization-object" }, "long_description": { "$ref": "#/components/schemas/long-description-localization-object" }, "image_url": { "$ref": "#/components/schemas/Virtual-Items-Currency_admin-image_url" }, "media_list": { "$ref": "#/components/schemas/Virtual-Items-Currency_admin-media_list" }, "groups": { "$ref": "#/components/schemas/Virtual-Items-Currency_admin-groups-create" }, "attributes": { "$ref": "#/components/schemas/Virtual-Items-Currency_admin-post-put-attributes" }, "prices": { "$ref": "#/components/schemas/Virtual-Items-Currency_admin-prices" }, "vc_prices": { "$ref": "#/components/schemas/Virtual-Items-Currency_admin-create-vc_prices" }, "is_enabled": { "$ref": "#/components/schemas/Virtual-Items-Currency_is_enabled" }, "is_show_in_store": { "$ref": "#/components/schemas/Virtual-Items-Currency_is_show_in_store" }, "is_free": { "$ref": "#/components/schemas/value-is_free" }, "is_paid_randomized_reward": { "$ref": "#/components/schemas/value-is_paid_randomized_reward" }, "order": { "$ref": "#/components/schemas/Virtual-Items-Currency_order" }, "regions": { "$ref": "#/components/schemas/Virtual-Items-Currency_admin-regions" }, "limits": { "$ref": "#/components/schemas/Virtual-Currency-item-limit" }, "periods": { "$ref": "#/components/schemas/item-periods" }, "custom_attributes": { "$ref": "#/components/schemas/item-custom-attributes" } } }, "Virtual-Items-Currency_admin-virtual-currency-package": { "type": "object", "properties": { "sku": { "$ref": "#/components/schemas/Virtual-Items-Currency_sku" }, "name": { "$ref": "#/components/schemas/name-localization-object" }, "description": { "$ref": "#/components/schemas/description-localization-object" }, "long_description": { "$ref": "#/components/schemas/long-description-localization-object" }, "type": { "$ref": "#/components/schemas/Virtual-Items-Currency_type" }, "image_url": { "$ref": "#/components/schemas/Virtual-Items-Currency_admin-image_url" }, "attributes": { "$ref": "#/components/schemas/Virtual-Items-Currency_admin-attributes" }, "is_free": { "$ref": "#/components/schemas/value-is_free" }, "is_paid_randomized_reward": { "$ref": "#/components/schemas/value-is_paid_randomized_reward" }, "order": { "$ref": "#/components/schemas/Virtual-Items-Currency_order" }, "groups": { "$ref": "#/components/schemas/Virtual-Items-Currency_admin-groups-response" }, "prices": { "$ref": "#/components/schemas/Virtual-Items-Currency_admin-prices" }, "media_list": { "$ref": "#/components/schemas/Virtual-Items-Currency_admin-media_list" }, "vc_prices": { "$ref": "#/components/schemas/Virtual-Items-Currency_admin-get-vc_prices" }, "is_enabled": { "$ref": "#/components/schemas/Virtual-Items-Currency_is_enabled" }, "bundle_type": { "type": "string", "default": "virtual_currency_package", "example": "virtual_currency_package" }, "content": { "type": "array", "items": { "type": "object", "properties": { "sku": { "$ref": "#/components/schemas/Virtual-Items-Currency_sku" }, "name": { "$ref": "#/components/schemas/name-localization-object" }, "description": { "$ref": "#/components/schemas/description-localization-object" }, "image_url": { "$ref": "#/components/schemas/Virtual-Items-Currency_admin-image_url" }, "type": { "$ref": "#/components/schemas/Virtual-Items-Currency_type" }, "quantity": { "type": "integer" } } } }, "is_show_in_store": { "$ref": "#/components/schemas/Virtual-Items-Currency_is_show_in_store" }, "regions": { "$ref": "#/components/schemas/Virtual-Items-Currency_admin-regions" }, "limits": { "$ref": "#/components/schemas/admin-item-limit-response" }, "periods": { "$ref": "#/components/schemas/item-periods-response" }, "custom_attributes": { "$ref": "#/components/schemas/item-custom-attributes" } } }, "per_user_hourly_vcp": { "type": "object", "title": "interval_type = 시간", "properties": { "interval_type": { "$ref": "#/components/schemas/interval_type_hourly" }, "hours_interval": { "allOf": [ { "$ref": "#/components/schemas/hours_interval" }, { "description": "한도가 재설정되는 시간 간격(시간).

카운트다운은 date_from 매개 변수에서 시작됩니다.

예를 들어, `date_start = \"2025-11-15T18:15:00+05:00\"`이고 `hours_interval = 2`인 경우, 이 아이템의 구매 한도는 `\"2025-11-15T20:15:00+05:00\"`부터 2시간마다 재설정됩니다." } ] } }, "required": [ "interval_type", "hours_interval" ] }, "virtual_currency_package_recurrent_schedule": { "type": [ "object", "null" ], "description": "새로고침 기간을 제한합니다.", "properties": { "per_user": { "description": "지정된 시간 간격(시간 단위)마다 구매 한도가 재설정됩니다.", "oneOf": [ { "$ref": "#/components/schemas/per_user_daily" }, { "$ref": "#/components/schemas/per_user_weekly" }, { "$ref": "#/components/schemas/per_user_monthly" }, { "$ref": "#/components/schemas/per_user_hourly_vcp" } ] } } }, "Virtual-Currency-Package-item-limit": { "type": "object", "description": "아이템 제한 사항입니다.", "properties": { "per_user": { "$ref": "#/components/schemas/limit_per_user" }, "per_item": { "$ref": "#/components/schemas/limit_per_item" }, "recurrent_schedule": { "$ref": "#/components/schemas/virtual_currency_package_recurrent_schedule" } } }, "Virtual-Items-Currency_admin-create-virtual-currency-package": { "type": "object", "required": [ "sku", "name", "description", "content" ], "anyOf": [ { "required": [ "prices" ] }, { "required": [ "vc_prices" ] } ], "properties": { "sku": { "$ref": "#/components/schemas/Virtual-Items-Currency_sku" }, "name": { "$ref": "#/components/schemas/name-localization-object" }, "description": { "$ref": "#/components/schemas/description-localization-object" }, "long_description": { "$ref": "#/components/schemas/long-description-localization-object" }, "image_url": { "$ref": "#/components/schemas/Virtual-Items-Currency_admin-image_url" }, "media_list": { "$ref": "#/components/schemas/Virtual-Items-Currency_admin-media_list" }, "groups": { "$ref": "#/components/schemas/Virtual-Items-Currency_admin-groups-create" }, "attributes": { "$ref": "#/components/schemas/Virtual-Items-Currency_admin-post-put-attributes" }, "prices": { "$ref": "#/components/schemas/Virtual-Items-Currency_admin-prices" }, "vc_prices": { "$ref": "#/components/schemas/Virtual-Items-Currency_admin-create-vc_prices" }, "is_enabled": { "$ref": "#/components/schemas/Virtual-Items-Currency_is_enabled" }, "is_show_in_store": { "$ref": "#/components/schemas/Virtual-Items-Currency_is_show_in_store" }, "is_free": { "$ref": "#/components/schemas/value-is_free" }, "is_paid_randomized_reward": { "$ref": "#/components/schemas/value-is_paid_randomized_reward" }, "order": { "$ref": "#/components/schemas/Virtual-Items-Currency_order" }, "content": { "type": "array", "minLength": 1, "maxLength": 1, "description": "인게임 재화 패키지에는 1개의 인게임 재화 위치만 포함할 수 있습니다.", "items": { "type": "object", "properties": { "sku": { "$ref": "#/components/schemas/Virtual-Items-Currency_sku" }, "quantity": { "type": "integer" } } } }, "regions": { "$ref": "#/components/schemas/Virtual-Items-Currency_admin-regions" }, "limits": { "$ref": "#/components/schemas/Virtual-Currency-Package-item-limit" }, "periods": { "$ref": "#/components/schemas/item-periods" }, "custom_attributes": { "$ref": "#/components/schemas/item-custom-attributes" } } }, "Pagination_has-more": { "type": "boolean", "example": true, "description": "페이지가 더 있다는 표시로 사용됩니다." }, "items_client_groups_response": { "type": "array", "example": [ { "external_id": "exclusive", "name": "Exclusive" } ], "default": [], "description": "아이템이 속한 그룹입니다.", "items": { "type": "object", "properties": { "external_id": { "type": "string", "description": "생성 시 지정된 [외부 아이템 그룹 ID](/ko/api/catalog/item-groups-admin/admin-create-item-group#item-groups-admin/admin-create-item-group/t=request&path=external_id)입니다.", "example": "exclusive" }, "name": { "type": "string", "description": "그룹의 이름입니다.", "example": "Exclusive" }, "item_order_in_group": { "type": "integer", "description": "아이템의 표시 순서를 결정하는 그룹 내 아이템 위치입니다.\n`additional_fields[]` 쿼리 매개 변수를 통해 요청된 경우에만 반환됩니다.", "example": 1 } } } }, "Virtual-Items-Currency_client-attributes": { "type": "array", "description": "아이템에 해당하는 특성 및 해당 값의 목록입니다. 카탈로그 필터링에 사용할 수 있습니다.", "example": { "value": { "external_id": "genre", "name": "Жанр", "values": [ { "external_id": "genre_e3364991f92e751689a68b96598a5a5a84010b85", "value": "Casual" }, { "external_id": "genre_eba07bfd0f982940773cba3744d97264dd58acd7", "value": "Strategy" }, { "external_id": "genre_b8d0c6d8f0524c2b2d79ebb93aa3cd0e8b5199a8", "value": "Mobile" } ] } }, "default": [], "items": { "type": "object", "properties": { "external_id": { "$ref": "#/components/schemas/admin-attribute-external_id" }, "name": { "type": "object", "description": "특성의 이름입니다.", "example": "Genre", "additionalProperties": { "type": [ "string", "null" ] } }, "values": { "type": "array", "items": { "type": "object", "properties": { "external_id": { "$ref": "#/components/schemas/value-external_id" }, "value": { "type": "string", "description": "특성의 값입니다.", "example": "Strategy" } } } } } } }, "client_virtual_prices_response": { "type": "array", "description": "가상 가격입니다.", "items": { "type": "object", "description": "가상 가격입니다.", "properties": { "amount": { "type": "integer", "example": 100, "description": "인게임 재화로 표시된 아이템 가격입니다." }, "amount_without_discount": { "type": "integer", "example": 200, "description": "할인 없이 인게임 재화로 표시된 아이템 가격입니다. 인게임 재화 가격에는 할인이 적용되지 않으므로 항상 `amount`와 같습니다." }, "sku": { "type": "string", "example": "vc_gold", "description": "인게임 재화 SKU입니다." }, "is_default": { "type": "boolean", "example": true, "description": "인게임 재화의 기본 가격인지 여부입니다." }, "image_url": { "type": [ "string", "null" ], "example": "http://image.png", "description": "인게임 재화의 이미지 URL입니다." }, "name": { "type": "string", "example": "Gold", "description": "인게임 재화의 이름입니다." }, "type": { "type": "string", "example": "virtual_currency", "description": "아이템 유형. 인게임 재화의 경우 `virtual_currency`입니다." }, "description": { "type": [ "string", "null" ], "example": "In-game currency used to purchase weapons and upgrades", "description": "인게임 재화 설명입니다." } } } }, "Can_be_bought": { "type": "boolean", "example": true, "description": "`true`일 경우 사용자는 아이템을 구매할 수 있습니다." }, "Catalog_item_promotions": { "type": "array", "description": "장바구니의 특정 아이템에 적용된 프로모션. 다음의 경우 배열이 반환됩니다.\n\n* 특정 아이템에 대한 할인 프로모션이 구성된 경우\n\n* **선택한 아이템 할인** 설정이 있는 프로모션 코드가 적용된 경우\n\n적용된 아이템 수준 프로모션이 없는 경우 빈 배열이 반환됩니다.", "items": { "type": "object", "properties": { "name": { "type": "string" }, "date_start": { "type": [ "string", "null" ], "format": "date-time" }, "date_end": { "type": [ "string", "null" ], "format": "date-time" }, "discount": { "type": [ "object", "null" ], "properties": { "percent": { "type": [ "string", "null" ] }, "value": { "type": [ "string", "null" ] } } }, "bonus": { "type": "array", "items": { "type": "object", "properties": { "sku": { "type": "string" }, "quantity": { "type": "integer" }, "type": { "type": "string", "description": "보너스 아이템 유형입니다.", "enum": [ "virtual_good", "virtual_currency", "bundle", "physical_good", "game_key", "nft" ] }, "name": { "type": "string", "description": "보너스 아이템 이름입니다. `physical_good` 보너스 아이템 유형에는 사용할 수 없습니다." }, "image_url": { "type": "string", "description": "보너스 아이템 이미지 URL입니다. `physical_good` 보너스 아이템 유형에는 사용할 수 없습니다." }, "bundle_type": { "type": "string", "description": "보너스 번들 아이템 유형입니다. `bundle` 보너스 아이템 유형에서만 사용할 수 있습니다.", "enum": [ "standard", "virtual_currency_package" ] } } } }, "limits": { "type": "object", "properties": { "per_user": { "type": "object", "properties": { "available": { "type": "integer" }, "total": { "type": "integer" } } } } } } } }, "catalog_recurrent_schedule_client_response": { "type": [ "object", "null" ], "description": "아이템이 사용자의 반복 새로고침 기간을 제한합니다.", "oneOf": [ { "type": "object", "title": "interval_type = 일일", "description": "일일 사용자 유형 제한 설정을 새로고침합니다.", "properties": { "interval_type": { "type": "string", "description": "반복 새로고침 기간 유형입니다.", "enum": [ "daily" ] }, "reset_next_date": { "type": "integer", "description": "재설정 제한이 적용되는 날짜 및 시간입니다(Unix 타임스탬프)", "example": 1677553200 } } }, { "type": "object", "title": "interval_type = 주간", "description": "주간 사용자 유형 제한 설정을 새로고침합니다.", "properties": { "interval_type": { "type": "string", "description": "반복 새로고침 기간 유형입니다.", "enum": [ "weekly" ] }, "reset_next_date": { "type": "integer", "description": "재설정 제한이 적용되는 날짜 및 시간입니다(Unix 타임스탬프)", "example": 1677553200 } } }, { "type": "object", "title": "interval_type = 월간", "description": "월간 사용자 제한 설정 새로고침 유형입니다.", "properties": { "interval_type": { "type": "string", "description": "반복 새로고침 기간 유형입니다.", "enum": [ "monthly" ] }, "reset_next_date": { "type": "integer", "description": "재설정 제한이 적용되는 날짜 및 시간입니다(Unix 타임스탬프)", "example": 1677553200 } } }, { "type": "object", "title": "interval_type = 시간", "description": "사용자 제한이 지정된 시간 간격(시간 단위)으로 재설정됩니다.", "properties": { "interval_type": { "type": "string", "description": "반복 새로고침 기간 유형입니다.", "enum": [ "hourly" ] }, "reset_next_date": { "type": "integer", "description": "재설정 제한이 적용되는 날짜 및 시간입니다(Unix 타임스탬프)", "example": 1677553200 } } } ] }, "client-item-limit-response": { "type": [ "object", "null" ], "description": "아이템 제한 사항입니다.", "properties": { "per_user": { "type": [ "object", "null" ], "description": "개별 사용자에 대한 아이템 제한 사항입니다.", "properties": { "total": { "type": "integer", "description": "사용자 한 명이 구매할 수 있는 최대 아이템 수량입니다." }, "available": { "type": "integer", "description": "현재 사용자가 구매할 수 있는 남은 아이템 수량." }, "recurrent_schedule": { "$ref": "#/components/schemas/catalog_recurrent_schedule_client_response" }, "limit_exceeded_visibility": { "$ref": "#/components/schemas/limit_exceeded_visibility" } } }, "per_item": { "type": [ "object", "null" ], "description": "전역 항목 제한 사항입니다.", "properties": { "total": { "type": "integer", "description": "모든 사용자가 구매할 수 있는 최대 아이템 수량." }, "available": { "type": "integer", "description": "모든 사용자가 구매할 수 있는 남은 아이템 수량." } } } } }, "item_id": { "type": "integer", "example": 1, "description": "내부 고유 아이템 ID입니다." }, "value-point-sku": { "type": "string", "description": "고유 가치 포인트 ID입니다." }, "value-point-amount": { "type": "integer", "description": "가치 포인트의 금액입니다." }, "value-point-name": { "type": "string", "description": "가치 포인트 이름입니다." }, "Common_admin-image_url": { "type": "string", "example": "https://image.example.com", "description": "이미지 URL입니다." }, "is_clan": { "type": "boolean", "description": "값 포인트가 클랜 보상 체인에서 사용되는지 여부입니다.", "example": true }, "client-item-value-point-reward": { "type": "array", "description": "아이템의 가치 포인트 리워드 목록입니다.", "items": { "type": "object", "properties": { "item_id": { "$ref": "#/components/schemas/item_id" }, "sku": { "$ref": "#/components/schemas/value-point-sku" }, "amount": { "$ref": "#/components/schemas/value-point-amount" }, "name": { "$ref": "#/components/schemas/value-point-name" }, "image_url": { "$ref": "#/components/schemas/Common_admin-image_url" }, "is_clan": { "$ref": "#/components/schemas/is_clan" } } } }, "Virtual-Items-Currency_item": { "type": "object", "properties": { "item_id": { "type": "number", "description": "아이템 ID입니다." }, "sku": { "type": "string", "example": "big_rocket", "description": "고유 아이템 ID입니다. SKU는 소문자 및 대문자 라틴 영숫자, 마침표, 대시 및 밑줄만 포함할 수 있습니다." }, "name": { "type": "object", "example": "Big Rocket", "description": "아이템 이름입니다.", "additionalProperties": { "type": [ "string", "null" ] } }, "groups": { "$ref": "#/components/schemas/items_client_groups_response" }, "attributes": { "$ref": "#/components/schemas/Virtual-Items-Currency_client-attributes" }, "type": { "type": "string", "example": "virtual_good", "description": "아이템 유형: `virtual_good`/`virtual_currency`/`bundle`." }, "description": { "type": "object", "example": "Big Rocket - description", "description": "아이템 설명입니다.", "additionalProperties": { "type": [ "string", "null" ] } }, "image_url": { "type": "string", "example": "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png", "description": "이미지 URL입니다." }, "is_free": { "$ref": "#/components/schemas/value-is_free" }, "price": { "type": [ "object", "null" ], "description": "아이템 가격입니다.", "properties": { "amount": { "type": "string", "example": "100.99", "description": "할인된 아이템 가격입니다." }, "amount_without_discount": { "type": "string", "example": "100.99", "description": "아이템 가격입니다." }, "currency": { "type": "string", "example": "USD", "description": "아이템 가격 통화입니다. [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)에 따른 3자리 코드입니다. [엑솔라에서 지원하는 통화](https://developers.xsolla.com/ko/doc/pay-station/references/supported-currencies/)에 대한 자세한 내용은 설명서를 확인하십시오." } } }, "virtual_prices": { "$ref": "#/components/schemas/client_virtual_prices_response" }, "can_be_bought": { "$ref": "#/components/schemas/Can_be_bought" }, "virtual_item_type": { "type": "string", "example": "non-consumable", "description": "가상 아이템의 유형입니다.\n\n사용 가능한 값: - `consumable` - 사용 후 인벤토리에서 사라지는 아이템(예: 탄약). - `non_consumable` - 인벤토리에 무기한으로 남아 있는 아이템. - `non_renewing_subscription` - 일정 기간 동안 서비스나 콘텐츠에 대한 이용 권한을 나타낼 수 있는 기간 한정 아이템.", "enum": [ "consumable", "non_consumable", "non_renewing_subscription" ] }, "promotions": { "$ref": "#/components/schemas/Catalog_item_promotions" }, "limits": { "$ref": "#/components/schemas/client-item-limit-response" }, "periods": { "$ref": "#/components/schemas/item-periods-response" }, "custom_attributes": { "$ref": "#/components/schemas/item-custom-attributes-response" }, "vp_rewards": { "$ref": "#/components/schemas/client-item-value-point-reward" } } }, "Virtual-Items-Currency_item-list": { "type": "object", "properties": { "has_more": { "$ref": "#/components/schemas/Pagination_has-more" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/Virtual-Items-Currency_item" } } } }, "Catalog_item_limits": { "description": "아이템 제한 사항입니다.", "properties": { "per_user": { "type": [ "object", "null" ], "description": "사용자 한 명에 대한 아이템 제한 사항입니다.", "properties": { "total": { "type": "integer", "description": "사용자 한 명이 구매할 수 있는 최대 아이템 수량입니다.", "example": 5 }, "available": { "type": "integer", "description": "현재 사용자가 구매할 수 있는 남은 아이템 수량.", "example": 3 }, "recurrent_schedule": { "$ref": "#/components/schemas/catalog_recurrent_schedule_client_response" }, "limit_exceeded_visibility": { "$ref": "#/components/schemas/limit_exceeded_visibility" } } }, "per_item": { "type": [ "object", "null" ], "description": "한 개 아이템에 대한 아이템 제한 사항입니다.", "properties": { "total": { "type": "integer", "description": "모든 사용자가 구매할 수 있는 최대 아이템 수량.", "example": 5 }, "available": { "type": "integer", "description": "모든 사용자가 구매할 수 있는 남은 아이템 수량.", "example": 3 } } } }, "type": [ "object", "null" ] }, "Virtual-Items-Currency_virtual-currency": { "type": "object", "properties": { "item_id": { "type": "integer", "description": "엑솔라가 할당한 고유 아이템 ID입니다." }, "sku": { "type": "string", "example": "crystal", "description": "고유 아이템 ID입니다. SKU는 소문자 및 대문자 라틴 영숫자, 마침표, 대시 및 밑줄만 포함할 수 있습니다." }, "name": { "type": "string", "example": "Crystals", "description": "아이템 이름입니다." }, "groups": { "$ref": "#/components/schemas/items_client_groups_response" }, "attributes": { "$ref": "#/components/schemas/Virtual-Items-Currency_client-attributes" }, "type": { "type": "string", "example": "virtual_currency", "description": "아이템 유형: `virtual_good`/`virtual_currency`/`bundle`." }, "description": { "type": "string", "example": "Crystals - description", "description": "아이템 설명입니다." }, "image_url": { "type": "string", "example": "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png", "description": "이미지 URL입니다." }, "is_free": { "$ref": "#/components/schemas/value-is_free" }, "price": { "type": [ "object", "null" ], "description": "아이템 가격입니다.", "properties": { "amount": { "type": "string", "example": "100.99", "description": "할인된 아이템 가격입니다." }, "amount_without_discount": { "type": "string", "example": "100.99", "description": "아이템 가격입니다." }, "currency": { "type": "string", "example": "USD", "description": "아이템 가격 통화입니다. [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)에 따른 3자리 코드입니다. [엑솔라에서 지원하는 통화](https://developers.xsolla.com/ko/doc/pay-station/references/supported-currencies/)에 대한 자세한 내용은 설명서를 확인하십시오." } } }, "virtual_prices": { "$ref": "#/components/schemas/client_virtual_prices_response", "example": [ { "amount": 100, "sku": "com.xsolla.crystals_1", "is_default": true, "amount_without_discount": 100, "image_url": "http://image.png" } ] }, "can_be_bought": { "$ref": "#/components/schemas/Can_be_bought" }, "promotions": { "$ref": "#/components/schemas/Catalog_item_promotions" }, "limits": { "$ref": "#/components/schemas/Catalog_item_limits" }, "periods": { "$ref": "#/components/schemas/item-periods-response" }, "custom_attributes": { "$ref": "#/components/schemas/item-custom-attributes-response" }, "vp_rewards": { "$ref": "#/components/schemas/client-item-value-point-reward" } } }, "Virtual-Items-Currency_virtual-currency-list": { "type": "object", "properties": { "has_more": { "$ref": "#/components/schemas/Pagination_has-more" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/Virtual-Items-Currency_virtual-currency" } } } }, "Virtual-Items-Currency_virtual-currency-package": { "type": "object", "properties": { "item_id": { "type": "integer", "description": "엑솔라가 할당한 고유 아이템 ID입니다." }, "sku": { "type": "string", "example": "crystal-pack", "description": "고유 아이템 ID입니다. SKU는 소문자 및 대문자 라틴 영숫자, 마침표, 대시 및 밑줄만 포함할 수 있습니다." }, "name": { "type": "string", "example": "Crystal Pack", "description": "아이템 이름입니다." }, "groups": { "$ref": "#/components/schemas/items_client_groups_response" }, "attributes": { "$ref": "#/components/schemas/Virtual-Items-Currency_client-attributes" }, "type": { "type": "string", "example": "bundle", "description": "아이템 유형: `virtual_good`/`virtual_currency`/`bundle`." }, "bundle_type": { "type": "string", "example": "virtual_currency_package", "description": "번들 유형입니다. 인게임 재화 패키지의 경우 항상 `virtual_currency_package`입니다." }, "description": { "type": "string", "example": "Crystal Pack Description", "description": "아이템 설명입니다." }, "image_url": { "type": "string", "example": "https://cdn.xsolla.net/items/crystal-pack.png", "description": "이미지 URL입니다." }, "is_free": { "$ref": "#/components/schemas/value-is_free" }, "price": { "type": "object", "description": "아이템 가격입니다.", "properties": { "amount": { "type": "string", "example": "100.99", "description": "할인된 아이템 가격입니다." }, "amount_without_discount": { "type": "string", "example": "100.99", "description": "할인이 없는 아이템 가격입니다. " }, "currency": { "type": "string", "example": "USD", "description": "아이템 가격 통화입니다. [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)에 따른 3자리 코드입니다. [엑솔라에서 지원하는 통화](https://developers.xsolla.com/ko/doc/pay-station/references/supported-currencies/)에 대한 자세한 내용은 설명서를 확인하십시오." } } }, "virtual_prices": { "$ref": "#/components/schemas/client_virtual_prices_response" }, "can_be_bought": { "$ref": "#/components/schemas/Can_be_bought" }, "content": { "type": "array", "example": [ { "description": "Crystal - short description", "image_url": "https://cdn.xsolla.net/items/crystal-pack.png", "sku": "com.xsolla.crystal_1", "name": "Crystals", "type": "virtual_currency", "quantity": 100 } ], "description": "인게임 재화 패키지 콘텐츠입니다.", "items": { "type": "object", "description": "패키지의 인게임 재화입니다.", "properties": { "item_id": { "type": "integer", "description": "엑솔라가 할당한 고유 아이템 ID입니다." }, "sku": { "type": "string", "example": "com.xsolla.crystal_1", "description": "고유한 아이템 ID입니다. SKU는 소문자 및 대문자 라틴 영숫자, 대시 및 밑줄만 포함할 수 있습니다." }, "name": { "type": "string", "example": "Crystals", "description": "아이템 이름입니다." }, "type": { "type": "string", "example": "virtual_currency", "description": "아이템 유형. 인게임 재화의 경우 `virtual_currency`입니다." }, "description": { "type": "string", "example": "Crystals - description", "description": "아이템 설명입니다." }, "image_url": { "type": "string", "example": "https://cdn.xsolla.net/items/crystal-pack.png", "description": "이미지 URL입니다." }, "quantity": { "type": "integer", "example": 250, "description": "패키지의 인게임 재화의 수량입니다." }, "limits": { "$ref": "#/components/schemas/Catalog_item_limits" } } } }, "promotions": { "$ref": "#/components/schemas/Catalog_item_promotions" }, "limits": { "$ref": "#/components/schemas/Catalog_item_limits" }, "periods": { "$ref": "#/components/schemas/item-periods-response" }, "custom_attributes": { "$ref": "#/components/schemas/item-custom-attributes-response" }, "vp_rewards": { "$ref": "#/components/schemas/client-item-value-point-reward" } } }, "Virtual-Items-Currency_virtual-currency-packages": { "type": "object", "properties": { "has_more": { "$ref": "#/components/schemas/Pagination_has-more" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/Virtual-Items-Currency_virtual-currency-package" } } } }, "group-name-localization-object": { "type": [ "object", "null" ], "description": "아이템 설명에 대한 현지화가 있는 개체입니다. 두 글자 소문자 언어 코드(예: `en`) 또는 다섯 글자 로케일 코드(예: `en-US`) 두 가지 형식 중 하나로 되어 있는 값을 허용합니다. 두 형식 모두 입력으로 허용되지만 응답은 두 글자 소문자 언어 코드를 반환합니다. 동일한 언어에 대한 두 옵션(예: `en` 및 `en-US`)이 모두 제공되면 마지막으로 제공된 값이 저장됩니다. 지원되는 언어의 전체 목록은 [문서](/ko/doc/shop-builder/references/supported-languages/)에서 확인할 수 있습니다.", "anyOf": [ { "$ref": "#/components/schemas/two-letter-locale" }, { "$ref": "#/components/schemas/five-letter-locale" } ] }, "group-description-localization-object": { "type": [ "object", "null" ], "description": "아이템 설명에 대한 현지화가 있는 개체입니다. 두 글자 소문자 언어 코드(예: `en`) 또는 다섯 글자 로케일 코드(예: `en-US`) 두 가지 형식 중 하나로 되어 있는 값을 허용합니다. 두 형식 모두 입력으로 허용되지만 응답은 두 글자 소문자 언어 코드를 반환합니다. 동일한 언어에 대한 두 옵션(예: `en` 및 `en-US`)이 모두 제공되면 마지막으로 제공된 값이 저장됩니다. 지원되는 언어의 전체 목록은 [문서](/ko/doc/shop-builder/references/supported-languages/)에서 확인할 수 있습니다.", "anyOf": [ { "$ref": "#/components/schemas/two-letter-locale" }, { "$ref": "#/components/schemas/five-letter-locale" } ] }, "group-image-url": { "type": [ "string", "null" ], "description": "아이템 그룹 이미지의 URL입니다.", "example": "https://example.com/weapons.png" }, "group-display-order": { "type": "integer", "description": "카탈로그 내 아이템 그룹 표시 순서입니다. 값이 클수록 목록에서 해당 그룹이 더 아래쪽에 표시됩니다. 값이 동일한 경우, 그룹이 생성 날짜 순으로 정렬되며, 보다 최근에 생성된 그룹이 더 위쪽에 표시됩니다.", "default": 1, "example": 1 }, "group-is-enabled": { "type": "boolean", "description": "카탈로그에서 해당 아이템 그룹이 활성화되어 있는지 여부입니다.", "example": true, "default": true }, "admin-group-response-base": { "type": "object", "properties": { "id": { "type": "integer", "description": "엑솔라에서 할당한 아이템 그룹 ID입니다.", "example": 1 }, "external_id": { "type": "string", "description": "생성 시 지정된 외부 아이템 그룹 ID입니다.", "example": "weapons" }, "name": { "$ref": "#/components/schemas/group-name-localization-object" }, "description": { "$ref": "#/components/schemas/group-description-localization-object" }, "image_url": { "$ref": "#/components/schemas/group-image-url" }, "order": { "$ref": "#/components/schemas/group-display-order" }, "is_enabled": { "$ref": "#/components/schemas/group-is-enabled" }, "items_count": { "type": "integer", "description": "그룹에 있는 아이템의 총 수량입니다.", "example": 5 } }, "required": [ "id", "external_id", "name", "is_enabled" ] }, "error-response-base": { "type": "object", "properties": { "statusCode": { "type": "integer", "description": "HTTP 응답 상태." }, "errorCode": { "type": "integer", "description": "오류 코드." }, "errorMessage": { "type": "string", "description": "간단한 오류 설명." }, "transactionId": { "type": "string", "description": "요청 ID. 이 특정 요청 또는 작업과 관련된 로그 엔트리를 추적하고 연결하는 데 사용되는 ID입니다. 이 ID는 문제 해결, 디버깅 및 감사 목적으로 유용하게 활용될 수 있습니다." } } }, "admin-group-create-request": { "type": "object", "properties": { "external_id": { "type": "string", "description": "아이템 그룹의 외부 ID입니다. 영문자와 숫자, 하이픈, 밑줄만 사용할 수 있습니다.", "pattern": "^[A-Za-z0-9_\\-]+$", "example": "weapons" }, "name": { "$ref": "#/components/schemas/group-name-localization-object" }, "description": { "$ref": "#/components/schemas/group-description-localization-object" }, "iconUrl": { "$ref": "#/components/schemas/group-image-url" }, "isEnabled": { "allOf": [ { "$ref": "#/components/schemas/group-is-enabled" } ], "default": true }, "order": { "allOf": [ { "$ref": "#/components/schemas/group-display-order" } ] } }, "description": "아이템 그룹 데이터.", "required": [ "external_id", "name" ] }, "error-message-extended-validation": { "type": "array", "description": "유효성 검사 오류 세부 정보. 어떤 필드에서 유효성 검사에 실패했는지와 그 원인을 설명하는 속성 수준 오류 목록을 포함합니다. ", "items": { "type": "object", "properties": { "property": { "type": "string", "description": "유효성 검사에 실패한 입력란의 이름.", "example": "external_id" }, "message": { "type": "string", "description": "해당 필드의 유효성 검사 오류 메시지입니다.", "example": "The property external_id is required" } } } }, "ItemGroup_422-invalid-request": { "type": "object", "required": [ "statusCode", "errorCode", "errorMessage", "transactionId" ], "properties": { "statusCode": { "type": "integer", "description": "HTTP 응답 상태.", "example": 422 }, "errorCode": { "type": "integer", "description": "오류 코드.", "example": 1102 }, "errorMessage": { "type": "string", "description": "간단한 오류 설명.", "example": "[0401-1102]: Unprocessable Entity. The property `property_name` is required" }, "transactionId": { "type": "string", "description": "요청 ID. 이 특정 요청 또는 작업과 관련된 로그 엔트리를 추적하고 연결하는 데 사용되는 ID입니다. 이 ID는 문제 해결, 디버깅 및 감사 목적으로 유용하게 활용될 수 있습니다.", "example": "x-x-x-x-transactionId-mock-x-x-x" }, "errorMessageExtended": { "$ref": "#/components/schemas/error-message-extended-validation" } } }, "admin-group-update-request": { "type": "object", "properties": { "name": { "$ref": "#/components/schemas/group-name-localization-object" }, "description": { "$ref": "#/components/schemas/group-description-localization-object" }, "external_id": { "type": "string", "description": "그룹의 고유한 외부 ID입니다. 영숫자 문자와 숫자, 하이픈, 밑줄만 사용할 수 있습니다. 이 값을 사용하여 그룹의 외부 ID 이름을 변경할 수 있습니다.", "pattern": "^[A-Za-z0-9_\\-]+$", "example": "weapons" }, "iconUrl": { "$ref": "#/components/schemas/group-image-url" }, "isEnabled": { "allOf": [ { "$ref": "#/components/schemas/group-is-enabled" } ] }, "order": { "allOf": [ { "$ref": "#/components/schemas/group-display-order" } ] } }, "description": "업데이트할 아이템 그룹 데이터입니다. 모든 요청에서 `external_id` 및 `name` 입력란은 필수입니다. 그 외 입력란은 선택 사항이며, 생략된 입력란은 현재 값을 유지합니다. ", "required": [ "external_id", "name" ] }, "group-is-contains-any-items": { "type": "boolean", "description": "지정된 `item_type`과 관계없이 해당 그룹에 아이템이 포함되어 있는지 여부입니다. 그룹은 지정된 유형에 대해 `items_count: 0`을 가질 수 있지만, 다른 유형의 항목이 포함되어 있는 경우 `is_contains_any_items`는 `true`가 됩니다.", "example": true }, "admin-group-response-by-item-type": { "allOf": [ { "$ref": "#/components/schemas/admin-group-response-base" }, { "type": "object", "properties": { "is_contains_any_items": { "$ref": "#/components/schemas/group-is-contains-any-items" } } } ] }, "admin-group-detail-response-by-item-type": { "allOf": [ { "$ref": "#/components/schemas/admin-group-response-base" }, { "type": "object", "properties": { "is_contains_any_items": { "$ref": "#/components/schemas/group-is-contains-any-items" } } } ] }, "item-in-group-order-request-item": { "type": "object", "properties": { "item_id": { "type": "integer", "description": "엑솔라에서 할당한 내부 아이템 ID입니다. [아이템 카탈로그 API 호출](/ko/api/catalog/common-catalog) 응답에서 반환된 아이템 ID를 사용하십시오.", "minimum": 0, "example": 101 }, "order": { "type": "integer", "description": "새로운 디스플레이 주문 금액입니다.", "minimum": 0, "example": 1 } }, "required": [ "item_id", "order" ], "additionalProperties": false }, "Cart-Payment_custom_parameters": { "description": "사용자 지정 매개 변수는 키-값 쌍의 유효한 JSON 집합으로 표시됩니다.
\n이 필드를 통해 추가 매개 변수를 전달하여 부정 결제 방지 필터를 구성할 수 있습니다. [페이 스테이션 설명서를 참조해주세요](https://developers.xsolla.com/ko/doc/pay-station/features/antifraud/).", "type": [ "object", "null" ], "minProperties": 1, "maxProperties": 200, "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "boolean" }, { "type": "array" }, { "type": "object" } ] }, "example": { "custom_parameters": { "string_param": "example", "bool_param": true, "int_param": 100, "null_param": null } } }, "Game-Keys_schemas-client-attributes": { "type": "array", "description": "아이템에 해당하는 특성 및 해당 값의 목록입니다. 카탈로그 필터링에 사용할 수 있습니다.", "example": { "value": { "external_id": "genre", "name": "Жанр", "values": [ { "external_id": "genre_e3364991f92e751689a68b96598a5a5a84010b85", "value": "Casual" }, { "external_id": "genre_eba07bfd0f982940773cba3744d97264dd58acd7", "value": "Strategy" }, { "external_id": "genre_b8d0c6d8f0524c2b2d79ebb93aa3cd0e8b5199a8", "value": "Mobile" } ] } }, "default": [], "items": { "type": "object", "properties": { "external_id": { "$ref": "#/components/schemas/admin-attribute-external_id" }, "name": { "type": "string", "description": "특성의 이름입니다.", "example": "Genre" }, "values": { "type": "array", "items": { "type": "object", "properties": { "external_id": { "$ref": "#/components/schemas/value-external_id" }, "value": { "type": "string", "description": "특성의 값입니다.", "example": "Strategy" } } } } } } }, "Game-Keys_admin-attributes": { "type": "array", "description": "특성 목록입니다.", "items": { "$ref": "#/components/schemas/attribute" } }, "Game-Keys_regions": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "example": 1 } } } }, "Game-Keys_admin-post-put-attributes": { "type": "array", "maxItems": 20, "description": "특성 목록입니다.\n\n
주의. 아이템에 20개 이상의 특성을 지정할 수 없습니다. 제한을 초과하려고 하면 오류가 발생합니다.
", "items": { "$ref": "#/components/schemas/admin-post-put-attribute-item" } }, "game_key_recurrent_schedule": { "type": [ "object", "null" ], "description": "새로고침 기간을 제한합니다.", "properties": { "per_user": { "oneOf": [ { "$ref": "#/components/schemas/per_user_daily" }, { "$ref": "#/components/schemas/per_user_weekly" }, { "$ref": "#/components/schemas/per_user_monthly" } ] } } }, "Game-key-item-limit": { "type": "object", "description": "아이템 제한 사항입니다.", "properties": { "per_user": { "$ref": "#/components/schemas/limit_per_user" }, "per_item": { "$ref": "#/components/schemas/limit_per_item" }, "recurrent_schedule": { "$ref": "#/components/schemas/game_key_recurrent_schedule" } } }, "Game-Keys_422-invalid-request": { "type": "object", "properties": { "statusCode": { "type": "integer", "example": 422 }, "errorCode": { "type": "integer", "example": 1102 }, "errorMessage": { "type": "string", "example": "[0401-1102]: Unprocessable Entity. The property `property_name` is required" }, "transactionId": { "type": "string", "example": "x-x-x-x-transactionId-mock-x-x-x" } } }, "Pagination_total-items-count": { "type": "integer", "example": 10, "description": "시스템에 있는 아이템의 총 수량입니다." }, "Game-Keys_client_name": { "type": "string", "example": "The Greatest Game in the World", "description": "게임 패키지 이름입니다." }, "Game-Keys_description": { "type": "string", "example": "Description of the greatest game in the world.", "description": "게임 패키지 설명입니다." }, "Game-Keys_project_id": { "type": "integer", "example": 44056, "description": "프로젝트 ID입니다. 이 매개 변수는 [관리자 페이지](https://publisher.xsolla.com/)의 프로젝트 이름 옆에서 확인할 수 있습니다." }, "Game-Keys_game_sku": { "type": "string", "minLength": 1, "maxLength": 255, "pattern": "^[a-zA-Z0-9_\\-–.]*$", "example": "theGreatestGameSku", "description": "고유 키 패키지 ID입니다." }, "Game-Keys_drm_sku": { "type": "string", "example": "steam", "description": "고유 DRM ID입니다.", "enum": [ "steam", "playstation", "xbox", "uplay", "origin", "drmfree", "gog", "epicgames", "nintendo_eshop", "discord_game_store", "oculus", "rockstar", "viveport", "stadia" ] }, "Game-Keys_image_url": { "type": "string", "example": "https://image.example.com", "description": "이미지 URL. 결제 UI에서 이미지가 올바르게 표시되고 빠르게 로드되도록 하려면 다음 이미지 및 URL 가이드라인을 확인하세요:
  • 지원되는 형식: WebP(권장), PNG, JPG.
  • 파일 크기: 50KB 이하(WebP의 경우) 또는 150KB 이하(PNG 및 JPG의 경우).
  • 이미지 크기: 280 x 280 픽셀.
  • 색 공간: sRGB.
  • 프로토콜: 버전 관리된 URL에 대해 장기 캐싱이 적용된 HTTPS.
" }, "Game-Keys_admin-attribute-external_id": { "type": "string", "minLength": 1, "maxLength": 255, "pattern": "^[a-zA-Z0-9-_]+$", "example": "attribute_1", "description": "고유 특성 ID입니다. `external_id`는 소문자 및 대문자 라틴 영숫자, 대시 및 밑줄만 포함할 수 있습니다." }, "Game-Keys_value-external_id": { "type": "string", "minLength": 1, "maxLength": 255, "pattern": "^[-_.\\d\\w]+$", "example": "attribute_value", "description": "특성의 고유한 값 ID입니다. `external_id`에는 소문자 라틴어 영숫자, 대시, 밑줄만 사용할 수 있습니다." }, "Game-Keys_client-attributes": { "type": "array", "description": "게임에 해당하는 특성과 값의 목록입니다.\n\n
주의. 응답의 이 부분은 `additional_fields[]=attributes` 쿼리 매개 변수를 보내는 경우에만 사용할 수 있습니다.
", "example": { "value": { "external_id": "genre", "name": "Жанр", "values": [ { "external_id": "genre_e3364991f92e751689a68b96598a5a5a84010b85", "value": "Casual" }, { "external_id": "genre_eba07bfd0f982940773cba3744d97264dd58acd7", "value": "Strategy" }, { "external_id": "genre_b8d0c6d8f0524c2b2d79ebb93aa3cd0e8b5199a8", "value": "Mobile" } ] } }, "default": [], "items": { "type": "object", "properties": { "external_id": { "$ref": "#/components/schemas/Game-Keys_admin-attribute-external_id" }, "name": { "type": "string", "description": "특성의 이름입니다.", "example": "Genre" }, "values": { "type": "array", "items": { "type": "object", "properties": { "external_id": { "$ref": "#/components/schemas/Game-Keys_value-external_id" }, "value": { "type": "string", "description": "특성의 값입니다.", "example": "Strategy" } } } } } } }, "Game-Keys_entitlement_item": { "type": "object", "properties": { "name": { "$ref": "#/components/schemas/Game-Keys_client_name" }, "description": { "$ref": "#/components/schemas/Game-Keys_description" }, "project_id": { "$ref": "#/components/schemas/Game-Keys_project_id" }, "game_sku": { "$ref": "#/components/schemas/Game-Keys_game_sku" }, "drm": { "$ref": "#/components/schemas/Game-Keys_drm_sku" }, "image_url": { "$ref": "#/components/schemas/Game-Keys_image_url" }, "is_pre_order": { "type": "boolean", "example": false, "description": "게임이 사전 판매 상태인지 여부입니다." }, "attributes": { "$ref": "#/components/schemas/Game-Keys_client-attributes" } } }, "Bundles_item_id": { "type": "integer", "example": 1, "minLength": 1, "maxLength": 255, "description": "내부 고유 아이템 ID입니다." }, "Bundles_sku": { "type": "string", "example": "bundle_1", "minLength": 1, "maxLength": 255, "pattern": "^[a-zA-Z0-9_\\-–.]*$", "description": "고유 아이템 ID입니다. SKU는 소문자 및 대문자 라틴 영숫자, 마침표, 대시 및 밑줄만 포함할 수 있습니다." }, "Bundles_admin-attributes": { "type": "array", "description": "특성 목록입니다.", "items": { "$ref": "#/components/schemas/attribute" } }, "Bundles_type": { "type": "string", "example": "bundle", "description": "아이템 유형입니다." }, "bundle_type": { "type": "string", "description": "번들 유형입니다. 아이템 유형이 번들인 경우 반환됩니다.", "enum": [ "standard", "virtual_currency_package", "partner_side_content" ] }, "Bundles_image_url": { "type": [ "string", "null" ], "example": "https://image.example.com", "description": "이미지 URL. 결제 UI에서 이미지가 올바르게 표시되고 빠르게 로드되도록 하려면 다음 이미지 및 URL 가이드라인을 확인하세요:
  • 지원되는 형식: WebP(권장), PNG, JPG.
  • 파일 크기: 50KB 이하(WebP의 경우) 또는 150KB 이하(PNG 및 JPG의 경우).
  • 이미지 크기: 280 x 280 픽셀.
  • 색 공간: sRGB.
  • 프로토콜: 버전 관리된 URL에 대해 장기 캐싱이 적용된 HTTPS.
" }, "Bundles_groups_response": { "type": "array", "example": [ { "external_id": "horror", "name": { "en": "Horror" } } ], "default": [], "description": "아이템이 속한 그룹입니다.", "items": { "type": "object", "properties": { "external_id": { "type": "string", "example": "horror" }, "name": { "type": "object", "description": "아이템의 이름입니다. 키가 \"^[a-z]{2}\" 형식의 로케일인\n키/값 쌍을 포함해야 하며 값은 문자열입니다.", "example": { "en": "Horror", "de": "Horror" }, "default": { "en": "Horror" }, "additionalProperties": { "type": "string" } } } } }, "Bundles_amount_without_discount": { "type": "string", "example": "100.99", "description": "아이템 가격입니다.", "pattern": "^\\d*\\.?\\d*$" }, "Bundles_currency": { "type": "string", "example": "USD", "description": "아이템 가격 통화입니다. [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)에 따른 3자리 코드입니다." }, "Bundles_prices": { "type": "array", "description": "실제 통화 가격입니다.", "items": { "type": "object", "properties": { "amount": { "$ref": "#/components/schemas/Bundles_amount_without_discount" }, "currency": { "$ref": "#/components/schemas/Bundles_currency" }, "is_default": { "type": "boolean", "description": "기본 가격은 사용자 통화로 가격을 지정하지 않은 경우 카탈로그를 작성하는 데 사용됩니다." }, "is_enabled": { "type": "boolean", "description": "가격이 활성화됩니다." }, "country_iso": { "type": [ "string", "null" ], "example": "US", "description": "이 가격을 사용할 수 있는 국가입니다. [ISO 3166-1 alpha 2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)에 따른 2자리 글자 코드입니다." } }, "required": [ "amount", "currency", "is_default", "is_enabled" ] } }, "Bundles_vc-type": { "type": "string", "example": "virtual_currency", "description": "인게임 재화 유형입니다." }, "Bundles_amount": { "type": "string", "example": "100.99", "description": "할인된 아이템 가격입니다.", "pattern": "^\\d*\\.?\\d*$" }, "Bundles_currency-is_default": { "type": "boolean", "example": true, "description": "아이템의 가격이 기본값인지 여부입니다." }, "Bundles_admin-response-virtual_price": { "type": "object", "properties": { "sku": { "$ref": "#/components/schemas/Bundles_sku" }, "name": { "$ref": "#/components/schemas/name-localization-object" }, "type": { "$ref": "#/components/schemas/Bundles_vc-type" }, "description": { "$ref": "#/components/schemas/description-localization-object" }, "image_url": { "$ref": "#/components/schemas/Bundles_image_url" }, "amount": { "$ref": "#/components/schemas/Bundles_amount" }, "is_default": { "$ref": "#/components/schemas/Bundles_currency-is_default" } } }, "Bundles_media_list": { "type": "array", "example": [ { "type": "image", "url": "https://cdn3.xsolla.com/img/misc/images/71ab1e12126f2103e1868076f0acb21a.jpg" } ], "description": "번들의 추가 자산입니다.", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "image", "video" ], "example": "image", "description": "미디어 유형: `image`/`video`." }, "url": { "type": "string", "example": "https://cdn3.xsolla.com/img/misc/images/71ab1e12126f2103e1868076f0acb21a.jpg", "description": "리소스 파일입니다." } } } }, "Bundles_order": { "type": "integer", "example": 1, "default": 1, "description": "목록에서 번들의 주문 우선 순위입니다." }, "Bundles_is_enabled": { "type": "boolean", "example": true, "default": true, "description": "비활성화된 경우 아이템을 검색하거나 구매할 수 없습니다." }, "Bundles_is_show_in_store": { "type": "boolean", "example": true, "default": false, "description": "아이템을 구매할 수 있는 상태입니다." }, "Bundles_admin-regions": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "minimum": 1, "example": 1 } } } }, "Bundles_admin_content_response": { "type": "object", "properties": { "sku": { "$ref": "#/components/schemas/Bundles_sku" }, "name": { "$ref": "#/components/schemas/name-localization-object" }, "type": { "$ref": "#/components/schemas/Bundles_type" }, "description": { "$ref": "#/components/schemas/description-localization-object" }, "image_url": { "$ref": "#/components/schemas/Bundles_image_url" }, "quantity": { "type": "integer", "description": "번들에 있는 아이템 유형의 수량입니다.", "default": 1, "minimum": 1 } } }, "Bundles_total_content_price": { "type": [ "object", "null" ], "description": "번들 콘텐츠 가격의 합계입니다.", "properties": { "amount": { "type": "string", "example": "100.99", "description": "할인이 적용된 번들 콘텐츠 가격의 합계입니다." }, "amount_without_discount": { "type": "string", "example": "100.99", "description": "번들 콘텐츠 가격의 합계입니다." }, "currency": { "$ref": "#/components/schemas/Bundles_currency" } } }, "Bundles_admin_bundle_response": { "type": "object", "properties": { "item_id": { "$ref": "#/components/schemas/Bundles_item_id" }, "sku": { "$ref": "#/components/schemas/Bundles_sku" }, "name": { "$ref": "#/components/schemas/name-localization-object" }, "attributes": { "$ref": "#/components/schemas/Bundles_admin-attributes" }, "type": { "$ref": "#/components/schemas/Bundles_type" }, "bundle_type": { "$ref": "#/components/schemas/bundle_type" }, "description": { "$ref": "#/components/schemas/description-localization-object" }, "long_description": { "$ref": "#/components/schemas/long-description-localization-object" }, "image_url": { "$ref": "#/components/schemas/Bundles_image_url" }, "is_free": { "$ref": "#/components/schemas/value-is_free" }, "is_paid_randomized_reward": { "$ref": "#/components/schemas/value-is_paid_randomized_reward" }, "groups": { "$ref": "#/components/schemas/Bundles_groups_response" }, "prices": { "$ref": "#/components/schemas/Bundles_prices" }, "virtual_prices": { "type": "array", "items": { "$ref": "#/components/schemas/Bundles_admin-response-virtual_price" } }, "media_list": { "anyOf": [ { "$ref": "#/components/schemas/Bundles_media_list" }, { "type": "null" } ] }, "order": { "$ref": "#/components/schemas/Bundles_order" }, "is_enabled": { "$ref": "#/components/schemas/Bundles_is_enabled" }, "is_show_in_store": { "$ref": "#/components/schemas/Bundles_is_show_in_store" }, "regions": { "$ref": "#/components/schemas/Bundles_admin-regions" }, "content": { "type": "array", "items": { "$ref": "#/components/schemas/Bundles_admin_content_response" } }, "limits": { "$ref": "#/components/schemas/admin-item-limit-response" }, "periods": { "$ref": "#/components/schemas/item-periods-response" }, "custom_attributes": { "$ref": "#/components/schemas/item-custom-attributes-response" }, "total_content_price": { "$ref": "#/components/schemas/Bundles_total_content_price" } }, "description": "지정한 번들입니다." }, "Bundles_groups_request": { "type": "array", "example": [ "honor" ], "default": [], "description": "아이템이 속한 그룹입니다.\n\n
메모. 문자열 값은 그룹 `external_id`을 참조합니다.
", "items": { "type": "string" } }, "Bundles_admin-post-put-attributes": { "type": "array", "maxItems": 20, "description": "특성 목록입니다.\n\n
주의. 아이템에 20개 이상의 특성을 지정할 수 없습니다. 제한을 초과하려고 하면 오류가 발생합니다.
", "items": { "$ref": "#/components/schemas/admin-post-put-attribute-item" } }, "Bundles_vc_prices": { "type": "array", "items": { "type": "object", "properties": { "sku": { "type": "string", "example": "gold", "description": "고유 아이템 ID입니다. SKU는 소문자 및 대문자 라틴 영숫자, 마침표, 대시 및 밑줄만 포함할 수 있습니다." }, "amount": { "type": "integer" }, "is_default": { "type": "boolean" }, "is_enabled": { "type": "boolean" } }, "required": [ "amount", "currency", "is_default", "is_enabled" ] } }, "Bundles_bundle_type": { "type": "string", "example": "standard", "enum": [ "standard", "partner_side_content" ], "description": "번들 유형입니다. `standard`를 사용하여 아이템이 포함된 번들을 생성하고 번들에 포함된 아이템의 SKU를 지정합니다.\n`partner_side_content`를 사용하여 빈 번들을 생성하고 [웹훅](https://developers.xsolla.com/ko/webhooks/operation/personalized-partner-catalog/)을 사용하여 직접 아이템을 추가합니다. 이 유형은 [파트너 측의 카탈로그 개인 설정](https://developers.xsolla.com/ko/doc/shop-builder/features/personalization/#guides_personalization_on_partner_side)에만 사용됩니다.", "default": "standard" }, "Bundles_admin_content_request": { "type": "array", "minItems": 1, "description": "번들에 포함된 아이템 배열입니다. 각 항목은 아이템 SKU와 수량을 지정합니다. 모든 아이템은 프로젝트에 미리 생성되어 있어야 합니다. 지정한 SKU가 존재하지 않으면 시스템에서 오류를 반환합니다.", "items": { "type": "object", "properties": { "sku": { "type": "string", "minLength": 1, "maxLength": 255, "pattern": "^[a-zA-Z0-9_\\-–.]*$", "example": "com.xsolla.kg_1", "description": "번들에 포함할 아이템의 SKU입니다. 해당 아이템은 프로젝트에 미리 생성되어 있어야 합니다. 지정한 SKU가 존재하지 않으면 시스템에서 오류를 반환합니다. 허용되는 문자: a–z, A–Z, 0–9, 마침표(.), 하이픈(-), 밑줄(_)." }, "quantity": { "type": "integer", "description": "번들에서 선택한 아이템의 수량입니다.", "default": 1, "minimum": 1 } }, "required": [ "sku" ], "example": { "sku": "com.xsolla.kg_1", "quantity": 1 } } }, "per_user_hourly_bundle": { "type": "object", "title": "interval_type = 시간", "properties": { "interval_type": { "$ref": "#/components/schemas/interval_type_hourly" }, "hours_interval": { "allOf": [ { "$ref": "#/components/schemas/hours_interval" }, { "description": "한도가 재설정되는 시간 간격(시간).

카운트다운은 date_from 매개 변수에서 시작됩니다.

예를 들어, `date_start = \"2025-11-15T18:15:00+05:00\"`이고 `hours_interval = 2`인 경우, 이 아이템의 구매 한도는 `\"2025-11-15T20:15:00+05:00\"`부터 2시간마다 재설정됩니다." } ] } }, "required": [ "interval_type", "hours_interval" ] }, "bundle_recurrent_schedule": { "type": [ "object", "null" ], "description": "새로고침 기간을 제한합니다.", "properties": { "per_user": { "description": "지정된 시간 간격(시간 단위)마다 구매 한도가 재설정됩니다.", "oneOf": [ { "$ref": "#/components/schemas/per_user_daily" }, { "$ref": "#/components/schemas/per_user_weekly" }, { "$ref": "#/components/schemas/per_user_monthly" }, { "$ref": "#/components/schemas/per_user_hourly_bundle" } ] } } }, "bundle-item-limit": { "type": "object", "description": "아이템 제한 사항입니다.", "properties": { "per_user": { "$ref": "#/components/schemas/limit_per_user" }, "per_item": { "$ref": "#/components/schemas/limit_per_item" }, "recurrent_schedule": { "$ref": "#/components/schemas/bundle_recurrent_schedule" } } }, "Bundles_admin_bundle_request": { "type": "object", "properties": { "sku": { "$ref": "#/components/schemas/Bundles_sku" }, "name": { "$ref": "#/components/schemas/name-localization-object" }, "groups": { "$ref": "#/components/schemas/Bundles_groups_request" }, "attributes": { "$ref": "#/components/schemas/Bundles_admin-post-put-attributes" }, "description": { "$ref": "#/components/schemas/description-localization-object" }, "long_description": { "$ref": "#/components/schemas/long-description-localization-object" }, "image_url": { "$ref": "#/components/schemas/Bundles_image_url" }, "prices": { "$ref": "#/components/schemas/Bundles_prices" }, "vc_prices": { "anyOf": [ { "$ref": "#/components/schemas/Bundles_vc_prices" }, { "type": "null" } ] }, "bundle_type": { "$ref": "#/components/schemas/Bundles_bundle_type" }, "content": { "$ref": "#/components/schemas/Bundles_admin_content_request" }, "is_free": { "$ref": "#/components/schemas/value-is_free" }, "is_paid_randomized_reward": { "$ref": "#/components/schemas/value-is_paid_randomized_reward" }, "is_enabled": { "$ref": "#/components/schemas/Bundles_is_enabled" }, "is_show_in_store": { "$ref": "#/components/schemas/Bundles_is_show_in_store" }, "media_list": { "anyOf": [ { "$ref": "#/components/schemas/Bundles_media_list" }, { "type": "null" } ] }, "order": { "$ref": "#/components/schemas/Bundles_order" }, "regions": { "$ref": "#/components/schemas/Bundles_admin-regions" }, "limits": { "$ref": "#/components/schemas/bundle-item-limit" }, "periods": { "$ref": "#/components/schemas/item-periods" }, "custom_attributes": { "$ref": "#/components/schemas/item-custom-attributes" } }, "description": "지정한 번들입니다.", "required": [ "sku", "name", "description" ] }, "Bundles_422-invalid-request": { "type": "object", "properties": { "statusCode": { "type": "integer", "example": 422 }, "errorCode": { "type": "integer", "example": 1102 }, "errorMessage": { "type": "string", "example": "[0401-1102]: Unprocessable Entity. The property `property_name` is required" }, "transactionId": { "type": "string", "example": "x-x-x-x-transactionId-mock-x-x-x" }, "errorMessageExtended": { "type": "array" } } }, "Bundles_client_name": { "type": "string", "example": "Big Rocket", "description": "아이템 이름입니다." }, "Bundles_client_description": { "type": [ "string", "null" ], "example": "Big Rocket - description.", "description": "아이템 설명입니다." }, "Bundles_client-attributes": { "type": "array", "description": "아이템에 해당하는 특성 및 해당 값의 목록입니다. 카탈로그 필터링에 사용할 수 있습니다.", "example": { "value": { "external_id": "genre", "name": "Жанр", "values": [ { "external_id": "genre_e3364991f92e751689a68b96598a5a5a84010b85", "value": "Casual" }, { "external_id": "genre_eba07bfd0f982940773cba3744d97264dd58acd7", "value": "Strategy" }, { "external_id": "genre_b8d0c6d8f0524c2b2d79ebb93aa3cd0e8b5199a8", "value": "Mobile" } ] } }, "default": [], "items": { "type": "object", "properties": { "external_id": { "$ref": "#/components/schemas/admin-attribute-external_id" }, "name": { "type": "string", "description": "특성의 이름입니다.", "example": "Genre" }, "values": { "type": "array", "items": { "type": "object", "properties": { "external_id": { "$ref": "#/components/schemas/value-external_id" }, "value": { "type": "string", "description": "특성의 값입니다.", "example": "Strategy" } } } } } } }, "Bundles_price": { "type": [ "object", "null" ], "description": "아이템 가격입니다.", "required": [ "amount", "amount_without_discount", "currency" ], "properties": { "amount": { "$ref": "#/components/schemas/Bundles_amount" }, "amount_without_discount": { "$ref": "#/components/schemas/Bundles_amount_without_discount" }, "currency": { "$ref": "#/components/schemas/Bundles_currency" } } }, "Catalog_item_limits_with_hourly": { "description": "아이템 제한 사항입니다.", "properties": { "per_user": { "type": [ "object", "null" ], "description": "사용자 한 명에 대한 아이템 제한 사항입니다.", "properties": { "total": { "type": "integer", "description": "사용자 한 명이 구매할 수 있는 최대 아이템 수량입니다.", "example": 5 }, "available": { "type": "integer", "description": "현재 사용자가 구매할 수 있는 남은 아이템 수량.", "example": 3 }, "recurrent_schedule": { "$ref": "#/components/schemas/catalog_recurrent_schedule_client_response" }, "limit_exceeded_visibility": { "$ref": "#/components/schemas/limit_exceeded_visibility" } } }, "per_item": { "type": [ "object", "null" ], "description": "한 개 아이템에 대한 아이템 제한 사항입니다.", "properties": { "total": { "type": "integer", "description": "모든 사용자가 구매할 수 있는 최대 아이템 수량.", "example": 5 }, "available": { "type": "integer", "description": "모든 사용자가 구매할 수 있는 남은 아이템 수량.", "example": 3 } } } }, "type": [ "object", "null" ] }, "Bundles_client_content": { "type": "array", "example": [ { "description": "Big Rocket - short description.", "image_url": "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png", "sku": "com.xsolla.big_rocket_1", "name": "Big Rocket", "type": "virtual_currency", "quantity": 100, "attributes": [], "is_free": false, "groups": [], "price": { "amount": "10.99", "currency": "USD", "amount_without_discount": "10.99" } } ], "description": "번들 패키지 콘텐츠입니다.", "items": { "type": "object", "description": "패키지에 있는 아이템입니다.", "properties": { "sku": { "type": "string", "example": "com.xsolla.big_rocket_1", "description": "고유한 아이템 ID입니다. SKU는 소문자 및 대문자 라틴 영숫자, 대시 및 밑줄만 포함할 수 있습니다." }, "name": { "type": "string", "example": "Big Rocket", "description": "아이템 이름입니다." }, "type": { "type": "string", "example": "virtual_currency", "description": "아이템 유형: `virtual_good`/`virtual_currency`/`bundle`." }, "description": { "type": "string", "example": "Big Rocket - description", "description": "아이템 설명입니다." }, "image_url": { "type": "string", "example": "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png", "description": "이미지 URL입니다." }, "quantity": { "type": "integer", "example": 250, "description": "패키지에 있는 아이템의 수량입니다." }, "virtual_item_type": { "type": "string", "example": "non-consumable", "description": "가상 아이템의 유형입니다.\n\n사용 가능한 값: - `consumable` - 사용 후 인벤토리에서 사라지는 아이템(예: 탄약). - `non_consumable` - 인벤토리에 무기한으로 남아 있는 아이템. - `non_renewing_subscription` - 일정 기간 동안 서비스나 콘텐츠에 대한 이용 권한을 나타낼 수 있는 기간 한정 아이템.", "enum": [ "consumable", "non_consumable", "non_renewing_subscription" ] }, "attributes": { "$ref": "#/components/schemas/Bundles_client-attributes" }, "price": { "type": [ "object", "null" ], "description": "아이템 가격입니다.", "properties": { "amount": { "type": "string", "example": "100.99", "description": "할인된 아이템 가격입니다." }, "amount_without_discount": { "type": "string", "example": "100.99", "description": "아이템 가격입니다." }, "currency": { "type": "string", "example": "USD", "description": "아이템 가격 통화입니다. [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)에 따른 3자리 코드입니다. [엑솔라에서 지원하는 통화](https://developers.xsolla.com/ko/doc/pay-station/references/supported-currencies/)에 대한 자세한 내용은 설명서를 확인하십시오." } } }, "virtual_prices": { "$ref": "#/components/schemas/client_virtual_prices_response" }, "limits": { "$ref": "#/components/schemas/Catalog_item_limits_with_hourly" }, "is_free": { "$ref": "#/components/schemas/value-is_free" }, "groups": { "$ref": "#/components/schemas/Bundles_groups_response" } } } }, "Bundles_client_bundle": { "type": "object", "properties": { "item_id": { "$ref": "#/components/schemas/Bundles_item_id" }, "sku": { "$ref": "#/components/schemas/Bundles_sku" }, "name": { "$ref": "#/components/schemas/Bundles_client_name" }, "groups": { "$ref": "#/components/schemas/items_client_groups_response" }, "description": { "$ref": "#/components/schemas/Bundles_client_description" }, "long_description": { "$ref": "#/components/schemas/long-description-localization-object" }, "attributes": { "$ref": "#/components/schemas/Bundles_client-attributes" }, "type": { "$ref": "#/components/schemas/Bundles_type" }, "bundle_type": { "$ref": "#/components/schemas/Bundles_bundle_type" }, "image_url": { "$ref": "#/components/schemas/Bundles_image_url" }, "is_free": { "$ref": "#/components/schemas/value-is_free" }, "price": { "$ref": "#/components/schemas/Bundles_price" }, "total_content_price": { "$ref": "#/components/schemas/Bundles_total_content_price" }, "virtual_prices": { "$ref": "#/components/schemas/client_virtual_prices_response" }, "can_be_bought": { "$ref": "#/components/schemas/Can_be_bought" }, "content": { "$ref": "#/components/schemas/Bundles_client_content" }, "promotions": { "$ref": "#/components/schemas/Catalog_item_promotions" }, "limits": { "$ref": "#/components/schemas/Catalog_item_limits_with_hourly" }, "periods": { "$ref": "#/components/schemas/item-periods" }, "custom_attributes": { "$ref": "#/components/schemas/item-custom-attributes-response" }, "vp_rewards": { "$ref": "#/components/schemas/client-item-value-point-reward" }, "order": { "$ref": "#/components/schemas/Bundles_order" }, "media_list": { "$ref": "#/components/schemas/Bundles_media_list" } }, "description": "지정한 번들입니다." }, "value-cart_is_free": { "type": "boolean", "example": false, "default": false, "description": "`true`이면 장바구니는 무료입니다." }, "Cart-Payment_client-attributes": { "type": "array", "description": "아이템에 해당하는 특성 및 해당 값의 목록입니다. 카탈로그 필터링에 사용할 수 있습니다.", "example": { "value": { "external_id": "genre", "name": "Жанр", "values": [ { "external_id": "genre_e3364991f92e751689a68b96598a5a5a84010b85", "value": "Casual" }, { "external_id": "genre_eba07bfd0f982940773cba3744d97264dd58acd7", "value": "Strategy" }, { "external_id": "genre_b8d0c6d8f0524c2b2d79ebb93aa3cd0e8b5199a8", "value": "Mobile" } ] } }, "default": [], "items": { "type": "object", "properties": { "external_id": { "$ref": "#/components/schemas/admin-attribute-external_id" }, "name": { "type": "string", "description": "특성의 이름입니다.", "example": "Genre" }, "values": { "type": "array", "items": { "type": "object", "properties": { "external_id": { "$ref": "#/components/schemas/value-external_id" }, "value": { "type": "string", "description": "특성의 값입니다.", "example": "Strategy" } } } } } } }, "Catalog_cart_promotions": { "type": "array", "description": "전체 장바구니에 적용된 프로모션. 다음의 경우 배열이 반환됩니다.\n\n* **구매 시 할인 설정** 프로모션 코드와 같이 프로모션이 전체 장바구니 금액에 영향을 미치는 경우\n\n* 장바구니에 보너스 아이템을 추가하는 프로모션의 경우\n\n적용되는 주문 수준 프로모션이 없는 경우 빈 배열이 반환됩니다.", "items": { "type": "object", "properties": { "name": { "type": "string" }, "date_start": { "type": [ "string", "null" ], "format": "date-time" }, "date_end": { "type": [ "string", "null" ], "format": "date-time" }, "discount": { "type": [ "object", "null" ], "properties": { "percent": { "type": [ "string", "null" ] }, "value": { "type": [ "string", "null" ] } } }, "bonus": { "type": "array", "items": { "type": "object", "properties": { "sku": { "type": "string" }, "quantity": { "type": "integer" }, "type": { "type": "string", "description": "보너스 아이템 유형입니다.", "enum": [ "virtual_good", "virtual_currency", "bundle", "physical_good", "game_key", "nft" ] }, "name": { "type": "string", "description": "보너스 아이템 이름입니다. `physical_good` 보너스 아이템 유형에는 사용할 수 없습니다." }, "image_url": { "type": "string", "description": "보너스 아이템 이미지 URL입니다. `physical_good` 보너스 아이템 유형에는 사용할 수 없습니다." }, "bundle_type": { "type": "string", "description": "보너스 번들 아이템 유형입니다. `bundle` 보너스 아이템 유형에서만 사용할 수 있습니다.", "enum": [ "standard", "virtual_currency_package" ] } } } }, "limits": { "type": "object", "properties": { "per_user": { "type": "object", "properties": { "available": { "type": "integer" }, "total": { "type": "integer" } } } } } } } }, "Cart-Payment_settings_ui": { "description": "인터페이스 설정입니다.", "type": "object", "additionalProperties": false, "properties": { "theme": { "description": "결제 UI 테마. 라이트 테마(기본값)의 경우 `63295a9a2e47fab76f7708e1`, 다크 테마의 경우 `63295aab2e47fab76f7708e3`일 수 있습니다. [사용자 정의 테마를 생성](https://developers.xsolla.com/ko/doc/pay-station/features/ui-theme-customization/#pay_station_ui_theme_customization_in_token)하고 이 매개 변수의 해당 ID를 전달할 수도 있습니다.", "type": "string", "default": "63295a9a2e47fab76f7708e1", "enum": [ "63295a9a2e47fab76f7708e1", "63295aab2e47fab76f7708e3" ] }, "desktop": { "type": "object", "additionalProperties": false, "description": "데스크톱 버전용 인터페이스 설정입니다.", "properties": { "header": { "type": "object", "additionalProperties": false, "description": "헤더 설정입니다.", "properties": { "is_visible": { "type": "boolean", "description": "결제 UI에 헤더를 표시할지 여부입니다." }, "visible_logo": { "type": "boolean", "description": "`true`인 경우, 헤더에 로고가 표시됩니다. 이미지를 업로드하려면 [관리자 페이지](https://publisher.xsolla.com/)에서 프로젝트를 열고 페이 스테이션 > 설정 섹션으로 이동하십시오." }, "visible_name": { "type": "boolean", "description": "프로젝트 이름을 헤더에 표시할지 여부를 나타냅니다." }, "visible_purchase": { "type": "boolean", "description": "헤더에 구매 설명(`purchase.description.value`)을 표시할지 여부입니다. 기본값은 `true`입니다.", "default": true }, "type": { "type": "string", "description": "헤더를 표시하는 방식입니다. `compact`(프로젝트 이름 및 사용자 ID 표시 안 함) 또는 `normal`(기본값)일 수 있습니다.", "default": "normal", "enum": [ "compact", "normal" ] }, "close_button": { "type": "boolean", "description": "데스크톱 결제 UI에 **닫기** 버튼을 표시할지 여부입니다. 이 버튼은 결제 UI를 닫고 사용자를 `settings.return_url` 매개 변수에 지정된 URL로 리디렉션합니다. 기본적으로 `false`로 설정되어 있습니다.", "default": false } } } } }, "mode": { "type": "string", "enum": [ "user_account" ], "description": "결제 UI의 인터페이스 모드. `user_account`만 가능합니다. 헤더에는 계정 탐색 메뉴만 포함되며 사용자는 제품을 선택하거나 결제할 수 없습니다. 이 모드는 데스크톱에서만 사용할 수 있습니다." }, "user_account": { "type": "object", "additionalProperties": false, "description": "사용자 계정 세부 정보입니다.", "properties": { "payment_accounts": { "type": "object", "additionalProperties": false, "description": "**내 결제 계정**의 하위 메뉴입니다.", "properties": { "enable": { "type": "boolean", "default": false, "description": "하위 메뉴를 표시할지 여부입니다. 기본값은 `false`입니다." } }, "required": [ "enable" ] }, "info": { "type": "object", "additionalProperties": false, "description": "**내 계정** 페이지입니다.", "properties": { "enable": { "type": "boolean", "default": false, "description": "하위 메뉴를 표시할지 여부입니다. 기본값은 `false`입니다." }, "order": { "type": "integer", "minimum": 1, "description": "메뉴에서 하위 메뉴의 위치입니다." } }, "required": [ "enable", "order" ] }, "subscriptions": { "type": "object", "additionalProperties": false, "description": "**구독 관리**의 하위 메뉴입니다.", "properties": { "enable": { "type": "boolean", "default": false, "description": "하위 메뉴를 표시할지 여부입니다. 기본값은 `false`입니다." }, "order": { "type": "integer", "minimum": 1, "description": "메뉴에서 하위 메뉴의 위치입니다." } }, "required": [ "enable", "order" ] } } }, "header": { "type": "object", "properties": { "visible_virtual_currency_balance": { "type": "boolean", "additionalProperties": false, "description": "결제 UI에서 이 요소를 숨길 수 있는지 여부입니다.", "default": true } } }, "mobile": { "type": "object", "properties": { "header": { "type": "object", "additionalProperties": false, "properties": { "close_button": { "type": "boolean", "description": "모바일 결제 UI에 **닫기** 버튼을 표시할지 여부입니다. 이 버튼은 결제 UI를 닫고 사용자를 `settings.return_url`매개 변수에 지정된 URL로 리디렉션합니다.", "default": false } } } } }, "is_prevent_external_link_open": { "type": "boolean", "description": "외부 자원에 대한 링크를 리디렉션할지 여부입니다. 외부 링크를 클릭하면 `postMessage` 메커니즘을 통해 `external-link-open` 이벤트가 전송됩니다. 리디렉션된 링크 주소는 `url` 매개 변수에 전달됩니다 .", "default": false }, "is_payment_methods_list_mode": { "type": "boolean", "description": "결제 UI를 열 때 사용자의 국가에서 사용할 수 있는 결제 방식 목록이 표시되는지 여부입니다. `false`(기본값)인 경우 `settings.payment_method` 매개 변수에서 전달된 결제 방식이나 [PayRank 알고리즘](https://developers.xsolla.com/ko/solutions/payments/payment-ui-management/top-payment-methods-management/)으로 선택한 결제 방식이 표시됩니다.", "default": false }, "is_independent_windows": { "type": "boolean", "description": "삽입된 런처의 브라우저(WebView)에서 기본 브라우저로 사용자를 리디렉션하여 구매할지 여부입니다.", "default": false }, "currency_format": { "type": "string", "description": "결제 UI에 3자리 [ISO 4217](https://developers.xsolla.com/ko/doc/pay-station/references/supported-currencies/) 통화 코드를 표시하려면 `code`로 설정하십시오. 기본적으로는 3자리 통화 코드 대신 통화 기호가 표시됩니다." }, "is_show_close_widget_warning": { "type": "boolean", "description": "결제 페이지를 닫기 전에 **×** 아이콘 위로 마우스를 가져갔을 때 거래 처리에 대한 경고를 표시할지 여부입니다. `false`가 전달되거나 매개 변수가 전달되지 않으면 경고가 표시되지 않습니다.", "default": true }, "layout": { "type": "string", "description": "결제 UI의 주요 요소 위치. 게임 내부에서 결제 UI를 열거나 주문 및 결제 방식에 대한 정보로 열을 바꿀 수 있습니다. 자세한 정보는 [사용자 정의 지침](https://developers.xsolla.com/ko/doc/pay-station/features/ui-theme-customization/#pay_station_ui_theme_customization_layout)을 참조해 주세요.", "enum": [ "embed", "column_reverse", "embed_column_reverse" ] }, "is_three_ds_independent_windows": { "type": "boolean", "description": "3-D 보안 확인이 새 브라우저 창에서 열릴지 여부입니다. 설정에서 CSP(콘텐츠 보안 정책)를 적용하는 경우로 `true`설정합니다.", "default": false }, "is_cart_open_by_default": { "type": "boolean", "description": "모바일 버전으로 결제 UI를 열 때 장바구니에 있는 아이템 목록을 표시할지 여부입니다. `true`이면 목록이 확장된 보기로 표시됩니다. `false`(기본값)이거나 매개 변수가 전달되지 않으면 목록이 축소된 보기로 표시됩니다.", "default": false } } }, "Cart-Payment_settings_payment_method": { "type": "integer", "description": "결제 수단 ID입니다. 일부 결제 방법은 특정 통화만 지원할 수 있으므로 결제 인터페이스에서 통화 표시를 결정합니다.", "minimum": 1 }, "Cart-Payment_settings_return_url": { "type": "string", "format": "uri", "description": "결제 후 사용자를 리디렉션하는 페이지입니다. 매개 변수 `user_id`, `foreigninvoice`, `invoice_id`, `status`가 자동으로 링크에 추가됩니다.", "maxLength": 1000 }, "Cart-Payment_redirect_policy": { "type": "object", "properties": { "redirect_conditions": { "description": "사용자를 반환 URL로 리디렉션하도록 트리거하는 결제 상태입니다.", "type": "string", "example": "none", "enum": [ "none", "successful", "successful_or_canceled", "any" ] }, "delay": { "description": "지연 후 사용자가 자동으로 반환 URL로 리디렉션됩니다.", "type": "integer", "example": 0 }, "status_for_manual_redirection": { "description": "사용자를 반환 URL로 리디렉션하는 버튼 클릭 표시를 트리거하는 결제 상태입니다.", "type": "string", "example": "none", "enum": [ "none", "successful", "successful_or_canceled", "any" ] }, "redirect_button_caption": { "description": "현지화된 리디렉션 버튼 캡션입니다.", "type": "string", "example": "Text button" } } }, "Cart-Payment_settings_sandbox": { "type": "boolean", "description": "결제 프로세스를 테스트하기 위해 `true` 값으로 설정합니다. 이 경우 테스트 결제 UI에 액세스하기 위해 https://sandbox-secure.Xsolla.com을 사용합니다.", "default": false }, "Cart-Payment_admin-user-request-body": { "type": "object", "required": [ "id" ], "additionalProperties": false, "properties": { "id": { "type": "object", "properties": { "value": { "description": "사용자 ID입니다. 테스트 목적으로 어떤 값이나 전달할 수 있습니다. 실제 결제를 수락하려면 시스템의 사용자 ID 값을 사용해야 합니다. 이 ID는 [유효성 검사](https://developers.xsolla.com/ko/webhooks/operation/user-validation/) 웹훅에서 전달됩니다.", "type": "string", "minLength": 1, "maxLength": 255 } } }, "name": { "type": "object", "properties": { "value": { "type": "string", "minLength": 1, "maxLength": 255, "description": "사용자 화면 이름입니다." } } }, "email": { "type": "object", "properties": { "value": { "type": "string", "minLength": 3, "maxLength": 255, "format": "email", "description": "사용자 이메일입니다. RFC 822 프로토콜에 따라 유효해야 합니다." } } }, "country": { "type": "object", "properties": { "value": { "type": "string", "description": "[ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)에 따른 2자리 대문자 국가 코드입니다. `X-User-Ip` 헤더에서 IP 주소가 전달되지 않을 경우 필요합니다. [엑솔라에서 지원하는 국가](https://developers.xsolla.com/ko/doc/shop-builder/references/supported-countries/)에 대한 자세한 정보는 설명서를 확인하십시오.
예: `country=US`", "example": "US" }, "allow_modify": { "type": "boolean", "description": "결제 UI에서 사용자가 국가를 변경할 수 있는지 여부입니다.", "default": false, "example": false } } }, "age": { "type": "integer", "description": "사용자 나이." }, "phone": { "type": "object", "required": [ "value" ], "properties": { "value": { "type": "string", "description": "전화번호." }, "allow_modify": { "type": "boolean", "description": "사용자가 결제 UI에서 전화번호를 변경할 수 있는지 여부입니다. `phone.value`가 토큰에서 전달되면 기본값은 `false`입니다.", "default": false, "example": false }, "hidden": { "type": "boolean", "default": true, "example": false } } }, "tracking_id": { "type": "object", "required": [ "value" ], "properties": { "value": { "type": "string", "minLength": 32, "maxLength": 32, "pattern": "^[A-Za-z0-9]{32}$", "description": "고유 추적 ID(마케팅 캠페인에 사용됨)입니다." } } }, "steam_id": { "type": "object", "required": [ "value" ], "properties": { "value": { "type": "string", "minLength": 17, "maxLength": 17, "pattern": "^\\d{17}$", "description": "Steam ID입니다." } } }, "is_legal": { "type": "boolean", "description": "사용자가 법인인지 여부를 나타냅니다." }, "legal": { "type": "object", "description": "법인 세부 정보가 있는 개체입니다. `user.is_legal`이 `true`인 경우 개체와 이에 해당하는 모든 매개 변수는 필수입니다.", "properties": { "name": { "type": "string", "description": "법인 전체 이름입니다." }, "address": { "type": "string", "description": "법인 전체 주소입니다." }, "vat_id": { "type": "string", "description": "개별 납세자 식별자입니다." }, "country": { "type": "string", "description": "기업이 속한 국가입니다. [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)에 따른 2자로 된 대문자 국가 코드를 사용합니다." } } } } }, "Cart_admin_payment": { "type": "object", "additionalProperties": false, "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "sku": { "type": "string", "minLength": 1, "description": "고유 아이템 ID입니다. SKU는 소문자 및 대문자 라틴 영숫자, 마침표, 대시 및 밑줄만 포함할 수 있습니다.\n\n
주의

하나의 SKU를 여러 번 판매하려면 purchase.items[].quantity 매개 변수에서 필요한 수량을 지정합니다. 배열 내의 중복 SKU는 지원되지 않으며, 토큰 생성 시 첫 번째 항목만 사용됩니다. 이 경우 오류는 반환되지 않습니다.
", "example": "t-shirt" }, "quantity": { "type": "number", "minimum": 1, "example": 2, "description": "아이템의 수량입니다." } }, "required": [ "sku", "quantity" ] }, "minItems": 1 } }, "required": [ "items" ] }, "Promotions_coupon_code": { "type": "string", "description": "고유한 대/소문자 구분 코드입니다. 문자와 숫자를 포함합니다.", "minLength": 1, "maxLength": 128, "example": "WINTER2021", "default": "WINTER2021", "pattern": "^[a-zA-Z0-9]+$" }, "Cart-Payment_settings_currency": { "type": "string", "description": "선호하는 결제 통화입니다. [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)에 따른 3자리 통화 코드입니다. [엑솔라에서 지원하는 통화](https://developers.xsolla.com/ko/doc/pay-station/references/supported-currencies/)에 대한 자세한 정보는 설명서에서 확인하십시오." }, "Cart-Payment_settings_locale": { "type": "string", "description": "인터페이스 언어입니다. 2자리 소문자 [언어 코드](https://developers.xsolla.com/ko/doc/pay-station/features/localization/)입니다." }, "Cart-Payment_settings_external_id": { "type": "string", "minLength": 1, "maxLength": 255, "description": "거래 외부 ID 입니다." }, "Cart-Payment_custom_parameters_token": { "description": "사용자 지정 매개 변수는 키-값 쌍의 유효한 JSON 집합으로 표시됩니다.
\n이 필드를 통해 추가 매개 변수를 전달하여 부정 결제 방지 필터를 구성할 수 있습니다. [페이 스테이션 설명서를 참조해주세요](https://developers.xsolla.com/ko/doc/pay-station/features/antifraud/).", "type": [ "object", "null" ], "minProperties": 1, "maxProperties": 200, "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" } ] }, "example": { "custom_parameters": { "string_param": "example", "bool_param": true, "int_param": 100, "number_param": 12.5, "null_param": null } } }, "422-invalid-request": { "type": "object", "properties": { "statusCode": { "type": "number", "description": "응답 상태 코드입니다.", "example": 422 }, "errorCode": { "type": "number", "description": "오류 코드.", "example": 1102 }, "errorMessage": { "type": "string", "description": "읽을 수 있는 오류 메시지입니다.", "example": "[0401-1102]: Unprocessable Entity. The property `external_id` is required" }, "transactionId": { "type": "string", "description": "요청의 고유 ID입니다.", "example": "da145238620011eb8e24fe6913ff226a" } } }, "Cart": { "type": "object", "additionalProperties": false, "properties": { "country": { "type": "string", "minLength": 2, "maxLength": 2, "example": "US", "description": "[ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)에 따른 2자리 대문자 국가 코드입니다. [엑솔라에서 지원하는 국가](https://developers.xsolla.com/ko/doc/shop-builder/references/supported-countries/)에 대한 자세한 정보는 설명서를 확인하십시오.
예: `country=US`" }, "currency": { "type": "string", "minLength": 3, "maxLength": 3, "example": "USD", "description": "장바구니에 표시되는 아이템 가격 통화입니다. [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)에 따른 3자리 코드입니다. [엑솔라에서 지원하는 통화](https://developers.xsolla.com/ko/doc/pay-station/references/supported-currencies/)에 대한 자세한 정보는 설명서를 확인하십시오." }, "items": { "type": "array", "items": { "type": "object", "properties": { "sku": { "type": "string", "minLength": 1, "description": "고유 아이템 ID입니다. SKU는 소문자 및 대문자 라틴 영숫자, 마침표, 대시 및 밑줄만 포함할 수 있습니다.", "example": "t-shirt" }, "quantity": { "type": "number", "minimum": 1, "example": 2, "description": "아이템의 수량입니다." } }, "required": [ "sku", "quantity" ] }, "minItems": 1 } }, "required": [ "items" ] }, "User-limit_user-external-id": { "description": "사용자 외부 ID입니다.", "type": "string", "minLength": 1, "pattern": "^\\S+$" }, "User-limit_user": { "type": "object", "properties": { "user_external_id": { "$ref": "#/components/schemas/User-limit_user-external-id" } }, "required": [ "user_external_id" ] }, "User-limit_user_flexible": { "type": [ "object", "null" ], "properties": { "user_external_id": { "$ref": "#/components/schemas/User-limit_user-external-id" } } }, "User-limit-item": { "type": "object", "properties": { "per_user": { "type": "object", "properties": { "total": { "type": "integer", "example": 10, "description": "사용자가 구매할 수 있는 아이템의 최대 개수입니다." }, "available": { "type": "integer", "example": 9, "description": "사용자가 구매할 수 있는 남은 아이템의 개수입니다." } } } } }, "User-limit_available_flexible": { "type": "integer", "minimum": 0, "description": "적용된 제한 설정 내에서 사용자가 사용할 수 있는 남은 아이템 또는 프로모션 사용 수량입니다." }, "User-limit_available": { "type": "integer", "minimum": 1, "description": "적용된 제한 설정 내에서 사용자가 사용할 수 있는 남은 아이템 또는 프로모션 사용 수량입니다." }, "422-invalid-request-extended": { "type": "object", "properties": { "statusCode": { "type": "number", "description": "응답 상태 코드입니다.", "example": 422 }, "errorCode": { "type": "number", "description": "오류 코드.", "example": 1102 }, "errorMessage": { "type": "string", "description": "읽을 수 있는 오류 메시지입니다.", "example": "[0401-1102]: Unprocessable Entity" }, "errorMessageExtended": { "$ref": "#/components/schemas/error-message-extended-validation" }, "transactionId": { "type": "string", "description": "고유 요청 ID입니다. 문제 해결을 위해 엑솔라 지원팀에 문의할 때 사용할 수 있습니다.", "example": "da145238620011eb8e24fe6913ff226a" } } }, "client_virtual_prices_with_calculated_price_response": { "type": "array", "description": "가상 가격입니다.", "items": { "type": "object", "description": "가상 가격입니다.", "properties": { "amount": { "type": "integer", "example": 100, "description": "인게임 재화로 표시된 아이템 가격입니다." }, "amount_without_discount": { "type": "integer", "example": 200, "description": "할인 없이 인게임 재화로 표시된 아이템 가격입니다. 인게임 재화 가격에는 할인이 적용되지 않으므로 항상 `amount`와 같습니다." }, "calculated_price": { "type": "object", "properties": { "amount": { "type": "string" }, "amount_without_discount": { "type": "string" } } }, "sku": { "type": "string", "example": "vc_gold", "description": "인게임 재화 SKU입니다." }, "is_default": { "type": "boolean", "example": true, "description": "인게임 재화의 기본 가격인지 여부입니다." }, "image_url": { "type": [ "string", "null" ], "example": "http://image.png", "description": "인게임 재화의 이미지 URL입니다." }, "item_id": { "type": "integer", "example": 259774, "description": "엑솔라가 할당한 고유 아이템 ID입니다." }, "name": { "type": "string", "example": "Gold", "description": "인게임 재화의 이름입니다." }, "type": { "type": "string", "example": "virtual_currency", "description": "아이템 유형. 인게임 재화의 경우 `virtual_currency입니다." }, "description": { "type": [ "string", "null" ], "example": "In-game currency used to purchase weapons and upgrades", "description": "인게임 재화 설명입니다." } } } }, "Regions_region_id": { "type": "integer", "description": "지역 ID입니다. 프로젝트 내부의 고유 지역 식별자입니다.", "example": 42 }, "Regions_name": { "type": "object", "description": "지역의 이름입니다. 키가 \"^[a-z]{2}-[A-Z]{2}$\" 형식의 로케일인 키/값 쌍을 포함해야 하며 값은 문자열입니다.", "additionalProperties": { "type": "string" }, "example": { "en-US": "Asia", "de-DE": "Asien" }, "default": { "en-US": "Asia", "de-DE": "Asien" } }, "Regions_200-region-short-model": { "type": "object", "properties": { "id": { "$ref": "#/components/schemas/Regions_region_id" }, "name": { "$ref": "#/components/schemas/Regions_name" } } }, "Regions_countries": { "type": "array", "description": "지역에 추가될 국가 목록입니다.\n
[ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)에 따른 2자리 대문자 국가 코드입니다.\n[엑솔라에서 지원하는 국가](https://developers.xsolla.com/ko/doc/shop-builder/references/supported-countries/)에 대한 자세한 정보는 설명서를 확인하십시오.\n
예: `[\"JP\", \"CN\", \"VN\"]`", "items": { "type": "string" } }, "Regions_200-region-model": { "type": "object", "properties": { "id": { "$ref": "#/components/schemas/Regions_region_id" }, "name": { "$ref": "#/components/schemas/Regions_name" }, "countries": { "$ref": "#/components/schemas/Regions_countries" } }, "example": { "value": { "id": 44, "name": { "en-US": "Asia", "de-DE": "Asien" }, "countries": [ "JP", "CN", "VN" ] } } }, "admin_attribute_response": { "type": "object", "properties": { "external_id": { "$ref": "#/components/schemas/admin-attribute-external_id" }, "name": { "$ref": "#/components/schemas/admin-attribute-name" } }, "example": { "value": [ { "external_id": "genre", "name": { "en": "Genre", "de": "Genre" } } ] } }, "schemas-422-invalid-request": { "type": "object", "properties": { "statusCode": { "type": "integer", "example": 422 }, "errorCode": { "type": "integer", "example": 1102 }, "errorMessage": { "type": "string", "example": "[0401-1102]: Unprocessable Entity. The property `property_name` is required" }, "transactionId": { "type": "string", "example": "x-x-x-x-transactionId-mock-x-x-x" } } }, "request-attribute-value": { "type": "object", "required": [ "external_id", "value" ], "properties": { "external_id": { "$ref": "#/components/schemas/value-external_id" }, "value": { "$ref": "#/components/schemas/value-name" } }, "example": { "external_id": "value_id", "value": { "en": "Value", "de": "Wert" } } }, "404-not-found": { "type": "object", "properties": { "statusCode": { "type": "integer", "example": 422 }, "errorCode": { "type": "integer", "example": 1102 }, "errorMessage": { "type": "string", "example": "[0000-0000]: Entity not found" }, "transactionId": { "type": "string", "example": "x-x-x-x-transactionId-mock-x-x-x" } } } }, "responses": { "Virtual-Items-Currency_200-admin-get-virtual-items": { "description": "가상 아이템 목록을 성공적으로 수신했습니다.", "content": { "application/json": { "example": { "items": [ { "sku": "com.xsolla.armor_max_1", "name": { "en": "Maximum Armor Xsolla Skin" }, "type": "virtual_good", "description": { "en": "Suit up with flair showcasing your allegiance to Xsolla" }, "image_url": "https://cdn.xsolla.net/img/misc/images/5c3b8b45c5be5fe7803e59fbc8041be4.png", "long_description": { "en": "The metal coverings formerly worn by soldiers or warriors to protect the body in battle." }, "attributes": [ { "external_id": "attr_1", "name": { "en-US": "OK" }, "values": [ { "external_id": "val1", "value": { "en-US": "VALUE" } }, { "external_id": "val2", "value": { "en-US": "VALUE2" } } ] } ], "is_free": false, "order": 1, "groups": [ { "external_id": "featured", "name": { "en": "featured" } }, { "external_id": "Xsolla", "name": { "en": "Xsolla" } }, { "external_id": "Premium", "name": { "en": "Premium" } }, { "external_id": "NonConsumableGroupCode", "name": { "en": "Non-consumable" } } ], "prices": [ { "amount": 12.99, "currency": "USD", "is_default": true, "is_enabled": true }, { "amount": 20.99, "currency": "CZK", "country_iso": "CZ", "is_default": false, "is_enabled": true } ], "media_list": [], "vc_prices": [], "is_enabled": true, "is_show_in_store": true, "regions": [], "limits": { "per_user": null, "per_item": null, "recurrent_schedule": null }, "periods": [], "custom_attributes": { "purchased": 0, "attr": "value" } }, { "sku": "com.xsolla.armor_max_2", "name": { "en": "Empire Maximum Armor" }, "type": "virtual_good", "description": { "en": "A strong armor forged to withstand heavy attacks." }, "image_url": "https://cdn.xsolla.net/img/misc/images/67d647ad4f4e9a905bd552b0408db8a8.png", "long_description": null, "attributes": [], "is_free": false, "order": 1, "groups": [ { "external_id": "all", "name": { "en": "Equipment" } }, { "external_id": "equipment", "name": { "en": "Nice Equipment" } }, { "external_id": "Empire", "name": { "en": "Empire" } } ], "prices": [ { "amount": 12.99, "currency": "USD", "is_default": true, "is_enabled": true }, { "amount": 20.99, "currency": "CZK", "country_iso": "CZ", "is_default": false, "is_enabled": true } ], "media_list": [], "vc_prices": [], "is_enabled": true, "is_show_in_store": true, "regions": [], "limits": { "per_user": { "total": 5, "limit_exceeded_visibility": "show" }, "per_item": null, "recurrent_schedule": { "per_user": { "interval_type": "daily", "time": "11:00:00+08:00", "reset_next_date": 1677553200, "displayable_reset_start_date": "2023-02-28T11:00:00+08:00", "displayable_reset_next_date": "2023-02-28T11:00:00+08:00" } } }, "periods": [ { "date_from": "2020-08-11T10:00:00+03:00", "date_until": "2020-08-11T20:00:00+03:00" } ] }, { "sku": "com.xsolla.armor_med_1", "name": { "en": "Xsolla Medium Armor" }, "type": "virtual_good", "description": { "en": "Moderately protect yourself against the Empires barrage of attacks" }, "image_url": "https://cdn.xsolla.net/img/misc/images/7f6e216f8fcc3c1796162897c2b0db01.png", "long_description": { "en": "Armor is a security-as-a-service company that provides cloud security and compliance solutions for small businesses and enterprises." }, "attributes": [], "is_free": false, "order": 1, "groups": [ { "external_id": "all", "name": { "en": "Equipment" } }, { "external_id": "Xsolla", "name": { "en": "Xsolla" } }, { "external_id": "equipment", "name": { "en": "Nice Equipment" } } ], "prices": [ { "amount": 4.99, "currency": "USD", "is_default": true, "is_enabled": true }, { "amount": 20.99, "currency": "CZK", "country_iso": "CZ", "is_default": false, "is_enabled": true } ], "media_list": [], "vc_prices": [], "is_enabled": true, "is_show_in_store": false, "regions": [], "limits": { "per_user": { "total": 5, "limit_exceeded_visibility": "show" }, "per_item": null, "recurrent_schedule": { "per_user": { "interval_type": "daily", "time": "11:00:00+08:00", "reset_next_date": 1677553200, "displayable_reset_start_date": "2023-02-28T11:00:00+08:00", "displayable_reset_next_date": "2023-02-28T11:00:00+08:00" } } }, "periods": [ { "date_from": null, "date_until": "2020-08-11T20:00:00+03:00" } ] }, { "sku": "com.xsolla.armor_med_2", "name": { "en": "Empire Medium Armor" }, "type": "virtual_good", "description": { "en": "Provides moderate protection in battle." }, "image_url": "https://cdn.xsolla.net/img/misc/images/737b4c93205dc774f47dda1f73037734.png", "long_description": { "en": "A strong armor forged to withstand heavy attacks." }, "attributes": [ { "external_id": "attr_1", "name": { "en-US": "OK" }, "values": [ { "external_id": "val1", "value": { "en-US": "VALUE" } }, { "external_id": "val2", "value": { "en-US": "VALUE2" } } ] } ], "is_free": false, "order": 1, "groups": [ { "external_id": "all", "name": { "en": "Equipment" } }, { "external_id": "equipment", "name": { "en": "Nice Equipment" } }, { "external_id": "Empire", "name": { "en": "Empire" } } ], "prices": [ { "amount": 4.99, "currency": "USD", "is_default": true, "is_enabled": true }, { "amount": 20.99, "currency": "CZK", "is_default": false, "is_enabled": true } ], "media_list": [], "vc_prices": [], "is_enabled": true, "is_show_in_store": true, "regions": [], "limits": { "per_user": { "total": 5 }, "per_item": { "total": 500, "available": 455, "reserved": 5, "sold": 40 }, "recurrent_schedule": { "per_user": { "interval_type": "daily", "time": "11:00:00+08:00", "reset_next_date": 1677553200, "displayable_reset_start_date": "2023-02-28T11:00:00+08:00", "displayable_reset_next_date": "2023-02-28T11:00:00+08:00" } } }, "periods": [] }, { "sku": "com.xsolla.armor_large_3", "name": { "en": "Empire Large Armor" }, "type": "virtual_good", "description": { "en": "Provides moderate protection in battle." }, "image_url": "https://cdn.xsolla.net/img/misc/images/737b4c93205dc774f47dda1f73037734.png", "long_description": null, "attributes": [ { "external_id": "attr_1", "name": { "en-US": "OK" }, "values": [ { "external_id": "val1", "value": { "en-US": "VALUE" } }, { "external_id": "val2", "value": { "en-US": "VALUE2" } } ] } ], "is_free": false, "order": 1, "groups": [ { "external_id": "all", "name": { "en": "Equipment" } }, { "external_id": "equipment", "name": { "en": "Nice Equipment" } }, { "external_id": "Empire", "name": { "en": "Empire" } } ], "prices": [ { "amount": 4.99, "currency": "USD", "is_default": true, "is_enabled": true }, { "amount": 20.99, "currency": "CZK", "is_default": false, "is_enabled": true } ], "media_list": [], "vc_prices": [], "is_enabled": true, "is_show_in_store": true, "regions": [], "limits": { "per_user": { "total": 5 }, "per_item": { "total": 500, "available": 455, "reserved": 5, "sold": 40 }, "recurrent_schedule": { "per_user": { "interval_type": "hourly", "hours_interval": 8, "time": "11:00:00+08:00", "reset_next_date": 1677553200, "displayable_reset_start_date": "2023-02-28T11:00:00+08:00", "displayable_reset_next_date": "2023-02-28T11:00:00+08:00" } } }, "periods": [] } ] }, "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/Virtual-Items-Currency_admin-virtual-item" } } } } } } }, "Virtual-Items-Currency_401-invalid-basic-auth": { "description": "기본 인증이 전달되지 않았거나 잘못되었습니다. 기본 인증 또는 올바른 자격 증명을 사용했는지 확인해야 합니다.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "example": 401 }, "errorCode": { "type": "integer", "example": 1020 }, "errorMessage": { "type": "string", "example": "[0401-1020]: Error in Authentication method occurred" } } }, "examples": { "response": { "value": { "statusCode": 401, "errorCode": 1020, "errorMessage": "[0401-1020]: Error in Authentication method occurred" } } } } } }, "Virtual-Items-Currency_201-created": { "description": "가상 아이템을 성공적으로 생성했습니다.", "content": { "application/json": { "examples": { "response": { "value": { "sku": "com.xsolla.item_1" } } }, "schema": { "type": "object", "example": { "sku": "com.xsolla.item_1" }, "properties": { "sku": { "type": "string", "example": "new-sku" } } } } } }, "Virtual-Items-Currency_422-invalid-request": { "description": "잘못된 요청입니다.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Virtual-Items-Currency_422-invalid-request" }, "examples": { "The property `sku` is required": { "$ref": "#/components/examples/422-property-sku-is-required" }, "Numbers of attribute values per item exceeded": { "$ref": "#/components/examples/422-numbers-of-attribute-values-per-item-exceeded" }, "Numbers of attributes per item exceeded": { "$ref": "#/components/examples/422-numbers-of-attributes-per-item-exceeded" }, "Value limit exceeded": { "$ref": "#/components/examples/422-value-limit-exceeded" }, "Custom attributes JSON can’t exceed 500 characters": { "$ref": "#/components/examples/422-custom-attributes-size-exceeded" } } } } }, "Virtual-Items-Currency_200-admin-get-virtual-items-by-group": { "description": "가상 아이템 목록을 성공적으로 수신했습니다.", "content": { "application/json": { "example": { "items": [ { "sku": "com.xsolla.armor_max_2", "name": { "en": "Empire Maximum Armor" }, "type": "virtual_good", "description": { "en": "A strong armor forged to withstand heavy attacks" }, "image_url": "https://cdn.xsolla.net/img/misc/images/67d647ad4f4e9a905bd552b0408db8a8.png", "long_description": null, "attributes": [], "is_free": false, "order": 1, "groups": [ { "external_id": "weapons", "name": { "en": "Weapons" } }, { "external_id": "accessory", "name": { "en": "Accessory" } } ], "prices": [ { "amount": 12.99, "currency": "USD", "is_default": true, "is_enabled": true }, { "amount": 20.99, "currency": "CZK", "country_iso": "CZ", "is_default": false, "is_enabled": true } ], "media_list": [], "vc_prices": [], "is_enabled": true, "is_show_in_store": true, "regions": [], "limits": { "per_user": { "total": 5, "limit_exceeded_visibility": "show" }, "per_item": null, "recurrent_schedule": { "per_user": { "interval_type": "monthly", "day_of_week": null, "day_of_month": 28, "time": "11:00:00+08:00", "reset_next_date": 1679972400, "displayable_reset_start_date": "2023-02-28T11:00:00+08:00", "displayable_reset_next_date": "2023-03-28T11:00:00+08:00" } } }, "periods": [ { "date_from": "2020-08-11T10:00:00+03:00", "date_until": "2020-08-11T20:00:00+03:00" } ], "custom_attributes": { "purchased": 0, "attr": "value" } }, { "sku": "com.xsolla.armor_med_1", "name": { "en": "Xsolla Medium Armor" }, "type": "virtual_good", "description": { "en": "Moderately protect yourself against the Empires barrage of attacks" }, "image_url": "https://cdn.xsolla.net/img/misc/images/7f6e216f8fcc3c1796162897c2b0db01.png", "long_description": { "en": "Armor is a security-as-a-service company that provides cloud security and compliance solutions for small businesses and enterprises." }, "attributes": [], "is_free": false, "order": 1, "groups": [ { "external_id": "weapons", "name": { "en": "Weapons" } }, { "external_id": "accessory", "name": { "en": "Accessory" } } ], "prices": [ { "amount": 4.99, "currency": "USD", "is_default": true, "is_enabled": true }, { "amount": 20.99, "currency": "CZK", "country_iso": "CZ", "is_default": false, "is_enabled": true } ], "media_list": [], "vc_prices": [], "is_enabled": true, "is_show_in_store": false, "regions": [], "limits": { "per_user": { "total": 5, "limit_exceeded_visibility": "show" }, "per_item": null, "recurrent_schedule": { "per_user": { "interval_type": "daily", "time": "11:00:00+08:00", "reset_next_date": 1677553200, "displayable_reset_start_date": "2023-02-28T11:00:00+08:00", "displayable_reset_next_date": "2023-02-28T11:00:00+08:00" } } }, "periods": [ { "date_from": null, "date_until": "2020-08-11T20:00:00+03:00" } ] }, { "sku": "com.xsolla.armor_med_2", "name": { "en": "Empire Medium Armor" }, "type": "virtual_good", "description": { "en": "Provides moderate protection in battle." }, "image_url": "https://cdn.xsolla.net/img/misc/images/737b4c93205dc774f47dda1f73037734.png", "long_description": { "en": "A strong armor forged to withstand heavy attacks." }, "attributes": [ { "external_id": "attr_1", "name": { "en-US": "OK" }, "values": [ { "external_id": "val1", "value": { "en-US": "VALUE" } }, { "external_id": "val2", "value": { "en-US": "VALUE2" } } ] } ], "is_free": false, "order": 1, "groups": [ { "external_id": "weapons", "name": { "en": "Weapons" } }, { "external_id": "accessory", "name": { "en": "Accessory" } } ], "prices": [ { "amount": 4.99, "currency": "USD", "is_default": true, "is_enabled": true }, { "amount": 20.99, "currency": "CZK", "is_default": false, "is_enabled": true } ], "media_list": [], "vc_prices": [], "is_enabled": true, "is_show_in_store": true, "regions": [], "limits": { "per_user": { "total": 5, "limit_exceeded_visibility": "show" }, "per_item": { "total": 500, "available": 455, "reserved": 5, "sold": 40 }, "recurrent_schedule": { "per_user": { "interval_type": "daily", "time": "11:00:00+08:00", "reset_next_date": 1677553200, "displayable_reset_start_date": "2023-02-28T11:00:00+08:00", "displayable_reset_next_date": "2023-02-28T11:00:00+08:00" } } }, "periods": [] }, { "sku": "com.xsolla.armor_lrg_2", "name": { "en": "Empire Large Armor" }, "type": "virtual_good", "description": { "en": "Provides moderate protection in battle." }, "image_url": "https://cdn.xsolla.net/img/misc/images/737b4c93205dc774f47dda1f73037734.png", "long_description": { "en": "A strong armor forged to withstand heavy attacks." }, "attributes": [ { "external_id": "attr_1", "name": { "en-US": "OK" }, "values": [ { "external_id": "val1", "value": { "en-US": "VALUE" } }, { "external_id": "val2", "value": { "en-US": "VALUE2" } } ] } ], "is_free": false, "order": 1, "groups": [ { "external_id": "weapons", "name": { "en": "Weapons" } }, { "external_id": "accessory", "name": { "en": "Accessory" } } ], "prices": [ { "amount": 4.99, "currency": "USD", "is_default": true, "is_enabled": true }, { "amount": 20.99, "currency": "CZK", "is_default": false, "is_enabled": true } ], "media_list": [], "vc_prices": [], "is_enabled": true, "is_show_in_store": true, "regions": [], "limits": { "per_user": { "total": 5, "limit_exceeded_visibility": "show" }, "per_item": { "total": 500, "available": 455, "reserved": 5, "sold": 40 }, "recurrent_schedule": { "per_user": { "interval_type": "hourly", "hours_interval": 8, "time": "11:00:00+08:00", "reset_next_date": 1677553200, "displayable_reset_start_date": "2023-02-28T11:00:00+08:00", "displayable_reset_next_date": "2023-02-28T11:00:00+08:00" } } }, "periods": [] } ] }, "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/Virtual-Items-Currency_admin-virtual-item" } } } } } } }, "Virtual-Items-Currency_200-admin-get-item": { "description": "지정한 가상 아이템을 성공적으로 수신했습니다.", "content": { "application/json": { "example": { "sku": "com.xsolla.swords_1", "name": { "en": "Sword Xsolla Skin" }, "type": "virtual_good", "description": { "en": "Honshu Boshin Wakizashi - Modern Tactical Samurai / Ninja Sword - Hand Forged 1060 Carbon Steel - Full Tang, Fully Functional, Battle Ready - Black TPR, Steel Guard and Pommel" }, "image_url": "https://cdn.xsolla.net/img/misc/images/8ab44fe99038a56de01950ba4a971b77.png", "long_description": { "en": "Honshu Boshin Wakizashi - Modern Tactical Samurai / Ninja Sword - Hand Forged 1060 Carbon Steel - Full Tang, Fully Functional, Battle Ready - Black TPR, Steel Guard and Pommel" }, "attributes": [ { "external_id": "attr_1", "name": { "en-US": "OK" }, "values": [ { "external_id": "val1", "value": { "en-US": "VALUE" } }, { "external_id": "val2", "value": { "en-US": "VALUE2" } } ] } ], "is_free": false, "is_paid_randomized_reward": true, "order": 1, "groups": [ { "external_id": "accessory", "name": { "en": "accessory" } }, { "external_id": "weapon", "name": { "en": "weapon" } } ], "prices": [ { "amount": 4.99, "currency": "USD", "is_default": true, "is_enabled": true, "country_iso": "US" } ], "media_list": [], "vc_prices": [], "is_enabled": true, "is_show_in_store": true, "regions": [], "limits": { "per_user": { "total": 5, "limit_exceeded_visibility": "show" }, "per_item": null, "recurrent_schedule": { "per_user": { "interval_type": "daily", "time": "11:00:00+08:00", "reset_next_date": 1677553200, "displayable_reset_start_date": "2023-02-28T11:00:00+08:00", "displayable_reset_next_date": "2023-02-28T11:00:00+08:00" } } }, "periods": [ { "date_from": "2020-08-11T10:00:00+03:00", "date_until": "2020-08-11T20:00:00+03:00" } ], "custom_attributes": { "purchased": 0, "attr": "value" } }, "schema": { "$ref": "#/components/schemas/Virtual-Items-Currency_admin-virtual-item" } } } }, "Virtual-Items-Currency_200-admin-get-virtual-currencies": { "description": "인게임 재화 목록을 성공적으로 수신했습니다.", "content": { "application/json": { "example": { "items": [ { "sku": "com.xsolla.crystal_1", "name": { "en": "Crystals", "ru": "Crystals" }, "type": "virtual_currency", "description": { "en": "Main in-game currency" }, "image_url": "https://cdn3.xsolla.com/img/misc/images/da33ab6cc1d7e5899cfdc5b6b6180fad.png", "long_description": null, "attributes": [ { "external_id": "attr_1", "name": { "en-US": "OK" }, "values": [ { "external_id": "val1", "value": { "en-US": "VALUE" } }, { "external_id": "val2", "value": { "en-US": "VALUE2" } } ] } ], "is_free": false, "order": 1, "groups": [], "prices": [ { "amount": 1, "currency": "USD", "is_default": true, "is_enabled": true, "country_iso": "US" } ], "media_list": [], "vc_prices": [], "is_enabled": true, "is_show_in_store": true, "regions": [], "limits": { "per_user": { "total": 5, "limit_exceeded_visibility": "show" }, "per_item": null, "recurrent_schedule": { "per_user": { "interval_type": "daily", "time": "11:00:00+08:00", "reset_next_date": 1677553200, "displayable_reset_start_date": "2023-02-28T11:00:00+08:00", "displayable_reset_next_date": "2023-02-28T11:00:00+08:00" } } }, "periods": [ { "date_from": "2020-08-11T10:00:00+03:00", "date_until": "2020-08-11T20:00:00+03:00" } ], "custom_attributes": { "purchased": 0, "attr": "value" } }, { "sku": "com.xsolla.gold_1", "name": { "en": "Gold", "ru": "Gold" }, "type": "virtual_currency", "description": { "en": "Money for in-store purchases" }, "image_url": "https://cdn3.xsolla.com/img/misc/images/bc1bf2bdeca78515d5d15e545d6884be.png", "long_description": null, "attributes": [], "is_free": false, "order": 1, "groups": [], "prices": [ { "amount": 1, "currency": "USD", "is_default": true, "is_enabled": true, "country_iso": "US" } ], "media_list": [], "vc_prices": [], "is_enabled": true, "is_show_in_store": true, "regions": [], "limits": { "per_user": null, "per_item": null, "recurrent_schedule": null }, "periods": [] } ] }, "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/Virtual-Items-Currency_admin-virtual-currency" } } } } } } }, "Virtual-Items-Currency_200-admin-get-virtual-currency": { "description": "지정한 인게임 재화를 성공적으로 수신했습니다.", "content": { "application/json": { "example": { "sku": "com.xsolla.crystal_1", "name": { "en": "Crystals", "ru": "Crystals" }, "type": "virtual_currency", "description": { "en": "Main in-game currency" }, "image_url": "https://cdn3.xsolla.com/img/misc/images/da33ab6cc1d7e5899cfdc5b6b6180fad.png", "long_description": null, "attributes": [ { "external_id": "attr_1", "name": { "en-US": "OK" }, "values": [ { "external_id": "val1", "value": { "en-US": "VALUE" } }, { "external_id": "val2", "value": { "en-US": "VALUE2" } } ] } ], "is_free": false, "is_paid_randomized_reward": false, "order": 1, "groups": [], "prices": [ { "amount": 1, "currency": "USD", "is_default": true, "is_enabled": true, "country_iso": "US" } ], "media_list": [], "vc_prices": [], "is_enabled": true, "is_show_in_store": true, "regions": [], "limits": { "per_user": null, "per_item": null, "recurrent_schedule": null }, "periods": [], "custom_attributes": { "purchased": 0, "attr": "value" } }, "schema": { "$ref": "#/components/schemas/Virtual-Items-Currency_admin-virtual-currency" } } } }, "Virtual-Items-Currency_404-item": { "description": "아이템을 찾을 수 없습니다. `project_id`과 `item_sku`가 올바른지 확인해야 합니다.", "content": { "application/json": { "schema": { "properties": { "statusCode": { "type": "integer", "example": 404 }, "errorCode": { "type": "integer", "example": 4001 }, "errorMessage": { "type": "string", "example": "[0401-4001]: Item with Project Id = 44056 and Sku = booster_mega_12222 not found" } }, "type": "object" } } } }, "Virtual-Items-Currency_200-admin-get-virtual-currency-packages": { "description": "인게임 재화 패키지 목록을 성공적으로 수신했습니다.", "content": { "application/json": { "example": { "items": [ { "sku": "com.xsolla.crystal_pack_1", "name": { "en": "Small crystal pack" }, "type": "bundle", "description": { "en": "Crystals x100" }, "image_url": "https://cdn3.xsolla.com/img/misc/images/a8682cea328afda0bd127d59eb5b9077.png", "long_description": null, "attributes": [ { "external_id": "attr_1", "name": { "en-US": "OK" }, "values": [ { "external_id": "val1", "value": { "en-US": "VALUE" } }, { "external_id": "val2", "value": { "en-US": "VALUE2" } } ] } ], "is_free": false, "order": 1, "groups": [], "prices": [ { "amount": 5, "currency": "USD", "is_default": true, "is_enabled": true, "country_iso": "US" } ], "media_list": [], "vc_prices": [], "is_enabled": true, "is_show_in_store": true, "regions": [], "bundle_type": "virtual_currency_package", "content": [ { "description": { "en": "Main in-game currency" }, "image_url": "https://cdn3.xsolla.com/img/misc/images/da33ab6cc1d7e5899cfdc5b6b6180fad.png", "sku": "com.xsolla.crystal_1", "name": { "en": "Crystals", "ru": "Crystals" }, "type": "virtual_currency", "quantity": 100 } ], "limits": { "per_user": { "total": 5, "limit_exceeded_visibility": "show" }, "per_item": null, "recurrent_schedule": { "per_user": { "interval_type": "daily", "time": "11:00:00+08:00", "reset_next_date": 1677553200, "displayable_reset_start_date": "2023-02-28T11:00:00+08:00", "displayable_reset_next_date": "2023-02-28T11:00:00+08:00" } } }, "periods": [ { "date_from": "2020-08-11T10:00:00+03:00", "date_until": "2020-08-11T20:00:00+03:00" } ], "custom_attributes": { "purchased": 0, "attr": "value" } }, { "sku": "com.xsolla.crystal_pack_2", "name": { "en": "Medium crystal pack" }, "type": "bundle", "description": { "en": "Crystals x500" }, "image_url": "https://cdn3.xsolla.com/img/misc/images/431a40dd8c99290dd761508964ddbacf.png", "long_description": null, "attributes": [], "is_free": false, "order": 1, "groups": [], "prices": [ { "amount": 20, "currency": "USD", "is_default": true, "is_enabled": true, "country_iso": "US" } ], "media_list": [], "vc_prices": [], "is_enabled": true, "is_show_in_store": true, "regions": [], "bundle_type": "virtual_currency_package", "content": [ { "description": { "en": "Main in-game currency" }, "image_url": "https://cdn3.xsolla.com/img/misc/images/da33ab6cc1d7e5899cfdc5b6b6180fad.png", "sku": "com.xsolla.crystal_2", "name": { "en": "Crystals", "ru": "Crystals" }, "type": "virtual_currency", "quantity": 500 } ], "limits": { "per_user": null, "per_item": null, "recurrent_schedule": null }, "periods": [ { "date_from": null, "date_until": "2020-08-11T20:00:00+03:00" } ] }, { "sku": "com.xsolla.crystal_pack_3", "name": { "en": "Massive crystal pack" }, "type": "bundle", "description": { "en": "Crystals x1500" }, "image_url": "https://cdn3.xsolla.com/img/misc/images/1d67a1d2f92d69e021a97effa692dff3.png", "long_description": null, "attributes": [], "is_free": false, "order": 1, "groups": [], "prices": [ { "amount": 50, "currency": "USD", "is_default": true, "is_enabled": true, "country_iso": "US" } ], "media_list": [], "vc_prices": [], "is_enabled": true, "is_show_in_store": true, "regions": [], "bundle_type": "virtual_currency_package", "content": [ { "description": { "en": "Main in-game currency" }, "image_url": "https://cdn3.xsolla.com/img/misc/images/da33ab6cc1d7e5899cfdc5b6b6180fad.png", "sku": "com.xsolla.crystal_3", "name": { "en": "Crystals", "ru": "Crystals" }, "type": "virtual_currency", "quantity": 1500 } ], "limits": { "per_user": null, "per_item": null, "recurrent_schedule": null }, "periods": [] }, { "sku": "com.xsolla.gold_pack_1", "name": { "en": "Small gold pack" }, "type": "bundle", "description": { "en": "Gold x100" }, "image_url": "https://cdn3.xsolla.com/img/misc/images/09984ff0a3ae6b367c9c886b31366950.png", "long_description": null, "attributes": [], "is_free": false, "order": 1, "groups": [], "prices": [ { "amount": 5, "currency": "USD", "is_default": true, "is_enabled": true, "country_iso": "US" } ], "media_list": [], "vc_prices": [], "is_enabled": true, "is_show_in_store": true, "regions": [], "bundle_type": "virtual_currency_package", "content": [ { "description": { "en": "Money for in-store purchases" }, "image_url": "https://cdn3.xsolla.com/img/misc/images/bc1bf2bdeca78515d5d15e545d6884be.png", "sku": "com.xsolla.gold_1", "name": { "en": "Gold", "ru": "Gold" }, "type": "virtual_currency", "quantity": 100 } ], "limits": { "per_user": null, "per_item": null, "recurrent_schedule": null }, "periods": [] }, { "sku": "com.xsolla.gold_pack_2", "name": { "en": "Medium gold pack" }, "type": "bundle", "description": { "en": "Gold x500" }, "image_url": "https://cdn3.xsolla.com/img/misc/images/b5d8130bdaf28aa55c43a68aa3ca0ef4.png", "long_description": null, "attributes": [ { "external_id": "attr_1", "name": { "en-US": "OK" }, "values": [ { "external_id": "val1", "value": { "en-US": "VALUE" } }, { "external_id": "val2", "value": { "en-US": "VALUE2" } } ] } ], "is_free": false, "order": 1, "groups": [], "prices": [ { "amount": 20, "currency": "USD", "is_default": true, "is_enabled": true, "country_iso": "US" } ], "media_list": [], "vc_prices": [], "is_enabled": true, "is_show_in_store": true, "regions": [], "bundle_type": "virtual_currency_package", "content": [ { "description": { "en": "Money for in-store purchases" }, "image_url": "https://cdn3.xsolla.com/img/misc/images/bc1bf2bdeca78515d5d15e545d6884be.png", "sku": "com.xsolla.gold_2", "name": { "en": "Gold", "ru": "Gold" }, "type": "virtual_currency", "quantity": 500 } ], "limits": { "per_user": null, "per_item": null, "recurrent_schedule": null }, "periods": [] }, { "sku": "com.xsolla.gold_pack_3", "name": { "en": "Large gold pack" }, "type": "bundle", "description": { "en": "Gold x1500" }, "image_url": "https://cdn3.xsolla.com/img/misc/images/dea74a3667807d5502a4acb8f4c879ca.png", "long_description": null, "attributes": [ { "external_id": "attr_1", "name": { "en-US": "OK" }, "values": [ { "external_id": "val1", "value": { "en-US": "VALUE" } }, { "external_id": "val2", "value": { "en-US": "VALUE2" } } ] } ], "is_free": false, "order": 1, "groups": [], "prices": [ { "amount": 50, "currency": "USD", "is_default": true, "is_enabled": true, "country_iso": "US" } ], "media_list": [], "vc_prices": [], "is_enabled": true, "is_show_in_store": true, "regions": [], "bundle_type": "virtual_currency_package", "content": [ { "description": { "en": "Money for in-store purchases" }, "image_url": "https://cdn3.xsolla.com/img/misc/images/bc1bf2bdeca78515d5d15e545d6884be.png", "sku": "com.xsolla.gold_3", "name": { "en": "Gold", "ru": "Gold" }, "type": "virtual_currency", "quantity": 1500 } ], "limits": { "per_user": null, "per_item": null, "recurrent_schedule": null }, "periods": [] } ] }, "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/Virtual-Items-Currency_admin-virtual-currency-package" } } } } } } }, "Virtual-Items-Currency_200-admin-get-virtual-currency-package": { "description": "지정한 인게임 재화 패키지를 성공적으로 수신했습니다.", "content": { "application/json": { "example": { "sku": "com.xsolla.crystal_pack_1", "name": { "en": "Small crystal pack" }, "type": "bundle", "description": { "en": "Crystals x100" }, "image_url": "https://cdn3.xsolla.com/img/misc/images/a8682cea328afda0bd127d59eb5b9077.png", "long_description": null, "attributes": [ { "external_id": "attr_1", "name": { "en-US": "OK" }, "values": [ { "external_id": "val1", "value": { "en-US": "VALUE" } }, { "external_id": "val2", "value": { "en-US": "VALUE2" } } ] } ], "is_free": false, "is_paid_randomized_reward": true, "order": 1, "groups": [], "prices": [ { "amount": 5, "currency": "USD", "is_default": true, "is_enabled": true, "country_iso": "US" } ], "media_list": [], "vc_prices": [], "is_enabled": true, "is_show_in_store": true, "regions": [], "bundle_type": "virtual_currency_package", "content": [ { "description": { "en": "Main in-game currency" }, "image_url": "https://cdn3.xsolla.com/img/misc/images/da33ab6cc1d7e5899cfdc5b6b6180fad.png", "sku": "com.xsolla.crystal_1", "name": { "en": "Crystals", "ru": "Crystals" }, "type": "virtual_currency", "quantity": 100 } ], "limits": { "per_user": null, "per_item": null, "recurrent_schedule": null }, "periods": [], "custom_attributes": { "purchased": 0, "attr": "value" } }, "schema": { "$ref": "#/components/schemas/Virtual-Items-Currency_admin-virtual-currency-package" } } } }, "Virtual-Items-Currency_200-get-items-list": { "description": "가상 아이템 목록을 성공적으로 수신했습니다.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Virtual-Items-Currency_item-list" }, "examples": { "response": { "value": { "has_more": true, "items": [ { "sku": "com.xsolla.big_rocket_1", "name": { "en": "Big Rocket" }, "groups": [ { "external_id": "accessory", "name": "accessory", "item_order_in_group": 1 } ], "attributes": [ { "external_id": "stack_size", "name": { "en": "Stack size" }, "values": [ { "external_id": "size_e3364991f92e751689a68b96598a5a5a84010b85", "value": "5" } ] } ], "type": "virtual_good", "description": { "en": "Big Rocket - description" }, "image_url": "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png", "is_free": false, "price": { "amount": "100.99", "amount_without_discount": "100.99", "currency": "USD" }, "virtual_prices": [ { "amount": 100, "sku": "com.xsolla.vc_1", "is_default": true, "amount_without_discount": 100, "image_url": "http://image.png", "name": "SHOTGUN FOR TRUE RAIDERS", "type": "virtual_currency", "description": "description" } ], "can_be_bought": true, "virtual_item_type": "non_renewing_subscription", "promotions": [ { "name": "Bonus promotion", "date_start": "2020-04-15T16:16:00+03:00", "date_end": "2026-04-15T16:16:00+03:00", "discount": null, "bonus": [ { "quantity": 1, "name": "Xsolla Minigun", "image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png", "sku": "com.xsolla.minigun_1", "type": "virtual_good" }, { "quantity": 1, "sku": "com.xsolla.phys_good_1", "type": "physical_good" }, { "quantity": 1, "name": "Super Lootbox with items", "image_url": "https://cdn.xsolla.net/img/misc/images/9676f06265375087e607cb79c5283688.png", "sku": "com.xsolla.SuperLootboxBundle_1", "type": "bundle", "bundle_type": "standard" } ] } ], "limits": { "per_user": { "total": 5, "available": 3, "recurrent_schedule": { "interval_type": "weekly", "reset_next_date": 1746057600 }, "limit_exceeded_visibility": "show" } }, "periods": [ { "date_from": "2020-08-11T10:00:00+03:00", "date_until": "2020-08-11T20:00:00+03:00" } ], "custom_attributes": { "purchased": 0, "attr": "value" }, "vp_rewards": [] }, { "sku": "com.xsolla.shotgun_raider_1", "name": { "en": "SHOTGUN FOR TRUE RAIDERS" }, "groups": [ { "external_id": "weapons", "name": "Weapons", "item_order_in_group": 1 } ], "attributes": [ { "external_id": "stack_size", "name": { "en": "Stack size" }, "values": [ { "external_id": "size_e3364991f92e751689a68b96598a5a5a84010b85", "value": "5" } ] }, { "external_id": "rating", "name": { "en": "Rating" }, "values": [ { "external_id": "rating_e3364991f92e751689a68b96598a5a5a84010b85", "value": "3.9" } ] } ], "type": "virtual_good", "description": { "en": "description" }, "image_url": "http://image.png", "is_free": false, "price": { "amount": "101.0", "amount_without_discount": "101.0", "currency": "USD" }, "virtual_prices": [ { "amount": 100, "sku": "com.xsolla.vc_1", "is_default": true, "amount_without_discount": 100, "image_url": "http://image.png", "name": "SHOTGUN FOR TRUE RAIDERS", "type": "virtual_currency", "description": "description" }, { "amount": 200, "sku": "com.xsolla.vc_2", "is_default": false, "amount_without_discount": 200, "image_url": "http://image.png", "name": "SHOTGUN FOR TRUE RAIDERS", "type": "virtual_currency", "description": "description" } ], "can_be_bought": true, "virtual_item_type": "non_renewing_subscription", "promotions": [], "limits": null, "periods": [ { "date_from": null, "date_until": "2020-08-11T20:00:00+03:00" } ], "vp_rewards": [] }, { "sku": "com.xsolla.shotgun_raider_2", "name": { "en": "SHOTGUN FOR TRUE RAIDERS" }, "groups": [], "attributes": [], "type": "virtual_good", "description": { "en": "description" }, "image_url": "http://image.png", "is_free": true, "price": null, "virtual_prices": [], "can_be_bought": true, "virtual_item_type": "non_renewing_subscription", "promotions": [], "limits": null, "periods": [], "vp_rewards": [] } ] } } } } } }, "Virtual-Items-Currency_200-get-item-by-sku": { "description": "가상 아이템을 성공적으로 수신했습니다.", "content": { "application/json": { "example": { "item_id": 488833, "sku": "com.xsolla.swords_1", "type": "virtual_good", "name": { "en": "Sword Xsolla Skin" }, "description": { "en": "Honshu Boshin Wakizashi - Modern Tactical Samurai / Ninja Sword - Hand Forged 1060 Carbon Steel - Full Tang, Fully Functional, Battle Ready - Black TPR, Steel Guard and Pommel" }, "image_url": "https://cdn.xsolla.net/img/misc/images/8ab44fe99038a56de01950ba4a971b77.png", "price": { "amount": "4.99", "amount_without_discount": "4.99", "currency": "USD" }, "virtual_prices": [], "can_be_bought": true, "promotions": [], "limits": { "per_user": { "total": 3, "available": 1, "recurrent_schedule": { "interval_type": "weekly", "reset_next_date": 1761840000 }, "limit_exceeded_visibility": "show" }, "per_item": null }, "periods": [ { "date_from": "2020-08-11T10:00:00+03:00", "date_until": "2020-08-11T20:00:00+03:00" } ], "attributes": [ { "external_id": "attr_1", "name": { "en-US": "OK" }, "values": [ { "external_id": "val1", "value": "VALUE" }, { "external_id": "val2", "value": "VALUE2" } ] } ], "is_free": false, "groups": [ { "external_id": "weapons", "name": "weapons" } ], "virtual_item_type": "non_consumable", "vp_rewards": [], "custom_attributes": { "purchased": 0, "attr": "value" } }, "schema": { "$ref": "#/components/schemas/Virtual-Items-Currency_item" } } } }, "Virtual-Items-Currency_200-get-all-items-list": { "description": "모든 가상 아이템 목록을 성공적으로 수신했습니다.", "content": { "application/json": { "schema": { "type": "object", "description": "가상 아이템이 있는 개체입니다.", "properties": { "items": { "type": "array", "example": [ { "sku": "com.xsolla.big_rocket_1", "name": "Big Rocket", "description": "Big Rocket - description", "groups": [ { "external_id": "accessory", "name": { "en": "accessory" } } ] }, { "sku": "com.xsolla.shotgun_raider_1", "name": "SHOTGUN FOR TRUE RAIDERS", "description": "description", "groups": [ { "external_id": "weapons", "name": { "en": "Weapons" } } ] }, { "sku": "com.xsolla.shotgun_raider_2", "name": "SHOTGUN FOR TRUE RAIDERS", "description": "description", "groups": [] } ], "items": { "type": "object", "properties": { "sku": { "type": "string", "example": "com.xsolla.big_rocket_1", "description": "고유 아이템 ID입니다. SKU는 소문자 및 대문자 라틴 영숫자, 마침표, 대시 및 밑줄만 포함할 수 있습니다." }, "name": { "type": "string", "example": "Big Rocket", "description": "아이템 이름입니다." }, "groups": { "type": "array", "properties": { "external_id": { "type": "string", "example": "weapons" }, "name": { "type": "object", "additionalProperties": { "type": [ "string", "null" ] } } } }, "description": { "type": "string", "example": "Big Rocket - description", "description": "아이템 설명입니다." } } } } } }, "examples": { "response": { "value": { "items": [ { "sku": "com.xsolla.big_rocket_1", "name": "Big Rocket", "groups": [ { "external_id": "accessory", "name": { "en": "Accessory" } } ], "description": "Big Rocket - description" }, { "sku": "com.xsolla.shotgun_raider_1", "name": "SHOTGUN FOR TRUE RAIDERS", "groups": [ { "external_id": "weapons", "name": { "en": "Weapons" } } ], "description": "description" }, { "sku": "com.xsolla.shotgun_raider_2", "name": "SHOTGUN FOR TRUE RAIDERS", "groups": [], "description": "description" } ] } } } } } }, "Virtual-Items-Currency_200-get-virtual-currency-list": { "description": "인게임 재화 목록을 성공적으로 수신했습니다.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Virtual-Items-Currency_virtual-currency-list" }, "examples": { "response": { "value": { "has_more": false, "items": [ { "sku": "com.xsolla.crystal_1", "name": "Crystals", "groups": [ { "external_id": "game_currencies", "name": "VC", "item_order_in_group": 1 } ], "attributes": [ { "external_id": "attr1", "name": { "en-US": "Attribute" }, "values": [ { "external_id": "val1", "value": "Value" }, { "external_id": "val2", "value": "Value" } ] } ], "type": "virtual_currency", "description": "Crystals - short description", "image_url": "https://cdn3.xsolla.com/img/misc/images/da33ab6cc1d7e5899cfdc5b6b6180fad.png", "is_free": false, "price": { "amount": "100.99", "amount_without_discount": "100.99", "currency": "USD" }, "virtual_prices": [ { "amount": 100, "sku": "com.xsolla.vc_1", "is_default": true, "amount_without_discount": 100, "image_url": "http://image.png", "name": "Virtual currency name", "type": "virtual_currency", "description": "description" } ], "can_be_bought": true, "promotions": [], "limits": null, "periods": [ { "date_from": "2020-08-11T10:00:00+03:00", "date_until": "2020-08-11T20:00:00+03:00" } ], "custom_attributes": { "purchased": 0, "attr": "value" }, "vp_rewards": [] }, { "sku": "com.xsolla.emerald_1", "name": "Emeralds", "groups": [ { "external_id": "game_currencies", "name": "VC", "item_order_in_group": 2 } ], "attributes": [ { "external_id": "attr1", "name": { "en-US": "Attribute" }, "values": [ { "external_id": "val1", "value": "Value" }, { "external_id": "val2", "value": "Value" } ] }, { "external_id": "rating", "name": { "en": "Rating" }, "values": [ { "external_id": "rating_e3364991f92e751689a68b96598a5a5a84010b85", "value": "3.9" } ] } ], "type": "virtual_currency", "description": "Emeralds - short description", "image_url": "http://image.png", "is_free": false, "price": { "amount": "101.0", "amount_without_discount": "101.0", "currency": "USD" }, "virtual_prices": [], "can_be_bought": true, "promotions": [], "limits": null, "periods": [ { "date_from": null, "date_until": "2020-08-11T20:00:00+03:00" } ], "vp_rewards": [] }, { "sku": "com.xsolla.diamond_1", "name": "Diamonds", "groups": [], "attributes": [], "type": "virtual_currency", "description": "Diamonds - description", "image_url": "http://image.png", "is_free": true, "price": null, "virtual_prices": [], "can_be_bought": true, "promotions": [], "limits": null, "periods": [], "vp_rewards": [] } ] } } } } } }, "Virtual-Items-Currency_200-get-virtual-currency": { "description": "인게임 재화를 성공적으로 수신했습니다.", "content": { "application/json": { "examples": { "response": { "value": { "item_id": 451414, "sku": "com.xsolla.crystal_1", "type": "virtual_currency", "name": "Crystals", "description": "Crystals - short description", "image_url": "https://cdn3.xsolla.com/img/misc/images/da33ab6cc1d7e5899cfdc5b6b6180fad.png", "price": { "amount": "100", "amount_without_discount": "100", "currency": "USD" }, "virtual_prices": [], "can_be_bought": true, "promotions": [], "limits": null, "periods": [ { "date_from": "2023-08-11T10:00:00+03:00", "date_until": "2023-08-11T20:00:00+03:00" } ], "attributes": [ { "external_id": "attr1", "name": { "en-US": "Attribute" }, "values": [ { "external_id": "val1", "value": "Value" }, { "external_id": "val2", "value": "Value" } ] } ], "is_free": false, "groups": [], "custom_attributes": { "purchased": 0, "attr": "value" } } } }, "schema": { "$ref": "#/components/schemas/Virtual-Items-Currency_virtual-currency" } } } }, "Virtual-Items-Currency_200-get-virtual-currency-packages-list": { "description": "인게임 재화 패키지 목록을 성공적으로 수신했습니다.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Virtual-Items-Currency_virtual-currency-packages" }, "examples": { "response": { "value": { "has_more": false, "items": [ { "sku": "com.xsolla.vc_package_1", "name": "VC Name first package", "groups": [ { "external_id": "gift", "name": "Gift", "item_order_in_group": 1 } ], "attributes": [], "type": "bundle", "description": "VC Short Package Description", "image_url": "http://vc_package_image.png", "is_free": false, "price": { "amount": "2.0000", "amount_without_discount": "2.0000", "currency": "USD" }, "bundle_type": "virtual_currency_package", "content": [ { "description": "Crystals - short description", "image_url": "https://cdn3.xsolla.com/img/misc/images/da33ab6cc1d7e5899cfdc5b6b6180fad.png", "sku": "com.xsolla.crystal_1", "name": "Crystals", "type": "virtual_currency", "quantity": 100, "limits": null } ], "virtual_prices": [], "promotions": [ { "name": "Bonus promotion", "date_start": "2020-04-15T16:16:00+03:00", "date_end": "2026-04-15T16:16:00+03:00", "discount": { "percent": "50.00" }, "bonus": [ { "quantity": 1, "name": "Xsolla Minigun", "image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png", "sku": "com.xsolla.minigun_1", "type": "virtual_good" } ] } ], "limits": { "per_user": { "total": 5, "available": 3, "recurrent_schedule": { "interval_type": "weekly", "reset_next_date": 1746057600 }, "limit_exceeded_visibility": "show" } }, "can_be_bought": true, "periods": [ { "date_from": "2020-08-11T10:00:00+03:00", "date_until": "2020-08-11T20:00:00+03:00" } ], "custom_attributes": { "purchased": 0, "attr": "value" }, "vp_rewards": [] }, { "sku": "com.xsolla.vc_package_3", "name": "VC Name third package", "groups": [ { "external_id": "gift", "name": "Gift", "item_order_in_group": 2 } ], "attributes": [], "type": "bundle", "description": "VC Short Package Description", "image_url": "http://vc_package_image.png", "is_free": false, "price": { "amount": "4.0000", "amount_without_discount": "4.0000", "currency": "USD" }, "bundle_type": "virtual_currency_package", "content": [ { "description": "description", "image_url": "http://image.png", "sku": "com.xsolla.emerald_1", "name": "Emeralds", "type": "virtual_currency", "quantity": 200, "limits": null } ], "virtual_prices": [], "promotions": [ { "name": "Bonus promotion", "date_start": "2020-04-15T16:16:00+03:00", "date_end": "2026-04-15T16:16:00+03:00", "discount": { "percent": "50.00" }, "bonus": [ { "quantity": 1, "name": "Xsolla Minigun", "image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png", "sku": "com.xsolla.minigun_1", "type": "virtual_good" } ] } ], "limits": { "per_user": { "total": 5, "available": 3, "recurrent_schedule": { "interval_type": "weekly", "reset_next_date": 1746057600 }, "limit_exceeded_visibility": "show" } }, "can_be_bought": true, "periods": [ { "date_from": null, "date_until": "2020-08-11T20:00:00+03:00" } ], "vp_rewards": [] } ] } } } } } }, "Virtual-Items-Currency_200-get-virtual-currency-package": { "description": "인게임 재화 패키지를 성공적으로 수신했습니다.", "content": { "application/json": { "examples": { "response": { "value": { "item_id": 488832, "sku": "com.xsolla.crystal_pack_1", "type": "bundle", "name": "Crystal Pack", "bundle_type": "virtual_currency_package", "description": "Crystal Pack Short Description", "image_url": "http://vc_package_image.png", "price": { "amount": "100", "amount_without_discount": "100", "currency": "USD" }, "virtual_prices": [], "can_be_bought": true, "promotions": [], "limits": { "per_user": { "total": 1, "available": 1, "recurrent_schedule": { "interval_type": "weekly", "reset_next_date": 1690732800 }, "limit_exceeded_visibility": "show" }, "per_item": null }, "periods": [ { "date_from": "2020-08-11T10:00:00+03:00", "date_until": "2020-08-11T20:00:00+03:00" } ], "attributes": [], "is_free": false, "groups": [], "content": [ { "item_id": 488831, "sku": "com.xsolla.crystals_1", "type": "virtual_currency", "name": "Crystals", "description": "Crystal - short description", "image_url": "https://cdn.xsolla.net/items/crystal-pack.png", "quantity": 10, "limits": null } ], "vp_rewards": [], "custom_attributes": { "purchased": 0, "attr": "value" } } } }, "schema": { "$ref": "#/components/schemas/Virtual-Items-Currency_virtual-currency-package" } } } }, "Virtual-Items-Currency_200-get-items-by-group-id": { "description": "지정한 그룹의 아이템 목록을 성공적으로 수신했습니다.", "content": { "application/json": { "schema": { "type": "object", "properties": { "has_more": { "$ref": "#/components/schemas/Pagination_has-more" }, "items": { "type": "array", "example": [ { "sku": "com.xsolla.big_rocket_1", "name": "Big Rocket", "groups": [ { "external_id": "weapons", "name": "weapons" } ], "attributes": [ { "external_id": "stack_size", "name": "Stack size", "values": [ { "value": "5" } ] } ], "type": "virtual_good", "description": "Big Rocket - description", "image_url": "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png", "is_free": false, "price": { "amount": "100.99", "amount_without_discount": "100.99", "currency": "USD" }, "virtual_prices": [ { "amount": 100, "sku": "com.xsolla.vc_1", "is_default": true, "amount_without_discount": 100, "image_url": "http://image.png", "name": "SHOTGUN FOR TRUE RAIDERS", "type": "virtual_currency", "description": "description" } ], "can_be_bought": true, "virtual_item_type": "non_renewing_subscription", "promotions": [ { "name": "Bonus promotion", "date_start": "2020-04-15T16:16:00+03:00", "date_end": "2026-04-15T16:16:00+03:00", "discount": { "percent": "50.00" }, "bonus": [ { "quantity": 1, "name": "Xsolla Minigun", "image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png", "sku": "com.xsolla.minigun_1", "type": "virtual_good" } ] } ], "limits": { "per_user": { "total": 5, "available": 3, "recurrent_schedule": { "interval_type": "weekly", "reset_next_date": 1746057600 }, "limit_exceeded_visibility": "show" }, "per_item": null }, "periods": [ { "date_from": "2020-08-11T10:00:00+03:00", "date_until": "2020-08-11T20:00:00+03:00" } ] }, { "sku": "com.xsolla.shotgun_raider", "name": "SHOTGUN FOR TRUE RAIDERS", "groups": [ { "external_id": "weapons", "name": { "en": "weapons" } } ], "attributes": [ { "external_id": "stack_size", "name": "Stack size", "values": [ { "value": "5" } ] }, { "external_id": "rating", "name": "Rating", "values": [ { "value": "3.9" } ] }, { "external_id": "genre", "name": "Genre", "values": [ { "value": "Strategy" }, { "value": "Tactical" }, "Turn-based" ] } ], "type": "virtual_good", "description": "description", "image_url": "http://image.png", "is_free": false, "price": { "amount": "101.0", "amount_without_discount": "101.0", "currency": "USD" }, "virtual_prices": [ { "amount": 100, "sku": "com.xsolla.vc_1", "is_default": true, "amount_without_discount": 100, "image_url": "http://image.png", "name": "SHOTGUN FOR TRUE RAIDERS", "type": "virtual_currency", "description": "description" }, { "amount": 200, "sku": "com.xsolla.vc_2", "is_default": false, "amount_without_discount": 200, "image_url": "http://image.png", "name": "SHOTGUN FOR TRUE RAIDERS", "type": "virtual_currency", "description": "description" } ], "can_be_bought": true, "virtual_item_type": "non_renewing_subscription", "promotions": [], "limits": null, "periods": [] } ], "items": { "type": "object", "properties": { "sku": { "type": "string", "example": "com.xsolla.big_rocket_1", "description": "고유 아이템 ID입니다. SKU는 소문자 및 대문자 라틴 영숫자, 마침표, 대시 및 밑줄만 포함할 수 있습니다." }, "name": { "type": "string", "example": "Big Rocket", "description": "아이템 이름입니다." }, "groups": { "$ref": "#/components/schemas/items_client_groups_response" }, "attributes": { "$ref": "#/components/schemas/Virtual-Items-Currency_client-attributes" }, "type": { "type": "string", "example": "virtual_good", "description": "아이템의 유형: `consumable`/`expiration`/`permanent`/`lootboxes`/`physical`." }, "description": { "type": "string", "example": "Big Rocket - description", "description": "아이템 설명입니다." }, "image_url": { "type": "string", "example": "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png", "description": "이미지 URL입니다." }, "is_free": { "$ref": "#/components/schemas/value-is_free" }, "price": { "type": "object", "description": "아이템 가격입니다.", "properties": { "amount": { "type": "string", "example": "100.99", "description": "할인된 아이템 가격입니다." }, "amount_without_discount": { "type": "string", "example": "100.99", "description": "아이템 가격입니다." }, "currency": { "type": "string", "example": "USD", "description": "아이템 가격 통화입니다. [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)에 따른 3자리 코드입니다." } } }, "virtual_prices": { "$ref": "#/components/schemas/client_virtual_prices_response" }, "can_be_bought": { "$ref": "#/components/schemas/Can_be_bought" }, "virtual_item_type": { "type": "string", "example": "non_consumable", "description": "가상 아이템의 유형입니다.\n\n사용 가능한 값: - `consumable` - 사용 후 인벤토리에서 사라지는 아이템(예: 탄약). - `non_consumable` - 인벤토리에 무기한으로 남아 있는 아이템. - `non_renewing_subscription` - 일정 기간 동안 서비스나 콘텐츠에 대한 이용 권한을 나타낼 수 있는 기간 한정 아이템.", "enum": [ "consumable", "non_consumable", "non_renewing_subscription" ] }, "promotions": { "$ref": "#/components/schemas/Catalog_item_promotions" }, "limits": { "$ref": "#/components/schemas/Catalog_item_limits" }, "periods": { "$ref": "#/components/schemas/item-periods-response" }, "custom_attributes": { "$ref": "#/components/schemas/item-custom-attributes-response" }, "vp_rewards": { "$ref": "#/components/schemas/client-item-value-point-reward" } } } } } }, "examples": { "response": { "value": { "has_more": false, "items": [ { "sku": "com.xsolla.big_rocket_1", "name": "Big Rocket", "groups": [ { "external_id": "weapons", "name": "weapons", "item_order_in_group": 1 } ], "attributes": [ { "external_id": "stack_size", "name": { "en": "Stack size" }, "values": [ { "external_id": "size_e3364991f92e751689a68b96598a5a5a84010b85", "value": "5" } ] } ], "type": "virtual_good", "description": "Big Rocket - description", "image_url": "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png", "is_free": false, "price": { "amount": "100.99", "amount_without_discount": "100.99", "currency": "USD" }, "virtual_prices": [ { "amount": 100, "sku": "com.xsolla.vc_1", "is_default": true, "amount_without_discount": 100, "image_url": "http://image.png", "name": "SHOTGUN FOR TRUE RAIDERS", "type": "virtual_currency", "description": "description" } ], "can_be_bought": true, "virtual_item_type": "non_renewing_subscription", "promotions": [ { "name": "Bonus promotion", "date_start": "2020-04-15T16:16:00+03:00", "date_end": "2026-04-15T16:16:00+03:00", "discount": { "percent": "50.00" }, "bonus": [ { "quantity": 1, "name": "Xsolla Minigun", "image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png", "sku": "com.xsolla.minigun_1", "type": "virtual_good" } ] } ], "limits": { "per_user": { "total": 5, "available": 3, "recurrent_schedule": { "interval_type": "weekly", "reset_next_date": 1746057600 }, "limit_exceeded_visibility": "show" } }, "periods": [ { "date_from": "2020-08-11T10:00:00+03:00", "date_until": "2020-08-11T20:00:00+03:00" } ], "custom_attributes": { "purchased": 0, "attr": "value" }, "vp_rewards": [ { "item_id": 175232, "sku": "com.xsolla.value_point_1", "amount": 130, "name": "Value point", "image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg" }, { "item_id": 186321, "sku": "com.xsolla.clan_value_point_1", "amount": 50, "name": "Clan Reward VP 1", "image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg", "is_clan": true } ] }, { "sku": "com.xsolla.shotgun_raider_1", "name": "SHOTGUN FOR TRUE RAIDERS", "groups": [ { "external_id": "weapons", "name": "weapons", "item_order_in_group": 2 } ], "attributes": [ { "external_id": "stack_size", "name": { "en": "Stack size" }, "values": [ { "external_id": "size_e3364991f92e751689a68b96598a5a5a84010b85", "value": "5" } ] }, { "external_id": "rating", "name": { "en": "Rating" }, "values": [ { "external_id": "rating_e3364991f92e751689a68b96598a5a5a84010b85", "value": "3.9" } ] } ], "type": "virtual_good", "description": "description", "image_url": "http://image.png", "is_free": false, "price": { "amount": "101.0", "amount_without_discount": "101.0", "currency": "USD" }, "virtual_prices": [ { "amount": 100, "sku": "com.xsolla.vc_1", "is_default": true, "amount_without_discount": 100, "image_url": "http://image.png", "name": "SHOTGUN FOR TRUE RAIDERS", "type": "virtual_currency", "description": "description" }, { "amount": 200, "sku": "com.xsolla.vc_2", "is_default": false, "amount_without_discount": 200, "image_url": "http://image.png", "name": "SHOTGUN FOR TRUE RAIDERS", "type": "virtual_currency", "description": "description" } ], "can_be_bought": true, "virtual_item_type": "non_renewing_subscription", "promotions": [ { "name": "Bonus promotion", "date_start": "2020-04-15T16:16:00+03:00", "date_end": "2026-04-15T16:16:00+03:00", "discount": { "percent": "50.00" }, "bonus": [ { "quantity": 1, "name": "Xsolla Minigun", "image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png", "sku": "com.xsolla.minigun_1", "type": "virtual_good" } ] } ], "limits": { "per_user": { "total": 5, "available": 3, "recurrent_schedule": { "interval_type": "weekly", "reset_next_date": 1746057600 }, "limit_exceeded_visibility": "show" } }, "periods": [], "vp_rewards": [] } ] } } } } } }, "Virtual-Items-Currency_404-item-group": { "description": "그룹을 찾을 수 없습니다. `external_id`이 올바르고 그룹이 꺼져 있거나 삭제되지 않았는지 확인해야 합니다.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "description": "HTTP 응답 상태 코드입니다.", "example": 404 }, "errorCode": { "type": "integer", "description": "엑솔라 오류 코드", "example": 4403 }, "errorMessage": { "type": "string", "description": "간단한 오류 설명.", "example": "[0401-4403]: Item group not found" } } }, "examples": { "response": { "value": { "statusCode": 404, "errorCode": 4403, "errorMessage": "[0401-4403]: Item group not found" } } } } } }, "Virtual-Items-Currency_200-get-virtual-currency-by-group-id": { "description": "지정된 그룹의 인게임 재화 목록을 성공적으로 수신했습니다.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Virtual-Items-Currency_virtual-currency-list" }, "examples": { "response": { "value": { "has_more": false, "items": [ { "sku": "com.xsolla.crystal_1", "name": "Crystals", "groups": [ { "external_id": "game_currencies", "name": "VC", "item_order_in_group": 1 } ], "attributes": [ { "external_id": "attr1", "name": { "en-US": "Attribute" }, "values": [ { "external_id": "val1", "value": "Value" }, { "external_id": "val2", "value": "Value" } ] } ], "type": "virtual_currency", "description": "Crystals - short description", "image_url": "https://cdn3.xsolla.com/img/misc/images/da33ab6cc1d7e5899cfdc5b6b6180fad.png", "is_free": false, "price": { "amount": "100.99", "amount_without_discount": "100.99", "currency": "USD" }, "virtual_prices": [ { "amount": 100, "sku": "com.xsolla.vc_1", "is_default": true, "amount_without_discount": 100, "image_url": "http://image.png", "name": "Virtual currency name", "type": "virtual_currency", "description": "description" } ], "can_be_bought": true, "promotions": [], "limits": null, "periods": [ { "date_from": "2020-08-11T10:00:00+03:00", "date_until": "2020-08-11T20:00:00+03:00" } ], "custom_attributes": { "purchased": 0, "attr": "value" }, "vp_rewards": [] }, { "sku": "com.xsolla.emerald_1", "name": "Emeralds", "groups": [ { "external_id": "game_currencies", "name": "VC", "item_order_in_group": 2 } ], "attributes": [ { "external_id": "attr1", "name": { "en-US": "Attribute" }, "values": [ { "external_id": "val1", "value": "Value" }, { "external_id": "val2", "value": "Value" } ] }, { "external_id": "rating", "name": { "en": "Rating" }, "values": [ { "external_id": "rating_e3364991f92e751689a68b96598a5a5a84010b85", "value": "3.9" } ] } ], "type": "virtual_currency", "description": "Emeralds - short description", "image_url": "http://image.png", "is_free": false, "price": { "amount": "101.0", "amount_without_discount": "101.0", "currency": "USD" }, "virtual_prices": [], "can_be_bought": true, "promotions": [], "limits": null, "periods": [ { "date_from": null, "date_until": "2020-08-11T20:00:00+03:00" } ], "vp_rewards": [] } ] } } } } } }, "Virtual-Items-Currency_200-get-virtual-currency-packages-by-group-id": { "description": "지정된 그룹의 인게임 재화 패키지 목록을 성공적으로 수신했습니다.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Virtual-Items-Currency_virtual-currency-packages" }, "examples": { "response": { "value": { "has_more": false, "items": [ { "sku": "com.xsolla.vc_package_1", "name": "VC Name first package", "groups": [ { "external_id": "gift", "name": "Gift", "item_order_in_group": 1 } ], "attributes": [], "type": "bundle", "description": "VC Short Package Description", "image_url": "http://vc_package_image.png", "is_free": false, "price": { "amount": "2.0000", "amount_without_discount": "2.0000", "currency": "USD" }, "bundle_type": "virtual_currency_package", "content": [ { "description": "Crystals - short description", "image_url": "https://cdn3.xsolla.com/img/misc/images/da33ab6cc1d7e5899cfdc5b6b6180fad.png", "sku": "com.xsolla.crystal_1", "name": "Crystals", "type": "virtual_currency", "quantity": 100, "limits": null } ], "virtual_prices": [], "promotions": [ { "name": "Bonus promotion", "date_start": "2020-04-15T16:16:00+03:00", "date_end": "2026-04-15T16:16:00+03:00", "discount": { "percent": "50.00" }, "bonus": [ { "quantity": 1, "name": "Xsolla Minigun", "image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png", "sku": "com.xsolla.minigun_1", "type": "virtual_good" } ] } ], "limits": { "per_user": { "total": 5, "available": 3, "recurrent_schedule": { "interval_type": "weekly", "reset_next_date": 1746057600 }, "limit_exceeded_visibility": "show" } }, "can_be_bought": true, "periods": [ { "date_from": "2020-08-11T10:00:00+03:00", "date_until": "2020-08-11T20:00:00+03:00" } ], "custom_attributes": { "purchased": 0, "attr": "value" }, "vp_rewards": [] }, { "sku": "com.xsolla.vc_package_3", "name": "VC Name third package", "groups": [ { "external_id": "gift", "name": "Gift", "item_order_in_group": 2 } ], "attributes": [], "type": "bundle", "description": "VC Short Package Description", "image_url": "http://vc_package_image.png", "is_free": false, "price": { "amount": "4.0000", "amount_without_discount": "4.0000", "currency": "USD" }, "bundle_type": "virtual_currency_package", "content": [ { "description": "description", "image_url": "http://image.png", "sku": "com.xsolla.emerald_1", "name": "Emeralds", "type": "virtual_currency", "quantity": 200, "limits": null } ], "virtual_prices": [], "promotions": [ { "name": "Bonus promotion", "date_start": "2020-04-15T16:16:00+03:00", "date_end": "2026-04-15T16:16:00+03:00", "discount": { "percent": "50.00" }, "bonus": [ { "quantity": 1, "name": "Xsolla Minigun", "image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png", "sku": "com.xsolla.minigun_1", "type": "virtual_good" } ] } ], "limits": { "per_user": { "total": 5, "available": 3, "recurrent_schedule": { "interval_type": "weekly", "reset_next_date": 1746057600 }, "limit_exceeded_visibility": "show" } }, "can_be_bought": true, "periods": [ { "date_from": null, "date_until": "2020-08-11T20:00:00+03:00" } ], "vp_rewards": [] } ] } } } } } }, "Virtual-Items-Currency_200-get-items-groups": { "description": "그룹 목록을 성공적으로 수신했습니다.", "content": { "application/json": { "schema": { "type": "object", "properties": { "groups": { "type": "array", "example": [ { "external_id": "weapons", "name": "Weapons", "description": "All weapons available in the game", "image_url": null, "order": 1 }, { "external_id": "group_external_id", "name": "Super", "description": "Super description", "image_url": null, "order": 1 } ], "items": { "type": "object", "properties": { "external_id": { "type": "string", "example": "weapons", "description": "외부 그룹 ID입니다." }, "name": { "type": "string", "example": "Weapons", "description": "그룹 이름입니다." }, "description": { "type": "string", "example": "All weapons available in the game", "description": "그룹 설명입니다." }, "image_url": { "type": [ "string", "null" ], "example": null, "description": "이미지 URL입니다." }, "order": { "type": "integer", "example": 1, "description": "배열 순서를 정의합니다." }, "level": { "type": "integer", "example": 0, "description": "그룹 중첩 수준입니다." }, "children": { "type": "array", "example": [ { "external_id": "background", "name": "Background", "description": "Background description", "image_url": null, "order": 1, "level": 1, "children": [ { "external_id": "accessory", "name": "Accessory", "description": "Accessory", "image_url": null, "order": 1, "level": 2, "children": [], "parent_external_id": "background" } ], "parent_external_id": "weapons" } ], "description": "하위 그룹입니다.", "items": { "type": "object", "properties": { "external_id": { "type": "string", "example": "background", "description": "외부 그룹 ID입니다." }, "name": { "type": "string", "example": "Background", "description": "그룹 이름입니다." }, "description": { "type": "string", "example": "Background description", "description": "그룹 설명입니다." }, "image_url": { "type": [ "string", "null" ], "example": null, "description": "그룹 이미지 URL입니다." }, "order": { "type": "integer", "example": 1, "description": "배열 순서를 정의합니다." }, "level": { "type": "integer", "example": 1, "description": "그룹 중첩 수준입니다." }, "children": { "type": "array", "example": [ { "external_id": "accessory", "name": "Accessory", "description": "Accessory", "image_url": null, "order": 1, "level": 2, "children": [], "parent_external_id": "background" } ], "description": "하위 그룹입니다.", "items": { "type": "object", "properties": { "external_id": { "type": "string", "example": "accessory", "description": "외부 그룹 ID입니다." }, "name": { "type": "string", "example": "Accessory", "description": "그룹 이름입니다." }, "description": { "type": "string", "example": "Accessory", "description": "그룹 설명입니다." }, "image_url": { "type": [ "string", "null" ], "example": null, "description": "이미지 URL입니다." }, "order": { "type": "integer", "example": 1, "description": "배열 순서를 정의합니다." }, "level": { "type": "integer", "example": 2, "description": "그룹 중첩 수준입니다." }, "children": { "type": "array", "example": [], "description": "하위 그룹입니다.", "items": { "type": "string" } }, "parent_external_id": { "type": [ "string", "null" ], "example": "background", "description": "상위 외부 그룹 ID입니다." } } } }, "parent_external_id": { "type": [ "string", "null" ], "example": "weapons", "description": "상위 외부 그룹 ID입니다." } } } }, "parent_external_id": { "type": [ "string", "null" ], "example": null, "description": "상위 외부 그룹 ID입니다." } } } } } }, "examples": { "response": { "value": { "groups": [ { "external_id": "weapons", "name": "Weapons", "description": "All weapons available in the game", "image_url": "https://example.com/groups/weapons.png", "order": 1 }, { "external_id": "armor", "name": "Armor", "description": "Protective equipment", "image_url": "https://example.com/groups/armor.png", "order": 2 }, { "external_id": "consumables", "name": "Consumables", "description": "Potions, food, and other single-use items", "image_url": null, "order": 3 } ] } } } } } }, "ItemGroup_200-admin-get-group-list": { "description": "아이템 그룹 목록을 성공적으로 검색했습니다.", "content": { "application/json": { "schema": { "type": "object", "properties": { "groups": { "type": "array", "items": { "$ref": "#/components/schemas/admin-group-response-base" } } } }, "examples": { "response": { "$ref": "#/components/examples/200-admin-get-group-list" } } } } }, "ItemGroup_401-invalid-basic-auth": { "description": "기본 인증에 실패했거나 잘못된 자격 증명이 입력되었습니다. 기본 인증을 사용하고 올바른 자격 증명을 입력했는지 확인하십시오.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response-base" }, "examples": { "response": { "value": { "statusCode": 401, "errorCode": 1020, "errorMessage": "[0401-1020]: Error in Authentication method occurred", "transactionId": "x-x-x-x-transactionId-mock-x-x-x" } } } } } }, "ItemGroup_201-admin-create-group": { "description": "아이템 그룹을 성공적으로 생성했습니다.", "content": { "application/json": { "schema": { "type": "object", "properties": { "external_id": { "type": "string", "description": "생성 시 지정된 외부 아이템 그룹 ID입니다.", "example": "weapons" } } }, "examples": { "response": { "$ref": "#/components/examples/201-admin-create-group" } } } } }, "ItemGroup_422-create-update": { "description": "요청을 처리할 수 없습니다. 유효성 검사 오류를 위해 반환되거나 데이터가 시스템 규칙에 위배됩니다.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ItemGroup_422-invalid-request" }, "examples": { "The property `external_id` is required": { "$ref": "#/components/examples/422-property-external-id-required" }, "Group already exists": { "value": { "statusCode": 422, "errorCode": 4401, "errorMessage": "[0401-4401]: Item group already exists", "transactionId": "x-x-x-x-transactionId-mock-x-x-x" } }, "Group cannot be its own parent": { "value": { "statusCode": 422, "errorCode": 4404, "errorMessage": "[0401-4404]: Group can't be self parent", "transactionId": "x-x-x-x-transactionId-mock-x-x-x" } }, "Reserved external_id value": { "value": { "statusCode": 422, "errorCode": 4516, "errorMessage": "[0401-4516]: Value 'tools' not allowed to be used for the property 'external_id'.", "transactionId": "x-x-x-x-transactionId-mock-x-x-x" } } } } } }, "ItemGroup_200-admin-get-group": { "description": "아이템 그룹을 성공적으로 생성했습니다.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/admin-group-response-base" }, "examples": { "response": { "$ref": "#/components/examples/200-admin-get-group" } } } } }, "ItemGroup_404-group-not-found": { "description": "아이템 그룹을 찾을 수 없습니다. 지정된 `external_id`가 있는 그룹이 존재하지 않거나 또다른 프로젝트에 속한 경우 반환됩니다.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/error-response-base" }, { "type": "object", "properties": { "errorMessageExtended": { "type": [ "object", "null" ], "description": "실패한 조회에 사용되는 ID입니다.", "properties": { "project_id": { "type": "integer", "description": "조회 요청 시 사용되는 프로젝트 ID입니다." }, "external_id_list": { "type": "array", "description": "조회 요청 시 사용되는 그룹 목록 `external_id`입니다.", "items": { "type": "string" } }, "group_id_list": { "type": "array", "description": "조회 요청 시 사용되는 그룹 목록 `id`입니다.", "items": { "type": "integer" } } } } } } ] }, "examples": { "Group not found by external_id": { "value": { "statusCode": 404, "errorCode": 4403, "errorMessage": "[0401-4403]: Group with external id = 'weapons' not found", "transactionId": "x-x-x-x-transactionId-mock-x-x-x", "errorMessageExtended": { "project_id": 123, "external_id_list": [ "weapons" ] } } }, "Group not found by ID": { "value": { "statusCode": 404, "errorCode": 4403, "errorMessage": "[0401-4403]: Group with id in (99) and projectId = 123 not found", "transactionId": "x-x-x-x-transactionId-mock-x-x-x", "errorMessageExtended": { "project_id": 123, "group_id_list": [ 99 ] } } }, "Items or group not found (reorder endpoints)": { "value": { "statusCode": 404, "errorCode": 4403, "errorMessage": "[0401-4403]: Items or group were not found.", "transactionId": "x-x-x-x-transactionId-mock-x-x-x", "errorMessageExtended": {} } } } } } }, "ItemGroup_204-admin-update-group": { "description": "아이템 그룹을 성공적으로 업데이트했습니다." }, "ItemGroup_204-admin-delete-group": { "description": "아이템 그룹을 성공적으로 삭제했습니다." }, "ItemGroup_422-delete": { "description": "요청을 처리할 수 없습니다. 아이템을 포함하는 그룹을 삭제할 수 없습니다.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ItemGroup_422-invalid-request" }, "examples": { "Cannot delete group with items": { "value": { "statusCode": 422, "errorCode": 4402, "errorMessage": "[0401-4402]: Item group with items cannot be deleted.", "transactionId": "x-x-x-x-transactionId-mock-x-x-x" } } } } } }, "ItemGroup_200-admin-get-group-list-by-item-type": { "description": "아이템 그룹을 성공적으로 검색했습니다. `items_count` 입력란은 지정된 유형의 아이템만 포함합니다.", "content": { "application/json": { "schema": { "type": "object", "properties": { "groups": { "type": "array", "items": { "$ref": "#/components/schemas/admin-group-response-by-item-type" } } } }, "examples": { "response": { "$ref": "#/components/examples/200-admin-get-group-list-by-item-type" } } } } }, "ItemGroup_200-admin-get-group-by-item-type": { "description": "지정된 아이템 유형으로 필터링한 `items_count`를 통해 아이템 그룹을 성공적으로 검색했습니다.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/admin-group-detail-response-by-item-type" }, "examples": { "response": { "$ref": "#/components/examples/200-admin-get-group-by-item-type" } } } } }, "ItemGroup_204-admin-reorder-groups": { "description": "아이템 그룹을 성공적으로 재주문했습니다" }, "ItemGroup_404-reorder-groups-not-found": { "description": "아이템 그룹을 찾을 수 없습니다. 지정된 `id` 또는 `external_id`가 있는 그룹이 존재하지 않거나 또 다른 프로젝트에 속한 경우 반환됩니다.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/error-response-base" }, { "type": "object", "properties": { "errorMessageExtended": { "type": [ "object", "null" ], "description": "실패한 조회에 사용되는 ID입니다.", "properties": { "project_id": { "type": "integer", "description": "조회 요청 시 사용되는 프로젝트 ID입니다." }, "external_id_list": { "type": "array", "description": "조회 요청 시 사용되는 그룹 목록 `external_id`입니다.", "items": { "type": "string" } }, "group_id_list": { "type": "array", "description": "조회 요청 시 사용되는 그룹 목록 `id`입니다.", "items": { "type": "integer" } } } } } } ] }, "examples": { "Group not found by external_id": { "value": { "statusCode": 404, "errorCode": 4403, "errorMessage": "[0401-4403]: Group with external id = 'weapons' not found", "transactionId": "x-x-x-x-transactionId-mock-x-x-x", "errorMessageExtended": { "project_id": 123, "external_id_list": [ "weapons" ] } } }, "Group not found by ID": { "value": { "statusCode": 404, "errorCode": 4403, "errorMessage": "[0401-4403]: Group with id in (99) and projectId = 123 not found", "transactionId": "x-x-x-x-transactionId-mock-x-x-x", "errorMessageExtended": { "project_id": 123, "group_id_list": [ 99 ] } } } } } } }, "ItemGroup_422-ordering": { "description": "요청을 처리할 수 없습니다. 요청 본문의 유효성 검사에 실패했습니다.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ItemGroup_422-invalid-request" }, "examples": { "Invalid request body": { "value": { "statusCode": 422, "errorCode": 1102, "errorMessage": "[0401-1102]: Unprocessable Entity", "transactionId": "x-x-x-x-transactionId-mock-x-x-x", "errorMessageExtended": [ { "property": "", "message": "Object value found, but an array is required" } ] } } } } } }, "ItemGroup_204-admin-reorder-items": { "description": "그룹 내 아이템 순서가 성공적으로 재정렬되었습니다." }, "ItemGroup_404-reorder-items-by-external-id-not-found": { "description": "아이템 그룹 또는 아이템을 찾을 수 없습니다. 지정된 `external_id`를 갖는 그룹이 존재하지 않거나 다른 프로젝트에 속해 있는 경우, 또는 해당 그룹에서 하나 이상의 `item_id`를 찾을 수 없는 경우 이 오류가 반환됩니다.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/error-response-base" }, { "type": "object", "properties": { "errorMessageExtended": { "type": [ "object", "null" ], "description": "실패한 조회에 사용되는 ID입니다.", "properties": { "project_id": { "type": "integer", "description": "조회 요청 시 사용되는 프로젝트 ID입니다." }, "external_id_list": { "type": "array", "description": "조회 요청 시 사용되는 그룹 목록 `external_id`입니다.", "items": { "type": "string" } } } } } } ] }, "examples": { "Items or group not found": { "value": { "statusCode": 404, "errorCode": 4403, "errorMessage": "[0401-4403]: Items or group were not found.", "transactionId": "x-x-x-x-transactionId-mock-x-x-x", "errorMessageExtended": {} } } } } } }, "ItemGroup_404-reorder-items-by-id-not-found": { "description": "아이템 그룹 또는 아이템을 찾을 수 없습니다. 지정된 `id`를 갖는 그룹이 존재하지 않거나 다른 프로젝트에 속해 있는 경우, 또는 해당 그룹에서 하나 이상의 `item_id`를 찾을 수 없는 경우 이 오류가 반환됩니다.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/error-response-base" }, { "type": "object", "properties": { "errorMessageExtended": { "type": [ "object", "null" ], "description": "실패한 조회에 사용되는 ID입니다.", "properties": { "project_id": { "type": "integer", "description": "조회 요청 시 사용되는 프로젝트 ID입니다." }, "group_id_list": { "type": "array", "description": "조회 요청 시 사용되는 그룹 목록 `id`입니다.", "items": { "type": "integer" } } } } } } ] }, "examples": { "Items or group not found": { "value": { "statusCode": 404, "errorCode": 4403, "errorMessage": "[0401-4403]: Items or group were not found.", "transactionId": "x-x-x-x-transactionId-mock-x-x-x", "errorMessageExtended": {} } } } } } }, "Virtual-Items-Currency_200-quick-purchase": { "description": "성공한 빠른 가상 구매입니다.", "content": { "application/json": { "schema": { "type": "object", "properties": { "order_id": { "type": "integer", "description": "주문 ID입니다." } } }, "examples": { "response": { "value": { "order_id": 641 } } } } } }, "Virtual-Items-Currency_422-not-enough-virtual-currency": { "description": "인게임 재화가 부족합니다.", "content": { "application/json": { "schema": { "type": "object", "properties": { "errorCode": { "type": "integer", "example": 5006 }, "statusCode": { "type": "integer", "example": 422 }, "errorMessage": { "type": "string", "example": "[0401-5006]: Not enough virtual currency" } } }, "examples": { "response": { "value": { "errorCode": 5006, "statusCode": 422, "errorMessage": "[0401-5006]: Not enough virtual currency" } } } } } }, "Game-Keys_200-get-games-catalog": { "description": "게임 목록을 성공적으로 수신했습니다.", "content": { "application/json": { "schema": { "type": "object", "description": "게임이 있는 개체입니다.", "properties": { "has_more": { "$ref": "#/components/schemas/Pagination_has-more" }, "items": { "type": "array", "example": [ { "sku": "com.xsolla.game_1", "name": "Game name", "groups": [ { "external_id": "all", "name": "All games" }, { "external_id": "Xsolla", "name": "Xsolla games" } ], "type": "unit", "unit_type": "game", "description": "Game description", "image_url": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png", "attributes": [ { "external_id": "genre", "name": "Genre", "values": [ { "external_id": "23fda05111c125608af8f1fa0e99db45a10ea1cc", "value": "Horror" } ] } ], "promotions": [], "unit_items": [ { "sku": "com.xsolla.game_key_01", "type": "game_key", "is_free": false, "price": { "amount": "30.5", "amount_without_discount": "30.5", "currency": "USD" }, "virtual_prices": [], "can_be_bought": true, "drm_name": "Steam", "drm_sku": "steam_key_1", "has_keys": true, "is_pre_order": true, "release_date": "2020-08-11T10:00:00+03:00", "promotions": [], "periods": [ { "date_from": "2020-08-11T10:00:00+03:00", "date_until": "2020-08-11T20:00:00+03:00" } ] }, { "sku": "com.xsolla.game_key_02", "type": "game_key", "is_free": false, "price": { "amount": "30.5", "amount_without_discount": "30.5", "currency": "USD" }, "virtual_prices": [], "can_be_bought": true, "drm_name": "Origin", "drm_sku": "origin_key_1", "has_keys": false, "is_pre_order": false, "release_date": null, "promotions": [], "periods": [] } ] }, { "sku": "com.xsolla.game_2", "name": "Game name", "groups": [ { "external_id": "all", "name": "All games" } ], "type": "unit", "unit_type": "game", "description": "Game description", "image_url": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png", "attributes": [ { "external_id": "OS", "name": "OS", "values": [ { "external_id": "9d5c5efb7c0f00a00fe4e3583f1215b0050bc723", "value": "Windows" } ] } ], "promotions": [], "unit_items": [ { "sku": "com.xsolla.game_key_01", "type": "game_key", "is_free": false, "price": { "amount": "30.5", "amount_without_discount": "30.5", "currency": "USD" }, "virtual_prices": [], "can_be_bought": true, "drm_name": "Steam", "drm_sku": "steam_key_2", "has_keys": false, "is_pre_order": false, "release_date": null, "promotions": [], "periods": [ { "date_from": null, "date_until": "2020-08-11T20:00:00+03:00" } ] } ] } ], "items": { "type": "object", "properties": { "sku": { "type": "string", "example": "game_01", "description": "고유 아이템 ID입니다. SKU는 소문자 및 대문자 라틴 영숫자, 마침표, 대시 및 밑줄만 포함할 수 있습니다." }, "name": { "type": "string", "example": "Game name", "description": "아이템 이름입니다." }, "groups": { "$ref": "#/components/schemas/items_client_groups_response" }, "attributes": { "$ref": "#/components/schemas/Game-Keys_schemas-client-attributes" }, "type": { "type": "string", "example": "unit", "description": "아이템의 유형: `virtual_good`/`virtual_currency`/`bundle`/`physical_good`/`unit`." }, "unit_type": { "type": "string", "example": "game", "description": "유닛의 유형: `game`." }, "description": { "type": "string", "example": "Game description", "description": "아이템 설명입니다." }, "image_url": { "type": "string", "example": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png", "description": "이미지 URL입니다." }, "promotions": { "$ref": "#/components/schemas/Catalog_item_promotions" }, "unit_items": { "type": "array", "items": { "type": "object", "properties": { "sku": { "type": "string", "example": "game_01", "description": "고유 아이템 ID입니다. SKU는 소문자 및 대문자 라틴 영숫자, 마침표, 대시 및 밑줄만 포함할 수 있습니다." }, "type": { "type": "string", "example": "game_key", "description": "아이템의 유형: `game_key`." }, "is_free": { "$ref": "#/components/schemas/value-is_free" }, "price": { "type": "object", "description": "아이템 가격입니다.", "properties": { "amount": { "type": "string", "example": "2.9900", "description": "할인된 아이템 가격입니다." }, "amount_without_discount": { "type": "string", "example": "2.9900", "description": "아이템 가격입니다." }, "currency": { "type": "string", "example": "USD", "description": "아이템 가격 통화입니다. [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)에 따른 3자리 코드입니다." } } }, "virtual_prices": { "$ref": "#/components/schemas/client_virtual_prices_response" }, "can_be_bought": { "$ref": "#/components/schemas/Can_be_bought" }, "drm_name": { "type": "string", "example": "Steam", "description": "DRM 이름입니다." }, "drm_sku": { "type": "string", "example": "steam", "description": "고유 DRM ID입니다. SKU는 소문자 및 대문자 라틴 영숫자, 마침표, 대시 및 밑줄만 포함할 수 있습니다." }, "has_keys": { "type": "boolean", "example": false, "description": "`true`인 경우 게임 키에 판매용 키가 있습니다." }, "is_pre_order": { "type": "boolean", "example": true, "description": "`true`인 경우 사전 판매 게임 키이며 출시 날짜가 전달되지 않은 상태입니다." }, "release_date": { "type": [ "string", "null" ], "example": "2020-08-11T10:00:00+03:00", "description": "ISO 8601 형식으로 된 게임 키 출시 날짜입니다." }, "promotions": { "$ref": "#/components/schemas/Catalog_item_promotions" }, "periods": { "$ref": "#/components/schemas/item-periods" }, "vp_rewards": { "$ref": "#/components/schemas/client-item-value-point-reward" } } } } } } } } }, "examples": { "response": { "value": { "has_more": false, "items": [ { "sku": "com.xsolla.game_1", "name": "Game name", "groups": [ { "external_id": "all", "name": "All games", "item_order_in_group": 2 }, { "external_id": "Xsolla", "name": "Xsolla games", "item_order_in_group": 1 } ], "type": "unit", "unit_type": "game", "description": "Game description", "image_url": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png", "attributes": [ { "external_id": "genre", "name": "Genre", "values": [ { "external_id": "23fda05111c125608af8f1fa0e99db45a10ea1cc", "value": "Horror" } ] } ], "promotions": [], "unit_items": [ { "sku": "com.xsolla.game_key_01", "type": "game_key", "is_free": false, "price": { "amount": "30.5", "amount_without_discount": "30.5", "currency": "USD" }, "virtual_prices": [], "can_be_bought": true, "drm_name": "Steam", "drm_sku": "steam_key_1", "has_keys": true, "is_pre_order": true, "release_date": "2020-08-11T10:00:00+03:00", "periods": [ { "date_from": "2020-08-11T10:00:00+03:00", "date_until": "2020-08-11T20:00:00+03:00" } ], "vp_rewards": [ { "item_id": 175232, "sku": "com.xsolla.value_point_1", "amount": 130, "name": "Value point", "image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg" }, { "item_id": 186321, "sku": "com.xsolla.clan_value_point_1", "amount": 50, "name": "Clan Reward VP 1", "image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg", "is_clan": true } ] }, { "sku": "com.xsolla.game_key_02", "type": "game_key", "is_free": false, "price": { "amount": "30.5", "amount_without_discount": "30.5", "currency": "USD" }, "virtual_prices": [], "can_be_bought": true, "drm_name": "Origin", "drm_sku": "origin_key_1", "has_keys": false, "is_pre_order": false, "release_date": null, "periods": [], "vp_rewards": [] } ] }, { "sku": "com.xsolla.game_2", "name": "Game name", "groups": [ { "external_id": "all", "name": "All games", "item_order_in_group": 1 } ], "type": "unit", "unit_type": "game", "description": "Game description", "image_url": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png", "attributes": [ { "external_id": "OS", "name": "OS", "values": [ { "external_id": "9d5c5efb7c0f00a00fe4e3583f1215b0050bc723", "value": "Windows" } ] } ], "promotions": [], "unit_items": [ { "sku": "com.xsolla.game_key_01", "type": "game_key", "is_free": false, "price": { "amount": "30.5", "amount_without_discount": "30.5", "currency": "USD" }, "virtual_prices": [], "can_be_bought": true, "drm_name": "Steam", "drm_sku": "steam_key_1", "has_keys": false, "is_pre_order": false, "release_date": null, "periods": [ { "date_from": "2020-08-11T20:00:00+03:00", "date_until": null } ], "vp_rewards": [] } ] } ] } } } } } }, "Game-Keys_200-get-game-keys-by-group-catalog": { "description": "게임 키 목록을 성공적으로 수신했습니다.", "content": { "application/json": { "schema": { "type": "object", "description": "게임이 있는 개체입니다.", "properties": { "has_more": { "$ref": "#/components/schemas/Pagination_has-more" }, "items": { "type": "array", "example": [ { "sku": "com.xsolla.game_1", "name": "Game name", "groups": [ { "external_id": "all", "name": "All games" }, { "external_id": "Xsolla", "name": "Xsolla games" } ], "type": "game_key", "description": "Game description", "image_url": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png", "attributes": [ { "external_id": "OS", "name": "OS", "values": [ { "external_id": "9d5c5efb7c0f00a00fe4e3583f1215b0050bc723", "value": "Windows" } ] }, { "external_id": "genre", "name": "Genre", "values": [ { "external_id": "23fda05111c125608af8f1fa0e99db45a10ea1cc", "value": "Horror" } ] } ], "is_free": false, "price": { "amount": "30.5", "amount_without_discount": "30.5", "currency": "USD" }, "virtual_prices": [], "drm_name": "Steam", "drm_sku": "steam_key_1", "has_keys": true, "is_pre_order": true, "release_date": "2020-08-11T10:00:00+03:00", "periods": [ { "date_from": "2020-08-11T10:00:00+03:00", "date_until": "2020-08-11T20:00:00+03:00" } ] }, { "sku": "com.xsolla.game_2", "name": "Game name", "groups": [ { "external_id": "all", "name": "All games" } ], "type": "game_key", "description": "Game description", "image_url": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png", "attributes": [ { "external_id": "OS", "name": "OS", "values": [ { "external_id": "9d5c5efb7c0f00a00fe4e3583f1215b0050bc723", "value": "Windows" } ] }, { "external_id": "genre", "name": "Genre", "values": [ { "external_id": "23fda05111c125608af8f1fa0e99db45a10ea1cc", "value": "Horror" } ] } ], "is_free": false, "price": { "amount": "30.5", "amount_without_discount": "30.5", "currency": "USD" }, "virtual_prices": [], "drm_name": "Steam", "drm_sku": "steam_key_2", "has_keys": true, "is_pre_order": false, "release_date": null, "periods": [] } ], "items": { "type": "object", "properties": { "sku": { "type": "string", "example": "game_01", "description": "고유 아이템 ID입니다. SKU는 소문자 및 대문자 라틴 영숫자, 마침표, 대시 및 밑줄만 포함할 수 있습니다." }, "name": { "type": "string", "example": "Game name", "description": "아이템 이름입니다." }, "groups": { "$ref": "#/components/schemas/items_client_groups_response" }, "attributes": { "$ref": "#/components/schemas/Game-Keys_schemas-client-attributes" }, "type": { "type": "string", "example": "game_key", "description": "아이템의 유형: `game_key`." }, "description": { "type": "string", "example": "Game description", "description": "아이템 설명입니다." }, "image_url": { "type": "string", "example": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png", "description": "이미지 URL입니다." }, "is_free": { "$ref": "#/components/schemas/value-is_free" }, "price": { "type": "object", "description": "아이템 가격입니다.", "properties": { "amount": { "type": "string", "example": "2.9900", "description": "할인된 아이템 가격입니다." }, "amount_without_discount": { "type": "string", "example": "2.9900", "description": "아이템 가격입니다." }, "currency": { "type": "string", "example": "USD", "description": "아이템 가격 통화입니다. [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)에 따른 3자리 코드입니다." } } }, "virtual_prices": { "$ref": "#/components/schemas/client_virtual_prices_response" }, "drm_name": { "type": "string", "example": "Steam", "description": "DRM 이름입니다." }, "drm_sku": { "type": "string", "example": "steam", "description": "고유 DRM ID입니다. SKU는 소문자 및 대문자 라틴 영숫자, 마침표, 대시 및 밑줄만 포함할 수 있습니다." }, "has_keys": { "type": "boolean", "example": false, "description": "`true`인 경우 게임 키에 판매용 키가 있습니다." }, "is_pre_order": { "type": "boolean", "example": true, "description": "`true`인 경우 사전 판매 게임 키이며 출시 날짜가 전달되지 않은 상태입니다." }, "release_date": { "type": [ "string", "null" ], "example": "2020-08-11T10:00:00+03:00", "description": "ISO 8601 형식으로 된 게임 키 출시 날짜입니다." }, "periods": { "$ref": "#/components/schemas/item-periods-response" } } } } } }, "examples": { "response": { "value": { "has_more": true, "items": [ { "sku": "com.xsolla.game_1", "name": "Game name", "groups": [ { "external_id": "all", "name": "All games", "item_order_in_group": 2 }, { "external_id": "Xsolla", "name": "Xsolla games", "item_order_in_group": 1 } ], "type": "game_key", "description": "Game description", "image_url": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png", "attributes": [ { "external_id": "OS", "name": "OS", "values": [ { "external_id": "9d5c5efb7c0f00a00fe4e3583f1215b0050bc723", "value": "Windows" } ] }, { "external_id": "genre", "name": "Genre", "values": [ { "external_id": "23fda05111c125608af8f1fa0e99db45a10ea1cc", "value": "Horror" } ] } ], "is_free": false, "price": { "amount": "30.5", "amount_without_discount": "30.5", "currency": "USD" }, "virtual_prices": [], "drm_name": "Steam", "drm_sku": "steam_key_1", "has_keys": true, "is_pre_order": true, "release_date": "2020-08-11T10:00:00+03:00", "periods": [ { "date_from": "2020-08-11T10:00:00+03:00", "date_until": "2020-08-11T20:00:00+03:00" } ] }, { "sku": "com.xsolla.game_2", "name": "Game name", "groups": [ { "external_id": "all", "name": "All games", "item_order_in_group": 1 } ], "type": "game_key", "description": "Game description", "image_url": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png", "attributes": [ { "external_id": "OS", "name": "OS", "values": [ { "external_id": "9d5c5efb7c0f00a00fe4e3583f1215b0050bc723", "value": "Windows" } ] }, { "external_id": "genre", "name": "Genre", "values": [ { "external_id": "23fda05111c125608af8f1fa0e99db45a10ea1cc", "value": "Horror" } ] } ], "is_free": false, "price": { "amount": "30.5", "amount_without_discount": "30.5", "currency": "USD" }, "virtual_prices": [], "drm_name": "Steam", "drm_sku": "steam_key_2", "has_keys": true, "is_pre_order": false, "release_date": null, "periods": [] } ] } } } } } }, "Game-Keys_200-get-drm-list": { "description": "DRM 목록을 성공적으로 수신했습니다.", "content": { "application/json": { "schema": { "type": "object", "description": "게임이 있는 개체입니다.", "properties": { "drm": { "type": "array", "example": [ { "sku": "steam_key_1", "name": "Steam", "image": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png", "link": "https://support.steampowered.com", "redeem_instruction_link": "https://support.steampowered.com", "drm_id": 1 }, { "sku": "playstation_key_1", "name": "Playstation", "image": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png", "link": null, "redeem_instruction_link": "https://support.us.playstation.com", "drm_id": 2 } ], "items": { "type": "object", "properties": { "sku": { "type": "string", "example": "steam", "description": "고유 DRM ID입니다. SKU는 소문자 및 대문자 라틴 영숫자, 마침표, 대시 및 밑줄만 포함할 수 있습니다." }, "name": { "type": "string", "example": "Steam", "description": "DRM 이름입니다." }, "image": { "type": "string", "example": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png", "description": "이미지 URL입니다." }, "link": { "type": [ "string", "null" ], "example": "https://support.us.playstation.com", "description": "링크를 사용합니다." }, "redeem_instruction_link": { "type": "string", "example": "https://support.us.playstation.com", "description": "사용 지침 링크를 사용합니다." }, "drm_id": { "type": "number", "example": 1, "description": "DRM ID입니다." } } } } } }, "examples": { "response": { "value": { "drm": [ { "sku": "steam_key_1", "name": "Steam", "image": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png", "link": "https://support.steampowered.com", "redeem_instruction_link": "https://support.steampowered.com", "drm_id": 1 }, { "sku": "playstation_key_1", "name": "Playstation", "image": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png", "link": null, "redeem_instruction_link": "https://support.us.playstation.com", "drm_id": 2 } ] } } } } } }, "Game-Keys_200-admin-get-games-list": { "description": "게임 목록을 성공적으로 수신했습니다.", "content": { "application/json": { "schema": { "type": "object", "description": "게임이 있는 개체입니다.", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "item_id": { "type": "integer", "example": 1, "description": "아이템 생성 시 제공되는 내부의 고유 아이템 ID입니다." }, "sku": { "type": "string", "example": "game_1", "description": "고유 아이템 ID입니다. SKU는 소문자 및 대문자 라틴 영숫자, 마침표, 대시 및 밑줄만 포함할 수 있습니다." }, "type": { "type": "string", "example": "unit", "description": "아이템 유형입니다. 이 경우 항상 `unit`입니다." }, "name": { "$ref": "#/components/schemas/name-localization-object" }, "description": { "$ref": "#/components/schemas/description-localization-object" }, "long_description": { "$ref": "#/components/schemas/long-description-localization-object" }, "image_url": { "type": "string", "example": "https://image.example.com", "description": "이미지 URL입니다." }, "media_list": { "type": "array", "example": [ { "type": "image", "url": "https://cdn3.xsolla.com/img/misc/images/71ab1e12126f2103e1868076f0acb21a.jpg" } ], "description": "스크린샷, 게임 플레이 동영상 등과 같은 게임 추가 자산입니다.", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "image", "video" ], "example": "image", "description": "미디어 유형: `image`/`video`." }, "url": { "type": "string", "example": "https://cdn3.xsolla.com/img/misc/images/71ab1e12126f2103e1868076f0acb21a.jpg", "description": "리소스 파일입니다." } } } }, "is_enabled": { "type": "boolean", "description": "비활성화된 경우 인벤토리를 통해 아이템을 구매하고 액세스할 수 없습니다." }, "is_show_in_store": { "type": "boolean", "description": "아이템을 구매할 수 있는 상태입니다." }, "order": { "type": "integer", "example": 1, "description": "목록에서 게임의 주문 우선 순위입니다." }, "groups": { "type": "array", "example": [ { "external_id": "horror", "name": { "en": "Horror" } } ], "description": "아이템이 속한 그룹입니다.", "items": { "type": "object", "properties": { "external_id": { "type": "string", "example": "horror" }, "name": { "type": "object", "example": { "en": "Horror" } } } } }, "attributes": { "$ref": "#/components/schemas/Game-Keys_admin-attributes" }, "is_free": { "$ref": "#/components/schemas/value-is_free" }, "unit_items": { "type": "array", "description": "다른 DRM용 게임 키입니다.", "items": { "type": "object", "description": "게임 키 아이템입니다. 특정 플랫폼(steam, gog 등)의 게임을 나타냅니다.", "properties": { "item_id": { "type": "integer", "example": 1, "description": "아이템 생성 시 제공되는 내부의 고유 아이템 ID입니다." }, "sku": { "type": "string", "example": "game_1", "description": "고유 아이템 ID입니다. SKU는 소문자 및 대문자 라틴 영숫자, 마침표, 대시 및 밑줄만 포함할 수 있습니다." }, "type": { "type": "string", "example": "game_key", "description": "아이템 유형입니다. 이 경우 항상 `game_key`입니다." }, "is_free": { "$ref": "#/components/schemas/value-is_free" }, "prices": { "type": "array", "description": "실제 통화 가격입니다.", "example": [ { "amount": 1299.99, "currency": "RUB", "is_default": true, "is_enabled": true } ], "items": { "type": "object", "properties": { "amount": { "type": "number", "example": 1299.99 }, "currency": { "type": "string", "example": "RUB", "description": "아이템 가격 통화입니다. [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)에 따른 3자리 코드입니다." }, "is_default": { "type": "boolean", "description": "기본 가격은 사용자 통화로 가격을 지정하지 않은 경우 카탈로그를 작성하는 데 사용됩니다." }, "is_enabled": { "type": "boolean" }, "country_iso": { "type": [ "string", "null" ], "example": "US", "description": "이 가격을 사용할 수 있는 국가입니다. [ISO 3166-1 alpha 2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)에 따른 2자리 글자 코드입니다." } } } }, "virtual_prices": { "type": [ "array", "null" ], "example": [ { "sku": "com.xsolla.gold_1", "name": { "en": "Gold" }, "type": "virtual_currency", "description": null, "image_url": "https://i.pinimg.com/originals/91/ae/56/91ae5683045f6dbef16b1482bade938f.png", "amount": 1000, "is_default": true } ], "items": { "type": "object", "properties": { "sku": { "type": "string", "example": "gold", "description": "고유 아이템 ID입니다. SKU는 소문자 및 대문자 라틴 영숫자, 마침표, 대시 및 밑줄만 포함할 수 있습니다." }, "name": { "type": "object", "additionalProperties": true, "example": { "en": "Gold" }, "description": "인게임 재화의 이름에 대한 현지화가 있는 개체입니다. 키는 ISO 3166-1에 따라 지정되어 있습니다." }, "type": { "type": "string", "example": "virtual_currency", "description": "아이템 유형입니다. 이 경우 항상 `virtual_currency`입니다." }, "description": { "type": [ "object", "null" ], "additionalProperties": true, "example": { "en": "Game 1 Example" }, "description": "게임 설명에 대한 현지화가 있는 개체입니다. 키는 ISO 3166-1에 따라 지정되어 있습니다." }, "image_url": { "type": "string", "example": "https://image.example.com", "description": "이미지 URL입니다." }, "amount": { "type": "number" }, "is_default": { "type": "boolean" } } } }, "order": { "type": "integer", "example": 1, "description": "목록에서 게임의 주문 우선 순위입니다." }, "is_enabled": { "type": "boolean", "description": "비활성화된 경우 인벤토리를 통해 아이템을 구매하고 액세스할 수 없습니다." }, "is_show_in_store": { "type": "boolean", "description": "아이템을 구매할 수 있는 상태입니다." }, "drm_name": { "type": "string", "example": "Steam", "description": "게임 키 DRM 이름입니다." }, "drm_sku": { "type": "string", "example": "steam", "description": "DRM 고유 ID입니다." }, "drm_image": { "type": [ "string", "null" ], "example": "https://upload.wikimedia.org/wikipedia/en/4/48/Steam_Icon_2014.png", "description": "게임 키 DRM 아이콘입니다." }, "drm_id": { "type": "integer", "example": 1, "description": "DRM 내부 고유 ID입니다." }, "keys": { "type": "object", "properties": { "available": { "type": "integer", "description": "구매할 수 있는 키의 개수입니다." }, "total": { "type": "integer", "description": "업로드된 키의 총 개수입니다." }, "used": { "type": "integer", "description": "판매된 키 개수입니다." } } }, "is_sales_exist": { "type": "boolean", "description": "`true`인 경우 사용자가 게임 키를 구매한 것입니다." }, "pre_order": { "type": "object", "description": "사전 판매 설정입니다.", "properties": { "release_date": { "type": [ "string", "null" ], "description": "ISO 8601 형식으로 된 게임 키 출시 날짜입니다." }, "is_enabled": { "type": "boolean", "description": "비활성화된 경우 해당 아이템은 사전 판매 대상이 아닙니다." }, "description": { "type": [ "string", "null" ], "description": "사전 판매에 대한 추가 정보는 이메일로 전송됩니다." } } }, "regions": { "$ref": "#/components/schemas/Game-Keys_regions" }, "limits": { "$ref": "#/components/schemas/admin-item-limit-response" }, "periods": { "$ref": "#/components/schemas/item-periods-response" }, "name": { "$ref": "#/components/schemas/name-localization-object" }, "attributes": { "$ref": "#/components/schemas/Game-Keys_admin-attributes" }, "long_description": { "$ref": "#/components/schemas/long-description-localization-object" }, "groups": { "type": "array", "example": [ { "external_id": "horror", "name": { "en": "Horror" } } ], "description": "아이템이 속한 그룹입니다.", "items": { "type": "object", "properties": { "external_id": { "type": "string", "example": "horror" }, "name": { "type": "object", "example": { "en": "Horror" } } } } } } } } } } } } }, "examples": { "response": { "value": { "items": [ { "item_id": 1, "sku": "com.xsolla.game_1", "type": "unit", "name": { "en": "Game 1" }, "description": { "en": "Example game 1" }, "long_description": { "en": "Example game's long description" }, "image_url": "https://image.example.com", "media_list": [ { "type": "image", "url": "https://cdn3.xsolla.com/img/misc/images/71ab1e12126f2103e1868076f0acb21a.jpg" } ], "order": 1, "groups": [ { "external_id": "horror", "name": { "en": "Horror" } } ], "attributes": [ { "external_id": "platform", "name": { "en-US": "Platform" }, "values": [ { "external_id": "platform_value_d847f9a494487f5e95ad218f7beecac646f15989", "value": { "en-US": "Windows, Linux", "de-DE": "Windows, Linux" } } ] } ], "is_free": false, "is_enabled": true, "is_show_in_store": false, "unit_items": [ { "item_id": 3, "sku": "com.xsolla.game_1_key_1", "type": "game_key", "is_free": false, "prices": [ { "amount": 1199.99, "currency": "RUB", "is_default": true, "is_enabled": true, "country_iso": "RU" } ], "virtual_prices": [], "order": 1, "is_enabled": true, "is_show_in_store": false, "drm_name": "Steam", "drm_sku": "steam_key_1", "drm_image": "https://upload.wikimedia.org/wikipedia/en/4/48/Steam_Icon_2014.png", "drm_id": 1, "keys": { "available": 3, "total": 4, "used": 1 }, "is_sales_exist": false, "pre_order": { "release_date": null, "is_enabled": false, "description": null }, "limits": { "per_user": { "total": 10, "limit_exceeded_visibility": "show" }, "per_item": { "total": 10000, "available": 5000, "reserved": 500, "sold": 4500 }, "recurrent_schedule": { "per_user": { "interval_type": "daily", "time": "11:00:00+08:00", "reset_next_date": 1677553200, "displayable_reset_start_date": "2023-02-28T11:00:00+08:00", "displayable_reset_next_date": "2023-02-28T11:00:00+08:00" } } }, "periods": [ { "date_from": "2020-08-11T20:00:00+03:00", "date_until": null } ] }, { "item_id": 4, "sku": "com.xsolla.game_1_key_2", "type": "game_key", "name": { "en": "Game 1 Key 2" }, "groups": [], "attributes": [], "is_free": false, "prices": [ { "amount": 1299.99, "currency": "RUB", "is_default": true, "is_enabled": true, "country_iso": "RU" } ], "virtual_prices": null, "order": 1, "is_enabled": true, "is_show_in_store": false, "drm_name": "Epic Games Store", "drm_sku": "epicgames_key_1", "drm_image": null, "drm_id": 8, "keys": { "available": 0, "total": 0, "used": 0 }, "is_sales_exist": true, "pre_order": { "release_date": "2020-08-11T10:00:00+03:00", "is_enabled": true, "description": "Some description" }, "limits": { "per_user": null, "per_item": null, "recurrent_schedule": null }, "periods": [] } ] }, { "item_id": 2, "sku": "com.xsolla.game_2", "type": "unit", "name": { "en": "Game 2" }, "description": { "en": "Example game 2" }, "long_description": { "en": "Example game's long description" }, "image_url": "https://image.example.com", "media_list": [], "order": 1, "groups": [ { "external_id": "horror", "name": { "en": "Horror" } } ], "attributes": [ { "external_id": "platform", "name": { "en-US": "Platform" }, "values": [ { "external_id": "platform_value_d847f9a494487f5e95ad218f7beecac646f15989", "value": { "en-US": "Windows, Linux", "de-DE": "Windows, Linux" } } ] } ], "is_free": false, "is_enabled": true, "is_show_in_store": true, "unit_items": [ { "item_id": 5, "sku": "com.xsolla.game_2_key_2", "type": "game_key", "is_free": false, "prices": [], "virtual_prices": [ { "sku": "com.xsolla.gold_1", "name": { "en": "Gold" }, "type": "virtual_currency", "description": null, "image_url": "https://i.pinimg.com/originals/91/ae/56/91ae5683045f6dbef16b1482bade938f.png", "amount": 1000, "is_default": true } ], "order": 1, "is_enabled": false, "is_show_in_store": false, "drm_name": "Epic Games Store", "drm_sku": "epicgames_key_1", "drm_image": null, "drm_id": 8, "keys": { "available": 0, "total": 0, "used": 0 }, "is_sales_exist": true, "pre_order": { "release_date": null, "is_enabled": false, "description": null }, "limits": { "per_user": { "total": 10, "limit_exceeded_visibility": "show" }, "per_item": { "total": 10000, "available": 5000, "reserved": 500, "sold": 4500 }, "recurrent_schedule": { "per_user": { "interval_type": "daily", "time": "11:00:00+08:00", "reset_next_date": 1677553200, "displayable_reset_start_date": "2023-02-28T11:00:00+08:00", "displayable_reset_next_date": "2023-02-28T11:00:00+08:00" } } }, "periods": [ { "date_from": "2020-08-11T10:00:00+03:00", "date_until": "2020-08-11T20:00:00+03:00" } ] } ] } ] } } } } } }, "Game-Keys_401-invalid-basic-auth": { "description": "기본 인증이 전달되지 않았거나 잘못되었습니다. 기본 인증 또는 올바른 자격 증명을 사용했는지 확인해야 합니다.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "example": 401 }, "errorCode": { "type": "integer", "example": 1020 }, "errorMessage": { "type": "string", "example": "[0401-1020]: Error in Authentication method occurred" } } }, "examples": { "response": { "value": { "statusCode": 401, "errorCode": 1020, "errorMessage": "[0401-1020]: Error in Authentication method occurred" } } } } } }, "Game-Keys_422-invalid-request": { "description": "잘못된 요청입니다.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Game-Keys_422-invalid-request" }, "examples": { "The property `drm_sku` is required": { "value": { "statusCode": 422, "errorCode": 1102, "errorMessage": "[0401-1102]: Unprocessable Entity. The property `drm_sku` is required" } }, "Numbers of attribute values per item exceeded": { "$ref": "#/components/examples/422-numbers-of-attribute-values-per-item-exceeded" }, "Numbers of attributes per item exceeded": { "$ref": "#/components/examples/422-numbers-of-attributes-per-item-exceeded" }, "Value limit exceeded": { "$ref": "#/components/examples/422-value-limit-exceeded" } } } } }, "Game-Keys_200-admin-get-game-by-sku": { "description": "게임을 성공적으로 수신했습니다.", "content": { "application/json": { "schema": { "type": "object", "description": "게임 정보가 있는 개체입니다.", "properties": { "item_id": { "type": "integer", "example": 1, "description": "아이템 생성 시 제공되는 내부의 고유 아이템 ID입니다." }, "sku": { "type": "string", "example": "game_1", "description": "고유 아이템 ID입니다. SKU는 소문자 및 대문자 라틴 영숫자, 마침표, 대시 및 밑줄만 포함할 수 있습니다." }, "type": { "type": "string", "example": "unit", "description": "아이템 유형입니다. 이 경우 항상 `unit`입니다." }, "name": { "$ref": "#/components/schemas/name-localization-object" }, "description": { "$ref": "#/components/schemas/description-localization-object" }, "long_description": { "$ref": "#/components/schemas/long-description-localization-object" }, "image_url": { "type": "string", "example": "https://image.example.com", "description": "이미지 URL입니다." }, "media_list": { "type": "array", "example": [ { "type": "image", "url": "https://cdn3.xsolla.com/img/misc/images/71ab1e12126f2103e1868076f0acb21a.jpg" } ], "description": "스크린샷, 게임 플레이 동영상 등과 같은 게임 추가 자산입니다.", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "image", "video" ], "example": "image", "description": "미디어 유형: `image`/`video`." }, "url": { "type": "string", "example": "https://cdn3.xsolla.com/img/misc/images/71ab1e12126f2103e1868076f0acb21a.jpg", "description": "리소스 파일입니다." } } } }, "order": { "type": "integer", "example": 1, "description": "목록에서 게임의 주문 우선 순위입니다." }, "groups": { "type": "array", "example": [ { "external_id": "horror", "name": { "en": "Horror" } } ], "description": "아이템이 속한 그룹입니다.", "items": { "type": "object", "properties": { "external_id": { "type": "string", "example": "horror" }, "name": { "type": "object", "example": { "en": "Horror" } } } } }, "attributes": { "$ref": "#/components/schemas/Game-Keys_admin-attributes" }, "is_enabled": { "type": "boolean" }, "is_free": { "$ref": "#/components/schemas/value-is_free" }, "is_show_in_store": { "type": "boolean" }, "unit_items": { "type": "array", "description": "다른 DRM용 게임 키입니다.", "items": { "type": "object", "description": "게임 키 아이템입니다. 특정 플랫폼(steam, gog 등)의 게임을 나타냅니다.", "properties": { "item_id": { "type": "integer", "example": 1, "description": "아이템 생성 시 제공되는 내부의 고유 아이템 ID입니다." }, "sku": { "type": "string", "example": "game_1", "description": "고유 아이템 ID입니다. SKU는 소문자 및 대문자 라틴 영숫자, 마침표, 대시 및 밑줄만 포함할 수 있습니다." }, "type": { "type": "string", "example": "game_key", "description": "아이템 유형입니다. 이 경우 항상 `game_key`입니다." }, "is_free": { "$ref": "#/components/schemas/value-is_free" }, "prices": { "type": "array", "description": "실제 통화 가격입니다.", "example": [ { "amount": 1299.99, "currency": "RUB", "is_default": true, "is_enabled": true, "country_is": "RU" } ], "items": { "type": "object", "properties": { "amount": { "type": "number", "example": 1299.99 }, "currency": { "type": "string", "example": "RUB", "description": "아이템 가격 통화입니다. [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)에 따른 3자리 코드입니다." }, "is_default": { "type": "boolean", "description": "기본 가격은 사용자 통화로 가격을 지정하지 않은 경우 카탈로그를 작성하는 데 사용됩니다." }, "is_enabled": { "type": "boolean" }, "country_iso": { "type": [ "string", "null" ], "example": "US", "description": "이 가격을 사용할 수 있는 국가입니다. [ISO 3166-1 alpha 2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)에 따른 2자리 글자 코드입니다." } } } }, "virtual_prices": { "type": [ "array", "null" ], "example": [ { "sku": "com.xsolla.gold_1", "name": { "en": "Gold" }, "type": "virtual_currency", "description": null, "image_url": "https://i.pinimg.com/originals/91/ae/56/91ae5683045f6dbef16b1482bade938f.png", "amount": 1000, "is_default": true } ], "items": { "type": "object", "properties": { "sku": { "type": "string", "example": "gold", "description": "고유 아이템 ID입니다. SKU는 소문자 및 대문자 라틴 영숫자, 마침표, 대시 및 밑줄만 포함할 수 있습니다." }, "name": { "type": "object", "additionalProperties": true, "example": { "en": "Gold" }, "description": "인게임 재화의 이름에 대한 현지화가 있는 개체입니다. 키는 ISO 3166-1에 따라 지정되어 있습니다." }, "type": { "type": "string", "example": "virtual_currency", "description": "아이템 유형입니다. 이 경우 항상 `virtual_currency`입니다." }, "description": { "type": "object", "additionalProperties": true, "example": { "en": "Game 1 Example" }, "description": "게임 설명에 대한 현지화가 있는 개체입니다. 키는 ISO 3166-1에 따라 지정되어 있습니다." }, "image_url": { "type": "string", "example": "https://image.example.com", "description": "이미지 URL입니다." }, "amount": { "type": "number" }, "is_default": { "type": "boolean" } } } }, "order": { "type": "integer", "example": 1, "description": "목록에서 게임의 주문 우선 순위입니다." }, "is_enabled": { "type": "boolean", "description": "비활성화된 경우 인벤토리를 통해 아이템을 구매하고 액세스할 수 없습니다." }, "is_show_in_store": { "type": "boolean", "description": "아이템을 구매할 수 있는 상태입니다." }, "drm_name": { "type": "string", "example": "Steam", "description": "게임 키 DRM 이름입니다." }, "drm_sku": { "type": "string", "example": "steam", "description": "DRM 고유 ID입니다." }, "drm_image": { "type": [ "string", "null" ], "example": "https://upload.wikimedia.org/wikipedia/en/4/48/Steam_Icon_2014.png", "description": "게임 키 DRM 아이콘입니다." }, "drm_id": { "type": "integer", "example": 1, "description": "DRM 내부 고유 ID입니다." }, "keys": { "type": "object", "properties": { "available": { "type": "integer", "description": "구매할 수 있는 키의 개수입니다." }, "total": { "type": "integer", "description": "업로드된 키의 총 개수입니다." }, "used": { "type": "integer", "description": "판매된 키 개수입니다." } } }, "is_sales_exist": { "type": "boolean", "description": "`true`인 경우 사용자가 게임 키를 구매한 것입니다." }, "pre_order": { "type": "object", "description": "사전 판매 설정입니다.", "properties": { "release_date": { "type": [ "string", "null" ], "description": "ISO 8601 형식으로 된 게임 키 출시 날짜입니다." }, "is_enabled": { "type": "boolean", "description": "비활성화된 경우 해당 아이템은 사전 판매 대상이 아닙니다." }, "description": { "type": [ "string", "null" ], "description": "사전 판매에 대한 추가 정보는 이메일로 전송됩니다." } } }, "regions": { "$ref": "#/components/schemas/Game-Keys_regions" }, "limits": { "$ref": "#/components/schemas/admin-item-limit-response" }, "periods": { "$ref": "#/components/schemas/item-periods-response" } } } } } }, "examples": { "response": { "value": { "item_id": 1, "sku": "com.xsolla.game_1", "type": "unit", "name": { "en": "Game 1" }, "description": { "en": "Example game 1" }, "long_description": { "en": "Example game's long description" }, "image_url": "https://image.example.com", "media_list": [ { "type": "image", "url": "https://cdn3.xsolla.com/img/misc/images/71ab1e12126f2103e1868076f0acb21a.jpg" } ], "order": 1, "groups": [ { "external_id": "horror", "name": { "en": "Horror" } } ], "attributes": [ { "external_id": "platform", "name": { "en-US": "Platform" }, "values": [ { "external_id": "platform_value_d847f9a494487f5e95ad218f7beecac646f15989", "value": { "en-US": "Windows, Linux", "de-DE": "Windows, Linux" } } ] } ], "is_free": false, "is_enabled": true, "is_show_in_store": false, "unit_items": [ { "item_id": 3, "sku": "com.xsolla.game_1_key_1", "type": "game_key", "is_free": false, "prices": [ { "amount": 1199.99, "currency": "RUB", "is_default": true, "is_enabled": true, "country_iso": "RU" } ], "virtual_prices": [], "order": 1, "is_enabled": true, "is_show_in_store": false, "drm_name": "Steam", "drm_sku": "steam_key_1", "drm_image": "https://upload.wikimedia.org/wikipedia/en/4/48/Steam_Icon_2014.png", "drm_id": 1, "keys": { "available": 3, "total": 4, "used": 1 }, "is_sales_exist": false, "pre_order": { "release_date": null, "is_enabled": false, "description": null }, "limits": { "per_user": { "total": 5, "limit_exceeded_visibility": "show" }, "per_item": { "total": 10000, "available": 5000, "reserved": 500, "sold": 4500 }, "recurrent_schedule": { "per_user": { "interval_type": "daily", "time": "11:00:00+08:00", "reset_next_date": 1677553200, "displayable_reset_start_date": "2023-02-28T11:00:00+08:00", "displayable_reset_next_date": "2023-02-28T11:00:00+08:00" } } }, "periods": [ { "date_from": "2020-08-11T10:00:00+03:00", "date_until": "2020-08-11T20:00:00+03:00" } ] }, { "item_id": 4, "sku": "com.xsolla.game_1_key_2", "type": "game_key", "is_free": false, "prices": [ { "amount": 1299.99, "currency": "RUB", "is_default": true, "is_enabled": true, "country_iso": "RU" } ], "virtual_prices": null, "order": 1, "is_enabled": true, "is_show_in_store": false, "drm_name": "Epic Games Store", "drm_sku": "epicgames_key_1", "drm_image": null, "drm_id": 8, "keys": { "available": 0, "total": 0, "used": 0 }, "is_sales_exist": false, "pre_order": { "release_date": "2020-08-11T10:00:00+03:00", "is_enabled": true, "description": null }, "regions": [ { "id": 12 }, { "id": 64 } ], "limits": { "per_user": null, "per_item": null, "recurrent_schedule": null }, "periods": [ { "date_from": null, "date_until": "2020-08-11T20:00:00+03:00" } ] } ] } } } } } }, "Game-Keys_200-session-information": { "description": "세션 정보를 로드하는 코드를 성공적으로 수신했습니다.", "content": { "application/json": { "schema": { "type": "object", "properties": { "session_id": { "type": "string", "example": "fc7105b6e8ee01339582970b37697242" }, "count_uploaded": { "type": "integer", "example": 0 }, "count_total": { "type": "integer", "example": 100 }, "count_skipped": { "type": "integer", "example": 10 }, "status": { "type": "string", "example": "processing" } } }, "examples": { "response": { "value": { "session_id": "fc7105b6e8ee01339582970b37697242", "count_uploaded": 0, "count_total": 100, "count_skipped": 10, "status": "processing" } } } } } }, "Game-Keys_200-get-codes": { "description": "코드를 성공적으로 수신했습니다.", "content": { "text/plain": { "schema": { "type": "string", "example": "PIN-CODE-ALL PIN-CODE-ALL-3" }, "examples": { "response": { "value": "PIN-CODE-ALL PIN-CODE-ALL-3" } } } } }, "Game-Keys_200-user-entitlement-list": { "description": "사용자가 소유한 게임 키 목록을 성공적으로 수신했습니다.", "content": { "application/json": { "schema": { "type": "object", "description": "게임 정보가 있는 개체입니다.", "properties": { "has_more": { "$ref": "#/components/schemas/Pagination_has-more" }, "total_items_count": { "$ref": "#/components/schemas/Pagination_total-items-count" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/Game-Keys_entitlement_item" } } } }, "examples": { "response": { "value": { "has_more": false, "total_items_count": 1, "items": [ { "name": "The Greatest Game in the World", "description": "Description of the greatest game in the world.", "image_url": "https://none", "project_id": 30810, "game_sku": "com.xsolla.key_1", "drm": "drmfree", "is_pre_order": false } ] } } } } } }, "Game-Keys_403-auth-header-not-sent": { "description": "인증 헤더가 전송되지 않았습니다.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "example": 403 }, "errorCode": { "type": "integer", "example": 0 }, "errorMessage": { "type": "string", "example": "Authorization header not sent." }, "transactionId": { "type": "string", "example": "x-x-x-x-transactionId-mock-x-x-x" } } }, "examples": { "response": { "value": { "statusCode": 403, "errorCode": 0, "errorMessage": "Authorization header not sent" } } } } } }, "Bundles_200-admin-get-bundle-list": { "description": "번들 목록을 성공적으로 수신했습니다.", "content": { "application/json": { "schema": { "type": "object", "description": "아이템이 있는 개체입니다.", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/Bundles_admin_bundle_response" } } } }, "example": { "items": [ { "item_id": 610316, "sku": "com.xsolla.UltraSuperLootboxBundle_1", "name": { "en": "Ultra Super Lootbox Bundle" }, "type": "bundle", "description": { "en": "Ultra Super Lootbox with items" }, "image_url": "https://cdn.xsolla.net/img/misc/images/779d2588a5b3cf348133fa7d5755cec8.png", "long_description": { "en": "Ultra Super lootbox with different items" }, "attributes": [], "is_free": false, "groups": [ { "external_id": "all", "name": { "en": "Equipment" } } ], "prices": [ { "amount": "150.49", "currency": "USD", "is_default": true, "is_enabled": true } ], "virtual_prices": [], "media_list": [], "order": 1, "is_enabled": true, "is_show_in_store": true, "regions": [], "bundle_type": "standard", "content": [ { "sku": "com.xsolla.booster_min_1", "name": { "en": "Xsolla Booster Mini" }, "type": "virtual_good", "description": { "en": "Test your luck to find glorious treasures from the past in an Xsolla Booster Mini." }, "image_url": "https://cdn.xsolla.net/img/misc/images/5ee252b292a560930c8f7e2c791dfc6d.png", "quantity": 2 }, { "sku": "com.xsolla.booster_min_2", "name": { "en": "Booster" }, "type": "virtual_good", "description": { "en": "Get high-quality, competitively priced gas with Booster. Download the app for free same-day delivery. Kick the gas station habit for good." }, "image_url": "https://cdn.xsolla.net/img/misc/images/e76d317ee5a8d06a4b730bcf23746e9e.png", "quantity": 15 }, { "sku": "com.xsolla.gloves_1", "name": { "en": "Xsolla Gloves" }, "type": "virtual_good", "description": { "en": "Enjoy a range of outdoor activities with gloves from EK Sporting Goods." }, "image_url": "https://cdn.xsolla.net/img/misc/images/93a7ee3ae284b677d3dc1f2e989731cb.png", "quantity": 3 }, { "sku": "com.xsolla.boots_1", "name": { "en": "Xsolla Boots" }, "type": "virtual_good", "description": { "en": "Stylishly protect your toes with the accent of Xsolla" }, "image_url": "https://cdn.xsolla.net/img/misc/images/6e33d40df3cdac152dac9ac3d1f5986e.png", "quantity": 2 }, { "sku": "com.xsolla.gun_max", "name": { "en": "Xsolla Gun" }, "type": "virtual_good", "description": { "en": "The M134 Minigun is a 7.62×51mm NATO, six-barrel rotary machine gun with a high rate of fire (2,000 to 6,000 rounds per minute)" }, "image_url": "https://cdn.xsolla.net/img/misc/images/3093eeb39d5ec7def3af6396607a30ba.png", "quantity": 10 }, { "sku": "com.xsolla.minigun_2", "name": { "en": "Empire Minigun" }, "type": "virtual_good", "description": { "en": "Just hold down the trigger and pray to the Empire" }, "image_url": "https://cdn.xsolla.net/img/misc/images/dabfa4567cd2d82e0562d4b0f448b436.png", "quantity": 3 } ], "limits": { "per_user": { "total": 10, "limit_exceeded_visibility": "show" }, "per_item": { "total": 500, "available": 455, "reserved": 5, "sold": 40 }, "recurrent_schedule": { "per_user": { "interval_type": "daily", "time": "11:00:00+08:00", "reset_next_date": 1677639600, "displayable_reset_start_date": "2023-02-28T11:00:00+08:00", "displayable_reset_next_date": "2023-03-01T11:00:00+08:00" } } }, "periods": [ { "date_from": "2020-08-11T10:00:00+03:00", "date_until": "2020-08-11T20:00:00+03:00" } ], "custom_attributes": { "type": "lootbox", "purchased": 0 } }, { "item_id": 610317, "sku": "com.xsolla.EmpireBundle_1", "name": { "en": "Empire bundle" }, "type": "bundle", "description": { "en": "Empire bundle with items" }, "image_url": "https://cdn.xsolla.net/img/misc/images/685b21f9d9dca4aa0c953e8816b4eb4b.png", "long_description": { "en": "Empire bundle with some goods" }, "attributes": [], "is_free": false, "groups": [ { "external_id": "all", "name": { "en": "Equipment" } } ], "prices": [], "virtual_prices": [ { "sku": "com.xsolla.crystal_1", "name": { "en": "Crystals", "ru": "Crystals" }, "type": "virtual_currency", "description": { "en": "Main in-game currency" }, "image_url": "https://cdn3.xsolla.com/img/misc/images/da33ab6cc1d7e5899cfdc5b6b6180fad.png", "amount": "150", "is_default": true } ], "media_list": [], "order": 1, "is_enabled": true, "is_show_in_store": true, "regions": [], "bundle_type": "standard", "content": [ { "sku": "com.xsolla.keys_2", "name": { "en": "Empire Key" }, "type": "virtual_good", "description": { "en": "Opens ONE Empire lootbox of any kind" }, "image_url": "https://cdn.xsolla.net/img/misc/images/5c2f8536f08a9949964e4fa2e01a7cb8.png", "quantity": 5 }, { "sku": "com.xsolla.booster_mega_2", "name": { "en": "Empire Booster Mega" }, "type": "virtual_good", "description": { "en": "Take it, take it all! All of the Empires riches in one Mega Booster." }, "image_url": "https://cdn.xsolla.net/img/misc/images/55e908cb9670301ac8f89a6382433a27.png", "quantity": 1 }, { "sku": "com.xsolla.booster_min_2", "name": { "en": "Empire Booster Mini" }, "type": "virtual_good", "description": { "en": "Test your luck to find glorious treasures from Empire's past" }, "image_url": "https://cdn.xsolla.net/img/misc/images/5bcecec17400a0d8c72dd265ff730b07.png", "quantity": 3 } ], "limits": { "per_user": null, "per_item": null, "recurrent_schedule": null }, "periods": [] } ] } } } }, "Bundles_401-invalid-basic-auth": { "description": "기본 인증이 전달되지 않았거나 잘못되었습니다. 기본 인증 또는 올바른 자격 증명을 사용했는지 확인해야 합니다.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "example": 401 }, "errorCode": { "type": "integer", "example": 1020 }, "errorMessage": { "type": "string", "example": "[0401-1020]: Error in Authentication method occurred" } } }, "examples": { "response": { "value": { "statusCode": 401, "errorCode": 1020, "errorMessage": "[0401-1020]: Error in Authentication method occurred" } } } } } }, "Bundles_201-admin-create-bundle": { "description": "번들을 성공적으로 생성했습니다.", "content": { "application/json": { "schema": { "type": "object", "properties": { "sku": { "$ref": "#/components/schemas/Bundles_sku" } } }, "examples": { "response": { "value": { "sku": "com.xsolla.kg_1" } } } } } }, "Bundles_422-invalid-request": { "description": "잘못된 요청입니다.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Bundles_422-invalid-request" }, "examples": { "The property `sku` is required": { "$ref": "#/components/examples/422-property-sku-is-required" }, "Numbers of attribute values per item exceeded": { "$ref": "#/components/examples/422-numbers-of-attribute-values-per-item-exceeded" }, "Numbers of attributes per item exceeded": { "$ref": "#/components/examples/422-numbers-of-attributes-per-item-exceeded" }, "Value limit exceeded": { "$ref": "#/components/examples/422-value-limit-exceeded" }, "Custom attributes JSON can’t exceed 500 characters": { "$ref": "#/components/examples/422-custom-attributes-size-exceeded" } } } } }, "Bundles_200-admin-get-bundle-list-in-group": { "description": "번들 목록을 성공적으로 수신했습니다.", "content": { "application/json": { "schema": { "type": "object", "description": "아이템이 있는 개체입니다.", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/Bundles_admin_bundle_response" } } } }, "example": { "items": [ { "item_id": 610316, "sku": "com.xsolla.UltraSuperLootboxBundle_1", "name": { "en": "Ultra Super Lootbox Bundle" }, "type": "bundle", "description": { "en": "Ultra Super Lootbox with items" }, "image_url": "https://cdn.xsolla.net/img/misc/images/779d2588a5b3cf348133fa7d5755cec8.png", "long_description": { "en": "Ultra Super lootbox with different items" }, "attributes": [], "is_free": false, "groups": [ { "external_id": "all", "name": { "en": "Equipment" } } ], "prices": [ { "amount": "150.49", "currency": "USD", "is_default": true, "is_enabled": true } ], "virtual_prices": [], "media_list": [], "order": 1, "is_enabled": true, "is_show_in_store": true, "regions": [], "bundle_type": "standard", "content": [ { "sku": "com.xsolla.booster_min_1", "name": { "en": "Xsolla Booster Mini" }, "type": "virtual_good", "description": { "en": "Test your luck to find glorious treasures from the past in an Xsolla Booster Mini." }, "image_url": "https://cdn.xsolla.net/img/misc/images/5ee252b292a560930c8f7e2c791dfc6d.png", "quantity": 2 }, { "sku": "com.xsolla.booster_min_2", "name": { "en": "Booster" }, "type": "virtual_good", "description": { "en": "Get high-quality, competitively priced gas with Booster. Download the app for free same-day delivery. Kick the gas station habit for good." }, "image_url": "https://cdn.xsolla.net/img/misc/images/e76d317ee5a8d06a4b730bcf23746e9e.png", "quantity": 15 }, { "sku": "com.xsolla.gloves_1", "name": { "en": "Xsolla Gloves" }, "type": "virtual_good", "description": { "en": "Enjoy a range of outdoor activities with gloves from EK Sporting Goods." }, "image_url": "https://cdn.xsolla.net/img/misc/images/93a7ee3ae284b677d3dc1f2e989731cb.png", "quantity": 3 }, { "sku": "com.xsolla.boots_1", "name": { "en": "Xsolla Boots" }, "type": "virtual_good", "description": { "en": "Stylishly protect your toes with the accent of Xsolla" }, "image_url": "https://cdn.xsolla.net/img/misc/images/6e33d40df3cdac152dac9ac3d1f5986e.png", "quantity": 2 }, { "sku": "com.xsolla.gun_max", "name": { "en": "Xsolla Gun" }, "type": "virtual_good", "description": { "en": "The M134 Minigun is a 7.62×51mm NATO, six-barrel rotary machine gun with a high rate of fire (2,000 to 6,000 rounds per minute)" }, "image_url": "https://cdn.xsolla.net/img/misc/images/3093eeb39d5ec7def3af6396607a30ba.png", "quantity": 10 }, { "sku": "com.xsolla.minigun_2", "name": { "en": "Empire Minigun" }, "type": "virtual_good", "description": { "en": "Just hold down the trigger and pray to the Empire" }, "image_url": "https://cdn.xsolla.net/img/misc/images/dabfa4567cd2d82e0562d4b0f448b436.png", "quantity": 3 } ], "limits": { "per_user": { "total": 10, "limit_exceeded_visibility": "show" }, "per_item": { "total": 500, "available": 455, "reserved": 5, "sold": 40 }, "recurrent_schedule": { "per_user": { "interval_type": "weekly", "day_of_week": 2, "time": "11:00:00+08:00", "reset_next_date": 1677553200, "displayable_reset_start_date": "2023-02-28T11:00:00+08:00", "displayable_reset_next_date": "2023-03-07T11:00:00+08:00" } } }, "periods": [ { "date_from": "2020-08-11T10:00:00+03:00", "date_until": "2020-08-11T20:00:00+03:00" } ], "custom_attributes": { "type": "lootbox", "purchased": 0 } }, { "item_id": 610317, "sku": "com.xsolla.EmpireBundle_1", "name": { "en": "Empire bundle" }, "type": "bundle", "description": { "en": "Empire bundle with items" }, "image_url": "https://cdn.xsolla.net/img/misc/images/685b21f9d9dca4aa0c953e8816b4eb4b.png", "long_description": { "en": "Empire bundle with some goods" }, "attributes": [], "is_free": false, "groups": [ { "external_id": "all", "name": { "en": "Equipment" } } ], "prices": [], "virtual_prices": [ { "sku": "com.xsolla.crystal_1", "name": { "en": "Crystals", "ru": "Crystals" }, "type": "virtual_currency", "description": { "en": "Main in-game currency" }, "image_url": "https://cdn3.xsolla.com/img/misc/images/da33ab6cc1d7e5899cfdc5b6b6180fad.png", "amount": "150", "is_default": true } ], "media_list": [], "order": 1, "is_enabled": true, "is_show_in_store": true, "regions": [], "bundle_type": "standard", "content": [ { "sku": "com.xsolla.keys_2", "name": { "en": "Empire Key" }, "type": "virtual_good", "description": { "en": "Opens ONE Empire lootbox of any kind" }, "image_url": "https://cdn.xsolla.net/img/misc/images/5c2f8536f08a9949964e4fa2e01a7cb8.png", "quantity": 5 }, { "sku": "com.xsolla.booster_mega_2", "name": { "en": "Empire Booster Mega" }, "type": "virtual_good", "description": { "en": "Take it, take it all! All of the Empires riches in one Mega Booster." }, "image_url": "https://cdn.xsolla.net/img/misc/images/55e908cb9670301ac8f89a6382433a27.png", "quantity": 1 }, { "sku": "com.xsolla.booster_min_2", "name": { "en": "Empire Booster Mini" }, "type": "virtual_good", "description": { "en": "Test your luck to find glorious treasures from Empire's past" }, "image_url": "https://cdn.xsolla.net/img/misc/images/5bcecec17400a0d8c72dd265ff730b07.png", "quantity": 3 } ], "limits": { "per_user": null, "per_item": null, "recurrent_schedule": null }, "periods": [] } ] } } } }, "Bundles_200-admin-get-bundle": { "description": "지정한 번들을 성공적으로 수신했습니다.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Bundles_admin_bundle_response" }, "example": { "item_id": 610316, "sku": "com.xsolla.EmpireBundle_1", "name": { "en": "Empire bundle" }, "type": "bundle", "description": { "en": "Empire bundle with items" }, "image_url": "https://cdn.xsolla.net/img/misc/images/685b21f9d9dca4aa0c953e8816b4eb4b.png", "long_description": { "en": "Empire bundle with some goods" }, "attributes": [], "is_free": false, "is_paid_randomized_reward": true, "groups": [ { "external_id": "all", "name": { "en": "Equipment" } } ], "prices": [], "virtual_prices": [ { "sku": "com.xsolla.crystal_1", "name": { "en": "Crystals", "ru": "Crystals" }, "type": "virtual_currency", "description": { "en": "Main in-game currency" }, "image_url": "https://cdn3.xsolla.com/img/misc/images/da33ab6cc1d7e5899cfdc5b6b6180fad.png", "amount": "150", "is_default": true } ], "media_list": [], "order": 1, "is_enabled": true, "is_show_in_store": true, "regions": [], "bundle_type": "standard", "content": [ { "sku": "com.xsolla.keys_2", "name": { "en": "Empire Key" }, "type": "virtual_good", "description": { "en": "Opens ONE Empire lootbox of any kind" }, "image_url": "https://cdn.xsolla.net/img/misc/images/5c2f8536f08a9949964e4fa2e01a7cb8.png", "quantity": 5 }, { "sku": "com.xsolla.booster_mega_2", "name": { "en": "Empire Booster Mega" }, "type": "virtual_good", "description": { "en": "Take it, take it all! All of the Empires riches in one Mega Booster." }, "image_url": "https://cdn.xsolla.net/img/misc/images/55e908cb9670301ac8f89a6382433a27.png", "quantity": 1 }, { "sku": "com.xsolla.booster_min_2", "name": { "en": "Empire Booster Mini" }, "type": "virtual_good", "description": { "en": "Test your luck to find glorious treasures from Empire's past" }, "image_url": "https://cdn.xsolla.net/img/misc/images/5bcecec17400a0d8c72dd265ff730b07.png", "quantity": 3 } ], "limits": { "per_user": { "total": 10, "limit_exceeded_visibility": "show" }, "per_item": null, "recurrent_schedule": null }, "periods": [ { "date_from": "2020-08-11T10:00:00+03:00", "date_until": "2020-08-11T20:00:00+03:00" } ], "custom_attributes": { "type": "lootbox", "purchased": 0 } } } } }, "Bundles_204-admin-update-bundle": { "description": "번들을 성공적으로 업데이트했습니다.", "content": {} }, "Bundles_204-admin-delete-bundle": { "description": "번들을 성공적으로 삭제했습니다.", "content": {} }, "Bundles_204-admin-show-bundle": { "description": "번들을 성공적으로 표시했습니다.", "content": {} }, "Bundles_204-admin-hide-bundle": { "description": "번들을 성공적으로 숨김 처리했습니다.", "content": {} }, "Bundles_200-get-bundle-list": { "description": "번들 목록을 성공적으로 수신했습니다.", "content": { "application/json": { "schema": { "type": "object", "description": "아이템이 있는 개체입니다.", "properties": { "has_more": { "$ref": "#/components/schemas/Pagination_has-more" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/Bundles_client_bundle" } } } }, "examples": { "response": { "$ref": "#/components/examples/Bundles_200-get-bundle-list" } } } } }, "Cart-Payment_200-get-cart-json-model": { "description": "아이템이 있는 장바구니를 성공적으로 반환했습니다.", "content": { "application/json": { "schema": { "type": "object", "properties": { "cart_id": { "type": "string", "example": "cart_id", "description": "장바구니 ID입니다." }, "price": { "type": [ "object", "null" ], "properties": { "amount": { "type": "string", "default": "50.0000000000000000" }, "amount_without_discount": { "type": "string", "default": "100.0000000000000000" }, "currency": { "type": "string", "default": "USD" } }, "example": { "amount": "6150.0000000000000000", "amount_without_discount": "6150.0000000000000000", "currency": "USD" }, "description": "장바구니 가격입니다." }, "is_free": { "$ref": "#/components/schemas/value-cart_is_free" }, "items": { "type": "array", "items": { "type": "object", "properties": { "sku": { "type": "string" }, "groups": { "type": "array", "items": { "type": "object", "properties": { "external_id": { "type": "string" }, "name": { "type": "string" } } } }, "name": { "type": [ "string", "null" ] }, "attributes": { "$ref": "#/components/schemas/Cart-Payment_client-attributes" }, "type": { "type": "string" }, "description": { "type": "string" }, "image_url": { "type": "string" }, "quantity": { "type": "integer" }, "price": { "type": [ "object", "null" ], "properties": { "amount": { "type": "string" }, "amount_without_discount": { "type": "string" }, "currency": { "type": "string" } }, "example": { "amount": "6150.0000000000000000", "amount_without_discount": "6150.0000000000000000", "currency": "USD" }, "description": "아이템 가격입니다." }, "virtual_item_type": { "type": "string", "description": "아이템 유형입니다." }, "virtual_prices": { "$ref": "#/components/schemas/client_virtual_prices_response" }, "is_free": { "$ref": "#/components/schemas/value-is_free" }, "is_bonus": { "type": "boolean" }, "promotions": { "$ref": "#/components/schemas/Catalog_item_promotions" }, "can_be_bought": { "$ref": "#/components/schemas/Can_be_bought" }, "vp_rewards": { "$ref": "#/components/schemas/client-item-value-point-reward" }, "limits": { "$ref": "#/components/schemas/Catalog_item_limits" }, "periods": { "$ref": "#/components/schemas/item-periods" } } } }, "promotions": { "$ref": "#/components/schemas/Catalog_cart_promotions" } } }, "examples": { "response": { "value": { "cart_id": "cart_id", "is_free": false, "items": [ { "attributes": [], "description": "Take it, take it all! All of Xsollas riches in one Mega Booster.", "groups": [ { "external_id": "powerups", "name": "Power Ups" } ], "image_url": "https://cdn.xsolla.net/img/misc/images/e9f2f4a634bc96ea03b5d5ceadd7c55f.png", "is_free": false, "is_bonus": false, "name": "Xsolla Booster Mega", "price": { "amount": "50.0000000000000000", "amount_without_discount": "100.0000000000000000", "currency": "USD" }, "quantity": 123, "sku": "com.xsolla.booster_mega_1", "type": "virtual_good", "virtual_item_type": "consumable", "virtual_prices": [], "promotions": [], "can_be_bought": true, "vp_rewards": [ { "item_id": 175232, "sku": "com.xsolla.value_point_1", "amount": 130, "name": "Value point", "image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg" }, { "item_id": 186321, "sku": "com.xsolla.clan_value_point_1", "amount": 50, "name": "Clan Reward VP 1", "image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg", "is_clan": true } ], "limits": { "per_user": { "available": 3, "recurrent_schedule": { "interval_type": "weekly", "reset_next_date": 1746057600 }, "total": 5 } }, "periods": [ { "date_from": "2020-08-11T10:00:00+03:00", "date_until": "2020-08-11T20:00:00+03:00" } ] } ], "price": { "amount": "6150.0000000000000000", "amount_without_discount": "6150.0000000000000000", "currency": "USD" }, "promotions": [ { "name": "Bonus promotion", "date_start": "2020-04-15T16:16:00+03:00", "date_end": "2026-04-15T16:16:00+03:00", "discount": { "percent": "50.00" }, "bonus": [ { "quantity": 1, "name": "Xsolla Minigun", "image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png", "sku": "com.xsolla.minigun_1", "type": "virtual_good" } ] } ] } } } } } }, "Cart-Payment_200-fill-cart-json-model": { "description": "아이템이 있는 장바구니를 성공적으로 반환했습니다.", "content": { "application/json": { "schema": { "type": "object", "properties": { "cart_id": { "type": "string", "example": "cart_id", "description": "장바구니 ID입니다." }, "price": { "type": [ "object", "null" ], "properties": { "amount": { "type": "string", "default": "50.0000000000000000" }, "amount_without_discount": { "type": "string", "default": "100.0000000000000000" }, "currency": { "type": "string", "default": "USD" } }, "example": { "amount": "6150.0000000000000000", "amount_without_discount": "6150.0000000000000000", "currency": "USD" }, "description": "장바구니 가격입니다." }, "is_free": { "$ref": "#/components/schemas/value-cart_is_free" }, "items": { "type": "array", "items": { "type": "object", "properties": { "sku": { "type": "string" }, "groups": { "type": "array", "items": { "type": "object", "properties": { "external_id": { "type": "string" }, "name": { "type": "string" } } } }, "name": { "type": [ "string", "null" ] }, "attributes": { "$ref": "#/components/schemas/Cart-Payment_client-attributes" }, "type": { "type": "string" }, "description": { "type": "string" }, "image_url": { "type": "string" }, "quantity": { "type": "integer" }, "price": { "type": [ "object", "null" ], "properties": { "amount": { "type": "string" }, "amount_without_discount": { "type": "string" }, "currency": { "type": "string" } }, "example": { "amount": "6150.0000000000000000", "amount_without_discount": "6150.0000000000000000", "currency": "USD" }, "description": "아이템 가격입니다." }, "virtual_item_type": { "type": "string", "description": "아이템 유형입니다." }, "virtual_prices": { "$ref": "#/components/schemas/client_virtual_prices_response" }, "is_free": { "$ref": "#/components/schemas/value-is_free" }, "is_bonus": { "type": "boolean" }, "promotions": { "$ref": "#/components/schemas/Catalog_item_promotions" }, "can_be_bought": { "$ref": "#/components/schemas/Can_be_bought" }, "vp_rewards": { "$ref": "#/components/schemas/client-item-value-point-reward" }, "limits": { "$ref": "#/components/schemas/Catalog_item_limits" }, "periods": { "$ref": "#/components/schemas/item-periods" } } } }, "promotions": { "$ref": "#/components/schemas/Catalog_cart_promotions" }, "warnings": { "type": "array", "items": { "type": "object", "properties": { "sku": { "type": "string" }, "quantity": { "type": "integer" }, "errorCode": { "type": "integer" }, "errorMessage": { "type": "string" } } } } } }, "examples": { "response": { "value": { "cart_id": "cart_id", "is_free": false, "items": [ { "attributes": [], "description": "Take it, take it all! All of Xsollas riches in one Mega Booster.", "groups": [ { "external_id": "powerups", "name": "Power Ups" } ], "image_url": "https://cdn.xsolla.net/img/misc/images/e9f2f4a634bc96ea03b5d5ceadd7c55f.png", "is_free": false, "is_bonus": false, "name": "Xsolla Booster Mega", "price": { "amount": "50.0000000000000000", "amount_without_discount": "100.0000000000000000", "currency": "USD" }, "quantity": 123, "sku": "com.xsolla.booster_mega_1", "type": "virtual_good", "virtual_item_type": "consumable", "virtual_prices": [], "promotions": [ { "name": "Bonus promotion", "date_start": "2020-04-15T16:16:00+03:00", "date_end": "2026-04-15T16:16:00+03:00", "discount": { "percent": "50.00" }, "bonus": [ { "quantity": 1, "name": "Xsolla Minigun", "image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png", "sku": "com.xsolla.minigun_1", "type": "virtual_good" } ] } ], "can_be_bought": true, "vp_rewards": [ { "item_id": 175232, "sku": "com.xsolla.value_point_1", "amount": 130, "name": "Value point", "image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg" }, { "item_id": 186321, "sku": "com.xsolla.clan_value_point_1", "amount": 50, "name": "Clan Reward VP 1", "image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg", "is_clan": true } ], "limits": { "per_user": { "available": 3, "recurrent_schedule": { "interval_type": "weekly", "reset_next_date": 1746057600 }, "total": 5 } }, "periods": [ { "date_from": "2020-08-11T10:00:00+03:00", "date_until": "2020-08-11T20:00:00+03:00" } ] } ], "warnings": [ { "sku": "com.xsolla.booster_mega_21", "quantity": 1, "errorCode": 4001, "errorMessage": "[0401-4001]: Item with Project Id = 44056 and Sku = booster_mega_2 not found" } ], "price": { "amount": "6150.0000000000000000", "amount_without_discount": "6150.0000000000000000", "currency": "USD" }, "promotions": [ { "name": "Bonus promotion", "date_start": "2020-04-15T16:16:00+03:00", "date_end": "2026-04-15T16:16:00+03:00", "discount": { "percent": "50.00" }, "bonus": [ { "quantity": 1, "name": "Xsolla Minigun", "image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png", "sku": "com.xsolla.minigun_1", "type": "virtual_good" } ] } ] } } } } } }, "Cart-Payment_404-item": { "description": "아이템을 찾을 수 없습니다. `project_id`과 `item_sku`가 올바른지 확인해야 합니다.", "content": { "application/json": { "schema": { "properties": { "statusCode": { "type": "integer", "example": 404 }, "errorCode": { "type": "integer", "example": 4001 }, "errorMessage": { "type": "string", "example": "[0401-4001]: Item with Project Id = 44056 and Sku = booster_mega_12222 not found" } }, "type": "object" } } } }, "Cart-Payment_422-non-negative-quantity": { "description": "아이템 수량은 음수가 아닌 정수여야 합니다.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "example": 422 }, "errorMessage": { "type": "string", "example": "Item quantity must be non-negative integer." }, "errorCode": { "type": "integer", "example": 1102 } } }, "examples": { "response": { "value": { "errorCode": 1102, "errorMessage": "[0401-1102]: Item quantity must be non-negative integer", "statusCode": 422 } } } } } }, "Cart-Payment_422-can-put-only-virtual-good-to-cart": { "description": "이 유형의 아이템은 장바구니에 넣을 수 없습니다. 다른 유형의 아이템을 선택해야 합니다.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "example": 422 }, "errorCode": { "type": "integer", "example": 1421 }, "errorMessage": { "type": "string", "example": "This type of item cannot be put to the cart. Select another type of item." } } }, "examples": { "response": { "value": { "statusCode": 422, "errorCode": 1421, "errorMessage": "Only Virtual Good Supported" } } } } } }, "Cart-Payment_200-order-created": { "description": "주문을 성공적으로 생성했습니다.", "content": { "application/json": { "schema": { "type": "object", "properties": { "order_id": { "type": "integer", "description": "주문 ID입니다." }, "token": { "type": "string", "description": "결제 토큰입니다." } } }, "examples": { "response": { "value": { "order_id": 641, "token": "f4puMEFFDZcx9nv5HoNHIkPe9qghvBQo" } } } } } }, "Cart-Payment_422-invalid-cart": { "description": "장바구니가 잘못되었습니다. 장바구니가 존재하는지, 장바구니가 비어 있지 않은지, 장바구니에 있는 모든 아이템이 무료가 아닌지 확인해야 합니다.", "content": { "application/json": { "schema": { "type": "object", "properties": { "errorCode": { "type": "integer", "example": 1401 }, "statusCode": { "type": "integer", "example": 422 }, "errorMessage": { "type": "string", "example": "[0401-1401]: Invalid cart" } } }, "examples": { "response": { "value": { "errorCode": 1401, "statusCode": 422, "errorMessage": "[0401-1401]: Invalid cart" } } } } } }, "Cart-Payment_404-create-order-with-item-not-found-errors": { "description": "아이템 또는 쿠폰을 찾을 수 없습니다. 사용한 데이터가 올바른지 확인해 주십시오.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer" }, "errorCode": { "type": "integer" }, "errorMessage": { "type": "string" }, "transactionId": { "type": "string" } } }, "examples": { "item not found": { "$ref": "#/components/examples/404-item-by-sku-not-found" }, "coupon not found": { "$ref": "#/components/examples/404-coupon-not-found" } } } } }, "Cart-Payment_422-create-order-with-item-invalid": { "description": "잘못된 오류입니다.", "content": { "application/json": { "schema": { "type": "object", "properties": { "errorCode": { "type": "integer", "example": 1411 }, "statusCode": { "type": "integer", "example": 422 }, "errorMessage": { "type": "string", "example": "[0401-1411]: Invalid item" } } }, "examples": { "invalid item": { "value": { "errorCode": 1411, "statusCode": 422, "errorMessage": "[0401-1411]: Invalid item" } }, "code expired": { "value": { "errorCode": 9810, "statusCode": 422, "errorMessage": "[0401-9810]: Sorry, this code is expired." } }, "code redemption limit": { "value": { "errorCode": 9804, "statusCode": 422, "errorMessage": "[0401-9804]: You have reached the coupon redemption limit." } }, "regionally restricted": { "value": { "errorCode": 9808, "statusCode": 422, "errorMessage": "[0401-9808]: Coupon is not available in your region." } } } } } }, "Cart-Free_200-order-created": { "description": "무료 주문을 성공적으로 생성했습니다.", "content": { "application/json": { "schema": { "type": "object", "properties": { "order_id": { "type": "integer", "description": "주문 ID입니다." } } }, "examples": { "response": { "value": { "order_id": 641 } } } } } }, "Cart-Payment_422-invalid-item": { "description": "아이템이 잘못되었습니다. 아이템이 존재하는지, 꺼진 상태가 아닌지, 삭제되었는지, 무료가 아닌지 확인해야 합니다.", "content": { "application/json": { "schema": { "type": "object", "properties": { "errorCode": { "type": "integer", "example": 1411 }, "statusCode": { "type": "integer", "example": 422 }, "errorMessage": { "type": "string", "example": "[0401-1411]: Invalid item" } } }, "examples": { "response": { "value": { "errorCode": 1411, "statusCode": 422, "errorMessage": "[0401-1411]: Invalid item" } } } } } }, "Cart-Payment_200-get-order": { "description": "주문 요청에 성공했습니다.", "content": { "application/json": { "schema": { "type": "object", "properties": { "order_id": { "type": "integer", "example": 1, "default": "Order ID.", "description": "주문 ID입니다." }, "status": { "type": "string", "example": "paid", "enum": [ "new", "paid", "done", "canceled", "expired" ], "description": "주문 상태. 자세한 상태 설명은 [주문 수명 주기](https://developers.xsolla.com/ko/api/catalog/order-life-cycle)) 섹션을 참조하십시오." }, "content": { "type": "object", "description": "주문 세부 정보입니다.", "properties": { "price": { "type": "object", "description": "주문 가격입니다.", "properties": { "amount": { "type": "string", "example": "30", "description": "주문 할인 가격입니다." }, "amount_without_discount": { "type": "string", "example": "30", "description": "주문 가격입니다." }, "currency": { "type": "string", "example": "USD", "description": "주문 가격 통화입니다. [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)에 따른 3자리 코드입니다." } } }, "virtual_price": { "type": "object", "description": "인게임 재화로 표시된 주문 가격입니다.", "properties": { "amount": { "type": "string", "example": "100", "description": "주문 할인 가격입니다." }, "amount_without_discount": { "type": "string", "example": "150", "description": "주문 가격입니다." }, "currency": { "type": "string", "example": "test_vc", "description": "주문에 사용된 인게임 재화 SKU입니다." } } }, "is_free": { "type": "boolean", "example": false, "description": "`true`일 경우 주문이 무료입니다." }, "items": { "type": "array", "example": [ { "sku": "com.xsolla.item_1", "quantity": 1, "is_free": false, "price": { "amount": "30", "amount_without_discount": "30", "currency": "USD" } } ], "description": "아이템 목록입니다.", "items": { "type": "object", "properties": { "sku": { "type": "string", "example": "some_sku", "description": "고유 아이템 ID입니다. SKU는 소문자 및 대문자 라틴 영숫자, 마침표, 대시 및 밑줄만 포함할 수 있습니다." }, "quantity": { "type": "integer", "example": 1, "description": "아이템 수량입니다." }, "is_free": { "$ref": "#/components/schemas/value-is_free" }, "price": { "type": "object", "description": "아이템 가격입니다.", "properties": { "amount": { "type": "string", "example": "30", "description": "할인된 아이템 가격입니다." }, "amount_without_discount": { "type": "string", "example": "30", "description": "아이템 가격입니다." }, "currency": { "type": "string", "example": "USD", "description": "아이템 가격 통화입니다. [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)에 따른 3자리 코드입니다." } } } } } } } } } }, "examples": { "response": { "value": { "order_id": 1, "status": "paid", "content": { "price": { "amount": "30", "amount_without_discount": "30", "currency": "USD" }, "is_free": false, "items": [ { "sku": "com.xsolla.item_1", "quantity": 1, "is_free": false, "price": { "amount": "30", "amount_without_discount": "30", "currency": "USD" } } ] } } } } } } }, "Cart-Payment_404-get-order": { "description": "주문을 찾을 수 없습니다. `project_id`와 `order_id`가 올바른지 확인해야 합니다.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "example": 404 }, "errorCode": { "type": "integer", "example": 9001 }, "errorMessage": { "type": "string", "example": "[0401-9001]: Order not found" } } }, "examples": { "response": { "value": { "statusCode": 404, "errorCode": 9001, "errorMessage": "[0401-9001]: Order not found" } } } } } }, "200-admin-order-search": { "description": "주문 목록을 성공적으로 검색했습니다.", "content": { "application/json": { "schema": { "type": "object", "properties": { "orders": { "type": "array", "description": "주문 목록입니다.", "items": { "type": "object", "properties": { "order_id": { "type": "integer", "example": 1, "description": "주문 ID입니다." }, "project_id": { "type": "integer", "example": 44056, "description": "프로젝트 ID입니다. 이 매개 변수는 [관리자 페이지](https://publisher.xsolla.com/)의 프로젝트 이름 옆에서 확인할 수 있습니다." }, "status": { "type": "string", "enum": [ "new", "paid", "done", "canceled", "expired" ], "example": "paid", "description": "주문 상태. 자세한 상태 설명은 [주문 수명 주기](https://developers.xsolla.com/ko/api/catalog/order-life-cycle)) 섹션을 참조하십시오." }, "date_created": { "type": "string", "format": "date-time", "example": "2020-08-11T10:00:00+03:00", "description": "[ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)에 따른 주문 생성 날짜 또는 날짜-시간 코드입니다." }, "mode": { "type": "string", "enum": [ "default", "sandbox" ], "example": "default", "description": "주문 생성 모드입니다." }, "is_free": { "type": "boolean", "example": false, "description": "주문이 무료인지 여부입니다." }, "invoice_id": { "type": "string", "description": "인보이스 ID입니다." }, "price": { "type": [ "object", "null" ], "description": "주문 가격입니다.", "properties": { "amount": { "type": "string", "example": "30", "description": "최종 주문 가격입니다." }, "amount_without_discount": { "type": "string", "example": "30", "description": "할인이 없는 주문 가격입니다." }, "currency": { "type": "string", "example": "USD", "description": "[ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)에 따른 인게임 재화의 SKU 또는 실제 통화의 3자리 코드입니다. [엑솔라에서 지원하는 통화](https://developers.xsolla.com/ko/doc/pay-station/references/supported-currencies/)에 대한 자세한 정보는 설명서를 확인하십시오." }, "is_virtual_currency": { "type": "boolean", "example": false, "description": "통화가 인게임 재화인지 여부입니다." } } }, "user": { "type": "object", "properties": { "id": { "type": "string", "example": "07e653a2b15011e6818f005056a54369", "description": "주문을 생성할 때 전달된 사용자 ID입니다." }, "country": { "type": "string", "description": "[ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)에 따른 대문자 2자리 국가 코드입니다. [액솔라에서 지원하는 국가](https://developers.xsolla.com/ko/doc/shop-builder/references/supported-countries/)에 대한 자세한 정보는 설명서를 참조하십시오.", "example": "US" }, "email": { "type": "string", "format": "email", "example": "user@xsolla.com", "description": "[RFC 822](https://www.w3.org/Protocols/rfc822/#z8) 프로토콜에 따라 형식이 지정된 사용자 이메일입니다." }, "region_id": { "type": [ "integer", "null" ], "example": 12, "description": "사용자의 지역 ID입니다. 지역별 판매 제한이 설정된 경우 반환됩니다. 주문을 생성할 때 전달된 사용자의 국가는 [지역을 생성](https://developers.xsolla.com/ko/api/shop-builder/operation/admin-create-region/)할 때 지정된 국가 목록과 일치합니다. 지역별 판매 제한에 대한 자세한 내용은 [설명서](https://developers.xsolla.com/ko/doc/shop-builder/features/regional-restrictions/)를 참조하십시오." } } }, "items": { "type": "array", "description": "아이템 목록입니다.", "items": { "type": "object", "properties": { "order_item_id": { "type": "integer", "description": "주문의 아이템 ID입니다. 주문 생성 중에 엑솔라에 의해 생성됩니다." }, "item_id": { "type": "integer", "example": 1, "description": "아이템 ID입니다. 아이템을 생성할 때 엑솔라에 의해 생성됩니다." }, "sku": { "type": "string", "example": "elven_shield", "description": "생성하는 동안 지정된 아이템 ID입니다. SKU는 소문자 및 대문자 라틴 영숫자, 마침표, 대시 및 밑줄만 포함할 수 있습니다." }, "type": { "type": "string", "example": "virtual_good", "description": "아이템 유형입니다.", "enum": [ "virtual_good", "virtual_currency", "bundle", "game_key", "physical_good", "value_point" ] }, "quantity": { "type": "integer", "example": 1, "description": "아이템 수량입니다." }, "is_free": { "type": "boolean", "example": false, "default": false, "description": "아이템이 무료인지 여부입니다." }, "is_bonus": { "type": "boolean", "example": false, "description": "아이템이 보너스인지 여부입니다." }, "region_id": { "type": [ "integer", "null" ], "description": "아이템을 사용할 수 있는 지역의 ID입니다. 지역별 판매 제한에 대한 자세한 정보는 [설명서](https://developers.xsolla.com/ko/doc/shop-builder/features/regional-restrictions/)를 참조하십시오." }, "tax_category": { "type": "string", "example": "DG00002", "description": "세금 범주입니다." }, "price": { "type": [ "object", "null" ], "description": "아이템 가격입니다.", "properties": { "amount": { "type": "string", "example": "30", "description": "할인된 아이템 가격입니다." }, "amount_without_discount": { "type": "string", "example": "30", "description": "할인이 없는 아이템 가격입니다." }, "currency": { "type": "string", "example": "USD", "description": "[ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)에 따른 인게임 재화의 SKU 또는 3자리 코드입니다. [엑솔라에서 지원하는 통화](https://developers.xsolla.com/ko/doc/pay-station/references/supported-currencies/)에 대한 자세한 정보는 설명서를 참조하십시오." }, "is_virtual_currency": { "type": "boolean", "example": false, "description": "통화가 인게임 재화인지 여부입니다." } } }, "description": { "type": [ "object", "null" ], "description": "아이템에 대한 정보가 있는 개체입니다.", "properties": { "name": { "type": "string", "description": "아이템 이름입니다." }, "image_url": { "type": "string", "format": "uri", "description": "아이템 이미지 URL입니다." }, "description": { "type": "string", "description": "아이템 설명입니다." } } } } } }, "promotions": { "type": [ "array", "null" ], "description": "주문에 적용된 프로모션 목록입니다.", "items": { "type": "object", "properties": { "promotion_id": { "type": "integer", "example": 111425, "description": "프로젝트 내의 프로모션 ID입니다." } } } }, "coupons": { "type": [ "array", "null" ], "description": "주문에 적용된 쿠폰 목록입니다.", "items": { "type": "object", "properties": { "coupon_id": { "type": "integer", "description": "쿠폰으로 프로모션을 생성할 때 엑솔라가 생성한 쿠폰 ID입니다." }, "sku": { "type": "string", "description": "쿠폰으로 프로모션을 생성할 때 엑솔라가 생성하는 쿠폰 SKU입니다." }, "code": { "type": "string", "description": "사용된 쿠폰 코드입니다. 대소문자를 구분하는 고유한 코드입니다. 문자와 숫자를 포함합니다." }, "type": { "type": "string", "enum": [ "unique_catalog_offer", "coupon", "promocode" ], "description": "쿠폰의 종류입니다." } } } } } } }, "total_items_count": { "type": "integer", "example": 1, "description": "지정된 기간 동안의 총 주문 수입니다." }, "has_more": { "type": "boolean", "example": true, "description": "추가 페이지가 있는지 여부입니다." } } }, "examples": { "response": { "value": { "orders": [ { "order_id": 100511, "project_id": 101, "status": "done", "date_created": "2018-01-08T15:32:06+03:00", "mode": "default", "user": { "id": "07e653a2b15011e6818f005056a54369", "country": "US", "email": "user@xsolla.com", "region_id": 1 }, "is_free": true, "items": [ { "order_item_id": 29, "item_id": 1005111, "sku": "com.xsolla.1005111", "type": "virtual_good", "quantity": 1, "is_free": true, "is_bonus": false, "region_id": 1, "tax_category": "DG00001", "description": { "name": "bla", "image_url": "http://example.com/image.jpg", "description": "yes" } }, { "order_item_id": 30, "item_id": 1005112, "sku": "com.xsolla.1005112", "type": "value_point", "quantity": 3, "is_free": true, "is_bonus": true, "region_id": 1, "tax_category": "DG00001", "description": null } ] }, { "order_id": 100510, "project_id": 101, "status": "paid", "date_created": "2018-01-07T15:32:06+03:00", "mode": "default", "user": { "id": "07e653a2b15011e6818f005056a54369", "country": "US", "email": "user@xsolla.com", "region_id": null }, "is_free": false, "items": [ { "order_item_id": 27, "item_id": 1005101, "sku": "com.xsolla.1005101", "type": "game_key", "quantity": 1, "is_free": false, "is_bonus": false, "region_id": null, "tax_category": "DG00001", "description": null, "price": { "amount": "67.3400", "amount_without_discount": "67.3400", "currency": "USD", "is_virtual_currency": false } }, { "order_item_id": 28, "item_id": 1005102, "sku": "com.xsolla.1005102", "type": "value_point", "quantity": 2, "is_free": true, "is_bonus": true, "region_id": null, "tax_category": "DG00001", "description": null } ], "price": { "amount": "67.3400", "amount_without_discount": "72.3400", "currency": "USD", "is_virtual_currency": false }, "invoice_id": "100510", "promotions": [ { "promotion_id": 1005101 } ], "coupons": [ { "coupon_id": 100510, "sku": "com.xsolla.100510", "code": "OPQRSTUVWX", "type": "promocode" } ] }, { "order_id": 100505, "project_id": 101, "status": "paid", "date_created": "2018-01-02T15:32:06+03:00", "mode": "default", "user": { "id": "07e653a2b15011e6818f005056a54369", "country": "US", "email": "user@xsolla.com", "region_id": null }, "is_free": false, "items": [ { "order_item_id": 17, "item_id": 1005051, "sku": "com.xsolla.1005051", "type": "virtual_good", "quantity": 1, "is_free": true, "is_bonus": true, "region_id": null, "tax_category": "DG00001", "description": null }, { "order_item_id": 18, "item_id": 1005052, "sku": "com.xsolla.1005052", "type": "value_point", "quantity": 3, "is_free": true, "is_bonus": true, "region_id": null, "tax_category": "DG00001", "description": null } ], "price": { "amount": "78.2300", "amount_without_discount": "78.2300", "currency": "popugi", "is_virtual_currency": true } } ], "total_items_count": 11, "has_more": true } } } } } }, "401-invalid-basic-auth": { "description": "기본 인증이 전달되지 않았거나 잘못되었습니다. 기본 인증 또는 올바른 자격 증명을 사용했는지 확인해야 합니다.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "example": 401 }, "errorCode": { "type": "integer", "example": 1020 }, "errorMessage": { "type": "string", "example": "[0401-1020]: Error in Authentication method occurred" } } }, "examples": { "response": { "value": { "statusCode": 401, "errorCode": 1020, "errorMessage": "[0401-1020]: Error in Authentication method occurred" } } } } } }, "Cart-Payment_201-admin-create-payment-token": { "description": "결제 토큰 및 주문을 생성했습니다.", "content": { "application/json": { "schema": { "type": "object", "properties": { "token": { "type": "string", "description": "결제 토큰입니다." }, "order_id": { "type": "integer", "example": 1, "description": "주문 ID입니다." } } }, "examples": { "response": { "value": { "token": "huooAqbXBSJxB8Q4dYBqJp4ybiInqsPb", "order_id": 12345 } } } } } }, "Cart-Payment_401-invalid-basic-auth": { "description": "기본 인증이 전달되지 않았거나 잘못되었습니다. 기본 인증 또는 올바른 자격 증명을 사용했는지 확인해야 합니다.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "example": 401 }, "errorCode": { "type": "integer", "example": 1020 }, "errorMessage": { "type": "string", "example": "[0401-1020]: Error in Authentication method occurred" } } }, "examples": { "response": { "value": { "statusCode": 401, "errorCode": 1020, "errorMessage": "[0401-1020]: Error in Authentication method occurred" } } } } } }, "Cart-Payment_422-admin-create-payment-token": { "description": "요청 본문 및 장바구니 유효성 검사 오류입니다.\n- 전달된 아이템에서 생성된 유효하지 않은 장바구니입니다. 장바구니가 비어 있지 않은지, 모든 아이템이 무료가 아닌지 확인해야 합니다.\n- 잘못된 요청 본문입니다.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/422-invalid-request" }, "examples": { "Invalid request body": { "value": { "errorCode": 1102, "statusCode": 422, "errorMessage": "[0401-1102]: Unprocessable Entity. The property `name` is required", "transactionId": "da145238620011eb8e24fe6913ff226a" } }, "Item is free": { "value": { "errorCode": 1421, "statusCode": 422, "errorMessage": "[0401-1421]: Item is free", "transactionId": "da145238620011eb8e24fe6913ff226a" } }, "Invalid cart": { "value": { "errorCode": 1401, "statusCode": 422, "errorMessage": "[0401-1401]: Invalid cart", "transactionId": "da145238620011eb8e24fe6913ff226a" } }, "Empty cart": { "value": { "errorCode": 1417, "statusCode": 422, "errorMessage": "[0401-1417]: Empty cart! Cart shouldn't be empty!", "transactionId": "da145238620011eb8e24fe6913ff226a" } }, "User country not provided": { "value": { "errorCode": 1102, "statusCode": 422, "errorMessage": "[0401-1102]: The parameter user.country.value or the header X-User-Ip must be specified", "transactionId": "da145238620011eb8e24fe6913ff226a" } } } } } }, "Cart-Payment_200-admin-fill-cart-json-model": { "description": "아이템이 있는 장바구니를 성공적으로 반환했습니다.", "content": { "application/json": { "schema": { "type": "object", "properties": { "cart_id": { "type": "string", "example": "cart_id", "description": "장바구니 ID. 구매 페이지 또는 결제 API 엔드포인트를 쿼리하려면 장바구니 ID를 전달합니다." }, "price": { "type": [ "object", "null" ], "properties": { "amount": { "type": "string" }, "amount_without_discount": { "type": "string" }, "currency": { "type": "string" } }, "description": "장바구니 가격입니다." }, "is_free": { "$ref": "#/components/schemas/value-cart_is_free" }, "items": { "type": "array", "items": { "type": "object", "properties": { "sku": { "type": "string" }, "groups": { "type": "array", "items": { "type": "object", "properties": { "external_id": { "type": "string" }, "name": { "type": "string" } } } }, "name": { "type": [ "string", "null" ] }, "attributes": { "$ref": "#/components/schemas/Cart-Payment_client-attributes" }, "type": { "type": "string" }, "description": { "type": "string" }, "image_url": { "type": "string" }, "quantity": { "type": "integer" }, "is_free": { "$ref": "#/components/schemas/value-is_free" }, "is_bonus": { "type": "boolean" }, "promotions": { "$ref": "#/components/schemas/Catalog_item_promotions" }, "can_be_bought": { "$ref": "#/components/schemas/Can_be_bought" }, "vp_rewards": { "$ref": "#/components/schemas/client-item-value-point-reward" }, "limits": { "$ref": "#/components/schemas/Catalog_item_limits" }, "periods": { "$ref": "#/components/schemas/item-periods" }, "price": { "type": [ "object", "null" ], "properties": { "amount": { "type": "string" }, "amount_without_discount": { "type": "string" }, "currency": { "type": "string" } }, "description": "아이템 가격입니다." }, "virtual_prices": { "$ref": "#/components/schemas/client_virtual_prices_response" } } } }, "promotions": { "$ref": "#/components/schemas/Catalog_cart_promotions" }, "warnings": { "type": "array", "items": { "type": "object", "properties": { "sku": { "type": "string" }, "quantity": { "type": "integer" }, "errorCode": { "type": "integer" }, "errorMessage": { "type": "string" } } } } } }, "examples": { "response": { "value": { "cart_id": "cart_id", "is_free": false, "items": [ { "attributes": [], "description": "The cup of tea", "groups": [ { "external_id": "cups", "name": "Cups" } ], "image_url": "https://cdn.xsolla.net/img/misc/images/e9f2f4a634bc96ea03b5d5ceadd7c55f.png", "is_free": false, "is_bonus": false, "name": "Cup", "price": { "amount": "5.99", "amount_without_discount": "5.99", "currency": "USD" }, "quantity": 2, "sku": "com.xsolla.cup01", "type": "physical_good", "virtual_prices": [], "promotions": [], "can_be_bought": true, "vp_rewards": [ { "item_id": 175232, "sku": "com.xsolla.value_point_1", "amount": 130, "name": "Value point", "image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg" }, { "item_id": 186321, "sku": "com.xsolla.clan_value_point_1", "amount": 50, "name": "Clan Reward VP 1", "image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg", "is_clan": true } ], "limits": { "per_user": { "available": 3, "recurrent_schedule": { "interval_type": "weekly", "reset_next_date": 1746057600 }, "total": 5 } }, "periods": [ { "date_from": "2020-08-11T10:00:00+03:00", "date_until": "2020-08-11T20:00:00+03:00" } ] }, { "attributes": [], "description": "Wonderful white T-shirt", "groups": [], "image_url": "https://cdn.xsolla.net/img/misc/images/e9f2f4a634bc96ea03b5d5ceadd7c55f.png", "is_free": false, "is_bonus": false, "name": "White T-shirt", "price": { "amount": "3.99", "amount_without_discount": "4.99", "currency": "USD" }, "quantity": 1, "sku": "com.xsolla.t-shirt01", "type": "physical_good", "virtual_prices": [], "promotions": [ { "name": "Bonus promotion", "date_start": "2020-04-15T16:16:00+03:00", "date_end": "2026-04-15T16:16:00+03:00", "discount": { "percent": "50.00" }, "bonus": [ { "quantity": 1, "name": "Xsolla Minigun", "image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png", "sku": "com.xsolla.minigun_1", "type": "virtual_good" } ] } ], "can_be_bought": true, "vp_rewards": [ { "item_id": 175232, "sku": "com.xsolla.value_point_1", "amount": 130, "name": "Value point", "image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg" }, { "item_id": 186321, "sku": "com.xsolla.clan_value_point_1", "amount": 50, "name": "Clan Reward VP 1", "image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg", "is_clan": true } ], "limits": { "per_user": { "available": 3, "recurrent_schedule": { "interval_type": "weekly", "reset_next_date": 1746057600 }, "total": 5 } }, "periods": [ { "date_from": "2020-08-11T10:00:00+03:00", "date_until": "2020-08-11T20:00:00+03:00" } ] }, { "attributes": [], "description": "Wonderful white T-shirt", "groups": [ { "external_id": "clothes", "name": "Clothes" } ], "image_url": "https://cdn.xsolla.net/img/misc/images/e9f2f4a634bc96ea03b5d5ceadd7c55f.png", "is_free": true, "is_bonus": false, "name": "Cat's cup", "price": null, "quantity": 1, "sku": "com.xsolla.cup01", "type": "physical_good", "virtual_prices": [], "promotions": [], "can_be_bought": true, "vp_rewards": [ { "item_id": 175232, "sku": "com.xsolla.value_point_1", "amount": 130, "name": "Value point", "image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg" }, { "item_id": 186321, "sku": "com.xsolla.clan_value_point_1", "amount": 50, "name": "Clan Reward VP 1", "image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg", "is_clan": true } ], "limits": { "per_user": { "available": 3, "recurrent_schedule": { "interval_type": "weekly", "reset_next_date": 1746057600 }, "total": 5 } }, "periods": [ { "date_from": "2020-08-11T10:00:00+03:00", "date_until": "2020-08-11T20:00:00+03:00" } ] } ], "warnings": [ { "sku": "com.xsolla.hat01", "quantity": 1, "errorCode": 4001, "errorMessage": "[0401-4001]: Item with Project Id = 44056 and Sku = hut01 not found" } ], "price": { "amount": "15.97", "amount_without_discount": "22.96", "currency": "USD" }, "promotions": [ { "name": "Bonus promotion", "date_start": "2020-04-15T16:16:00+03:00", "date_end": "2026-04-15T16:16:00+03:00", "discount": { "percent": "50.00" }, "bonus": [ { "quantity": 1, "name": "Xsolla Minigun", "image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png", "sku": "com.xsolla.minigun_1", "type": "virtual_good" } ] } ] } } } } } }, "Cart-Payment_404-user": { "description": "사용자를 찾을 수 없습니다. `x-user-for` 또는 `x-user-id` 토큰이 올바른지 확인해야 합니다.", "content": { "application/json": { "schema": { "properties": { "statusCode": { "type": "integer", "example": 404 }, "errorCode": { "type": "integer", "example": 5008 }, "errorMessage": { "type": "string", "example": "[0401-5008]: Could not find User" } }, "type": "object" } } } }, "Common_401-invalid-basic-auth": { "description": "기본 인증 자격 증명이 제공되지 않았거나 올바르지 않습니다. 기본 인증을 사용하고 있는지 확인하고 자격 증명이 올바른지 확인해 주세요.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "example": 401 }, "errorCode": { "type": "integer", "example": 1020 }, "errorMessage": { "type": "string", "example": "[0401-1020]: Error in Authentication method occurred" } } }, "examples": { "response": { "value": { "statusCode": 401, "errorCode": 1020, "errorMessage": "[0401-1020]: Error in Authentication method occurred" } } } } } }, "200-admin-get-user-item-limits": { "description": "사용자 한 명에 대한 구매 제한 설정을 성공적으로 수신했습니다.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User-limit-item" }, "examples": { "response": { "value": { "per_user": { "total": 10, "available": 9 } } } } } } }, "connector-422-validation-failed": { "description": "요청 본문, 파일 특성 또는 파일 콘텐츠의 잘못된 매개 변수로 인해 발생하는 유효성 검사 오류입니다.", "content": { "application/json": { "schema": { "type": "object", "properties": { "errorCode": { "type": "integer", "example": 1803 }, "statusCode": { "type": "integer", "example": 422 }, "errorMessage": { "type": "string", "example": "[0410-1803]: File content-type doesn't allowed. Allowed content types: application/json; current content type: text/plain" }, "transactionId": { "type": "string", "example": "x-x-x-x-transactionId-mock-x-x-x" } } }, "examples": { "response": { "value": { "statusCode": 422, "errorCode": 1803, "errorMessage": "[0410-1803]: File content-type doesn't allowed. Allowed content types: application/json; current content type: text/plain", "transactionId": "x-x-x-x-transactionId-mock-x-x-x" } } } } } }, "200-items-import-status-model": { "description": "가져오기 상태가 성공적으로 검색되었습니다.", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "example": "error", "description": "가져오기 상태입니다.\n\n가능한 값:\n- `initialized` - 가져오기가 시작되었습니다.\n- `process` - 가져오기 중입니다.\n- `done` - 가져오기가 성공적으로 완료되었습니다.\n- `error` - 오류로 인해 가져오기가 완료되지 않았거나 부분적으로만 완료되었습니다.", "enum": [ "initialized", "process", "done", "error" ] }, "date_created": { "type": "string", "example": "2024-12-15T18:16:00+03:00", "description": "GMT+3 시간대로 표시되는 가져오기 생성 작업의 타임스탬프입니다." }, "date_updated": { "type": "string", "example": "2024-12-15T18:16:00+03:00", "description": "오류로 인해 가져오기가 중단된 GMT+3 시간대로 표시되는 타임스탬프입니다." }, "date_completed": { "type": "string", "example": "2024-12-15T18:16:00+03:00", "description": "GMT+3 시간대로 표시되는 가져오기 작업 완료 타임스탬프입니다. 오류로 인해 가져오기가 중단되고 가져온 아이템이 없는 경우 빈 문자열이 반환됩니다." }, "progress": { "type": "integer", "example": 100, "description": "가져오기 실행 진행률(%)입니다." }, "error": { "type": "string", "description": "일반 가져오기 오류에 대한 설명입니다." }, "error_code": { "type": "string", "description": "일반 가져오기 오류에 대한 코드입니다." }, "result": { "type": "object", "description": "특정 아이템 SKU에 대한 가져오기 결과 및 가져오기 오류에 대한 데이터가 있는 개체입니다.", "properties": { "errors_count": { "type": "integer", "example": 3, "description": "가져오는 동안 오류가 발생한 아이템 수입니다." }, "total_entities_count": { "type": "integer", "example": 11, "description": "가져온 아이템의 총 수입니다." }, "errors_by_sku": { "type": "array", "description": "특정 아이템 SKU에 대한 가져오기 오류에 대한 데이터가 있는 개체 배열입니다.", "items": { "type": "object", "properties": { "sku": { "type": "string", "example": "sku_1", "description": "가져온 아이템에 대한 SKU입니다." }, "type": { "type": "string", "example": "vi", "description": "아이템 유형입니다.", "enum": [ "virtual_good", "virtual_currency", "virtual_currency_packages", "bundle" ] }, "error_code": { "type": "integer", "example": 1001, "description": "특정 아이템 SKU에 대한 가져오기 오류 코드입니다." }, "error_message": { "type": "string", "example": "Something went wrong", "description": "특정 아이템 SKU에 대한 가져오기 오류에 대한 설명입니다." } } } } } } }, "example": { "status": "error", "date_created": "2024-11-19T14:27:31+03:00", "date_updated": "2024-11-19T15:27:31+03:00", "date_completed": "2024-11-19T15:27:31+03:00", "progress": 100, "error": null, "error_code": null, "result": { "errors_count": 2, "total_entities_count": 10, "errors_by_sku": [ { "sku": "com.xsolla.sword_1", "type": "virtual_items", "error_code": 4055, "error_message": "[0401-4055]: Item default price not set" }, { "sku": "", "type": null, "error_code": 1817, "error_message": "[0410-1817]: SKU can't be empty" } ] } } } } } }, "sellable_items_200-get-items-list": { "description": "판매할 수 있는 아이템 목록을 성공적으로 수신했습니다.", "content": { "application/json": { "schema": { "type": "object", "description": "판매할 수 있는 아이템이 있는 개체입니다.", "properties": { "has_more": { "$ref": "#/components/schemas/Pagination_has-more" }, "items": { "type": "array", "example": [ { "item_id": 259765, "sku": "com.xsolla.gold_1", "type": "virtual_currency", "name": "Gold", "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png", "price": { "amount": "1.00", "amount_without_discount": "1.00", "currency": "USD" }, "virtual_prices": [], "can_be_bought": true, "attributes": [], "is_free": false, "groups": [], "limits": { "per_user": { "total": 5, "available": 3, "recurrent_schedule": { "interval_type": "weekly", "reset_next_date": 1746057600 }, "limit_exceeded_visibility": "show" } }, "vp_rewards": [ { "item_id": 175232, "sku": "com.xsolla.value_point_1", "amount": 130, "name": "Value point", "image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg" }, { "item_id": 186321, "sku": "com.xsolla.clan_value_point_1", "amount": 50, "name": "Clan Reward VP 1", "image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg", "is_clan": true } ] }, { "item_id": 259766, "sku": "com.xsolla.silver_1", "type": "virtual_currency", "name": "Silver", "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png", "price": { "amount": "0.50", "amount_without_discount": "0.50", "currency": "USD" }, "virtual_prices": [], "can_be_bought": true, "attributes": [], "is_free": false, "groups": [], "limits": null, "vp_rewards": [] }, { "item_id": 259767, "sku": "com.xsolla.bronze_1", "type": "virtual_currency", "name": "Bronze", "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png", "price": { "amount": "0.10", "amount_without_discount": "0.10", "currency": "USD" }, "virtual_prices": [], "can_be_bought": true, "attributes": [], "is_free": false, "groups": [], "limits": null, "vp_rewards": [] }, { "item_id": 259768, "sku": "com.xsolla.gold_chest_1", "type": "bundle", "name": "Chest of gold", "bundle_type": "virtual_currency_package", "description": "Chest of gold", "image_url": "https://cdn3.xsolla.com/img/misc/images/61b8d0785093017ce1f50ebed55c42a9.png", "price": { "amount": "7.99", "amount_without_discount": "7.99", "currency": "USD" }, "virtual_prices": [], "can_be_bought": true, "attributes": [], "is_free": false, "groups": [], "content": [ { "item_id": 259765, "sku": "com.xsolla.gold_1", "type": "virtual_currency", "name": "Gold", "description": null, "image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png", "quantity": 10 } ], "limits": null, "vp_rewards": [] }, { "item_id": 259769, "sku": "com.xsolla.silver_chest_1", "type": "bundle", "name": "Chest of silver", "bundle_type": "virtual_currency_package", "description": "Chest of silver", "image_url": "https://cdn3.xsolla.com/img/misc/images/f0b59a3370404e8881107249051b70bd.png", "price": { "amount": "19.99", "amount_without_discount": "19.99", "currency": "USD" }, "virtual_prices": [], "can_be_bought": true, "attributes": [], "is_free": false, "groups": [], "content": [ { "item_id": 259766, "sku": "com.xsolla.silver_1", "type": "virtual_currency", "name": "Silver", "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png", "quantity": 50 } ], "limits": null, "vp_rewards": [] }, { "item_id": 259770, "sku": "com.xsolla.bronze_chest_1", "type": "bundle", "name": "Chest of bronze", "bundle_type": "virtual_currency_package", "description": "Chest of bronze", "image_url": "https://cdn3.xsolla.com/img/misc/images/b32eb5b1f4f0c202ea6ac4e21c2eae18.png", "price": { "amount": "5.99", "amount_without_discount": "5.99", "currency": "USD" }, "virtual_prices": [], "can_be_bought": true, "attributes": [], "is_free": false, "groups": [], "content": [ { "item_id": 259767, "sku": "com.xsolla.bronze_2", "type": "virtual_currency", "name": "Bronze", "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png", "quantity": 100 } ], "limits": null, "vp_rewards": [] }, { "item_id": 259771, "sku": "com.xsolla.sword_1", "type": "virtual_good", "name": "Sword", "description": "Sword", "image_url": "https://cdn3.xsolla.com/img/misc/images/a558727a420cad609556e4449b9ecb12.png", "price": { "amount": "1.99", "amount_without_discount": "1.99", "currency": "USD" }, "virtual_prices": [ { "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png", "item_id": 259765, "sku": "com.xsolla.gold_2", "name": "Gold", "type": "virtual_currency", "amount": 2, "amount_without_discount": 2, "calculated_price": { "amount": "2.00", "amount_without_discount": "2.00" }, "is_default": true }, { "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png", "item_id": 259766, "sku": "com.xsolla.silver_2", "name": "Silver", "type": "virtual_currency", "amount": 5, "amount_without_discount": 5, "calculated_price": { "amount": "5.00", "amount_without_discount": "5.00" }, "is_default": false }, { "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png", "item_id": 259767, "sku": "com.xsolla.bronze_2", "name": "Bronze", "type": "virtual_currency", "amount": 50, "amount_without_discount": 50, "calculated_price": { "amount": "50.00", "amount_without_discount": "50.00" }, "is_default": false } ], "can_be_bought": true, "attributes": [], "is_free": false, "groups": [ { "external_id": "swords", "name": "Swords" } ], "virtual_item_type": "non_consumable", "limits": null, "vp_rewards": [] }, { "item_id": 259772, "sku": "com.xsolla.saber_1", "type": "virtual_good", "name": "Saber", "description": "Saber", "image_url": "https://cdn3.xsolla.com/img/misc/images/edd914d60301d77b94926478d253fcb6.png", "price": { "amount": "3.99", "amount_without_discount": "3.99", "currency": "USD" }, "virtual_prices": [ { "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png", "item_id": 259765, "sku": "com.xsolla.gold_3", "name": "Gold", "type": "virtual_currency", "amount": 3, "amount_without_discount": 3, "calculated_price": { "amount": "3.00", "amount_without_discount": "3.00" }, "is_default": true }, { "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png", "item_id": 259766, "sku": "com.xsolla.silver_3", "name": "Silver", "type": "virtual_currency", "amount": 7, "amount_without_discount": 7, "calculated_price": { "amount": "7.00", "amount_without_discount": "7.00" }, "is_default": false }, { "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png", "item_id": 259767, "sku": "com.xsolla.bronze_3", "name": "Bronze", "type": "virtual_currency", "amount": 70, "amount_without_discount": 70, "calculated_price": { "amount": "70.00", "amount_without_discount": "70.00" }, "is_default": false } ], "can_be_bought": true, "attributes": [], "is_free": false, "groups": [ { "external_id": "swords", "name": "Swords" } ], "virtual_item_type": "non_consumable", "limits": null, "vp_rewards": [] }, { "item_id": 259773, "sku": "com.xsolla.bow_1", "type": "virtual_good", "name": "Bow", "description": "Bow", "image_url": "https://cdn3.xsolla.com/img/misc/images/3bb3b0a5254ad15134c891108898363f.png", "price": { "amount": "4.99", "amount_without_discount": "4.99", "currency": "USD" }, "virtual_prices": [ { "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png", "item_id": 259765, "sku": "com.xsolla.gold_4", "name": "Gold", "type": "virtual_currency", "amount": 5, "amount_without_discount": 5, "calculated_price": { "amount": "5.00", "amount_without_discount": "5.00" }, "is_default": true }, { "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png", "item_id": 259766, "sku": "com.xsolla.silver_4", "name": "Silver", "type": "virtual_currency", "amount": 10, "amount_without_discount": 10, "calculated_price": { "amount": "10.00", "amount_without_discount": "10.00" }, "is_default": false }, { "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png", "item_id": 259767, "sku": "com.xsolla.bronze_4", "name": "Bronze", "type": "virtual_currency", "amount": 100, "amount_without_discount": 100, "calculated_price": { "amount": "100.00", "amount_without_discount": "100.00" }, "is_default": false } ], "can_be_bought": true, "attributes": [], "is_free": false, "groups": [ { "external_id": "bows", "name": "Bows" } ], "virtual_item_type": "non_consumable", "limits": null, "vp_rewards": [] }, { "item_id": 259774, "sku": "com.xsolla.electric_shield_1", "type": "virtual_good", "name": "Electric shield", "description": "Electric shield", "image_url": "https://cdn3.xsolla.com/img/misc/images/d2d6b1b517e6a7f3765c3bb5a3cfb87d.png", "price": { "amount": "9.99", "amount_without_discount": "9.99", "currency": "USD" }, "virtual_prices": [ { "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png", "item_id": 259765, "sku": "com.xsolla.gold_5", "name": "Gold", "type": "virtual_currency", "amount": 10, "amount_without_discount": 10, "calculated_price": { "amount": "10.00", "amount_without_discount": "10.00" }, "is_default": true }, { "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png", "item_id": 259766, "sku": "com.xsolla.silver_5", "name": "Silver", "type": "virtual_currency", "amount": 20, "amount_without_discount": 20, "calculated_price": { "amount": "20.00", "amount_without_discount": "20.00" }, "is_default": false }, { "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png", "item_id": 259767, "sku": "com.xsolla.bronze_5", "name": "Bronze", "type": "virtual_currency", "amount": 200, "amount_without_discount": 200, "calculated_price": { "amount": "200.00", "amount_without_discount": "200.00" }, "is_default": false } ], "can_be_bought": true, "attributes": [], "is_free": false, "groups": [ { "external_id": "armour", "name": "Armour" } ], "virtual_item_type": "non_consumable", "vp_rewards": [] }, { "item_id": 259775, "sku": "com.xsolla.royal_shield_1", "type": "virtual_good", "name": "Royal shield", "description": "Royal shield", "image_url": "https://cdn3.xsolla.com/img/misc/images/ed417975312a52efeeab8b039ff25cb1.png", "price": { "amount": "19.99", "amount_without_discount": "19.99", "currency": "USD" }, "virtual_prices": [ { "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png", "item_id": 259765, "sku": "com.xsolla.gold_6", "name": "Gold", "type": "virtual_currency", "amount": 20, "amount_without_discount": 20, "calculated_price": { "amount": "20.00", "amount_without_discount": "20.00" }, "is_default": true }, { "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png", "item_id": 259766, "sku": "com.xsolla.silver_6", "name": "Silver", "type": "virtual_currency", "amount": 40, "amount_without_discount": 40, "calculated_price": { "amount": "40.00", "amount_without_discount": "40.00" }, "is_default": false }, { "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png", "item_id": 259767, "sku": "com.xsolla.bronze_6", "name": "Bronze", "type": "virtual_currency", "amount": 400, "amount_without_discount": 400, "calculated_price": { "amount": "400.00", "amount_without_discount": "400.00" }, "is_default": false } ], "can_be_bought": true, "attributes": [], "is_free": false, "groups": [ { "external_id": "armour", "name": "Armour" } ], "virtual_item_type": "non_consumable", "vp_rewards": [] }, { "item_id": 259776, "sku": "com.xsolla.ancient_helmet_1", "type": "virtual_good", "name": "Ancient helmet", "description": "Ancient helmet", "image_url": "https://cdn3.xsolla.com/img/misc/images/e70e16d9626f435e519fc8e1cc1e7176.png", "price": { "amount": "1.99", "amount_without_discount": "1.99", "currency": "USD" }, "virtual_prices": [ { "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png", "item_id": 259765, "sku": "com.xsolla.gold_7", "name": "Gold", "type": "virtual_currency", "amount": 2, "amount_without_discount": 2, "calculated_price": { "amount": "2.00", "amount_without_discount": "2.00" }, "is_default": true }, { "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png", "item_id": 259766, "sku": "com.xsolla.silver_7", "name": "Silver", "type": "virtual_currency", "amount": 4, "amount_without_discount": 4, "calculated_price": { "amount": "4.00", "amount_without_discount": "4.00" }, "is_default": false }, { "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png", "item_id": 259767, "sku": "com.xsolla.bronze_7", "name": "Bronze", "type": "virtual_currency", "amount": 40, "amount_without_discount": 40, "calculated_price": { "amount": "40.00", "amount_without_discount": "40.00" }, "is_default": false } ], "can_be_bought": true, "attributes": [], "is_free": false, "groups": [ { "external_id": "armour", "name": "Armour" } ], "virtual_item_type": "non_consumable", "vp_rewards": [] }, { "item_id": 259777, "sku": "com.xsolla.wooden_helmet_1", "type": "virtual_good", "name": "Wooden helmet", "description": "Wooden helmet", "image_url": "https://cdn3.xsolla.com/img/misc/images/40d2812e52ad9d988ac20fc842fc66f0.png", "price": { "amount": "0.99", "amount_without_discount": "0.99", "currency": "USD" }, "virtual_prices": [ { "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png", "item_id": 259765, "sku": "com.xsolla.gold_8", "name": "Gold", "type": "virtual_currency", "amount": 1, "amount_without_discount": 1, "calculated_price": { "amount": "1.00", "amount_without_discount": "1.00" }, "is_default": true }, { "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png", "item_id": 259766, "sku": "com.xsolla.silver_8", "name": "Silver", "type": "virtual_currency", "amount": 2, "amount_without_discount": 2, "calculated_price": { "amount": "2.00", "amount_without_discount": "2.00" }, "is_default": false }, { "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png", "item_id": 259767, "sku": "com.xsolla.bronze_8", "name": "Bronze", "type": "virtual_currency", "amount": 20, "amount_without_discount": 20, "calculated_price": { "amount": "20.00", "amount_without_discount": "20.00" }, "is_default": false } ], "can_be_bought": true, "attributes": [], "is_free": false, "groups": [ { "external_id": "armour", "name": "Armour" } ], "virtual_item_type": "non_consumable", "vp_rewards": [] }, { "item_id": 259778, "sku": "com.xsolla.armor_chest_1", "type": "bundle", "name": "Chest of armor", "bundle_type": "standard", "description": "Chest of armour", "image_url": "https://cdn3.xsolla.com/img/misc/images/5212202f9b8c9dbd254652d6cbeba03e.png", "price": { "amount": "19.99", "amount_without_discount": "19.99", "currency": "USD" }, "virtual_prices": [ { "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png", "item_id": 259765, "sku": "com.xsolla.gold_9", "name": "Gold", "type": "virtual_currency", "amount": 20, "amount_without_discount": 20, "calculated_price": { "amount": "20.00", "amount_without_discount": "20.00" }, "is_default": true }, { "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png", "item_id": 259766, "sku": "com.xsolla.silver_9", "name": "Silver", "type": "virtual_currency", "amount": 40, "amount_without_discount": 40, "calculated_price": { "amount": "40.00", "amount_without_discount": "40.00" }, "is_default": false }, { "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png", "item_id": 259767, "sku": "com.xsolla.bronze_9", "name": "Bronze", "type": "virtual_currency", "amount": 400, "amount_without_discount": 400, "calculated_price": { "amount": "400.00", "amount_without_discount": "400.00" }, "is_default": false } ], "can_be_bought": true, "attributes": [], "is_free": false, "groups": [], "total_content_price": { "amount": "11.98", "amount_without_discount": "11.98", "currency": "USD" }, "content": [ { "item_id": 259774, "sku": "com.xsolla.electric_shield_2", "type": "virtual_good", "name": "Electric shield", "description": "Electric shield", "image_url": "https://cdn3.xsolla.com/img/misc/images/d2d6b1b517e6a7f3765c3bb5a3cfb87d.png", "price": { "amount": "9.99", "amount_without_discount": "9.99", "currency": "USD" }, "virtual_prices": [ { "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png", "item_id": 259765, "sku": "com.xsolla.gold_10", "name": "Gold", "type": "virtual_currency", "amount": 10, "amount_without_discount": 10, "calculated_price": { "amount": "10.00", "amount_without_discount": "10.00" }, "is_default": true }, { "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png", "item_id": 259766, "sku": "com.xsolla.silver_10", "name": "Silver", "type": "virtual_currency", "amount": 20, "amount_without_discount": 20, "calculated_price": { "amount": "20.00", "amount_without_discount": "20.00" }, "is_default": false }, { "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png", "item_id": 259767, "sku": "com.xsolla.bronze_10", "name": "Bronze", "type": "virtual_currency", "amount": 200, "amount_without_discount": 200, "calculated_price": { "amount": "200.00", "amount_without_discount": "200.00" }, "is_default": false } ], "can_be_bought": true, "attributes": [], "is_free": false, "groups": [ { "external_id": "armour", "name": "Armour" } ], "virtual_item_type": "non_consumable", "quantity": 1 }, { "item_id": 259776, "sku": "com.xsolla.ancient_helmet_2", "type": "virtual_good", "name": "Ancient helmet", "description": "Ancient helmet", "image_url": "https://cdn3.xsolla.com/img/misc/images/e70e16d9626f435e519fc8e1cc1e7176.png", "price": { "amount": "1.99", "amount_without_discount": "1.99", "currency": "USD" }, "virtual_prices": [ { "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png", "item_id": 259765, "sku": "com.xsolla.gold_11", "name": "Gold", "type": "virtual_currency", "amount": 2, "amount_without_discount": 2, "calculated_price": { "amount": "2.00", "amount_without_discount": "2.00" }, "is_default": true }, { "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png", "item_id": 259766, "sku": "com.xsolla.silver_11", "name": "Silver", "type": "virtual_currency", "amount": 4, "amount_without_discount": 4, "calculated_price": { "amount": "4.00", "amount_without_discount": "4.00" }, "is_default": false }, { "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png", "item_id": 259767, "sku": "com.xsolla.bronze_11", "name": "Bronze", "type": "virtual_currency", "amount": 40, "amount_without_discount": 40, "calculated_price": { "amount": "40.00", "amount_without_discount": "40.00" }, "is_default": false } ], "can_be_bought": true, "attributes": [], "is_free": false, "groups": [ { "external_id": "armour", "name": "Armour" } ], "virtual_item_type": "non_consumable", "quantity": 1 } ], "vp_rewards": [] }, { "item_id": 259779, "sku": "com.xsolla.treasure_chest_1", "type": "bundle", "name": "Treasure Chest", "bundle_type": "standard", "description": "Treasure Chest", "image_url": "https://cdn3.xsolla.com/img/misc/images/7b1c0136d91398f9ab17924deee5eeec.png", "price": { "amount": "9.99", "amount_without_discount": "9.99", "currency": "USD" }, "virtual_prices": [ { "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png", "item_id": 259765, "sku": "com.xsolla.gold_12", "name": "Gold", "type": "virtual_currency", "amount": 10, "amount_without_discount": 10, "calculated_price": { "amount": "10.00", "amount_without_discount": "10.00" }, "is_default": true }, { "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png", "item_id": 259766, "sku": "com.xsolla.silver_12", "name": "Silver", "type": "virtual_currency", "amount": 20, "amount_without_discount": 20, "calculated_price": { "amount": "20.00", "amount_without_discount": "20.00" }, "is_default": false }, { "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png", "item_id": 259767, "sku": "com.xsolla.bronze_12", "name": "Bronze", "type": "virtual_currency", "amount": 40, "amount_without_discount": 40, "calculated_price": { "amount": "40.00", "amount_without_discount": "40.00" }, "is_default": false } ], "can_be_bought": true, "attributes": [], "is_free": false, "groups": [], "total_content_price": { "amount": "802.89", "amount_without_discount": "802.89", "currency": "USD" }, "content": [ { "item_id": 259772, "sku": "com.xsolla.saber_2", "type": "virtual_good", "name": "Saber", "description": "Saber", "image_url": "https://cdn3.xsolla.com/img/misc/images/edd914d60301d77b94926478d253fcb6.png", "price": { "amount": "3.99", "amount_without_discount": "3.99", "currency": "USD" }, "virtual_prices": [ { "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png", "item_id": 259765, "sku": "com.xsolla.gold_13", "name": "Gold", "type": "virtual_currency", "amount": 3, "amount_without_discount": 3, "calculated_price": { "amount": "3.00", "amount_without_discount": "3.00" }, "is_default": true }, { "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png", "item_id": 259766, "sku": "com.xsolla.silver_13", "name": "Silver", "type": "virtual_currency", "amount": 7, "amount_without_discount": 7, "calculated_price": { "amount": "7.00", "amount_without_discount": "7.00" }, "is_default": false }, { "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png", "item_id": 259767, "sku": "com.xsolla.bronze_13", "name": "Bronze", "type": "virtual_currency", "amount": 70, "amount_without_discount": 70, "calculated_price": { "amount": "70.00", "amount_without_discount": "70.00" }, "is_default": false } ], "can_be_bought": true, "attributes": [], "is_free": false, "groups": [ { "external_id": "swords", "name": "Swords" } ], "virtual_item_type": "non_consumable", "quantity": 1 }, { "item_id": 259769, "sku": "com.xsolla.silver_chest_2", "type": "bundle", "name": "Chest of silver", "bundle_type": "virtual_currency_package", "description": "Chest of silver", "image_url": "https://cdn3.xsolla.com/img/misc/images/f0b59a3370404e8881107249051b70bd.png", "price": { "amount": "19.99", "amount_without_discount": "19.99", "currency": "USD" }, "virtual_prices": [], "can_be_bought": true, "attributes": [], "is_free": false, "groups": [], "content": [ { "item_id": 259766, "sku": "com.xsolla.silver_14", "type": "virtual_currency", "name": "Silver", "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png", "quantity": 50 } ], "quantity": 10 }, { "item_id": 259770, "sku": "com.xsolla.bronze_chest_2", "type": "bundle", "name": "Chest of bronze", "bundle_type": "virtual_currency_package", "description": "Chest of bronze", "image_url": "https://cdn3.xsolla.com/img/misc/images/b32eb5b1f4f0c202ea6ac4e21c2eae18.png", "price": { "amount": "5.99", "amount_without_discount": "5.99", "currency": "USD" }, "virtual_prices": [], "can_be_bought": true, "attributes": [], "is_free": false, "groups": [], "content": [ { "item_id": 259767, "sku": "com.xsolla.bronze_11", "type": "virtual_currency", "name": "Bronze", "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png", "quantity": 100 } ], "quantity": 100 } ], "vp_rewards": [] } ], "items": { "type": "object", "properties": { "item_id": { "type": "integer", "example": 259774, "description": "아이템 생성 시 제공되는 내부의 고유 아이템 ID입니다." }, "sku": { "type": "string", "example": "com.xsolla.electric_shield_1", "description": "고유 아이템 ID입니다. SKU는 소문자 및 대문자 라틴 영숫자, 마침표, 대시 및 밑줄만 포함할 수 있습니다." }, "name": { "type": "string", "example": "Electric shield", "description": "아이템 이름입니다." }, "groups": { "$ref": "#/components/schemas/items_client_groups_response" }, "total_content_price": { "$ref": "#/components/schemas/Bundles_total_content_price" }, "attributes": { "$ref": "#/components/schemas/Virtual-Items-Currency_client-attributes" }, "type": { "type": "string", "example": "virtual_good", "description": "아이템 유형: `virtual_good`/`virtual_currency`/`bundle`/`game_key`/`physical_good`.", "enum": [ "virtual_good", "virtual_currency", "bundle", "game_key", "physical_good" ] }, "bundle_type": { "type": "string", "description": "번들 유형입니다. 아이템 유형이 번들인 경우 반환됩니다.", "enum": [ "standard", "virtual_currency_package" ] }, "description": { "type": "string", "example": "Electric shield", "description": "아이템 설명입니다." }, "image_url": { "type": "string", "example": "https://cdn3.xsolla.com/img/misc/images/d2d6b1b517e6a7f3765c3bb5a3cfb87d.png", "description": "이미지 URL입니다." }, "is_free": { "$ref": "#/components/schemas/value-is_free" }, "price": { "type": "object", "description": "아이템 가격입니다.", "properties": { "amount": { "type": "string", "example": "9.99", "description": "할인된 아이템 가격입니다." }, "amount_without_discount": { "type": "string", "example": "9.99", "description": "아이템 가격입니다." }, "currency": { "type": "string", "example": "USD", "description": "아이템 가격 통화입니다. [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)에 따른 3자리 코드입니다." } } }, "virtual_prices": { "$ref": "#/components/schemas/client_virtual_prices_with_calculated_price_response" }, "can_be_bought": { "type": "boolean", "example": true, "description": "`true`일 경우 사용자는 아이템을 구매할 수 있습니다." }, "promotions": { "$ref": "#/components/schemas/Catalog_item_promotions" }, "virtual_item_type": { "type": "string", "example": "non-consumable", "description": "가상 아이템의 유형입니다.\n\n사용 가능한 값: - `consumable` - 사용 후 인벤토리에서 사라지는 아이템(예: 탄약). - `non_consumable` - 인벤토리에 무기한으로 남아 있는 아이템. - `non_renewing_subscription` - 일정 기간 동안 서비스나 콘텐츠에 대한 이용 권한을 나타낼 수 있는 기간 한정 아이템.", "enum": [ "consumable", "non_consumable", "non_renewing_subscription" ] }, "limits": { "$ref": "#/components/schemas/Catalog_item_limits" }, "custom_attributes": { "$ref": "#/components/schemas/item-custom-attributes-response" }, "vp_rewards": { "$ref": "#/components/schemas/client-item-value-point-reward" }, "content": { "type": "array", "items": { "type": "object", "items": { "$ref": "#/components/schemas/Bundles_client_content" } } } } } } } }, "examples": { "response": { "value": { "has_more": false, "items": [ { "item_id": 259765, "sku": "com.xsolla.gold_1", "type": "virtual_currency", "name": "Gold", "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png", "price": { "amount": "1.00", "amount_without_discount": "1.00", "currency": "USD" }, "virtual_prices": [], "can_be_bought": true, "promotions": [ { "name": "Bonus promotion", "date_start": "2020-04-15T16:16:00+03:00", "date_end": "2026-04-15T16:16:00+03:00", "discount": { "percent": "50.00" }, "bonus": [ { "quantity": 1, "name": "Xsolla Minigun", "image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png", "sku": "com.xsolla.minigun_1", "type": "virtual_good" } ] } ], "attributes": [], "is_free": false, "groups": [], "limits": null, "custom_attributes": { "purchased": 0, "attr": "value" }, "vp_rewards": [ { "item_id": 175232, "sku": "com.xsolla.value_point_1", "amount": 130, "name": "Value point", "image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg" }, { "item_id": 186321, "sku": "com.xsolla.clan_value_point_1", "amount": 50, "name": "Clan Reward VP 1", "image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg", "is_clan": true } ] }, { "item_id": 259766, "sku": "com.xsolla.silver_1", "type": "virtual_currency", "name": "Silver", "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png", "price": { "amount": "0.50", "amount_without_discount": "0.50", "currency": "USD" }, "virtual_prices": [], "can_be_bought": true, "promotions": [ { "name": "Bonus promotion", "date_start": "2020-04-15T16:16:00+03:00", "date_end": "2026-04-15T16:16:00+03:00", "discount": { "percent": "50.00" }, "bonus": [ { "quantity": 1, "name": "Xsolla Minigun", "image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png", "sku": "com.xsolla.minigun_1", "type": "virtual_good" } ] } ], "attributes": [], "is_free": false, "groups": [], "vp_rewards": [] }, { "item_id": 259767, "sku": "com.xsolla.bronze_1", "type": "virtual_currency", "name": "Bronze", "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png", "price": { "amount": "0.10", "amount_without_discount": "0.10", "currency": "USD" }, "virtual_prices": [], "can_be_bought": true, "promotions": [ { "name": "Bonus promotion", "date_start": "2020-04-15T16:16:00+03:00", "date_end": "2026-04-15T16:16:00+03:00", "discount": { "percent": "50.00" }, "bonus": [ { "quantity": 1, "name": "Xsolla Minigun", "image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png", "sku": "com.xsolla.minigun_1", "type": "virtual_good" } ] } ], "attributes": [], "is_free": false, "groups": [], "vp_rewards": [] }, { "item_id": 259768, "sku": "com.xsolla.gold_chest_1", "type": "bundle", "name": "Chest of gold", "bundle_type": "virtual_currency_package", "description": "Chest of gold", "image_url": "https://cdn3.xsolla.com/img/misc/images/61b8d0785093017ce1f50ebed55c42a9.png", "price": { "amount": "7.99", "amount_without_discount": "7.99", "currency": "USD" }, "virtual_prices": [], "can_be_bought": true, "promotions": [ { "name": "Bonus promotion", "date_start": "2020-04-15T16:16:00+03:00", "date_end": "2026-04-15T16:16:00+03:00", "discount": { "percent": "50.00" }, "bonus": [ { "quantity": 1, "name": "Xsolla Minigun", "image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png", "sku": "com.xsolla.minigun_1", "type": "virtual_good" } ] } ], "attributes": [], "is_free": false, "groups": [], "content": [ { "item_id": 259765, "sku": "com.xsolla.gold_2", "type": "virtual_currency", "name": "Gold", "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png", "quantity": 10 } ], "vp_rewards": [] }, { "item_id": 259769, "sku": "com.xsolla.silver_chest_1", "type": "bundle", "name": "Chest of silver", "bundle_type": "virtual_currency_package", "description": "Chest of silver", "image_url": "https://cdn3.xsolla.com/img/misc/images/f0b59a3370404e8881107249051b70bd.png", "price": { "amount": "19.99", "amount_without_discount": "19.99", "currency": "USD" }, "virtual_prices": [], "can_be_bought": true, "promotions": [ { "name": "Bonus promotion", "date_start": "2020-04-15T16:16:00+03:00", "date_end": "2026-04-15T16:16:00+03:00", "discount": { "percent": "50.00" }, "bonus": [ { "quantity": 1, "name": "Xsolla Minigun", "image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png", "sku": "com.xsolla.minigun_1", "type": "virtual_good" } ] } ], "attributes": [], "is_free": false, "groups": [], "content": [ { "item_id": 259766, "sku": "com.xsolla.silver_2", "type": "virtual_currency", "name": "Silver", "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png", "quantity": 50 } ], "vp_rewards": [] }, { "item_id": 259770, "sku": "com.xsolla.bronze_chest_1", "type": "bundle", "name": "Chest of bronze", "bundle_type": "virtual_currency_package", "description": "Chest of bronze", "image_url": "https://cdn3.xsolla.com/img/misc/images/b32eb5b1f4f0c202ea6ac4e21c2eae18.png", "price": { "amount": "5.99", "amount_without_discount": "5.99", "currency": "USD" }, "virtual_prices": [], "can_be_bought": true, "promotions": [ { "name": "Bonus promotion", "date_start": "2020-04-15T16:16:00+03:00", "date_end": "2026-04-15T16:16:00+03:00", "discount": { "percent": "50.00" }, "bonus": [ { "quantity": 1, "name": "Xsolla Minigun", "image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png", "sku": "com.xsolla.minigun_1", "type": "virtual_good" } ] } ], "attributes": [], "is_free": false, "groups": [], "content": [ { "item_id": 259767, "sku": "com.xsolla.bronze_1", "type": "virtual_currency", "name": "Bronze", "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png", "quantity": 100 } ], "vp_rewards": [] }, { "item_id": 259771, "sku": "com.xsolla.sword_1", "type": "virtual_good", "name": "Sword", "description": "Sword", "image_url": "https://cdn3.xsolla.com/img/misc/images/a558727a420cad609556e4449b9ecb12.png", "price": { "amount": "1.99", "amount_without_discount": "1.99", "currency": "USD" }, "virtual_prices": [ { "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png", "item_id": 259765, "sku": "com.xsolla.gold_2", "name": "Gold", "type": "virtual_currency", "amount": 2, "amount_without_discount": 2, "calculated_price": { "amount": "2.00", "amount_without_discount": "2.00" }, "is_default": true }, { "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png", "item_id": 259766, "sku": "com.xsolla.silver_2", "name": "Silver", "type": "virtual_currency", "amount": 5, "amount_without_discount": 5, "calculated_price": { "amount": "5.00", "amount_without_discount": "5.00" }, "is_default": false }, { "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png", "item_id": 259767, "sku": "com.xsolla.bronze_2", "name": "Bronze", "type": "virtual_currency", "amount": 50, "amount_without_discount": 50, "calculated_price": { "amount": "50.00", "amount_without_discount": "50.00" }, "is_default": false } ], "can_be_bought": true, "promotions": [ { "name": "Bonus promotion", "date_start": "2020-04-15T16:16:00+03:00", "date_end": "2026-04-15T16:16:00+03:00", "discount": { "percent": "50.00" }, "bonus": [ { "quantity": 1, "name": "Xsolla Minigun", "image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png", "sku": "com.xsolla.minigun_1", "type": "virtual_good" } ] } ], "attributes": [], "is_free": false, "groups": [ { "external_id": "swords", "name": "Swords", "item_order_in_group": 1 } ], "virtual_item_type": "non_consumable", "vp_rewards": [] }, { "item_id": 259772, "sku": "com.xsolla.saber_1", "type": "virtual_good", "name": "Saber", "description": "Saber", "image_url": "https://cdn3.xsolla.com/img/misc/images/edd914d60301d77b94926478d253fcb6.png", "price": { "amount": "3.99", "amount_without_discount": "3.99", "currency": "USD" }, "virtual_prices": [ { "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png", "item_id": 259765, "sku": "com.xsolla.gold_3", "name": "Gold", "type": "virtual_currency", "amount": 3, "amount_without_discount": 3, "calculated_price": { "amount": "3.00", "amount_without_discount": "3.00" }, "is_default": true }, { "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png", "item_id": 259766, "sku": "com.xsolla.silver_3", "name": "Silver", "type": "virtual_currency", "amount": 7, "amount_without_discount": 7, "calculated_price": { "amount": "7.00", "amount_without_discount": "7.00" }, "is_default": false }, { "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png", "item_id": 259767, "sku": "com.xsolla.bronze_3", "name": "Bronze", "type": "virtual_currency", "amount": 70, "amount_without_discount": 70, "calculated_price": { "amount": "70.00", "amount_without_discount": "70.00" }, "is_default": false } ], "can_be_bought": true, "promotions": [], "attributes": [], "is_free": false, "groups": [ { "external_id": "swords", "name": "Swords", "item_order_in_group": 2 } ], "virtual_item_type": "non_consumable", "vp_rewards": [] }, { "item_id": 259773, "sku": "com.xsolla.bow_1", "type": "virtual_good", "name": "Bow", "description": "Bow", "image_url": "https://cdn3.xsolla.com/img/misc/images/3bb3b0a5254ad15134c891108898363f.png", "price": { "amount": "4.99", "amount_without_discount": "4.99", "currency": "USD" }, "virtual_prices": [ { "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png", "item_id": 259765, "sku": "com.xsolla.gold_4", "name": "Gold", "type": "virtual_currency", "amount": 5, "amount_without_discount": 5, "calculated_price": { "amount": "5.00", "amount_without_discount": "5.00" }, "is_default": true }, { "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png", "item_id": 259766, "sku": "com.xsolla.silver_4", "name": "Silver", "type": "virtual_currency", "amount": 10, "amount_without_discount": 10, "calculated_price": { "amount": "10.00", "amount_without_discount": "10.00" }, "is_default": false }, { "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png", "item_id": 259767, "sku": "com.xsolla.bronze_5", "name": "Bronze", "type": "virtual_currency", "amount": 100, "amount_without_discount": 100, "calculated_price": { "amount": "100.00", "amount_without_discount": "100.00" }, "is_default": false } ], "can_be_bought": true, "promotions": [], "attributes": [], "is_free": false, "groups": [ { "external_id": "bows", "name": "Bows", "item_order_in_group": 1 } ], "virtual_item_type": "non_consumable", "vp_rewards": [] }, { "item_id": 259774, "sku": "com.xsolla.electric_shield_2", "type": "virtual_good", "name": "Electric shield", "description": "Electric shield", "image_url": "https://cdn3.xsolla.com/img/misc/images/d2d6b1b517e6a7f3765c3bb5a3cfb87d.png", "price": { "amount": "9.99", "amount_without_discount": "9.99", "currency": "USD" }, "virtual_prices": [ { "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png", "item_id": 259765, "sku": "com.xsolla.gold_5", "name": "Gold", "type": "virtual_currency", "amount": 10, "amount_without_discount": 10, "calculated_price": { "amount": "10.00", "amount_without_discount": "10.00" }, "is_default": true }, { "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png", "item_id": 259766, "sku": "com.xsolla.silver_5", "name": "Silver", "type": "virtual_currency", "amount": 20, "amount_without_discount": 20, "calculated_price": { "amount": "20.00", "amount_without_discount": "20.00" }, "is_default": false }, { "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png", "item_id": 259767, "sku": "com.xsolla.bronze_5", "name": "Bronze", "type": "virtual_currency", "amount": 200, "amount_without_discount": 200, "calculated_price": { "amount": "200.00", "amount_without_discount": "200.00" }, "is_default": false } ], "can_be_bought": true, "promotions": [], "attributes": [], "is_free": false, "groups": [ { "external_id": "armour", "name": "Armour", "item_order_in_group": 1 } ], "virtual_item_type": "non_consumable", "vp_rewards": [] }, { "item_id": 259775, "sku": "com.xsolla.royal_shield_2", "type": "virtual_good", "name": "Royal shield", "description": "Royal shield", "image_url": "https://cdn3.xsolla.com/img/misc/images/ed417975312a52efeeab8b039ff25cb1.png", "price": { "amount": "19.99", "amount_without_discount": "19.99", "currency": "USD" }, "virtual_prices": [ { "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png", "item_id": 259765, "sku": "com.xsolla.gold_6", "name": "Gold", "type": "virtual_currency", "amount": 20, "amount_without_discount": 20, "calculated_price": { "amount": "20.00", "amount_without_discount": "20.00" }, "is_default": true }, { "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png", "item_id": 259766, "sku": "com.xsolla.silver_6", "name": "Silver", "type": "virtual_currency", "amount": 40, "amount_without_discount": 40, "calculated_price": { "amount": "40.00", "amount_without_discount": "40.00" }, "is_default": false }, { "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png", "item_id": 259767, "sku": "com.xsolla.bronze_6", "name": "Bronze", "type": "virtual_currency", "amount": 400, "amount_without_discount": 400, "calculated_price": { "amount": "400.00", "amount_without_discount": "400.00" }, "is_default": false } ], "can_be_bought": true, "promotions": [ { "name": "Bonus promotion", "date_start": "2020-04-15T16:16:00+03:00", "date_end": "2026-04-15T16:16:00+03:00", "discount": { "percent": "50.00" }, "bonus": [ { "quantity": 1, "name": "Xsolla Minigun", "image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png", "sku": "com.xsolla.minigun_1", "type": "virtual_good" } ] } ], "attributes": [], "is_free": false, "groups": [ { "external_id": "armour", "name": "Armour", "item_order_in_group": 2 } ], "virtual_item_type": "non_consumable", "vp_rewards": [] }, { "item_id": 259776, "sku": "com.xsolla.ancient_helmet_1", "type": "virtual_good", "name": "Ancient helmet", "description": "Ancient helmet", "image_url": "https://cdn3.xsolla.com/img/misc/images/e70e16d9626f435e519fc8e1cc1e7176.png", "price": { "amount": "1.99", "amount_without_discount": "1.99", "currency": "USD" }, "virtual_prices": [ { "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png", "item_id": 259765, "sku": "com.xsolla.gold_7", "name": "Gold", "type": "virtual_currency", "amount": 2, "amount_without_discount": 2, "calculated_price": { "amount": "2.00", "amount_without_discount": "2.00" }, "is_default": true }, { "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png", "item_id": 259766, "sku": "com.xsolla.silver_7", "name": "Silver", "type": "virtual_currency", "amount": 4, "amount_without_discount": 4, "calculated_price": { "amount": "4.00", "amount_without_discount": "4.00" }, "is_default": false }, { "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png", "item_id": 259767, "sku": "com.xsolla.bronze_7", "name": "Bronze", "type": "virtual_currency", "amount": 40, "amount_without_discount": 40, "calculated_price": { "amount": "40.00", "amount_without_discount": "40.00" }, "is_default": false } ], "can_be_bought": true, "promotions": [], "attributes": [], "is_free": false, "groups": [ { "external_id": "armour", "name": "Armour", "item_order_in_group": 3 } ], "virtual_item_type": "non_consumable", "vp_rewards": [] }, { "item_id": 259777, "sku": "com.xsolla.wooden_helmet_1", "type": "virtual_good", "name": "Wooden helmet", "description": "Wooden helmet", "image_url": "https://cdn3.xsolla.com/img/misc/images/40d2812e52ad9d988ac20fc842fc66f0.png", "price": { "amount": "0.99", "amount_without_discount": "0.99", "currency": "USD" }, "virtual_prices": [ { "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png", "item_id": 259765, "sku": "com.xsolla.gold_8", "name": "Gold", "type": "virtual_currency", "amount": 1, "amount_without_discount": 1, "calculated_price": { "amount": "1.00", "amount_without_discount": "1.00" }, "is_default": true }, { "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png", "item_id": 259766, "sku": "com.xsolla.silver_8", "name": "Silver", "type": "virtual_currency", "amount": 2, "amount_without_discount": 2, "calculated_price": { "amount": "2.00", "amount_without_discount": "2.00" }, "is_default": false }, { "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png", "item_id": 259767, "sku": "com.xsolla.bronze_8", "name": "Bronze", "type": "virtual_currency", "amount": 20, "amount_without_discount": 20, "calculated_price": { "amount": "20.00", "amount_without_discount": "20.00" }, "is_default": false } ], "can_be_bought": true, "promotions": [ { "name": "Bonus promotion", "date_start": "2020-04-15T16:16:00+03:00", "date_end": "2026-04-15T16:16:00+03:00", "discount": { "percent": "50.00" }, "bonus": [ { "quantity": 1, "name": "Xsolla Minigun", "image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png", "sku": "com.xsolla.minigun_1", "type": "virtual_good" } ] } ], "attributes": [], "is_free": false, "groups": [ { "external_id": "armour", "name": "Armour", "item_order_in_group": 4 } ], "virtual_item_type": "non_consumable", "vp_rewards": [] }, { "item_id": 259778, "sku": "com.xsolla.armor_chest_1", "type": "bundle", "name": "Chest of armor", "bundle_type": "standard", "description": "Chest of armour", "image_url": "https://cdn3.xsolla.com/img/misc/images/5212202f9b8c9dbd254652d6cbeba03e.png", "price": { "amount": "19.99", "amount_without_discount": "19.99", "currency": "USD" }, "virtual_prices": [ { "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png", "item_id": 259765, "sku": "com.xsolla.gold_9", "name": "Gold", "type": "virtual_currency", "amount": 20, "amount_without_discount": 20, "calculated_price": { "amount": "20.00", "amount_without_discount": "20.00" }, "is_default": true }, { "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png", "item_id": 259766, "sku": "com.xsolla.silver_9", "name": "Silver", "type": "virtual_currency", "amount": 40, "amount_without_discount": 40, "calculated_price": { "amount": "40.00", "amount_without_discount": "40.00" }, "is_default": false }, { "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png", "item_id": 259767, "sku": "com.xsolla.bronze_9", "name": "Bronze", "type": "virtual_currency", "amount": 400, "amount_without_discount": 400, "calculated_price": { "amount": "400.00", "amount_without_discount": "400.00" }, "is_default": false } ], "can_be_bought": true, "promotions": [ { "name": "Bonus promotion", "date_start": "2020-04-15T16:16:00+03:00", "date_end": "2026-04-15T16:16:00+03:00", "discount": { "percent": "50.00" }, "bonus": [ { "quantity": 1, "name": "Xsolla Minigun", "image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png", "sku": "com.xsolla.minigun_1", "type": "virtual_good" } ] } ], "attributes": [], "is_free": false, "groups": [], "total_content_price": { "amount": "11.98", "amount_without_discount": "11.98", "currency": "USD" }, "content": [ { "item_id": 259774, "sku": "com.xsolla.electric_shield_2", "type": "virtual_good", "name": "Electric shield", "description": "Electric shield", "image_url": "https://cdn3.xsolla.com/img/misc/images/d2d6b1b517e6a7f3765c3bb5a3cfb87d.png", "price": { "amount": "9.99", "amount_without_discount": "9.99", "currency": "USD" }, "virtual_prices": [ { "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png", "item_id": 259765, "sku": "com.xsolla.gold_10", "name": "Gold", "type": "virtual_currency", "amount": 10, "amount_without_discount": 10, "calculated_price": { "amount": "10.00", "amount_without_discount": "10.00" }, "is_default": true }, { "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png", "item_id": 259766, "sku": "com.xsolla.silver_10", "name": "Silver", "type": "virtual_currency", "amount": 20, "amount_without_discount": 20, "calculated_price": { "amount": "20.00", "amount_without_discount": "20.00" }, "is_default": false }, { "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png", "item_id": 259767, "sku": "com.xsolla.bronze_10", "name": "Bronze", "type": "virtual_currency", "amount": 200, "amount_without_discount": 200, "calculated_price": { "amount": "200.00", "amount_without_discount": "200.00" }, "is_default": false } ], "can_be_bought": true, "promotions": [ { "name": "Bonus promotion", "date_start": "2020-04-15T16:16:00+03:00", "date_end": "2026-04-15T16:16:00+03:00", "discount": { "percent": "50.00" }, "bonus": [ { "quantity": 1, "name": "Xsolla Minigun", "image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png", "sku": "com.xsolla.minigun_1", "type": "virtual_good" } ] } ], "attributes": [], "is_free": false, "groups": [ { "external_id": "armour", "name": "Armour" } ], "virtual_item_type": "non_consumable", "quantity": 1 }, { "item_id": 259776, "sku": "com.xsolla.ancient_helmet_2", "type": "virtual_good", "name": "Ancient helmet", "description": "Ancient helmet", "image_url": "https://cdn3.xsolla.com/img/misc/images/e70e16d9626f435e519fc8e1cc1e7176.png", "price": { "amount": "1.99", "amount_without_discount": "1.99", "currency": "USD" }, "virtual_prices": [ { "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png", "item_id": 259765, "sku": "com.xsolla.gold_11", "name": "Gold", "type": "virtual_currency", "amount": 2, "amount_without_discount": 2, "calculated_price": { "amount": "2.00", "amount_without_discount": "2.00" }, "is_default": true }, { "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png", "item_id": 259766, "sku": "com.xsolla.silver_11", "name": "Silver", "type": "virtual_currency", "amount": 4, "amount_without_discount": 4, "calculated_price": { "amount": "4.00", "amount_without_discount": "4.00" }, "is_default": false }, { "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png", "item_id": 259767, "sku": "com.xsolla.bronze_11", "name": "Bronze", "type": "virtual_currency", "amount": 40, "amount_without_discount": 40, "calculated_price": { "amount": "40.00", "amount_without_discount": "40.00" }, "is_default": false } ], "can_be_bought": true, "promotions": [ { "name": "Bonus promotion", "date_start": "2020-04-15T16:16:00+03:00", "date_end": "2026-04-15T16:16:00+03:00", "discount": { "percent": "50.00" }, "bonus": [ { "quantity": 1, "name": "Xsolla Minigun", "image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png", "sku": "com.xsolla.minigun_1", "type": "virtual_good" } ] } ], "attributes": [], "is_free": false, "groups": [ { "external_id": "armour", "name": "Armour" } ], "virtual_item_type": "non_consumable", "quantity": 1 } ], "vp_rewards": [] }, { "item_id": 259779, "sku": "com.xsolla.treasure_chest_1", "type": "bundle", "name": "Treasure Chest", "bundle_type": "standard", "description": "Treasure Chest", "image_url": "https://cdn3.xsolla.com/img/misc/images/7b1c0136d91398f9ab17924deee5eeec.png", "price": { "amount": "9.99", "amount_without_discount": "9.99", "currency": "USD" }, "virtual_prices": [ { "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png", "item_id": 259765, "sku": "com.xsolla.gold_12", "name": "Gold", "type": "virtual_currency", "amount": 10, "amount_without_discount": 10, "calculated_price": { "amount": "10.00", "amount_without_discount": "10.00" }, "is_default": true }, { "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png", "item_id": 259766, "sku": "com.xsolla.silver_12", "name": "Silver", "type": "virtual_currency", "amount": 20, "amount_without_discount": 20, "calculated_price": { "amount": "20.00", "amount_without_discount": "20.00" }, "is_default": false }, { "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png", "item_id": 259767, "sku": "com.xsolla.bronze_12", "name": "Bronze", "type": "virtual_currency", "amount": 40, "amount_without_discount": 40, "calculated_price": { "amount": "40.00", "amount_without_discount": "40.00" }, "is_default": false } ], "can_be_bought": true, "promotions": [ { "name": "Bonus promotion", "date_start": "2020-04-15T16:16:00+03:00", "date_end": "2026-04-15T16:16:00+03:00", "discount": { "percent": "50.00" }, "bonus": [ { "quantity": 1, "name": "Xsolla Minigun", "image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png", "sku": "com.xsolla.minigun_1", "type": "virtual_good" } ] } ], "attributes": [], "is_free": false, "groups": [], "total_content_price": { "amount": "802.89", "amount_without_discount": "802.89", "currency": "USD" }, "content": [ { "item_id": 259772, "sku": "com.xsolla.saber_1", "type": "virtual_good", "name": "Saber", "description": "Saber", "image_url": "https://cdn3.xsolla.com/img/misc/images/edd914d60301d77b94926478d253fcb6.png", "price": { "amount": "3.99", "amount_without_discount": "3.99", "currency": "USD" }, "virtual_prices": [ { "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png", "item_id": 259765, "sku": "com.xsolla.gold_13", "name": "Gold", "type": "virtual_currency", "amount": 3, "amount_without_discount": 3, "calculated_price": { "amount": "3.00", "amount_without_discount": "3.00" }, "is_default": true }, { "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png", "item_id": 259766, "sku": "com.xsolla.silver_13", "name": "Silver", "type": "virtual_currency", "amount": 7, "amount_without_discount": 7, "calculated_price": { "amount": "7.00", "amount_without_discount": "7.00" }, "is_default": false }, { "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png", "item_id": 259767, "sku": "com.xsolla.bronze_13", "name": "Bronze", "type": "virtual_currency", "amount": 70, "amount_without_discount": 70, "calculated_price": { "amount": "70.00", "amount_without_discount": "70.00" }, "is_default": false } ], "can_be_bought": true, "attributes": [], "is_free": false, "groups": [ { "external_id": "swords", "name": "Swords" } ], "virtual_item_type": "non_consumable", "quantity": 1 }, { "item_id": 259769, "sku": "com.xsolla.silver_chest_2", "type": "bundle", "name": "Chest of silver", "bundle_type": "virtual_currency_package", "description": "Chest of silver", "image_url": "https://cdn3.xsolla.com/img/misc/images/f0b59a3370404e8881107249051b70bd.png", "price": { "amount": "19.99", "amount_without_discount": "19.99", "currency": "USD" }, "virtual_prices": [], "can_be_bought": true, "promotions": [], "attributes": [], "is_free": false, "groups": [], "content": [ { "item_id": 259766, "sku": "com.xsolla.silver_13", "type": "virtual_currency", "name": "Silver", "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png", "quantity": 50 } ], "quantity": 10 }, { "item_id": 259770, "sku": "com.xsolla.bronze_chest_2", "type": "bundle", "name": "Chest of bronze", "bundle_type": "virtual_currency_package", "description": "Chest of bronze", "image_url": "https://cdn3.xsolla.com/img/misc/images/b32eb5b1f4f0c202ea6ac4e21c2eae18.png", "price": { "amount": "5.99", "amount_without_discount": "5.99", "currency": "USD" }, "virtual_prices": [], "can_be_bought": true, "promotions": [], "attributes": [], "is_free": false, "groups": [], "content": [ { "item_id": 259767, "sku": "com.xsolla.bronze_13", "type": "virtual_currency", "name": "Bronze", "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png", "quantity": 100 } ], "quantity": 100 } ], "vp_rewards": [] } ] } } } } } }, "sellable_items_200-get-item-by-id": { "description": "판매할 수 있는 아이템을 성공적으로 수신했습니다.", "content": { "application/json": { "schema": { "type": "object", "description": "판매할 수 있는 아이템이 있는 개체입니다.", "properties": { "item_id": { "type": "integer", "example": 259774, "description": "아이템 생성 시 제공되는 내부의 고유 아이템 ID입니다." }, "sku": { "type": "string", "example": "electric_shield", "description": "고유 아이템 ID입니다. SKU는 소문자 및 대문자 라틴 영숫자, 마침표, 대시 및 밑줄만 포함할 수 있습니다." }, "name": { "type": "string", "example": "Electric shield", "description": "아이템 이름입니다." }, "groups": { "$ref": "#/components/schemas/items_client_groups_response" }, "attributes": { "$ref": "#/components/schemas/Virtual-Items-Currency_client-attributes" }, "type": { "type": "string", "example": "virtual_good", "description": "아이템 유형: `virtual_good`/`virtual_currency`/`bundle`/`game_key`/`physical_good`.", "enum": [ "virtual_good", "virtual_currency", "bundle", "game_key", "physical_good" ] }, "description": { "type": "string", "example": "Electric shield", "description": "아이템 설명입니다." }, "image_url": { "type": "string", "example": "https://cdn3.xsolla.com/img/misc/images/d2d6b1b517e6a7f3765c3bb5a3cfb87d.png", "description": "이미지 URL입니다." }, "is_free": { "$ref": "#/components/schemas/value-is_free" }, "price": { "type": "object", "description": "아이템 가격입니다.", "properties": { "amount": { "type": "string", "example": "9.99", "description": "할인된 아이템 가격입니다." }, "amount_without_discount": { "type": "string", "example": "9.99", "description": "아이템 가격입니다." }, "currency": { "type": "string", "example": "USD", "description": "아이템 가격 통화입니다. [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)에 따른 3자리 코드입니다." } } }, "virtual_prices": { "$ref": "#/components/schemas/client_virtual_prices_with_calculated_price_response" }, "can_be_bought": { "type": "boolean", "example": true, "description": "`true`일 경우 사용자는 아이템을 구매할 수 있습니다." }, "promotions": { "$ref": "#/components/schemas/Catalog_item_promotions" }, "virtual_item_type": { "type": "string", "example": "non-consumable", "description": "가상 아이템의 유형입니다.\n\n사용 가능한 값: - `consumable` - 사용 후 인벤토리에서 사라지는 아이템(예: 탄약). - `non_consumable` - 인벤토리에 무기한으로 남아 있는 아이템. - `non_renewing_subscription` - 일정 기간 동안 서비스나 콘텐츠에 대한 이용 권한을 나타낼 수 있는 기간 한정 아이템.", "enum": [ "consumable", "non_consumable", "non_renewing_subscription" ] }, "limits": { "$ref": "#/components/schemas/Catalog_item_limits" }, "custom_attributes": { "$ref": "#/components/schemas/item-custom-attributes-response" }, "vp_rewards": { "$ref": "#/components/schemas/client-item-value-point-reward" } } }, "examples": { "response": { "value": { "item_id": 259774, "sku": "com.xsolla.electric_shield_1", "type": "virtual_good", "name": "Electric shield", "description": "Electric shield", "image_url": "https://cdn3.xsolla.com/img/misc/images/d2d6b1b517e6a7f3765c3bb5a3cfb87d.png", "price": { "amount": "9.99", "amount_without_discount": "9.99", "currency": "USD" }, "virtual_prices": [ { "description": null, "image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png", "item_id": 259765, "sku": "com.xsolla.gold_1", "name": "Gold", "type": "virtual_currency", "amount": 10, "amount_without_discount": 10, "calculated_price": { "amount": "10.00", "amount_without_discount": "10.00" }, "is_default": true }, { "description": null, "image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png", "item_id": 259766, "sku": "com.xsolla.silver_1", "name": "Silver", "type": "virtual_currency", "amount": 20, "amount_without_discount": 20, "calculated_price": { "amount": "20.00", "amount_without_discount": "20.00" }, "is_default": false }, { "description": null, "image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png", "item_id": 259767, "sku": "com.xsolla.bronze_1", "name": "Bronze", "type": "virtual_currency", "amount": 200, "amount_without_discount": 200, "calculated_price": { "amount": "200.00", "amount_without_discount": "200.00" }, "is_default": false } ], "can_be_bought": true, "promotions": [ { "name": "Bonus promotion", "date_start": "2020-04-15T16:16:00+03:00", "date_end": "2026-04-15T16:16:00+03:00", "discount": { "percent": "50.00" }, "bonus": [ { "quantity": 1, "name": "Xsolla Minigun", "image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png", "sku": "com.xsolla.minigun_1", "type": "virtual_good" } ] } ], "attributes": [], "is_free": false, "groups": [ { "external_id": "armour", "name": "Armour", "item_order_in_group": 10 } ], "virtual_item_type": "non_consumable", "limits": { "per_user": { "total": 5, "available": 3, "recurrent_schedule": { "interval_type": "weekly", "reset_next_date": 1746057600 }, "limit_exceeded_visibility": "show" } }, "vp_rewards": [ { "item_id": 175232, "sku": "com.xsolla.value_point_1", "amount": 130, "name": "Value point", "image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg" }, { "item_id": 186321, "sku": "com.xsolla.clan_value_point_1", "amount": 50, "name": "Clan Reward VP 1", "image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg", "is_clan": true } ], "custom_attributes": { "purchased": 0, "attr": "value" } } } } } } }, "sellable-item-by-id_404": { "description": "아이템을 찾을 수 없습니다. `project_id`과 `item_id`가 올바른지 확인해야 합니다.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "example": 404 }, "errorCode": { "type": "integer", "example": 4001 }, "errorMessage": { "type": "string", "example": "[0401-4001]: Item with id = 259774 not found" } } } } } }, "sellable-item-by-sku_404": { "description": "아이템을 찾을 수 없습니다. `project_id`과 `sku`가 올바른지 확인해야 합니다.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "example": 404 }, "errorCode": { "type": "integer", "example": 4001 }, "errorMessage": { "type": "string", "example": "[0401-4001]: Item with sku = 'electric_shiel' not found" } } } } } }, "sellable_items_200-get-items-by-group-id": { "description": "지정한 그룹의 판매할 수 있는 아이템 목록을 성공적으로 수신했습니다.", "content": { "application/json": { "schema": { "type": "object", "properties": { "has_more": { "$ref": "#/components/schemas/Pagination_has-more" }, "items": { "type": "array", "example": [ { "item_id": 259774, "sku": "com.xsolla.electric_shield_1", "type": "virtual_good", "name": "Electric shield", "description": "Electric shield", "image_url": "https://cdn3.xsolla.com/img/misc/images/d2d6b1b517e6a7f3765c3bb5a3cfb87d.png", "price": { "amount": "9.99", "amount_without_discount": "9.99", "currency": "USD" }, "virtual_prices": [ { "description": null, "image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png", "item_id": 259765, "sku": "com.xsolla.gold_1", "name": "Gold", "type": "virtual_currency", "amount": 10, "amount_without_discount": 10, "calculated_price": { "amount": "10.00", "amount_without_discount": "10.00" }, "is_default": true }, { "description": null, "image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png", "item_id": 259766, "sku": "com.xsolla.silver_1", "name": "Silver", "type": "virtual_currency", "amount": 20, "amount_without_discount": 20, "calculated_price": { "amount": "20.00", "amount_without_discount": "20.00" }, "is_default": false }, { "description": null, "image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png", "item_id": 259767, "sku": "com.xsolla.bronze_1", "name": "Bronze", "type": "virtual_currency", "amount": 200, "amount_without_discount": 200, "calculated_price": { "amount": "200.00", "amount_without_discount": "200.00" }, "is_default": false } ], "can_be_bought": true, "promotions": [ { "name": "Bonus promotion", "date_start": "2020-04-15T16:16:00+03:00", "date_end": "2026-04-15T16:16:00+03:00", "discount": { "percent": "50.00" }, "bonus": [ { "quantity": 1, "name": "Xsolla Minigun", "image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png", "sku": "com.xsolla.minigun_1", "type": "virtual_good" } ] } ], "attributes": [], "is_free": false, "groups": [ { "external_id": "armour", "name": "Armour" } ], "virtual_item_type": "non_consumable", "limits": { "per_user": { "total": 5, "available": 3, "recurrent_schedule": { "interval_type": "weekly", "reset_next_date": 1746057600 }, "limit_exceeded_visibility": "show" } }, "vp_rewards": [ { "item_id": 175232, "sku": "com.xsolla.value_point_1", "amount": 130, "name": "Value point", "image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg" }, { "item_id": 186321, "sku": "clan_value_point_sku_1", "amount": 50, "name": "Clan Reward VP 1", "image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg", "is_clan": true } ] }, { "item_id": 259775, "sku": "com.xsolla.royal_shield_1", "type": "virtual_good", "name": "Royal shield", "description": "Royal shield", "image_url": "https://cdn3.xsolla.com/img/misc/images/ed417975312a52efeeab8b039ff25cb1.png", "price": { "amount": "19.99", "amount_without_discount": "19.99", "currency": "USD" }, "virtual_prices": [ { "description": null, "image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png", "item_id": 259765, "sku": "com.xsolla.gold_2", "name": "Gold", "type": "virtual_currency", "amount": 20, "amount_without_discount": 20, "calculated_price": { "amount": "20.00", "amount_without_discount": "20.00" }, "is_default": true }, { "description": null, "image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png", "item_id": 259766, "sku": "com.xsolla.silver_2", "name": "Silver", "type": "virtual_currency", "amount": 40, "amount_without_discount": 40, "calculated_price": { "amount": "40.00", "amount_without_discount": "40.00" }, "is_default": false }, { "description": null, "image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png", "item_id": 259767, "sku": "com.xsolla.bronze_2", "name": "Bronze", "type": "virtual_currency", "amount": 400, "amount_without_discount": 400, "calculated_price": { "amount": "400.00", "amount_without_discount": "400.00" }, "is_default": false } ], "can_be_bought": true, "promotions": [], "attributes": [], "is_free": false, "groups": [ { "external_id": "armour", "name": "Armour" } ], "virtual_item_type": "non_consumable", "vp_rewards": [] }, { "item_id": 259776, "sku": "com.xsolla.ancient_helmet_1", "type": "virtual_good", "name": "Ancient helmet", "description": "Ancient helmet", "image_url": "https://cdn3.xsolla.com/img/misc/images/e70e16d9626f435e519fc8e1cc1e7176.png", "price": { "amount": "1.99", "amount_without_discount": "1.99", "currency": "USD" }, "virtual_prices": [ { "description": null, "image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png", "item_id": 259765, "sku": "com.xsolla.gold_3", "name": "Gold", "type": "virtual_currency", "amount": 2, "amount_without_discount": 2, "calculated_price": { "amount": "2.00", "amount_without_discount": "2.00" }, "is_default": true }, { "description": null, "image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png", "item_id": 259766, "sku": "com.xsolla.silver_3", "name": "Silver", "type": "virtual_currency", "amount": 4, "amount_without_discount": 4, "calculated_price": { "amount": "4.00", "amount_without_discount": "4.00" }, "is_default": false }, { "description": null, "image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png", "item_id": 259767, "sku": "com.xsolla.bronze_3", "name": "Bronze", "type": "virtual_currency", "amount": 40, "amount_without_discount": 40, "calculated_price": { "amount": "40.00", "amount_without_discount": "40.00" }, "is_default": false } ], "can_be_bought": true, "promotions": [ { "name": "Bonus promotion", "date_start": "2020-04-15T16:16:00+03:00", "date_end": "2026-04-15T16:16:00+03:00", "discount": { "percent": "50.00" }, "bonus": [ { "quantity": 1, "name": "Xsolla Minigun", "image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png", "sku": "com.xsolla.minigun_1", "type": "virtual_good" } ] } ], "attributes": [], "is_free": false, "groups": [ { "external_id": "armour", "name": "Armour" } ], "virtual_item_type": "non_consumable", "vp_rewards": [] }, { "item_id": 259777, "sku": "com.xsolla.wooden_helmet_1", "type": "virtual_good", "name": "Wooden helmet", "description": "Wooden helmet", "image_url": "https://cdn3.xsolla.com/img/misc/images/40d2812e52ad9d988ac20fc842fc66f0.png", "price": { "amount": "0.99", "amount_without_discount": "0.99", "currency": "USD" }, "virtual_prices": [ { "description": null, "image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png", "item_id": 259765, "sku": "com.xsolla.gold_4", "name": "Gold", "type": "virtual_currency", "amount": 1, "amount_without_discount": 1, "calculated_price": { "amount": "1.00", "amount_without_discount": "1.00" }, "is_default": true }, { "description": null, "image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png", "item_id": 259766, "sku": "com.xsolla.silver_4", "name": "Silver", "type": "virtual_currency", "amount": 2, "amount_without_discount": 2, "calculated_price": { "amount": "2.00", "amount_without_discount": "2.00" }, "is_default": false }, { "description": null, "image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png", "item_id": 259767, "sku": "com.xsolla.bronze_4", "name": "Bronze", "type": "virtual_currency", "amount": 20, "amount_without_discount": 20, "calculated_price": { "amount": "20.00", "amount_without_discount": "20.00" }, "is_default": false } ], "can_be_bought": true, "promotions": [], "attributes": [], "is_free": false, "groups": [ { "external_id": "armour", "name": "Armour" } ], "virtual_item_type": "non_consumable", "vp_rewards": [] } ], "items": { "type": "object", "properties": { "item_id": { "type": "integer", "example": 259774, "description": "아이템 생성 시 제공되는 내부의 고유 아이템 ID입니다." }, "sku": { "type": "string", "example": "com.xsolla.electric_shield_1", "description": "고유 아이템 ID입니다. SKU는 소문자 및 대문자 라틴 영숫자, 마침표, 대시 및 밑줄만 포함할 수 있습니다." }, "name": { "type": "string", "example": "Electric shield", "description": "아이템 이름입니다." }, "groups": { "$ref": "#/components/schemas/items_client_groups_response" }, "attributes": { "$ref": "#/components/schemas/Virtual-Items-Currency_client-attributes" }, "type": { "type": "string", "example": "virtual_good", "description": "아이템 유형: `virtual_good`/`virtual_currency`/`bundle`/`game_key`/`physical_good`.", "enum": [ "virtual_good", "virtual_currency", "bundle", "game_key", "physical_good" ] }, "description": { "type": [ "string", "null" ], "example": "Electric shield", "description": "아이템 설명입니다." }, "image_url": { "type": "string", "example": "https://cdn3.xsolla.com/img/misc/images/d2d6b1b517e6a7f3765c3bb5a3cfb87d.png", "description": "이미지 URL입니다." }, "is_free": { "$ref": "#/components/schemas/value-is_free" }, "price": { "type": "object", "description": "아이템 가격입니다.", "properties": { "amount": { "type": "string", "example": "9.99", "description": "할인된 아이템 가격입니다." }, "amount_without_discount": { "type": "string", "example": "9.99", "description": "아이템 가격입니다." }, "currency": { "type": "string", "example": "USD", "description": "아이템 가격 통화입니다. [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)에 따른 3자리 코드입니다." } } }, "virtual_prices": { "$ref": "#/components/schemas/client_virtual_prices_with_calculated_price_response" }, "virtual_item_type": { "type": "string", "example": "non_consumable", "description": "가상 아이템의 유형입니다.\n\n사용 가능한 값: - `consumable` - 사용 후 인벤토리에서 사라지는 아이템(예: 탄약). - `non_consumable` - 인벤토리에 무기한으로 남아 있는 아이템. - `non_renewing_subscription` - 일정 기간 동안 서비스나 콘텐츠에 대한 이용 권한을 나타낼 수 있는 기간 한정 아이템.", "enum": [ "consumable", "non_consumable", "non_renewing_subscription" ] }, "can_be_bought": { "type": "boolean", "example": true, "description": "`true`일 경우 사용자는 아이템을 구매할 수 있습니다." }, "promotions": { "$ref": "#/components/schemas/Catalog_item_promotions" }, "limits": { "$ref": "#/components/schemas/Catalog_item_limits" }, "custom_attributes": { "$ref": "#/components/schemas/item-custom-attributes-response" }, "vp_rewards": { "$ref": "#/components/schemas/client-item-value-point-reward" } } } } } }, "examples": { "response": { "value": { "has_more": true, "items": [ { "item_id": 259774, "sku": "com.xsolla.electric_shields_1", "type": "virtual_good", "name": "Electric shield", "description": "Electric shield", "image_url": "https://cdn3.xsolla.com/img/misc/images/d2d6b1b517e6a7f3765c3bb5a3cfb87d.png", "price": { "amount": "9.99", "amount_without_discount": "9.99", "currency": "USD" }, "virtual_prices": [ { "description": null, "image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png", "item_id": 259765, "sku": "com.xsolla.gold_1", "name": "Gold", "type": "virtual_currency", "amount": 10, "amount_without_discount": 10, "calculated_price": { "amount": "10.00", "amount_without_discount": "10.00" }, "is_default": true }, { "description": null, "image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png", "item_id": 259766, "sku": "com.xsolla.silver_1", "name": "Silver", "type": "virtual_currency", "amount": 20, "amount_without_discount": 20, "calculated_price": { "amount": "20.00", "amount_without_discount": "20.00" }, "is_default": false }, { "description": null, "image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png", "item_id": 259767, "sku": "com.xsolla.bronze_1", "name": "Bronze", "type": "virtual_currency", "amount": 200, "amount_without_discount": 200, "calculated_price": { "amount": "200.00", "amount_without_discount": "200.00" }, "is_default": false } ], "can_be_bought": true, "promotions": [ { "name": "Bonus promotion", "date_start": "2020-04-15T16:16:00+03:00", "date_end": "2026-04-15T16:16:00+03:00", "discount": { "percent": "50.00" }, "bonus": [ { "quantity": 1, "name": "Xsolla Minigun", "image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png", "sku": "com.xsolla.minigun_1", "type": "virtual_good" } ] } ], "attributes": [], "is_free": false, "groups": [ { "external_id": "armour", "name": "Armour", "item_order_in_group": 1 } ], "virtual_item_type": "non_consumable" }, { "item_id": 259775, "sku": "com.xsolla.royal_shield_1", "type": "virtual_good", "name": "Royal shield", "description": "Royal shield", "image_url": "https://cdn3.xsolla.com/img/misc/images/ed417975312a52efeeab8b039ff25cb1.png", "price": { "amount": "19.99", "amount_without_discount": "19.99", "currency": "USD" }, "virtual_prices": [ { "description": null, "image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png", "item_id": 259765, "sku": "com.xsolla.gold_1", "name": "Gold", "type": "virtual_currency", "amount": 20, "amount_without_discount": 20, "calculated_price": { "amount": "20.00", "amount_without_discount": "20.00" }, "is_default": true }, { "description": null, "image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png", "item_id": 259766, "sku": "com.xsolla.silver_1", "name": "Silver", "type": "virtual_currency", "amount": 40, "amount_without_discount": 40, "calculated_price": { "amount": "40.00", "amount_without_discount": "40.00" }, "is_default": false }, { "description": null, "image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png", "item_id": 259767, "sku": "com.xsolla.bronze_1", "name": "Bronze", "type": "virtual_currency", "amount": 400, "amount_without_discount": 400, "calculated_price": { "amount": "400.00", "amount_without_discount": "400.00" }, "is_default": false } ], "can_be_bought": true, "promotions": [], "attributes": [], "is_free": false, "groups": [ { "external_id": "armour", "name": "Armour", "item_order_in_group": 2 } ], "virtual_item_type": "non_consumable" }, { "item_id": 259776, "sku": "com.xsolla.ancient_helmet_1", "type": "virtual_good", "name": "Ancient helmet", "description": "Ancient helmet", "image_url": "https://cdn3.xsolla.com/img/misc/images/e70e16d9626f435e519fc8e1cc1e7176.png", "price": { "amount": "1.99", "amount_without_discount": "1.99", "currency": "USD" }, "virtual_prices": [ { "description": null, "image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png", "item_id": 259765, "sku": "com.xsolla.gold_2", "name": "Gold", "type": "virtual_currency", "amount": 2, "amount_without_discount": 2, "calculated_price": { "amount": "2.00", "amount_without_discount": "2.00" }, "is_default": true }, { "description": null, "image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png", "item_id": 259766, "sku": "com.xsolla.silver_2", "name": "Silver", "type": "virtual_currency", "amount": 4, "amount_without_discount": 4, "calculated_price": { "amount": "4.00", "amount_without_discount": "4.00" }, "is_default": false }, { "description": null, "image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png", "item_id": 259767, "sku": "com.xsolla.bronze_2", "name": "Bronze", "type": "virtual_currency", "amount": 40, "amount_without_discount": 40, "calculated_price": { "amount": "40.00", "amount_without_discount": "40.00" }, "is_default": false } ], "can_be_bought": true, "promotions": [ { "name": "Bonus promotion", "date_start": "2020-04-15T16:16:00+03:00", "date_end": "2026-04-15T16:16:00+03:00", "discount": { "percent": "50.00" }, "bonus": [ { "quantity": 1, "name": "Xsolla Minigun", "image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png", "sku": "com.xsolla.minigun_1", "type": "virtual_good" } ] } ], "attributes": [], "is_free": false, "groups": [ { "external_id": "armour", "name": "Armour", "item_order_in_group": 3 } ], "virtual_item_type": "non_consumable" }, { "item_id": 259777, "sku": "com.xsolla.wooden_helmet_2", "type": "virtual_good", "name": "Wooden helmet", "description": "Wooden helmet", "image_url": "https://cdn3.xsolla.com/img/misc/images/40d2812e52ad9d988ac20fc842fc66f0.png", "price": { "amount": "0.99", "amount_without_discount": "0.99", "currency": "USD" }, "virtual_prices": [ { "description": null, "image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png", "item_id": 259765, "sku": "com.xsolla.gold_3", "name": "Gold", "type": "virtual_currency", "amount": 1, "amount_without_discount": 1, "calculated_price": { "amount": "1.00", "amount_without_discount": "1.00" }, "is_default": true }, { "description": null, "image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png", "item_id": 259766, "sku": "com.xsolla.silver_3", "name": "Silver", "type": "virtual_currency", "amount": 2, "amount_without_discount": 2, "calculated_price": { "amount": "2.00", "amount_without_discount": "2.00" }, "is_default": false }, { "description": null, "image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png", "item_id": 259767, "sku": "com.xsolla.bronze_3", "name": "Bronze", "type": "virtual_currency", "amount": 20, "amount_without_discount": 20, "calculated_price": { "amount": "20.00", "amount_without_discount": "20.00" }, "is_default": false } ], "can_be_bought": true, "promotions": [ { "name": "Bonus promotion", "date_start": "2020-04-15T16:16:00+03:00", "date_end": "2026-04-15T16:16:00+03:00", "discount": { "percent": "50.00" }, "bonus": [ { "quantity": 1, "name": "Xsolla Minigun", "image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png", "sku": "com.xsolla.minigun_1", "type": "virtual_good" } ] } ], "attributes": [], "is_free": false, "groups": [ { "external_id": "armour", "name": "Armour", "item_order_in_group": 4 } ], "virtual_item_type": "non_consumable", "limits": { "per_user": { "total": 5, "available": 3, "recurrent_schedule": { "interval_type": "weekly", "reset_next_date": 1746057600 } } }, "vp_rewards": [ { "item_id": 175232, "sku": "com.xsolla.value_point_1", "amount": 130, "name": "Value point", "image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg" }, { "item_id": 186321, "sku": "com.xsolla.clan_value_point_1", "amount": 50, "name": "Clan Reward VP 1", "image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg", "is_clan": true } ], "custom_attributes": { "purchased": 0, "attr": "value" } } ] } } } } } }, "200-admin-get-regions-list": { "description": "지역 목록을 성공적으로 수신했습니다.", "content": { "application/json": { "schema": { "type": "object", "description": "아이템이 있는 개체입니다.", "properties": { "regions": { "type": "array", "items": { "$ref": "#/components/schemas/Regions_200-region-short-model" } } } }, "examples": { "response": { "value": { "regions": [ { "id": 44, "name": { "en-US": "Asia", "de-DE": "Asien" } }, { "id": 45, "name": { "en-US": "CIS", "de-DE": "GUS" } } ] } } } } } }, "201-admin-create-region": { "description": "지역이 성공적으로 생성되었습니다.", "content": { "application/json": { "schema": { "type": "object", "properties": { "region_id": { "$ref": "#/components/schemas/Regions_region_id" } } }, "example": { "region_id": 42 } } } }, "200-admin-get-region": { "description": "지정된 지역을 성공적으로 수신했습니다.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Regions_200-region-model" } } } }, "404-region-not-found": { "description": "지역을 찾을 수 없습니다. `id`가 올바른지 확인하십시오.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "example": 404 }, "errorCode": { "type": "integer", "example": 9701 }, "errorMessage": { "type": "string", "example": "[0401-9701]: Region not found" }, "transactionId": { "type": "string", "example": "x-x-x-x-transactionId-mock-x-x-x" } } } } } }, "204-admin-update-region": { "description": "지역을 성공적으로 업데이트했습니다.", "content": {} }, "204-admin-delete-region": { "description": "지역을 성공적으로 삭제했습니다.", "content": {} }, "200-admin-get-attribute-list-response": { "description": "특성 목록을 성공적으로 수신했습니다.", "content": { "application/json": { "schema": { "type": "object", "description": "아이템이 있는 개체입니다.", "properties": { "attributes": { "type": "array", "items": { "$ref": "#/components/schemas/admin_attribute_response" } }, "total_count": { "type": "integer" } } }, "examples": { "response": { "value": { "total_count": 2, "attributes": [ { "external_id": "size", "name": { "en": "Size", "de": "Größe" } }, { "external_id": "genre", "name": { "en": "Genre", "de": "Genre" } } ] } } } } } }, "201-admin-create-attribute": { "description": "특성을 성공적으로 생성했습니다.", "content": { "application/json": { "schema": { "type": "object", "properties": { "external_id": { "$ref": "#/components/schemas/admin-attribute-external_id" } } }, "example": { "external_id": "genre" } } } }, "422-validation-failed": { "description": "잘못된 요청입니다.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/schemas-422-invalid-request" }, "examples": { "response": { "value": { "statusCode": 422, "errorCode": 1102, "errorMessage": "[0401-1102]: Unprocessable Entity. The property `external_id` is required" } } } } } }, "200-admin-get-attribute": { "description": "지정한 특성을 성공적으로 수신했습니다.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/admin_attribute_response" } } } }, "404-attribute-not-found": { "description": "특성을 찾을 수 없습니다.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "example": 404 }, "errorCode": { "type": "integer", "example": 9901 }, "errorMessage": { "type": "string", "example": "[0401-9901]: Attribute not found." }, "transactionId": { "type": "string", "example": "x-x-x-x-transactionId-mock-x-x-x" } } }, "examples": { "response": { "value": { "statusCode": 404, "errorCode": 9901, "errorMessage": "[0401-9901]: Attribute not found.", "transactionId": "x-x-x-x-transactionId-mock-x-x-x" } } } } } }, "204-admin-update-attribute": { "description": "특성을 성공적으로 업데이트했습니다.", "content": {} }, "201-admin-create-attribute-value": { "description": "특성 값을 성공적으로 생성했습니다.", "content": { "application/json": { "schema": { "type": "object", "properties": { "external_id": { "$ref": "#/components/schemas/value-external_id" } } }, "example": { "external_id": "rpg" } } } }, "403-auth-header-not-sent": { "description": "인증 헤더가 전송되지 않았습니다.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "example": 403 }, "errorCode": { "type": "integer", "example": 0 }, "errorMessage": { "type": "string", "example": "Authorization header not sent." }, "transactionId": { "type": "string", "example": "x-x-x-x-transactionId-mock-x-x-x" } } }, "examples": { "response": { "value": { "statusCode": 403, "errorCode": 0, "errorMessage": "Authorization header not sent" } } } } } }, "422-create-update-attribute-value": { "description": "잘못된 요청입니다.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/schemas-422-invalid-request" }, "examples": { "external_id is required": { "$ref": "#/components/examples/422-external-id-required" }, "external_id is invalid": { "$ref": "#/components/examples/422-external-id-invalid" }, "external_id is duplicate": { "$ref": "#/components/examples/422-external-id-duplicate" }, "value is required": { "$ref": "#/components/examples/422-value-invalid" }, "value properties minimum length": { "$ref": "#/components/examples/422-value-properties-required" }, "value limit exceeded": { "$ref": "#/components/examples/422-value-limit-exceeded" } } } } }, "404-attribute-value-not-found": { "description": "특성 값을 찾을 수 없습니다.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/404-not-found" }, "examples": { "Attribute not found": { "$ref": "#/components/examples/404-attribute-not-found" }, "Attribue value not found": { "$ref": "#/components/examples/404-attribute-value-not-found" } } } } } }, "requestBodies": { "Virtual-Items-Currency_admin-create-virtual-item": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Virtual-Items-Currency_admin-create-virtual-item" }, "examples": { "default": { "summary": "Minimal setup example", "value": { "sku": "booster_mega_1", "name": { "en": "Mega Booster" }, "description": { "en": "Temporarily doubles the experience points earned in battle." } } }, "quickstart": { "summary": "Quickstart example", "value": { "sku": "booster_mega_1", "name": { "en": "Mega Booster", "de": "Mega-Booster" }, "description": { "en": "Temporarily doubles the experience points earned in battle.", "de": "Verdoppelt vorübergehend die im Kampf erhaltenen Erfahrungspunkte." }, "is_enabled": true, "is_show_in_store": true, "is_free": false, "groups": [ "boosters" ], "order": 1, "prices": [ { "amount": 4.99, "currency": "USD", "is_default": true, "is_enabled": true } ] } }, "full-payload": { "summary": "Full payload example", "value": { "sku": "com.xsolla.sword_1", "name": { "en": "Sword", "de": "Schwert" }, "is_enabled": true, "is_free": false, "is_paid_randomized_reward": true, "groups": [ "weapons" ], "order": 1, "description": { "en": "A sword is a bladed melee weapon intended for cutting or thrusting that is longer than a knife or dagger, consisting of a long blade attached to a hilt.", "de": "Ein Schwert ist eine Nahkampfwaffe mit Klinge, die zum Schneiden oder Stechen bestimmt ist, länger als ein Messer oder Dolch ist und aus einer langen Klinge besteht, die an einem Griff befestigt ist." }, "prices": [ { "amount": 100, "currency": "USD", "is_enabled": true, "is_default": true }, { "amount": 200, "currency": "CZK", "country_iso": "CZ", "is_enabled": false, "is_default": true } ], "vc_prices": [], "is_show_in_store": true, "attributes": [ { "external_id": "craft-materials", "name": { "en": "Craft materials" }, "values": [ { "external_id": "steel", "value": { "en-US": "5" } }, { "external_id": "leather", "value": { "en-US": "1" } } ] } ], "limits": { "per_user": 5, "per_item": 100 }, "periods": [ { "date_from": "2020-08-11T10:00:00+03:00", "date_until": "2020-08-11T20:00:00+03:00" } ], "custom_attributes": { "purchased": 0, "attr": "value" } } } } } } }, "Virtual-Items-Currency_admin-create-virtual-currency": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Virtual-Items-Currency_admin-create-virtual-currency" }, "example": { "sku": "com.xsolla.coin_1", "name": { "en-US": "Gold coin", "de-DE": "Goldmünze" }, "is_enabled": true, "is_free": false, "is_paid_randomized_reward": false, "groups": [ "gold" ], "order": 1, "description": { "en-US": "The main currency of your kingdom", "de-DE": "Die Hauptwährung deines Königreichs" }, "prices": [ { "amount": 100, "currency": "USD", "is_enabled": true, "is_default": true } ], "attributes": [ { "external_id": "material", "name": { "en-US": "Material" }, "values": [ { "external_id": "gold", "value": { "en-US": "Gold" } } ] } ], "limits": { "per_user": 5, "per_item": 10000 }, "periods": [ { "date_from": "2020-08-11T10:00:00+03:00", "date_until": "2020-08-11T20:00:00+03:00" } ], "custom_attributes": { "purchased": 0, "attr": "value" } } } } }, "Virtual-Items-Currency_admin-create-virtual-currency-package": { "content": { "application/json": { "example": { "sku": "com.xsolla.novigrad_crown_500", "name": { "en-US": "500x Novigradian crown", "ru-RU": "500x Новиградских крон" }, "is_enabled": true, "is_free": false, "is_paid_randomized_reward": true, "groups": [ "witcher" ], "order": 1, "long_description": { "en-US": "Long Test new", "ru-RU": "Длинное описание" }, "description": { "en-US": "The Crown (also known as the Novigradian crown) is a monetary unit which is used in some Northern Kingdoms", "ru-RU": "Крона (Также известна как Новиградская крона) - платежная единица, используемая в северных королевствах" }, "image_url": "https://vignette.wikia.nocookie.net/witcher/images/7/7c/Items_Orens.png/revision/latest?cb=20081113120917", "media_list": [ { "type": "image", "url": "https://test.com/image0" }, { "type": "image", "url": "https://test.com/image1" } ], "attributes": [ { "external_id": "event", "name": { "en-US": "Event" }, "values": [ { "external_id": "10-anniversary", "value": { "en-US": "10th anniversary" } }, { "external_id": "christmas", "value": { "en-US": "Christmas" } } ] } ], "prices": [ { "currency": "USD", "amount": 99.99, "is_default": true }, { "currency": "EUR", "amount": 80.03, "is_enabled": false } ], "vc_prices": null, "content": [ { "sku": "com.xsolla.novigrad_crown", "quantity": 500 } ], "limits": { "per_user": null, "per_item": null }, "periods": [ { "date_from": "2020-08-11T10:00:00+03:00", "date_until": "2020-08-11T20:00:00+03:00" } ], "custom_attributes": { "purchased": 0, "attr": "value" } }, "schema": { "$ref": "#/components/schemas/Virtual-Items-Currency_admin-create-virtual-currency-package" } } } }, "ItemGroup_create": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/admin-group-create-request" }, "example": { "external_id": "weapons", "name": { "en": "Weapons", "de": "Waffen" }, "description": { "en": "Player weapons", "de": "Spielerwaffen" }, "iconUrl": "https://example.com/weapons.png", "isEnabled": true, "order": 1 } } }, "description": "아이템 그룹 데이터가 포함된 개체.", "required": true }, "ItemGroup_update": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/admin-group-update-request" }, "example": { "external_id": "weapons", "name": { "en": "Weapons Updated", "de": "Waffen Aktualisiert" }, "description": { "en": "Updated player weapons", "de": "Aktualisierte Spielerwaffen" }, "iconUrl": "https://example.com/weapons-new.png", "isEnabled": true, "order": 2 } } }, "description": "업데이트할 아이템 그룹 데이터가 포함된 개체.", "required": true }, "ItemGroup_order": { "content": { "application/json": { "schema": { "oneOf": [ { "title": "ID로 식별", "type": "array", "uniqueItems": true, "items": { "type": "object", "properties": { "id": { "type": "integer", "description": "엑솔라에서 할당한 아이템 그룹 ID입니다.", "minimum": 0, "example": 1 }, "order": { "type": "integer", "description": "새로운 디스플레이 주문 금액입니다.", "minimum": 0, "example": 1 } }, "required": [ "id", "order" ], "additionalProperties": false } }, { "title": "external_id로 식별", "type": "array", "uniqueItems": true, "items": { "type": "object", "properties": { "external_id": { "type": "string", "description": "생성 시 지정된 외부 아이템 그룹 ID입니다.", "minLength": 1, "example": "weapons" }, "order": { "type": "integer", "description": "새로운 디스플레이 주문 금액입니다.", "minimum": 0, "example": 1 } }, "required": [ "external_id", "order" ], "additionalProperties": false } } ] }, "examples": { "by_id": { "summary": "Identify groups by ID", "value": [ { "id": 1, "order": 1 }, { "id": 2, "order": 2 }, { "id": 3, "order": 3 } ] }, "by_external_id": { "summary": "Identify groups by external_id", "value": [ { "external_id": "weapons", "order": 1 }, { "external_id": "armor", "order": 2 }, { "external_id": "consumables", "order": 3 } ] } } } }, "description": "새로운 주문 값을 가진 그룹 목록입니다. 모든 아이템은 동일한 식별 방법을 사용해야 합니다(모두 `id`를 사용하거나 모두 `external_id`를 사용해야 함).", "required": true }, "ItemGroup_item_order": { "content": { "application/json": { "schema": { "type": "array", "uniqueItems": true, "items": { "$ref": "#/components/schemas/item-in-group-order-request-item" } }, "example": [ { "item_id": 101, "order": 1 }, { "item_id": 102, "order": 2 }, { "item_id": 103, "order": 3 } ] } }, "description": "그룹 내 새로운 주문 금액이 적용된 아이템 목록.", "required": true }, "Game-Keys_create-update-game-model": { "content": { "application/json": { "schema": { "type": "object", "properties": { "sku": { "type": "string", "minLength": 1, "maxLength": 255, "example": "game_1", "pattern": "^[a-zA-Z0-9_\\-–.]*$", "description": "고유 아이템 ID입니다. SKU는 소문자 및 대문자 라틴 영숫자, 마침표, 대시 및 밑줄만 포함할 수 있습니다." }, "name": { "$ref": "#/components/schemas/name-localization-object" }, "description": { "$ref": "#/components/schemas/description-localization-object" }, "long_description": { "$ref": "#/components/schemas/long-description-localization-object" }, "image_url": { "type": "string", "example": "https://image.example.com", "description": "이미지 URL입니다." }, "media_list": { "type": "array", "example": [ { "type": "image", "url": "https://cdn3.xsolla.com/img/misc/images/71ab1e12126f2103e1868076f0acb21a.jpg" } ], "description": "스크린샷, 게임 플레이 동영상 등과 같은 게임 추가 자산입니다.", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "image", "video" ], "example": "image", "description": "미디어 유형: `image`/`video`." }, "url": { "type": "string", "example": "https://cdn3.xsolla.com/img/misc/images/71ab1e12126f2103e1868076f0acb21a.jpg", "description": "리소스 파일입니다." } } } }, "order": { "type": "integer", "example": 1, "description": "목록에서 게임의 주문 우선 순위입니다." }, "groups": { "type": "array", "description": "아이템이 속한 그룹입니다.", "items": { "type": "object", "properties": { "external_id": { "type": "string", "example": "horror" } }, "required": [ "external_id" ] } }, "attributes": { "$ref": "#/components/schemas/Game-Keys_admin-post-put-attributes" }, "is_enabled": { "type": "boolean", "description": "비활성화된 경우 인벤토리를 통해 아이템을 구매하고 액세스할 수 없습니다." }, "is_show_in_store": { "type": "boolean", "description": "아이템을 구매할 수 있는 상태입니다." }, "unit_items": { "type": "array", "description": "다른 DRM용 게임 키입니다.", "items": { "type": "object", "description": "게임 키 아이템입니다. 특정 플랫폼(steam, gog 등)의 게임을 나타냅니다.", "properties": { "sku": { "type": "string", "minLength": 1, "maxLength": 255, "example": "game_1", "description": "고유 아이템 ID입니다. SKU는 소문자 및 대문자 라틴 영숫자, 마침표, 대시 및 밑줄만 포함할 수 있습니다." }, "name": { "$ref": "#/components/schemas/name-localization-object" }, "groups": { "type": "array", "description": "아이템이 속한 그룹입니다.", "items": { "type": "object", "properties": { "external_id": { "type": "string", "example": "horror" } }, "required": [ "external_id" ] } }, "attributes": { "$ref": "#/components/schemas/Game-Keys_admin-attributes" }, "is_free": { "$ref": "#/components/schemas/value-is_free" }, "prices": { "type": "array", "description": "실제 통화 가격입니다.", "items": { "type": "object", "properties": { "amount": { "type": "number", "example": 1299.99 }, "currency": { "type": "string", "example": "RUB", "description": "아이템 가격 통화입니다. [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)에 따른 3자리 코드입니다. [엑솔라에서 지원하는 통화](https://developers.xsolla.com/ko/doc/pay-station/references/supported-currencies/)에 대한 자세한 내용은 설명서를 확인하십시오." }, "is_default": { "type": "boolean", "description": "기본 가격은 사용자 통화로 가격을 지정하지 않은 경우 카탈로그를 작성하는 데 사용됩니다." }, "is_enabled": { "type": "boolean" } }, "required": [ "amount", "currency", "is_default", "is_enabled" ] } }, "vc_prices": { "type": "array", "items": { "type": "object", "properties": { "sku": { "type": "string", "example": "gold", "description": "고유 아이템 ID입니다. SKU는 소문자 및 대문자 라틴 영숫자, 마침표, 대시 및 밑줄만 포함할 수 있습니다." }, "amount": { "type": "number" }, "is_default": { "type": "boolean" }, "is_enabled": { "type": "boolean" } }, "required": [ "amount", "currency", "is_default", "is_enabled" ] } }, "order": { "type": "integer", "example": 1, "description": "목록에서 게임의 주문 우선 순위입니다." }, "is_enabled": { "type": "boolean", "description": "비활성화된 경우 인벤토리를 통해 아이템을 구매하고 액세스할 수 없습니다." }, "is_show_in_store": { "type": "boolean", "description": "아이템을 구매할 수 있는 상태입니다." }, "drm_sku": { "type": "string", "example": "steam", "description": "DRM 고유 ID입니다." }, "pre_order": { "type": "object", "description": "사전 판매 설정입니다.", "properties": { "release_date": { "type": "string", "description": "ISO 8601 형식으로 된 게임 키 출시 날짜입니다." }, "is_enabled": { "type": "boolean", "description": "비활성화된 경우 해당 아이템은 사전 판매 대상이 아닙니다." }, "description": { "type": "string", "description": "사전 판매에 대한 추가 정보는 이메일로 전송됩니다." } }, "required": [ "release_date", "is_enabled" ] }, "regions": { "$ref": "#/components/schemas/Game-Keys_regions" }, "limits": { "$ref": "#/components/schemas/Game-key-item-limit" }, "periods": { "$ref": "#/components/schemas/item-periods" } }, "required": [ "sku", "drm_sku", "prices" ] } } }, "required": [ "sku", "name", "unit_items" ], "example": { "sku": "com.xsolla.game_1", "name": { "en-US": "Game name", "ru-RU": "Название игры" }, "description": { "en-US": "Game description", "ru-RU": "Краткое описание игры" }, "long_description": { "en-US": "Game long description", "ru-RU": "Полное описание игры" }, "image_url": "http://image.png", "media_list": [ { "type": "image", "url": "http://image.png" }, { "type": "video", "url": "http://video.png" } ], "groups": [ "new_games" ], "is_enabled": true, "is_show_in_store": true, "unit_items": [ { "sku": "com.xsolla.game_key_1", "name": { "en-US": "Game key name", "ru-RU": "Название игрового ключа" }, "drm_sku": "steam_key_1", "prices": [ { "amount": 35.5, "currency": "USD", "is_enabled": true, "is_default": true } ], "vc_prices": [ { "amount": 35.5, "sku": "com.xsolla.gold_1", "is_enabled": true, "is_default": true } ], "is_enabled": true, "is_free": false, "is_show_in_store": true, "pre_order": { "release_date": "2020-08-11T10:00:00+03:00", "is_enabled": true, "description": "Some description" }, "regions": [ { "id": 12 }, { "id": 64 } ], "limits": { "per_user": { "total": 5 }, "per_item": { "total": 10000, "available": 5000, "reserved": 500, "sold": 4500 } }, "periods": [ { "date_from": "2020-08-11T10:00:00+03:00", "date_until": "2020-08-11T20:00:00+03:00" } ] } ] } } } }, "description": "게임 데이터가 있는 개체입니다.", "required": true }, "Bundles_bundle": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Bundles_admin_bundle_request" }, "example": { "sku": "com.xsolla.armour_chest_1", "name": { "en": "Chest of armour", "de": "Brustpanzer" }, "is_enabled": true, "is_free": true, "is_paid_randomized_reward": true, "order": 1, "long_description": { "en": "Chest of armour for soldiers", "de": "Brustpanzer für Soldaten" }, "description": { "en": "Chest of armour for soldiers", "de": "Brustpanzer für Soldaten" }, "image_url": "https://picture.bundle-with-many-stuff.png", "media_list": [ { "type": "image", "url": "https://test.com/image0" }, { "type": "image", "url": "https://test.com/image1" } ], "groups": [ "chests" ], "attributes": [ { "external_id": "class", "name": { "en": "Class" }, "values": [ { "external_id": "soldier", "value": { "en": "Soldier" } }, { "external_id": "officer", "value": { "en": "Officer" } } ] } ], "prices": [ { "currency": "USD", "amount": "9.99", "is_default": true, "is_enabled": true }, { "currency": "EUR", "amount": "9.99", "is_default": false, "is_enabled": true } ], "vc_prices": [], "content": [ { "sku": "com.xsolla.iron_gloves_1", "quantity": 1 }, { "sku": "com.xsolla.iron_boots_1", "quantity": 1 }, { "sku": "com.xsolla.iron_shield_1", "quantity": 1 }, { "sku": "com.xsolla.iron_armour_1", "quantity": 1 }, { "sku": "com.xsolla.iron_helmet_1", "quantity": 1 } ], "limits": { "per_user": null, "per_item": null }, "periods": [ { "date_from": "2020-08-11T10:00:00+03:00", "date_until": "2020-08-11T20:00:00+03:00" } ], "custom_attributes": { "type": "lootbox", "purchased": 0 } } } }, "description": "번들 데이터가 있는 개체입니다.", "required": true }, "Cart-Payment_fill-cart-json-model": { "content": { "application/json": { "schema": { "type": "object", "required": [ "items" ], "example": { "items": [ { "sku": "com.xsolla.booster_mega_1", "quantity": 123 } ] }, "properties": { "items": { "type": "array", "description": "아이템 목록입니다.", "items": { "type": "object", "minItems": 1, "required": [ "sku", "quantity" ], "properties": { "sku": { "type": "string", "default": "booster_mega_1" }, "quantity": { "type": "number", "default": 123 } } } } } } } } }, "Cart-Payment_put-item-by-cart-idJsonModel": { "content": { "application/json": { "schema": { "type": "object", "properties": { "quantity": { "type": "number", "description": "아이템 수량입니다.", "default": 123 } } } } } }, "Cart-Payment_create-order-by-cart-idJsonModel": { "content": { "application/json": { "schema": { "type": "object", "properties": { "currency": { "type": "string", "description": "주문 가격 통화입니다. [ ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)에 따른 3글자 통화 코드입니다. [엑솔라에서 지원하는 통화](https://developers.xsolla.com/ko/doc/pay-station/references/supported-currencies/)에 대한 자세한 정보는 설명서를 확인하십시오." }, "locale": { "type": "string", "description": "응답 언어입니다." }, "sandbox": { "type": "boolean", "description": "샌드박스 모드로 주문을 생성합니다. 이 옵션은 회사 사용자 목록에서 지정한 사용자에게 사용할 수 있습니다.", "default": false }, "settings": { "type": "object", "description": "사용자의 결제 프로세스와 결제 UI를 구성하는 설정입니다.", "additionalProperties": false, "properties": { "ui": { "$ref": "#/components/schemas/Cart-Payment_settings_ui" }, "payment_method": { "$ref": "#/components/schemas/Cart-Payment_settings_payment_method" }, "return_url": { "$ref": "#/components/schemas/Cart-Payment_settings_return_url" }, "redirect_policy": { "$ref": "#/components/schemas/Cart-Payment_redirect_policy" } } }, "custom_parameters": { "type": "object", "description": "프로젝트별 매개 변수입니다.", "minProperties": 1, "maxProperties": 200 } } }, "example": { "sandbox": true, "settings": { "ui": { "theme": "63295a9a2e47fab76f7708e1", "desktop": { "header": { "is_visible": true, "visible_logo": true, "visible_name": true, "visible_purchase": true, "type": "normal", "close_button": false } } } }, "custom_parameters": { "character_id": "ingameUsername" } } } } }, "Cart-Payment_create-order-with-specified-item-idJsonModel": { "content": { "application/json": { "schema": { "type": "object", "properties": { "currency": { "type": "string", "description": "주문 가격 통화입니다. [ ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)에 따른 3글자 통화 코드입니다. [엑솔라에서 지원하는 통화](https://developers.xsolla.com/ko/doc/pay-station/references/supported-currencies/)에 대한 자세한 정보는 설명서를 확인하십시오." }, "locale": { "type": "string", "description": "응답 언어입니다." }, "sandbox": { "type": "boolean", "description": "샌드박스 모드로 주문을 생성합니다. 이 옵션은 회사 사용자 목록에서 지정한 사용자에게 사용할 수 있습니다.", "default": false }, "quantity": { "type": "integer", "minimum": 1, "description": "아이템 수량입니다.", "default": 1 }, "promo_code": { "type": "string", "description": "결제 시 프로모션 코드 프로모션용 코드를 사용합니다." }, "settings": { "type": "object", "description": "사용자의 결제 프로세스와 결제 UI를 구성하는 설정입니다.", "additionalProperties": false, "properties": { "ui": { "$ref": "#/components/schemas/Cart-Payment_settings_ui" }, "payment_method": { "$ref": "#/components/schemas/Cart-Payment_settings_payment_method" }, "return_url": { "$ref": "#/components/schemas/Cart-Payment_settings_return_url" }, "redirect_policy": { "$ref": "#/components/schemas/Cart-Payment_redirect_policy" } } }, "custom_parameters": { "type": "object", "description": "프로젝트별 매개 변수입니다.", "minProperties": 1, "maxProperties": 200 } } }, "example": { "sandbox": true, "quantity": 5, "promo_code": "discount_code", "settings": { "ui": { "theme": "63295a9a2e47fab76f7708e1", "desktop": { "header": { "is_visible": true, "visible_logo": true, "visible_name": true, "visible_purchase": true, "type": "normal", "close_button": false } } } }, "custom_parameters": { "character_id": "ingameUsername" } } } } }, "admin-order-search": { "description": "주문 검색 매개 변수", "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "type": "integer", "description": "응답에 포함되는 주문 수에 대한 제한입니다.", "minimum": 1, "maximum": 10, "default": 10, "nullable": false }, "offset": { "type": "integer", "description": "목록이 생성되는 주문 수입니다(개수는 0부터 시작).", "default": 0, "minimum": 0, "nullable": false }, "created_date_from": { "type": "string", "format": "date-time", "nullable": false, "example": "2020-04-15T18:16:00+05:00", "description": "[ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)에 따른 주문 생성 기간의 시작 날짜 또는 날짜-시간입니다." }, "created_date_until": { "type": "string", "format": "date-time", "nullable": false, "example": "2020-04-16T18:16:00+05:00", "description": "[ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)에 따른 주문 생성 기간의 종료 날짜 또는 날짜-시간입니다." } } }, "example": { "offset": 0, "limit": 5, "created_date_from": "2018-01-07T00:00:00+03:00", "created_date_until": "2018-01-09T16:00:00+03:00" } } } }, "Cart-Payment_admin-create-payment-token": { "content": { "application/json": { "schema": { "type": "object", "required": [ "user", "purchase" ], "properties": { "sandbox": { "$ref": "#/components/schemas/Cart-Payment_settings_sandbox" }, "user": { "$ref": "#/components/schemas/Cart-Payment_admin-user-request-body" }, "purchase": { "$ref": "#/components/schemas/Cart_admin_payment" }, "promo_code": { "$ref": "#/components/schemas/Promotions_coupon_code" }, "settings": { "type": "object", "description": "사용자의 결제 프로세스와 결제 UI를 구성하는 설정입니다.", "additionalProperties": false, "properties": { "ui": { "$ref": "#/components/schemas/Cart-Payment_settings_ui" }, "currency": { "$ref": "#/components/schemas/Cart-Payment_settings_currency" }, "language": { "$ref": "#/components/schemas/Cart-Payment_settings_locale" }, "external_id": { "$ref": "#/components/schemas/Cart-Payment_settings_external_id" }, "payment_method": { "$ref": "#/components/schemas/Cart-Payment_settings_payment_method" }, "return_url": { "$ref": "#/components/schemas/Cart-Payment_settings_return_url" }, "redirect_policy": { "$ref": "#/components/schemas/Cart-Payment_redirect_policy" } } }, "custom_parameters": { "$ref": "#/components/schemas/Cart-Payment_custom_parameters_token" } }, "additionalProperties": false }, "examples": { "common": { "value": { "user": { "id": { "value": "user-id" }, "name": { "value": "user-name" }, "email": { "value": "user@xsolla.com" }, "country": { "value": "US", "allow_modify": false } }, "purchase": { "items": [ { "sku": "com.xsolla.cup01", "quantity": 2 }, { "sku": "com.xsolla.t-shirt01", "quantity": 1 }, { "sku": "com.xsolla.cup02", "quantity": 1 }, { "sku": "com.xsolla.hat01", "quantity": 1 } ] }, "settings": { "language": "de", "external_id": "AABBCCDD01", "currency": "USD", "payment_method": 1380, "return_url": "https://developers.xsolla.com/ko/", "ui": { "theme": "63295aab2e47fab76f7708e3" } } } }, "in-sandbox": { "value": { "sandbox": true, "user": { "id": { "value": "user-id" } }, "purchase": { "items": [ { "sku": "com.xsolla.cup01", "quantity": 2 }, { "sku": "com.xsolla.t-shirt01", "quantity": 1 }, { "sku": "com.xsolla.cup02", "quantity": 1 }, { "sku": "com.xsolla.hat01", "quantity": 1 } ] }, "settings": { "currency": "USD" } } }, "with-custom-parameters": { "value": { "user": { "id": { "value": "user-id" }, "name": { "value": "user-name" }, "email": { "value": "user@xsolla.com" }, "country": { "value": "US", "allow_modify": false } }, "purchase": { "items": [ { "sku": "com.xsolla.cup01", "quantity": 2 }, { "sku": "com.xsolla.t-shirt01", "quantity": 1 }, { "sku": "com.xsolla.cup02", "quantity": 1 }, { "sku": "com.xsolla.hat01", "quantity": 1 } ] }, "settings": { "language": "de", "external_id": "AABBCCDD01", "currency": "USD", "payment_method": 1380, "return_url": "https://developers.xsolla.com/ko/", "ui": { "theme": "63295aab2e47fab76f7708e3" } }, "custom_parameters": { "user_public_id": "player1", "user_os": "windows10" } } } } } } }, "Cart-Payment_admin-fill-cart-json-model": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Cart" }, "examples": { "basic": { "value": { "currency": "USD", "items": [ { "sku": "com.xsolla.cup01", "quantity": 2 }, { "sku": "com.xsolla.t-shirt01", "quantity": 1 }, { "sku": "com.xsolla.cup02", "quantity": 1 }, { "sku": "com.xsolla.hat01", "quantity": 1 } ] } } } } } }, "reset-user-limits": { "content": { "application/json": { "schema": { "type": "object", "required": [ "user" ], "properties": { "user": { "$ref": "#/components/schemas/User-limit_user" } } }, "example": { "user": { "user_external_id": "d342dad2-9d59-11e9-a384-42010aa8003f" } } } } }, "reset-user-limits-flexible": { "content": { "application/json": { "schema": { "type": "object", "required": [ "user" ], "properties": { "user": { "$ref": "#/components/schemas/User-limit_user_flexible" } } }, "example": { "user": { "user_external_id": "d342dad2-9d59-11e9-a384-42010aa8003f" } } } } }, "update-user-limits-flexible": { "content": { "application/json": { "schema": { "type": "object", "required": [ "user", "available" ], "properties": { "user": { "$ref": "#/components/schemas/User-limit_user" }, "available": { "$ref": "#/components/schemas/User-limit_available_flexible" } } }, "example": { "user": { "user_external_id": "d342dad2-9d59-11e9-a384-42010aa8003f" }, "available": 0 } } } }, "update-user-limits-strict": { "content": { "application/json": { "schema": { "type": "object", "required": [ "user", "available" ], "properties": { "user": { "$ref": "#/components/schemas/User-limit_user" }, "available": { "$ref": "#/components/schemas/User-limit_available" } } }, "example": { "user": { "user_external_id": "d342dad2-9d59-11e9-a384-42010aa8003f" }, "available": 1 } } } }, "connector-import-items-body": { "content": { "application/json": { "schema": { "type": "object", "required": [ "connector_external_id", "file_url" ], "properties": { "connector_external_id": { "type": "string", "description": "아이템을 가져오기 위한 작업 유형을 지정하는 고정 값입니다.", "enum": [ "import_items" ] }, "file_url": { "type": "string", "description": "JSON 형식의 데이터가 있는 파일의 URL입니다. 파일은 공개 액세스가 가능한 스토리지 서비스에 호스팅되어야 합니다. [ 스토어 > 가상 아이템 > 카탈로그 관리 > 아이템 가져오기(JSON)](https://publisher.xsolla.com/0/projects/0/storefront/import-export/import-items) 섹션의 관리자 페이지에서 파일 템플릿을 다운로드할 수 있습니다.", "example": "https://my-bucket.s3.amazonaws.com/items.json" }, "mode": { "type": "string", "description": "가져오기 작업:\n\n가능한 값:\n- `create` - 새 아이템을 추가합니다.\n- `create_and_update` - 새 아이템을 추가하고 기존 항목을 업데이트합니다.\n- `sync` - 새 아이템을 추가하고, 기존 아이템을 업데이트하며, 누락된 아이템을 비활성화합니다.", "enum": [ "create", "create_and_update", "sync" ], "default": "create_and_update" } } } } } }, "create-update-region": { "content": { "application/json": { "schema": { "type": "object", "required": [ "countries", "name" ], "properties": { "countries": { "$ref": "#/components/schemas/Regions_countries" }, "name": { "$ref": "#/components/schemas/Regions_name" } }, "example": { "name": { "en-US": "Asia", "de-DE": "Asien" }, "countries": [ "JP", "CN", "VN" ] } } } } }, "create-update-attribute": { "content": { "application/json": { "schema": { "type": "object", "required": [ "external_id", "name" ], "properties": { "external_id": { "$ref": "#/components/schemas/admin-attribute-external_id" }, "name": { "$ref": "#/components/schemas/admin-attribute-name" } } }, "example": { "external_id": "genre", "name": { "en": "Genre", "de": "Genre" } } } } }, "create-update-attribute-value": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/request-attribute-value" }, "example": { "external_id": "weapon_class_sword_value", "value": { "en": "Sword", "de": "Schwert" } } } } } }, "examples": { "422-property-sku-is-required": { "value": { "statusCode": 422, "errorCode": 1102, "errorMessage": "[0401-1102]: Unprocessable Entity. The property `sku` is required", "transactionId": "da145238620011eb8e24fe6913ff226a" } }, "422-numbers-of-attribute-values-per-item-exceeded": { "value": { "statusCode": 422, "errorCode": 9909, "errorMessage": "[0401-9909]: The number of attribute values you specified for the item exceeds the required limit. Try to specify fewer attribute values.", "transactionId": "da145238620011eb8e24fe6913ff226a" } }, "422-numbers-of-attributes-per-item-exceeded": { "value": { "statusCode": 422, "errorCode": 9908, "errorMessage": "[0401-9908]: The number of attributes you specified for the item exceeds the required limit. Try to specify fewer attributes.", "transactionId": "da145238620011eb8e24fe6913ff226a" } }, "422-value-limit-exceeded": { "value": { "statusCode": 422, "errorCode": 9908, "errorMessage": "[0401-9908]: You reached the maximum number of values for the attribute.", "transactionId": "x-x-x-x-transactionId-mock-x-x-x" } }, "422-custom-attributes-size-exceeded": { "value": { "statusCode": 422, "errorCode": 1102, "errorMessage": "[0401-1102]: Unprocessable Entity", "transactionId": "da145238620011eb8e24fe6913ff226a", "errorMessageExtended": [ { "property": "custom_attributes", "message": "JSON can’t exceed 500 characters." } ] } }, "200-admin-get-group-list": { "value": { "groups": [ { "id": 1, "external_id": "weapons", "name": { "en": "Weapons" }, "description": { "en": "Player weapons" }, "image_url": "https://example.com/weapons.png", "order": 1, "is_enabled": true, "items_count": 5 }, { "id": 2, "external_id": "swords", "name": { "en": "Swords" }, "description": { "en": "Melee weapons" }, "image_url": "https://example.com/swords.png", "order": 2, "is_enabled": true, "items_count": 3 }, { "id": 3, "external_id": "armor", "name": { "en": "Armor" }, "description": { "en": "Player armor" }, "image_url": "https://example.com/armor.png", "order": 3, "is_enabled": true, "items_count": 4 } ] } }, "201-admin-create-group": { "value": { "external_id": "weapons" } }, "422-property-external-id-required": { "value": { "statusCode": 422, "errorCode": 1102, "errorMessage": "[0401-1102]: Unprocessable Entity", "transactionId": "x-x-x-x-transactionId-mock-x-x-x", "errorMessageExtended": [ { "property": "external_id", "message": "The property external_id is required" } ] } }, "200-admin-get-group": { "value": { "id": 1, "external_id": "weapons", "name": { "en": "Weapons" }, "description": { "en": "Player weapons" }, "image_url": "https://example.com/weapons.png", "order": 1, "is_enabled": true, "items_count": 5 } }, "200-admin-get-group-list-by-item-type": { "value": { "groups": [ { "id": 1, "external_id": "weapons", "name": { "en": "Weapons" }, "description": { "en": "Player weapons" }, "image_url": "https://example.com/weapons.png", "order": 1, "is_enabled": true, "items_count": 3, "is_contains_any_items": true }, { "id": 2, "external_id": "swords", "name": { "en": "Swords" }, "description": { "en": "Melee weapons" }, "image_url": "https://example.com/swords.png", "order": 2, "is_enabled": true, "items_count": 2, "is_contains_any_items": true }, { "id": 3, "external_id": "armor", "name": { "en": "Armor" }, "description": { "en": "Player armor" }, "image_url": "https://example.com/armor.png", "order": 3, "is_enabled": true, "items_count": 0, "is_contains_any_items": false } ] } }, "200-admin-get-group-by-item-type": { "value": { "id": 1, "external_id": "weapons", "name": { "en": "Weapons" }, "description": { "en": "Player weapons" }, "image_url": "https://example.com/weapons.png", "order": 1, "is_enabled": true, "items_count": 3, "is_contains_any_items": true } }, "404-game-code-not-found": { "value": { "statusCode": 404, "errorCode": 4603, "errorMessage": "[0401-4603]: Game code not found.", "transactionId": "transaction id" } }, "422-drm-is-not-drm-free": { "value": { "statusCode": 422, "errorCode": 5103, "errorMessage": "[0401-5103]: Selected drm is not drmfree.", "transactionId": "transaction id" } }, "422-user-already-has-entitlement": { "value": { "statusCode": 422, "errorCode": 5101, "errorMessage": "[0401-5101]: User already has entitlement.", "transactionId": "transaction id" } }, "Bundles_200-get-bundle-list": { "value": { "has_more": true, "items": [ { "item_id": 61031, "sku": "com.xsolla.kg_1", "name": "kg_10.00_bundle", "type": "bundle", "description": "pricePoint_44056_1", "image_url": null, "long_description": null, "attributes": [ { "external_id": "genre", "name": "Genre", "values": [ { "external_id": "genre_e3364991f92e751689a68b96598a5a5a84010b85", "value": "Casual" }, { "external_id": "genre_eba07bfd0f982940773cba3744d97264dd58acd7", "value": "Strategy" }, { "external_id": "genre_b8d0c6d8f0524c2b2d79ebb93aa3cd0e8b5199a8", "value": "Mobile" } ] } ], "is_free": false, "order": 999, "groups": [ { "external_id": "exclusive", "name": "Exclusive", "item_order_in_group": 1 } ], "price": { "amount": "9.99", "currency": "USD", "amount_without_discount": "9.99" }, "total_content_price": { "amount": "10.99", "currency": "USD", "amount_without_discount": "10.99" }, "media_list": [], "virtual_prices": [], "can_be_bought": true, "bundle_type": "standard", "promotions": [], "limits": { "per_user": { "total": 5, "available": 3, "recurrent_schedule": { "interval_type": "weekly", "reset_next_date": 1746057600 }, "limit_exceeded_visibility": "show" } }, "periods": [ { "date_from": "2020-08-11T10:00:00+03:00", "date_until": "2020-08-11T20:00:00+03:00" } ], "custom_attributes": { "purchased": 0, "attr": "value" }, "content": [ { "sku": "com.xsolla.big_rocket_1", "name": "Big Rocket", "description": "Big Rocket - short description.", "image_url": "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png", "type": "virtual_currency", "quantity": 100, "virtual_item_type": "non_consumable", "attributes": [ { "external_id": "size", "name": "Size", "values": [ { "external_id": "size_e3364991f92e751689a68b96598a5a5a84010b85", "value": "Large" } ] } ], "is_free": false, "groups": [], "price": { "amount": "10.99", "currency": "USD", "amount_without_discount": "10.99" }, "virtual_prices": [], "limits": { "per_user": { "total": 5, "available": 3, "recurrent_schedule": { "interval_type": "weekly", "reset_next_date": 1746057600 }, "limit_exceeded_visibility": "show" } } } ], "vp_rewards": [ { "item_id": 175232, "sku": "com.xsolla.value_point_1", "amount": 130, "name": "Value point", "image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg" }, { "item_id": 186321, "sku": "com.xsolla.clan_value_point_1", "amount": 50, "name": "Clan Reward VP 1", "image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg", "is_clan": true } ] } ] } }, "Bundles_200-get-bundle": { "value": { "item_id": 610316, "sku": "com.xsolla.kg_1", "name": "kg_10.00_bundle", "type": "bundle", "description": "pricePoint_44056_1.", "image_url": null, "long_description": null, "attributes": [], "is_free": false, "order": 999, "groups": [], "price": { "amount": "9.99", "currency": "USD", "amount_without_discount": "9.99" }, "total_content_price": { "amount": "10.99", "currency": "USD", "amount_without_discount": "10.99" }, "media_list": [], "virtual_prices": [], "promotions": [], "limits": { "per_user": { "total": 5, "available": 3, "recurrent_schedule": { "interval_type": "weekly", "reset_next_date": 1746057600 }, "limit_exceeded_visibility": "show" } }, "can_be_bought": true, "bundle_type": "standard", "periods": [ { "date_from": "2020-08-11T10:00:00+03:00", "date_until": "2020-08-11T20:00:00+03:00" } ], "custom_attributes": { "purchased": 0, "attr": "value" }, "content": [ { "description": "Big Rocket - short description.", "image_url": "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png", "sku": "com.xsolla.big_rocket_1", "name": "Big Rocket", "type": "virtual_currency", "quantity": 100, "attributes": [], "is_free": false, "groups": [], "price": { "amount": "10.99", "currency": "USD", "amount_without_discount": "10.99" }, "virtual_prices": [], "limits": { "per_user": { "total": 5, "available": 3, "recurrent_schedule": { "interval_type": "weekly", "reset_next_date": 1746057600 }, "limit_exceeded_visibility": "show" } } } ], "vp_rewards": [ { "item_id": 175232, "sku": "com.xsolla.value_point_1", "amount": 130, "name": "Value point", "image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg" }, { "item_id": 186321, "sku": "com.xsolla.clan_value_point_1", "amount": 50, "name": "Clan Reward VP 1", "image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg", "is_clan": true } ] } }, "404-item-by-sku-not-found": { "value": { "statusCode": 404, "errorCode": 4001, "errorMessage": "[0401-4001]: Item with sku = 'item_sku' not found", "transactionId": "transaction id" } }, "404-coupon-not-found": { "value": { "statusCode": 404, "errorCode": 9802, "errorMessage": "[0401-9802]: Coupon not found", "transactionId": "x-x-x-x-transactionId-mock-x-x-x" } }, "404-user-not-found": { "value": { "statusCode": 404, "errorCode": 5008, "errorMessage": "[0401-5008]: Could not find User", "transactionId": "transaction id" } }, "422-user_external_id_invalid": { "value": { "statusCode": 404, "errorCode": 1102, "errorMessage": "[0401-1102]: Unprocessable Entity", "transactionId": "transaction id", "errorMessageExtended": [ { "property": "user_external_id", "message": "Must be at least 1 characters long" }, { "property": "user_external_id", "message": "Does not match the regex pattern ^\\S+$" } ] } }, "422-item-without-user-limit": { "value": { "statusCode": 422, "errorCode": 4508, "errorMessage": "[0401-4508]: Item does not have configured user limits.", "transactionId": "transaction id" } }, "422-item-out-of-range-available-user-limit": { "value": { "statusCode": 422, "errorCode": 4510, "errorMessage": "[0401-4510]: Available item limit is out of range.", "transactionId": "transaction id" } }, "422-external-id-required": { "value": { "statusCode": 422, "errorCode": 9901, "errorMessage": "[0401-1102]: Unprocessable Entity. The property `external_id` is required", "transactionId": "x-x-x-x-transactionId-mock-x-x-x" } }, "422-external-id-invalid": { "value": { "statusCode": 422, "errorCode": 9901, "errorMessage": "[0401-1102]: Unprocessable Entity. Does not match the regex pattern ^[a-zA-Z0-9-_]+$", "transactionId": "x-x-x-x-transactionId-mock-x-x-x" } }, "422-external-id-duplicate": { "value": { "statusCode": 422, "errorCode": 9907, "errorMessage": "[0401-9907]: The attribute value already exists.", "transactionId": "x-x-x-x-transactionId-mock-x-x-x" } }, "422-value-invalid": { "value": { "statusCode": 422, "errorCode": 9901, "errorMessage": "[0401-1102]: Unprocessable Entity. The property `value` is required", "transactionId": "x-x-x-x-transactionId-mock-x-x-x" } }, "422-value-properties-required": { "value": { "statusCode": 422, "errorCode": 9901, "errorMessage": "[0401-1102]: Unprocessable Entity. Array value found, but an object is required", "transactionId": "x-x-x-x-transactionId-mock-x-x-x" } }, "404-attribute-not-found": { "value": { "statusCode": 404, "errorCode": 9901, "errorMessage": "[0401-9901]: Attribute not found.", "transactionId": "x-x-x-x-transactionId-mock-x-x-x" } }, "404-attribute-value-not-found": { "value": { "statusCode": 404, "errorCode": 9906, "errorMessage": "[0401-9906]: Attribute value not found.", "transactionId": "x-x-x-x-transactionId-mock-x-x-x" } } } }, "x-tagGroups": [ { "name": "가상 아이템 및 인게임 재화", "tags": [ "virtual-items-currency-overview", "virtual-items-currency-admin", "virtual-items-currency-catalog", "virtual-payment" ] }, { "name": "게임 키", "tags": [ "game-keys-overview", "game-keys-catalog", "game-keys-entitlement", "game-keys-admin" ] }, { "name": "번들", "tags": [ "bundles-overview", "bundles-admin", "bundles-catalog" ] }, { "name": "장바구니 및 결제", "tags": [ "cart-and-payment-overview", "order-life-cycle", "cart-client-side", "cart-server-side", "payment-client-side", "payment-server-side", "order", "free-item" ] }, { "name": "제한 사항", "tags": [ "limits-overview", "user-limits-admin" ] }, { "name": "아이템 가져오기", "tags": [ "connector-admin" ] }, { "name": "일반", "tags": [ "common-pre-orders", "common-merchant", "common-catalog", "common-regions", "common-webhooks" ] }, { "name": "아이템 특성", "tags": [ "attribute-admin" ] }, { "name": "아이템 그룹", "tags": [ "item-groups-admin", "item-groups-catalog" ] } ] }