{ "components": { "examples": { "200-admin-get-group": { "value": { "description": { "en": "Player weapons" }, "external_id": "weapons", "id": 1, "image_url": "https://example.com/weapons.png", "is_enabled": true, "items_count": 5, "name": { "en": "Weapons" }, "order": 1 } }, "200-admin-get-group-by-item-type": { "value": { "description": { "en": "Player weapons" }, "external_id": "weapons", "id": 1, "image_url": "https://example.com/weapons.png", "is_contains_any_items": true, "is_enabled": true, "items_count": 3, "name": { "en": "Weapons" }, "order": 1 } }, "200-admin-get-group-list": { "value": { "groups": [ { "description": { "en": "Player weapons" }, "external_id": "weapons", "id": 1, "image_url": "https://example.com/weapons.png", "is_enabled": true, "items_count": 5, "name": { "en": "Weapons" }, "order": 1 }, { "description": { "en": "Melee weapons" }, "external_id": "swords", "id": 2, "image_url": "https://example.com/swords.png", "is_enabled": true, "items_count": 3, "name": { "en": "Swords" }, "order": 2 }, { "description": { "en": "Player armor" }, "external_id": "armor", "id": 3, "image_url": "https://example.com/armor.png", "is_enabled": true, "items_count": 4, "name": { "en": "Armor" }, "order": 3 } ] } }, "200-admin-get-group-list-by-item-type": { "value": { "groups": [ { "description": { "en": "Player weapons" }, "external_id": "weapons", "id": 1, "image_url": "https://example.com/weapons.png", "is_contains_any_items": true, "is_enabled": true, "items_count": 3, "name": { "en": "Weapons" }, "order": 1 }, { "description": { "en": "Melee weapons" }, "external_id": "swords", "id": 2, "image_url": "https://example.com/swords.png", "is_contains_any_items": true, "is_enabled": true, "items_count": 2, "name": { "en": "Swords" }, "order": 2 }, { "description": { "en": "Player armor" }, "external_id": "armor", "id": 3, "image_url": "https://example.com/armor.png", "is_contains_any_items": false, "is_enabled": true, "items_count": 0, "name": { "en": "Armor" }, "order": 3 } ] } }, "201-admin-create-group": { "value": { "external_id": "weapons" } }, "404-attribute-not-found": { "value": { "errorCode": 9901, "errorMessage": "[0401-9901]: Attribute not found.", "statusCode": 404, "transactionId": "x-x-x-x-transactionId-mock-x-x-x" } }, "404-attribute-value-not-found": { "value": { "errorCode": 9906, "errorMessage": "[0401-9906]: Attribute value not found.", "statusCode": 404, "transactionId": "x-x-x-x-transactionId-mock-x-x-x" } }, "404-coupon-not-found": { "value": { "errorCode": 9802, "errorMessage": "[0401-9802]: Coupon not found", "statusCode": 404, "transactionId": "x-x-x-x-transactionId-mock-x-x-x" } }, "404-game-code-not-found": { "value": { "errorCode": 4603, "errorMessage": "[0401-4603]: Game code not found.", "statusCode": 404, "transactionId": "transaction id" } }, "404-item-by-sku-not-found": { "value": { "errorCode": 4001, "errorMessage": "[0401-4001]: Item with sku = 'item_sku' not found", "statusCode": 404, "transactionId": "transaction id" } }, "404-user-not-found": { "value": { "errorCode": 5008, "errorMessage": "[0401-5008]: Could not find User", "statusCode": 404, "transactionId": "transaction id" } }, "422-custom-attributes-size-exceeded": { "value": { "errorCode": 1102, "errorMessage": "[0401-1102]: Unprocessable Entity", "errorMessageExtended": [ { "message": "JSON can’t exceed 500 characters.", "property": "custom_attributes" } ], "statusCode": 422, "transactionId": "da145238620011eb8e24fe6913ff226a" } }, "422-drm-is-not-drm-free": { "value": { "errorCode": 5103, "errorMessage": "[0401-5103]: Selected drm is not drmfree.", "statusCode": 422, "transactionId": "transaction id" } }, "422-external-id-duplicate": { "value": { "errorCode": 9907, "errorMessage": "[0401-9907]: The attribute value already exists.", "statusCode": 422, "transactionId": "x-x-x-x-transactionId-mock-x-x-x" } }, "422-external-id-invalid": { "value": { "errorCode": 9901, "errorMessage": "[0401-1102]: Unprocessable Entity. Does not match the regex pattern ^[a-zA-Z0-9-_]+$", "statusCode": 422, "transactionId": "x-x-x-x-transactionId-mock-x-x-x" } }, "422-external-id-required": { "value": { "errorCode": 9901, "errorMessage": "[0401-1102]: Unprocessable Entity. The property `external_id` is required", "statusCode": 422, "transactionId": "x-x-x-x-transactionId-mock-x-x-x" } }, "422-item-out-of-range-available-user-limit": { "value": { "errorCode": 4510, "errorMessage": "[0401-4510]: Available item limit is out of range.", "statusCode": 422, "transactionId": "transaction id" } }, "422-item-without-user-limit": { "value": { "errorCode": 4508, "errorMessage": "[0401-4508]: Item does not have configured user limits.", "statusCode": 422, "transactionId": "transaction id" } }, "422-numbers-of-attribute-values-per-item-exceeded": { "value": { "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.", "statusCode": 422, "transactionId": "da145238620011eb8e24fe6913ff226a" } }, "422-numbers-of-attributes-per-item-exceeded": { "value": { "errorCode": 9908, "errorMessage": "[0401-9908]: The number of attributes you specified for the item exceeds the required limit. Try to specify fewer attributes.", "statusCode": 422, "transactionId": "da145238620011eb8e24fe6913ff226a" } }, "422-property-external-id-required": { "value": { "errorCode": 1102, "errorMessage": "[0401-1102]: Unprocessable Entity", "errorMessageExtended": [ { "message": "The property external_id is required", "property": "external_id" } ], "statusCode": 422, "transactionId": "x-x-x-x-transactionId-mock-x-x-x" } }, "422-property-sku-is-required": { "value": { "errorCode": 1102, "errorMessage": "[0401-1102]: Unprocessable Entity. The property `sku` is required", "statusCode": 422, "transactionId": "da145238620011eb8e24fe6913ff226a" } }, "422-user-already-has-entitlement": { "value": { "errorCode": 5101, "errorMessage": "[0401-5101]: User already has entitlement.", "statusCode": 422, "transactionId": "transaction id" } }, "422-user_external_id_invalid": { "value": { "errorCode": 1102, "errorMessage": "[0401-1102]: Unprocessable Entity", "errorMessageExtended": [ { "message": "Must be at least 1 characters long", "property": "user_external_id" }, { "message": "Does not match the regex pattern ^\\S+$", "property": "user_external_id" } ], "statusCode": 404, "transactionId": "transaction id" } }, "422-value-invalid": { "value": { "errorCode": 9901, "errorMessage": "[0401-1102]: Unprocessable Entity. The property `value` is required", "statusCode": 422, "transactionId": "x-x-x-x-transactionId-mock-x-x-x" } }, "422-value-limit-exceeded": { "value": { "errorCode": 9908, "errorMessage": "[0401-9908]: You reached the maximum number of values for the attribute.", "statusCode": 422, "transactionId": "x-x-x-x-transactionId-mock-x-x-x" } }, "422-value-properties-required": { "value": { "errorCode": 9901, "errorMessage": "[0401-1102]: Unprocessable Entity. Array value found, but an object is required", "statusCode": 422, "transactionId": "x-x-x-x-transactionId-mock-x-x-x" } }, "Bundles_200-get-bundle": { "value": { "attributes": [], "bundle_type": "standard", "can_be_bought": true, "content": [ { "attributes": [], "description": "Big Rocket - short description.", "groups": [], "image_url": "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png", "is_free": false, "limits": { "per_user": { "available": 3, "limit_exceeded_visibility": "show", "recurrent_schedule": { "interval_type": "weekly", "reset_next_date": 1746057600 }, "total": 5 } }, "name": "Big Rocket", "price": { "amount": "10.99", "amount_without_discount": "10.99", "currency": "USD" }, "quantity": 100, "sku": "com.xsolla.big_rocket_1", "type": "virtual_currency", "virtual_prices": [] } ], "custom_attributes": { "attr": "value", "purchased": 0 }, "description": "pricePoint_44056_1.", "groups": [], "image_url": null, "is_free": false, "item_id": 610316, "limits": { "per_user": { "available": 3, "limit_exceeded_visibility": "show", "recurrent_schedule": { "interval_type": "weekly", "reset_next_date": 1746057600 }, "total": 5 } }, "long_description": null, "media_list": [], "name": "kg_10.00_bundle", "order": 999, "periods": [ { "date_from": "2020-08-11T10:00:00+03:00", "date_until": "2020-08-11T20:00:00+03:00" } ], "price": { "amount": "9.99", "amount_without_discount": "9.99", "currency": "USD" }, "promotions": [], "sku": "com.xsolla.kg_1", "total_content_price": { "amount": "10.99", "amount_without_discount": "10.99", "currency": "USD" }, "type": "bundle", "virtual_prices": [], "vp_rewards": [ { "amount": 130, "image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg", "item_id": 175232, "name": "Value point", "sku": "com.xsolla.value_point_1" }, { "amount": 50, "image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg", "is_clan": true, "item_id": 186321, "name": "Clan Reward VP 1", "sku": "com.xsolla.clan_value_point_1" } ] } }, "Bundles_200-get-bundle-list": { "value": { "has_more": true, "items": [ { "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" } ] } ], "bundle_type": "standard", "can_be_bought": true, "content": [ { "attributes": [ { "external_id": "size", "name": "Size", "values": [ { "external_id": "size_e3364991f92e751689a68b96598a5a5a84010b85", "value": "Large" } ] } ], "description": "Big Rocket - short description.", "groups": [], "image_url": "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png", "is_free": false, "limits": { "per_user": { "available": 3, "limit_exceeded_visibility": "show", "recurrent_schedule": { "interval_type": "weekly", "reset_next_date": 1746057600 }, "total": 5 } }, "name": "Big Rocket", "price": { "amount": "10.99", "amount_without_discount": "10.99", "currency": "USD" }, "quantity": 100, "sku": "com.xsolla.big_rocket_1", "type": "virtual_currency", "virtual_item_type": "non_consumable", "virtual_prices": [] } ], "custom_attributes": { "attr": "value", "purchased": 0 }, "description": "pricePoint_44056_1", "groups": [ { "external_id": "exclusive", "item_order_in_group": 1, "name": "Exclusive" } ], "image_url": null, "is_free": false, "item_id": 61031, "limits": { "per_user": { "available": 3, "limit_exceeded_visibility": "show", "recurrent_schedule": { "interval_type": "weekly", "reset_next_date": 1746057600 }, "total": 5 } }, "long_description": null, "media_list": [], "name": "kg_10.00_bundle", "order": 999, "periods": [ { "date_from": "2020-08-11T10:00:00+03:00", "date_until": "2020-08-11T20:00:00+03:00" } ], "price": { "amount": "9.99", "amount_without_discount": "9.99", "currency": "USD" }, "promotions": [], "sku": "com.xsolla.kg_1", "total_content_price": { "amount": "10.99", "amount_without_discount": "10.99", "currency": "USD" }, "type": "bundle", "virtual_prices": [], "vp_rewards": [ { "amount": 130, "image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg", "item_id": 175232, "name": "Value point", "sku": "com.xsolla.value_point_1" }, { "amount": 50, "image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg", "is_clan": true, "item_id": 186321, "name": "Clan Reward VP 1", "sku": "com.xsolla.clan_value_point_1" } ] } ] } } }, "parameters": { "additional_fields-entitlement-query-param": { "description": "추가 필드 목록입니다. 이러한 필드는 요청에서 보내는 경우 응답에 포함됩니다. 사용할 수 있는 필드는 `attributes`입니다.", "in": "query", "name": "additional_fields[]", "required": false, "schema": { "items": { "type": "string" }, "type": "array" } }, "additional_fields-query-param": { "description": "추가 필드의 목록입니다. 이러한 필드는 요청에서 보내는 경우 응답에 포함됩니다.", "in": "query", "name": "additional_fields[]", "required": false, "schema": { "items": { "enum": [ "media_list", "order", "long_description", "custom_attributes", "item_order_in_group" ], "type": "string" }, "type": "array" } }, "cart_id-path-param": { "description": "장바구니 ID입니다.", "in": "path", "name": "cart_id", "required": true, "schema": { "example": "custom_id", "type": "string" } }, "country-query-param": { "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)에 대한 자세한 정보는 설명서를 확인하십시오.", "in": "query", "name": "country", "required": false, "schema": { "example": "US", "type": "string" } }, "currency-query-param": { "description": "장바구니에 표시되는 아이템 가격 통화입니다. [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)에 따른 3자리 통화 코드입니다. [엑솔라에서 지원하는 통화](https://developers.xsolla.com/ko/doc/pay-station/references/supported-currencies/)에 대한 자세한 정보는 설명서를 확인하십시오.", "in": "query", "name": "currency", "required": false, "schema": { "default": "USD", "type": "string" } }, "external_id-attr-path-param": { "description": "특성 외부 ID입니다.", "in": "path", "name": "external_id", "required": true, "schema": { "example": "attribute_id", "type": "string" } }, "external_id-group-path-param": { "description": "External item group ID specified during creation.", "in": "path", "name": "external_id", "required": true, "schema": { "example": "weapons", "type": "string" } }, "external_id_59080-group-path-param": { "description": "그룹 외부 ID입니다.", "in": "path", "name": "external_id", "required": true, "schema": { "default": "armour", "type": "string" } }, "group_id-path-param": { "description": "그룹 ID입니다.", "in": "path", "name": "group_id", "required": true, "schema": { "example": 10, "type": "integer" } }, "id-group-path-param": { "description": "Item group ID assigned by Xsolla.", "in": "path", "name": "id", "required": true, "schema": { "example": 1, "type": "integer" } }, "item_id-path-param": { "description": "아이템 ID입니다.", "in": "path", "name": "item_id", "required": true, "schema": { "example": "656", "type": "string" } }, "item_id_59080-path-param": { "description": "아이템 ID입니다.", "in": "path", "name": "item_id", "required": true, "schema": { "example": "259774", "type": "string" } }, "item_sku-path-param": { "description": "아이템 SKU입니다.", "in": "path", "name": "item_sku", "required": true, "schema": { "example": "booster_mega_1", "type": "string" } }, "item_sku_59080-path-param": { "description": "아이템 SKU입니다.", "in": "path", "name": "sku", "required": true, "schema": { "example": "electric_shield", "type": "string" } }, "item_type-group-path-param": { "description": "Item type used to filter groups. Determines which items are included in `items_count`. Values containing `/` (for example, `virtual_currency/package` or `game/key`) must be URL-encoded (for example, `virtual_currency%2Fpackage`).", "in": "path", "name": "item_type", "required": true, "schema": { "enum": [ "virtual_items", "virtual_currency", "virtual_currency/package", "game/key", "bundle", "game", "value_points", "subscription_plans" ], "example": "virtual_items", "type": "string" } }, "limit-query-param": { "description": "페이지 요소 개수 제한입니다.", "example": 50, "in": "query", "name": "limit", "required": false, "schema": { "example": 50, "minimum": 1, "type": "integer" } }, "locale-query-param": { "description": "Response language. Two-letter lowercase language code per ISO 639-1 (for example, `en`). Five-character locale codes (for example, `en-US`) are supported in localization fields such as `name` and `description`, but are normalized to two-letter codes in responses. You can find the full list of supported languages in the [documentation](https://developers.xsolla.com/ko/doc/shop-builder/references/supported-languages/).", "in": "query", "name": "locale", "required": false, "schema": { "default": "en", "type": "string" } }, "merchant_id-path-param": { "description": "판매자 ID입니다.", "in": "path", "name": "merchant_id", "required": true, "schema": { "example": 121212, "type": "integer" } }, "offset-query-param": { "description": "목록이 생성된 요소의 개수입니다(개수는 0부터 시작함).", "example": 0, "in": "query", "name": "offset", "required": false, "schema": { "example": 0, "minimum": 0, "type": "integer" } }, "order_id-path-param": { "description": "주문 ID입니다.", "in": "path", "name": "order_id", "required": true, "schema": { "example": "656", "type": "string" } }, "platform-query-param": { "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` 등 사용자가 플레이하는 퍼블리싱 플랫폼입니다.", "in": "query", "name": "platform", "required": false, "schema": { "default": "xsolla", "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" ], "type": "string" } }, "project_id-path-param": { "description": "Project ID. You can find this parameter in your [Publisher Account](https://publisher.xsolla.com/0/projects/0/) next to the project name and in the browser address bar when working with a project. The URL has the following format: `https://publisher.xsolla.com//projects/`.", "in": "path", "name": "project_id", "required": true, "schema": { "example": 44056, "type": "integer" } }, "project_id_59080-path-param": { "description": "프로젝트 ID입니다. 이 매개 변수는 [관리자 페이지](https://publisher.xsolla.com/)의 프로젝트 이름 옆에서 확인할 수 있습니다.", "in": "path", "name": "project_id", "required": true, "schema": { "example": 59080, "type": "integer" } }, "promo_code-query-param": { "description": "고유한 대/소문자 구분 코드입니다. 문자와 숫자를 포함합니다.", "in": "query", "name": "promo_code", "required": false, "schema": { "example": "WINTER2021", "maxLength": 128, "minLength": 1, "type": "string" } }, "quantity-query-param": { "description": "코드 수량입니다.", "in": "query", "name": "quantity", "required": true, "schema": { "example": 100, "type": "integer" } }, "reason-query-param": { "description": "코드 수신 코드입니다.", "in": "query", "name": "reason", "required": true, "schema": { "example": "Very important", "type": "string" } }, "region_id-path-param": { "description": "지역 ID입니다. 프로젝트 내부의 고유 지역 식별자입니다.", "in": "path", "name": "region_id", "required": true, "schema": { "example": 42, "type": "integer" } }, "region_id-query-param": { "description": "지역 ID입니다.", "in": "query", "name": "region_id", "required": false, "schema": { "default": 1, "type": "integer" } }, "sandbox-query-param": { "description": "반환해야 하는 자격 유형입니다. 매개 변수를 1로 설정하면 사용자가 샌드박스 모드에서 받은 권한만 반환됩니다. 매개 변수가 전달되지 않거나 0으로 설정된 경우 사용자가 라이브 모드에서 받은 권한만 반환됩니다.", "in": "query", "name": "sandbox", "required": false, "schema": { "default": 0, "type": "integer" } }, "show_inactive_time_limited_items-query-param": { "description": "사용자가 사용할 수 없는 사용기간 제한 아이템을 표시합니다. 해당 아이템의 사용기간이 아직 시작되지 않았거나 이미 만료되었습니다.", "in": "query", "name": "show_inactive_time_limited_items", "required": false, "schema": { "default": 0, "example": 1, "type": "integer" } }, "sku-path-param": { "description": "번들 SKU입니다.", "in": "path", "name": "sku", "required": true, "schema": { "example": "kg_1", "type": "string" } }, "user_email-query-param": { "description": "사용자 이메일입니다.", "in": "query", "name": "user_email", "required": true, "schema": { "example": "email@email.com", "type": "string" } }, "user_external_id-query-param": { "description": "사용자 외부 ID", "in": "query", "name": "user_external_id", "required": true, "schema": { "example": "d342dad2-9d59-11e9-a384-42010aa8003f", "type": "string" } }, "value_external_id-path-param": { "description": "특성 값 외부 ID입니다.", "in": "path", "name": "value_external_id", "required": true, "schema": { "example": "value_id", "pattern": "^[-_\\.\\d\\w]+$", "type": "string" } }, "virtual_currency_package_sku-path-param": { "description": "인게임 재화 패키지 SKU입니다.", "in": "path", "name": "virtual_currency_package_sku", "required": true, "schema": { "example": "crystal-pack", "type": "string" } }, "virtual_currency_sku-path-param": { "description": "인게임 재화 SKU입니다.", "in": "path", "name": "virtual_currency_sku", "required": true, "schema": { "example": "crystal", "type": "string" } }, "with_geo-query-param": { "description": "Whether to return the user's locale and country information in the response headers. If set to `true`, the response includes `X-User-Locale-Code` and `X-User-Country-Code` headers.", "in": "query", "name": "with_geo", "required": false, "schema": { "default": false, "type": "boolean" } }, "x-user-for-header": { "description": "사용자 식별자는 엑솔라 로그인 사용자 JWT 또는 [페이 스테이션 액세스 토큰](https://developers.xsolla.com/ko/pay-station-api/current/token/create-token)을 사용하여 전송할 수 있습니다.", "example": "ACCESS_TOKEN/LOGIN_JWT", "in": "header", "name": "x-user-for", "required": false, "schema": { "type": "string" } }, "x-user-id-header": { "description": "게임이 포함된 장바구니를 판매할 때 자신의 사용자 ID를 사용할 수 있습니다.", "example": "UNIQUE_ID", "in": "header", "name": "x-user-id", "required": false, "schema": { "maxLength": 32, "type": "string" } } }, "requestBodies": { "Bundles_bundle": { "content": { "application/json": { "example": { "attributes": [ { "external_id": "class", "name": { "en": "Class" }, "values": [ { "external_id": "soldier", "value": { "en": "Soldier" } }, { "external_id": "officer", "value": { "en": "Officer" } } ] } ], "content": [ { "quantity": 1, "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" } ], "custom_attributes": { "purchased": 0, "type": "lootbox" }, "description": { "de": "Brustpanzer für Soldaten", "en": "Chest of armour for soldiers" }, "groups": [ "chests" ], "image_url": "https://picture.bundle-with-many-stuff.png", "is_enabled": true, "is_free": true, "is_paid_randomized_reward": true, "limits": { "per_item": null, "per_user": null }, "long_description": { "de": "Brustpanzer für Soldaten", "en": "Chest of armour for soldiers" }, "media_list": [ { "type": "image", "url": "https://test.com/image0" }, { "type": "image", "url": "https://test.com/image1" } ], "name": { "de": "Brustpanzer", "en": "Chest of armour" }, "order": 1, "periods": [ { "date_from": "2020-08-11T10:00:00+03:00", "date_until": "2020-08-11T20:00:00+03:00" } ], "prices": [ { "amount": "9.99", "currency": "USD", "is_default": true, "is_enabled": true }, { "amount": "9.99", "currency": "EUR", "is_default": false, "is_enabled": true } ], "sku": "com.xsolla.armour_chest_1", "vc_prices": [] }, "schema": { "$ref": "#/components/schemas/Bundles_admin_bundle_request" } } }, "description": "번들 데이터가 있는 개체입니다.", "required": true }, "Cart-Payment_admin-create-payment-token": { "content": { "application/json": { "examples": { "common": { "value": { "purchase": { "items": [ { "quantity": 2, "sku": "com.xsolla.cup01" }, { "quantity": 1, "sku": "com.xsolla.t-shirt01" }, { "quantity": 1, "sku": "com.xsolla.cup02" }, { "quantity": 1, "sku": "com.xsolla.hat01" } ] }, "settings": { "currency": "USD", "external_id": "AABBCCDD01", "language": "de", "payment_method": 1380, "return_url": "https://developers.xsolla.com/ko/", "ui": { "theme": "63295aab2e47fab76f7708e3" } }, "user": { "country": { "allow_modify": false, "value": "US" }, "email": { "value": "user@xsolla.com" }, "id": { "value": "user-id" }, "name": { "value": "user-name" } } } }, "in-sandbox": { "value": { "purchase": { "items": [ { "quantity": 2, "sku": "com.xsolla.cup01" }, { "quantity": 1, "sku": "com.xsolla.t-shirt01" }, { "quantity": 1, "sku": "com.xsolla.cup02" }, { "quantity": 1, "sku": "com.xsolla.hat01" } ] }, "sandbox": true, "settings": { "currency": "USD" }, "user": { "id": { "value": "user-id" } } } }, "with-custom-parameters": { "value": { "custom_parameters": { "user_os": "windows10", "user_public_id": "player1" }, "purchase": { "items": [ { "quantity": 2, "sku": "com.xsolla.cup01" }, { "quantity": 1, "sku": "com.xsolla.t-shirt01" }, { "quantity": 1, "sku": "com.xsolla.cup02" }, { "quantity": 1, "sku": "com.xsolla.hat01" } ] }, "settings": { "currency": "USD", "external_id": "AABBCCDD01", "language": "de", "payment_method": 1380, "return_url": "https://developers.xsolla.com/ko/", "ui": { "theme": "63295aab2e47fab76f7708e3" } }, "user": { "country": { "allow_modify": false, "value": "US" }, "email": { "value": "user@xsolla.com" }, "id": { "value": "user-id" }, "name": { "value": "user-name" } } } } }, "schema": { "additionalProperties": false, "properties": { "custom_parameters": { "$ref": "#/components/schemas/Cart-Payment_custom_parameters_token" }, "promo_code": { "$ref": "#/components/schemas/Promotions_coupon_code" }, "purchase": { "$ref": "#/components/schemas/Cart_admin_payment" }, "sandbox": { "$ref": "#/components/schemas/Cart-Payment_settings_sandbox" }, "settings": { "additionalProperties": false, "description": "사용자의 결제 프로세스와 결제 UI를 구성하는 설정입니다.", "properties": { "currency": { "$ref": "#/components/schemas/Cart-Payment_settings_currency" }, "external_id": { "$ref": "#/components/schemas/Cart-Payment_settings_external_id" }, "language": { "$ref": "#/components/schemas/Cart-Payment_settings_locale" }, "payment_method": { "$ref": "#/components/schemas/Cart-Payment_settings_payment_method" }, "redirect_policy": { "$ref": "#/components/schemas/Cart-Payment_redirect_policy" }, "return_url": { "$ref": "#/components/schemas/Cart-Payment_settings_return_url" }, "ui": { "$ref": "#/components/schemas/Cart-Payment_settings_ui" } }, "type": "object" }, "user": { "$ref": "#/components/schemas/Cart-Payment_admin-user-request-body" } }, "required": [ "user", "purchase" ], "type": "object" } } } }, "Cart-Payment_admin-fill-cart-json-model": { "content": { "application/json": { "examples": { "basic": { "value": { "currency": "USD", "items": [ { "quantity": 2, "sku": "com.xsolla.cup01" }, { "quantity": 1, "sku": "com.xsolla.t-shirt01" }, { "quantity": 1, "sku": "com.xsolla.cup02" }, { "quantity": 1, "sku": "com.xsolla.hat01" } ] } } }, "schema": { "$ref": "#/components/schemas/Cart" } } } }, "Cart-Payment_create-order-by-cart-idJsonModel": { "content": { "application/json": { "example": { "custom_parameters": { "character_id": "ingameUsername" }, "sandbox": true, "settings": { "ui": { "desktop": { "header": { "close_button": false, "is_visible": true, "type": "normal", "visible_logo": true, "visible_name": true, "visible_purchase": true } }, "theme": "63295a9a2e47fab76f7708e1" } } }, "schema": { "properties": { "currency": { "description": "주문 가격 통화입니다. [ ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)에 따른 3글자 통화 코드입니다. [엑솔라에서 지원하는 통화](https://developers.xsolla.com/ko/doc/pay-station/references/supported-currencies/)에 대한 자세한 정보는 설명서를 확인하십시오.", "type": "string" }, "custom_parameters": { "description": "프로젝트별 매개 변수입니다.", "maxProperties": 200, "minProperties": 1, "type": "object" }, "locale": { "description": "응답 언어입니다.", "type": "string" }, "sandbox": { "default": false, "description": "샌드박스 모드로 주문을 생성합니다. 이 옵션은 회사 사용자 목록에서 지정한 사용자에게 사용할 수 있습니다.", "type": "boolean" }, "settings": { "additionalProperties": false, "description": "사용자의 결제 프로세스와 결제 UI를 구성하는 설정입니다.", "properties": { "payment_method": { "$ref": "#/components/schemas/Cart-Payment_settings_payment_method" }, "redirect_policy": { "$ref": "#/components/schemas/Cart-Payment_redirect_policy" }, "return_url": { "$ref": "#/components/schemas/Cart-Payment_settings_return_url" }, "ui": { "$ref": "#/components/schemas/Cart-Payment_settings_ui" } }, "type": "object" } }, "type": "object" } } } }, "Cart-Payment_create-order-with-specified-item-idJsonModel": { "content": { "application/json": { "example": { "custom_parameters": { "character_id": "ingameUsername" }, "promo_code": "discount_code", "quantity": 5, "sandbox": true, "settings": { "ui": { "desktop": { "header": { "close_button": false, "is_visible": true, "type": "normal", "visible_logo": true, "visible_name": true, "visible_purchase": true } }, "theme": "63295a9a2e47fab76f7708e1" } } }, "schema": { "properties": { "currency": { "description": "주문 가격 통화입니다. [ ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)에 따른 3글자 통화 코드입니다. [엑솔라에서 지원하는 통화](https://developers.xsolla.com/ko/doc/pay-station/references/supported-currencies/)에 대한 자세한 정보는 설명서를 확인하십시오.", "type": "string" }, "custom_parameters": { "description": "프로젝트별 매개 변수입니다.", "maxProperties": 200, "minProperties": 1, "type": "object" }, "locale": { "description": "응답 언어입니다.", "type": "string" }, "promo_code": { "description": "결제 시 프로모션 코드 프로모션용 코드를 사용합니다.", "type": "string" }, "quantity": { "default": 1, "description": "아이템 수량입니다.", "minimum": 1, "type": "integer" }, "sandbox": { "default": false, "description": "샌드박스 모드로 주문을 생성합니다. 이 옵션은 회사 사용자 목록에서 지정한 사용자에게 사용할 수 있습니다.", "type": "boolean" }, "settings": { "additionalProperties": false, "description": "사용자의 결제 프로세스와 결제 UI를 구성하는 설정입니다.", "properties": { "payment_method": { "$ref": "#/components/schemas/Cart-Payment_settings_payment_method" }, "redirect_policy": { "$ref": "#/components/schemas/Cart-Payment_redirect_policy" }, "return_url": { "$ref": "#/components/schemas/Cart-Payment_settings_return_url" }, "ui": { "$ref": "#/components/schemas/Cart-Payment_settings_ui" } }, "type": "object" } }, "type": "object" } } } }, "Cart-Payment_fill-cart-json-model": { "content": { "application/json": { "schema": { "example": { "items": [ { "quantity": 123, "sku": "com.xsolla.booster_mega_1" } ] }, "properties": { "items": { "description": "아이템 목록입니다.", "items": { "minItems": 1, "properties": { "quantity": { "default": 123, "type": "number" }, "sku": { "default": "booster_mega_1", "type": "string" } }, "required": [ "sku", "quantity" ], "type": "object" }, "type": "array" } }, "required": [ "items" ], "type": "object" } } } }, "Cart-Payment_put-item-by-cart-idJsonModel": { "content": { "application/json": { "schema": { "properties": { "quantity": { "default": 123, "description": "아이템 수량입니다.", "type": "number" } }, "type": "object" } } } }, "Game-Keys_create-update-game-model": { "content": { "application/json": { "schema": { "example": { "description": { "en-US": "Game description", "ru-RU": "Краткое описание игры" }, "groups": [ "new_games" ], "image_url": "http://image.png", "is_enabled": true, "is_show_in_store": true, "long_description": { "en-US": "Game long description", "ru-RU": "Полное описание игры" }, "media_list": [ { "type": "image", "url": "http://image.png" }, { "type": "video", "url": "http://video.png" } ], "name": { "en-US": "Game name", "ru-RU": "Название игры" }, "sku": "com.xsolla.game_1", "unit_items": [ { "drm_sku": "steam_key_1", "is_enabled": true, "is_free": false, "is_show_in_store": true, "limits": { "per_item": { "available": 5000, "reserved": 500, "sold": 4500, "total": 10000 }, "per_user": { "total": 5 } }, "name": { "en-US": "Game key name", "ru-RU": "Название игрового ключа" }, "periods": [ { "date_from": "2020-08-11T10:00:00+03:00", "date_until": "2020-08-11T20:00:00+03:00" } ], "pre_order": { "description": "Some description", "is_enabled": true, "release_date": "2020-08-11T10:00:00+03:00" }, "prices": [ { "amount": 35.5, "currency": "USD", "is_default": true, "is_enabled": true } ], "regions": [ { "id": 12 }, { "id": 64 } ], "sku": "com.xsolla.game_key_1", "vc_prices": [ { "amount": 35.5, "is_default": true, "is_enabled": true, "sku": "com.xsolla.gold_1" } ] } ] }, "properties": { "attributes": { "$ref": "#/components/schemas/Game-Keys_admin-post-put-attributes" }, "description": { "$ref": "#/components/schemas/description-localization-object" }, "groups": { "description": "아이템이 속한 그룹입니다.", "items": { "properties": { "external_id": { "example": "horror", "type": "string" } }, "required": [ "external_id" ], "type": "object" }, "type": "array" }, "image_url": { "description": "이미지 URL입니다.", "example": "https://image.example.com", "type": "string" }, "is_enabled": { "description": "비활성화된 경우 인벤토리를 통해 아이템을 구매하고 액세스할 수 없습니다.", "type": "boolean" }, "is_show_in_store": { "description": "아이템을 구매할 수 있는 상태입니다.", "type": "boolean" }, "long_description": { "$ref": "#/components/schemas/long-description-localization-object" }, "media_list": { "description": "스크린샷, 게임 플레이 동영상 등과 같은 게임 추가 자산입니다.", "example": [ { "type": "image", "url": "https://cdn3.xsolla.com/img/misc/images/71ab1e12126f2103e1868076f0acb21a.jpg" } ], "items": { "properties": { "type": { "description": "미디어 유형: `image`/`video`.", "enum": [ "image", "video" ], "example": "image", "type": "string" }, "url": { "description": "리소스 파일입니다.", "example": "https://cdn3.xsolla.com/img/misc/images/71ab1e12126f2103e1868076f0acb21a.jpg", "type": "string" } }, "type": "object" }, "type": "array" }, "name": { "$ref": "#/components/schemas/name-localization-object" }, "order": { "description": "목록에서 게임의 주문 우선 순위입니다.", "example": 1, "type": "integer" }, "sku": { "description": "고유한 아이템 ID입니다. SKU는 소문자 및 대문자 라틴 영숫자, 마침표, 대시 및 밑줄만 포함할 수 있습니다.", "example": "game_1", "maxLength": 255, "minLength": 1, "pattern": "^[a-zA-Z0-9_\\-–.]*$", "type": "string" }, "unit_items": { "description": "다른 DRM용 게임 키입니다.", "items": { "description": "게임 키 아이템입니다. 특정 플랫폼(steam, gog 등)의 게임을 나타냅니다.", "properties": { "attributes": { "$ref": "#/components/schemas/Game-Keys_admin-attributes" }, "drm_sku": { "description": "DRM 고유 ID입니다.", "example": "steam", "type": "string" }, "groups": { "description": "아이템이 속한 그룹입니다.", "items": { "properties": { "external_id": { "example": "horror", "type": "string" } }, "required": [ "external_id" ], "type": "object" }, "type": "array" }, "is_enabled": { "description": "비활성화된 경우 인벤토리를 통해 아이템을 구매하고 액세스할 수 없습니다.", "type": "boolean" }, "is_free": { "$ref": "#/components/schemas/value-is_free" }, "is_show_in_store": { "description": "아이템을 구매할 수 있는 상태입니다.", "type": "boolean" }, "limits": { "$ref": "#/components/schemas/Game-key-item-limit" }, "name": { "$ref": "#/components/schemas/name-localization-object" }, "order": { "description": "목록에서 게임의 주문 우선 순위입니다.", "example": 1, "type": "integer" }, "periods": { "$ref": "#/components/schemas/item-periods" }, "pre_order": { "description": "사전 판매 설정입니다.", "properties": { "description": { "description": "사전 판매에 대한 추가 정보는 이메일로 전송됩니다.", "type": "string" }, "is_enabled": { "description": "비활성화된 경우 해당 아이템은 사전 판매 대상이 아닙니다.", "type": "boolean" }, "release_date": { "description": "ISO 8601 형식으로 된 게임 키 출시 날짜입니다.", "type": "string" } }, "required": [ "release_date", "is_enabled" ], "type": "object" }, "prices": { "description": "실제 통화 가격입니다.", "items": { "properties": { "amount": { "example": 1299.99, "type": "number" }, "currency": { "description": "아이템 가격 통화입니다. [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)에 따른 3자리 코드입니다. [엑솔라에서 지원하는 통화](https://developers.xsolla.com/ko/doc/pay-station/references/supported-currencies/)에 대한 자세한 정보는 설명서를 확인하십시오.", "example": "RUB", "type": "string" }, "is_default": { "description": "기본 가격은 사용자 통화로 가격을 지정하지 않은 경우 카탈로그를 작성하는 데 사용됩니다.", "type": "boolean" }, "is_enabled": { "type": "boolean" } }, "required": [ "amount", "currency", "is_default", "is_enabled" ], "type": "object" }, "type": "array" }, "regions": { "$ref": "#/components/schemas/Game-Keys_regions" }, "sku": { "description": "고유한 아이템 ID입니다. SKU는 소문자 및 대문자 라틴 영숫자, 마침표, 대시 및 밑줄만 포함할 수 있습니다.", "example": "game_1", "maxLength": 255, "minLength": 1, "type": "string" }, "vc_prices": { "items": { "properties": { "amount": { "type": "number" }, "is_default": { "type": "boolean" }, "is_enabled": { "type": "boolean" }, "sku": { "description": "고유한 아이템 ID입니다. SKU는 소문자 및 대문자 라틴 영숫자, 마침표, 대시 및 밑줄만 포함할 수 있습니다.", "example": "gold", "type": "string" } }, "required": [ "amount", "currency", "is_default", "is_enabled" ], "type": "object" }, "type": "array" } }, "required": [ "sku", "drm_sku", "prices" ], "type": "object" }, "type": "array" } }, "required": [ "sku", "name", "unit_items" ], "type": "object" } } }, "description": "게임 데이터가 있는 개체입니다.", "required": true }, "ItemGroup_create": { "content": { "application/json": { "example": { "description": { "de": "Spielerwaffen", "en": "Player weapons" }, "external_id": "weapons", "iconUrl": "https://example.com/weapons.png", "isEnabled": true, "name": { "de": "Waffen", "en": "Weapons" }, "order": 1 }, "schema": { "$ref": "#/components/schemas/admin-group-create-request" } } }, "description": "Object with item group data.", "required": true }, "ItemGroup_item_order": { "content": { "application/json": { "example": [ { "item_id": 101, "order": 1 }, { "item_id": 102, "order": 2 }, { "item_id": 103, "order": 3 } ], "schema": { "items": { "$ref": "#/components/schemas/item-in-group-order-request-item" }, "type": "array", "uniqueItems": true } } }, "description": "Array of items with new order values in the group.", "required": true }, "ItemGroup_order": { "content": { "application/json": { "examples": { "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 } ] }, "by_id": { "summary": "Identify groups by ID", "value": [ { "id": 1, "order": 1 }, { "id": 2, "order": 2 }, { "id": 3, "order": 3 } ] } }, "schema": { "oneOf": [ { "items": { "additionalProperties": false, "properties": { "id": { "description": "Item group ID assigned by Xsolla.", "example": 1, "minimum": 0, "type": "integer" }, "order": { "description": "New display order value.", "example": 1, "minimum": 0, "type": "integer" } }, "required": [ "id", "order" ], "type": "object" }, "title": "Identify by ID", "type": "array", "uniqueItems": true }, { "items": { "additionalProperties": false, "properties": { "external_id": { "description": "External item group ID specified during creation.", "example": "weapons", "minLength": 1, "type": "string" }, "order": { "description": "New display order value.", "example": 1, "minimum": 0, "type": "integer" } }, "required": [ "external_id", "order" ], "type": "object" }, "title": "Identify by external_id", "type": "array", "uniqueItems": true } ] } } }, "description": "Array of groups with new order values. All items must use the same identification method (either all by `id` or all by `external_id`).", "required": true }, "ItemGroup_update": { "content": { "application/json": { "example": { "description": { "de": "Aktualisierte Spielerwaffen", "en": "Updated player weapons" }, "external_id": "weapons", "iconUrl": "https://example.com/weapons-new.png", "isEnabled": true, "name": { "de": "Waffen Aktualisiert", "en": "Weapons Updated" }, "order": 2 }, "schema": { "$ref": "#/components/schemas/admin-group-update-request" } } }, "description": "Object with item group data to update.", "required": true }, "Virtual-Items-Currency_admin-create-virtual-currency": { "content": { "application/json": { "example": { "attributes": [ { "external_id": "material", "name": { "en-US": "Material" }, "values": [ { "external_id": "gold", "value": { "en-US": "Gold" } } ] } ], "custom_attributes": { "attr": "value", "purchased": 0 }, "description": { "de-DE": "Die Hauptwährung deines Königreichs", "en-US": "The main currency of your kingdom" }, "groups": [ "gold" ], "is_enabled": true, "is_free": false, "is_paid_randomized_reward": false, "limits": { "per_item": 10000, "per_user": 5 }, "name": { "de-DE": "Goldmünze", "en-US": "Gold coin" }, "order": 1, "periods": [ { "date_from": "2020-08-11T10:00:00+03:00", "date_until": "2020-08-11T20:00:00+03:00" } ], "prices": [ { "amount": 100, "currency": "USD", "is_default": true, "is_enabled": true } ], "sku": "com.xsolla.coin_1" }, "schema": { "$ref": "#/components/schemas/Virtual-Items-Currency_admin-create-virtual-currency" } } } }, "Virtual-Items-Currency_admin-create-virtual-currency-package": { "content": { "application/json": { "example": { "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" } } ] } ], "content": [ { "quantity": 500, "sku": "com.xsolla.novigrad_crown" } ], "custom_attributes": { "attr": "value", "purchased": 0 }, "description": { "en-US": "The Crown (also known as the Novigradian crown) is a monetary unit which is used in some Northern Kingdoms", "ru-RU": "Крона (Также известна как Новиградская крона) - платежная единица, используемая в северных королевствах" }, "groups": [ "witcher" ], "image_url": "https://vignette.wikia.nocookie.net/witcher/images/7/7c/Items_Orens.png/revision/latest?cb=20081113120917", "is_enabled": true, "is_free": false, "is_paid_randomized_reward": true, "limits": { "per_item": null, "per_user": null }, "long_description": { "en-US": "Long Test new", "ru-RU": "Длинное описание" }, "media_list": [ { "type": "image", "url": "https://test.com/image0" }, { "type": "image", "url": "https://test.com/image1" } ], "name": { "en-US": "500x Novigradian crown", "ru-RU": "500x Новиградских крон" }, "order": 1, "periods": [ { "date_from": "2020-08-11T10:00:00+03:00", "date_until": "2020-08-11T20:00:00+03:00" } ], "prices": [ { "amount": 99.99, "currency": "USD", "is_default": true }, { "amount": 80.03, "currency": "EUR", "is_enabled": false } ], "sku": "com.xsolla.novigrad_crown_500", "vc_prices": null }, "schema": { "$ref": "#/components/schemas/Virtual-Items-Currency_admin-create-virtual-currency-package" } } } }, "Virtual-Items-Currency_admin-create-virtual-item": { "content": { "application/json": { "example": { "attributes": [ { "external_id": "craft-materials", "name": { "en": "Craft materials" }, "values": [ { "external_id": "steel", "value": { "en-US": "5" } }, { "external_id": "leather", "value": { "en-US": "1" } } ] } ], "custom_attributes": { "attr": "value", "purchased": 0 }, "description": { "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.", "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." }, "groups": [ "weapons" ], "is_enabled": true, "is_free": false, "is_paid_randomized_reward": true, "is_show_in_store": true, "limits": { "per_item": 100, "per_user": 5 }, "name": { "de": "Schwert", "en": "Sword" }, "order": 1, "periods": [ { "date_from": "2020-08-11T10:00:00+03:00", "date_until": "2020-08-11T20:00:00+03:00" } ], "prices": [ { "amount": 100, "currency": "USD", "is_default": true, "is_enabled": true }, { "amount": 200, "country_iso": "CZ", "currency": "CZK", "is_default": true, "is_enabled": false } ], "sku": "com.xsolla.sword_1", "vc_prices": [] }, "schema": { "$ref": "#/components/schemas/Virtual-Items-Currency_admin-create-virtual-item" } } } }, "admin-order-search": { "content": { "application/json": { "example": { "created_date_from": "2018-01-07T00:00:00+03:00", "created_date_until": "2018-01-09T16:00:00+03:00", "limit": 5, "offset": 0 }, "schema": { "properties": { "created_date_from": { "description": "[ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)에 따른 주문 생성 기간의 시작 날짜 또는 날짜-시간입니다.", "example": "2020-04-15T18:16:00+05:00", "format": "date-time", "nullable": false, "type": "string" }, "created_date_until": { "description": "[ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)에 따른 주문 생성 기간의 종료 날짜 또는 날짜-시간입니다.", "example": "2020-04-16T18:16:00+05:00", "format": "date-time", "nullable": false, "type": "string" }, "limit": { "default": 10, "description": "응답에 포함되는 주문 수에 대한 제한입니다.", "maximum": 10, "minimum": 1, "nullable": false, "type": "integer" }, "offset": { "default": 0, "description": "목록이 생성되는 주문 수입니다(개수는 0부터 시작).", "minimum": 0, "nullable": false, "type": "integer" } }, "type": "object" } } }, "description": "주문 검색 매개 변수" }, "connector-import-items-body": { "content": { "application/json": { "schema": { "properties": { "connector_external_id": { "description": "아이템을 가져오기 위한 작업 유형을 지정하는 고정 값입니다.", "enum": [ "import_items" ], "type": "string" }, "file_url": { "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", "type": "string" }, "mode": { "default": "create_and_update", "description": "Import actions:\n\nPossible values:\n- `create` — Add new items.\n- `create_and_update` — Add new items and update existing ones.\n- `sync` — Add new, update existing, and disable missing items.", "enum": [ "create", "create_and_update", "sync" ], "type": "string" } }, "required": [ "connector_external_id", "file_url" ], "type": "object" } } } }, "create-update-attribute": { "content": { "application/json": { "example": { "external_id": "genre", "name": { "de": "Genre", "en": "Genre" } }, "schema": { "properties": { "external_id": { "$ref": "#/components/schemas/admin-attribute-external_id" }, "name": { "$ref": "#/components/schemas/admin-attribute-name" } }, "required": [ "external_id", "name" ], "type": "object" } } } }, "create-update-attribute-value": { "content": { "application/json": { "example": { "external_id": "weapon_class_sword_value", "value": { "de": "Schwert", "en": "Sword" } }, "schema": { "$ref": "#/components/schemas/request-attribute-value" } } } }, "create-update-region": { "content": { "application/json": { "schema": { "example": { "countries": [ "JP", "CN", "VN" ], "name": { "de-DE": "Asien", "en-US": "Asia" } }, "properties": { "countries": { "$ref": "#/components/schemas/Regions_countries" }, "name": { "$ref": "#/components/schemas/Regions_name" } }, "required": [ "countries", "name" ], "type": "object" } } } }, "reset-user-limits": { "content": { "application/json": { "example": { "user": { "user_external_id": "d342dad2-9d59-11e9-a384-42010aa8003f" } }, "schema": { "properties": { "user": { "$ref": "#/components/schemas/User-limit_user" } }, "required": [ "user" ], "type": "object" } } } }, "reset-user-limits-flexible": { "content": { "application/json": { "example": { "user": { "user_external_id": "d342dad2-9d59-11e9-a384-42010aa8003f" } }, "schema": { "properties": { "user": { "$ref": "#/components/schemas/User-limit_user_flexible" } }, "required": [ "user" ], "type": "object" } } } }, "update-user-limits-flexible": { "content": { "application/json": { "example": { "available": 0, "user": { "user_external_id": "d342dad2-9d59-11e9-a384-42010aa8003f" } }, "schema": { "properties": { "available": { "$ref": "#/components/schemas/User-limit_available_flexible" }, "user": { "$ref": "#/components/schemas/User-limit_user" } }, "required": [ "user", "available" ], "type": "object" } } } }, "update-user-limits-strict": { "content": { "application/json": { "example": { "available": 1, "user": { "user_external_id": "d342dad2-9d59-11e9-a384-42010aa8003f" } }, "schema": { "properties": { "available": { "$ref": "#/components/schemas/User-limit_available" }, "user": { "$ref": "#/components/schemas/User-limit_user" } }, "required": [ "user", "available" ], "type": "object" } } } } }, "responses": { "200-admin-get-attribute": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/admin_attribute_response" } } }, "description": "지정한 특성을 성공적으로 수신했습니다." }, "200-admin-get-attribute-list-response": { "content": { "application/json": { "examples": { "response": { "value": { "attributes": [ { "external_id": "size", "name": { "de": "Größe", "en": "Size" } }, { "external_id": "genre", "name": { "de": "Genre", "en": "Genre" } } ], "total_count": 2 } } }, "schema": { "description": "아이템이 있는 개체입니다.", "properties": { "attributes": { "items": { "$ref": "#/components/schemas/admin_attribute_response" }, "type": "array" }, "total_count": { "type": "integer" } }, "type": "object" } } }, "description": "특성 목록을 성공적으로 수신했습니다." }, "200-admin-get-region": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Regions_200-region-model" } } }, "description": "지정된 지역을 성공적으로 수신했습니다." }, "200-admin-get-regions-list": { "content": { "application/json": { "examples": { "response": { "value": { "regions": [ { "id": 44, "name": { "de-DE": "Asien", "en-US": "Asia" } }, { "id": 45, "name": { "de-DE": "GUS", "en-US": "CIS" } } ] } } }, "schema": { "description": "아이템이 있는 개체입니다.", "properties": { "regions": { "items": { "$ref": "#/components/schemas/Regions_200-region-short-model" }, "type": "array" } }, "type": "object" } } }, "description": "지역 목록을 성공적으로 수신했습니다." }, "200-admin-get-user-item-limits": { "content": { "application/json": { "examples": { "response": { "value": { "per_user": { "available": 9, "total": 10 } } } }, "schema": { "$ref": "#/components/schemas/User-limit-item" } } }, "description": "사용자 한 명에 대한 구매 제한 설정을 성공적으로 수신했습니다." }, "200-admin-order-search": { "content": { "application/json": { "examples": { "response": { "value": { "has_more": true, "orders": [ { "date_created": "2018-01-08T15:32:06+03:00", "is_free": true, "items": [ { "description": { "description": "yes", "image_url": "http://example.com/image.jpg", "name": "bla" }, "is_bonus": false, "is_free": true, "item_id": 1005111, "order_item_id": 29, "quantity": 1, "region_id": 1, "sku": "com.xsolla.1005111", "tax_category": "DG00001", "type": "virtual_good" }, { "description": null, "is_bonus": true, "is_free": true, "item_id": 1005112, "order_item_id": 30, "quantity": 3, "region_id": 1, "sku": "com.xsolla.1005112", "tax_category": "DG00001", "type": "value_point" } ], "mode": "default", "order_id": 100511, "project_id": 101, "status": "done", "user": { "country": "US", "email": "user@xsolla.com", "id": "07e653a2b15011e6818f005056a54369", "region_id": 1 } }, { "coupons": [ { "code": "OPQRSTUVWX", "coupon_id": 100510, "sku": "com.xsolla.100510", "type": "promocode" } ], "date_created": "2018-01-07T15:32:06+03:00", "invoice_id": "100510", "is_free": false, "items": [ { "description": null, "is_bonus": false, "is_free": false, "item_id": 1005101, "order_item_id": 27, "price": { "amount": "67.3400", "amount_without_discount": "67.3400", "currency": "USD", "is_virtual_currency": false }, "quantity": 1, "region_id": null, "sku": "com.xsolla.1005101", "tax_category": "DG00001", "type": "game_key" }, { "description": null, "is_bonus": true, "is_free": true, "item_id": 1005102, "order_item_id": 28, "quantity": 2, "region_id": null, "sku": "com.xsolla.1005102", "tax_category": "DG00001", "type": "value_point" } ], "mode": "default", "order_id": 100510, "price": { "amount": "67.3400", "amount_without_discount": "72.3400", "currency": "USD", "is_virtual_currency": false }, "project_id": 101, "promotions": [ { "promotion_id": 1005101 } ], "status": "paid", "user": { "country": "US", "email": "user@xsolla.com", "id": "07e653a2b15011e6818f005056a54369", "region_id": null } }, { "date_created": "2018-01-02T15:32:06+03:00", "is_free": false, "items": [ { "description": null, "is_bonus": true, "is_free": true, "item_id": 1005051, "order_item_id": 17, "quantity": 1, "region_id": null, "sku": "com.xsolla.1005051", "tax_category": "DG00001", "type": "virtual_good" }, { "description": null, "is_bonus": true, "is_free": true, "item_id": 1005052, "order_item_id": 18, "quantity": 3, "region_id": null, "sku": "com.xsolla.1005052", "tax_category": "DG00001", "type": "value_point" } ], "mode": "default", "order_id": 100505, "price": { "amount": "78.2300", "amount_without_discount": "78.2300", "currency": "popugi", "is_virtual_currency": true }, "project_id": 101, "status": "paid", "user": { "country": "US", "email": "user@xsolla.com", "id": "07e653a2b15011e6818f005056a54369", "region_id": null } } ], "total_items_count": 11 } } }, "schema": { "properties": { "has_more": { "description": "추가 페이지가 있는지 여부입니다.", "example": true, "type": "boolean" }, "orders": { "description": "주문 목록입니다.", "items": { "properties": { "coupons": { "description": "주문에 적용된 쿠폰 목록입니다.", "items": { "properties": { "code": { "description": "사용된 쿠폰 코드입니다. 대소문자를 구분하는 고유한 코드입니다. 문자와 숫자를 포함합니다.", "type": "string" }, "coupon_id": { "description": "쿠폰으로 프로모션을 생성할 때 엑솔라가 생성한 쿠폰 ID입니다.", "type": "integer" }, "sku": { "description": "쿠폰으로 프로모션을 생성할 때 엑솔라가 생성하는 쿠폰 SKU입니다.", "type": "string" }, "type": { "description": "쿠폰의 종류입니다.", "enum": [ "unique_catalog_offer", "coupon", "promocode" ], "type": "string" } }, "type": "object" }, "type": [ "array", "null" ] }, "date_created": { "description": "[ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)에 따른 주문 생성 날짜 또는 날짜-시간 코드입니다.", "example": "2020-08-11T10:00:00+03:00", "format": "date-time", "type": "string" }, "invoice_id": { "description": "인보이스 ID입니다.", "type": "string" }, "is_free": { "description": "주문이 무료인지 여부입니다.", "example": false, "type": "boolean" }, "items": { "description": "아이템 목록입니다.", "items": { "properties": { "description": { "description": "아이템에 대한 정보가 있는 개체입니다.", "properties": { "description": { "description": "아이템 설명입니다.", "type": "string" }, "image_url": { "description": "아이템 이미지 URL입니다.", "format": "uri", "type": "string" }, "name": { "description": "아이템 이름입니다.", "type": "string" } }, "type": [ "object", "null" ] }, "is_bonus": { "description": "아이템이 보너스인지 여부입니다.", "example": false, "type": "boolean" }, "is_free": { "default": false, "description": "아이템이 무료인지 여부입니다.", "example": false, "type": "boolean" }, "item_id": { "description": "아이템 ID입니다. 아이템을 생성할 때 엑솔라에 의해 생성됩니다.", "example": 1, "type": "integer" }, "order_item_id": { "description": "주문의 아이템 ID입니다. 주문 생성 중에 엑솔라에 의해 생성됩니다.", "type": "integer" }, "price": { "description": "아이템 가격입니다.", "properties": { "amount": { "description": "할인된 아이템 가격입니다.", "example": "30", "type": "string" }, "amount_without_discount": { "description": "할인이 없는 아이템 가격입니다.", "example": "30", "type": "string" }, "currency": { "description": "[ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)에 따른 인게임 재화의 SKU 또는 3자리 코드입니다. [엑솔라에서 지원하는 통화](https://developers.xsolla.com/ko/doc/pay-station/references/supported-currencies/)에 대한 자세한 정보는 설명서를 참조하십시오.", "example": "USD", "type": "string" }, "is_virtual_currency": { "description": "통화가 인게임 재화인지 여부입니다.", "example": false, "type": "boolean" } }, "type": [ "object", "null" ] }, "quantity": { "description": "아이템 수량입니다.", "example": 1, "type": "integer" }, "region_id": { "description": "아이템을 사용할 수 있는 지역의 ID입니다. 지역별 판매 제한에 대한 자세한 정보는 [설명서](https://developers.xsolla.com/ko/doc/shop-builder/features/regional-restrictions/)를 참조하십시오.", "type": [ "integer", "null" ] }, "sku": { "description": "생성하는 동안 지정된 아이템 ID입니다. SKU는 소문자 및 대문자 라틴 영숫자, 마침표, 대시 및 밑줄만 포함할 수 있습니다.", "example": "elven_shield", "type": "string" }, "tax_category": { "description": "세금 범주입니다.", "example": "DG00002", "type": "string" }, "type": { "description": "아이템 유형입니다.", "enum": [ "virtual_good", "virtual_currency", "bundle", "game_key", "physical_good", "value_point" ], "example": "virtual_good", "type": "string" } }, "type": "object" }, "type": "array" }, "mode": { "description": "주문 생성 모드입니다.", "enum": [ "default", "sandbox" ], "example": "default", "type": "string" }, "order_id": { "description": "주문 ID입니다.", "example": 1, "type": "integer" }, "price": { "description": "주문 가격입니다.", "properties": { "amount": { "description": "최종 주문 가격입니다.", "example": "30", "type": "string" }, "amount_without_discount": { "description": "할인이 없는 주문 가격입니다.", "example": "30", "type": "string" }, "currency": { "description": "[ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)에 따른 인게임 재화의 SKU 또는 실제 통화의 3자리 코드입니다. [엑솔라에서 지원하는 통화](https://developers.xsolla.com/ko/doc/pay-station/references/supported-currencies/)에 대한 자세한 정보는 설명서를 확인하십시오.", "example": "USD", "type": "string" }, "is_virtual_currency": { "description": "통화가 인게임 재화인지 여부입니다.", "example": false, "type": "boolean" } }, "type": [ "object", "null" ] }, "project_id": { "description": "프로젝트 ID입니다. 이 매개 변수는 [관리자 페이지](https://publisher.xsolla.com/)의 프로젝트 이름 옆에서 확인할 수 있습니다.", "example": 44056, "type": "integer" }, "promotions": { "description": "주문에 적용된 프로모션 목록입니다.", "items": { "properties": { "promotion_id": { "description": "프로젝트 내의 프로모션 ID입니다.", "example": 111425, "type": "integer" } }, "type": "object" }, "type": [ "array", "null" ] }, "status": { "description": "주문 상태입니다.", "enum": [ "new", "paid", "done", "canceled", "expired" ], "example": "paid", "type": "string" }, "user": { "properties": { "country": { "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", "type": "string" }, "email": { "description": "[RFC 822](https://www.w3.org/Protocols/rfc822/#z8) 프로토콜에 따라 형식이 지정된 사용자 이메일입니다.", "example": "user@xsolla.com", "format": "email", "type": "string" }, "id": { "description": "주문을 생성할 때 전달된 사용자 ID입니다.", "example": "07e653a2b15011e6818f005056a54369", "type": "string" }, "region_id": { "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/)를 참조하십시오.", "example": 12, "type": [ "integer", "null" ] } }, "type": "object" } }, "type": "object" }, "type": "array" }, "total_items_count": { "description": "지정된 기간 동안의 총 주문 수입니다.", "example": 1, "type": "integer" } }, "type": "object" } } }, "description": "주문 목록을 성공적으로 검색했습니다." }, "200-items-import-status-model": { "content": { "application/json": { "schema": { "example": { "date_completed": "2024-11-19T15:27:31+03:00", "date_created": "2024-11-19T14:27:31+03:00", "date_updated": "2024-11-19T15:27:31+03:00", "error": null, "error_code": null, "progress": 100, "result": { "errors_by_sku": [ { "error_code": 4055, "error_message": "[0401-4055]: Item default price not set", "sku": "com.xsolla.sword_1", "type": "virtual_items" }, { "error_code": 1817, "error_message": "[0410-1817]: SKU can't be empty", "sku": "", "type": null } ], "errors_count": 2, "total_entities_count": 10 }, "status": "error" }, "properties": { "date_completed": { "description": "GMT+3 시간대로 표시되는 가져오기 작업 완료 타임스탬프입니다. 오류로 인해 가져오기가 중단되고 가져온 아이템이 없는 경우 빈 문자열이 반환됩니다.", "example": "2024-12-15T18:16:00+03:00", "type": "string" }, "date_created": { "description": "GMT+3 시간대로 표시되는 가져오기 생성 작업의 타임스탬프입니다.", "example": "2024-12-15T18:16:00+03:00", "type": "string" }, "date_updated": { "description": "오류로 인해 가져오기가 중단된 GMT+3 시간대로 표시되는 타임스탬프입니다.", "example": "2024-12-15T18:16:00+03:00", "type": "string" }, "error": { "description": "일반 가져오기 오류에 대한 설명입니다.", "type": "string" }, "error_code": { "description": "일반 가져오기 오류에 대한 코드입니다.", "type": "string" }, "progress": { "description": "가져오기 실행 진행률(%)입니다.", "example": 100, "type": "integer" }, "result": { "description": "특정 아이템 SKU에 대한 가져오기 결과 및 가져오기 오류에 대한 데이터가 있는 개체입니다.", "properties": { "errors_by_sku": { "description": "특정 아이템 SKU에 대한 가져오기 오류에 대한 데이터가 있는 개체 배열입니다.", "items": { "properties": { "error_code": { "description": "특정 아이템 SKU에 대한 가져오기 오류 코드입니다.", "example": 1001, "type": "integer" }, "error_message": { "description": "특정 아이템 SKU에 대한 가져오기 오류에 대한 설명입니다.", "example": "Something went wrong", "type": "string" }, "sku": { "description": "가져온 아이템에 대한 SKU입니다.", "example": "sku_1", "type": "string" }, "type": { "description": "아이템 유형입니다.", "enum": [ "virtual_good", "virtual_currency", "virtual_currency_packages", "bundle" ], "example": "vi", "type": "string" } }, "type": "object" }, "type": "array" }, "errors_count": { "description": "가져오는 동안 오류가 발생한 아이템 수입니다.", "example": 3, "type": "integer" }, "total_entities_count": { "description": "가져온 아이템의 총 수입니다.", "example": 11, "type": "integer" } }, "type": "object" }, "status": { "description": "Import status.\n\nPossible values:\n- `initialized` — Import has been initiated.\n- `process` — Import is in progress.\n- `done` — Import was successfull.\n- `error` — Due to errors, the import was not completed or only partially completed.", "enum": [ "initialized", "process", "done", "error" ], "example": "error", "type": "string" } }, "type": "object" } } }, "description": "가져오기 상태가 성공적으로 검색되었습니다." }, "201-admin-create-attribute": { "content": { "application/json": { "example": { "external_id": "genre" }, "schema": { "properties": { "external_id": { "$ref": "#/components/schemas/admin-attribute-external_id" } }, "type": "object" } } }, "description": "특성을 성공적으로 생성했습니다." }, "201-admin-create-attribute-value": { "content": { "application/json": { "example": { "external_id": "rpg" }, "schema": { "properties": { "external_id": { "$ref": "#/components/schemas/value-external_id" } }, "type": "object" } } }, "description": "특성 값을 성공적으로 생성했습니다." }, "201-admin-create-region": { "content": { "application/json": { "example": { "region_id": 42 }, "schema": { "properties": { "region_id": { "$ref": "#/components/schemas/Regions_region_id" } }, "type": "object" } } }, "description": "지역이 성공적으로 생성되었습니다." }, "204-admin-delete-region": { "content": {}, "description": "지역을 성공적으로 삭제했습니다." }, "204-admin-update-attribute": { "content": {}, "description": "특성을 성공적으로 업데이트했습니다." }, "204-admin-update-region": { "content": {}, "description": "지역을 성공적으로 업데이트했습니다." }, "401-invalid-basic-auth": { "content": { "application/json": { "examples": { "response": { "value": { "errorCode": 1020, "errorMessage": "[0401-1020]: Error in Authentication method occurred", "statusCode": 401 } } }, "schema": { "properties": { "errorCode": { "example": 1020, "type": "integer" }, "errorMessage": { "example": "[0401-1020]: Error in Authentication method occurred", "type": "string" }, "statusCode": { "example": 401, "type": "integer" } }, "type": "object" } } }, "description": "기본 인증이 전달되지 않았거나 잘못되었습니다. 기본 인증 또는 올바른 자격 증명을 사용했는지 확인해야 합니다." }, "403-auth-header-not-sent": { "content": { "application/json": { "examples": { "response": { "value": { "errorCode": 0, "errorMessage": "Authorization header not sent", "statusCode": 403 } } }, "schema": { "properties": { "errorCode": { "example": 0, "type": "integer" }, "errorMessage": { "example": "Authorization header not sent.", "type": "string" }, "statusCode": { "example": 403, "type": "integer" }, "transactionId": { "example": "x-x-x-x-transactionId-mock-x-x-x", "type": "string" } }, "type": "object" } } }, "description": "인증 헤더가 전송되지 않았습니다." }, "404-attribute-not-found": { "content": { "application/json": { "examples": { "response": { "value": { "errorCode": 9901, "errorMessage": "[0401-9901]: Attribute not found.", "statusCode": 404, "transactionId": "x-x-x-x-transactionId-mock-x-x-x" } } }, "schema": { "properties": { "errorCode": { "example": 9901, "type": "integer" }, "errorMessage": { "example": "[0401-9901]: Attribute not found.", "type": "string" }, "statusCode": { "example": 404, "type": "integer" }, "transactionId": { "example": "x-x-x-x-transactionId-mock-x-x-x", "type": "string" } }, "type": "object" } } }, "description": "특성을 찾을 수 없습니다." }, "404-attribute-value-not-found": { "content": { "application/json": { "examples": { "Attribue value not found": { "$ref": "#/components/examples/404-attribute-value-not-found" }, "Attribute not found": { "$ref": "#/components/examples/404-attribute-not-found" } }, "schema": { "$ref": "#/components/schemas/404-not-found" } } }, "description": "특성 값을 찾을 수 없습니다." }, "404-region-not-found": { "content": { "application/json": { "schema": { "properties": { "errorCode": { "example": 9701, "type": "integer" }, "errorMessage": { "example": "[0401-9701]: Region not found", "type": "string" }, "statusCode": { "example": 404, "type": "integer" }, "transactionId": { "example": "x-x-x-x-transactionId-mock-x-x-x", "type": "string" } }, "type": "object" } } }, "description": "지역을 찾을 수 없습니다. `id`가 올바른지 확인하십시오." }, "422-create-update-attribute-value": { "content": { "application/json": { "examples": { "external_id is duplicate": { "$ref": "#/components/examples/422-external-id-duplicate" }, "external_id is invalid": { "$ref": "#/components/examples/422-external-id-invalid" }, "external_id is required": { "$ref": "#/components/examples/422-external-id-required" }, "value is required": { "$ref": "#/components/examples/422-value-invalid" }, "value limit exceeded": { "$ref": "#/components/examples/422-value-limit-exceeded" }, "value properties minimum length": { "$ref": "#/components/examples/422-value-properties-required" } }, "schema": { "$ref": "#/components/schemas/schemas-422-invalid-request" } } }, "description": "잘못된 요청입니다." }, "422-validation-failed": { "content": { "application/json": { "examples": { "response": { "value": { "errorCode": 1102, "errorMessage": "[0401-1102]: Unprocessable Entity. The property `external_id` is required", "statusCode": 422 } } }, "schema": { "$ref": "#/components/schemas/schemas-422-invalid-request" } } }, "description": "잘못된 요청입니다." }, "Bundles_200-admin-get-bundle": { "content": { "application/json": { "example": { "attributes": [], "bundle_type": "standard", "content": [ { "description": { "en": "Opens ONE Empire lootbox of any kind" }, "image_url": "https://cdn.xsolla.net/img/misc/images/5c2f8536f08a9949964e4fa2e01a7cb8.png", "name": { "en": "Empire Key" }, "quantity": 5, "sku": "com.xsolla.keys_2", "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", "name": { "en": "Empire Booster Mega" }, "quantity": 1, "sku": "com.xsolla.booster_mega_2", "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", "name": { "en": "Empire Booster Mini" }, "quantity": 3, "sku": "com.xsolla.booster_min_2", "type": "virtual_good" } ], "custom_attributes": { "purchased": 0, "type": "lootbox" }, "description": { "en": "Empire bundle with items" }, "groups": [ { "external_id": "all", "name": { "en": "Equipment" } } ], "image_url": "https://cdn.xsolla.net/img/misc/images/685b21f9d9dca4aa0c953e8816b4eb4b.png", "is_enabled": true, "is_free": false, "is_paid_randomized_reward": true, "is_show_in_store": true, "item_id": 610316, "limits": { "per_item": null, "per_user": { "limit_exceeded_visibility": "show", "total": 10 }, "recurrent_schedule": null }, "long_description": { "en": "Empire bundle with some goods" }, "media_list": [], "name": { "en": "Empire bundle" }, "order": 1, "periods": [ { "date_from": "2020-08-11T10:00:00+03:00", "date_until": "2020-08-11T20:00:00+03:00" } ], "prices": [], "regions": [], "sku": "com.xsolla.EmpireBundle_1", "type": "bundle", "virtual_prices": [ { "amount": "150", "description": { "en": "Main in-game currency" }, "image_url": "https://cdn3.xsolla.com/img/misc/images/da33ab6cc1d7e5899cfdc5b6b6180fad.png", "is_default": true, "name": { "en": "Crystals", "ru": "Crystals" }, "sku": "com.xsolla.crystal_1", "type": "virtual_currency" } ] }, "schema": { "$ref": "#/components/schemas/Bundles_admin_bundle_response" } } }, "description": "지정한 번들을 성공적으로 수신했습니다." }, "Bundles_200-admin-get-bundle-list": { "content": { "application/json": { "example": { "items": [ { "attributes": [], "bundle_type": "standard", "content": [ { "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", "name": { "en": "Xsolla Booster Mini" }, "quantity": 2, "sku": "com.xsolla.booster_min_1", "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", "name": { "en": "Booster" }, "quantity": 15, "sku": "com.xsolla.booster_min_2", "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", "name": { "en": "Xsolla Gloves" }, "quantity": 3, "sku": "com.xsolla.gloves_1", "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", "name": { "en": "Xsolla Boots" }, "quantity": 2, "sku": "com.xsolla.boots_1", "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", "name": { "en": "Xsolla Gun" }, "quantity": 10, "sku": "com.xsolla.gun_max", "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", "name": { "en": "Empire Minigun" }, "quantity": 3, "sku": "com.xsolla.minigun_2", "type": "virtual_good" } ], "custom_attributes": { "purchased": 0, "type": "lootbox" }, "description": { "en": "Ultra Super Lootbox with items" }, "groups": [ { "external_id": "all", "name": { "en": "Equipment" } } ], "image_url": "https://cdn.xsolla.net/img/misc/images/779d2588a5b3cf348133fa7d5755cec8.png", "is_enabled": true, "is_free": false, "is_show_in_store": true, "item_id": 610316, "limits": { "per_item": { "available": 455, "reserved": 5, "sold": 40, "total": 500 }, "per_user": { "limit_exceeded_visibility": "show", "total": 10 }, "recurrent_schedule": { "per_user": { "displayable_reset_next_date": "2023-03-01T11:00:00+08:00", "displayable_reset_start_date": "2023-02-28T11:00:00+08:00", "interval_type": "daily", "reset_next_date": 1677639600, "time": "11:00:00+08:00" } } }, "long_description": { "en": "Ultra Super lootbox with different items" }, "media_list": [], "name": { "en": "Ultra Super Lootbox Bundle" }, "order": 1, "periods": [ { "date_from": "2020-08-11T10:00:00+03:00", "date_until": "2020-08-11T20:00:00+03:00" } ], "prices": [ { "amount": "150.49", "currency": "USD", "is_default": true, "is_enabled": true } ], "regions": [], "sku": "com.xsolla.UltraSuperLootboxBundle_1", "type": "bundle", "virtual_prices": [] }, { "attributes": [], "bundle_type": "standard", "content": [ { "description": { "en": "Opens ONE Empire lootbox of any kind" }, "image_url": "https://cdn.xsolla.net/img/misc/images/5c2f8536f08a9949964e4fa2e01a7cb8.png", "name": { "en": "Empire Key" }, "quantity": 5, "sku": "com.xsolla.keys_2", "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", "name": { "en": "Empire Booster Mega" }, "quantity": 1, "sku": "com.xsolla.booster_mega_2", "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", "name": { "en": "Empire Booster Mini" }, "quantity": 3, "sku": "com.xsolla.booster_min_2", "type": "virtual_good" } ], "description": { "en": "Empire bundle with items" }, "groups": [ { "external_id": "all", "name": { "en": "Equipment" } } ], "image_url": "https://cdn.xsolla.net/img/misc/images/685b21f9d9dca4aa0c953e8816b4eb4b.png", "is_enabled": true, "is_free": false, "is_show_in_store": true, "item_id": 610317, "limits": { "per_item": null, "per_user": null, "recurrent_schedule": null }, "long_description": { "en": "Empire bundle with some goods" }, "media_list": [], "name": { "en": "Empire bundle" }, "order": 1, "periods": [], "prices": [], "regions": [], "sku": "com.xsolla.EmpireBundle_1", "type": "bundle", "virtual_prices": [ { "amount": "150", "description": { "en": "Main in-game currency" }, "image_url": "https://cdn3.xsolla.com/img/misc/images/da33ab6cc1d7e5899cfdc5b6b6180fad.png", "is_default": true, "name": { "en": "Crystals", "ru": "Crystals" }, "sku": "com.xsolla.crystal_1", "type": "virtual_currency" } ] } ] }, "schema": { "description": "아이템이 있는 개체입니다.", "properties": { "items": { "items": { "$ref": "#/components/schemas/Bundles_admin_bundle_response" }, "type": "array" } }, "type": "object" } } }, "description": "번들 목록을 성공적으로 수신했습니다." }, "Bundles_200-admin-get-bundle-list-in-group": { "content": { "application/json": { "example": { "items": [ { "attributes": [], "bundle_type": "standard", "content": [ { "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", "name": { "en": "Xsolla Booster Mini" }, "quantity": 2, "sku": "com.xsolla.booster_min_1", "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", "name": { "en": "Booster" }, "quantity": 15, "sku": "com.xsolla.booster_min_2", "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", "name": { "en": "Xsolla Gloves" }, "quantity": 3, "sku": "com.xsolla.gloves_1", "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", "name": { "en": "Xsolla Boots" }, "quantity": 2, "sku": "com.xsolla.boots_1", "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", "name": { "en": "Xsolla Gun" }, "quantity": 10, "sku": "com.xsolla.gun_max", "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", "name": { "en": "Empire Minigun" }, "quantity": 3, "sku": "com.xsolla.minigun_2", "type": "virtual_good" } ], "custom_attributes": { "purchased": 0, "type": "lootbox" }, "description": { "en": "Ultra Super Lootbox with items" }, "groups": [ { "external_id": "all", "name": { "en": "Equipment" } } ], "image_url": "https://cdn.xsolla.net/img/misc/images/779d2588a5b3cf348133fa7d5755cec8.png", "is_enabled": true, "is_free": false, "is_show_in_store": true, "item_id": 610316, "limits": { "per_item": { "available": 455, "reserved": 5, "sold": 40, "total": 500 }, "per_user": { "limit_exceeded_visibility": "show", "total": 10 }, "recurrent_schedule": { "per_user": { "day_of_week": 2, "displayable_reset_next_date": "2023-03-07T11:00:00+08:00", "displayable_reset_start_date": "2023-02-28T11:00:00+08:00", "interval_type": "weekly", "reset_next_date": 1677553200, "time": "11:00:00+08:00" } } }, "long_description": { "en": "Ultra Super lootbox with different items" }, "media_list": [], "name": { "en": "Ultra Super Lootbox Bundle" }, "order": 1, "periods": [ { "date_from": "2020-08-11T10:00:00+03:00", "date_until": "2020-08-11T20:00:00+03:00" } ], "prices": [ { "amount": "150.49", "currency": "USD", "is_default": true, "is_enabled": true } ], "regions": [], "sku": "com.xsolla.UltraSuperLootboxBundle_1", "type": "bundle", "virtual_prices": [] }, { "attributes": [], "bundle_type": "standard", "content": [ { "description": { "en": "Opens ONE Empire lootbox of any kind" }, "image_url": "https://cdn.xsolla.net/img/misc/images/5c2f8536f08a9949964e4fa2e01a7cb8.png", "name": { "en": "Empire Key" }, "quantity": 5, "sku": "com.xsolla.keys_2", "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", "name": { "en": "Empire Booster Mega" }, "quantity": 1, "sku": "com.xsolla.booster_mega_2", "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", "name": { "en": "Empire Booster Mini" }, "quantity": 3, "sku": "com.xsolla.booster_min_2", "type": "virtual_good" } ], "description": { "en": "Empire bundle with items" }, "groups": [ { "external_id": "all", "name": { "en": "Equipment" } } ], "image_url": "https://cdn.xsolla.net/img/misc/images/685b21f9d9dca4aa0c953e8816b4eb4b.png", "is_enabled": true, "is_free": false, "is_show_in_store": true, "item_id": 610317, "limits": { "per_item": null, "per_user": null, "recurrent_schedule": null }, "long_description": { "en": "Empire bundle with some goods" }, "media_list": [], "name": { "en": "Empire bundle" }, "order": 1, "periods": [], "prices": [], "regions": [], "sku": "com.xsolla.EmpireBundle_1", "type": "bundle", "virtual_prices": [ { "amount": "150", "description": { "en": "Main in-game currency" }, "image_url": "https://cdn3.xsolla.com/img/misc/images/da33ab6cc1d7e5899cfdc5b6b6180fad.png", "is_default": true, "name": { "en": "Crystals", "ru": "Crystals" }, "sku": "com.xsolla.crystal_1", "type": "virtual_currency" } ] } ] }, "schema": { "description": "아이템이 있는 개체입니다.", "properties": { "items": { "items": { "$ref": "#/components/schemas/Bundles_admin_bundle_response" }, "type": "array" } }, "type": "object" } } }, "description": "번들 목록을 성공적으로 수신했습니다." }, "Bundles_200-get-bundle-list": { "content": { "application/json": { "examples": { "response": { "$ref": "#/components/examples/Bundles_200-get-bundle-list" } }, "schema": { "description": "아이템이 있는 개체입니다.", "properties": { "has_more": { "$ref": "#/components/schemas/Pagination_has-more" }, "items": { "items": { "$ref": "#/components/schemas/Bundles_client_bundle" }, "type": "array" } }, "type": "object" } } }, "description": "번들 목록을 성공적으로 수신했습니다." }, "Bundles_201-admin-create-bundle": { "content": { "application/json": { "examples": { "response": { "value": { "sku": "com.xsolla.kg_1" } } }, "schema": { "properties": { "sku": { "$ref": "#/components/schemas/Bundles_sku" } }, "type": "object" } } }, "description": "번들을 성공적으로 생성했습니다." }, "Bundles_204-admin-delete-bundle": { "content": {}, "description": "번들을 성공적으로 삭제했습니다." }, "Bundles_204-admin-hide-bundle": { "content": {}, "description": "번들을 성공적으로 숨김 처리했습니다." }, "Bundles_204-admin-show-bundle": { "content": {}, "description": "번들을 성공적으로 표시했습니다." }, "Bundles_204-admin-update-bundle": { "content": {}, "description": "번들을 성공적으로 업데이트했습니다." }, "Bundles_401-invalid-basic-auth": { "content": { "application/json": { "examples": { "response": { "value": { "errorCode": 1020, "errorMessage": "[0401-1020]: Error in Authentication method occurred", "statusCode": 401 } } }, "schema": { "properties": { "errorCode": { "example": 1020, "type": "integer" }, "errorMessage": { "example": "[0401-1020]: Error in Authentication method occurred", "type": "string" }, "statusCode": { "example": 401, "type": "integer" } }, "type": "object" } } }, "description": "기본 인증이 전달되지 않았거나 잘못되었습니다. 기본 인증 또는 올바른 자격 증명을 사용했는지 확인해야 합니다." }, "Bundles_422-invalid-request": { "content": { "application/json": { "examples": { "Custom attributes JSON can’t exceed 500 characters": { "$ref": "#/components/examples/422-custom-attributes-size-exceeded" }, "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" }, "The property `sku` is required": { "$ref": "#/components/examples/422-property-sku-is-required" }, "Value limit exceeded": { "$ref": "#/components/examples/422-value-limit-exceeded" } }, "schema": { "$ref": "#/components/schemas/Bundles_422-invalid-request" } } }, "description": "잘못된 요청입니다." }, "Cart-Free_200-order-created": { "content": { "application/json": { "examples": { "response": { "value": { "order_id": 641 } } }, "schema": { "properties": { "order_id": { "description": "주문 ID입니다.", "type": "integer" } }, "type": "object" } } }, "description": "무료 주문을 성공적으로 생성했습니다." }, "Cart-Payment_200-admin-fill-cart-json-model": { "content": { "application/json": { "examples": { "response": { "value": { "cart_id": "cart_id", "is_free": false, "items": [ { "attributes": [], "can_be_bought": true, "description": "The cup of tea", "groups": [ { "external_id": "cups", "name": "Cups" } ], "image_url": "https://cdn.xsolla.net/img/misc/images/e9f2f4a634bc96ea03b5d5ceadd7c55f.png", "is_bonus": false, "is_free": false, "limits": { "per_user": { "available": 3, "recurrent_schedule": { "interval_type": "weekly", "reset_next_date": 1746057600 }, "total": 5 } }, "name": "Cup", "periods": [ { "date_from": "2020-08-11T10:00:00+03:00", "date_until": "2020-08-11T20:00:00+03:00" } ], "price": { "amount": "5.99", "amount_without_discount": "5.99", "currency": "USD" }, "promotions": [], "quantity": 2, "sku": "com.xsolla.cup01", "type": "physical_good", "virtual_prices": [], "vp_rewards": [ { "amount": 130, "image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg", "item_id": 175232, "name": "Value point", "sku": "com.xsolla.value_point_1" }, { "amount": 50, "image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg", "is_clan": true, "item_id": 186321, "name": "Clan Reward VP 1", "sku": "com.xsolla.clan_value_point_1" } ] }, { "attributes": [], "can_be_bought": true, "description": "Wonderful white T-shirt", "groups": [], "image_url": "https://cdn.xsolla.net/img/misc/images/e9f2f4a634bc96ea03b5d5ceadd7c55f.png", "is_bonus": false, "is_free": false, "limits": { "per_user": { "available": 3, "recurrent_schedule": { "interval_type": "weekly", "reset_next_date": 1746057600 }, "total": 5 } }, "name": "White T-shirt", "periods": [ { "date_from": "2020-08-11T10:00:00+03:00", "date_until": "2020-08-11T20:00:00+03:00" } ], "price": { "amount": "3.99", "amount_without_discount": "4.99", "currency": "USD" }, "promotions": [ { "bonus": [ { "image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png", "name": "Xsolla Minigun", "quantity": 1, "sku": "com.xsolla.minigun_1", "type": "virtual_good" } ], "date_end": "2026-04-15T16:16:00+03:00", "date_start": "2020-04-15T16:16:00+03:00", "discount": { "percent": "50.00" }, "name": "Bonus promotion" } ], "quantity": 1, "sku": "com.xsolla.t-shirt01", "type": "physical_good", "virtual_prices": [], "vp_rewards": [ { "amount": 130, "image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg", "item_id": 175232, "name": "Value point", "sku": "com.xsolla.value_point_1" }, { "amount": 50, "image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg", "is_clan": true, "item_id": 186321, "name": "Clan Reward VP 1", "sku": "com.xsolla.clan_value_point_1" } ] }, { "attributes": [], "can_be_bought": true, "description": "Wonderful white T-shirt", "groups": [ { "external_id": "clothes", "name": "Clothes" } ], "image_url": "https://cdn.xsolla.net/img/misc/images/e9f2f4a634bc96ea03b5d5ceadd7c55f.png", "is_bonus": false, "is_free": true, "limits": { "per_user": { "available": 3, "recurrent_schedule": { "interval_type": "weekly", "reset_next_date": 1746057600 }, "total": 5 } }, "name": "Cat's cup", "periods": [ { "date_from": "2020-08-11T10:00:00+03:00", "date_until": "2020-08-11T20:00:00+03:00" } ], "price": null, "promotions": [], "quantity": 1, "sku": "com.xsolla.cup01", "type": "physical_good", "virtual_prices": [], "vp_rewards": [ { "amount": 130, "image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg", "item_id": 175232, "name": "Value point", "sku": "com.xsolla.value_point_1" }, { "amount": 50, "image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg", "is_clan": true, "item_id": 186321, "name": "Clan Reward VP 1", "sku": "com.xsolla.clan_value_point_1" } ] } ], "price": { "amount": "15.97", "amount_without_discount": "22.96", "currency": "USD" }, "promotions": [ { "bonus": [ { "image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png", "name": "Xsolla Minigun", "quantity": 1, "sku": "com.xsolla.minigun_1", "type": "virtual_good" } ], "date_end": "2026-04-15T16:16:00+03:00", "date_start": "2020-04-15T16:16:00+03:00", "discount": { "percent": "50.00" }, "name": "Bonus promotion" } ], "warnings": [ { "errorCode": 4001, "errorMessage": "[0401-4001]: Item with Project Id = 44056 and Sku = hut01 not found", "quantity": 1, "sku": "com.xsolla.hat01" } ] } } }, "schema": { "properties": { "cart_id": { "description": "장바구니 ID. 구매 페이지 또는 결제 API 엔드포인트를 쿼리하려면 장바구니 ID를 전달합니다.", "example": "cart_id", "type": "string" }, "is_free": { "$ref": "#/components/schemas/value-cart_is_free" }, "items": { "items": { "properties": { "attributes": { "$ref": "#/components/schemas/Cart-Payment_client-attributes" }, "can_be_bought": { "$ref": "#/components/schemas/Can_be_bought" }, "description": { "type": "string" }, "groups": { "items": { "properties": { "external_id": { "type": "string" }, "name": { "type": "string" } }, "type": "object" }, "type": "array" }, "image_url": { "type": "string" }, "is_bonus": { "type": "boolean" }, "is_free": { "$ref": "#/components/schemas/value-is_free" }, "limits": { "$ref": "#/components/schemas/Catalog_item_limits" }, "name": { "type": [ "string", "null" ] }, "periods": { "$ref": "#/components/schemas/item-periods" }, "price": { "description": "아이템 가격입니다.", "properties": { "amount": { "type": "string" }, "amount_without_discount": { "type": "string" }, "currency": { "type": "string" } }, "type": [ "object", "null" ] }, "promotions": { "$ref": "#/components/schemas/Catalog_item_promotions" }, "quantity": { "type": "integer" }, "sku": { "type": "string" }, "type": { "type": "string" }, "virtual_prices": { "$ref": "#/components/schemas/Bundles_virtual_prices" }, "vp_rewards": { "$ref": "#/components/schemas/client-item-value-point-reward" } }, "type": "object" }, "type": "array" }, "price": { "description": "장바구니 가격입니다.", "properties": { "amount": { "type": "string" }, "amount_without_discount": { "type": "string" }, "currency": { "type": "string" } }, "type": [ "object", "null" ] }, "promotions": { "$ref": "#/components/schemas/Catalog_cart_promotions" }, "warnings": { "items": { "properties": { "errorCode": { "type": "integer" }, "errorMessage": { "type": "string" }, "quantity": { "type": "integer" }, "sku": { "type": "string" } }, "type": "object" }, "type": "array" } }, "type": "object" } } }, "description": "아이템이 있는 장바구니를 성공적으로 반환했습니다." }, "Cart-Payment_200-fill-cart-json-model": { "content": { "application/json": { "examples": { "response": { "value": { "cart_id": "cart_id", "is_free": false, "items": [ { "attributes": [], "can_be_bought": true, "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_bonus": false, "is_free": false, "limits": { "per_user": { "available": 3, "recurrent_schedule": { "interval_type": "weekly", "reset_next_date": 1746057600 }, "total": 5 } }, "name": "Xsolla Booster Mega", "periods": [ { "date_from": "2020-08-11T10:00:00+03:00", "date_until": "2020-08-11T20:00:00+03:00" } ], "price": { "amount": "50.0000000000000000", "amount_without_discount": "100.0000000000000000", "currency": "USD" }, "promotions": [ { "bonus": [ { "image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png", "name": "Xsolla Minigun", "quantity": 1, "sku": "com.xsolla.minigun_1", "type": "virtual_good" } ], "date_end": "2026-04-15T16:16:00+03:00", "date_start": "2020-04-15T16:16:00+03:00", "discount": { "percent": "50.00" }, "name": "Bonus promotion" } ], "quantity": 123, "sku": "com.xsolla.booster_mega_1", "type": "virtual_good", "virtual_item_type": "consumable", "virtual_prices": [], "vp_rewards": [ { "amount": 130, "image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg", "item_id": 175232, "name": "Value point", "sku": "com.xsolla.value_point_1" }, { "amount": 50, "image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg", "is_clan": true, "item_id": 186321, "name": "Clan Reward VP 1", "sku": "com.xsolla.clan_value_point_1" } ] } ], "price": { "amount": "6150.0000000000000000", "amount_without_discount": "6150.0000000000000000", "currency": "USD" }, "promotions": [ { "bonus": [ { "image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png", "name": "Xsolla Minigun", "quantity": 1, "sku": "com.xsolla.minigun_1", "type": "virtual_good" } ], "date_end": "2026-04-15T16:16:00+03:00", "date_start": "2020-04-15T16:16:00+03:00", "discount": { "percent": "50.00" }, "name": "Bonus promotion" } ], "warnings": [ { "errorCode": 4001, "errorMessage": "[0401-4001]: Item with Project Id = 44056 and Sku = booster_mega_2 not found", "quantity": 1, "sku": "com.xsolla.booster_mega_21" } ] } } }, "schema": { "properties": { "cart_id": { "description": "장바구니 ID입니다.", "example": "cart_id", "type": "string" }, "is_free": { "$ref": "#/components/schemas/value-cart_is_free" }, "items": { "items": { "properties": { "attributes": { "$ref": "#/components/schemas/Cart-Payment_client-attributes" }, "can_be_bought": { "$ref": "#/components/schemas/Can_be_bought" }, "description": { "type": "string" }, "groups": { "items": { "properties": { "external_id": { "type": "string" }, "name": { "type": "string" } }, "type": "object" }, "type": "array" }, "image_url": { "type": "string" }, "is_bonus": { "type": "boolean" }, "is_free": { "$ref": "#/components/schemas/value-is_free" }, "limits": { "$ref": "#/components/schemas/Catalog_item_limits" }, "name": { "type": [ "string", "null" ] }, "periods": { "$ref": "#/components/schemas/item-periods" }, "price": { "description": "아이템 가격입니다.", "example": { "amount": "6150.0000000000000000", "amount_without_discount": "6150.0000000000000000", "currency": "USD" }, "properties": { "amount": { "type": "string" }, "amount_without_discount": { "type": "string" }, "currency": { "type": "string" } }, "type": [ "object", "null" ] }, "promotions": { "$ref": "#/components/schemas/Catalog_item_promotions" }, "quantity": { "type": "integer" }, "sku": { "type": "string" }, "type": { "type": "string" }, "virtual_item_type": { "description": "아이템 유형입니다.", "type": "string" }, "virtual_prices": { "$ref": "#/components/schemas/Bundles_virtual_prices" }, "vp_rewards": { "$ref": "#/components/schemas/client-item-value-point-reward" } }, "type": "object" }, "type": "array" }, "price": { "description": "장바구니 가격입니다.", "example": { "amount": "6150.0000000000000000", "amount_without_discount": "6150.0000000000000000", "currency": "USD" }, "properties": { "amount": { "default": "50.0000000000000000", "type": "string" }, "amount_without_discount": { "default": "100.0000000000000000", "type": "string" }, "currency": { "default": "USD", "type": "string" } }, "type": [ "object", "null" ] }, "promotions": { "$ref": "#/components/schemas/Catalog_cart_promotions" }, "warnings": { "items": { "properties": { "errorCode": { "type": "integer" }, "errorMessage": { "type": "string" }, "quantity": { "type": "integer" }, "sku": { "type": "string" } }, "type": "object" }, "type": "array" } }, "type": "object" } } }, "description": "아이템이 있는 장바구니를 성공적으로 반환했습니다." }, "Cart-Payment_200-get-cart-json-model": { "content": { "application/json": { "examples": { "response": { "value": { "cart_id": "cart_id", "is_free": false, "items": [ { "attributes": [], "can_be_bought": true, "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_bonus": false, "is_free": false, "limits": { "per_user": { "available": 3, "recurrent_schedule": { "interval_type": "weekly", "reset_next_date": 1746057600 }, "total": 5 } }, "name": "Xsolla Booster Mega", "periods": [ { "date_from": "2020-08-11T10:00:00+03:00", "date_until": "2020-08-11T20:00:00+03:00" } ], "price": { "amount": "50.0000000000000000", "amount_without_discount": "100.0000000000000000", "currency": "USD" }, "promotions": [], "quantity": 123, "sku": "com.xsolla.booster_mega_1", "type": "virtual_good", "virtual_item_type": "consumable", "virtual_prices": [], "vp_rewards": [ { "amount": 130, "image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg", "item_id": 175232, "name": "Value point", "sku": "com.xsolla.value_point_1" }, { "amount": 50, "image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg", "is_clan": true, "item_id": 186321, "name": "Clan Reward VP 1", "sku": "com.xsolla.clan_value_point_1" } ] } ], "price": { "amount": "6150.0000000000000000", "amount_without_discount": "6150.0000000000000000", "currency": "USD" }, "promotions": [ { "bonus": [ { "image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png", "name": "Xsolla Minigun", "quantity": 1, "sku": "com.xsolla.minigun_1", "type": "virtual_good" } ], "date_end": "2026-04-15T16:16:00+03:00", "date_start": "2020-04-15T16:16:00+03:00", "discount": { "percent": "50.00" }, "name": "Bonus promotion" } ] } } }, "schema": { "properties": { "cart_id": { "description": "장바구니 ID입니다.", "example": "cart_id", "type": "string" }, "is_free": { "$ref": "#/components/schemas/value-cart_is_free" }, "items": { "items": { "properties": { "attributes": { "$ref": "#/components/schemas/Cart-Payment_client-attributes" }, "can_be_bought": { "$ref": "#/components/schemas/Can_be_bought" }, "description": { "type": "string" }, "groups": { "items": { "properties": { "external_id": { "type": "string" }, "name": { "type": "string" } }, "type": "object" }, "type": "array" }, "image_url": { "type": "string" }, "is_bonus": { "type": "boolean" }, "is_free": { "$ref": "#/components/schemas/value-is_free" }, "limits": { "$ref": "#/components/schemas/Catalog_item_limits" }, "name": { "type": [ "string", "null" ] }, "periods": { "$ref": "#/components/schemas/item-periods" }, "price": { "description": "아이템 가격입니다.", "example": { "amount": "6150.0000000000000000", "amount_without_discount": "6150.0000000000000000", "currency": "USD" }, "properties": { "amount": { "type": "string" }, "amount_without_discount": { "type": "string" }, "currency": { "type": "string" } }, "type": [ "object", "null" ] }, "promotions": { "$ref": "#/components/schemas/Catalog_item_promotions" }, "quantity": { "type": "integer" }, "sku": { "type": "string" }, "type": { "type": "string" }, "virtual_item_type": { "description": "아이템 유형입니다.", "type": "string" }, "virtual_prices": { "$ref": "#/components/schemas/Bundles_virtual_prices" }, "vp_rewards": { "$ref": "#/components/schemas/client-item-value-point-reward" } }, "type": "object" }, "type": "array" }, "price": { "description": "장바구니 가격입니다.", "example": { "amount": "6150.0000000000000000", "amount_without_discount": "6150.0000000000000000", "currency": "USD" }, "properties": { "amount": { "default": "50.0000000000000000", "type": "string" }, "amount_without_discount": { "default": "100.0000000000000000", "type": "string" }, "currency": { "default": "USD", "type": "string" } }, "type": [ "object", "null" ] }, "promotions": { "$ref": "#/components/schemas/Catalog_cart_promotions" } }, "type": "object" } } }, "description": "아이템이 있는 장바구니를 성공적으로 반환했습니다." }, "Cart-Payment_200-get-order": { "content": { "application/json": { "examples": { "response": { "value": { "content": { "is_free": false, "items": [ { "is_free": false, "price": { "amount": "30", "amount_without_discount": "30", "currency": "USD" }, "quantity": 1, "sku": "com.xsolla.item_1" } ], "price": { "amount": "30", "amount_without_discount": "30", "currency": "USD" } }, "order_id": 1, "status": "paid" } } }, "schema": { "properties": { "content": { "description": "주문 세부 정보입니다.", "properties": { "is_free": { "description": "`true`일 경우 주문이 무료입니다.", "example": false, "type": "boolean" }, "items": { "description": "아이템 목록입니다.", "example": [ { "is_free": false, "price": { "amount": "30", "amount_without_discount": "30", "currency": "USD" }, "quantity": 1, "sku": "com.xsolla.item_1" } ], "items": { "properties": { "is_free": { "$ref": "#/components/schemas/value-is_free" }, "price": { "description": "아이템 가격입니다.", "properties": { "amount": { "description": "할인된 아이템 가격입니다.", "example": "30", "type": "string" }, "amount_without_discount": { "description": "아이템 가격입니다.", "example": "30", "type": "string" }, "currency": { "description": "아이템 가격 통화입니다. [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)에 따른 3자리 코드입니다.", "example": "USD", "type": "string" } }, "type": "object" }, "quantity": { "description": "아이템 수량입니다.", "example": 1, "type": "integer" }, "sku": { "description": "고유한 아이템 ID입니다. SKU는 소문자 및 대문자 라틴 영숫자, 마침표, 대시 및 밑줄만 포함할 수 있습니다.", "example": "some_sku", "type": "string" } }, "type": "object" }, "type": "array" }, "price": { "description": "주문 가격입니다.", "properties": { "amount": { "description": "주문 할인 가격입니다.", "example": "30", "type": "string" }, "amount_without_discount": { "description": "주문 가격입니다.", "example": "30", "type": "string" }, "currency": { "description": "주문 가격 통화입니다. [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)에 따른 3자리 코드입니다.", "example": "USD", "type": "string" } }, "type": "object" }, "virtual_price": { "description": "인게임 재화로 표시된 주문 가격입니다.", "properties": { "amount": { "description": "주문 할인 가격입니다.", "example": "100", "type": "string" }, "amount_without_discount": { "description": "주문 가격입니다.", "example": "150", "type": "string" }, "currency": { "description": "주문에 사용된 인게임 재화 SKU입니다.", "example": "test_vc", "type": "string" } }, "type": "object" } }, "type": "object" }, "order_id": { "default": "Order ID.", "description": "주문 ID입니다.", "example": 1, "type": "integer" }, "status": { "description": "주문 상태: `new`/`paid`/`done`/`canceled`.", "example": "paid", "type": "string" } }, "type": "object" } } }, "description": "주문 요청에 성공했습니다." }, "Cart-Payment_200-order-created": { "content": { "application/json": { "examples": { "response": { "value": { "order_id": 641, "token": "f4puMEFFDZcx9nv5HoNHIkPe9qghvBQo" } } }, "schema": { "properties": { "order_id": { "description": "주문 ID입니다.", "type": "integer" }, "token": { "description": "결제 토큰입니다.", "type": "string" } }, "type": "object" } } }, "description": "주문을 성공적으로 생성했습니다." }, "Cart-Payment_201-admin-create-payment-token": { "content": { "application/json": { "examples": { "response": { "value": { "order_id": 12345, "token": "huooAqbXBSJxB8Q4dYBqJp4ybiInqsPb" } } }, "schema": { "properties": { "order_id": { "description": "주문 ID입니다.", "example": 1, "type": "integer" }, "token": { "description": "결제 토큰입니다.", "type": "string" } }, "type": "object" } } }, "description": "결제 토큰 및 주문을 생성했습니다." }, "Cart-Payment_401-invalid-basic-auth": { "content": { "application/json": { "examples": { "response": { "value": { "errorCode": 1020, "errorMessage": "[0401-1020]: Error in Authentication method occurred", "statusCode": 401 } } }, "schema": { "properties": { "errorCode": { "example": 1020, "type": "integer" }, "errorMessage": { "example": "[0401-1020]: Error in Authentication method occurred", "type": "string" }, "statusCode": { "example": 401, "type": "integer" } }, "type": "object" } } }, "description": "기본 인증이 전달되지 않았거나 잘못되었습니다. 기본 인증 또는 올바른 자격 증명을 사용했는지 확인해야 합니다." }, "Cart-Payment_404-create-order-with-item-not-found-errors": { "content": { "application/json": { "examples": { "coupon not found": { "$ref": "#/components/examples/404-coupon-not-found" }, "item not found": { "$ref": "#/components/examples/404-item-by-sku-not-found" } }, "schema": { "properties": { "errorCode": { "type": "integer" }, "errorMessage": { "type": "string" }, "statusCode": { "type": "integer" }, "transactionId": { "type": "string" } }, "type": "object" } } }, "description": "아이템 또는 쿠폰을 찾을 수 없습니다. 사용한 데이터가 올바른지 확인해 주십시오." }, "Cart-Payment_404-get-order": { "content": { "application/json": { "examples": { "response": { "value": { "errorCode": 9001, "errorMessage": "[0401-9001]: Order not found", "statusCode": 404 } } }, "schema": { "properties": { "errorCode": { "example": 9001, "type": "integer" }, "errorMessage": { "example": "[0401-9001]: Order not found", "type": "string" }, "statusCode": { "example": 404, "type": "integer" } }, "type": "object" } } }, "description": "주문을 찾을 수 없습니다. `project_id`와 `order_id`가 올바른지 확인해야 합니다." }, "Cart-Payment_404-item": { "content": { "application/json": { "schema": { "properties": { "errorCode": { "example": 4001, "type": "integer" }, "errorMessage": { "example": "[0401-4001]: Item with Project Id = 44056 and Sku = booster_mega_12222 not found", "type": "string" }, "statusCode": { "example": 404, "type": "integer" } }, "type": "object" } } }, "description": "아이템을 찾을 수 없습니다. `project_id`과 `item_sku`가 올바른지 확인해야 합니다." }, "Cart-Payment_404-user": { "content": { "application/json": { "schema": { "properties": { "errorCode": { "example": 5008, "type": "integer" }, "errorMessage": { "example": "[0401-5008]: Could not find User", "type": "string" }, "statusCode": { "example": 404, "type": "integer" } }, "type": "object" } } }, "description": "사용자를 찾을 수 없습니다. `x-user-for` 또는 `x-user-id` 토큰이 올바른지 확인해야 합니다." }, "Cart-Payment_422-admin-create-payment-token": { "content": { "application/json": { "examples": { "Empty cart": { "value": { "errorCode": 1417, "errorMessage": "[0401-1417]: Empty cart! Cart shouldn't be empty!", "statusCode": 422, "transactionId": "da145238620011eb8e24fe6913ff226a" } }, "Invalid cart": { "value": { "errorCode": 1401, "errorMessage": "[0401-1401]: Invalid cart", "statusCode": 422, "transactionId": "da145238620011eb8e24fe6913ff226a" } }, "Invalid request body": { "value": { "errorCode": 1102, "errorMessage": "[0401-1102]: Unprocessable Entity. The property `name` is required", "statusCode": 422, "transactionId": "da145238620011eb8e24fe6913ff226a" } }, "Item is free": { "value": { "errorCode": 1421, "errorMessage": "[0401-1421]: Item is free", "statusCode": 422, "transactionId": "da145238620011eb8e24fe6913ff226a" } }, "User country not provided": { "value": { "errorCode": 1102, "errorMessage": "[0401-1102]: The parameter user.country.value or the header X-User-Ip must be specified", "statusCode": 422, "transactionId": "da145238620011eb8e24fe6913ff226a" } } }, "schema": { "$ref": "#/components/schemas/422-invalid-request-2" } } }, "description": "요청 본문 및 장바구니 유효성 검사 오류입니다.\n- 전달된 아이템에서 생성된 유효하지 않은 장바구니입니다. 장바구니가 비어 있지 않은지, 모든 아이템이 무료가 아닌지 확인해야 합니다.\n- 잘못된 요청 본문입니다." }, "Cart-Payment_422-can-put-only-virtual-good-to-cart": { "content": { "application/json": { "examples": { "response": { "value": { "errorCode": 1421, "errorMessage": "Only Virtual Good Supported", "statusCode": 422 } } }, "schema": { "properties": { "errorCode": { "example": 1421, "type": "integer" }, "errorMessage": { "example": "This type of item cannot be put to the cart. Select another type of item.", "type": "string" }, "statusCode": { "example": 422, "type": "integer" } }, "type": "object" } } }, "description": "이 유형의 아이템은 장바구니에 넣을 수 없습니다. 다른 유형의 아이템을 선택해야 합니다." }, "Cart-Payment_422-create-order-with-item-invalid": { "content": { "application/json": { "examples": { "code expired": { "value": { "errorCode": 9810, "errorMessage": "[0401-9810]: Sorry, this code is expired.", "statusCode": 422 } }, "code redemption limit": { "value": { "errorCode": 9804, "errorMessage": "[0401-9804]: You have reached the coupon redemption limit.", "statusCode": 422 } }, "invalid item": { "value": { "errorCode": 1411, "errorMessage": "[0401-1411]: Invalid item", "statusCode": 422 } }, "regionally restricted": { "value": { "errorCode": 9808, "errorMessage": "[0401-9808]: Coupon is not available in your region.", "statusCode": 422 } } }, "schema": { "properties": { "errorCode": { "example": 1411, "type": "integer" }, "errorMessage": { "example": "[0401-1411]: Invalid item", "type": "string" }, "statusCode": { "example": 422, "type": "integer" } }, "type": "object" } } }, "description": "잘못된 오류입니다." }, "Cart-Payment_422-invalid-cart": { "content": { "application/json": { "examples": { "response": { "value": { "errorCode": 1401, "errorMessage": "[0401-1401]: Invalid cart", "statusCode": 422 } } }, "schema": { "properties": { "errorCode": { "example": 1401, "type": "integer" }, "errorMessage": { "example": "[0401-1401]: Invalid cart", "type": "string" }, "statusCode": { "example": 422, "type": "integer" } }, "type": "object" } } }, "description": "장바구니가 잘못되었습니다. 장바구니가 존재하는지, 장바구니가 비어 있지 않은지, 장바구니에 있는 모든 아이템이 무료가 아닌지 확인해야 합니다." }, "Cart-Payment_422-invalid-item": { "content": { "application/json": { "examples": { "response": { "value": { "errorCode": 1411, "errorMessage": "[0401-1411]: Invalid item", "statusCode": 422 } } }, "schema": { "properties": { "errorCode": { "example": 1411, "type": "integer" }, "errorMessage": { "example": "[0401-1411]: Invalid item", "type": "string" }, "statusCode": { "example": 422, "type": "integer" } }, "type": "object" } } }, "description": "아이템이 잘못되었습니다. 아이템이 존재하는지, 꺼진 상태가 아닌지, 삭제되었는지, 무료가 아닌지 확인해야 합니다." }, "Cart-Payment_422-non-negative-quantity": { "content": { "application/json": { "examples": { "response": { "value": { "errorCode": 1102, "errorMessage": "[0401-1102]: Item quantity must be non-negative integer", "statusCode": 422 } } }, "schema": { "properties": { "errorCode": { "example": 1102, "type": "integer" }, "errorMessage": { "example": "Item quantity must be non-negative integer.", "type": "string" }, "statusCode": { "example": 422, "type": "integer" } }, "type": "object" } } }, "description": "아이템 수량은 음수가 아닌 정수여야 합니다." }, "Common_401-invalid-basic-auth": { "content": { "application/json": { "examples": { "response": { "value": { "errorCode": 1020, "errorMessage": "[0401-1020]: Error in Authentication method occurred", "statusCode": 401 } } }, "schema": { "properties": { "errorCode": { "example": 1020, "type": "integer" }, "errorMessage": { "example": "[0401-1020]: Error in Authentication method occurred", "type": "string" }, "statusCode": { "example": 401, "type": "integer" } }, "type": "object" } } }, "description": "기본 인증이 전달되지 않았거나 잘못되었습니다. 기본 인증 또는 올바른 자격 증명을 사용했는지 확인해야 합니다." }, "Game-Keys_200-admin-get-game-by-sku": { "content": { "application/json": { "examples": { "response": { "value": { "attributes": [ { "external_id": "platform", "name": { "en-US": "Platform" }, "values": [ { "external_id": "platform_value_d847f9a494487f5e95ad218f7beecac646f15989", "value": { "de-DE": "Windows, Linux", "en-US": "Windows, Linux" } } ] } ], "description": { "en": "Example game 1" }, "groups": [ { "external_id": "horror", "name": { "en": "Horror" } } ], "image_url": "https://image.example.com", "is_enabled": true, "is_free": false, "is_show_in_store": false, "item_id": 1, "long_description": { "en": "Example game's long description" }, "media_list": [ { "type": "image", "url": "https://cdn3.xsolla.com/img/misc/images/71ab1e12126f2103e1868076f0acb21a.jpg" } ], "name": { "en": "Game 1" }, "order": 1, "sku": "com.xsolla.game_1", "type": "unit", "unit_items": [ { "drm_id": 1, "drm_image": "https://upload.wikimedia.org/wikipedia/en/4/48/Steam_Icon_2014.png", "drm_name": "Steam", "drm_sku": "steam_key_1", "is_enabled": true, "is_free": false, "is_sales_exist": false, "is_show_in_store": false, "item_id": 3, "keys": { "available": 3, "total": 4, "used": 1 }, "limits": { "per_item": { "available": 5000, "reserved": 500, "sold": 4500, "total": 10000 }, "per_user": { "limit_exceeded_visibility": "show", "total": 5 }, "recurrent_schedule": { "per_user": { "displayable_reset_next_date": "2023-02-28T11:00:00+08:00", "displayable_reset_start_date": "2023-02-28T11:00:00+08:00", "interval_type": "daily", "reset_next_date": 1677553200, "time": "11:00:00+08:00" } } }, "order": 1, "periods": [ { "date_from": "2020-08-11T10:00:00+03:00", "date_until": "2020-08-11T20:00:00+03:00" } ], "pre_order": { "description": null, "is_enabled": false, "release_date": null }, "prices": [ { "amount": 1199.99, "country_iso": "RU", "currency": "RUB", "is_default": true, "is_enabled": true } ], "sku": "com.xsolla.game_1_key_1", "type": "game_key", "virtual_prices": [] }, { "drm_id": 8, "drm_image": null, "drm_name": "Epic Games Store", "drm_sku": "epicgames_key_1", "is_enabled": true, "is_free": false, "is_sales_exist": false, "is_show_in_store": false, "item_id": 4, "keys": { "available": 0, "total": 0, "used": 0 }, "limits": { "per_item": null, "per_user": null, "recurrent_schedule": null }, "order": 1, "periods": [ { "date_from": null, "date_until": "2020-08-11T20:00:00+03:00" } ], "pre_order": { "description": null, "is_enabled": true, "release_date": "2020-08-11T10:00:00+03:00" }, "prices": [ { "amount": 1299.99, "country_iso": "RU", "currency": "RUB", "is_default": true, "is_enabled": true } ], "regions": [ { "id": 12 }, { "id": 64 } ], "sku": "com.xsolla.game_1_key_2", "type": "game_key", "virtual_prices": null } ] } } }, "schema": { "description": "게임 정보가 있는 개체입니다.", "properties": { "attributes": { "$ref": "#/components/schemas/Game-Keys_admin-attributes" }, "description": { "$ref": "#/components/schemas/description-localization-object" }, "groups": { "description": "아이템이 속한 그룹입니다.", "example": [ { "external_id": "horror", "name": { "en": "Horror" } } ], "items": { "properties": { "external_id": { "example": "horror", "type": "string" }, "name": { "example": { "en": "Horror" }, "type": "object" } }, "type": "object" }, "type": "array" }, "image_url": { "description": "이미지 URL입니다.", "example": "https://image.example.com", "type": "string" }, "is_enabled": { "type": "boolean" }, "is_free": { "$ref": "#/components/schemas/value-is_free" }, "is_show_in_store": { "type": "boolean" }, "item_id": { "description": "아이템 생성 시 제공되는 내부의 고유 아이템 ID입니다.", "example": 1, "type": "integer" }, "long_description": { "$ref": "#/components/schemas/long-description-localization-object" }, "media_list": { "description": "스크린샷, 게임 플레이 동영상 등과 같은 게임 추가 자산입니다.", "example": [ { "type": "image", "url": "https://cdn3.xsolla.com/img/misc/images/71ab1e12126f2103e1868076f0acb21a.jpg" } ], "items": { "properties": { "type": { "description": "미디어 유형: `image`/`video`.", "enum": [ "image", "video" ], "example": "image", "type": "string" }, "url": { "description": "리소스 파일입니다.", "example": "https://cdn3.xsolla.com/img/misc/images/71ab1e12126f2103e1868076f0acb21a.jpg", "type": "string" } }, "type": "object" }, "type": "array" }, "name": { "$ref": "#/components/schemas/name-localization-object" }, "order": { "description": "목록에서 게임의 주문 우선 순위입니다.", "example": 1, "type": "integer" }, "sku": { "description": "고유한 아이템 ID입니다. SKU는 소문자 및 대문자 라틴 영숫자, 마침표, 대시 및 밑줄만 포함할 수 있습니다.", "example": "game_1", "type": "string" }, "type": { "description": "아이템 유형입니다. 이 경우 항상 `unit`입니다.", "example": "unit", "type": "string" }, "unit_items": { "description": "다른 DRM용 게임 키입니다.", "items": { "description": "게임 키 아이템입니다. 특정 플랫폼(steam, gog 등)의 게임을 나타냅니다.", "properties": { "drm_id": { "description": "DRM 내부 고유 ID입니다.", "example": 1, "type": "integer" }, "drm_image": { "description": "게임 키 DRM 아이콘입니다.", "example": "https://upload.wikimedia.org/wikipedia/en/4/48/Steam_Icon_2014.png", "type": [ "string", "null" ] }, "drm_name": { "description": "게임 키 DRM 이름입니다.", "example": "Steam", "type": "string" }, "drm_sku": { "description": "DRM 고유 ID입니다.", "example": "steam", "type": "string" }, "is_enabled": { "description": "비활성화된 경우 인벤토리를 통해 아이템을 구매하고 액세스할 수 없습니다.", "type": "boolean" }, "is_free": { "$ref": "#/components/schemas/value-is_free" }, "is_sales_exist": { "description": "`true`인 경우 사용자가 게임 키를 구매한 것입니다.", "type": "boolean" }, "is_show_in_store": { "description": "아이템을 구매할 수 있는 상태입니다.", "type": "boolean" }, "item_id": { "description": "아이템 생성 시 제공되는 내부의 고유 아이템 ID입니다.", "example": 1, "type": "integer" }, "keys": { "properties": { "available": { "description": "구매할 수 있는 키의 개수입니다.", "type": "integer" }, "total": { "description": "업로드된 키의 총 개수입니다.", "type": "integer" }, "used": { "description": "판매된 키 개수입니다.", "type": "integer" } }, "type": "object" }, "limits": { "$ref": "#/components/schemas/admin-item-limit-response" }, "order": { "description": "목록에서 게임의 주문 우선 순위입니다.", "example": 1, "type": "integer" }, "periods": { "$ref": "#/components/schemas/item-periods-response" }, "pre_order": { "description": "사전 판매 설정입니다.", "properties": { "description": { "description": "사전 판매에 대한 추가 정보는 이메일로 전송됩니다.", "type": [ "string", "null" ] }, "is_enabled": { "description": "비활성화된 경우 해당 아이템은 사전 판매 대상이 아닙니다.", "type": "boolean" }, "release_date": { "description": "ISO 8601 형식으로 된 게임 키 출시 날짜입니다.", "type": [ "string", "null" ] } }, "type": "object" }, "prices": { "description": "실제 통화 가격입니다.", "example": [ { "amount": 1299.99, "country_is": "RU", "currency": "RUB", "is_default": true, "is_enabled": true } ], "items": { "properties": { "amount": { "example": 1299.99, "type": "number" }, "country_iso": { "description": "이 가격을 사용할 수 있는 국가입니다. [ISO 3166-1 alpha 2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)에 따른 2자리 글자 코드입니다.", "example": "US", "type": [ "string", "null" ] }, "currency": { "description": "아이템 가격 통화입니다. [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)에 따른 3자리 코드입니다.", "example": "RUB", "type": "string" }, "is_default": { "description": "기본 가격은 사용자 통화로 가격을 지정하지 않은 경우 카탈로그를 작성하는 데 사용됩니다.", "type": "boolean" }, "is_enabled": { "type": "boolean" } }, "type": "object" }, "type": "array" }, "regions": { "$ref": "#/components/schemas/Game-Keys_regions" }, "sku": { "description": "고유한 아이템 ID입니다. SKU는 소문자 및 대문자 라틴 영숫자, 마침표, 대시 및 밑줄만 포함할 수 있습니다.", "example": "game_1", "type": "string" }, "type": { "description": "아이템 유형입니다. 이 경우 항상 `game_key`입니다.", "example": "game_key", "type": "string" }, "virtual_prices": { "example": [ { "amount": 1000, "description": null, "image_url": "https://i.pinimg.com/originals/91/ae/56/91ae5683045f6dbef16b1482bade938f.png", "is_default": true, "name": { "en": "Gold" }, "sku": "com.xsolla.gold_1", "type": "virtual_currency" } ], "items": { "properties": { "amount": { "type": "number" }, "description": { "additionalProperties": true, "description": "게임 설명에 대한 현지화가 있는 개체입니다. 키는 ISO 3166-1에 따라 지정되어 있습니다.", "example": { "en": "Game 1 Example" }, "type": "object" }, "image_url": { "description": "이미지 URL입니다.", "example": "https://image.example.com", "type": "string" }, "is_default": { "type": "boolean" }, "name": { "additionalProperties": true, "description": "인게임 재화의 이름에 대한 현지화가 있는 개체입니다. 키는 ISO 3166-1에 따라 지정되어 있습니다.", "example": { "en": "Gold" }, "type": "object" }, "sku": { "description": "고유한 아이템 ID입니다. SKU는 소문자 및 대문자 라틴 영숫자, 마침표, 대시 및 밑줄만 포함할 수 있습니다.", "example": "gold", "type": "string" }, "type": { "description": "아이템 유형입니다. 이 경우 항상 `virtual_currency`입니다.", "example": "virtual_currency", "type": "string" } }, "type": "object" }, "type": [ "array", "null" ] } }, "type": "object" }, "type": "array" } }, "type": "object" } } }, "description": "게임을 성공적으로 수신했습니다." }, "Game-Keys_200-admin-get-games-list": { "content": { "application/json": { "examples": { "response": { "value": { "items": [ { "attributes": [ { "external_id": "platform", "name": { "en-US": "Platform" }, "values": [ { "external_id": "platform_value_d847f9a494487f5e95ad218f7beecac646f15989", "value": { "de-DE": "Windows, Linux", "en-US": "Windows, Linux" } } ] } ], "description": { "en": "Example game 1" }, "groups": [ { "external_id": "horror", "name": { "en": "Horror" } } ], "image_url": "https://image.example.com", "is_enabled": true, "is_free": false, "is_show_in_store": false, "item_id": 1, "long_description": { "en": "Example game's long description" }, "media_list": [ { "type": "image", "url": "https://cdn3.xsolla.com/img/misc/images/71ab1e12126f2103e1868076f0acb21a.jpg" } ], "name": { "en": "Game 1" }, "order": 1, "sku": "com.xsolla.game_1", "type": "unit", "unit_items": [ { "drm_id": 1, "drm_image": "https://upload.wikimedia.org/wikipedia/en/4/48/Steam_Icon_2014.png", "drm_name": "Steam", "drm_sku": "steam_key_1", "is_enabled": true, "is_free": false, "is_sales_exist": false, "is_show_in_store": false, "item_id": 3, "keys": { "available": 3, "total": 4, "used": 1 }, "limits": { "per_item": { "available": 5000, "reserved": 500, "sold": 4500, "total": 10000 }, "per_user": { "limit_exceeded_visibility": "show", "total": 10 }, "recurrent_schedule": { "per_user": { "displayable_reset_next_date": "2023-02-28T11:00:00+08:00", "displayable_reset_start_date": "2023-02-28T11:00:00+08:00", "interval_type": "daily", "reset_next_date": 1677553200, "time": "11:00:00+08:00" } } }, "order": 1, "periods": [ { "date_from": "2020-08-11T20:00:00+03:00", "date_until": null } ], "pre_order": { "description": null, "is_enabled": false, "release_date": null }, "prices": [ { "amount": 1199.99, "country_iso": "RU", "currency": "RUB", "is_default": true, "is_enabled": true } ], "sku": "com.xsolla.game_1_key_1", "type": "game_key", "virtual_prices": [] }, { "attributes": [], "drm_id": 8, "drm_image": null, "drm_name": "Epic Games Store", "drm_sku": "epicgames_key_1", "groups": [], "is_enabled": true, "is_free": false, "is_sales_exist": true, "is_show_in_store": false, "item_id": 4, "keys": { "available": 0, "total": 0, "used": 0 }, "limits": { "per_item": null, "per_user": null, "recurrent_schedule": null }, "name": { "en": "Game 1 Key 2" }, "order": 1, "periods": [], "pre_order": { "description": "Some description", "is_enabled": true, "release_date": "2020-08-11T10:00:00+03:00" }, "prices": [ { "amount": 1299.99, "country_iso": "RU", "currency": "RUB", "is_default": true, "is_enabled": true } ], "sku": "com.xsolla.game_1_key_2", "type": "game_key", "virtual_prices": null } ] }, { "attributes": [ { "external_id": "platform", "name": { "en-US": "Platform" }, "values": [ { "external_id": "platform_value_d847f9a494487f5e95ad218f7beecac646f15989", "value": { "de-DE": "Windows, Linux", "en-US": "Windows, Linux" } } ] } ], "description": { "en": "Example game 2" }, "groups": [ { "external_id": "horror", "name": { "en": "Horror" } } ], "image_url": "https://image.example.com", "is_enabled": true, "is_free": false, "is_show_in_store": true, "item_id": 2, "long_description": { "en": "Example game's long description" }, "media_list": [], "name": { "en": "Game 2" }, "order": 1, "sku": "com.xsolla.game_2", "type": "unit", "unit_items": [ { "drm_id": 8, "drm_image": null, "drm_name": "Epic Games Store", "drm_sku": "epicgames_key_1", "is_enabled": false, "is_free": false, "is_sales_exist": true, "is_show_in_store": false, "item_id": 5, "keys": { "available": 0, "total": 0, "used": 0 }, "limits": { "per_item": { "available": 5000, "reserved": 500, "sold": 4500, "total": 10000 }, "per_user": { "limit_exceeded_visibility": "show", "total": 10 }, "recurrent_schedule": { "per_user": { "displayable_reset_next_date": "2023-02-28T11:00:00+08:00", "displayable_reset_start_date": "2023-02-28T11:00:00+08:00", "interval_type": "daily", "reset_next_date": 1677553200, "time": "11:00:00+08:00" } } }, "order": 1, "periods": [ { "date_from": "2020-08-11T10:00:00+03:00", "date_until": "2020-08-11T20:00:00+03:00" } ], "pre_order": { "description": null, "is_enabled": false, "release_date": null }, "prices": [], "sku": "com.xsolla.game_2_key_2", "type": "game_key", "virtual_prices": [ { "amount": 1000, "description": null, "image_url": "https://i.pinimg.com/originals/91/ae/56/91ae5683045f6dbef16b1482bade938f.png", "is_default": true, "name": { "en": "Gold" }, "sku": "com.xsolla.gold_1", "type": "virtual_currency" } ] } ] } ] } } }, "schema": { "description": "게임이 있는 개체입니다.", "properties": { "items": { "items": { "properties": { "attributes": { "$ref": "#/components/schemas/Game-Keys_admin-attributes" }, "description": { "$ref": "#/components/schemas/description-localization-object" }, "groups": { "description": "아이템이 속한 그룹입니다.", "example": [ { "external_id": "horror", "name": { "en": "Horror" } } ], "items": { "properties": { "external_id": { "example": "horror", "type": "string" }, "name": { "example": { "en": "Horror" }, "type": "object" } }, "type": "object" }, "type": "array" }, "image_url": { "description": "이미지 URL입니다.", "example": "https://image.example.com", "type": "string" }, "is_enabled": { "description": "비활성화된 경우 인벤토리를 통해 아이템을 구매하고 액세스할 수 없습니다.", "type": "boolean" }, "is_free": { "$ref": "#/components/schemas/value-is_free" }, "is_show_in_store": { "description": "아이템을 구매할 수 있는 상태입니다.", "type": "boolean" }, "item_id": { "description": "아이템 생성 시 제공되는 내부의 고유 아이템 ID입니다.", "example": 1, "type": "integer" }, "long_description": { "$ref": "#/components/schemas/long-description-localization-object" }, "media_list": { "description": "스크린샷, 게임 플레이 동영상 등과 같은 게임 추가 자산입니다.", "example": [ { "type": "image", "url": "https://cdn3.xsolla.com/img/misc/images/71ab1e12126f2103e1868076f0acb21a.jpg" } ], "items": { "properties": { "type": { "description": "미디어 유형: `image`/`video`.", "enum": [ "image", "video" ], "example": "image", "type": "string" }, "url": { "description": "리소스 파일입니다.", "example": "https://cdn3.xsolla.com/img/misc/images/71ab1e12126f2103e1868076f0acb21a.jpg", "type": "string" } }, "type": "object" }, "type": "array" }, "name": { "$ref": "#/components/schemas/name-localization-object" }, "order": { "description": "목록에서 게임의 주문 우선 순위입니다.", "example": 1, "type": "integer" }, "sku": { "description": "고유 아이템 ID입니다. SKU는 소문자 및 대문자 라틴 영숫자, 마침표, 대시 및 밑줄만 포함할 수 있습니다.", "example": "game_1", "type": "string" }, "type": { "description": "아이템 유형입니다. 이 경우 항상 `unit`입니다.", "example": "unit", "type": "string" }, "unit_items": { "description": "다른 DRM용 게임 키입니다.", "items": { "description": "게임 키 아이템입니다. 특정 플랫폼(steam, gog 등)의 게임을 나타냅니다.", "properties": { "attributes": { "$ref": "#/components/schemas/Game-Keys_admin-attributes" }, "drm_id": { "description": "DRM 내부 고유 ID입니다.", "example": 1, "type": "integer" }, "drm_image": { "description": "게임 키 DRM 아이콘입니다.", "example": "https://upload.wikimedia.org/wikipedia/en/4/48/Steam_Icon_2014.png", "type": [ "string", "null" ] }, "drm_name": { "description": "게임 키 DRM 이름입니다.", "example": "Steam", "type": "string" }, "drm_sku": { "description": "DRM 고유 ID입니다.", "example": "steam", "type": "string" }, "groups": { "description": "아이템이 속한 그룹입니다.", "example": [ { "external_id": "horror", "name": { "en": "Horror" } } ], "items": { "properties": { "external_id": { "example": "horror", "type": "string" }, "name": { "example": { "en": "Horror" }, "type": "object" } }, "type": "object" }, "type": "array" }, "is_enabled": { "description": "비활성화된 경우 인벤토리를 통해 아이템을 구매하고 액세스할 수 없습니다.", "type": "boolean" }, "is_free": { "$ref": "#/components/schemas/value-is_free" }, "is_sales_exist": { "description": "`true`인 경우 사용자가 게임 키를 구매한 것입니다.", "type": "boolean" }, "is_show_in_store": { "description": "아이템을 구매할 수 있는 상태입니다.", "type": "boolean" }, "item_id": { "description": "아이템 생성 시 제공되는 내부의 고유 아이템 ID입니다.", "example": 1, "type": "integer" }, "keys": { "properties": { "available": { "description": "구매할 수 있는 키의 개수입니다.", "type": "integer" }, "total": { "description": "업로드된 키의 총 개수입니다.", "type": "integer" }, "used": { "description": "판매된 키 개수입니다.", "type": "integer" } }, "type": "object" }, "limits": { "$ref": "#/components/schemas/admin-item-limit-response" }, "long_description": { "$ref": "#/components/schemas/long-description-localization-object" }, "name": { "$ref": "#/components/schemas/name-localization-object" }, "order": { "description": "목록에서 게임의 주문 우선 순위입니다.", "example": 1, "type": "integer" }, "periods": { "$ref": "#/components/schemas/item-periods-response" }, "pre_order": { "description": "사전 판매 설정입니다.", "properties": { "description": { "description": "사전 판매에 대한 추가 정보는 이메일로 전송됩니다.", "type": [ "string", "null" ] }, "is_enabled": { "description": "비활성화된 경우 해당 아이템은 사전 판매 대상이 아닙니다.", "type": "boolean" }, "release_date": { "description": "ISO 8601 형식으로 된 게임 키 출시 날짜입니다.", "type": [ "string", "null" ] } }, "type": "object" }, "prices": { "description": "실제 통화 가격입니다.", "example": [ { "amount": 1299.99, "currency": "RUB", "is_default": true, "is_enabled": true } ], "items": { "properties": { "amount": { "example": 1299.99, "type": "number" }, "country_iso": { "description": "이 가격을 사용할 수 있는 국가입니다. [ISO 3166-1 alpha 2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)에 따른 2자리 글자 코드입니다.", "example": "US", "type": [ "string", "null" ] }, "currency": { "description": "아이템 가격 통화입니다. [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)에 따른 3자리 코드입니다.", "example": "RUB", "type": "string" }, "is_default": { "description": "기본 가격은 사용자 통화로 가격을 지정하지 않은 경우 카탈로그를 작성하는 데 사용됩니다.", "type": "boolean" }, "is_enabled": { "type": "boolean" } }, "type": "object" }, "type": "array" }, "regions": { "$ref": "#/components/schemas/Game-Keys_regions" }, "sku": { "description": "고유한 아이템 ID입니다. SKU는 소문자 및 대문자 라틴 영숫자, 마침표, 대시 및 밑줄만 포함할 수 있습니다.", "example": "game_1", "type": "string" }, "type": { "description": "아이템 유형입니다. 이 경우 항상 `game_key`입니다.", "example": "game_key", "type": "string" }, "virtual_prices": { "example": [ { "amount": 1000, "description": null, "image_url": "https://i.pinimg.com/originals/91/ae/56/91ae5683045f6dbef16b1482bade938f.png", "is_default": true, "name": { "en": "Gold" }, "sku": "com.xsolla.gold_1", "type": "virtual_currency" } ], "items": { "properties": { "amount": { "type": "number" }, "description": { "additionalProperties": true, "description": "게임 설명에 대한 현지화가 있는 개체입니다. 키는 ISO 3166-1에 따라 지정되어 있습니다.", "example": { "en": "Game 1 Example" }, "type": [ "object", "null" ] }, "image_url": { "description": "이미지 URL입니다.", "example": "https://image.example.com", "type": "string" }, "is_default": { "type": "boolean" }, "name": { "additionalProperties": true, "description": "인게임 재화의 이름에 대한 현지화가 있는 개체입니다. 키는 ISO 3166-1에 따라 지정되어 있습니다.", "example": { "en": "Gold" }, "type": "object" }, "sku": { "description": "고유한 아이템 ID입니다. SKU는 소문자 및 대문자 라틴 영숫자, 마침표, 대시 및 밑줄만 포함할 수 있습니다.", "example": "gold", "type": "string" }, "type": { "description": "아이템 유형입니다. 이 경우 항상 `virtual_currency`입니다.", "example": "virtual_currency", "type": "string" } }, "type": "object" }, "type": [ "array", "null" ] } }, "type": "object" }, "type": "array" } }, "type": "object" }, "type": "array" } }, "type": "object" } } }, "description": "게임 목록을 성공적으로 수신했습니다." }, "Game-Keys_200-get-codes": { "content": { "text/plain": { "examples": { "response": { "value": "PIN-CODE-ALL PIN-CODE-ALL-3" } }, "schema": { "example": "PIN-CODE-ALL PIN-CODE-ALL-3", "type": "string" } } }, "description": "코드를 성공적으로 수신했습니다." }, "Game-Keys_200-get-drm-list": { "content": { "application/json": { "examples": { "response": { "value": { "drm": [ { "drm_id": 1, "image": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png", "link": "https://support.steampowered.com", "name": "Steam", "redeem_instruction_link": "https://support.steampowered.com", "sku": "steam_key_1" }, { "drm_id": 2, "image": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png", "link": null, "name": "Playstation", "redeem_instruction_link": "https://support.us.playstation.com", "sku": "playstation_key_1" } ] } } }, "schema": { "description": "게임이 있는 개체입니다.", "properties": { "drm": { "example": [ { "drm_id": 1, "image": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png", "link": "https://support.steampowered.com", "name": "Steam", "redeem_instruction_link": "https://support.steampowered.com", "sku": "steam_key_1" }, { "drm_id": 2, "image": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png", "link": null, "name": "Playstation", "redeem_instruction_link": "https://support.us.playstation.com", "sku": "playstation_key_1" } ], "items": { "properties": { "drm_id": { "description": "DRM ID입니다.", "example": 1, "type": "number" }, "image": { "description": "이미지 URL입니다.", "example": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png", "type": "string" }, "link": { "description": "링크를 사용합니다.", "example": "https://support.us.playstation.com", "type": [ "string", "null" ] }, "name": { "description": "DRM 이름입니다.", "example": "Steam", "type": "string" }, "redeem_instruction_link": { "description": "사용 지침 링크를 사용합니다.", "example": "https://support.us.playstation.com", "type": "string" }, "sku": { "description": "고유한 DRM ID입니다. SKU는 소문자 및 대문자 라틴 영숫자, 마침표, 대시 및 밑줄만 포함할 수 있습니다.", "example": "steam", "type": "string" } }, "type": "object" }, "type": "array" } }, "type": "object" } } }, "description": "DRM 목록을 성공적으로 수신했습니다." }, "Game-Keys_200-get-game-keys-by-group-catalog": { "content": { "application/json": { "examples": { "response": { "value": { "has_more": true, "items": [ { "attributes": [ { "external_id": "OS", "name": "OS", "values": [ { "external_id": "9d5c5efb7c0f00a00fe4e3583f1215b0050bc723", "value": "Windows" } ] }, { "external_id": "genre", "name": "Genre", "values": [ { "external_id": "23fda05111c125608af8f1fa0e99db45a10ea1cc", "value": "Horror" } ] } ], "description": "Game description", "drm_name": "Steam", "drm_sku": "steam_key_1", "groups": [ { "external_id": "all", "item_order_in_group": 2, "name": "All games" }, { "external_id": "Xsolla", "item_order_in_group": 1, "name": "Xsolla games" } ], "has_keys": true, "image_url": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png", "is_free": false, "is_pre_order": true, "name": "Game name", "periods": [ { "date_from": "2020-08-11T10:00:00+03:00", "date_until": "2020-08-11T20:00:00+03:00" } ], "price": { "amount": "30.5", "amount_without_discount": "30.5", "currency": "USD" }, "release_date": "2020-08-11T10:00:00+03:00", "sku": "com.xsolla.game_1", "type": "game_key", "virtual_prices": [] }, { "attributes": [ { "external_id": "OS", "name": "OS", "values": [ { "external_id": "9d5c5efb7c0f00a00fe4e3583f1215b0050bc723", "value": "Windows" } ] }, { "external_id": "genre", "name": "Genre", "values": [ { "external_id": "23fda05111c125608af8f1fa0e99db45a10ea1cc", "value": "Horror" } ] } ], "description": "Game description", "drm_name": "Steam", "drm_sku": "steam_key_2", "groups": [ { "external_id": "all", "item_order_in_group": 1, "name": "All games" } ], "has_keys": true, "image_url": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png", "is_free": false, "is_pre_order": false, "name": "Game name", "periods": [], "price": { "amount": "30.5", "amount_without_discount": "30.5", "currency": "USD" }, "release_date": null, "sku": "com.xsolla.game_2", "type": "game_key", "virtual_prices": [] } ] } } }, "schema": { "description": "게임이 있는 개체입니다.", "properties": { "has_more": { "$ref": "#/components/schemas/Pagination_has-more" }, "items": { "example": [ { "attributes": [ { "external_id": "OS", "name": "OS", "values": [ { "external_id": "9d5c5efb7c0f00a00fe4e3583f1215b0050bc723", "value": "Windows" } ] }, { "external_id": "genre", "name": "Genre", "values": [ { "external_id": "23fda05111c125608af8f1fa0e99db45a10ea1cc", "value": "Horror" } ] } ], "description": "Game description", "drm_name": "Steam", "drm_sku": "steam_key_1", "groups": [ { "external_id": "all", "name": "All games" }, { "external_id": "Xsolla", "name": "Xsolla games" } ], "has_keys": true, "image_url": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png", "is_free": false, "is_pre_order": true, "name": "Game name", "periods": [ { "date_from": "2020-08-11T10:00:00+03:00", "date_until": "2020-08-11T20:00:00+03:00" } ], "price": { "amount": "30.5", "amount_without_discount": "30.5", "currency": "USD" }, "release_date": "2020-08-11T10:00:00+03:00", "sku": "com.xsolla.game_1", "type": "game_key", "virtual_prices": [] }, { "attributes": [ { "external_id": "OS", "name": "OS", "values": [ { "external_id": "9d5c5efb7c0f00a00fe4e3583f1215b0050bc723", "value": "Windows" } ] }, { "external_id": "genre", "name": "Genre", "values": [ { "external_id": "23fda05111c125608af8f1fa0e99db45a10ea1cc", "value": "Horror" } ] } ], "description": "Game description", "drm_name": "Steam", "drm_sku": "steam_key_2", "groups": [ { "external_id": "all", "name": "All games" } ], "has_keys": true, "image_url": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png", "is_free": false, "is_pre_order": false, "name": "Game name", "periods": [], "price": { "amount": "30.5", "amount_without_discount": "30.5", "currency": "USD" }, "release_date": null, "sku": "com.xsolla.game_2", "type": "game_key", "virtual_prices": [] } ], "items": { "properties": { "attributes": { "$ref": "#/components/schemas/Game-Keys_schemas-client-attributes" }, "description": { "description": "아이템 설명입니다.", "example": "Game description", "type": "string" }, "drm_name": { "description": "DRM 이름입니다.", "example": "Steam", "type": "string" }, "drm_sku": { "description": "고유한 DRM ID입니다. SKU는 소문자 및 대문자 라틴 영숫자, 마침표, 대시 및 밑줄만 포함할 수 있습니다.", "example": "steam", "type": "string" }, "groups": { "$ref": "#/components/schemas/items_client_groups_response" }, "has_keys": { "description": "`true`인 경우 게임 키에 판매용 키가 있습니다.", "example": false, "type": "boolean" }, "image_url": { "description": "이미지 URL입니다.", "example": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png", "type": "string" }, "is_free": { "$ref": "#/components/schemas/value-is_free" }, "is_pre_order": { "description": "`true`인 경우 사전 판매 게임 키이며 출시 날짜가 전달되지 않은 상태입니다.", "example": true, "type": "boolean" }, "name": { "description": "아이템 이름입니다.", "example": "Game name", "type": "string" }, "periods": { "$ref": "#/components/schemas/item-periods-response" }, "price": { "description": "아이템 가격입니다.", "properties": { "amount": { "description": "할인된 아이템 가격입니다.", "example": "2.9900", "type": "string" }, "amount_without_discount": { "description": "아이템 가격입니다.", "example": "2.9900", "type": "string" }, "currency": { "description": "아이템 가격 통화입니다. [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)에 따른 3자리 코드입니다.", "example": "USD", "type": "string" } }, "type": "object" }, "release_date": { "description": "ISO 8601 형식으로 된 게임 키 출시 날짜입니다.", "example": "2020-08-11T10:00:00+03:00", "type": [ "string", "null" ] }, "sku": { "description": "고유한 아이템 ID입니다. SKU는 소문자 및 대문자 라틴 영숫자, 마침표, 대시 및 밑줄만 포함할 수 있습니다.", "example": "game_01", "type": "string" }, "type": { "description": "아이템의 유형: `game_key`.", "example": "game_key", "type": "string" }, "virtual_prices": { "description": "가상 가격입니다.", "items": { "description": "가상 가격입니다.", "properties": { "amount": { "description": "인게임 재화로 표시된 할인된 아이템 가격입니다.", "example": 100, "type": "integer" }, "amount_without_discount": { "description": "아이템 가격입니다.", "example": 200, "type": "integer" }, "description": { "description": "인게임 재화 설명입니다.", "example": "Big Rocket - description", "type": "string" }, "image_url": { "description": "인게임 재화의 이미지입니다.", "example": "http://image.png", "type": "string" }, "is_default": { "description": "아이템의 가격이 기본값인지 여부입니다.", "example": true, "type": "boolean" }, "name": { "description": "인게임 재화 이름입니다.", "example": "SHOTGUN FOR TRUE RAIDERS", "type": "string" }, "sku": { "description": "인게임 재화 아이템 SKU입니다.", "example": "vc_test", "type": "string" }, "type": { "description": "인게임 재화 유형입니다.", "example": "virtual_currency", "type": "string" } }, "type": "object" }, "type": "array" } }, "type": "object" }, "type": "array" } }, "type": "object" } } }, "description": "게임 키 목록을 성공적으로 수신했습니다." }, "Game-Keys_200-get-games-catalog": { "content": { "application/json": { "examples": { "response": { "value": { "has_more": false, "items": [ { "attributes": [ { "external_id": "genre", "name": "Genre", "values": [ { "external_id": "23fda05111c125608af8f1fa0e99db45a10ea1cc", "value": "Horror" } ] } ], "description": "Game description", "groups": [ { "external_id": "all", "item_order_in_group": 2, "name": "All games" }, { "external_id": "Xsolla", "item_order_in_group": 1, "name": "Xsolla games" } ], "image_url": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png", "name": "Game name", "promotions": [], "sku": "com.xsolla.game_1", "type": "unit", "unit_items": [ { "can_be_bought": true, "drm_name": "Steam", "drm_sku": "steam_key_1", "has_keys": true, "is_free": false, "is_pre_order": true, "periods": [ { "date_from": "2020-08-11T10:00:00+03:00", "date_until": "2020-08-11T20:00:00+03:00" } ], "price": { "amount": "30.5", "amount_without_discount": "30.5", "currency": "USD" }, "release_date": "2020-08-11T10:00:00+03:00", "sku": "com.xsolla.game_key_01", "type": "game_key", "virtual_prices": [], "vp_rewards": [ { "amount": 130, "image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg", "item_id": 175232, "name": "Value point", "sku": "com.xsolla.value_point_1" }, { "amount": 50, "image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg", "is_clan": true, "item_id": 186321, "name": "Clan Reward VP 1", "sku": "com.xsolla.clan_value_point_1" } ] }, { "can_be_bought": true, "drm_name": "Origin", "drm_sku": "origin_key_1", "has_keys": false, "is_free": false, "is_pre_order": false, "periods": [], "price": { "amount": "30.5", "amount_without_discount": "30.5", "currency": "USD" }, "release_date": null, "sku": "com.xsolla.game_key_02", "type": "game_key", "virtual_prices": [], "vp_rewards": [] } ], "unit_type": "game" }, { "attributes": [ { "external_id": "OS", "name": "OS", "values": [ { "external_id": "9d5c5efb7c0f00a00fe4e3583f1215b0050bc723", "value": "Windows" } ] } ], "description": "Game description", "groups": [ { "external_id": "all", "item_order_in_group": 1, "name": "All games" } ], "image_url": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png", "name": "Game name", "promotions": [], "sku": "com.xsolla.game_2", "type": "unit", "unit_items": [ { "can_be_bought": true, "drm_name": "Steam", "drm_sku": "steam_key_1", "has_keys": false, "is_free": false, "is_pre_order": false, "periods": [ { "date_from": "2020-08-11T20:00:00+03:00", "date_until": null } ], "price": { "amount": "30.5", "amount_without_discount": "30.5", "currency": "USD" }, "release_date": null, "sku": "com.xsolla.game_key_01", "type": "game_key", "virtual_prices": [], "vp_rewards": [] } ], "unit_type": "game" } ] } } }, "schema": { "description": "게임이 있는 개체입니다.", "properties": { "has_more": { "$ref": "#/components/schemas/Pagination_has-more" }, "items": { "example": [ { "attributes": [ { "external_id": "genre", "name": "Genre", "values": [ { "external_id": "23fda05111c125608af8f1fa0e99db45a10ea1cc", "value": "Horror" } ] } ], "description": "Game description", "groups": [ { "external_id": "all", "name": "All games" }, { "external_id": "Xsolla", "name": "Xsolla games" } ], "image_url": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png", "name": "Game name", "promotions": [], "sku": "com.xsolla.game_1", "type": "unit", "unit_items": [ { "can_be_bought": true, "drm_name": "Steam", "drm_sku": "steam_key_1", "has_keys": true, "is_free": false, "is_pre_order": true, "periods": [ { "date_from": "2020-08-11T10:00:00+03:00", "date_until": "2020-08-11T20:00:00+03:00" } ], "price": { "amount": "30.5", "amount_without_discount": "30.5", "currency": "USD" }, "promotions": [], "release_date": "2020-08-11T10:00:00+03:00", "sku": "com.xsolla.game_key_01", "type": "game_key", "virtual_prices": [] }, { "can_be_bought": true, "drm_name": "Origin", "drm_sku": "origin_key_1", "has_keys": false, "is_free": false, "is_pre_order": false, "periods": [], "price": { "amount": "30.5", "amount_without_discount": "30.5", "currency": "USD" }, "promotions": [], "release_date": null, "sku": "com.xsolla.game_key_02", "type": "game_key", "virtual_prices": [] } ], "unit_type": "game" }, { "attributes": [ { "external_id": "OS", "name": "OS", "values": [ { "external_id": "9d5c5efb7c0f00a00fe4e3583f1215b0050bc723", "value": "Windows" } ] } ], "description": "Game description", "groups": [ { "external_id": "all", "name": "All games" } ], "image_url": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png", "name": "Game name", "promotions": [], "sku": "com.xsolla.game_2", "type": "unit", "unit_items": [ { "can_be_bought": true, "drm_name": "Steam", "drm_sku": "steam_key_2", "has_keys": false, "is_free": false, "is_pre_order": false, "periods": [ { "date_from": null, "date_until": "2020-08-11T20:00:00+03:00" } ], "price": { "amount": "30.5", "amount_without_discount": "30.5", "currency": "USD" }, "promotions": [], "release_date": null, "sku": "com.xsolla.game_key_01", "type": "game_key", "virtual_prices": [] } ], "unit_type": "game" } ], "items": { "properties": { "attributes": { "$ref": "#/components/schemas/Game-Keys_schemas-client-attributes" }, "description": { "description": "아이템 설명입니다.", "example": "Game description", "type": "string" }, "groups": { "$ref": "#/components/schemas/items_client_groups_response" }, "image_url": { "description": "이미지 URL입니다.", "example": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png", "type": "string" }, "name": { "description": "아이템 이름입니다.", "example": "Game name", "type": "string" }, "promotions": { "$ref": "#/components/schemas/Catalog_item_promotions" }, "sku": { "description": "고유한 아이템 ID입니다. SKU는 소문자 및 대문자 라틴 영숫자, 마침표, 대시 및 밑줄만 포함할 수 있습니다.", "example": "game_01", "type": "string" }, "type": { "description": "아이템의 유형: `virtual_good`/`virtual_currency`/`bundle`/`physical_good`/`unit`.", "example": "unit", "type": "string" }, "unit_items": { "items": { "properties": { "can_be_bought": { "$ref": "#/components/schemas/Can_be_bought" }, "drm_name": { "description": "DRM 이름입니다.", "example": "Steam", "type": "string" }, "drm_sku": { "description": "고유한 DRM ID입니다. SKU는 소문자 및 대문자 라틴 영숫자, 마침표, 대시 및 밑줄만 포함할 수 있습니다.", "example": "steam", "type": "string" }, "has_keys": { "description": "`true`인 경우 게임 키에 판매용 키가 있습니다.", "example": false, "type": "boolean" }, "is_free": { "$ref": "#/components/schemas/value-is_free" }, "is_pre_order": { "description": "`true`인 경우 사전 판매 게임 키이며 출시 날짜가 전달되지 않은 상태입니다.", "example": true, "type": "boolean" }, "periods": { "$ref": "#/components/schemas/item-periods" }, "price": { "description": "아이템 가격입니다.", "properties": { "amount": { "description": "할인된 아이템 가격입니다.", "example": "2.9900", "type": "string" }, "amount_without_discount": { "description": "아이템 가격입니다.", "example": "2.9900", "type": "string" }, "currency": { "description": "아이템 가격 통화입니다. [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)에 따른 3자리 코드입니다.", "example": "USD", "type": "string" } }, "type": "object" }, "promotions": { "$ref": "#/components/schemas/Catalog_item_promotions" }, "release_date": { "description": "ISO 8601 형식으로 된 게임 키 출시 날짜입니다.", "example": "2020-08-11T10:00:00+03:00", "type": [ "string", "null" ] }, "sku": { "description": "고유한 아이템 ID입니다. SKU는 소문자 및 대문자 라틴 영숫자, 마침표, 대시 및 밑줄만 포함할 수 있습니다.", "example": "game_01", "type": "string" }, "type": { "description": "아이템의 유형: `game_key`.", "example": "game_key", "type": "string" }, "virtual_prices": { "description": "가상 가격입니다.", "items": { "description": "가상 가격입니다.", "properties": { "amount": { "description": "인게임 재화로 표시된 할인된 아이템 가격입니다.", "example": 100, "type": "integer" }, "amount_without_discount": { "description": "아이템 가격입니다.", "example": 200, "type": "integer" }, "description": { "description": "인게임 재화 설명입니다.", "example": "Big Rocket - description", "type": "string" }, "image_url": { "description": "인게임 재화의 이미지입니다.", "example": "http://image.png", "type": "string" }, "is_default": { "description": "아이템의 가격이 기본값인지 여부입니다.", "example": true, "type": "boolean" }, "name": { "description": "인게임 재화 이름입니다.", "example": "SHOTGUN FOR TRUE RAIDERS", "type": "string" }, "sku": { "description": "인게임 재화 아이템 SKU입니다.", "example": "vc_test", "type": "string" }, "type": { "description": "인게임 재화 유형입니다.", "example": "virtual_currency", "type": "string" } }, "type": "object" }, "type": "array" }, "vp_rewards": { "$ref": "#/components/schemas/client-item-value-point-reward" } }, "type": "object" }, "type": "array" }, "unit_type": { "description": "유닛의 유형: `game`.", "example": "game", "type": "string" } }, "type": "object" }, "type": "array" } }, "type": "object" } } }, "description": "게임 목록을 성공적으로 수신했습니다." }, "Game-Keys_200-session-information": { "content": { "application/json": { "examples": { "response": { "value": { "count_skipped": 10, "count_total": 100, "count_uploaded": 0, "session_id": "fc7105b6e8ee01339582970b37697242", "status": "processing" } } }, "schema": { "properties": { "count_skipped": { "example": 10, "type": "integer" }, "count_total": { "example": 100, "type": "integer" }, "count_uploaded": { "example": 0, "type": "integer" }, "session_id": { "example": "fc7105b6e8ee01339582970b37697242", "type": "string" }, "status": { "example": "processing", "type": "string" } }, "type": "object" } } }, "description": "세션 정보를 로드하는 코드를 성공적으로 수신했습니다." }, "Game-Keys_200-user-entitlement-list": { "content": { "application/json": { "examples": { "response": { "value": { "has_more": false, "items": [ { "description": "Description of the greatest game in the world.", "drm": "drmfree", "game_sku": "com.xsolla.key_1", "image_url": "https://none", "is_pre_order": false, "name": "The Greatest Game in the World", "project_id": 30810 } ], "total_items_count": 1 } } }, "schema": { "description": "게임 정보가 있는 개체입니다.", "properties": { "has_more": { "$ref": "#/components/schemas/Pagination_has-more" }, "items": { "items": { "$ref": "#/components/schemas/Game-Keys_entitlement_item" }, "type": "array" }, "total_items_count": { "$ref": "#/components/schemas/Pagination_total-items-count" } }, "type": "object" } } }, "description": "사용자가 소유한 게임 키 목록을 성공적으로 수신했습니다." }, "Game-Keys_401-invalid-basic-auth": { "content": { "application/json": { "examples": { "response": { "value": { "errorCode": 1020, "errorMessage": "[0401-1020]: Error in Authentication method occurred", "statusCode": 401 } } }, "schema": { "properties": { "errorCode": { "example": 1020, "type": "integer" }, "errorMessage": { "example": "[0401-1020]: Error in Authentication method occurred", "type": "string" }, "statusCode": { "example": 401, "type": "integer" } }, "type": "object" } } }, "description": "기본 인증이 전달되지 않았거나 잘못되었습니다. 기본 인증 또는 올바른 자격 증명을 사용했는지 확인해야 합니다." }, "Game-Keys_403-auth-header-not-sent": { "content": { "application/json": { "examples": { "response": { "value": { "errorCode": 0, "errorMessage": "Authorization header not sent", "statusCode": 403 } } }, "schema": { "properties": { "errorCode": { "example": 0, "type": "integer" }, "errorMessage": { "example": "Authorization header not sent.", "type": "string" }, "statusCode": { "example": 403, "type": "integer" }, "transactionId": { "example": "x-x-x-x-transactionId-mock-x-x-x", "type": "string" } }, "type": "object" } } }, "description": "인증 헤더가 전송되지 않았습니다." }, "Game-Keys_422-invalid-request": { "content": { "application/json": { "examples": { "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" }, "The property `drm_sku` is required": { "value": { "errorCode": 1102, "errorMessage": "[0401-1102]: Unprocessable Entity. The property `drm_sku` is required", "statusCode": 422 } }, "Value limit exceeded": { "$ref": "#/components/examples/422-value-limit-exceeded" } }, "schema": { "$ref": "#/components/schemas/Game-Keys_422-invalid-request" } } }, "description": "잘못된 요청입니다." }, "ItemGroup_200-admin-get-group": { "content": { "application/json": { "examples": { "response": { "$ref": "#/components/examples/200-admin-get-group" } }, "schema": { "$ref": "#/components/schemas/admin-group-response-base" } } }, "description": "Item group was successfully retrieved." }, "ItemGroup_200-admin-get-group-by-item-type": { "content": { "application/json": { "examples": { "response": { "$ref": "#/components/examples/200-admin-get-group-by-item-type" } }, "schema": { "$ref": "#/components/schemas/admin-group-detail-response-by-item-type" } } }, "description": "Item group was successfully retrieved, with `items_count` filtered by the specified item type." }, "ItemGroup_200-admin-get-group-list": { "content": { "application/json": { "examples": { "response": { "$ref": "#/components/examples/200-admin-get-group-list" } }, "schema": { "properties": { "groups": { "items": { "$ref": "#/components/schemas/admin-group-response-base" }, "type": "array" } }, "type": "object" } } }, "description": "Item groups list was successfully retrieved." }, "ItemGroup_200-admin-get-group-list-by-item-type": { "content": { "application/json": { "examples": { "response": { "$ref": "#/components/examples/200-admin-get-group-list-by-item-type" } }, "schema": { "properties": { "groups": { "items": { "$ref": "#/components/schemas/admin-group-response-by-item-type" }, "type": "array" } }, "type": "object" } } }, "description": "Item group list was successfully retrieved. `items_count` field includes only items of the specified type." }, "ItemGroup_201-admin-create-group": { "content": { "application/json": { "examples": { "response": { "$ref": "#/components/examples/201-admin-create-group" } }, "schema": { "properties": { "external_id": { "description": "External item group ID specified during creation.", "example": "weapons", "type": "string" } }, "type": "object" } } }, "description": "Item group was successfully created." }, "ItemGroup_204-admin-delete-group": { "description": "Item group was successfully deleted." }, "ItemGroup_204-admin-reorder-groups": { "description": "Item groups were successfully reordered." }, "ItemGroup_204-admin-reorder-items": { "description": "Items within the group were successfully reordered." }, "ItemGroup_204-admin-update-group": { "description": "Item group was successfully updated." }, "ItemGroup_401-invalid-basic-auth": { "content": { "application/json": { "examples": { "response": { "value": { "errorCode": 1020, "errorMessage": "[0401-1020]: Error in Authentication method occurred", "statusCode": 401, "transactionId": "x-x-x-x-transactionId-mock-x-x-x" } } }, "schema": { "$ref": "#/components/schemas/error-response-base" } } }, "description": "Basic authentication failed or invalid credentials were provided. Ensure that you use basic authentication and correct credentials." }, "ItemGroup_404-group-not-found": { "content": { "application/json": { "examples": { "Group not found by ID": { "value": { "errorCode": 4403, "errorMessage": "[0401-4403]: Group with id in (99) and projectId = 123 not found", "errorMessageExtended": { "group_id_list": [ 99 ], "project_id": 123 }, "statusCode": 404, "transactionId": "x-x-x-x-transactionId-mock-x-x-x" } }, "Group not found by external_id": { "value": { "errorCode": 4403, "errorMessage": "[0401-4403]: Group with external id = 'weapons' not found", "errorMessageExtended": { "external_id_list": [ "weapons" ], "project_id": 123 }, "statusCode": 404, "transactionId": "x-x-x-x-transactionId-mock-x-x-x" } }, "Items or group not found (reorder endpoints)": { "value": { "errorCode": 4403, "errorMessage": "[0401-4403]: Items or group were not found.", "errorMessageExtended": {}, "statusCode": 404, "transactionId": "x-x-x-x-transactionId-mock-x-x-x" } } }, "schema": { "allOf": [ { "$ref": "#/components/schemas/error-response-base" }, { "properties": { "errorMessageExtended": { "description": "IDs used in the failed lookup.", "properties": { "external_id_list": { "description": "List of group `external_id` used in the lookup request.", "items": { "type": "string" }, "type": "array" }, "group_id_list": { "description": "List of group `id` used in the lookup request.", "items": { "type": "integer" }, "type": "array" }, "project_id": { "description": "Project ID used in the lookup request.", "type": "integer" } }, "type": [ "object", "null" ] } }, "type": "object" } ] } } }, "description": "Item group not found. Returned if the group with the specified `external_id` does not exist or belongs to another project." }, "ItemGroup_404-reorder-groups-not-found": { "content": { "application/json": { "examples": { "Group not found by ID": { "value": { "errorCode": 4403, "errorMessage": "[0401-4403]: Group with id in (99) and projectId = 123 not found", "errorMessageExtended": { "group_id_list": [ 99 ], "project_id": 123 }, "statusCode": 404, "transactionId": "x-x-x-x-transactionId-mock-x-x-x" } }, "Group not found by external_id": { "value": { "errorCode": 4403, "errorMessage": "[0401-4403]: Group with external id = 'weapons' not found", "errorMessageExtended": { "external_id_list": [ "weapons" ], "project_id": 123 }, "statusCode": 404, "transactionId": "x-x-x-x-transactionId-mock-x-x-x" } } }, "schema": { "allOf": [ { "$ref": "#/components/schemas/error-response-base" }, { "properties": { "errorMessageExtended": { "description": "IDs used in the failed lookup.", "properties": { "external_id_list": { "description": "List of group `external_id` used in the lookup request.", "items": { "type": "string" }, "type": "array" }, "group_id_list": { "description": "List of group `id` used in the lookup request.", "items": { "type": "integer" }, "type": "array" }, "project_id": { "description": "Project ID used in the lookup request.", "type": "integer" } }, "type": [ "object", "null" ] } }, "type": "object" } ] } } }, "description": "Item group not found. Returned if the group with the specified `id` or `external_id` does not exist or belongs to another project." }, "ItemGroup_404-reorder-items-by-external-id-not-found": { "content": { "application/json": { "examples": { "Items or group not found": { "value": { "errorCode": 4403, "errorMessage": "[0401-4403]: Items or group were not found.", "errorMessageExtended": {}, "statusCode": 404, "transactionId": "x-x-x-x-transactionId-mock-x-x-x" } } }, "schema": { "allOf": [ { "$ref": "#/components/schemas/error-response-base" }, { "properties": { "errorMessageExtended": { "description": "IDs used in the failed lookup.", "properties": { "external_id_list": { "description": "List of group `external_id` used in the lookup request.", "items": { "type": "string" }, "type": "array" }, "project_id": { "description": "Project ID used in the lookup request.", "type": "integer" } }, "type": [ "object", "null" ] } }, "type": "object" } ] } } }, "description": "Item group or items not found. Returned if the group with the specified `external_id` doesn't exist or belongs to another project, or if one or more `item_id` were not found in the group." }, "ItemGroup_404-reorder-items-by-id-not-found": { "content": { "application/json": { "examples": { "Items or group not found": { "value": { "errorCode": 4403, "errorMessage": "[0401-4403]: Items or group were not found.", "errorMessageExtended": {}, "statusCode": 404, "transactionId": "x-x-x-x-transactionId-mock-x-x-x" } } }, "schema": { "allOf": [ { "$ref": "#/components/schemas/error-response-base" }, { "properties": { "errorMessageExtended": { "description": "IDs used in the failed lookup.", "properties": { "group_id_list": { "description": "List of group `id` used in the lookup request.", "items": { "type": "integer" }, "type": "array" }, "project_id": { "description": "Project ID used in the lookup request.", "type": "integer" } }, "type": [ "object", "null" ] } }, "type": "object" } ] } } }, "description": "Item group or items not found. Returned if the group with the specified `id` does not exist or belongs to another project, or if one or more `item_id` were not found in the group." }, "ItemGroup_422-create-update": { "content": { "application/json": { "examples": { "Group already exists": { "value": { "errorCode": 4401, "errorMessage": "[0401-4401]: Item group already exists", "statusCode": 422, "transactionId": "x-x-x-x-transactionId-mock-x-x-x" } }, "Group cannot be its own parent": { "value": { "errorCode": 4404, "errorMessage": "[0401-4404]: Group can't be self parent", "statusCode": 422, "transactionId": "x-x-x-x-transactionId-mock-x-x-x" } }, "Reserved external_id value": { "value": { "errorCode": 4516, "errorMessage": "[0401-4516]: Value 'tools' not allowed to be used for the property 'external_id'.", "statusCode": 422, "transactionId": "x-x-x-x-transactionId-mock-x-x-x" } }, "The property `external_id` is required": { "$ref": "#/components/examples/422-property-external-id-required" } }, "schema": { "$ref": "#/components/schemas/422-invalid-request" } } }, "description": "The request cannot be processed. Returned for validation errors or if the data violates system rules." }, "ItemGroup_422-delete": { "content": { "application/json": { "examples": { "Cannot delete group with items": { "value": { "errorCode": 4402, "errorMessage": "[0401-4402]: Item group with items cannot be deleted.", "statusCode": 422, "transactionId": "x-x-x-x-transactionId-mock-x-x-x" } } }, "schema": { "$ref": "#/components/schemas/422-invalid-request" } } }, "description": "The request cannot be processed. Cannot delete a group that contains items." }, "ItemGroup_422-ordering": { "content": { "application/json": { "examples": { "Invalid request body": { "value": { "errorCode": 1102, "errorMessage": "[0401-1102]: Unprocessable Entity", "errorMessageExtended": [ { "message": "Object value found, but an array is required", "property": "" } ], "statusCode": 422, "transactionId": "x-x-x-x-transactionId-mock-x-x-x" } } }, "schema": { "$ref": "#/components/schemas/422-invalid-request" } } }, "description": "The request cannot be processed. Request body failed validation." }, "Virtual-Items-Currency_200-admin-get-item": { "content": { "application/json": { "example": { "attributes": [ { "external_id": "attr_1", "name": { "en-US": "OK" }, "values": [ { "external_id": "val1", "value": { "en-US": "VALUE" } }, { "external_id": "val2", "value": { "en-US": "VALUE2" } } ] } ], "custom_attributes": { "attr": "value", "purchased": 0 }, "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" }, "groups": [ { "external_id": "accessory", "name": { "en": "accessory" } }, { "external_id": "weapon", "name": { "en": "weapon" } } ], "image_url": "https://cdn.xsolla.net/img/misc/images/8ab44fe99038a56de01950ba4a971b77.png", "is_enabled": true, "is_free": false, "is_paid_randomized_reward": true, "is_show_in_store": true, "limits": { "per_item": null, "per_user": { "limit_exceeded_visibility": "show", "total": 5 }, "recurrent_schedule": { "per_user": { "displayable_reset_next_date": "2023-02-28T11:00:00+08:00", "displayable_reset_start_date": "2023-02-28T11:00:00+08:00", "interval_type": "daily", "reset_next_date": 1677553200, "time": "11:00:00+08:00" } } }, "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" }, "media_list": [], "name": { "en": "Sword Xsolla Skin" }, "order": 1, "periods": [ { "date_from": "2020-08-11T10:00:00+03:00", "date_until": "2020-08-11T20:00:00+03:00" } ], "prices": [ { "amount": 4.99, "country_iso": "US", "currency": "USD", "is_default": true, "is_enabled": true } ], "regions": [], "sku": "com.xsolla.swords_1", "type": "virtual_good", "vc_prices": [] }, "schema": { "$ref": "#/components/schemas/Virtual-Items-Currency_admin-virtual-item" } } }, "description": "지정한 가상 아이템을 성공적으로 수신했습니다." }, "Virtual-Items-Currency_200-admin-get-virtual-currencies": { "content": { "application/json": { "example": { "items": [ { "attributes": [ { "external_id": "attr_1", "name": { "en-US": "OK" }, "values": [ { "external_id": "val1", "value": { "en-US": "VALUE" } }, { "external_id": "val2", "value": { "en-US": "VALUE2" } } ] } ], "custom_attributes": { "attr": "value", "purchased": 0 }, "description": { "en": "Main in-game currency" }, "groups": [], "image_url": "https://cdn3.xsolla.com/img/misc/images/da33ab6cc1d7e5899cfdc5b6b6180fad.png", "is_enabled": true, "is_free": false, "is_show_in_store": true, "limits": { "per_item": null, "per_user": { "limit_exceeded_visibility": "show", "total": 5 }, "recurrent_schedule": { "per_user": { "displayable_reset_next_date": "2023-02-28T11:00:00+08:00", "displayable_reset_start_date": "2023-02-28T11:00:00+08:00", "interval_type": "daily", "reset_next_date": 1677553200, "time": "11:00:00+08:00" } } }, "long_description": null, "media_list": [], "name": { "en": "Crystals", "ru": "Crystals" }, "order": 1, "periods": [ { "date_from": "2020-08-11T10:00:00+03:00", "date_until": "2020-08-11T20:00:00+03:00" } ], "prices": [ { "amount": 1, "country_iso": "US", "currency": "USD", "is_default": true, "is_enabled": true } ], "regions": [], "sku": "com.xsolla.crystal_1", "type": "virtual_currency", "vc_prices": [] }, { "attributes": [], "description": { "en": "Money for in-store purchases" }, "groups": [], "image_url": "https://cdn3.xsolla.com/img/misc/images/bc1bf2bdeca78515d5d15e545d6884be.png", "is_enabled": true, "is_free": false, "is_show_in_store": true, "limits": { "per_item": null, "per_user": null, "recurrent_schedule": null }, "long_description": null, "media_list": [], "name": { "en": "Gold", "ru": "Gold" }, "order": 1, "periods": [], "prices": [ { "amount": 1, "country_iso": "US", "currency": "USD", "is_default": true, "is_enabled": true } ], "regions": [], "sku": "com.xsolla.gold_1", "type": "virtual_currency", "vc_prices": [] } ] }, "schema": { "properties": { "items": { "items": { "$ref": "#/components/schemas/Virtual-Items-Currency_admin-virtual-currency" }, "type": "array" } }, "type": "object" } } }, "description": "인게임 재화 목록을 성공적으로 수신했습니다." }, "Virtual-Items-Currency_200-admin-get-virtual-currency": { "content": { "application/json": { "example": { "attributes": [ { "external_id": "attr_1", "name": { "en-US": "OK" }, "values": [ { "external_id": "val1", "value": { "en-US": "VALUE" } }, { "external_id": "val2", "value": { "en-US": "VALUE2" } } ] } ], "custom_attributes": { "attr": "value", "purchased": 0 }, "description": { "en": "Main in-game currency" }, "groups": [], "image_url": "https://cdn3.xsolla.com/img/misc/images/da33ab6cc1d7e5899cfdc5b6b6180fad.png", "is_enabled": true, "is_free": false, "is_paid_randomized_reward": false, "is_show_in_store": true, "limits": { "per_item": null, "per_user": null, "recurrent_schedule": null }, "long_description": null, "media_list": [], "name": { "en": "Crystals", "ru": "Crystals" }, "order": 1, "periods": [], "prices": [ { "amount": 1, "country_iso": "US", "currency": "USD", "is_default": true, "is_enabled": true } ], "regions": [], "sku": "com.xsolla.crystal_1", "type": "virtual_currency", "vc_prices": [] }, "schema": { "$ref": "#/components/schemas/Virtual-Items-Currency_admin-virtual-currency" } } }, "description": "지정한 인게임 재화를 성공적으로 수신했습니다." }, "Virtual-Items-Currency_200-admin-get-virtual-currency-package": { "content": { "application/json": { "example": { "attributes": [ { "external_id": "attr_1", "name": { "en-US": "OK" }, "values": [ { "external_id": "val1", "value": { "en-US": "VALUE" } }, { "external_id": "val2", "value": { "en-US": "VALUE2" } } ] } ], "bundle_type": "virtual_currency_package", "content": [ { "description": { "en": "Main in-game currency" }, "image_url": "https://cdn3.xsolla.com/img/misc/images/da33ab6cc1d7e5899cfdc5b6b6180fad.png", "name": { "en": "Crystals", "ru": "Crystals" }, "quantity": 100, "sku": "com.xsolla.crystal_1", "type": "virtual_currency" } ], "custom_attributes": { "attr": "value", "purchased": 0 }, "description": { "en": "Crystals x100" }, "groups": [], "image_url": "https://cdn3.xsolla.com/img/misc/images/a8682cea328afda0bd127d59eb5b9077.png", "is_enabled": true, "is_free": false, "is_paid_randomized_reward": true, "is_show_in_store": true, "limits": { "per_item": null, "per_user": null, "recurrent_schedule": null }, "long_description": null, "media_list": [], "name": { "en": "Small crystal pack" }, "order": 1, "periods": [], "prices": [ { "amount": 5, "country_iso": "US", "currency": "USD", "is_default": true, "is_enabled": true } ], "regions": [], "sku": "com.xsolla.crystal_pack_1", "type": "bundle", "vc_prices": [] }, "schema": { "$ref": "#/components/schemas/Virtual-Items-Currency_admin-virtual-currency-package" } } }, "description": "지정한 인게임 재화 패키지를 성공적으로 수신했습니다." }, "Virtual-Items-Currency_200-admin-get-virtual-currency-packages": { "content": { "application/json": { "example": { "items": [ { "attributes": [ { "external_id": "attr_1", "name": { "en-US": "OK" }, "values": [ { "external_id": "val1", "value": { "en-US": "VALUE" } }, { "external_id": "val2", "value": { "en-US": "VALUE2" } } ] } ], "bundle_type": "virtual_currency_package", "content": [ { "description": { "en": "Main in-game currency" }, "image_url": "https://cdn3.xsolla.com/img/misc/images/da33ab6cc1d7e5899cfdc5b6b6180fad.png", "name": { "en": "Crystals", "ru": "Crystals" }, "quantity": 100, "sku": "com.xsolla.crystal_1", "type": "virtual_currency" } ], "custom_attributes": { "attr": "value", "purchased": 0 }, "description": { "en": "Crystals x100" }, "groups": [], "image_url": "https://cdn3.xsolla.com/img/misc/images/a8682cea328afda0bd127d59eb5b9077.png", "is_enabled": true, "is_free": false, "is_show_in_store": true, "limits": { "per_item": null, "per_user": { "limit_exceeded_visibility": "show", "total": 5 }, "recurrent_schedule": { "per_user": { "displayable_reset_next_date": "2023-02-28T11:00:00+08:00", "displayable_reset_start_date": "2023-02-28T11:00:00+08:00", "interval_type": "daily", "reset_next_date": 1677553200, "time": "11:00:00+08:00" } } }, "long_description": null, "media_list": [], "name": { "en": "Small crystal pack" }, "order": 1, "periods": [ { "date_from": "2020-08-11T10:00:00+03:00", "date_until": "2020-08-11T20:00:00+03:00" } ], "prices": [ { "amount": 5, "country_iso": "US", "currency": "USD", "is_default": true, "is_enabled": true } ], "regions": [], "sku": "com.xsolla.crystal_pack_1", "type": "bundle", "vc_prices": [] }, { "attributes": [], "bundle_type": "virtual_currency_package", "content": [ { "description": { "en": "Main in-game currency" }, "image_url": "https://cdn3.xsolla.com/img/misc/images/da33ab6cc1d7e5899cfdc5b6b6180fad.png", "name": { "en": "Crystals", "ru": "Crystals" }, "quantity": 500, "sku": "com.xsolla.crystal_2", "type": "virtual_currency" } ], "description": { "en": "Crystals x500" }, "groups": [], "image_url": "https://cdn3.xsolla.com/img/misc/images/431a40dd8c99290dd761508964ddbacf.png", "is_enabled": true, "is_free": false, "is_show_in_store": true, "limits": { "per_item": null, "per_user": null, "recurrent_schedule": null }, "long_description": null, "media_list": [], "name": { "en": "Medium crystal pack" }, "order": 1, "periods": [ { "date_from": null, "date_until": "2020-08-11T20:00:00+03:00" } ], "prices": [ { "amount": 20, "country_iso": "US", "currency": "USD", "is_default": true, "is_enabled": true } ], "regions": [], "sku": "com.xsolla.crystal_pack_2", "type": "bundle", "vc_prices": [] }, { "attributes": [], "bundle_type": "virtual_currency_package", "content": [ { "description": { "en": "Main in-game currency" }, "image_url": "https://cdn3.xsolla.com/img/misc/images/da33ab6cc1d7e5899cfdc5b6b6180fad.png", "name": { "en": "Crystals", "ru": "Crystals" }, "quantity": 1500, "sku": "com.xsolla.crystal_3", "type": "virtual_currency" } ], "description": { "en": "Crystals x1500" }, "groups": [], "image_url": "https://cdn3.xsolla.com/img/misc/images/1d67a1d2f92d69e021a97effa692dff3.png", "is_enabled": true, "is_free": false, "is_show_in_store": true, "limits": { "per_item": null, "per_user": null, "recurrent_schedule": null }, "long_description": null, "media_list": [], "name": { "en": "Massive crystal pack" }, "order": 1, "periods": [], "prices": [ { "amount": 50, "country_iso": "US", "currency": "USD", "is_default": true, "is_enabled": true } ], "regions": [], "sku": "com.xsolla.crystal_pack_3", "type": "bundle", "vc_prices": [] }, { "attributes": [], "bundle_type": "virtual_currency_package", "content": [ { "description": { "en": "Money for in-store purchases" }, "image_url": "https://cdn3.xsolla.com/img/misc/images/bc1bf2bdeca78515d5d15e545d6884be.png", "name": { "en": "Gold", "ru": "Gold" }, "quantity": 100, "sku": "com.xsolla.gold_1", "type": "virtual_currency" } ], "description": { "en": "Gold x100" }, "groups": [], "image_url": "https://cdn3.xsolla.com/img/misc/images/09984ff0a3ae6b367c9c886b31366950.png", "is_enabled": true, "is_free": false, "is_show_in_store": true, "limits": { "per_item": null, "per_user": null, "recurrent_schedule": null }, "long_description": null, "media_list": [], "name": { "en": "Small gold pack" }, "order": 1, "periods": [], "prices": [ { "amount": 5, "country_iso": "US", "currency": "USD", "is_default": true, "is_enabled": true } ], "regions": [], "sku": "com.xsolla.gold_pack_1", "type": "bundle", "vc_prices": [] }, { "attributes": [ { "external_id": "attr_1", "name": { "en-US": "OK" }, "values": [ { "external_id": "val1", "value": { "en-US": "VALUE" } }, { "external_id": "val2", "value": { "en-US": "VALUE2" } } ] } ], "bundle_type": "virtual_currency_package", "content": [ { "description": { "en": "Money for in-store purchases" }, "image_url": "https://cdn3.xsolla.com/img/misc/images/bc1bf2bdeca78515d5d15e545d6884be.png", "name": { "en": "Gold", "ru": "Gold" }, "quantity": 500, "sku": "com.xsolla.gold_2", "type": "virtual_currency" } ], "description": { "en": "Gold x500" }, "groups": [], "image_url": "https://cdn3.xsolla.com/img/misc/images/b5d8130bdaf28aa55c43a68aa3ca0ef4.png", "is_enabled": true, "is_free": false, "is_show_in_store": true, "limits": { "per_item": null, "per_user": null, "recurrent_schedule": null }, "long_description": null, "media_list": [], "name": { "en": "Medium gold pack" }, "order": 1, "periods": [], "prices": [ { "amount": 20, "country_iso": "US", "currency": "USD", "is_default": true, "is_enabled": true } ], "regions": [], "sku": "com.xsolla.gold_pack_2", "type": "bundle", "vc_prices": [] }, { "attributes": [ { "external_id": "attr_1", "name": { "en-US": "OK" }, "values": [ { "external_id": "val1", "value": { "en-US": "VALUE" } }, { "external_id": "val2", "value": { "en-US": "VALUE2" } } ] } ], "bundle_type": "virtual_currency_package", "content": [ { "description": { "en": "Money for in-store purchases" }, "image_url": "https://cdn3.xsolla.com/img/misc/images/bc1bf2bdeca78515d5d15e545d6884be.png", "name": { "en": "Gold", "ru": "Gold" }, "quantity": 1500, "sku": "com.xsolla.gold_3", "type": "virtual_currency" } ], "description": { "en": "Gold x1500" }, "groups": [], "image_url": "https://cdn3.xsolla.com/img/misc/images/dea74a3667807d5502a4acb8f4c879ca.png", "is_enabled": true, "is_free": false, "is_show_in_store": true, "limits": { "per_item": null, "per_user": null, "recurrent_schedule": null }, "long_description": null, "media_list": [], "name": { "en": "Large gold pack" }, "order": 1, "periods": [], "prices": [ { "amount": 50, "country_iso": "US", "currency": "USD", "is_default": true, "is_enabled": true } ], "regions": [], "sku": "com.xsolla.gold_pack_3", "type": "bundle", "vc_prices": [] } ] }, "schema": { "properties": { "items": { "items": { "$ref": "#/components/schemas/Virtual-Items-Currency_admin-virtual-currency-package" }, "type": "array" } }, "type": "object" } } }, "description": "인게임 재화 패키지 목록을 성공적으로 수신했습니다." }, "Virtual-Items-Currency_200-admin-get-virtual-items": { "content": { "application/json": { "example": { "items": [ { "attributes": [ { "external_id": "attr_1", "name": { "en-US": "OK" }, "values": [ { "external_id": "val1", "value": { "en-US": "VALUE" } }, { "external_id": "val2", "value": { "en-US": "VALUE2" } } ] } ], "custom_attributes": { "attr": "value", "purchased": 0 }, "description": { "en": "Suit up with flair showcasing your allegiance to Xsolla" }, "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" } } ], "image_url": "https://cdn.xsolla.net/img/misc/images/5c3b8b45c5be5fe7803e59fbc8041be4.png", "is_enabled": true, "is_free": false, "is_show_in_store": true, "limits": { "per_item": null, "per_user": null, "recurrent_schedule": null }, "long_description": { "en": "The metal coverings formerly worn by soldiers or warriors to protect the body in battle." }, "media_list": [], "name": { "en": "Maximum Armor Xsolla Skin" }, "order": 1, "periods": [], "prices": [ { "amount": 12.99, "currency": "USD", "is_default": true, "is_enabled": true }, { "amount": 20.99, "country_iso": "CZ", "currency": "CZK", "is_default": false, "is_enabled": true } ], "regions": [], "sku": "com.xsolla.armor_max_1", "type": "virtual_good", "vc_prices": [] }, { "attributes": [], "description": { "en": "A strong armor forged to withstand heavy attacks." }, "groups": [ { "external_id": "all", "name": { "en": "Equipment" } }, { "external_id": "equipment", "name": { "en": "Nice Equipment" } }, { "external_id": "Empire", "name": { "en": "Empire" } } ], "image_url": "https://cdn.xsolla.net/img/misc/images/67d647ad4f4e9a905bd552b0408db8a8.png", "is_enabled": true, "is_free": false, "is_show_in_store": true, "limits": { "per_item": null, "per_user": { "limit_exceeded_visibility": "show", "total": 5 }, "recurrent_schedule": { "per_user": { "displayable_reset_next_date": "2023-02-28T11:00:00+08:00", "displayable_reset_start_date": "2023-02-28T11:00:00+08:00", "interval_type": "daily", "reset_next_date": 1677553200, "time": "11:00:00+08:00" } } }, "long_description": null, "media_list": [], "name": { "en": "Empire Maximum Armor" }, "order": 1, "periods": [ { "date_from": "2020-08-11T10:00:00+03:00", "date_until": "2020-08-11T20:00:00+03:00" } ], "prices": [ { "amount": 12.99, "currency": "USD", "is_default": true, "is_enabled": true }, { "amount": 20.99, "country_iso": "CZ", "currency": "CZK", "is_default": false, "is_enabled": true } ], "regions": [], "sku": "com.xsolla.armor_max_2", "type": "virtual_good", "vc_prices": [] }, { "attributes": [], "description": { "en": "Moderately protect yourself against the Empires barrage of attacks" }, "groups": [ { "external_id": "all", "name": { "en": "Equipment" } }, { "external_id": "Xsolla", "name": { "en": "Xsolla" } }, { "external_id": "equipment", "name": { "en": "Nice Equipment" } } ], "image_url": "https://cdn.xsolla.net/img/misc/images/7f6e216f8fcc3c1796162897c2b0db01.png", "is_enabled": true, "is_free": false, "is_show_in_store": false, "limits": { "per_item": null, "per_user": { "limit_exceeded_visibility": "show", "total": 5 }, "recurrent_schedule": { "per_user": { "displayable_reset_next_date": "2023-02-28T11:00:00+08:00", "displayable_reset_start_date": "2023-02-28T11:00:00+08:00", "interval_type": "daily", "reset_next_date": 1677553200, "time": "11:00:00+08:00" } } }, "long_description": { "en": "Armor is a security-as-a-service company that provides cloud security and compliance solutions for small businesses and enterprises." }, "media_list": [], "name": { "en": "Xsolla Medium Armor" }, "order": 1, "periods": [ { "date_from": null, "date_until": "2020-08-11T20:00:00+03:00" } ], "prices": [ { "amount": 4.99, "currency": "USD", "is_default": true, "is_enabled": true }, { "amount": 20.99, "country_iso": "CZ", "currency": "CZK", "is_default": false, "is_enabled": true } ], "regions": [], "sku": "com.xsolla.armor_med_1", "type": "virtual_good", "vc_prices": [] }, { "attributes": [ { "external_id": "attr_1", "name": { "en-US": "OK" }, "values": [ { "external_id": "val1", "value": { "en-US": "VALUE" } }, { "external_id": "val2", "value": { "en-US": "VALUE2" } } ] } ], "description": { "en": "Provides moderate protection in battle." }, "groups": [ { "external_id": "all", "name": { "en": "Equipment" } }, { "external_id": "equipment", "name": { "en": "Nice Equipment" } }, { "external_id": "Empire", "name": { "en": "Empire" } } ], "image_url": "https://cdn.xsolla.net/img/misc/images/737b4c93205dc774f47dda1f73037734.png", "is_enabled": true, "is_free": false, "is_show_in_store": true, "limits": { "per_item": { "available": 455, "reserved": 5, "sold": 40, "total": 500 }, "per_user": { "total": 5 }, "recurrent_schedule": { "per_user": { "displayable_reset_next_date": "2023-02-28T11:00:00+08:00", "displayable_reset_start_date": "2023-02-28T11:00:00+08:00", "interval_type": "daily", "reset_next_date": 1677553200, "time": "11:00:00+08:00" } } }, "long_description": { "en": "A strong armor forged to withstand heavy attacks." }, "media_list": [], "name": { "en": "Empire Medium Armor" }, "order": 1, "periods": [], "prices": [ { "amount": 4.99, "currency": "USD", "is_default": true, "is_enabled": true }, { "amount": 20.99, "currency": "CZK", "is_default": false, "is_enabled": true } ], "regions": [], "sku": "com.xsolla.armor_med_2", "type": "virtual_good", "vc_prices": [] }, { "attributes": [ { "external_id": "attr_1", "name": { "en-US": "OK" }, "values": [ { "external_id": "val1", "value": { "en-US": "VALUE" } }, { "external_id": "val2", "value": { "en-US": "VALUE2" } } ] } ], "description": { "en": "Provides moderate protection in battle." }, "groups": [ { "external_id": "all", "name": { "en": "Equipment" } }, { "external_id": "equipment", "name": { "en": "Nice Equipment" } }, { "external_id": "Empire", "name": { "en": "Empire" } } ], "image_url": "https://cdn.xsolla.net/img/misc/images/737b4c93205dc774f47dda1f73037734.png", "is_enabled": true, "is_free": false, "is_show_in_store": true, "limits": { "per_item": { "available": 455, "reserved": 5, "sold": 40, "total": 500 }, "per_user": { "total": 5 }, "recurrent_schedule": { "per_user": { "displayable_reset_next_date": "2023-02-28T11:00:00+08:00", "displayable_reset_start_date": "2023-02-28T11:00:00+08:00", "hours_interval": 8, "interval_type": "hourly", "reset_next_date": 1677553200, "time": "11:00:00+08:00" } } }, "long_description": null, "media_list": [], "name": { "en": "Empire Large Armor" }, "order": 1, "periods": [], "prices": [ { "amount": 4.99, "currency": "USD", "is_default": true, "is_enabled": true }, { "amount": 20.99, "currency": "CZK", "is_default": false, "is_enabled": true } ], "regions": [], "sku": "com.xsolla.armor_large_3", "type": "virtual_good", "vc_prices": [] } ] }, "schema": { "properties": { "items": { "items": { "$ref": "#/components/schemas/Virtual-Items-Currency_admin-virtual-item" }, "type": "array" } }, "type": "object" } } }, "description": "가상 아이템 목록을 성공적으로 수신했습니다." }, "Virtual-Items-Currency_200-admin-get-virtual-items-by-group": { "content": { "application/json": { "example": { "items": [ { "attributes": [], "custom_attributes": { "attr": "value", "purchased": 0 }, "description": { "en": "A strong armor forged to withstand heavy attacks" }, "groups": [ { "external_id": "weapons", "name": { "en": "Weapons" } }, { "external_id": "accessory", "name": { "en": "Accessory" } } ], "image_url": "https://cdn.xsolla.net/img/misc/images/67d647ad4f4e9a905bd552b0408db8a8.png", "is_enabled": true, "is_free": false, "is_show_in_store": true, "limits": { "per_item": null, "per_user": { "limit_exceeded_visibility": "show", "total": 5 }, "recurrent_schedule": { "per_user": { "day_of_month": 28, "day_of_week": null, "displayable_reset_next_date": "2023-03-28T11:00:00+08:00", "displayable_reset_start_date": "2023-02-28T11:00:00+08:00", "interval_type": "monthly", "reset_next_date": 1679972400, "time": "11:00:00+08:00" } } }, "long_description": null, "media_list": [], "name": { "en": "Empire Maximum Armor" }, "order": 1, "periods": [ { "date_from": "2020-08-11T10:00:00+03:00", "date_until": "2020-08-11T20:00:00+03:00" } ], "prices": [ { "amount": 12.99, "currency": "USD", "is_default": true, "is_enabled": true }, { "amount": 20.99, "country_iso": "CZ", "currency": "CZK", "is_default": false, "is_enabled": true } ], "regions": [], "sku": "com.xsolla.armor_max_2", "type": "virtual_good", "vc_prices": [] }, { "attributes": [], "description": { "en": "Moderately protect yourself against the Empires barrage of attacks" }, "groups": [ { "external_id": "weapons", "name": { "en": "Weapons" } }, { "external_id": "accessory", "name": { "en": "Accessory" } } ], "image_url": "https://cdn.xsolla.net/img/misc/images/7f6e216f8fcc3c1796162897c2b0db01.png", "is_enabled": true, "is_free": false, "is_show_in_store": false, "limits": { "per_item": null, "per_user": { "limit_exceeded_visibility": "show", "total": 5 }, "recurrent_schedule": { "per_user": { "displayable_reset_next_date": "2023-02-28T11:00:00+08:00", "displayable_reset_start_date": "2023-02-28T11:00:00+08:00", "interval_type": "daily", "reset_next_date": 1677553200, "time": "11:00:00+08:00" } } }, "long_description": { "en": "Armor is a security-as-a-service company that provides cloud security and compliance solutions for small businesses and enterprises." }, "media_list": [], "name": { "en": "Xsolla Medium Armor" }, "order": 1, "periods": [ { "date_from": null, "date_until": "2020-08-11T20:00:00+03:00" } ], "prices": [ { "amount": 4.99, "currency": "USD", "is_default": true, "is_enabled": true }, { "amount": 20.99, "country_iso": "CZ", "currency": "CZK", "is_default": false, "is_enabled": true } ], "regions": [], "sku": "com.xsolla.armor_med_1", "type": "virtual_good", "vc_prices": [] }, { "attributes": [ { "external_id": "attr_1", "name": { "en-US": "OK" }, "values": [ { "external_id": "val1", "value": { "en-US": "VALUE" } }, { "external_id": "val2", "value": { "en-US": "VALUE2" } } ] } ], "description": { "en": "Provides moderate protection in battle." }, "groups": [ { "external_id": "weapons", "name": { "en": "Weapons" } }, { "external_id": "accessory", "name": { "en": "Accessory" } } ], "image_url": "https://cdn.xsolla.net/img/misc/images/737b4c93205dc774f47dda1f73037734.png", "is_enabled": true, "is_free": false, "is_show_in_store": true, "limits": { "per_item": { "available": 455, "reserved": 5, "sold": 40, "total": 500 }, "per_user": { "limit_exceeded_visibility": "show", "total": 5 }, "recurrent_schedule": { "per_user": { "displayable_reset_next_date": "2023-02-28T11:00:00+08:00", "displayable_reset_start_date": "2023-02-28T11:00:00+08:00", "interval_type": "daily", "reset_next_date": 1677553200, "time": "11:00:00+08:00" } } }, "long_description": { "en": "A strong armor forged to withstand heavy attacks." }, "media_list": [], "name": { "en": "Empire Medium Armor" }, "order": 1, "periods": [], "prices": [ { "amount": 4.99, "currency": "USD", "is_default": true, "is_enabled": true }, { "amount": 20.99, "currency": "CZK", "is_default": false, "is_enabled": true } ], "regions": [], "sku": "com.xsolla.armor_med_2", "type": "virtual_good", "vc_prices": [] }, { "attributes": [ { "external_id": "attr_1", "name": { "en-US": "OK" }, "values": [ { "external_id": "val1", "value": { "en-US": "VALUE" } }, { "external_id": "val2", "value": { "en-US": "VALUE2" } } ] } ], "description": { "en": "Provides moderate protection in battle." }, "groups": [ { "external_id": "weapons", "name": { "en": "Weapons" } }, { "external_id": "accessory", "name": { "en": "Accessory" } } ], "image_url": "https://cdn.xsolla.net/img/misc/images/737b4c93205dc774f47dda1f73037734.png", "is_enabled": true, "is_free": false, "is_show_in_store": true, "limits": { "per_item": { "available": 455, "reserved": 5, "sold": 40, "total": 500 }, "per_user": { "limit_exceeded_visibility": "show", "total": 5 }, "recurrent_schedule": { "per_user": { "displayable_reset_next_date": "2023-02-28T11:00:00+08:00", "displayable_reset_start_date": "2023-02-28T11:00:00+08:00", "hours_interval": 8, "interval_type": "hourly", "reset_next_date": 1677553200, "time": "11:00:00+08:00" } } }, "long_description": { "en": "A strong armor forged to withstand heavy attacks." }, "media_list": [], "name": { "en": "Empire Large Armor" }, "order": 1, "periods": [], "prices": [ { "amount": 4.99, "currency": "USD", "is_default": true, "is_enabled": true }, { "amount": 20.99, "currency": "CZK", "is_default": false, "is_enabled": true } ], "regions": [], "sku": "com.xsolla.armor_lrg_2", "type": "virtual_good", "vc_prices": [] } ] }, "schema": { "properties": { "items": { "items": { "$ref": "#/components/schemas/Virtual-Items-Currency_admin-virtual-item" }, "type": "array" } }, "type": "object" } } }, "description": "가상 아이템 목록을 성공적으로 수신했습니다." }, "Virtual-Items-Currency_200-get-all-items-list": { "content": { "application/json": { "examples": { "response": { "value": { "items": [ { "description": "Big Rocket - description", "groups": [ { "external_id": "accessory", "name": { "en": "Accessory" } } ], "name": "Big Rocket", "sku": "com.xsolla.big_rocket_1" }, { "description": "description", "groups": [ { "external_id": "weapons", "name": { "en": "Weapons" } } ], "name": "SHOTGUN FOR TRUE RAIDERS", "sku": "com.xsolla.shotgun_raider_1" }, { "description": "description", "groups": [], "name": "SHOTGUN FOR TRUE RAIDERS", "sku": "com.xsolla.shotgun_raider_2" } ] } } }, "schema": { "description": "가상 아이템이 있는 개체입니다.", "properties": { "items": { "example": [ { "description": "Big Rocket - description", "groups": [ { "external_id": "accessory", "name": { "en": "accessory" } } ], "name": "Big Rocket", "sku": "com.xsolla.big_rocket_1" }, { "description": "description", "groups": [ { "external_id": "weapons", "name": { "en": "Weapons" } } ], "name": "SHOTGUN FOR TRUE RAIDERS", "sku": "com.xsolla.shotgun_raider_1" }, { "description": "description", "groups": [], "name": "SHOTGUN FOR TRUE RAIDERS", "sku": "com.xsolla.shotgun_raider_2" } ], "items": { "properties": { "description": { "description": "아이템 설명입니다.", "example": "Big Rocket - description", "type": "string" }, "groups": { "properties": { "external_id": { "example": "weapons", "type": "string" }, "name": { "additionalProperties": { "type": [ "string", "null" ] }, "type": "object" } }, "type": "array" }, "name": { "description": "아이템 이름입니다.", "example": "Big Rocket", "type": "string" }, "sku": { "description": "고유 아이템 ID입니다. SKU는 소문자 및 대문자 라틴 영숫자, 마침표, 대시 및 밑줄만 포함할 수 있습니다.", "example": "com.xsolla.big_rocket_1", "type": "string" } }, "type": "object" }, "type": "array" } }, "type": "object" } } }, "description": "모든 가상 아이템 목록을 성공적으로 수신했습니다." }, "Virtual-Items-Currency_200-get-item-by-sku": { "content": { "application/json": { "example": { "attributes": [ { "external_id": "attr_1", "name": { "en-US": "OK" }, "values": [ { "external_id": "val1", "value": "VALUE" }, { "external_id": "val2", "value": "VALUE2" } ] } ], "can_be_bought": true, "custom_attributes": { "attr": "value", "purchased": 0 }, "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" }, "groups": [ { "external_id": "weapons", "name": "weapons" } ], "image_url": "https://cdn.xsolla.net/img/misc/images/8ab44fe99038a56de01950ba4a971b77.png", "is_free": false, "item_id": 488833, "limits": { "per_item": null, "per_user": { "available": 1, "limit_exceeded_visibility": "show", "recurrent_schedule": { "interval_type": "weekly", "reset_next_date": 1761840000 }, "total": 3 } }, "name": { "en": "Sword Xsolla Skin" }, "periods": [ { "date_from": "2020-08-11T10:00:00+03:00", "date_until": "2020-08-11T20:00:00+03:00" } ], "price": { "amount": "4.99", "amount_without_discount": "4.99", "currency": "USD" }, "promotions": [], "sku": "com.xsolla.swords_1", "type": "virtual_good", "virtual_item_type": "non_consumable", "virtual_prices": [], "vp_rewards": [] }, "schema": { "$ref": "#/components/schemas/Virtual-Items-Currency_item" } } }, "description": "가상 아이템을 성공적으로 수신했습니다." }, "Virtual-Items-Currency_200-get-items-by-group-id": { "content": { "application/json": { "examples": { "response": { "value": { "has_more": false, "items": [ { "attributes": [ { "external_id": "stack_size", "name": { "en": "Stack size" }, "values": [ { "external_id": "size_e3364991f92e751689a68b96598a5a5a84010b85", "value": "5" } ] } ], "can_be_bought": true, "custom_attributes": { "attr": "value", "purchased": 0 }, "description": "Big Rocket - description", "groups": [ { "external_id": "weapons", "item_order_in_group": 1, "name": "weapons" } ], "image_url": "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png", "is_free": false, "limits": { "per_user": { "available": 3, "limit_exceeded_visibility": "show", "recurrent_schedule": { "interval_type": "weekly", "reset_next_date": 1746057600 }, "total": 5 } }, "name": "Big Rocket", "periods": [ { "date_from": "2020-08-11T10:00:00+03:00", "date_until": "2020-08-11T20:00:00+03:00" } ], "price": { "amount": "100.99", "amount_without_discount": "100.99", "currency": "USD" }, "promotions": [ { "bonus": [ { "image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png", "name": "Xsolla Minigun", "quantity": 1, "sku": "com.xsolla.minigun_1", "type": "virtual_good" } ], "date_end": "2026-04-15T16:16:00+03:00", "date_start": "2020-04-15T16:16:00+03:00", "discount": { "percent": "50.00" }, "name": "Bonus promotion" } ], "sku": "com.xsolla.big_rocket_1", "type": "virtual_good", "virtual_item_type": "non_renewing_subscription", "virtual_prices": [ { "amount": 100, "amount_without_discount": 100, "description": "description", "image_url": "http://image.png", "is_default": true, "name": "SHOTGUN FOR TRUE RAIDERS", "sku": "com.xsolla.vc_1", "type": "virtual_currency" } ], "vp_rewards": [ { "amount": 130, "image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg", "item_id": 175232, "name": "Value point", "sku": "com.xsolla.value_point_1" }, { "amount": 50, "image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg", "is_clan": true, "item_id": 186321, "name": "Clan Reward VP 1", "sku": "com.xsolla.clan_value_point_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" } ] } ], "can_be_bought": true, "description": "description", "groups": [ { "external_id": "weapons", "item_order_in_group": 2, "name": "weapons" } ], "image_url": "http://image.png", "is_free": false, "limits": { "per_user": { "available": 3, "limit_exceeded_visibility": "show", "recurrent_schedule": { "interval_type": "weekly", "reset_next_date": 1746057600 }, "total": 5 } }, "name": "SHOTGUN FOR TRUE RAIDERS", "periods": [], "price": { "amount": "101.0", "amount_without_discount": "101.0", "currency": "USD" }, "promotions": [ { "bonus": [ { "image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png", "name": "Xsolla Minigun", "quantity": 1, "sku": "com.xsolla.minigun_1", "type": "virtual_good" } ], "date_end": "2026-04-15T16:16:00+03:00", "date_start": "2020-04-15T16:16:00+03:00", "discount": { "percent": "50.00" }, "name": "Bonus promotion" } ], "sku": "com.xsolla.shotgun_raider_1", "type": "virtual_good", "virtual_item_type": "non_renewing_subscription", "virtual_prices": [ { "amount": 100, "amount_without_discount": 100, "description": "description", "image_url": "http://image.png", "is_default": true, "name": "SHOTGUN FOR TRUE RAIDERS", "sku": "com.xsolla.vc_1", "type": "virtual_currency" }, { "amount": 200, "amount_without_discount": 200, "description": "description", "image_url": "http://image.png", "is_default": false, "name": "SHOTGUN FOR TRUE RAIDERS", "sku": "com.xsolla.vc_2", "type": "virtual_currency" } ], "vp_rewards": [] } ] } } }, "schema": { "properties": { "has_more": { "$ref": "#/components/schemas/Pagination_has-more" }, "items": { "example": [ { "attributes": [ { "external_id": "stack_size", "name": "Stack size", "values": [ { "value": "5" } ] } ], "can_be_bought": true, "description": "Big Rocket - description", "groups": [ { "external_id": "weapons", "name": "weapons" } ], "image_url": "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png", "is_free": false, "limits": { "per_item": null, "per_user": { "available": 3, "limit_exceeded_visibility": "show", "recurrent_schedule": { "interval_type": "weekly", "reset_next_date": 1746057600 }, "total": 5 } }, "name": "Big Rocket", "periods": [ { "date_from": "2020-08-11T10:00:00+03:00", "date_until": "2020-08-11T20:00:00+03:00" } ], "price": { "amount": "100.99", "amount_without_discount": "100.99", "currency": "USD" }, "promotions": [ { "bonus": [ { "image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png", "name": "Xsolla Minigun", "quantity": 1, "sku": "com.xsolla.minigun_1", "type": "virtual_good" } ], "date_end": "2026-04-15T16:16:00+03:00", "date_start": "2020-04-15T16:16:00+03:00", "discount": { "percent": "50.00" }, "name": "Bonus promotion" } ], "sku": "com.xsolla.big_rocket_1", "type": "virtual_good", "virtual_item_type": "non_renewing_subscription", "virtual_prices": [ { "amount": 100, "amount_without_discount": 100, "description": "description", "image_url": "http://image.png", "is_default": true, "name": "SHOTGUN FOR TRUE RAIDERS", "sku": "com.xsolla.vc_1", "type": "virtual_currency" } ] }, { "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" ] } ], "can_be_bought": true, "description": "description", "groups": [ { "external_id": "weapons", "name": { "en": "weapons" } } ], "image_url": "http://image.png", "is_free": false, "limits": null, "name": "SHOTGUN FOR TRUE RAIDERS", "periods": [], "price": { "amount": "101.0", "amount_without_discount": "101.0", "currency": "USD" }, "promotions": [], "sku": "com.xsolla.shotgun_raider", "type": "virtual_good", "virtual_item_type": "non_renewing_subscription", "virtual_prices": [ { "amount": 100, "amount_without_discount": 100, "description": "description", "image_url": "http://image.png", "is_default": true, "name": "SHOTGUN FOR TRUE RAIDERS", "sku": "com.xsolla.vc_1", "type": "virtual_currency" }, { "amount": 200, "amount_without_discount": 200, "description": "description", "image_url": "http://image.png", "is_default": false, "name": "SHOTGUN FOR TRUE RAIDERS", "sku": "com.xsolla.vc_2", "type": "virtual_currency" } ] } ], "items": { "properties": { "attributes": { "$ref": "#/components/schemas/Virtual-Items-Currency_client-attributes" }, "can_be_bought": { "$ref": "#/components/schemas/Can_be_bought" }, "custom_attributes": { "$ref": "#/components/schemas/item-custom-attributes-response" }, "description": { "description": "아이템 설명입니다.", "example": "Big Rocket - description", "type": "string" }, "groups": { "$ref": "#/components/schemas/items_client_groups_response" }, "image_url": { "description": "이미지 URL입니다.", "example": "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png", "type": "string" }, "is_free": { "$ref": "#/components/schemas/value-is_free" }, "limits": { "$ref": "#/components/schemas/Catalog_item_limits" }, "name": { "description": "아이템 이름입니다.", "example": "Big Rocket", "type": "string" }, "periods": { "$ref": "#/components/schemas/item-periods-response" }, "price": { "description": "아이템 가격입니다.", "properties": { "amount": { "description": "할인된 아이템 가격입니다.", "example": "100.99", "type": "string" }, "amount_without_discount": { "description": "아이템 가격입니다.", "example": "100.99", "type": "string" }, "currency": { "description": "아이템 가격 통화입니다. [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)에 따른 3자리 코드입니다.", "example": "USD", "type": "string" } }, "type": "object" }, "promotions": { "$ref": "#/components/schemas/Catalog_item_promotions" }, "sku": { "description": "고유한 아이템 ID입니다. SKU는 소문자 및 대문자 라틴 영숫자, 마침표, 대시 및 밑줄만 포함할 수 있습니다.", "example": "com.xsolla.big_rocket_1", "type": "string" }, "type": { "description": "아이템의 유형: `consumable`/`expiration`/`permanent`/`lootboxes`/`physical`.", "example": "virtual_good", "type": "string" }, "virtual_item_type": { "description": "Type of virtual item.\n\nPossible values:\n- `consumable` — An item that disappears from the inventory after use (e.g., ammo).\n- `non_consumable` — An item that stays in the inventory for an unlimited period of time.\n- `non_renewing_subscription` — Time-limited item that can represent access to services or content for a limited period of time.", "enum": [ "consumable", "non_consumable", "non_renewing_subscription" ], "example": "non_consumable", "type": "string" }, "virtual_prices": { "description": "가상 가격입니다.", "items": { "description": "가상 가격입니다.", "properties": { "amount": { "description": "인게임 재화로 표시된 할인된 아이템 가격입니다.", "example": 100, "type": "integer" }, "amount_without_discount": { "description": "아이템 가격입니다.", "example": 200, "type": "integer" }, "description": { "description": "인게임 재화 설명입니다.", "example": "Big Rocket - description", "type": "string" }, "image_url": { "example": "http://image.png", "type": "string" }, "is_default": { "description": "아이템의 가격이 기본값인지 여부입니다.", "example": true, "type": "boolean" }, "name": { "description": "인게임 재화 이름입니다.", "example": "SHOTGUN FOR TRUE RAIDERS", "type": "string" }, "sku": { "description": "인게임 재화 아이템 SKU입니다.", "example": "com.xsolla.vc_1", "type": "string" }, "type": { "description": "인게임 재화 유형입니다.", "example": "virtual_currency", "type": "string" } }, "type": "object" }, "type": "array" }, "vp_rewards": { "$ref": "#/components/schemas/client-item-value-point-reward" } }, "type": "object" }, "type": "array" } }, "type": "object" } } }, "description": "지정한 그룹의 아이템 목록을 성공적으로 수신했습니다." }, "Virtual-Items-Currency_200-get-items-groups": { "content": { "application/json": { "examples": { "response": { "value": { "groups": [ { "description": "All weapons available in the game", "external_id": "weapons", "image_url": "https://example.com/groups/weapons.png", "name": "Weapons", "order": 1 }, { "description": "Protective equipment", "external_id": "armor", "image_url": "https://example.com/groups/armor.png", "name": "Armor", "order": 2 }, { "description": "Potions, food, and other single-use items", "external_id": "consumables", "image_url": null, "name": "Consumables", "order": 3 } ] } } }, "schema": { "properties": { "groups": { "example": [ { "description": "All weapons available in the game", "external_id": "weapons", "image_url": null, "name": "Weapons", "order": 1 }, { "description": "Super description", "external_id": "group_external_id", "image_url": null, "name": "Super", "order": 1 } ], "items": { "properties": { "children": { "description": "하위 그룹입니다.", "example": [ { "children": [ { "children": [], "description": "Accessory", "external_id": "accessory", "image_url": null, "level": 2, "name": "Accessory", "order": 1, "parent_external_id": "background" } ], "description": "Background description", "external_id": "background", "image_url": null, "level": 1, "name": "Background", "order": 1, "parent_external_id": "weapons" } ], "items": { "properties": { "children": { "description": "하위 그룹입니다.", "example": [ { "children": [], "description": "Accessory", "external_id": "accessory", "image_url": null, "level": 2, "name": "Accessory", "order": 1, "parent_external_id": "background" } ], "items": { "properties": { "children": { "description": "하위 그룹입니다.", "example": [], "items": { "type": "string" }, "type": "array" }, "description": { "description": "그룹 설명입니다.", "example": "Accessory", "type": "string" }, "external_id": { "description": "외부 그룹 ID입니다.", "example": "accessory", "type": "string" }, "image_url": { "description": "이미지 URL입니다.", "example": null, "type": [ "string", "null" ] }, "level": { "description": "그룹 중첩 수준입니다.", "example": 2, "type": "integer" }, "name": { "description": "그룹 이름입니다.", "example": "Accessory", "type": "string" }, "order": { "description": "배열 순서를 정의합니다.", "example": 1, "type": "integer" }, "parent_external_id": { "description": "상위 외부 그룹 ID입니다.", "example": "background", "type": [ "string", "null" ] } }, "type": "object" }, "type": "array" }, "description": { "description": "그룹 설명입니다.", "example": "Background description", "type": "string" }, "external_id": { "description": "외부 그룹 ID입니다.", "example": "background", "type": "string" }, "image_url": { "description": "그룹 이미지 URL입니다.", "example": null, "type": [ "string", "null" ] }, "level": { "description": "그룹 중첩 수준입니다.", "example": 1, "type": "integer" }, "name": { "description": "그룹 이름입니다.", "example": "Background", "type": "string" }, "order": { "description": "배열 순서를 정의합니다.", "example": 1, "type": "integer" }, "parent_external_id": { "description": "상위 외부 그룹 ID입니다.", "example": "weapons", "type": [ "string", "null" ] } }, "type": "object" }, "type": "array" }, "description": { "description": "그룹 설명입니다.", "example": "All weapons available in the game", "type": "string" }, "external_id": { "description": "외부 그룹 ID입니다.", "example": "weapons", "type": "string" }, "image_url": { "description": "이미지 URL입니다.", "example": null, "type": [ "string", "null" ] }, "level": { "description": "그룹 중첩 수준입니다.", "example": 0, "type": "integer" }, "name": { "description": "그룹 이름입니다.", "example": "Weapons", "type": "string" }, "order": { "description": "배열 순서를 정의합니다.", "example": 1, "type": "integer" }, "parent_external_id": { "description": "상위 외부 그룹 ID입니다.", "example": null, "type": [ "string", "null" ] } }, "type": "object" }, "type": "array" } }, "type": "object" } } }, "description": "그룹 목록을 성공적으로 수신했습니다." }, "Virtual-Items-Currency_200-get-items-list": { "content": { "application/json": { "examples": { "response": { "value": { "has_more": true, "items": [ { "attributes": [ { "external_id": "stack_size", "name": { "en": "Stack size" }, "values": [ { "external_id": "size_e3364991f92e751689a68b96598a5a5a84010b85", "value": "5" } ] } ], "can_be_bought": true, "custom_attributes": { "attr": "value", "purchased": 0 }, "description": { "en": "Big Rocket - description" }, "groups": [ { "external_id": "accessory", "item_order_in_group": 1, "name": "accessory" } ], "image_url": "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png", "is_free": false, "limits": { "per_user": { "available": 3, "limit_exceeded_visibility": "show", "recurrent_schedule": { "interval_type": "weekly", "reset_next_date": 1746057600 }, "total": 5 } }, "name": { "en": "Big Rocket" }, "periods": [ { "date_from": "2020-08-11T10:00:00+03:00", "date_until": "2020-08-11T20:00:00+03:00" } ], "price": { "amount": "100.99", "amount_without_discount": "100.99", "currency": "USD" }, "promotions": [ { "bonus": [ { "image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png", "name": "Xsolla Minigun", "quantity": 1, "sku": "com.xsolla.minigun_1", "type": "virtual_good" }, { "quantity": 1, "sku": "com.xsolla.phys_good_1", "type": "physical_good" }, { "bundle_type": "standard", "image_url": "https://cdn.xsolla.net/img/misc/images/9676f06265375087e607cb79c5283688.png", "name": "Super Lootbox with items", "quantity": 1, "sku": "com.xsolla.SuperLootboxBundle_1", "type": "bundle" } ], "date_end": "2026-04-15T16:16:00+03:00", "date_start": "2020-04-15T16:16:00+03:00", "discount": null, "name": "Bonus promotion" } ], "sku": "com.xsolla.big_rocket_1", "type": "virtual_good", "virtual_item_type": "non_renewing_subscription", "virtual_prices": [ { "amount": 100, "amount_without_discount": 100, "description": "description", "image_url": "http://image.png", "is_default": true, "name": "SHOTGUN FOR TRUE RAIDERS", "sku": "com.xsolla.vc_1", "type": "virtual_currency" } ], "vp_rewards": [] }, { "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" } ] } ], "can_be_bought": true, "description": { "en": "description" }, "groups": [ { "external_id": "weapons", "item_order_in_group": 1, "name": "Weapons" } ], "image_url": "http://image.png", "is_free": false, "limits": null, "name": { "en": "SHOTGUN FOR TRUE RAIDERS" }, "periods": [ { "date_from": null, "date_until": "2020-08-11T20:00:00+03:00" } ], "price": { "amount": "101.0", "amount_without_discount": "101.0", "currency": "USD" }, "promotions": [], "sku": "com.xsolla.shotgun_raider_1", "type": "virtual_good", "virtual_item_type": "non_renewing_subscription", "virtual_prices": [ { "amount": 100, "amount_without_discount": 100, "description": "description", "image_url": "http://image.png", "is_default": true, "name": "SHOTGUN FOR TRUE RAIDERS", "sku": "com.xsolla.vc_1", "type": "virtual_currency" }, { "amount": 200, "amount_without_discount": 200, "description": "description", "image_url": "http://image.png", "is_default": false, "name": "SHOTGUN FOR TRUE RAIDERS", "sku": "com.xsolla.vc_2", "type": "virtual_currency" } ], "vp_rewards": [] }, { "attributes": [], "can_be_bought": true, "description": { "en": "description" }, "groups": [], "image_url": "http://image.png", "is_free": true, "limits": null, "name": { "en": "SHOTGUN FOR TRUE RAIDERS" }, "periods": [], "price": null, "promotions": [], "sku": "com.xsolla.shotgun_raider_2", "type": "virtual_good", "virtual_item_type": "non_renewing_subscription", "virtual_prices": [], "vp_rewards": [] } ] } } }, "schema": { "$ref": "#/components/schemas/Virtual-Items-Currency_item-list" } } }, "description": "가상 아이템 목록을 성공적으로 수신했습니다." }, "Virtual-Items-Currency_200-get-virtual-currency": { "content": { "application/json": { "examples": { "response": { "value": { "attributes": [ { "external_id": "attr1", "name": { "en-US": "Attribute" }, "values": [ { "external_id": "val1", "value": "Value" }, { "external_id": "val2", "value": "Value" } ] } ], "can_be_bought": true, "custom_attributes": { "attr": "value", "purchased": 0 }, "description": "Crystals - short description", "groups": [], "image_url": "https://cdn3.xsolla.com/img/misc/images/da33ab6cc1d7e5899cfdc5b6b6180fad.png", "is_free": false, "item_id": 451414, "limits": null, "name": "Crystals", "periods": [ { "date_from": "2023-08-11T10:00:00+03:00", "date_until": "2023-08-11T20:00:00+03:00" } ], "price": { "amount": "100", "amount_without_discount": "100", "currency": "USD" }, "promotions": [], "sku": "com.xsolla.crystal_1", "type": "virtual_currency", "virtual_prices": [] } } }, "schema": { "$ref": "#/components/schemas/Virtual-Items-Currency_virtual-currency" } } }, "description": "인게임 재화를 성공적으로 수신했습니다." }, "Virtual-Items-Currency_200-get-virtual-currency-list": { "content": { "application/json": { "examples": { "response": { "value": { "has_more": false, "items": [ { "attributes": [ { "external_id": "stack_size", "name": { "en": "Stack size" }, "values": [ { "external_id": "size_e3364991f92e751689a68b96598a5a5a84010b85", "value": "5" } ] } ], "can_be_bought": true, "custom_attributes": { "attr": "value", "purchased": 0 }, "description": "Big Rocket - short description", "groups": [ { "external_id": "weapons", "item_order_in_group": 1, "name": "weapons" } ], "image_url": "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png", "is_free": false, "limits": null, "name": "Big Rocket", "periods": [ { "date_from": "2020-08-11T10:00:00+03:00", "date_until": "2020-08-11T20:00:00+03:00" } ], "price": { "amount": "100.99", "amount_without_discount": "100.99", "currency": "USD" }, "promotions": [], "sku": "com.xsolla.big_rocket_1", "type": "virtual_currency", "virtual_prices": [ { "amount": 100, "amount_without_discount": 100, "description": "description", "image_url": "http://image.png", "is_default": true, "name": "SHOTGUN FOR TRUE RAIDERS", "sku": "com.xsolla.shotgun_raider_1", "type": "virtual_currency" } ], "vp_rewards": [] }, { "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" } ] } ], "can_be_bought": true, "description": "description", "groups": [ { "external_id": "weapons", "item_order_in_group": 2, "name": "weapons" } ], "image_url": "http://image.png", "is_free": false, "limits": null, "name": "SHOTGUN FOR TRUE RAIDERS", "periods": [ { "date_from": null, "date_until": "2020-08-11T20:00:00+03:00" } ], "price": { "amount": "101.0", "amount_without_discount": "101.0", "currency": "USD" }, "promotions": [], "sku": "com.xsolla.shotgun_raider_2", "type": "virtual_currency", "virtual_prices": [], "vp_rewards": [] }, { "attributes": [], "can_be_bought": true, "description": "description", "groups": [], "image_url": "http://image.png", "is_free": true, "limits": null, "name": "SHOTGUN FOR TRUE RAIDERS", "periods": [], "price": null, "promotions": [], "sku": "com.xsolla.shotgun_raider_3", "type": "virtual_currency", "virtual_prices": [], "vp_rewards": [] } ] } } }, "schema": { "$ref": "#/components/schemas/Virtual-Items-Currency_virtual-currency-list" } } }, "description": "인게임 재화 목록을 성공적으로 수신했습니다." }, "Virtual-Items-Currency_200-get-virtual-currency-package": { "content": { "application/json": { "examples": { "response": { "value": { "attributes": [], "bundle_type": "virtual_currency_package", "can_be_bought": true, "content": [ { "description": "Crystal - short description", "image_url": "https://cdn3.xsolla.com/img/misc/images/da33ab6cc1d7e5899cfdc5b6b6180fad.png", "item_id": 488831, "limits": null, "name": "Crystals", "quantity": 10, "sku": "com.xsolla.crystals_1", "type": "virtual_currency" } ], "custom_attributes": { "attr": "value", "purchased": 0 }, "description": "Crystal Pack Short Description", "groups": [], "image_url": "http://vc_package_image.png", "is_free": false, "item_id": 488832, "limits": { "per_item": null, "per_user": { "available": 1, "limit_exceeded_visibility": "show", "recurrent_schedule": { "interval_type": "weekly", "reset_next_date": 1690732800 }, "total": 1 } }, "name": "Crystal Pack", "periods": [ { "date_from": "2020-08-11T10:00:00+03:00", "date_until": "2020-08-11T20:00:00+03:00" } ], "price": { "amount": "100", "amount_without_discount": "100", "currency": "USD" }, "promotions": [], "sku": "com.xsolla.crystal_pack_1", "type": "bundle", "virtual_prices": [], "vp_rewards": [] } } }, "schema": { "$ref": "#/components/schemas/Virtual-Items-Currency_virtual-currency-package" } } }, "description": "인게임 재화 패키지를 성공적으로 수신했습니다." }, "Virtual-Items-Currency_200-get-virtual-currency-packages-list": { "content": { "application/json": { "examples": { "response": { "value": { "has_more": false, "items": [ { "attributes": [], "bundle_type": "virtual_currency_package", "can_be_bought": true, "content": [ { "description": "Big Rocket - short description", "image_url": "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png", "name": "Big Rocket", "quantity": 100, "sku": "com.xsolla.big_rocket_1", "type": "virtual_currency" } ], "custom_attributes": { "attr": "value", "purchased": 0 }, "description": "VC Short Package Description", "groups": [ { "external_id": "gift", "item_order_in_group": 1, "name": "Gift" } ], "image_url": "http://vc_package_image.png", "is_free": false, "limits": { "per_user": { "available": 3, "limit_exceeded_visibility": "show", "recurrent_schedule": { "interval_type": "weekly", "reset_next_date": 1746057600 }, "total": 5 } }, "name": "VC Name first package", "periods": [ { "date_from": "2020-08-11T10:00:00+03:00", "date_until": "2020-08-11T20:00:00+03:00" } ], "price": { "amount": "2.0000", "amount_without_discount": "2.0000", "currency": "USD" }, "promotions": [ { "bonus": [ { "image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png", "name": "Xsolla Minigun", "quantity": 1, "sku": "com.xsolla.minigun_1", "type": "virtual_good" } ], "date_end": "2026-04-15T16:16:00+03:00", "date_start": "2020-04-15T16:16:00+03:00", "discount": { "percent": "50.00" }, "name": "Bonus promotion" } ], "sku": "com.xsolla.vc_package_1", "type": "bundle", "virtual_prices": [], "vp_rewards": [] }, { "attributes": [], "bundle_type": "virtual_currency_package", "can_be_bought": true, "content": [ { "description": "description", "image_url": "http://image.png", "name": "SHOTGUN FOR TRUE RAIDERS", "quantity": 200, "sku": "com.xsolla.shotgun_raider_1", "type": "virtual_currency" } ], "description": "VC Short Package Description", "groups": [ { "external_id": "gift", "item_order_in_group": 2, "name": "Gift" } ], "image_url": "http://vc_package_image.png", "is_free": false, "limits": { "per_user": { "available": 3, "limit_exceeded_visibility": "show", "recurrent_schedule": { "interval_type": "weekly", "reset_next_date": 1746057600 }, "total": 5 } }, "name": "VC Name third package", "periods": [ { "date_from": null, "date_until": "2020-08-11T20:00:00+03:00" } ], "price": { "amount": "4.0000", "amount_without_discount": "4.0000", "currency": "USD" }, "promotions": [ { "bonus": [ { "image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png", "name": "Xsolla Minigun", "quantity": 1, "sku": "com.xsolla.minigun_1", "type": "virtual_good" } ], "date_end": "2026-04-15T16:16:00+03:00", "date_start": "2020-04-15T16:16:00+03:00", "discount": { "percent": "50.00" }, "name": "Bonus promotion" } ], "sku": "com.xsolla.vc_package_3", "type": "bundle", "virtual_prices": [], "vp_rewards": [] } ] } } }, "schema": { "$ref": "#/components/schemas/Virtual-Items-Currency_virtual-currency-packages" } } }, "description": "인게임 재화 패키지 목록을 성공적으로 수신했습니다." }, "Virtual-Items-Currency_200-quick-purchase": { "content": { "application/json": { "examples": { "response": { "value": { "order_id": 641 } } }, "schema": { "properties": { "order_id": { "description": "주문 ID입니다.", "type": "integer" } }, "type": "object" } } }, "description": "성공한 빠른 가상 구매입니다." }, "Virtual-Items-Currency_201-created": { "content": { "application/json": { "examples": { "response": { "value": { "sku": "com.xsolla.item_1" } } }, "schema": { "example": { "sku": "com.xsolla.item_1" }, "properties": { "sku": { "example": "new-sku", "type": "string" } }, "type": "object" } } }, "description": "가상 아이템을 성공적으로 생성했습니다." }, "Virtual-Items-Currency_401-invalid-basic-auth": { "content": { "application/json": { "examples": { "response": { "value": { "errorCode": 1020, "errorMessage": "[0401-1020]: Error in Authentication method occurred", "statusCode": 401 } } }, "schema": { "properties": { "errorCode": { "example": 1020, "type": "integer" }, "errorMessage": { "example": "[0401-1020]: Error in Authentication method occurred", "type": "string" }, "statusCode": { "example": 401, "type": "integer" } }, "type": "object" } } }, "description": "기본 인증이 전달되지 않았거나 잘못되었습니다. 기본 인증 또는 올바른 자격 증명을 사용했는지 확인해야 합니다." }, "Virtual-Items-Currency_404-item": { "content": { "application/json": { "schema": { "properties": { "errorCode": { "example": 4001, "type": "integer" }, "errorMessage": { "example": "[0401-4001]: Item with Project Id = 44056 and Sku = booster_mega_12222 not found", "type": "string" }, "statusCode": { "example": 404, "type": "integer" } }, "type": "object" } } }, "description": "아이템을 찾을 수 없습니다. `project_id`과 `item_sku`가 올바른지 확인해야 합니다." }, "Virtual-Items-Currency_404-item-group": { "content": { "application/json": { "examples": { "response": { "value": { "errorCode": 4403, "errorMessage": "[0401-4403]: Item group not found", "statusCode": 404 } } }, "schema": { "properties": { "errorCode": { "example": 4403, "type": "integer" }, "errorMessage": { "example": "[0401-4403]: Item group not found", "type": "string" }, "statusCode": { "example": 404, "type": "integer" } }, "type": "object" } } }, "description": "그룹을 찾을 수 없습니다. `external_id`이 올바르고 그룹이 꺼져 있거나 삭제되지 않았는지 확인해야 합니다." }, "Virtual-Items-Currency_422-invalid-request": { "content": { "application/json": { "examples": { "Custom attributes JSON can’t exceed 500 characters": { "$ref": "#/components/examples/422-custom-attributes-size-exceeded" }, "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" }, "The property `sku` is required": { "$ref": "#/components/examples/422-property-sku-is-required" }, "Value limit exceeded": { "$ref": "#/components/examples/422-value-limit-exceeded" } }, "schema": { "$ref": "#/components/schemas/Virtual-Items-Currency_422-invalid-request" } } }, "description": "잘못된 요청입니다." }, "Virtual-Items-Currency_422-not-enough-virtual-currency": { "content": { "application/json": { "examples": { "response": { "value": { "errorCode": 5006, "errorMessage": "[0401-5006]: Not enough virtual currency", "statusCode": 422 } } }, "schema": { "properties": { "errorCode": { "example": 5006, "type": "integer" }, "errorMessage": { "example": "[0401-5006]: Not enough virtual currency", "type": "string" }, "statusCode": { "example": 422, "type": "integer" } }, "type": "object" } } }, "description": "인게임 재화가 부족합니다." }, "connector-422-validation-failed": { "content": { "application/json": { "examples": { "response": { "value": { "errorCode": 1803, "errorMessage": "[0410-1803]: File content-type doesn't allowed. Allowed content types: application/json; current content type: text/plain", "statusCode": 422, "transactionId": "x-x-x-x-transactionId-mock-x-x-x" } } }, "schema": { "properties": { "errorCode": { "example": 1803, "type": "integer" }, "errorMessage": { "example": "[0410-1803]: File content-type doesn't allowed. Allowed content types: application/json; current content type: text/plain", "type": "string" }, "statusCode": { "example": 422, "type": "integer" }, "transactionId": { "example": "x-x-x-x-transactionId-mock-x-x-x", "type": "string" } }, "type": "object" } } }, "description": "요청 본문, 파일 특성 또는 파일 콘텐츠의 잘못된 매개 변수로 인해 발생하는 유효성 검사 오류입니다." }, "sellable-item-by-id_404": { "content": { "application/json": { "schema": { "properties": { "errorCode": { "example": 4001, "type": "integer" }, "errorMessage": { "example": "[0401-4001]: Item with id = 259774 not found", "type": "string" }, "statusCode": { "example": 404, "type": "integer" } }, "type": "object" } } }, "description": "아이템을 찾을 수 없습니다. `project_id`과 `item_id`가 올바른지 확인해야 합니다." }, "sellable-item-by-sku_404": { "content": { "application/json": { "schema": { "properties": { "errorCode": { "example": 4001, "type": "integer" }, "errorMessage": { "example": "[0401-4001]: Item with sku = 'electric_shiel' not found", "type": "string" }, "statusCode": { "example": 404, "type": "integer" } }, "type": "object" } } }, "description": "아이템을 찾을 수 없습니다. `project_id`과 `sku`가 올바른지 확인해야 합니다." }, "sellable_items_200-get-item-by-id": { "content": { "application/json": { "examples": { "response": { "value": { "attributes": [], "can_be_bought": true, "custom_attributes": { "attr": "value", "purchased": 0 }, "description": "Electric shield", "groups": [ { "external_id": "armour", "item_order_in_group": 10, "name": "Armour" } ], "image_url": "https://cdn3.xsolla.com/img/misc/images/d2d6b1b517e6a7f3765c3bb5a3cfb87d.png", "is_free": false, "item_id": 259774, "limits": { "per_user": { "available": 3, "limit_exceeded_visibility": "show", "recurrent_schedule": { "interval_type": "weekly", "reset_next_date": 1746057600 }, "total": 5 } }, "name": "Electric shield", "price": { "amount": "9.99", "amount_without_discount": "9.99", "currency": "USD" }, "promotions": [ { "bonus": [ { "image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png", "name": "Xsolla Minigun", "quantity": 1, "sku": "com.xsolla.minigun_1", "type": "virtual_good" } ], "date_end": "2026-04-15T16:16:00+03:00", "date_start": "2020-04-15T16:16:00+03:00", "discount": { "percent": "50.00" }, "name": "Bonus promotion" } ], "sku": "com.xsolla.electric_shield_1", "type": "virtual_good", "virtual_item_type": "non_consumable", "virtual_prices": [ { "amount": 10, "amount_without_discount": 10, "calculated_price": { "amount": "10.00", "amount_without_discount": "10.00" }, "description": null, "image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png", "is_default": true, "item_id": 259765, "name": "Gold", "sku": "com.xsolla.gold_1", "type": "virtual_currency" }, { "amount": 20, "amount_without_discount": 20, "calculated_price": { "amount": "20.00", "amount_without_discount": "20.00" }, "description": null, "image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png", "is_default": false, "item_id": 259766, "name": "Silver", "sku": "com.xsolla.silver_1", "type": "virtual_currency" }, { "amount": 200, "amount_without_discount": 200, "calculated_price": { "amount": "200.00", "amount_without_discount": "200.00" }, "description": null, "image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png", "is_default": false, "item_id": 259767, "name": "Bronze", "sku": "com.xsolla.bronze_1", "type": "virtual_currency" } ], "vp_rewards": [ { "amount": 130, "image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg", "item_id": 175232, "name": "Value point", "sku": "com.xsolla.value_point_1" }, { "amount": 50, "image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg", "is_clan": true, "item_id": 186321, "name": "Clan Reward VP 1", "sku": "com.xsolla.clan_value_point_1" } ] } } }, "schema": { "description": "판매할 수 있는 아이템이 있는 개체입니다.", "properties": { "attributes": { "$ref": "#/components/schemas/Virtual-Items-Currency_client-attributes" }, "can_be_bought": { "description": "`true`일 경우 사용자는 아이템을 구매할 수 있습니다.", "example": true, "type": "boolean" }, "custom_attributes": { "$ref": "#/components/schemas/item-custom-attributes-response" }, "description": { "description": "아이템 설명입니다.", "example": "Electric shield", "type": "string" }, "groups": { "$ref": "#/components/schemas/items_client_groups_response" }, "image_url": { "description": "이미지 URL입니다.", "example": "https://cdn3.xsolla.com/img/misc/images/d2d6b1b517e6a7f3765c3bb5a3cfb87d.png", "type": "string" }, "is_free": { "$ref": "#/components/schemas/value-is_free" }, "item_id": { "description": "아이템 생성 시 제공되는 내부의 고유 아이템 ID입니다.", "example": 259774, "type": "integer" }, "limits": { "$ref": "#/components/schemas/Catalog_item_limits" }, "name": { "description": "아이템 이름입니다.", "example": "Electric shield", "type": "string" }, "price": { "description": "아이템 가격입니다.", "properties": { "amount": { "description": "할인된 아이템 가격입니다.", "example": "9.99", "type": "string" }, "amount_without_discount": { "description": "아이템 가격입니다.", "example": "9.99", "type": "string" }, "currency": { "description": "아이템 가격 통화입니다. [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)에 따른 3자리 코드입니다.", "example": "USD", "type": "string" } }, "type": "object" }, "promotions": { "$ref": "#/components/schemas/Catalog_item_promotions" }, "sku": { "description": "고유한 아이템 ID입니다. SKU는 소문자 및 대문자 라틴 영숫자, 마침표, 대시 및 밑줄만 포함할 수 있습니다.", "example": "electric_shield", "type": "string" }, "type": { "description": "아이템 유형: `virtual_good`/`virtual_currency`/`bundle`/`game_key`/`physical_good`.", "enum": [ "virtual_good", "virtual_currency", "bundle", "game_key", "physical_good" ], "example": "virtual_good", "type": "string" }, "virtual_item_type": { "description": "Type of virtual item.\n\nPossible values:\n- `consumable` — An item that disappears from the inventory after use (e.g., ammo).\n- `non_consumable` — An item that stays in the inventory for an unlimited period of time.\n- `non_renewing_subscription` — Time-limited item that can represent access to services or content for a limited period of time.", "enum": [ "consumable", "non_consumable", "non_renewing_subscription" ], "example": "non-consumable", "type": "string" }, "virtual_prices": { "description": "가상 가격입니다.", "items": { "description": "가상 가격입니다.", "properties": { "amount": { "description": "인게임 재화로 표시된 할인된 아이템 가격입니다.", "example": 10, "type": "integer" }, "amount_without_discount": { "description": "아이템 가격입니다.", "example": 10, "type": "integer" }, "calculated_price": { "properties": { "amount": { "type": "string" }, "amount_without_discount": { "type": "string" } }, "type": "object" }, "description": { "description": "인게임 재화 설명입니다.", "example": null, "type": [ "string", "null" ] }, "image_url": { "description": "인게임 재화의 이미지입니다.", "example": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png", "type": "string" }, "is_default": { "description": "아이템의 가격이 기본값인지 여부입니다.", "example": true, "type": "boolean" }, "item_id": { "description": "아이템 생성 시 제공되는 내부의 고유 아이템 ID입니다.", "example": 259774, "type": "integer" }, "name": { "description": "인게임 재화 이름입니다.", "example": "Gold", "type": "string" }, "sku": { "description": "인게임 재화 아이템 SKU입니다.", "example": "gold", "type": "string" }, "type": { "description": "인게임 재화 유형입니다.", "example": "virtual_currency", "type": "string" } }, "type": "object" }, "type": "array" }, "vp_rewards": { "$ref": "#/components/schemas/client-item-value-point-reward" } }, "type": "object" } } }, "description": "판매할 수 있는 아이템을 성공적으로 수신했습니다." }, "sellable_items_200-get-items-by-group-id": { "content": { "application/json": { "examples": { "response": { "value": { "has_more": true, "items": [ { "attributes": [], "can_be_bought": true, "description": "Electric shield", "groups": [ { "external_id": "armour", "item_order_in_group": 1, "name": "Armour" } ], "image_url": "https://cdn3.xsolla.com/img/misc/images/d2d6b1b517e6a7f3765c3bb5a3cfb87d.png", "is_free": false, "item_id": 259774, "name": "Electric shield", "price": { "amount": "9.99", "amount_without_discount": "9.99", "currency": "USD" }, "promotions": [ { "bonus": [ { "image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png", "name": "Xsolla Minigun", "quantity": 1, "sku": "com.xsolla.minigun_1", "type": "virtual_good" } ], "date_end": "2026-04-15T16:16:00+03:00", "date_start": "2020-04-15T16:16:00+03:00", "discount": { "percent": "50.00" }, "name": "Bonus promotion" } ], "sku": "com.xsolla.electric_shields_1", "type": "virtual_good", "virtual_item_type": "non_consumable", "virtual_prices": [ { "amount": 10, "amount_without_discount": 10, "calculated_price": { "amount": "10.00", "amount_without_discount": "10.00" }, "description": null, "image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png", "is_default": true, "item_id": 259765, "name": "Gold", "sku": "com.xsolla.gold_1", "type": "virtual_currency" }, { "amount": 20, "amount_without_discount": 20, "calculated_price": { "amount": "20.00", "amount_without_discount": "20.00" }, "description": null, "image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png", "is_default": false, "item_id": 259766, "name": "Silver", "sku": "com.xsolla.silver_1", "type": "virtual_currency" }, { "amount": 200, "amount_without_discount": 200, "calculated_price": { "amount": "200.00", "amount_without_discount": "200.00" }, "description": null, "image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png", "is_default": false, "item_id": 259767, "name": "Bronze", "sku": "com.xsolla.bronze_1", "type": "virtual_currency" } ] }, { "attributes": [], "can_be_bought": true, "description": "Royal shield", "groups": [ { "external_id": "armour", "item_order_in_group": 2, "name": "Armour" } ], "image_url": "https://cdn3.xsolla.com/img/misc/images/ed417975312a52efeeab8b039ff25cb1.png", "is_free": false, "item_id": 259775, "name": "Royal shield", "price": { "amount": "19.99", "amount_without_discount": "19.99", "currency": "USD" }, "promotions": [], "sku": "com.xsolla.royal_shield_1", "type": "virtual_good", "virtual_item_type": "non_consumable", "virtual_prices": [ { "amount": 20, "amount_without_discount": 20, "calculated_price": { "amount": "20.00", "amount_without_discount": "20.00" }, "description": null, "image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png", "is_default": true, "item_id": 259765, "name": "Gold", "sku": "com.xsolla.gold_1", "type": "virtual_currency" }, { "amount": 40, "amount_without_discount": 40, "calculated_price": { "amount": "40.00", "amount_without_discount": "40.00" }, "description": null, "image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png", "is_default": false, "item_id": 259766, "name": "Silver", "sku": "com.xsolla.silver_1", "type": "virtual_currency" }, { "amount": 400, "amount_without_discount": 400, "calculated_price": { "amount": "400.00", "amount_without_discount": "400.00" }, "description": null, "image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png", "is_default": false, "item_id": 259767, "name": "Bronze", "sku": "com.xsolla.bronze_1", "type": "virtual_currency" } ] }, { "attributes": [], "can_be_bought": true, "description": "Ancient helmet", "groups": [ { "external_id": "armour", "item_order_in_group": 3, "name": "Armour" } ], "image_url": "https://cdn3.xsolla.com/img/misc/images/e70e16d9626f435e519fc8e1cc1e7176.png", "is_free": false, "item_id": 259776, "name": "Ancient helmet", "price": { "amount": "1.99", "amount_without_discount": "1.99", "currency": "USD" }, "promotions": [ { "bonus": [ { "image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png", "name": "Xsolla Minigun", "quantity": 1, "sku": "com.xsolla.minigun_1", "type": "virtual_good" } ], "date_end": "2026-04-15T16:16:00+03:00", "date_start": "2020-04-15T16:16:00+03:00", "discount": { "percent": "50.00" }, "name": "Bonus promotion" } ], "sku": "com.xsolla.ancient_helmet_1", "type": "virtual_good", "virtual_item_type": "non_consumable", "virtual_prices": [ { "amount": 2, "amount_without_discount": 2, "calculated_price": { "amount": "2.00", "amount_without_discount": "2.00" }, "description": null, "image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png", "is_default": true, "item_id": 259765, "name": "Gold", "sku": "com.xsolla.gold_2", "type": "virtual_currency" }, { "amount": 4, "amount_without_discount": 4, "calculated_price": { "amount": "4.00", "amount_without_discount": "4.00" }, "description": null, "image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png", "is_default": false, "item_id": 259766, "name": "Silver", "sku": "com.xsolla.silver_2", "type": "virtual_currency" }, { "amount": 40, "amount_without_discount": 40, "calculated_price": { "amount": "40.00", "amount_without_discount": "40.00" }, "description": null, "image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png", "is_default": false, "item_id": 259767, "name": "Bronze", "sku": "com.xsolla.bronze_2", "type": "virtual_currency" } ] }, { "attributes": [], "can_be_bought": true, "custom_attributes": { "attr": "value", "purchased": 0 }, "description": "Wooden helmet", "groups": [ { "external_id": "armour", "item_order_in_group": 4, "name": "Armour" } ], "image_url": "https://cdn3.xsolla.com/img/misc/images/40d2812e52ad9d988ac20fc842fc66f0.png", "is_free": false, "item_id": 259777, "limits": { "per_user": { "available": 3, "recurrent_schedule": { "interval_type": "weekly", "reset_next_date": 1746057600 }, "total": 5 } }, "name": "Wooden helmet", "price": { "amount": "0.99", "amount_without_discount": "0.99", "currency": "USD" }, "promotions": [ { "bonus": [ { "image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png", "name": "Xsolla Minigun", "quantity": 1, "sku": "com.xsolla.minigun_1", "type": "virtual_good" } ], "date_end": "2026-04-15T16:16:00+03:00", "date_start": "2020-04-15T16:16:00+03:00", "discount": { "percent": "50.00" }, "name": "Bonus promotion" } ], "sku": "com.xsolla.wooden_helmet_2", "type": "virtual_good", "virtual_item_type": "non_consumable", "virtual_prices": [ { "amount": 1, "amount_without_discount": 1, "calculated_price": { "amount": "1.00", "amount_without_discount": "1.00" }, "description": null, "image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png", "is_default": true, "item_id": 259765, "name": "Gold", "sku": "com.xsolla.gold_3", "type": "virtual_currency" }, { "amount": 2, "amount_without_discount": 2, "calculated_price": { "amount": "2.00", "amount_without_discount": "2.00" }, "description": null, "image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png", "is_default": false, "item_id": 259766, "name": "Silver", "sku": "com.xsolla.silver_3", "type": "virtual_currency" }, { "amount": 20, "amount_without_discount": 20, "calculated_price": { "amount": "20.00", "amount_without_discount": "20.00" }, "description": null, "image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png", "is_default": false, "item_id": 259767, "name": "Bronze", "sku": "com.xsolla.bronze_3", "type": "virtual_currency" } ], "vp_rewards": [ { "amount": 130, "image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg", "item_id": 175232, "name": "Value point", "sku": "com.xsolla.value_point_1" }, { "amount": 50, "image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg", "is_clan": true, "item_id": 186321, "name": "Clan Reward VP 1", "sku": "com.xsolla.clan_value_point_1" } ] } ] } } }, "schema": { "properties": { "has_more": { "$ref": "#/components/schemas/Pagination_has-more" }, "items": { "example": [ { "attributes": [], "can_be_bought": true, "description": "Electric shield", "groups": [ { "external_id": "armour", "name": "Armour" } ], "image_url": "https://cdn3.xsolla.com/img/misc/images/d2d6b1b517e6a7f3765c3bb5a3cfb87d.png", "is_free": false, "item_id": 259774, "limits": { "per_user": { "available": 3, "limit_exceeded_visibility": "show", "recurrent_schedule": { "interval_type": "weekly", "reset_next_date": 1746057600 }, "total": 5 } }, "name": "Electric shield", "price": { "amount": "9.99", "amount_without_discount": "9.99", "currency": "USD" }, "promotions": [ { "bonus": [ { "image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png", "name": "Xsolla Minigun", "quantity": 1, "sku": "com.xsolla.minigun_1", "type": "virtual_good" } ], "date_end": "2026-04-15T16:16:00+03:00", "date_start": "2020-04-15T16:16:00+03:00", "discount": { "percent": "50.00" }, "name": "Bonus promotion" } ], "sku": "com.xsolla.electric_shield_1", "type": "virtual_good", "virtual_item_type": "non_consumable", "virtual_prices": [ { "amount": 10, "amount_without_discount": 10, "calculated_price": { "amount": "10.00", "amount_without_discount": "10.00" }, "description": null, "image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png", "is_default": true, "item_id": 259765, "name": "Gold", "sku": "com.xsolla.gold_1", "type": "virtual_currency" }, { "amount": 20, "amount_without_discount": 20, "calculated_price": { "amount": "20.00", "amount_without_discount": "20.00" }, "description": null, "image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png", "is_default": false, "item_id": 259766, "name": "Silver", "sku": "com.xsolla.silver_1", "type": "virtual_currency" }, { "amount": 200, "amount_without_discount": 200, "calculated_price": { "amount": "200.00", "amount_without_discount": "200.00" }, "description": null, "image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png", "is_default": false, "item_id": 259767, "name": "Bronze", "sku": "com.xsolla.bronze_1", "type": "virtual_currency" } ], "vp_rewards": [ { "amount": 130, "image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg", "item_id": 175232, "name": "Value point", "sku": "com.xsolla.value_point_1" }, { "amount": 50, "image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg", "is_clan": true, "item_id": 186321, "name": "Clan Reward VP 1", "sku": "clan_value_point_sku_1" } ] }, { "attributes": [], "can_be_bought": true, "description": "Royal shield", "groups": [ { "external_id": "armour", "name": "Armour" } ], "image_url": "https://cdn3.xsolla.com/img/misc/images/ed417975312a52efeeab8b039ff25cb1.png", "is_free": false, "item_id": 259775, "name": "Royal shield", "price": { "amount": "19.99", "amount_without_discount": "19.99", "currency": "USD" }, "promotions": [], "sku": "com.xsolla.royal_shield_1", "type": "virtual_good", "virtual_item_type": "non_consumable", "virtual_prices": [ { "amount": 20, "amount_without_discount": 20, "calculated_price": { "amount": "20.00", "amount_without_discount": "20.00" }, "description": null, "image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png", "is_default": true, "item_id": 259765, "name": "Gold", "sku": "com.xsolla.gold_2", "type": "virtual_currency" }, { "amount": 40, "amount_without_discount": 40, "calculated_price": { "amount": "40.00", "amount_without_discount": "40.00" }, "description": null, "image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png", "is_default": false, "item_id": 259766, "name": "Silver", "sku": "com.xsolla.silver_2", "type": "virtual_currency" }, { "amount": 400, "amount_without_discount": 400, "calculated_price": { "amount": "400.00", "amount_without_discount": "400.00" }, "description": null, "image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png", "is_default": false, "item_id": 259767, "name": "Bronze", "sku": "com.xsolla.bronze_2", "type": "virtual_currency" } ], "vp_rewards": [] }, { "attributes": [], "can_be_bought": true, "description": "Ancient helmet", "groups": [ { "external_id": "armour", "name": "Armour" } ], "image_url": "https://cdn3.xsolla.com/img/misc/images/e70e16d9626f435e519fc8e1cc1e7176.png", "is_free": false, "item_id": 259776, "name": "Ancient helmet", "price": { "amount": "1.99", "amount_without_discount": "1.99", "currency": "USD" }, "promotions": [ { "bonus": [ { "image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png", "name": "Xsolla Minigun", "quantity": 1, "sku": "com.xsolla.minigun_1", "type": "virtual_good" } ], "date_end": "2026-04-15T16:16:00+03:00", "date_start": "2020-04-15T16:16:00+03:00", "discount": { "percent": "50.00" }, "name": "Bonus promotion" } ], "sku": "com.xsolla.ancient_helmet_1", "type": "virtual_good", "virtual_item_type": "non_consumable", "virtual_prices": [ { "amount": 2, "amount_without_discount": 2, "calculated_price": { "amount": "2.00", "amount_without_discount": "2.00" }, "description": null, "image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png", "is_default": true, "item_id": 259765, "name": "Gold", "sku": "com.xsolla.gold_3", "type": "virtual_currency" }, { "amount": 4, "amount_without_discount": 4, "calculated_price": { "amount": "4.00", "amount_without_discount": "4.00" }, "description": null, "image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png", "is_default": false, "item_id": 259766, "name": "Silver", "sku": "com.xsolla.silver_3", "type": "virtual_currency" }, { "amount": 40, "amount_without_discount": 40, "calculated_price": { "amount": "40.00", "amount_without_discount": "40.00" }, "description": null, "image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png", "is_default": false, "item_id": 259767, "name": "Bronze", "sku": "com.xsolla.bronze_3", "type": "virtual_currency" } ], "vp_rewards": [] }, { "attributes": [], "can_be_bought": true, "description": "Wooden helmet", "groups": [ { "external_id": "armour", "name": "Armour" } ], "image_url": "https://cdn3.xsolla.com/img/misc/images/40d2812e52ad9d988ac20fc842fc66f0.png", "is_free": false, "item_id": 259777, "name": "Wooden helmet", "price": { "amount": "0.99", "amount_without_discount": "0.99", "currency": "USD" }, "promotions": [], "sku": "com.xsolla.wooden_helmet_1", "type": "virtual_good", "virtual_item_type": "non_consumable", "virtual_prices": [ { "amount": 1, "amount_without_discount": 1, "calculated_price": { "amount": "1.00", "amount_without_discount": "1.00" }, "description": null, "image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png", "is_default": true, "item_id": 259765, "name": "Gold", "sku": "com.xsolla.gold_4", "type": "virtual_currency" }, { "amount": 2, "amount_without_discount": 2, "calculated_price": { "amount": "2.00", "amount_without_discount": "2.00" }, "description": null, "image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png", "is_default": false, "item_id": 259766, "name": "Silver", "sku": "com.xsolla.silver_4", "type": "virtual_currency" }, { "amount": 20, "amount_without_discount": 20, "calculated_price": { "amount": "20.00", "amount_without_discount": "20.00" }, "description": null, "image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png", "is_default": false, "item_id": 259767, "name": "Bronze", "sku": "com.xsolla.bronze_4", "type": "virtual_currency" } ], "vp_rewards": [] } ], "items": { "properties": { "attributes": { "$ref": "#/components/schemas/Virtual-Items-Currency_client-attributes" }, "can_be_bought": { "description": "`true`일 경우 사용자는 아이템을 구매할 수 있습니다.", "example": true, "type": "boolean" }, "custom_attributes": { "$ref": "#/components/schemas/item-custom-attributes-response" }, "description": { "description": "아이템 설명입니다.", "example": "Electric shield", "type": [ "string", "null" ] }, "groups": { "$ref": "#/components/schemas/items_client_groups_response" }, "image_url": { "description": "이미지 URL입니다.", "example": "https://cdn3.xsolla.com/img/misc/images/d2d6b1b517e6a7f3765c3bb5a3cfb87d.png", "type": "string" }, "is_free": { "$ref": "#/components/schemas/value-is_free" }, "item_id": { "description": "아이템 생성 시 제공되는 내부의 고유 아이템 ID입니다.", "example": 259774, "type": "integer" }, "limits": { "$ref": "#/components/schemas/Catalog_item_limits" }, "name": { "description": "아이템 이름입니다.", "example": "Electric shield", "type": "string" }, "price": { "description": "아이템 가격입니다.", "properties": { "amount": { "description": "할인된 아이템 가격입니다.", "example": "9.99", "type": "string" }, "amount_without_discount": { "description": "아이템 가격입니다.", "example": "9.99", "type": "string" }, "currency": { "description": "아이템 가격 통화입니다. [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)에 따른 3자리 코드입니다.", "example": "USD", "type": "string" } }, "type": "object" }, "promotions": { "$ref": "#/components/schemas/Catalog_item_promotions" }, "sku": { "description": "고유한 아이템 ID입니다. SKU는 소문자 및 대문자 라틴 영숫자, 마침표, 대시 및 밑줄만 포함할 수 있습니다.", "example": "com.xsolla.electric_shield_1", "type": "string" }, "type": { "description": "아이템 유형: `virtual_good`/`virtual_currency`/`bundle`/`game_key`/`physical_good`.", "enum": [ "virtual_good", "virtual_currency", "bundle", "game_key", "physical_good" ], "example": "virtual_good", "type": "string" }, "virtual_item_type": { "description": "Type of virtual item.\n\nPossible values:\n- `consumable` — An item that disappears from the inventory after use (e.g., ammo).\n- `non_consumable` — An item that stays in the inventory for an unlimited period of time.\n- `non_renewing_subscription` — Time-limited item that can represent access to services or content for a limited period of time.", "enum": [ "consumable", "non_consumable", "non_renewing_subscription" ], "example": "non_consumable", "type": "string" }, "virtual_prices": { "description": "가상 가격입니다.", "items": { "description": "가상 가격입니다.", "properties": { "amount": { "description": "인게임 재화로 표시된 할인된 아이템 가격입니다.", "example": 10, "type": "integer" }, "amount_without_discount": { "description": "아이템 가격입니다.", "example": 10, "type": "integer" }, "calculated_price": { "properties": { "amount": { "type": "string" }, "amount_without_discount": { "type": "string" } }, "type": "object" }, "description": { "description": "인게임 재화 설명입니다.", "example": null, "type": [ "string", "null" ] }, "image_url": { "example": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png", "type": "string" }, "is_default": { "description": "아이템의 가격이 기본값인지 여부입니다.", "example": true, "type": "boolean" }, "item_id": { "description": "아이템 생성 시 제공되는 내부의 고유 아이템 ID입니다.", "example": 259774, "type": "integer" }, "name": { "description": "인게임 재화 이름입니다.", "example": "Gold", "type": "string" }, "sku": { "description": "인게임 재화 아이템 SKU입니다.", "example": "com.xsolla.gold_1", "type": "string" }, "type": { "description": "인게임 재화 유형입니다.", "example": "virtual_currency", "type": "string" } }, "type": "object" }, "type": "array" }, "vp_rewards": { "$ref": "#/components/schemas/client-item-value-point-reward" } }, "type": "object" }, "type": "array" } }, "type": "object" } } }, "description": "지정한 그룹의 판매할 수 있는 아이템 목록을 성공적으로 수신했습니다." }, "sellable_items_200-get-items-list": { "content": { "application/json": { "examples": { "response": { "value": { "has_more": false, "items": [ { "attributes": [], "can_be_bought": true, "custom_attributes": { "attr": "value", "purchased": 0 }, "description": "", "groups": [], "image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png", "is_free": false, "item_id": 259765, "limits": null, "name": "Gold", "price": { "amount": "1.00", "amount_without_discount": "1.00", "currency": "USD" }, "promotions": [ { "bonus": [ { "image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png", "name": "Xsolla Minigun", "quantity": 1, "sku": "com.xsolla.minigun_1", "type": "virtual_good" } ], "date_end": "2026-04-15T16:16:00+03:00", "date_start": "2020-04-15T16:16:00+03:00", "discount": { "percent": "50.00" }, "name": "Bonus promotion" } ], "sku": "com.xsolla.gold_1", "type": "virtual_currency", "virtual_prices": [], "vp_rewards": [ { "amount": 130, "image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg", "item_id": 175232, "name": "Value point", "sku": "com.xsolla.value_point_1" }, { "amount": 50, "image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg", "is_clan": true, "item_id": 186321, "name": "Clan Reward VP 1", "sku": "com.xsolla.clan_value_point_1" } ] }, { "attributes": [], "can_be_bought": true, "description": "", "groups": [], "image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png", "is_free": false, "item_id": 259766, "name": "Silver", "price": { "amount": "0.50", "amount_without_discount": "0.50", "currency": "USD" }, "promotions": [ { "bonus": [ { "image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png", "name": "Xsolla Minigun", "quantity": 1, "sku": "com.xsolla.minigun_1", "type": "virtual_good" } ], "date_end": "2026-04-15T16:16:00+03:00", "date_start": "2020-04-15T16:16:00+03:00", "discount": { "percent": "50.00" }, "name": "Bonus promotion" } ], "sku": "com.xsolla.silver_1", "type": "virtual_currency", "virtual_prices": [], "vp_rewards": [] }, { "attributes": [], "can_be_bought": true, "description": "", "groups": [], "image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png", "is_free": false, "item_id": 259767, "name": "Bronze", "price": { "amount": "0.10", "amount_without_discount": "0.10", "currency": "USD" }, "promotions": [ { "bonus": [ { "image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png", "name": "Xsolla Minigun", "quantity": 1, "sku": "com.xsolla.minigun_1", "type": "virtual_good" } ], "date_end": "2026-04-15T16:16:00+03:00", "date_start": "2020-04-15T16:16:00+03:00", "discount": { "percent": "50.00" }, "name": "Bonus promotion" } ], "sku": "com.xsolla.bronze_1", "type": "virtual_currency", "virtual_prices": [], "vp_rewards": [] }, { "attributes": [], "bundle_type": "virtual_currency_package", "can_be_bought": true, "content": [ { "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png", "item_id": 259765, "name": "Gold", "quantity": 10, "sku": "com.xsolla.gold_2", "type": "virtual_currency" } ], "description": "Chest of gold", "groups": [], "image_url": "https://cdn3.xsolla.com/img/misc/images/61b8d0785093017ce1f50ebed55c42a9.png", "is_free": false, "item_id": 259768, "name": "Chest of gold", "price": { "amount": "7.99", "amount_without_discount": "7.99", "currency": "USD" }, "promotions": [ { "bonus": [ { "image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png", "name": "Xsolla Minigun", "quantity": 1, "sku": "com.xsolla.minigun_1", "type": "virtual_good" } ], "date_end": "2026-04-15T16:16:00+03:00", "date_start": "2020-04-15T16:16:00+03:00", "discount": { "percent": "50.00" }, "name": "Bonus promotion" } ], "sku": "com.xsolla.gold_chest_1", "type": "bundle", "virtual_prices": [], "vp_rewards": [] }, { "attributes": [], "bundle_type": "virtual_currency_package", "can_be_bought": true, "content": [ { "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png", "item_id": 259766, "name": "Silver", "quantity": 50, "sku": "com.xsolla.silver_2", "type": "virtual_currency" } ], "description": "Chest of silver", "groups": [], "image_url": "https://cdn3.xsolla.com/img/misc/images/f0b59a3370404e8881107249051b70bd.png", "is_free": false, "item_id": 259769, "name": "Chest of silver", "price": { "amount": "19.99", "amount_without_discount": "19.99", "currency": "USD" }, "promotions": [ { "bonus": [ { "image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png", "name": "Xsolla Minigun", "quantity": 1, "sku": "com.xsolla.minigun_1", "type": "virtual_good" } ], "date_end": "2026-04-15T16:16:00+03:00", "date_start": "2020-04-15T16:16:00+03:00", "discount": { "percent": "50.00" }, "name": "Bonus promotion" } ], "sku": "com.xsolla.silver_chest_1", "type": "bundle", "virtual_prices": [], "vp_rewards": [] }, { "attributes": [], "bundle_type": "virtual_currency_package", "can_be_bought": true, "content": [ { "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png", "item_id": 259767, "name": "Bronze", "quantity": 100, "sku": "com.xsolla.bronze_1", "type": "virtual_currency" } ], "description": "Chest of bronze", "groups": [], "image_url": "https://cdn3.xsolla.com/img/misc/images/b32eb5b1f4f0c202ea6ac4e21c2eae18.png", "is_free": false, "item_id": 259770, "name": "Chest of bronze", "price": { "amount": "5.99", "amount_without_discount": "5.99", "currency": "USD" }, "promotions": [ { "bonus": [ { "image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png", "name": "Xsolla Minigun", "quantity": 1, "sku": "com.xsolla.minigun_1", "type": "virtual_good" } ], "date_end": "2026-04-15T16:16:00+03:00", "date_start": "2020-04-15T16:16:00+03:00", "discount": { "percent": "50.00" }, "name": "Bonus promotion" } ], "sku": "com.xsolla.bronze_chest_1", "type": "bundle", "virtual_prices": [], "vp_rewards": [] }, { "attributes": [], "can_be_bought": true, "description": "Sword", "groups": [ { "external_id": "swords", "item_order_in_group": 1, "name": "Swords" } ], "image_url": "https://cdn3.xsolla.com/img/misc/images/a558727a420cad609556e4449b9ecb12.png", "is_free": false, "item_id": 259771, "name": "Sword", "price": { "amount": "1.99", "amount_without_discount": "1.99", "currency": "USD" }, "promotions": [ { "bonus": [ { "image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png", "name": "Xsolla Minigun", "quantity": 1, "sku": "com.xsolla.minigun_1", "type": "virtual_good" } ], "date_end": "2026-04-15T16:16:00+03:00", "date_start": "2020-04-15T16:16:00+03:00", "discount": { "percent": "50.00" }, "name": "Bonus promotion" } ], "sku": "com.xsolla.sword_1", "type": "virtual_good", "virtual_item_type": "non_consumable", "virtual_prices": [ { "amount": 2, "amount_without_discount": 2, "calculated_price": { "amount": "2.00", "amount_without_discount": "2.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png", "is_default": true, "item_id": 259765, "name": "Gold", "sku": "com.xsolla.gold_2", "type": "virtual_currency" }, { "amount": 5, "amount_without_discount": 5, "calculated_price": { "amount": "5.00", "amount_without_discount": "5.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png", "is_default": false, "item_id": 259766, "name": "Silver", "sku": "com.xsolla.silver_2", "type": "virtual_currency" }, { "amount": 50, "amount_without_discount": 50, "calculated_price": { "amount": "50.00", "amount_without_discount": "50.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png", "is_default": false, "item_id": 259767, "name": "Bronze", "sku": "com.xsolla.bronze_2", "type": "virtual_currency" } ], "vp_rewards": [] }, { "attributes": [], "can_be_bought": true, "description": "Saber", "groups": [ { "external_id": "swords", "item_order_in_group": 2, "name": "Swords" } ], "image_url": "https://cdn3.xsolla.com/img/misc/images/edd914d60301d77b94926478d253fcb6.png", "is_free": false, "item_id": 259772, "name": "Saber", "price": { "amount": "3.99", "amount_without_discount": "3.99", "currency": "USD" }, "promotions": [], "sku": "com.xsolla.saber_1", "type": "virtual_good", "virtual_item_type": "non_consumable", "virtual_prices": [ { "amount": 3, "amount_without_discount": 3, "calculated_price": { "amount": "3.00", "amount_without_discount": "3.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png", "is_default": true, "item_id": 259765, "name": "Gold", "sku": "com.xsolla.gold_3", "type": "virtual_currency" }, { "amount": 7, "amount_without_discount": 7, "calculated_price": { "amount": "7.00", "amount_without_discount": "7.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png", "is_default": false, "item_id": 259766, "name": "Silver", "sku": "com.xsolla.silver_3", "type": "virtual_currency" }, { "amount": 70, "amount_without_discount": 70, "calculated_price": { "amount": "70.00", "amount_without_discount": "70.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png", "is_default": false, "item_id": 259767, "name": "Bronze", "sku": "com.xsolla.bronze_3", "type": "virtual_currency" } ], "vp_rewards": [] }, { "attributes": [], "can_be_bought": true, "description": "Bow", "groups": [ { "external_id": "bows", "item_order_in_group": 1, "name": "Bows" } ], "image_url": "https://cdn3.xsolla.com/img/misc/images/3bb3b0a5254ad15134c891108898363f.png", "is_free": false, "item_id": 259773, "name": "Bow", "price": { "amount": "4.99", "amount_without_discount": "4.99", "currency": "USD" }, "promotions": [], "sku": "com.xsolla.bow_1", "type": "virtual_good", "virtual_item_type": "non_consumable", "virtual_prices": [ { "amount": 5, "amount_without_discount": 5, "calculated_price": { "amount": "5.00", "amount_without_discount": "5.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png", "is_default": true, "item_id": 259765, "name": "Gold", "sku": "com.xsolla.gold_4", "type": "virtual_currency" }, { "amount": 10, "amount_without_discount": 10, "calculated_price": { "amount": "10.00", "amount_without_discount": "10.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png", "is_default": false, "item_id": 259766, "name": "Silver", "sku": "com.xsolla.silver_4", "type": "virtual_currency" }, { "amount": 100, "amount_without_discount": 100, "calculated_price": { "amount": "100.00", "amount_without_discount": "100.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png", "is_default": false, "item_id": 259767, "name": "Bronze", "sku": "com.xsolla.bronze_5", "type": "virtual_currency" } ], "vp_rewards": [] }, { "attributes": [], "can_be_bought": true, "description": "Electric shield", "groups": [ { "external_id": "armour", "item_order_in_group": 1, "name": "Armour" } ], "image_url": "https://cdn3.xsolla.com/img/misc/images/d2d6b1b517e6a7f3765c3bb5a3cfb87d.png", "is_free": false, "item_id": 259774, "name": "Electric shield", "price": { "amount": "9.99", "amount_without_discount": "9.99", "currency": "USD" }, "promotions": [], "sku": "com.xsolla.electric_shield_2", "type": "virtual_good", "virtual_item_type": "non_consumable", "virtual_prices": [ { "amount": 10, "amount_without_discount": 10, "calculated_price": { "amount": "10.00", "amount_without_discount": "10.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png", "is_default": true, "item_id": 259765, "name": "Gold", "sku": "com.xsolla.gold_5", "type": "virtual_currency" }, { "amount": 20, "amount_without_discount": 20, "calculated_price": { "amount": "20.00", "amount_without_discount": "20.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png", "is_default": false, "item_id": 259766, "name": "Silver", "sku": "com.xsolla.silver_5", "type": "virtual_currency" }, { "amount": 200, "amount_without_discount": 200, "calculated_price": { "amount": "200.00", "amount_without_discount": "200.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png", "is_default": false, "item_id": 259767, "name": "Bronze", "sku": "com.xsolla.bronze_5", "type": "virtual_currency" } ], "vp_rewards": [] }, { "attributes": [], "can_be_bought": true, "description": "Royal shield", "groups": [ { "external_id": "armour", "item_order_in_group": 2, "name": "Armour" } ], "image_url": "https://cdn3.xsolla.com/img/misc/images/ed417975312a52efeeab8b039ff25cb1.png", "is_free": false, "item_id": 259775, "name": "Royal shield", "price": { "amount": "19.99", "amount_without_discount": "19.99", "currency": "USD" }, "promotions": [ { "bonus": [ { "image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png", "name": "Xsolla Minigun", "quantity": 1, "sku": "com.xsolla.minigun_1", "type": "virtual_good" } ], "date_end": "2026-04-15T16:16:00+03:00", "date_start": "2020-04-15T16:16:00+03:00", "discount": { "percent": "50.00" }, "name": "Bonus promotion" } ], "sku": "com.xsolla.royal_shield_2", "type": "virtual_good", "virtual_item_type": "non_consumable", "virtual_prices": [ { "amount": 20, "amount_without_discount": 20, "calculated_price": { "amount": "20.00", "amount_without_discount": "20.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png", "is_default": true, "item_id": 259765, "name": "Gold", "sku": "com.xsolla.gold_6", "type": "virtual_currency" }, { "amount": 40, "amount_without_discount": 40, "calculated_price": { "amount": "40.00", "amount_without_discount": "40.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png", "is_default": false, "item_id": 259766, "name": "Silver", "sku": "com.xsolla.silver_6", "type": "virtual_currency" }, { "amount": 400, "amount_without_discount": 400, "calculated_price": { "amount": "400.00", "amount_without_discount": "400.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png", "is_default": false, "item_id": 259767, "name": "Bronze", "sku": "com.xsolla.bronze_6", "type": "virtual_currency" } ], "vp_rewards": [] }, { "attributes": [], "can_be_bought": true, "description": "Ancient helmet", "groups": [ { "external_id": "armour", "item_order_in_group": 3, "name": "Armour" } ], "image_url": "https://cdn3.xsolla.com/img/misc/images/e70e16d9626f435e519fc8e1cc1e7176.png", "is_free": false, "item_id": 259776, "name": "Ancient helmet", "price": { "amount": "1.99", "amount_without_discount": "1.99", "currency": "USD" }, "promotions": [], "sku": "com.xsolla.ancient_helmet_1", "type": "virtual_good", "virtual_item_type": "non_consumable", "virtual_prices": [ { "amount": 2, "amount_without_discount": 2, "calculated_price": { "amount": "2.00", "amount_without_discount": "2.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png", "is_default": true, "item_id": 259765, "name": "Gold", "sku": "com.xsolla.gold_7", "type": "virtual_currency" }, { "amount": 4, "amount_without_discount": 4, "calculated_price": { "amount": "4.00", "amount_without_discount": "4.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png", "is_default": false, "item_id": 259766, "name": "Silver", "sku": "com.xsolla.silver_7", "type": "virtual_currency" }, { "amount": 40, "amount_without_discount": 40, "calculated_price": { "amount": "40.00", "amount_without_discount": "40.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png", "is_default": false, "item_id": 259767, "name": "Bronze", "sku": "com.xsolla.bronze_7", "type": "virtual_currency" } ], "vp_rewards": [] }, { "attributes": [], "can_be_bought": true, "description": "Wooden helmet", "groups": [ { "external_id": "armour", "item_order_in_group": 4, "name": "Armour" } ], "image_url": "https://cdn3.xsolla.com/img/misc/images/40d2812e52ad9d988ac20fc842fc66f0.png", "is_free": false, "item_id": 259777, "name": "Wooden helmet", "price": { "amount": "0.99", "amount_without_discount": "0.99", "currency": "USD" }, "promotions": [ { "bonus": [ { "image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png", "name": "Xsolla Minigun", "quantity": 1, "sku": "com.xsolla.minigun_1", "type": "virtual_good" } ], "date_end": "2026-04-15T16:16:00+03:00", "date_start": "2020-04-15T16:16:00+03:00", "discount": { "percent": "50.00" }, "name": "Bonus promotion" } ], "sku": "com.xsolla.wooden_helmet_1", "type": "virtual_good", "virtual_item_type": "non_consumable", "virtual_prices": [ { "amount": 1, "amount_without_discount": 1, "calculated_price": { "amount": "1.00", "amount_without_discount": "1.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png", "is_default": true, "item_id": 259765, "name": "Gold", "sku": "com.xsolla.gold_8", "type": "virtual_currency" }, { "amount": 2, "amount_without_discount": 2, "calculated_price": { "amount": "2.00", "amount_without_discount": "2.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png", "is_default": false, "item_id": 259766, "name": "Silver", "sku": "com.xsolla.silver_8", "type": "virtual_currency" }, { "amount": 20, "amount_without_discount": 20, "calculated_price": { "amount": "20.00", "amount_without_discount": "20.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png", "is_default": false, "item_id": 259767, "name": "Bronze", "sku": "com.xsolla.bronze_8", "type": "virtual_currency" } ], "vp_rewards": [] }, { "attributes": [], "bundle_type": "standard", "can_be_bought": true, "content": [ { "attributes": [], "can_be_bought": true, "description": "Electric shield", "groups": [ { "external_id": "armour", "name": "Armour" } ], "image_url": "https://cdn3.xsolla.com/img/misc/images/d2d6b1b517e6a7f3765c3bb5a3cfb87d.png", "is_free": false, "item_id": 259774, "name": "Electric shield", "price": { "amount": "9.99", "amount_without_discount": "9.99", "currency": "USD" }, "promotions": [ { "bonus": [ { "image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png", "name": "Xsolla Minigun", "quantity": 1, "sku": "com.xsolla.minigun_1", "type": "virtual_good" } ], "date_end": "2026-04-15T16:16:00+03:00", "date_start": "2020-04-15T16:16:00+03:00", "discount": { "percent": "50.00" }, "name": "Bonus promotion" } ], "quantity": 1, "sku": "com.xsolla.electric_shield_2", "type": "virtual_good", "virtual_item_type": "non_consumable", "virtual_prices": [ { "amount": 10, "amount_without_discount": 10, "calculated_price": { "amount": "10.00", "amount_without_discount": "10.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png", "is_default": true, "item_id": 259765, "name": "Gold", "sku": "com.xsolla.gold_10", "type": "virtual_currency" }, { "amount": 20, "amount_without_discount": 20, "calculated_price": { "amount": "20.00", "amount_without_discount": "20.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png", "is_default": false, "item_id": 259766, "name": "Silver", "sku": "com.xsolla.silver_10", "type": "virtual_currency" }, { "amount": 200, "amount_without_discount": 200, "calculated_price": { "amount": "200.00", "amount_without_discount": "200.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png", "is_default": false, "item_id": 259767, "name": "Bronze", "sku": "com.xsolla.bronze_10", "type": "virtual_currency" } ] }, { "attributes": [], "can_be_bought": true, "description": "Ancient helmet", "groups": [ { "external_id": "armour", "name": "Armour" } ], "image_url": "https://cdn3.xsolla.com/img/misc/images/e70e16d9626f435e519fc8e1cc1e7176.png", "is_free": false, "item_id": 259776, "name": "Ancient helmet", "price": { "amount": "1.99", "amount_without_discount": "1.99", "currency": "USD" }, "promotions": [ { "bonus": [ { "image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png", "name": "Xsolla Minigun", "quantity": 1, "sku": "com.xsolla.minigun_1", "type": "virtual_good" } ], "date_end": "2026-04-15T16:16:00+03:00", "date_start": "2020-04-15T16:16:00+03:00", "discount": { "percent": "50.00" }, "name": "Bonus promotion" } ], "quantity": 1, "sku": "com.xsolla.ancient_helmet_2", "type": "virtual_good", "virtual_item_type": "non_consumable", "virtual_prices": [ { "amount": 2, "amount_without_discount": 2, "calculated_price": { "amount": "2.00", "amount_without_discount": "2.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png", "is_default": true, "item_id": 259765, "name": "Gold", "sku": "com.xsolla.gold_11", "type": "virtual_currency" }, { "amount": 4, "amount_without_discount": 4, "calculated_price": { "amount": "4.00", "amount_without_discount": "4.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png", "is_default": false, "item_id": 259766, "name": "Silver", "sku": "com.xsolla.silver_11", "type": "virtual_currency" }, { "amount": 40, "amount_without_discount": 40, "calculated_price": { "amount": "40.00", "amount_without_discount": "40.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png", "is_default": false, "item_id": 259767, "name": "Bronze", "sku": "com.xsolla.bronze_11", "type": "virtual_currency" } ] } ], "description": "Chest of armour", "groups": [], "image_url": "https://cdn3.xsolla.com/img/misc/images/5212202f9b8c9dbd254652d6cbeba03e.png", "is_free": false, "item_id": 259778, "name": "Chest of armor", "price": { "amount": "19.99", "amount_without_discount": "19.99", "currency": "USD" }, "promotions": [ { "bonus": [ { "image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png", "name": "Xsolla Minigun", "quantity": 1, "sku": "com.xsolla.minigun_1", "type": "virtual_good" } ], "date_end": "2026-04-15T16:16:00+03:00", "date_start": "2020-04-15T16:16:00+03:00", "discount": { "percent": "50.00" }, "name": "Bonus promotion" } ], "sku": "com.xsolla.armor_chest_1", "total_content_price": { "amount": "11.98", "amount_without_discount": "11.98", "currency": "USD" }, "type": "bundle", "virtual_prices": [ { "amount": 20, "amount_without_discount": 20, "calculated_price": { "amount": "20.00", "amount_without_discount": "20.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png", "is_default": true, "item_id": 259765, "name": "Gold", "sku": "com.xsolla.gold_9", "type": "virtual_currency" }, { "amount": 40, "amount_without_discount": 40, "calculated_price": { "amount": "40.00", "amount_without_discount": "40.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png", "is_default": false, "item_id": 259766, "name": "Silver", "sku": "com.xsolla.silver_9", "type": "virtual_currency" }, { "amount": 400, "amount_without_discount": 400, "calculated_price": { "amount": "400.00", "amount_without_discount": "400.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png", "is_default": false, "item_id": 259767, "name": "Bronze", "sku": "com.xsolla.bronze_9", "type": "virtual_currency" } ], "vp_rewards": [] }, { "attributes": [], "bundle_type": "standard", "can_be_bought": true, "content": [ { "attributes": [], "can_be_bought": true, "description": "Saber", "groups": [ { "external_id": "swords", "name": "Swords" } ], "image_url": "https://cdn3.xsolla.com/img/misc/images/edd914d60301d77b94926478d253fcb6.png", "is_free": false, "item_id": 259772, "name": "Saber", "price": { "amount": "3.99", "amount_without_discount": "3.99", "currency": "USD" }, "quantity": 1, "sku": "com.xsolla.saber_1", "type": "virtual_good", "virtual_item_type": "non_consumable", "virtual_prices": [ { "amount": 3, "amount_without_discount": 3, "calculated_price": { "amount": "3.00", "amount_without_discount": "3.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png", "is_default": true, "item_id": 259765, "name": "Gold", "sku": "com.xsolla.gold_13", "type": "virtual_currency" }, { "amount": 7, "amount_without_discount": 7, "calculated_price": { "amount": "7.00", "amount_without_discount": "7.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png", "is_default": false, "item_id": 259766, "name": "Silver", "sku": "com.xsolla.silver_13", "type": "virtual_currency" }, { "amount": 70, "amount_without_discount": 70, "calculated_price": { "amount": "70.00", "amount_without_discount": "70.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png", "is_default": false, "item_id": 259767, "name": "Bronze", "sku": "com.xsolla.bronze_13", "type": "virtual_currency" } ] }, { "attributes": [], "bundle_type": "virtual_currency_package", "can_be_bought": true, "content": [ { "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png", "item_id": 259766, "name": "Silver", "quantity": 50, "sku": "com.xsolla.silver_13", "type": "virtual_currency" } ], "description": "Chest of silver", "groups": [], "image_url": "https://cdn3.xsolla.com/img/misc/images/f0b59a3370404e8881107249051b70bd.png", "is_free": false, "item_id": 259769, "name": "Chest of silver", "price": { "amount": "19.99", "amount_without_discount": "19.99", "currency": "USD" }, "promotions": [], "quantity": 10, "sku": "com.xsolla.silver_chest_2", "type": "bundle", "virtual_prices": [] }, { "attributes": [], "bundle_type": "virtual_currency_package", "can_be_bought": true, "content": [ { "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png", "item_id": 259767, "name": "Bronze", "quantity": 100, "sku": "com.xsolla.bronze_13", "type": "virtual_currency" } ], "description": "Chest of bronze", "groups": [], "image_url": "https://cdn3.xsolla.com/img/misc/images/b32eb5b1f4f0c202ea6ac4e21c2eae18.png", "is_free": false, "item_id": 259770, "name": "Chest of bronze", "price": { "amount": "5.99", "amount_without_discount": "5.99", "currency": "USD" }, "promotions": [], "quantity": 100, "sku": "com.xsolla.bronze_chest_2", "type": "bundle", "virtual_prices": [] } ], "description": "Treasure Chest", "groups": [], "image_url": "https://cdn3.xsolla.com/img/misc/images/7b1c0136d91398f9ab17924deee5eeec.png", "is_free": false, "item_id": 259779, "name": "Treasure Chest", "price": { "amount": "9.99", "amount_without_discount": "9.99", "currency": "USD" }, "promotions": [ { "bonus": [ { "image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png", "name": "Xsolla Minigun", "quantity": 1, "sku": "com.xsolla.minigun_1", "type": "virtual_good" } ], "date_end": "2026-04-15T16:16:00+03:00", "date_start": "2020-04-15T16:16:00+03:00", "discount": { "percent": "50.00" }, "name": "Bonus promotion" } ], "sku": "com.xsolla.treasure_chest_1", "total_content_price": { "amount": "802.89", "amount_without_discount": "802.89", "currency": "USD" }, "type": "bundle", "virtual_prices": [ { "amount": 10, "amount_without_discount": 10, "calculated_price": { "amount": "10.00", "amount_without_discount": "10.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png", "is_default": true, "item_id": 259765, "name": "Gold", "sku": "com.xsolla.gold_12", "type": "virtual_currency" }, { "amount": 20, "amount_without_discount": 20, "calculated_price": { "amount": "20.00", "amount_without_discount": "20.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png", "is_default": false, "item_id": 259766, "name": "Silver", "sku": "com.xsolla.silver_12", "type": "virtual_currency" }, { "amount": 40, "amount_without_discount": 40, "calculated_price": { "amount": "40.00", "amount_without_discount": "40.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png", "is_default": false, "item_id": 259767, "name": "Bronze", "sku": "com.xsolla.bronze_12", "type": "virtual_currency" } ], "vp_rewards": [] } ] } } }, "schema": { "description": "판매할 수 있는 아이템이 있는 개체입니다.", "properties": { "has_more": { "$ref": "#/components/schemas/Pagination_has-more" }, "items": { "example": [ { "attributes": [], "can_be_bought": true, "description": "", "groups": [], "image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png", "is_free": false, "item_id": 259765, "limits": { "per_user": { "available": 3, "limit_exceeded_visibility": "show", "recurrent_schedule": { "interval_type": "weekly", "reset_next_date": 1746057600 }, "total": 5 } }, "name": "Gold", "price": { "amount": "1.00", "amount_without_discount": "1.00", "currency": "USD" }, "sku": "com.xsolla.gold_1", "type": "virtual_currency", "virtual_prices": [], "vp_rewards": [ { "amount": 130, "image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg", "item_id": 175232, "name": "Value point", "sku": "com.xsolla.value_point_1" }, { "amount": 50, "image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg", "is_clan": true, "item_id": 186321, "name": "Clan Reward VP 1", "sku": "com.xsolla.clan_value_point_1" } ] }, { "attributes": [], "can_be_bought": true, "description": "", "groups": [], "image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png", "is_free": false, "item_id": 259766, "limits": null, "name": "Silver", "price": { "amount": "0.50", "amount_without_discount": "0.50", "currency": "USD" }, "sku": "com.xsolla.silver_1", "type": "virtual_currency", "virtual_prices": [], "vp_rewards": [] }, { "attributes": [], "can_be_bought": true, "description": "", "groups": [], "image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png", "is_free": false, "item_id": 259767, "limits": null, "name": "Bronze", "price": { "amount": "0.10", "amount_without_discount": "0.10", "currency": "USD" }, "sku": "com.xsolla.bronze_1", "type": "virtual_currency", "virtual_prices": [], "vp_rewards": [] }, { "attributes": [], "bundle_type": "virtual_currency_package", "can_be_bought": true, "content": [ { "description": null, "image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png", "item_id": 259765, "name": "Gold", "quantity": 10, "sku": "com.xsolla.gold_1", "type": "virtual_currency" } ], "description": "Chest of gold", "groups": [], "image_url": "https://cdn3.xsolla.com/img/misc/images/61b8d0785093017ce1f50ebed55c42a9.png", "is_free": false, "item_id": 259768, "limits": null, "name": "Chest of gold", "price": { "amount": "7.99", "amount_without_discount": "7.99", "currency": "USD" }, "sku": "com.xsolla.gold_chest_1", "type": "bundle", "virtual_prices": [], "vp_rewards": [] }, { "attributes": [], "bundle_type": "virtual_currency_package", "can_be_bought": true, "content": [ { "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png", "item_id": 259766, "name": "Silver", "quantity": 50, "sku": "com.xsolla.silver_1", "type": "virtual_currency" } ], "description": "Chest of silver", "groups": [], "image_url": "https://cdn3.xsolla.com/img/misc/images/f0b59a3370404e8881107249051b70bd.png", "is_free": false, "item_id": 259769, "limits": null, "name": "Chest of silver", "price": { "amount": "19.99", "amount_without_discount": "19.99", "currency": "USD" }, "sku": "com.xsolla.silver_chest_1", "type": "bundle", "virtual_prices": [], "vp_rewards": [] }, { "attributes": [], "bundle_type": "virtual_currency_package", "can_be_bought": true, "content": [ { "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png", "item_id": 259767, "name": "Bronze", "quantity": 100, "sku": "com.xsolla.bronze_2", "type": "virtual_currency" } ], "description": "Chest of bronze", "groups": [], "image_url": "https://cdn3.xsolla.com/img/misc/images/b32eb5b1f4f0c202ea6ac4e21c2eae18.png", "is_free": false, "item_id": 259770, "limits": null, "name": "Chest of bronze", "price": { "amount": "5.99", "amount_without_discount": "5.99", "currency": "USD" }, "sku": "com.xsolla.bronze_chest_1", "type": "bundle", "virtual_prices": [], "vp_rewards": [] }, { "attributes": [], "can_be_bought": true, "description": "Sword", "groups": [ { "external_id": "swords", "name": "Swords" } ], "image_url": "https://cdn3.xsolla.com/img/misc/images/a558727a420cad609556e4449b9ecb12.png", "is_free": false, "item_id": 259771, "limits": null, "name": "Sword", "price": { "amount": "1.99", "amount_without_discount": "1.99", "currency": "USD" }, "sku": "com.xsolla.sword_1", "type": "virtual_good", "virtual_item_type": "non_consumable", "virtual_prices": [ { "amount": 2, "amount_without_discount": 2, "calculated_price": { "amount": "2.00", "amount_without_discount": "2.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png", "is_default": true, "item_id": 259765, "name": "Gold", "sku": "com.xsolla.gold_2", "type": "virtual_currency" }, { "amount": 5, "amount_without_discount": 5, "calculated_price": { "amount": "5.00", "amount_without_discount": "5.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png", "is_default": false, "item_id": 259766, "name": "Silver", "sku": "com.xsolla.silver_2", "type": "virtual_currency" }, { "amount": 50, "amount_without_discount": 50, "calculated_price": { "amount": "50.00", "amount_without_discount": "50.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png", "is_default": false, "item_id": 259767, "name": "Bronze", "sku": "com.xsolla.bronze_2", "type": "virtual_currency" } ], "vp_rewards": [] }, { "attributes": [], "can_be_bought": true, "description": "Saber", "groups": [ { "external_id": "swords", "name": "Swords" } ], "image_url": "https://cdn3.xsolla.com/img/misc/images/edd914d60301d77b94926478d253fcb6.png", "is_free": false, "item_id": 259772, "limits": null, "name": "Saber", "price": { "amount": "3.99", "amount_without_discount": "3.99", "currency": "USD" }, "sku": "com.xsolla.saber_1", "type": "virtual_good", "virtual_item_type": "non_consumable", "virtual_prices": [ { "amount": 3, "amount_without_discount": 3, "calculated_price": { "amount": "3.00", "amount_without_discount": "3.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png", "is_default": true, "item_id": 259765, "name": "Gold", "sku": "com.xsolla.gold_3", "type": "virtual_currency" }, { "amount": 7, "amount_without_discount": 7, "calculated_price": { "amount": "7.00", "amount_without_discount": "7.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png", "is_default": false, "item_id": 259766, "name": "Silver", "sku": "com.xsolla.silver_3", "type": "virtual_currency" }, { "amount": 70, "amount_without_discount": 70, "calculated_price": { "amount": "70.00", "amount_without_discount": "70.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png", "is_default": false, "item_id": 259767, "name": "Bronze", "sku": "com.xsolla.bronze_3", "type": "virtual_currency" } ], "vp_rewards": [] }, { "attributes": [], "can_be_bought": true, "description": "Bow", "groups": [ { "external_id": "bows", "name": "Bows" } ], "image_url": "https://cdn3.xsolla.com/img/misc/images/3bb3b0a5254ad15134c891108898363f.png", "is_free": false, "item_id": 259773, "limits": null, "name": "Bow", "price": { "amount": "4.99", "amount_without_discount": "4.99", "currency": "USD" }, "sku": "com.xsolla.bow_1", "type": "virtual_good", "virtual_item_type": "non_consumable", "virtual_prices": [ { "amount": 5, "amount_without_discount": 5, "calculated_price": { "amount": "5.00", "amount_without_discount": "5.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png", "is_default": true, "item_id": 259765, "name": "Gold", "sku": "com.xsolla.gold_4", "type": "virtual_currency" }, { "amount": 10, "amount_without_discount": 10, "calculated_price": { "amount": "10.00", "amount_without_discount": "10.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png", "is_default": false, "item_id": 259766, "name": "Silver", "sku": "com.xsolla.silver_4", "type": "virtual_currency" }, { "amount": 100, "amount_without_discount": 100, "calculated_price": { "amount": "100.00", "amount_without_discount": "100.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png", "is_default": false, "item_id": 259767, "name": "Bronze", "sku": "com.xsolla.bronze_4", "type": "virtual_currency" } ], "vp_rewards": [] }, { "attributes": [], "can_be_bought": true, "description": "Electric shield", "groups": [ { "external_id": "armour", "name": "Armour" } ], "image_url": "https://cdn3.xsolla.com/img/misc/images/d2d6b1b517e6a7f3765c3bb5a3cfb87d.png", "is_free": false, "item_id": 259774, "name": "Electric shield", "price": { "amount": "9.99", "amount_without_discount": "9.99", "currency": "USD" }, "sku": "com.xsolla.electric_shield_1", "type": "virtual_good", "virtual_item_type": "non_consumable", "virtual_prices": [ { "amount": 10, "amount_without_discount": 10, "calculated_price": { "amount": "10.00", "amount_without_discount": "10.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png", "is_default": true, "item_id": 259765, "name": "Gold", "sku": "com.xsolla.gold_5", "type": "virtual_currency" }, { "amount": 20, "amount_without_discount": 20, "calculated_price": { "amount": "20.00", "amount_without_discount": "20.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png", "is_default": false, "item_id": 259766, "name": "Silver", "sku": "com.xsolla.silver_5", "type": "virtual_currency" }, { "amount": 200, "amount_without_discount": 200, "calculated_price": { "amount": "200.00", "amount_without_discount": "200.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png", "is_default": false, "item_id": 259767, "name": "Bronze", "sku": "com.xsolla.bronze_5", "type": "virtual_currency" } ], "vp_rewards": [] }, { "attributes": [], "can_be_bought": true, "description": "Royal shield", "groups": [ { "external_id": "armour", "name": "Armour" } ], "image_url": "https://cdn3.xsolla.com/img/misc/images/ed417975312a52efeeab8b039ff25cb1.png", "is_free": false, "item_id": 259775, "name": "Royal shield", "price": { "amount": "19.99", "amount_without_discount": "19.99", "currency": "USD" }, "sku": "com.xsolla.royal_shield_1", "type": "virtual_good", "virtual_item_type": "non_consumable", "virtual_prices": [ { "amount": 20, "amount_without_discount": 20, "calculated_price": { "amount": "20.00", "amount_without_discount": "20.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png", "is_default": true, "item_id": 259765, "name": "Gold", "sku": "com.xsolla.gold_6", "type": "virtual_currency" }, { "amount": 40, "amount_without_discount": 40, "calculated_price": { "amount": "40.00", "amount_without_discount": "40.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png", "is_default": false, "item_id": 259766, "name": "Silver", "sku": "com.xsolla.silver_6", "type": "virtual_currency" }, { "amount": 400, "amount_without_discount": 400, "calculated_price": { "amount": "400.00", "amount_without_discount": "400.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png", "is_default": false, "item_id": 259767, "name": "Bronze", "sku": "com.xsolla.bronze_6", "type": "virtual_currency" } ], "vp_rewards": [] }, { "attributes": [], "can_be_bought": true, "description": "Ancient helmet", "groups": [ { "external_id": "armour", "name": "Armour" } ], "image_url": "https://cdn3.xsolla.com/img/misc/images/e70e16d9626f435e519fc8e1cc1e7176.png", "is_free": false, "item_id": 259776, "name": "Ancient helmet", "price": { "amount": "1.99", "amount_without_discount": "1.99", "currency": "USD" }, "sku": "com.xsolla.ancient_helmet_1", "type": "virtual_good", "virtual_item_type": "non_consumable", "virtual_prices": [ { "amount": 2, "amount_without_discount": 2, "calculated_price": { "amount": "2.00", "amount_without_discount": "2.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png", "is_default": true, "item_id": 259765, "name": "Gold", "sku": "com.xsolla.gold_7", "type": "virtual_currency" }, { "amount": 4, "amount_without_discount": 4, "calculated_price": { "amount": "4.00", "amount_without_discount": "4.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png", "is_default": false, "item_id": 259766, "name": "Silver", "sku": "com.xsolla.silver_7", "type": "virtual_currency" }, { "amount": 40, "amount_without_discount": 40, "calculated_price": { "amount": "40.00", "amount_without_discount": "40.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png", "is_default": false, "item_id": 259767, "name": "Bronze", "sku": "com.xsolla.bronze_7", "type": "virtual_currency" } ], "vp_rewards": [] }, { "attributes": [], "can_be_bought": true, "description": "Wooden helmet", "groups": [ { "external_id": "armour", "name": "Armour" } ], "image_url": "https://cdn3.xsolla.com/img/misc/images/40d2812e52ad9d988ac20fc842fc66f0.png", "is_free": false, "item_id": 259777, "name": "Wooden helmet", "price": { "amount": "0.99", "amount_without_discount": "0.99", "currency": "USD" }, "sku": "com.xsolla.wooden_helmet_1", "type": "virtual_good", "virtual_item_type": "non_consumable", "virtual_prices": [ { "amount": 1, "amount_without_discount": 1, "calculated_price": { "amount": "1.00", "amount_without_discount": "1.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png", "is_default": true, "item_id": 259765, "name": "Gold", "sku": "com.xsolla.gold_8", "type": "virtual_currency" }, { "amount": 2, "amount_without_discount": 2, "calculated_price": { "amount": "2.00", "amount_without_discount": "2.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png", "is_default": false, "item_id": 259766, "name": "Silver", "sku": "com.xsolla.silver_8", "type": "virtual_currency" }, { "amount": 20, "amount_without_discount": 20, "calculated_price": { "amount": "20.00", "amount_without_discount": "20.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png", "is_default": false, "item_id": 259767, "name": "Bronze", "sku": "com.xsolla.bronze_8", "type": "virtual_currency" } ], "vp_rewards": [] }, { "attributes": [], "bundle_type": "standard", "can_be_bought": true, "content": [ { "attributes": [], "can_be_bought": true, "description": "Electric shield", "groups": [ { "external_id": "armour", "name": "Armour" } ], "image_url": "https://cdn3.xsolla.com/img/misc/images/d2d6b1b517e6a7f3765c3bb5a3cfb87d.png", "is_free": false, "item_id": 259774, "name": "Electric shield", "price": { "amount": "9.99", "amount_without_discount": "9.99", "currency": "USD" }, "quantity": 1, "sku": "com.xsolla.electric_shield_2", "type": "virtual_good", "virtual_item_type": "non_consumable", "virtual_prices": [ { "amount": 10, "amount_without_discount": 10, "calculated_price": { "amount": "10.00", "amount_without_discount": "10.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png", "is_default": true, "item_id": 259765, "name": "Gold", "sku": "com.xsolla.gold_10", "type": "virtual_currency" }, { "amount": 20, "amount_without_discount": 20, "calculated_price": { "amount": "20.00", "amount_without_discount": "20.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png", "is_default": false, "item_id": 259766, "name": "Silver", "sku": "com.xsolla.silver_10", "type": "virtual_currency" }, { "amount": 200, "amount_without_discount": 200, "calculated_price": { "amount": "200.00", "amount_without_discount": "200.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png", "is_default": false, "item_id": 259767, "name": "Bronze", "sku": "com.xsolla.bronze_10", "type": "virtual_currency" } ] }, { "attributes": [], "can_be_bought": true, "description": "Ancient helmet", "groups": [ { "external_id": "armour", "name": "Armour" } ], "image_url": "https://cdn3.xsolla.com/img/misc/images/e70e16d9626f435e519fc8e1cc1e7176.png", "is_free": false, "item_id": 259776, "name": "Ancient helmet", "price": { "amount": "1.99", "amount_without_discount": "1.99", "currency": "USD" }, "quantity": 1, "sku": "com.xsolla.ancient_helmet_2", "type": "virtual_good", "virtual_item_type": "non_consumable", "virtual_prices": [ { "amount": 2, "amount_without_discount": 2, "calculated_price": { "amount": "2.00", "amount_without_discount": "2.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png", "is_default": true, "item_id": 259765, "name": "Gold", "sku": "com.xsolla.gold_11", "type": "virtual_currency" }, { "amount": 4, "amount_without_discount": 4, "calculated_price": { "amount": "4.00", "amount_without_discount": "4.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png", "is_default": false, "item_id": 259766, "name": "Silver", "sku": "com.xsolla.silver_11", "type": "virtual_currency" }, { "amount": 40, "amount_without_discount": 40, "calculated_price": { "amount": "40.00", "amount_without_discount": "40.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png", "is_default": false, "item_id": 259767, "name": "Bronze", "sku": "com.xsolla.bronze_11", "type": "virtual_currency" } ] } ], "description": "Chest of armour", "groups": [], "image_url": "https://cdn3.xsolla.com/img/misc/images/5212202f9b8c9dbd254652d6cbeba03e.png", "is_free": false, "item_id": 259778, "name": "Chest of armor", "price": { "amount": "19.99", "amount_without_discount": "19.99", "currency": "USD" }, "sku": "com.xsolla.armor_chest_1", "total_content_price": { "amount": "11.98", "amount_without_discount": "11.98", "currency": "USD" }, "type": "bundle", "virtual_prices": [ { "amount": 20, "amount_without_discount": 20, "calculated_price": { "amount": "20.00", "amount_without_discount": "20.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png", "is_default": true, "item_id": 259765, "name": "Gold", "sku": "com.xsolla.gold_9", "type": "virtual_currency" }, { "amount": 40, "amount_without_discount": 40, "calculated_price": { "amount": "40.00", "amount_without_discount": "40.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png", "is_default": false, "item_id": 259766, "name": "Silver", "sku": "com.xsolla.silver_9", "type": "virtual_currency" }, { "amount": 400, "amount_without_discount": 400, "calculated_price": { "amount": "400.00", "amount_without_discount": "400.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png", "is_default": false, "item_id": 259767, "name": "Bronze", "sku": "com.xsolla.bronze_9", "type": "virtual_currency" } ], "vp_rewards": [] }, { "attributes": [], "bundle_type": "standard", "can_be_bought": true, "content": [ { "attributes": [], "can_be_bought": true, "description": "Saber", "groups": [ { "external_id": "swords", "name": "Swords" } ], "image_url": "https://cdn3.xsolla.com/img/misc/images/edd914d60301d77b94926478d253fcb6.png", "is_free": false, "item_id": 259772, "name": "Saber", "price": { "amount": "3.99", "amount_without_discount": "3.99", "currency": "USD" }, "quantity": 1, "sku": "com.xsolla.saber_2", "type": "virtual_good", "virtual_item_type": "non_consumable", "virtual_prices": [ { "amount": 3, "amount_without_discount": 3, "calculated_price": { "amount": "3.00", "amount_without_discount": "3.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png", "is_default": true, "item_id": 259765, "name": "Gold", "sku": "com.xsolla.gold_13", "type": "virtual_currency" }, { "amount": 7, "amount_without_discount": 7, "calculated_price": { "amount": "7.00", "amount_without_discount": "7.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png", "is_default": false, "item_id": 259766, "name": "Silver", "sku": "com.xsolla.silver_13", "type": "virtual_currency" }, { "amount": 70, "amount_without_discount": 70, "calculated_price": { "amount": "70.00", "amount_without_discount": "70.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png", "is_default": false, "item_id": 259767, "name": "Bronze", "sku": "com.xsolla.bronze_13", "type": "virtual_currency" } ] }, { "attributes": [], "bundle_type": "virtual_currency_package", "can_be_bought": true, "content": [ { "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png", "item_id": 259766, "name": "Silver", "quantity": 50, "sku": "com.xsolla.silver_14", "type": "virtual_currency" } ], "description": "Chest of silver", "groups": [], "image_url": "https://cdn3.xsolla.com/img/misc/images/f0b59a3370404e8881107249051b70bd.png", "is_free": false, "item_id": 259769, "name": "Chest of silver", "price": { "amount": "19.99", "amount_without_discount": "19.99", "currency": "USD" }, "quantity": 10, "sku": "com.xsolla.silver_chest_2", "type": "bundle", "virtual_prices": [] }, { "attributes": [], "bundle_type": "virtual_currency_package", "can_be_bought": true, "content": [ { "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png", "item_id": 259767, "name": "Bronze", "quantity": 100, "sku": "com.xsolla.bronze_11", "type": "virtual_currency" } ], "description": "Chest of bronze", "groups": [], "image_url": "https://cdn3.xsolla.com/img/misc/images/b32eb5b1f4f0c202ea6ac4e21c2eae18.png", "is_free": false, "item_id": 259770, "name": "Chest of bronze", "price": { "amount": "5.99", "amount_without_discount": "5.99", "currency": "USD" }, "quantity": 100, "sku": "com.xsolla.bronze_chest_2", "type": "bundle", "virtual_prices": [] } ], "description": "Treasure Chest", "groups": [], "image_url": "https://cdn3.xsolla.com/img/misc/images/7b1c0136d91398f9ab17924deee5eeec.png", "is_free": false, "item_id": 259779, "name": "Treasure Chest", "price": { "amount": "9.99", "amount_without_discount": "9.99", "currency": "USD" }, "sku": "com.xsolla.treasure_chest_1", "total_content_price": { "amount": "802.89", "amount_without_discount": "802.89", "currency": "USD" }, "type": "bundle", "virtual_prices": [ { "amount": 10, "amount_without_discount": 10, "calculated_price": { "amount": "10.00", "amount_without_discount": "10.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png", "is_default": true, "item_id": 259765, "name": "Gold", "sku": "com.xsolla.gold_12", "type": "virtual_currency" }, { "amount": 20, "amount_without_discount": 20, "calculated_price": { "amount": "20.00", "amount_without_discount": "20.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png", "is_default": false, "item_id": 259766, "name": "Silver", "sku": "com.xsolla.silver_12", "type": "virtual_currency" }, { "amount": 40, "amount_without_discount": 40, "calculated_price": { "amount": "40.00", "amount_without_discount": "40.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png", "is_default": false, "item_id": 259767, "name": "Bronze", "sku": "com.xsolla.bronze_12", "type": "virtual_currency" } ], "vp_rewards": [] } ], "items": { "properties": { "attributes": { "$ref": "#/components/schemas/Virtual-Items-Currency_client-attributes" }, "bundle_type": { "description": "번들 유형입니다. 아이템 유형이 번들인 경우 반환됩니다.", "enum": [ "standard", "virtual_currency_package" ], "type": "string" }, "can_be_bought": { "description": "`true`일 경우 사용자는 아이템을 구매할 수 있습니다.", "example": true, "type": "boolean" }, "content": { "items": { "items": { "$ref": "#/components/schemas/Bundles_client_content" }, "type": "object" }, "type": "array" }, "custom_attributes": { "$ref": "#/components/schemas/item-custom-attributes-response" }, "description": { "description": "아이템 설명입니다.", "example": "Electric shield", "type": "string" }, "groups": { "$ref": "#/components/schemas/items_client_groups_response" }, "image_url": { "description": "이미지 URL입니다.", "example": "https://cdn3.xsolla.com/img/misc/images/d2d6b1b517e6a7f3765c3bb5a3cfb87d.png", "type": "string" }, "is_free": { "$ref": "#/components/schemas/value-is_free" }, "item_id": { "description": "아이템 생성 시 제공되는 내부의 고유 아이템 ID입니다.", "example": 259774, "type": "integer" }, "limits": { "$ref": "#/components/schemas/Catalog_item_limits" }, "name": { "description": "아이템 이름입니다.", "example": "Electric shield", "type": "string" }, "price": { "description": "아이템 가격입니다.", "properties": { "amount": { "description": "할인된 아이템 가격입니다.", "example": "9.99", "type": "string" }, "amount_without_discount": { "description": "아이템 가격입니다.", "example": "9.99", "type": "string" }, "currency": { "description": "아이템 가격 통화입니다. [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)에 따른 3자리 코드입니다.", "example": "USD", "type": "string" } }, "type": "object" }, "promotions": { "$ref": "#/components/schemas/Catalog_item_promotions" }, "sku": { "description": "고유 아이템 ID입니다. SKU는 소문자 및 대문자 라틴 영숫자, 마침표, 대시 및 밑줄만 포함할 수 있습니다.", "example": "com.xsolla.electric_shield_1", "type": "string" }, "total_content_price": { "$ref": "#/components/schemas/Bundles_total_content_price" }, "type": { "description": "아이템 유형: `virtual_good`/`virtual_currency`/`bundle`/`game_key`/`physical_good`.", "enum": [ "virtual_good", "virtual_currency", "bundle", "game_key", "physical_good" ], "example": "virtual_good", "type": "string" }, "virtual_item_type": { "description": "Type of virtual item.\n\nPossible values:\n- `consumable` — An item that disappears from the inventory after use (e.g., ammo).\n- `non_consumable` — An item that stays in the inventory for an unlimited period of time.\n- `non_renewing_subscription` — Time-limited item that can represent access to services or content for a limited period of time.", "enum": [ "consumable", "non_consumable", "non_renewing_subscription" ], "example": "non-consumable", "type": "string" }, "virtual_prices": { "description": "가상 가격입니다.", "items": { "description": "가상 가격입니다.", "properties": { "amount": { "description": "인게임 재화로 표시된 할인된 아이템 가격입니다.", "example": 10, "type": "integer" }, "amount_without_discount": { "description": "아이템 가격입니다.", "example": 10, "type": "integer" }, "calculated_price": { "properties": { "amount": { "type": "string" }, "amount_without_discount": { "type": "string" } }, "type": "object" }, "description": { "description": "인게임 재화 설명입니다.", "example": null, "type": [ "string", "null" ] }, "image_url": { "description": "인게임 재화의 이미지입니다.", "example": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png", "type": "string" }, "is_default": { "description": "아이템의 가격이 기본값인지 여부입니다.", "example": true, "type": "boolean" }, "item_id": { "description": "아이템 생성 시 제공되는 내부의 고유 아이템 ID입니다.", "example": 259774, "type": "integer" }, "name": { "description": "인게임 재화 이름입니다.", "example": "Gold", "type": "string" }, "sku": { "description": "인게임 재화 아이템 SKU입니다.", "example": "com.xsolla.gold_1", "type": "string" }, "type": { "description": "인게임 재화 유형입니다.", "example": "virtual_currency", "type": "string" } }, "type": "object" }, "type": "array" }, "vp_rewards": { "$ref": "#/components/schemas/client-item-value-point-reward" } }, "type": "object" }, "type": "array" } }, "type": "object" } } }, "description": "판매할 수 있는 아이템 목록을 성공적으로 수신했습니다." } }, "schemas": { "404-not-found": { "properties": { "errorCode": { "example": 1102, "type": "integer" }, "errorMessage": { "example": "[0000-0000]: Entity not found", "type": "string" }, "statusCode": { "example": 422, "type": "integer" }, "transactionId": { "example": "x-x-x-x-transactionId-mock-x-x-x", "type": "string" } }, "type": "object" }, "422-invalid-request": { "properties": { "errorCode": { "description": "오류 코드입니다.", "example": 1102, "type": "integer" }, "errorMessage": { "description": "Short error description.", "example": "[0401-1102]: Unprocessable Entity. The property `property_name` is required", "type": "string" }, "errorMessageExtended": { "$ref": "#/components/schemas/error-message-extended-validation" }, "statusCode": { "description": "HTTP response status.", "example": 422, "type": "integer" }, "transactionId": { "description": "Request ID. The ID used to track and associate log entries related to this specific request or operation. This ID can be helpful for troubleshooting, debugging, and auditing purposes.", "example": "x-x-x-x-transactionId-mock-x-x-x", "type": "string" } }, "required": [ "statusCode", "errorCode", "errorMessage", "transactionId" ], "type": "object" }, "422-invalid-request-2": { "properties": { "errorCode": { "description": "오류 코드입니다.", "example": 1102, "type": "number" }, "errorMessage": { "description": "읽을 수 있는 오류 메시지입니다.", "example": "[0401-1102]: Unprocessable Entity. The property `external_id` is required", "type": "string" }, "statusCode": { "description": "응답 상태 코드입니다.", "example": 422, "type": "number" }, "transactionId": { "description": "요청의 고유 ID입니다.", "example": "da145238620011eb8e24fe6913ff226a", "type": "string" } }, "type": "object" }, "Bundles_422-invalid-request": { "properties": { "errorCode": { "example": 1102, "type": "integer" }, "errorMessage": { "example": "[0401-1102]: Unprocessable Entity. The property `property_name` is required", "type": "string" }, "errorMessageExtended": { "type": "array" }, "statusCode": { "example": 422, "type": "integer" }, "transactionId": { "example": "x-x-x-x-transactionId-mock-x-x-x", "type": "string" } }, "type": "object" }, "Bundles_admin-attributes": { "description": "특성 목록입니다.", "items": { "$ref": "#/components/schemas/attribute" }, "type": "array" }, "Bundles_admin-post-put-attributes": { "description": "특성 목록입니다.\n
주의. 아이템에 20개 이상의 특성을 지정할 수 없습니다. 제한을 초과하려고 하면 오류가 발생합니다.
", "items": { "$ref": "#/components/schemas/admin-post-put-attribute-item" }, "maxItems": 20, "type": "array" }, "Bundles_admin-regions": { "items": { "properties": { "id": { "example": 1, "minimum": 1, "type": "integer" } }, "type": "object" }, "type": "array" }, "Bundles_admin-response-virtual_price": { "properties": { "amount": { "$ref": "#/components/schemas/Bundles_amount" }, "description": { "$ref": "#/components/schemas/description-localization-object" }, "image_url": { "$ref": "#/components/schemas/Bundles_image_url" }, "is_default": { "$ref": "#/components/schemas/Bundles_currency-is_default" }, "name": { "$ref": "#/components/schemas/name-localization-object" }, "sku": { "$ref": "#/components/schemas/Bundles_sku" }, "type": { "$ref": "#/components/schemas/Bundles_vc-type" } }, "type": "object" }, "Bundles_admin_bundle_request": { "description": "지정한 번들입니다.", "properties": { "attributes": { "$ref": "#/components/schemas/Bundles_admin-post-put-attributes" }, "bundle_type": { "$ref": "#/components/schemas/Bundles_bundle_type" }, "content": { "$ref": "#/components/schemas/Bundles_admin_content_request" }, "custom_attributes": { "$ref": "#/components/schemas/item-custom-attributes" }, "description": { "$ref": "#/components/schemas/description-localization-object" }, "groups": { "$ref": "#/components/schemas/Bundles_groups_request" }, "image_url": { "$ref": "#/components/schemas/Bundles_image_url" }, "is_enabled": { "$ref": "#/components/schemas/Bundles_is_enabled" }, "is_free": { "$ref": "#/components/schemas/value-is_free" }, "is_paid_randomized_reward": { "$ref": "#/components/schemas/value-is_paid_randomized_reward" }, "is_show_in_store": { "$ref": "#/components/schemas/Bundles_is_show_in_store" }, "limits": { "$ref": "#/components/schemas/bundle-item-limit" }, "long_description": { "$ref": "#/components/schemas/long-description-localization-object" }, "media_list": { "anyOf": [ { "$ref": "#/components/schemas/Bundles_media_list" }, { "type": "null" } ] }, "name": { "$ref": "#/components/schemas/name-localization-object" }, "order": { "$ref": "#/components/schemas/Bundles_order" }, "periods": { "$ref": "#/components/schemas/item-periods" }, "prices": { "$ref": "#/components/schemas/Bundles_prices" }, "regions": { "$ref": "#/components/schemas/Bundles_admin-regions" }, "sku": { "$ref": "#/components/schemas/Bundles_sku" }, "vc_prices": { "anyOf": [ { "$ref": "#/components/schemas/Bundles_vc_prices" }, { "type": "null" } ] } }, "required": [ "sku", "name", "description" ], "type": "object" }, "Bundles_admin_bundle_response": { "description": "지정한 번들입니다.", "properties": { "attributes": { "$ref": "#/components/schemas/Bundles_admin-attributes" }, "bundle_type": { "$ref": "#/components/schemas/bundle_type" }, "content": { "items": { "$ref": "#/components/schemas/Bundles_admin_content_response" }, "type": "array" }, "custom_attributes": { "$ref": "#/components/schemas/item-custom-attributes-response" }, "description": { "$ref": "#/components/schemas/description-localization-object" }, "groups": { "$ref": "#/components/schemas/Bundles_groups_response" }, "image_url": { "$ref": "#/components/schemas/Bundles_image_url" }, "is_enabled": { "$ref": "#/components/schemas/Bundles_is_enabled" }, "is_free": { "$ref": "#/components/schemas/value-is_free" }, "is_paid_randomized_reward": { "$ref": "#/components/schemas/value-is_paid_randomized_reward" }, "is_show_in_store": { "$ref": "#/components/schemas/Bundles_is_show_in_store" }, "item_id": { "$ref": "#/components/schemas/Bundles_item_id" }, "limits": { "$ref": "#/components/schemas/admin-item-limit-response" }, "long_description": { "$ref": "#/components/schemas/long-description-localization-object" }, "media_list": { "anyOf": [ { "$ref": "#/components/schemas/Bundles_media_list" }, { "type": "null" } ] }, "name": { "$ref": "#/components/schemas/name-localization-object" }, "order": { "$ref": "#/components/schemas/Bundles_order" }, "periods": { "$ref": "#/components/schemas/item-periods-response" }, "prices": { "$ref": "#/components/schemas/Bundles_prices" }, "regions": { "$ref": "#/components/schemas/Bundles_admin-regions" }, "sku": { "$ref": "#/components/schemas/Bundles_sku" }, "total_content_price": { "$ref": "#/components/schemas/Bundles_total_content_price" }, "type": { "$ref": "#/components/schemas/Bundles_type" }, "virtual_prices": { "items": { "$ref": "#/components/schemas/Bundles_admin-response-virtual_price" }, "type": "array" } }, "type": "object" }, "Bundles_admin_content_request": { "items": { "example": { "quantity": 1, "sku": "com.xsolla.kg_1" }, "properties": { "quantity": { "default": 1, "description": "번들에서 선택한 아이템의 수량입니다.", "minimum": 1, "type": "integer" }, "sku": { "$ref": "#/components/schemas/Bundles_sku" } }, "required": [ "sku" ], "type": "object" }, "minItems": 1, "type": "array" }, "Bundles_admin_content_response": { "properties": { "description": { "$ref": "#/components/schemas/description-localization-object" }, "image_url": { "$ref": "#/components/schemas/Bundles_image_url" }, "name": { "$ref": "#/components/schemas/name-localization-object" }, "quantity": { "default": 1, "description": "번들에 있는 아이템 유형의 수량입니다.", "minimum": 1, "type": "integer" }, "sku": { "$ref": "#/components/schemas/Bundles_sku" }, "type": { "$ref": "#/components/schemas/Bundles_type" } }, "type": "object" }, "Bundles_amount": { "description": "할인된 아이템 가격입니다.", "example": "100.99", "pattern": "^\\d*\\.?\\d*$", "type": "string" }, "Bundles_amount_without_discount": { "description": "아이템 가격입니다.", "example": "100.99", "pattern": "^\\d*\\.?\\d*$", "type": "string" }, "Bundles_bundle_type": { "default": "standard", "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)에만 사용됩니다.", "enum": [ "standard", "partner_side_content" ], "example": "standard", "type": "string" }, "Bundles_client-attributes": { "default": [], "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" } ] } }, "items": { "properties": { "external_id": { "$ref": "#/components/schemas/admin-attribute-external_id" }, "name": { "description": "특성의 이름입니다.", "example": "Genre", "type": "string" }, "values": { "items": { "properties": { "external_id": { "$ref": "#/components/schemas/value-external_id" }, "value": { "description": "특성의 값입니다.", "example": "Strategy", "type": "string" } }, "type": "object" }, "type": "array" } }, "type": "object" }, "type": "array" }, "Bundles_client_bundle": { "description": "지정한 번들입니다.", "properties": { "attributes": { "$ref": "#/components/schemas/Bundles_client-attributes" }, "bundle_type": { "$ref": "#/components/schemas/Bundles_bundle_type" }, "can_be_bought": { "$ref": "#/components/schemas/Can_be_bought" }, "content": { "$ref": "#/components/schemas/Bundles_client_content" }, "custom_attributes": { "$ref": "#/components/schemas/item-custom-attributes-response" }, "description": { "$ref": "#/components/schemas/Bundles_client_description" }, "groups": { "$ref": "#/components/schemas/items_client_groups_response" }, "image_url": { "$ref": "#/components/schemas/Bundles_image_url" }, "is_free": { "$ref": "#/components/schemas/value-is_free" }, "item_id": { "$ref": "#/components/schemas/Bundles_item_id" }, "limits": { "$ref": "#/components/schemas/Catalog_item_limits_with_hourly" }, "long_description": { "$ref": "#/components/schemas/long-description-localization-object" }, "media_list": { "$ref": "#/components/schemas/Bundles_media_list" }, "name": { "$ref": "#/components/schemas/Bundles_client_name" }, "order": { "$ref": "#/components/schemas/Bundles_order" }, "periods": { "$ref": "#/components/schemas/item-periods" }, "price": { "$ref": "#/components/schemas/Bundles_price" }, "promotions": { "$ref": "#/components/schemas/Catalog_item_promotions" }, "sku": { "$ref": "#/components/schemas/Bundles_sku" }, "total_content_price": { "$ref": "#/components/schemas/Bundles_total_content_price" }, "type": { "$ref": "#/components/schemas/Bundles_type" }, "virtual_prices": { "$ref": "#/components/schemas/Bundles_virtual_prices" }, "vp_rewards": { "$ref": "#/components/schemas/client-item-value-point-reward" } }, "type": "object" }, "Bundles_client_content": { "description": "번들 패키지 콘텐츠입니다.", "example": [ { "attributes": [], "description": "Big Rocket - short description.", "groups": [], "image_url": "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png", "is_free": false, "name": "Big Rocket", "price": { "amount": "10.99", "amount_without_discount": "10.99", "currency": "USD" }, "quantity": 100, "sku": "com.xsolla.big_rocket_1", "type": "virtual_currency" } ], "items": { "description": "패키지에 있는 아이템입니다.", "properties": { "attributes": { "$ref": "#/components/schemas/Bundles_client-attributes" }, "description": { "description": "아이템 설명입니다.", "example": "Big Rocket - description", "type": "string" }, "groups": { "$ref": "#/components/schemas/Bundles_groups_response" }, "image_url": { "description": "이미지 URL입니다.", "example": "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png", "type": "string" }, "is_free": { "$ref": "#/components/schemas/value-is_free" }, "limits": { "$ref": "#/components/schemas/Catalog_item_limits_with_hourly" }, "name": { "description": "아이템 이름입니다.", "example": "Big Rocket", "type": "string" }, "price": { "description": "아이템 가격입니다.", "properties": { "amount": { "description": "할인된 아이템 가격입니다.", "example": "100.99", "type": "string" }, "amount_without_discount": { "description": "아이템 가격입니다.", "example": "100.99", "type": "string" }, "currency": { "description": "아이템 가격 통화입니다. [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)에 따른 3자리 코드입니다. [엑솔라에서 지원하는 통화](https://developers.xsolla.com/ko/doc/pay-station/references/supported-currencies/)에 대한 자세한 정보는 설명서를 확인하십시오.", "example": "USD", "type": "string" } }, "type": [ "object", "null" ] }, "quantity": { "description": "패키지에 있는 아이템의 수량입니다.", "example": 250, "type": "integer" }, "sku": { "description": "고유한 아이템 ID입니다. SKU는 소문자 및 대문자 라틴 영숫자, 대시 및 밑줄만 포함할 수 있습니다.", "example": "com.xsolla.big_rocket_1", "type": "string" }, "type": { "description": "아이템 유형: `virtual_good`/`virtual_currency`/`bundle`.", "example": "virtual_currency", "type": "string" }, "virtual_item_type": { "description": "Type of virtual item.\n\nPossible values:\n- `consumable` — An item that disappears from the inventory after use (e.g., ammo).\n- `non_consumable` — An item that stays in the inventory for an unlimited period of time.\n- `non_renewing_subscription` — Time-limited item that can represent access to services or content for a limited period of time.", "enum": [ "consumable", "non_consumable", "non_renewing_subscription" ], "example": "non-consumable", "type": "string" }, "virtual_prices": { "description": "가상 가격입니다.", "items": { "description": "가상 가격입니다.", "properties": { "amount": { "description": "할인된 인게임 재화의 아이템 가격입니다.", "example": 100, "type": "integer" }, "amount_without_discount": { "description": "아이템 가격입니다.", "example": 200, "type": "integer" }, "description": { "description": "인게임 재화 설명입니다.", "example": "Big Rocket - description", "type": "string" }, "image_url": { "description": "인게임 재화의 이미지입니다.", "example": "http://image.png", "type": "string" }, "is_default": { "description": "아이템의 가격이 기본값인지 여부입니다.", "example": true, "type": "boolean" }, "name": { "description": "인게임 재화 이름입니다.", "example": "SHOTGUN FOR TRUE RAIDERS", "type": "string" }, "sku": { "description": "인게임 재화 아이템 SKU입니다.", "example": "vc_test", "type": "string" }, "type": { "description": "인게임 재화 유형입니다.", "example": "virtual_currency", "type": "string" } }, "type": "object" }, "type": "array" } }, "type": "object" }, "type": "array" }, "Bundles_client_description": { "description": "아이템 설명입니다.", "example": "Big Rocket - description.", "type": [ "string", "null" ] }, "Bundles_client_name": { "description": "아이템 이름입니다.", "example": "Big Rocket", "type": "string" }, "Bundles_currency": { "description": "아이템 가격 통화입니다. [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)에 따른 3자리 코드입니다.", "example": "USD", "type": "string" }, "Bundles_currency-is_default": { "description": "아이템의 가격이 기본값인지 여부입니다.", "example": true, "type": "boolean" }, "Bundles_groups_request": { "default": [], "description": "아이템이 속한 그룹입니다.\n
메모. 문자열 값은 그룹 `external_id`을 참조합니다.
", "example": [ "honor" ], "items": { "type": "string" }, "type": "array" }, "Bundles_groups_response": { "default": [], "description": "아이템이 속한 그룹입니다.", "example": [ { "external_id": "horror", "name": { "en": "Horror" } } ], "items": { "properties": { "external_id": { "example": "horror", "type": "string" }, "name": { "additionalProperties": { "type": "string" }, "default": { "en": "Horror" }, "description": "아이템의 이름입니다. 키가 \"^[a-z]{2}\" 형식의 로케일인\n키/값 쌍을 포함해야 하며 값은 문자열입니다.", "example": { "de": "Horror", "en": "Horror" }, "type": "object" } }, "type": "object" }, "type": "array" }, "Bundles_image_url": { "description": "이미지 URL입니다.", "example": "https://image.example.com", "type": [ "string", "null" ] }, "Bundles_is_enabled": { "default": true, "description": "비활성화된 경우 아이템을 검색하거나 구매할 수 없습니다.", "example": true, "type": "boolean" }, "Bundles_is_show_in_store": { "default": false, "description": "아이템을 구매할 수 있는 상태입니다.", "example": true, "type": "boolean" }, "Bundles_item_id": { "description": "내부의 고유 아이템 ID입니다.", "example": 1, "maxLength": 255, "minLength": 1, "type": "integer" }, "Bundles_media_list": { "description": "번들의 추가 자산입니다.", "example": [ { "type": "image", "url": "https://cdn3.xsolla.com/img/misc/images/71ab1e12126f2103e1868076f0acb21a.jpg" } ], "items": { "properties": { "type": { "description": "미디어 유형: `image`/`video`.", "enum": [ "image", "video" ], "example": "image", "type": "string" }, "url": { "description": "리소스 파일입니다.", "example": "https://cdn3.xsolla.com/img/misc/images/71ab1e12126f2103e1868076f0acb21a.jpg", "type": "string" } }, "type": "object" }, "type": "array" }, "Bundles_order": { "default": 1, "description": "목록에서 번들의 주문 우선 순위입니다.", "example": 1, "type": "integer" }, "Bundles_price": { "description": "아이템 가격입니다.", "properties": { "amount": { "$ref": "#/components/schemas/Bundles_amount" }, "amount_without_discount": { "$ref": "#/components/schemas/Bundles_amount_without_discount" }, "currency": { "$ref": "#/components/schemas/Bundles_currency" } }, "required": [ "amount", "amount_without_discount", "currency" ], "type": [ "object", "null" ] }, "Bundles_prices": { "description": "실제 통화 가격입니다.", "items": { "properties": { "amount": { "$ref": "#/components/schemas/Bundles_amount_without_discount" }, "country_iso": { "description": "이 가격을 사용할 수 있는 국가입니다. [ISO 3166-1 alpha 2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)에 따른 2자리 글자 코드입니다.", "example": "US", "type": [ "string", "null" ] }, "currency": { "$ref": "#/components/schemas/Bundles_currency" }, "is_default": { "description": "기본 가격은 사용자 통화로 가격을 지정하지 않은 경우 카탈로그를 작성하는 데 사용됩니다.", "type": "boolean" }, "is_enabled": { "description": "가격이 활성화됩니다.", "type": "boolean" } }, "required": [ "amount", "currency", "is_default", "is_enabled" ], "type": "object" }, "type": "array" }, "Bundles_sku": { "description": "고유한 아이템 ID입니다. SKU는 소문자 및 대문자 라틴 영숫자, 마침표, 대시 및 밑줄만 포함할 수 있습니다.", "example": "bundle_1", "maxLength": 255, "minLength": 1, "pattern": "^[a-zA-Z0-9_\\-–.]*$", "type": "string" }, "Bundles_total_content_price": { "description": "번들 콘텐츠 가격의 합계입니다.", "properties": { "amount": { "description": "할인이 적용된 번들 콘텐츠 가격의 합계입니다.", "example": "100.99", "type": "string" }, "amount_without_discount": { "description": "번들 콘텐츠 가격의 합계입니다.", "example": "100.99", "type": "string" }, "currency": { "$ref": "#/components/schemas/Bundles_currency" } }, "type": [ "object", "null" ] }, "Bundles_type": { "description": "아이템 유형입니다.", "example": "bundle", "type": "string" }, "Bundles_vc-type": { "description": "인게임 재화 유형입니다.", "example": "virtual_currency", "type": "string" }, "Bundles_vc_prices": { "items": { "properties": { "amount": { "type": "integer" }, "is_default": { "type": "boolean" }, "is_enabled": { "type": "boolean" }, "sku": { "description": "고유한 아이템 ID입니다. SKU는 소문자 및 대문자 라틴 영숫자, 마침표, 대시 및 밑줄만 포함할 수 있습니다.", "example": "gold", "type": "string" } }, "required": [ "amount", "currency", "is_default", "is_enabled" ], "type": "object" }, "type": "array" }, "Bundles_virtual_prices": { "description": "가상 가격입니다.", "items": { "description": "가상 가격입니다.", "properties": { "amount": { "description": "할인된 인게임 재화의 아이템 가격입니다.", "example": 100, "type": "integer" }, "amount_without_discount": { "description": "인게임 재화의 아이템 가격입니다.", "example": 200, "type": "integer" }, "description": { "description": "인게임 재화 설명입니다.", "example": "Most popular gold", "type": [ "string", "null" ] }, "image_url": { "description": "인게임 재화의 이미지입니다.", "example": "http://image.png", "type": [ "string", "null" ] }, "is_default": { "description": "아이템의 가격이 기본값인지 여부입니다.", "example": true, "type": "boolean" }, "name": { "description": "인게임 재화 이름입니다.", "example": "Gold", "type": "string" }, "sku": { "description": "인게임 재화 아이템 SKU입니다.", "example": "gold", "type": "string" }, "type": { "description": "인게임 재화 유형입니다.", "example": "virtual_currency", "type": "string" } }, "type": "object" }, "type": "array" }, "Can_be_bought": { "description": "`true`일 경우 사용자는 아이템을 구매할 수 있습니다.", "example": true, "type": "boolean" }, "Cart": { "additionalProperties": false, "properties": { "country": { "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", "maxLength": 2, "minLength": 2, "type": "string" }, "currency": { "description": "장바구니에 표시되는 아이템 가격 통화입니다. [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)에 따른 3자리 코드입니다. [엑솔라에서 지원하는 통화](https://developers.xsolla.com/ko/doc/pay-station/references/supported-currencies/)에 대한 자세한 정보는 설명서를 확인하십시오.", "example": "USD", "maxLength": 3, "minLength": 3, "type": "string" }, "items": { "items": { "properties": { "quantity": { "description": "아이템의 수량입니다.", "example": 2, "minimum": 1, "type": "number" }, "sku": { "description": "고유한 아이템 ID입니다. SKU는 소문자 및 대문자 라틴 영숫자, 마침표, 대시 및 밑줄만 포함할 수 있습니다.", "example": "t-shirt", "minLength": 1, "type": "string" } }, "required": [ "sku", "quantity" ], "type": "object" }, "minItems": 1, "type": "array" } }, "required": [ "items" ], "type": "object" }, "Cart-Payment_admin-user-request-body": { "additionalProperties": false, "properties": { "age": { "description": "사용자 나이.", "type": "integer" }, "country": { "properties": { "allow_modify": { "default": false, "description": "결제 UI에서 사용자가 국가를 변경할 수 있는지 여부입니다.", "example": false, "type": "boolean" }, "value": { "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", "type": "string" } }, "type": "object" }, "email": { "properties": { "value": { "description": "사용자 이메일입니다. RFC 822 프로토콜에 따라 유효해야 합니다.", "format": "email", "maxLength": 255, "minLength": 3, "type": "string" } }, "type": "object" }, "id": { "properties": { "value": { "description": "사용자 ID입니다. 테스트 목적으로 어떤 값이나 전달할 수 있습니다. 실제 결제를 수락하려면 시스템의 사용자 ID 값을 사용해야 합니다. 이 ID는 [유효성 검사](https://developers.xsolla.com/ko/webhooks/operation/user-validation/) 웹훅에서 전달됩니다.", "maxLength": 255, "minLength": 1, "type": "string" } }, "type": "object" }, "is_legal": { "description": "사용자가 법인인지 여부를 나타냅니다.", "type": "boolean" }, "legal": { "description": "법인 세부 정보가 있는 개체입니다. `user.is_legal`이 `true`인 경우 개체와 이에 해당하는 모든 매개 변수는 필수입니다.", "properties": { "address": { "description": "법인 전체 주소입니다.", "type": "string" }, "country": { "description": "기업이 속한 국가입니다. [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)에 따른 2자로 된 대문자 국가 코드를 사용합니다.", "type": "string" }, "name": { "description": "법인 전체 이름입니다.", "type": "string" }, "vat_id": { "description": "개별 납세자 식별자입니다.", "type": "string" } }, "type": "object" }, "name": { "properties": { "value": { "description": "사용자 화면 이름입니다.", "maxLength": 255, "minLength": 1, "type": "string" } }, "type": "object" }, "phone": { "properties": { "allow_modify": { "default": false, "description": "사용자가 결제 UI에서 전화번호를 변경할 수 있는지 여부입니다. `phone.value`가 토큰에서 전달되면 기본값은 `false`입니다.", "example": false, "type": "boolean" }, "hidden": { "default": true, "example": false, "type": "boolean" }, "value": { "description": "전화번호.", "type": "string" } }, "required": [ "value" ], "type": "object" }, "steam_id": { "properties": { "value": { "description": "Steam ID입니다.", "maxLength": 17, "minLength": 17, "pattern": "^\\d{17}$", "type": "string" } }, "required": [ "value" ], "type": "object" }, "tracking_id": { "properties": { "value": { "description": "고유 추적 ID(마케팅 캠페인에 사용됨)입니다.", "maxLength": 32, "minLength": 32, "pattern": "^[A-Za-z0-9]{32}$", "type": "string" } }, "required": [ "value" ], "type": "object" } }, "required": [ "id" ], "type": "object" }, "Cart-Payment_client-attributes": { "default": [], "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" } ] } }, "items": { "properties": { "external_id": { "$ref": "#/components/schemas/admin-attribute-external_id" }, "name": { "description": "특성의 이름입니다.", "example": "Genre", "type": "string" }, "values": { "items": { "properties": { "external_id": { "$ref": "#/components/schemas/value-external_id" }, "value": { "description": "특성의 값입니다.", "example": "Strategy", "type": "string" } }, "type": "object" }, "type": "array" } }, "type": "object" }, "type": "array" }, "Cart-Payment_custom_parameters": { "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "boolean" }, { "type": "array" }, { "type": "object" } ] }, "description": "사용자 지정 매개 변수는 키-값 쌍의 유효한 JSON 집합으로 표시됩니다.
\n이 필드를 통해 추가 매개 변수를 전달하여 부정 결제 방지 필터를 구성할 수 있습니다. [페이 스테이션 설명서를 참조해주세요](https://developers.xsolla.com/ko/doc/pay-station/features/antifraud/).", "example": { "custom_parameters": { "bool_param": true, "int_param": 100, "null_param": null, "string_param": "example" } }, "maxProperties": 200, "minProperties": 1, "type": [ "object", "null" ] }, "Cart-Payment_custom_parameters_token": { "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" } ] }, "description": "사용자 지정 매개 변수는 키-값 쌍의 유효한 JSON 집합으로 표시됩니다.
\n이 필드를 통해 추가 매개 변수를 전달하여 부정 결제 방지 필터를 구성할 수 있습니다. [페이 스테이션 설명서를 참조해주세요](https://developers.xsolla.com/ko/doc/pay-station/features/antifraud/).", "example": { "custom_parameters": { "bool_param": true, "int_param": 100, "null_param": null, "number_param": 12.5, "string_param": "example" } }, "maxProperties": 200, "minProperties": 1, "type": [ "object", "null" ] }, "Cart-Payment_redirect_policy": { "properties": { "delay": { "description": "지연 후 사용자가 자동으로 반환 URL로 리디렉션됩니다.", "example": 0, "type": "integer" }, "redirect_button_caption": { "description": "현지화된 리디렉션 버튼 캡션입니다.", "example": "Text button", "type": "string" }, "redirect_conditions": { "description": "사용자를 반환 URL로 리디렉션하도록 트리거하는 결제 상태입니다.", "enum": [ "none", "successful", "successful_or_canceled", "any" ], "example": "none", "type": "string" }, "status_for_manual_redirection": { "description": "사용자를 반환 URL로 리디렉션하는 버튼 클릭 표시를 트리거하는 결제 상태입니다.", "enum": [ "none", "successful", "successful_or_canceled", "any" ], "example": "none", "type": "string" } }, "type": "object" }, "Cart-Payment_settings_currency": { "description": "선호하는 결제 통화입니다. [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)에 따른 3자리 통화 코드입니다. [엑솔라에서 지원하는 통화](https://developers.xsolla.com/ko/doc/pay-station/references/supported-currencies/)에 대한 자세한 정보는 설명서에서 확인하십시오.", "type": "string" }, "Cart-Payment_settings_external_id": { "description": "거래 외부 ID 입니다.", "maxLength": 255, "minLength": 1, "type": "string" }, "Cart-Payment_settings_locale": { "description": "인터페이스 언어입니다. 2자리 소문자 [언어 코드](https://developers.xsolla.com/ko/doc/pay-station/features/localization/)입니다.", "type": "string" }, "Cart-Payment_settings_payment_method": { "description": "결제 수단 ID입니다. 일부 결제 방법은 특정 통화만 지원할 수 있으므로 결제 인터페이스에서 통화 표시를 결정합니다.", "minimum": 1, "type": "integer" }, "Cart-Payment_settings_return_url": { "description": "결제 후 사용자를 리디렉션하는 페이지입니다. 매개 변수 `user_id`, `foreigninvoice`, `invoice_id`, `status`가 자동으로 링크에 추가됩니다.", "format": "uri", "maxLength": 1000, "type": "string" }, "Cart-Payment_settings_sandbox": { "default": false, "description": "결제 프로세스를 테스트하기 위해 `true` 값으로 설정합니다. 이 경우 테스트 결제 UI에 액세스하기 위해 https://sandbox-secure.Xsolla.com을 사용합니다.", "type": "boolean" }, "Cart-Payment_settings_ui": { "additionalProperties": false, "description": "인터페이스 설정입니다.", "properties": { "currency_format": { "description": "결제 UI에 3자리 [ISO 4217](https://developers.xsolla.com/ko/doc/pay-station/references/supported-currencies/) 통화 코드를 표시하려면 `code`로 설정하십시오. 기본적으로는 3자리 통화 코드 대신 통화 기호가 표시됩니다.", "type": "string" }, "desktop": { "additionalProperties": false, "description": "데스크톱 버전용 인터페이스 설정입니다.", "properties": { "header": { "additionalProperties": false, "description": "헤더 설정입니다.", "properties": { "close_button": { "default": false, "description": "데스크톱 결제 UI에 **닫기** 버튼을 표시할지 여부입니다. 이 버튼은 결제 UI를 닫고 사용자를 `settings.return_url` 매개 변수에 지정된 URL로 리디렉션합니다. 기본적으로 `false`로 설정되어 있습니다.", "type": "boolean" }, "is_visible": { "description": "결제 UI에 헤더를 표시할지 여부입니다.", "type": "boolean" }, "type": { "default": "normal", "description": "헤더를 표시하는 방식입니다. `compact`(프로젝트 이름 및 사용자 ID 표시 안 함) 또는 `normal`(기본값)일 수 있습니다.", "enum": [ "compact", "normal" ], "type": "string" }, "visible_logo": { "description": "`true`인 경우, 헤더에 로고가 표시됩니다. 이미지를 업로드하려면 [관리자 페이지](https://publisher.xsolla.com/)에서 프로젝트를 열고 페이 스테이션 > 설정 섹션으로 이동하십시오.", "type": "boolean" }, "visible_name": { "description": "프로젝트 이름을 헤더에 표시할지 여부를 나타냅니다.", "type": "boolean" }, "visible_purchase": { "default": true, "description": "헤더에 구매 설명(`purchase.description.value`)을 표시할지 여부입니다. 기본값은 `true`입니다.", "type": "boolean" } }, "type": "object" } }, "type": "object" }, "header": { "properties": { "visible_virtual_currency_balance": { "additionalProperties": false, "default": true, "description": "결제 UI에서 이 요소를 숨길 수 있는지 여부입니다.", "type": "boolean" } }, "type": "object" }, "is_cart_open_by_default": { "default": false, "description": "모바일 버전으로 결제 UI를 열 때 장바구니에 있는 아이템 목록을 표시할지 여부입니다. `true`이면 목록이 확장된 보기로 표시됩니다. `false`(기본값)이거나 매개 변수가 전달되지 않으면 목록이 축소된 보기로 표시됩니다.", "type": "boolean" }, "is_independent_windows": { "default": false, "description": "삽입된 런처의 브라우저(WebView)에서 기본 브라우저로 사용자를 리디렉션하여 구매할지 여부입니다.", "type": "boolean" }, "is_payment_methods_list_mode": { "default": false, "description": "결제 UI를 열 때 사용자의 국가에서 사용할 수 있는 결제 방식 목록이 표시되는지 여부입니다. `false`(기본값)인 경우 `settings.payment_method` 매개 변수에서 전달된 결제 방식이나 [PayRank 알고리즘](https://developers.xsolla.com/ko/solutions/payments/payment-ui-management/top-payment-methods-management/)으로 선택한 결제 방식이 표시됩니다.", "type": "boolean" }, "is_prevent_external_link_open": { "default": false, "description": "외부 자원에 대한 링크를 리디렉션할지 여부입니다. 외부 링크를 클릭하면 `postMessage` 메커니즘을 통해 `external-link-open` 이벤트가 전송됩니다. 리디렉션된 링크 주소는 `url` 매개 변수에 전달됩니다 .", "type": "boolean" }, "is_show_close_widget_warning": { "default": true, "description": "결제 페이지를 닫기 전에 **×** 아이콘 위로 마우스를 가져갔을 때 거래 처리에 대한 경고를 표시할지 여부입니다. `false`가 전달되거나 매개 변수가 전달되지 않으면 경고가 표시되지 않습니다.", "type": "boolean" }, "is_three_ds_independent_windows": { "default": false, "description": "3-D 보안 확인이 새 브라우저 창에서 열릴지 여부입니다. 설정에서 CSP(콘텐츠 보안 정책)를 적용하는 경우로 `true`설정합니다.", "type": "boolean" }, "layout": { "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" ], "type": "string" }, "mobile": { "properties": { "header": { "additionalProperties": false, "properties": { "close_button": { "default": false, "description": "모바일 결제 UI에 **닫기** 버튼을 표시할지 여부입니다. 이 버튼은 결제 UI를 닫고 사용자를 `settings.return_url`매개 변수에 지정된 URL로 리디렉션합니다.", "type": "boolean" } }, "type": "object" } }, "type": "object" }, "mode": { "description": "결제 UI의 인터페이스 모드. `user_account`만 가능합니다. 헤더에는 계정 탐색 메뉴만 포함되며 사용자는 제품을 선택하거나 결제할 수 없습니다. 이 모드는 데스크톱에서만 사용할 수 있습니다.", "enum": [ "user_account" ], "type": "string" }, "theme": { "default": "63295a9a2e47fab76f7708e1", "description": "결제 UI 테마. 라이트 테마(기본값)의 경우 `63295a9a2e47fab76f7708e1`, 다크 테마의 경우 `63295aab2e47fab76f7708e3`일 수 있습니다. [사용자 정의 테마를 생성](https://developers.xsolla.com/ko/doc/pay-station/features/ui-theme-customization/#pay_station_ui_theme_customization_in_token)하고 이 매개 변수의 해당 ID를 전달할 수도 있습니다.", "enum": [ "63295a9a2e47fab76f7708e1", "63295aab2e47fab76f7708e3" ], "type": "string" }, "user_account": { "additionalProperties": false, "description": "사용자 계정 세부 정보입니다.", "properties": { "info": { "additionalProperties": false, "description": "**내 계정** 페이지입니다.", "properties": { "enable": { "default": false, "description": "하위 메뉴를 표시할지 여부입니다. 기본값은 `false`입니다.", "type": "boolean" }, "order": { "description": "메뉴에서 하위 메뉴의 위치입니다.", "minimum": 1, "type": "integer" } }, "required": [ "enable", "order" ], "type": "object" }, "payment_accounts": { "additionalProperties": false, "description": "**내 결제 계정**의 하위 메뉴입니다.", "properties": { "enable": { "default": false, "description": "하위 메뉴를 표시할지 여부입니다. 기본값은 `false`입니다.", "type": "boolean" } }, "required": [ "enable" ], "type": "object" }, "subscriptions": { "additionalProperties": false, "description": "**구독 관리**의 하위 메뉴입니다.", "properties": { "enable": { "default": false, "description": "하위 메뉴를 표시할지 여부입니다. 기본값은 `false`입니다.", "type": "boolean" }, "order": { "description": "메뉴에서 하위 메뉴의 위치입니다.", "minimum": 1, "type": "integer" } }, "required": [ "enable", "order" ], "type": "object" } }, "type": "object" } }, "type": "object" }, "Cart_admin_payment": { "additionalProperties": false, "properties": { "items": { "items": { "properties": { "quantity": { "description": "아이템의 수량입니다.", "example": 2, "minimum": 1, "type": "number" }, "sku": { "description": "고유한 아이템 ID. SKU에는 소문자 및 대문자 라틴 알파벳, 숫자, 마침표, 하이픈, 밑줄만 사용할 수 있습니다.\n
주의

하나의 SKU를 여러 번 판매하려면 purchase.items[].quantity 매개 변수에서 필요한 수량을 지정합니다. 배열 내의 중복 SKU는 지원되지 않으며, 토큰 생성 시 첫 번째 항목만 사용됩니다. 이 경우 오류는 반환되지 않습니다.
", "example": "t-shirt", "minLength": 1, "type": "string" } }, "required": [ "sku", "quantity" ], "type": "object" }, "minItems": 1, "type": "array" } }, "required": [ "items" ], "type": "object" }, "Catalog_cart_promotions": { "description": "전체 장바구니에 적용된 프로모션. 다음의 경우 배열이 반환됩니다.\n\n * **구매 시 할인 설정** 프로모션 코드와 같이 프로모션이 전체 장바구니 금액에 영향을 미치는 경우\n\n * 장바구니에 보너스 아이템을 추가하는 프로모션의 경우\n\n적용되는 주문 수준 프로모션이 없는 경우 빈 배열이 반환됩니다.", "items": { "properties": { "bonus": { "items": { "properties": { "bundle_type": { "description": "보너스 번들 아이템 유형입니다. `bundle` 보너스 아이템 유형에서만 사용할 수 있습니다.", "enum": [ "standard", "virtual_currency_package" ], "type": "string" }, "image_url": { "description": "보너스 아이템 이미지 URL입니다. `physical_good` 보너스 아이템 유형에는 사용할 수 없습니다.", "type": "string" }, "name": { "description": "보너스 아이템 이름입니다. `physical_good` 보너스 아이템 유형에는 사용할 수 없습니다.", "type": "string" }, "quantity": { "type": "integer" }, "sku": { "type": "string" }, "type": { "description": "보너스 아이템 유형입니다.", "enum": [ "virtual_good", "virtual_currency", "bundle", "physical_good", "game_key", "nft" ], "type": "string" } }, "type": "object" }, "type": "array" }, "date_end": { "format": "date-time", "type": [ "string", "null" ] }, "date_start": { "format": "date-time", "type": [ "string", "null" ] }, "discount": { "properties": { "percent": { "type": [ "string", "null" ] }, "value": { "type": [ "string", "null" ] } }, "type": [ "object", "null" ] }, "limits": { "properties": { "per_user": { "properties": { "available": { "type": "integer" }, "total": { "type": "integer" } }, "type": "object" } }, "type": "object" }, "name": { "type": "string" } }, "type": "object" }, "type": "array" }, "Catalog_item_limits": { "description": "아이템 제한 사항입니다.", "properties": { "per_item": { "description": "한 개 아이템에 대한 아이템 제한 사항입니다.", "properties": { "available": { "description": "모든 사용자가 구매할 수 있는 남은 아이템 수량.", "example": 3, "type": "integer" }, "total": { "description": "모든 사용자가 구매할 수 있는 최대 아이템 수량.", "example": 5, "type": "integer" } }, "type": [ "object", "null" ] }, "per_user": { "description": "사용자 한 명에 대한 아이템 제한 사항입니다.", "properties": { "available": { "description": "현재 사용자가 구매할 수 있는 남은 아이템 수량.", "example": 3, "type": "integer" }, "limit_exceeded_visibility": { "$ref": "#/components/schemas/limit_exceeded_visibility" }, "recurrent_schedule": { "$ref": "#/components/schemas/catalog_recurrent_schedule_client_response" }, "total": { "description": "사용자 한 명이 구매할 수 있는 최대 아이템 수량.", "example": 5, "type": "integer" } }, "type": [ "object", "null" ] } }, "type": [ "object", "null" ] }, "Catalog_item_limits_with_hourly": { "description": "아이템 제한 사항입니다.", "properties": { "per_item": { "description": "한 개 아이템에 대한 아이템 제한 사항입니다.", "properties": { "available": { "description": "모든 사용자가 구매할 수 있는 남은 아이템 수량.", "example": 3, "type": "integer" }, "total": { "description": "모든 사용자가 구매할 수 있는 최대 아이템 수량.", "example": 5, "type": "integer" } }, "type": [ "object", "null" ] }, "per_user": { "description": "사용자 한 명에 대한 아이템 제한 사항입니다.", "properties": { "available": { "description": "현재 사용자가 구매할 수 있는 남은 아이템 수량.", "example": 3, "type": "integer" }, "limit_exceeded_visibility": { "$ref": "#/components/schemas/limit_exceeded_visibility" }, "recurrent_schedule": { "$ref": "#/components/schemas/catalog_recurrent_schedule_client_response" }, "total": { "description": "사용자 한 명이 구매할 수 있는 최대 아이템 수량.", "example": 5, "type": "integer" } }, "type": [ "object", "null" ] } }, "type": [ "object", "null" ] }, "Catalog_item_promotions": { "description": "장바구니의 특정 아이템에 적용된 프로모션. 다음의 경우 배열이 반환됩니다.\n\n* 특정 아이템에 대한 할인 프로모션이 구성된 경우\n\n* **선택한 아이템 할인** 설정이 있는 프로모션 코드가 적용된 경우\n\n적용된 아이템 수준 프로모션이 없는 경우 빈 배열이 반환됩니다.", "items": { "properties": { "bonus": { "items": { "properties": { "bundle_type": { "description": "보너스 번들 아이템 유형입니다. `bundle` 보너스 아이템 유형에서만 사용할 수 있습니다.", "enum": [ "standard", "virtual_currency_package" ], "type": "string" }, "image_url": { "description": "보너스 아이템 이미지 URL입니다. `physical_good` 보너스 아이템 유형에는 사용할 수 없습니다.", "type": "string" }, "name": { "description": "보너스 아이템 이름입니다. `physical_good` 보너스 아이템 유형에는 사용할 수 없습니다.", "type": "string" }, "quantity": { "type": "integer" }, "sku": { "type": "string" }, "type": { "description": "보너스 아이템 유형입니다.", "enum": [ "virtual_good", "virtual_currency", "bundle", "physical_good", "game_key", "nft" ], "type": "string" } }, "type": "object" }, "type": "array" }, "date_end": { "format": "date-time", "type": [ "string", "null" ] }, "date_start": { "format": "date-time", "type": [ "string", "null" ] }, "discount": { "properties": { "percent": { "type": [ "string", "null" ] }, "value": { "type": [ "string", "null" ] } }, "type": [ "object", "null" ] }, "limits": { "properties": { "per_user": { "properties": { "available": { "type": "integer" }, "total": { "type": "integer" } }, "type": "object" } }, "type": "object" }, "name": { "type": "string" } }, "type": "object" }, "type": "array" }, "Common_admin-image_url": { "description": "이미지 URL입니다.", "example": "https://image.example.com", "type": "string" }, "Game-Keys_422-invalid-request": { "properties": { "errorCode": { "example": 1102, "type": "integer" }, "errorMessage": { "example": "[0401-1102]: Unprocessable Entity. The property `property_name` is required", "type": "string" }, "statusCode": { "example": 422, "type": "integer" }, "transactionId": { "example": "x-x-x-x-transactionId-mock-x-x-x", "type": "string" } }, "type": "object" }, "Game-Keys_admin-attribute-external_id": { "description": "고유 특성 ID입니다. `external_id`는 소문자 및 대문자 라틴 영숫자, 마침표, 대시 및 밑줄만 포함할 수 있습니다.", "example": "attribute_1", "maxLength": 255, "minLength": 1, "pattern": "^[a-zA-Z0-9-_]+$", "type": "string" }, "Game-Keys_admin-attributes": { "description": "특성 목록입니다.", "items": { "$ref": "#/components/schemas/attribute" }, "type": "array" }, "Game-Keys_admin-post-put-attributes": { "description": "특성 목록입니다.\n
주의. 아이템에 20개 이상의 특성을 지정할 수 없습니다. 제한을 초과하려고 하면 오류가 발생합니다.
", "items": { "$ref": "#/components/schemas/admin-post-put-attribute-item" }, "maxItems": 20, "type": "array" }, "Game-Keys_client-attributes": { "default": [], "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" } ] } }, "items": { "properties": { "external_id": { "$ref": "#/components/schemas/Game-Keys_admin-attribute-external_id" }, "name": { "description": "특성의 이름입니다.", "example": "Genre", "type": "string" }, "values": { "items": { "properties": { "external_id": { "$ref": "#/components/schemas/Game-Keys_value-external_id" }, "value": { "description": "특성의 값입니다.", "example": "Strategy", "type": "string" } }, "type": "object" }, "type": "array" } }, "type": "object" }, "type": "array" }, "Game-Keys_client_name": { "description": "게임 패키지 이름입니다.", "example": "The Greatest Game in the World", "type": "string" }, "Game-Keys_description": { "description": "게임 패키지 설명입니다.", "example": "Description of the greatest game in the world.", "type": "string" }, "Game-Keys_drm_sku": { "description": "고유 DRM ID입니다.", "enum": [ "steam", "playstation", "xbox", "uplay", "origin", "drmfree", "gog", "epicgames", "nintendo_eshop", "discord_game_store", "oculus", "rockstar", "viveport", "stadia" ], "example": "steam", "type": "string" }, "Game-Keys_entitlement_item": { "properties": { "attributes": { "$ref": "#/components/schemas/Game-Keys_client-attributes" }, "description": { "$ref": "#/components/schemas/Game-Keys_description" }, "drm": { "$ref": "#/components/schemas/Game-Keys_drm_sku" }, "game_sku": { "$ref": "#/components/schemas/Game-Keys_game_sku" }, "image_url": { "$ref": "#/components/schemas/Game-Keys_image_url" }, "is_pre_order": { "description": "게임이 사전 판매 상태인지 여부입니다.", "example": false, "type": "boolean" }, "name": { "$ref": "#/components/schemas/Game-Keys_client_name" }, "project_id": { "$ref": "#/components/schemas/Game-Keys_project_id" } }, "type": "object" }, "Game-Keys_game_sku": { "description": "고유 키 패키지 ID입니다.", "example": "theGreatestGameSku", "maxLength": 255, "minLength": 1, "pattern": "^[a-zA-Z0-9_\\-–.]*$", "type": "string" }, "Game-Keys_image_url": { "description": "이미지 URL입니다.", "example": "https://none", "type": "string" }, "Game-Keys_project_id": { "description": "프로젝트 ID입니다. 이 매개 변수는 [관리자 페이지](https://publisher.xsolla.com/)의 프로젝트 이름 옆에서 확인할 수 있습니다.", "example": 44056, "type": "integer" }, "Game-Keys_regions": { "items": { "properties": { "id": { "example": 1, "type": "integer" } }, "type": "object" }, "type": "array" }, "Game-Keys_schemas-client-attributes": { "default": [], "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" } ] } }, "items": { "properties": { "external_id": { "$ref": "#/components/schemas/admin-attribute-external_id" }, "name": { "description": "특성의 이름입니다.", "example": "Genre", "type": "string" }, "values": { "items": { "properties": { "external_id": { "$ref": "#/components/schemas/value-external_id" }, "value": { "description": "특성의 값입니다.", "example": "Strategy", "type": "string" } }, "type": "object" }, "type": "array" } }, "type": "object" }, "type": "array" }, "Game-Keys_value-external_id": { "description": "특성의 고유한 값 ID입니다. `external_id`에는 소문자 라틴어 영숫자, 대시, 밑줄만 사용할 수 있습니다.", "example": "attribute_value", "maxLength": 255, "minLength": 1, "pattern": "^[-_.\\d\\w]+$", "type": "string" }, "Game-key-item-limit": { "description": "아이템 제한 사항입니다.", "properties": { "per_item": { "$ref": "#/components/schemas/limit_per_item" }, "per_user": { "$ref": "#/components/schemas/limit_per_user" }, "recurrent_schedule": { "$ref": "#/components/schemas/game_key_recurrent_schedule" } }, "type": "object" }, "Pagination_has-more": { "description": "페이지가 더 있다는 표시로 사용됩니다.", "example": true, "type": "boolean" }, "Pagination_total-items-count": { "description": "시스템에 있는 아이템의 총 수량입니다.", "example": 10, "type": "integer" }, "Promotions_coupon_code": { "default": "WINTER2021", "description": "고유한 대/소문자 구분 코드입니다. 문자와 숫자를 포함합니다.", "example": "WINTER2021", "maxLength": 128, "minLength": 1, "pattern": "^[a-zA-Z0-9]+$", "type": "string" }, "Regions_200-region-model": { "example": { "value": { "countries": [ "JP", "CN", "VN" ], "id": 44, "name": { "de-DE": "Asien", "en-US": "Asia" } } }, "properties": { "countries": { "$ref": "#/components/schemas/Regions_countries" }, "id": { "$ref": "#/components/schemas/Regions_region_id" }, "name": { "$ref": "#/components/schemas/Regions_name" } }, "type": "object" }, "Regions_200-region-short-model": { "properties": { "id": { "$ref": "#/components/schemas/Regions_region_id" }, "name": { "$ref": "#/components/schemas/Regions_name" } }, "type": "object" }, "Regions_countries": { "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" }, "type": "array" }, "Regions_name": { "additionalProperties": { "type": "string" }, "default": { "de-DE": "Asien", "en-US": "Asia" }, "description": "지역의 이름입니다. 키가 \"^[a-z]{2}-[A-Z]{2}$\" 형식의 로케일인 키/값 쌍을 포함해야 하며 값은 문자열입니다.", "example": { "de-DE": "Asien", "en-US": "Asia" }, "type": "object" }, "Regions_region_id": { "description": "지역 ID입니다. 프로젝트 내부의 고유 지역 식별자입니다.", "example": 42, "type": "integer" }, "User-limit-item": { "properties": { "per_user": { "properties": { "available": { "description": "사용자가 구매할 수 있는 남은 아이템의 개수입니다.", "example": 9, "type": "integer" }, "total": { "description": "사용자가 구매할 수 있는 아이템의 최대 개수입니다.", "example": 10, "type": "integer" } }, "type": "object" } }, "type": "object" }, "User-limit_available": { "description": "적용된 제한 설정 내에서 사용자가 사용할 수 있는 남은 아이템 또는 프로모션 사용 수량입니다.", "minimum": 1, "type": "integer" }, "User-limit_available_flexible": { "description": "적용된 제한 설정 내에서 사용자가 사용할 수 있는 남은 아이템 또는 프로모션 사용 수량입니다.", "minimum": 0, "type": "integer" }, "User-limit_user": { "properties": { "user_external_id": { "$ref": "#/components/schemas/User-limit_user-external-id" } }, "required": [ "user_external_id" ], "type": "object" }, "User-limit_user-external-id": { "description": "사용자 외부 ID입니다.", "minLength": 1, "pattern": "^\\S+$", "type": "string" }, "User-limit_user_flexible": { "properties": { "user_external_id": { "$ref": "#/components/schemas/User-limit_user-external-id" } }, "type": [ "object", "null" ] }, "Virtual-Currency-Package-item-limit": { "description": "아이템 제한 사항입니다.", "properties": { "per_item": { "$ref": "#/components/schemas/limit_per_item" }, "per_user": { "$ref": "#/components/schemas/limit_per_user" }, "recurrent_schedule": { "$ref": "#/components/schemas/virtual_currency_package_recurrent_schedule" } }, "type": "object" }, "Virtual-Currency-item-limit": { "description": "아이템 제한 사항입니다.", "properties": { "per_item": { "$ref": "#/components/schemas/limit_per_item" }, "per_user": { "$ref": "#/components/schemas/limit_per_user" }, "recurrent_schedule": { "$ref": "#/components/schemas/virtual_currency_recurrent_schedule" } }, "type": "object" }, "Virtual-Item-item-limit": { "description": "아이템 제한 사항입니다.", "properties": { "per_item": { "$ref": "#/components/schemas/limit_per_item" }, "per_user": { "$ref": "#/components/schemas/limit_per_user" }, "recurrent_schedule": { "$ref": "#/components/schemas/virtual_item_recurrent_schedule" } }, "type": "object" }, "Virtual-Items-Currency_422-invalid-request": { "properties": { "errorCode": { "example": 1102, "type": "integer" }, "errorMessage": { "example": "[0401-1102]: Unprocessable Entity. The property `property_name` is required", "type": "string" }, "errorMessageExtended": { "type": "array" }, "statusCode": { "example": 422, "type": "integer" }, "transactionId": { "example": "x-x-x-x-transactionId-mock-x-x-x", "type": "string" } }, "type": "object" }, "Virtual-Items-Currency_admin-attributes": { "allOf": [ { "$ref": "#/components/schemas/Virtual-Items-Currency_schemas-admin-attributes" }, { "description": "특성 목록입니다." } ] }, "Virtual-Items-Currency_admin-create-vc_prices": { "description": "Array of virtual currency prices.", "items": { "example": { "amount": 10, "is_default": true, "is_enabled": true, "sku": "com.xsolla.gold_1" }, "properties": { "amount": { "description": "인게임 재화의 아이템 가격입니다.", "type": "integer" }, "is_default": { "default": false, "description": "Whether it is the default price in virtual currency.", "type": "boolean" }, "is_enabled": { "default": true, "description": "Whether this price is used for displaying in the catalog and for purchasing the item. If `false`, the price is not used.", "type": "boolean" }, "sku": { "$ref": "#/components/schemas/Virtual-Items-Currency_schemas-sku" } }, "required": [ "amount", "sku", "is_default", "is_enabled" ], "type": "object" }, "type": [ "array", "null" ] }, "Virtual-Items-Currency_admin-create-virtual-currency": { "properties": { "attributes": { "$ref": "#/components/schemas/Virtual-Items-Currency_admin-post-put-attributes" }, "custom_attributes": { "$ref": "#/components/schemas/item-custom-attributes" }, "description": { "$ref": "#/components/schemas/description-localization-object" }, "groups": { "$ref": "#/components/schemas/Virtual-Items-Currency_admin-groups-create" }, "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" }, "is_show_in_store": { "$ref": "#/components/schemas/Virtual-Items-Currency_is_show_in_store" }, "limits": { "$ref": "#/components/schemas/Virtual-Currency-item-limit" }, "long_description": { "$ref": "#/components/schemas/long-description-localization-object" }, "media_list": { "$ref": "#/components/schemas/Virtual-Items-Currency_admin-media_list" }, "name": { "$ref": "#/components/schemas/name-localization-object" }, "order": { "$ref": "#/components/schemas/Virtual-Items-Currency_order" }, "periods": { "$ref": "#/components/schemas/item-periods" }, "prices": { "$ref": "#/components/schemas/Virtual-Items-Currency_admin-prices" }, "regions": { "$ref": "#/components/schemas/Virtual-Items-Currency_admin-regions" }, "sku": { "$ref": "#/components/schemas/Virtual-Items-Currency_sku" }, "vc_prices": { "$ref": "#/components/schemas/Virtual-Items-Currency_admin-create-vc_prices" } }, "required": [ "sku", "name" ], "type": "object" }, "Virtual-Items-Currency_admin-create-virtual-currency-package": { "anyOf": [ { "required": [ "prices" ] }, { "required": [ "vc_prices" ] } ], "properties": { "attributes": { "$ref": "#/components/schemas/Virtual-Items-Currency_admin-post-put-attributes" }, "content": { "description": "인게임 재화 패키지에는 1개의 인게임 재화 위치만 포함할 수 있습니다.", "items": { "properties": { "quantity": { "type": "integer" }, "sku": { "$ref": "#/components/schemas/Virtual-Items-Currency_sku" } }, "type": "object" }, "maxLength": 1, "minLength": 1, "type": "array" }, "custom_attributes": { "$ref": "#/components/schemas/item-custom-attributes" }, "description": { "$ref": "#/components/schemas/description-localization-object" }, "groups": { "$ref": "#/components/schemas/Virtual-Items-Currency_admin-groups-create" }, "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" }, "is_show_in_store": { "$ref": "#/components/schemas/Virtual-Items-Currency_is_show_in_store" }, "limits": { "$ref": "#/components/schemas/Virtual-Currency-Package-item-limit" }, "long_description": { "$ref": "#/components/schemas/long-description-localization-object" }, "media_list": { "$ref": "#/components/schemas/Virtual-Items-Currency_admin-media_list" }, "name": { "$ref": "#/components/schemas/name-localization-object" }, "order": { "$ref": "#/components/schemas/Virtual-Items-Currency_order" }, "periods": { "$ref": "#/components/schemas/item-periods" }, "prices": { "$ref": "#/components/schemas/Virtual-Items-Currency_admin-prices" }, "regions": { "$ref": "#/components/schemas/Virtual-Items-Currency_admin-regions" }, "sku": { "$ref": "#/components/schemas/Virtual-Items-Currency_sku" }, "vc_prices": { "$ref": "#/components/schemas/Virtual-Items-Currency_admin-create-vc_prices" } }, "required": [ "sku", "name", "description", "content" ], "type": "object" }, "Virtual-Items-Currency_admin-create-virtual-item": { "properties": { "attributes": { "$ref": "#/components/schemas/Virtual-Items-Currency_admin-post-put-attributes" }, "custom_attributes": { "$ref": "#/components/schemas/item-custom-attributes" }, "description": { "$ref": "#/components/schemas/description-localization-object" }, "groups": { "$ref": "#/components/schemas/Virtual-Items-Currency_admin-groups-create" }, "image_url": { "$ref": "#/components/schemas/Virtual-Items-Currency_schemas-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" }, "is_show_in_store": { "$ref": "#/components/schemas/Virtual-Items-Currency_is_show_in_store" }, "limits": { "$ref": "#/components/schemas/Virtual-Item-item-limit" }, "long_description": { "$ref": "#/components/schemas/long-description-localization-object" }, "media_list": { "$ref": "#/components/schemas/Virtual-Items-Currency_admin-media_list" }, "name": { "$ref": "#/components/schemas/name-localization-object" }, "order": { "$ref": "#/components/schemas/Virtual-Items-Currency_order" }, "periods": { "$ref": "#/components/schemas/item-periods" }, "prices": { "$ref": "#/components/schemas/Virtual-Items_admin-prices" }, "regions": { "$ref": "#/components/schemas/Virtual-Items-Currency_admin-regions" }, "sku": { "$ref": "#/components/schemas/Virtual-Items-Currency_sku" }, "vc_prices": { "$ref": "#/components/schemas/Virtual-Items-Currency_admin-create-vc_prices" } }, "type": "object" }, "Virtual-Items-Currency_admin-get-vc_prices": { "items": { "example": { "amount": 10, "is_default": true, "sku": "com.xsolla.gold_1" }, "properties": { "amount": { "description": "금액.", "exclusiveMinimum": 0, "type": "number" }, "is_default": { "default": false, "type": "boolean" }, "sku": { "$ref": "#/components/schemas/Virtual-Items-Currency_schemas-sku" } }, "required": [ "sku", "amount" ], "type": "object" }, "type": "array" }, "Virtual-Items-Currency_admin-groups-create": { "description": "List of [group external IDs](/ko/api/catalog/item-groups-admin/admin-get-item-group-list/#!path=groups/external_id&t=response) the item belongs to.\n\nExample: [\"horror\", \"action\"]", "items": { "properties": { "external_id": { "example": "accessory", "type": "string" }, "name": { "example": "Accessory", "type": "string" } }, "type": "string" }, "type": "array" }, "Virtual-Items-Currency_admin-groups-response": { "default": [], "description": "아이템이 속한 그룹입니다.", "example": [ { "external_id": "horror", "name": { "en": "Horror" } } ], "items": { "properties": { "external_id": { "example": "horror", "type": "string" }, "name": { "additionalProperties": { "type": "string" }, "default": { "en": "Horror" }, "description": "아이템의 이름입니다. 키가 \"^[a-z]{2}\" 형식의 로케일인\n키/값 쌍을 포함해야 하며 값은 문자열입니다.", "example": { "de": "Horror", "en": "Horror" }, "type": "object" } }, "type": "object" }, "type": "array" }, "Virtual-Items-Currency_admin-image_url": { "description": "이미지 URL입니다.", "type": "string" }, "Virtual-Items-Currency_admin-media_list": { "description": "스크린샷, 게임 플레이 동영상 등과 같은 아이템의 추가 자산입니다.", "example": [ { "type": "image", "url": "https://cdn3.xsolla.com/img/misc/images/71ab1e12126f2103e1868076f0acb21a.jpg" } ], "items": { "properties": { "type": { "description": "미디어 유형: `image`/`video`.", "enum": [ "image", "video" ], "example": "image", "type": "string" }, "url": { "description": "리소스 파일입니다.", "example": "https://cdn3.xsolla.com/img/misc/images/71ab1e12126f2103e1868076f0acb21a.jpg", "type": "string" } }, "type": "object" }, "type": "array" }, "Virtual-Items-Currency_admin-post-put-attributes": { "description": "특성 목록입니다.\n
주의. 아이템에 20개 이상의 특성을 지정할 수 없습니다. 제한을 초과하려고 하면 오류가 발생합니다.
", "items": { "$ref": "#/components/schemas/admin-post-put-attribute-item" }, "maxItems": 20, "type": "array" }, "Virtual-Items-Currency_admin-prices": { "items": { "example": { "amount": 10.5, "country_iso": "US", "currency": "USD", "is_default": true, "is_enabled": true }, "properties": { "amount": { "description": "Item price in real currency.", "example": 10.5, "exclusiveMinimum": 0, "type": "number" }, "country_iso": { "description": "이 가격을 사용할 수 있는 국가입니다. [ISO 3166-1 alpha 2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)에 따른 2자리 글자 코드입니다.", "example": "US", "type": [ "string", "null" ] }, "currency": { "description": "아이템 가격 통화입니다. [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)에 따른 3자리 코드입니다. [엑솔라에서 지원하는 통화](https://developers.xsolla.com/ko/doc/pay-station/references/supported-currencies/)에 대한 자세한 내용은 설명서를 확인하십시오.", "example": "USD", "type": "string" }, "is_default": { "default": false, "description": "Whether it is the default price in real currency. Refer to our [documentation](https://developers.xsolla.com/ko/items-catalog/catalog-features/pricing-policy/#pricing_policy_country_determination) for detailed information on price settings.", "type": "boolean" }, "is_enabled": { "default": true, "description": "Whether this price is used for displaying in the catalog and for purchasing the item. If `false`, the price is not used and another price is applied. Refer to our [documentation](https://developers.xsolla.com/ko/items-catalog/catalog-features/pricing-policy/#pricing_policy_country_determination) for detailed information on price settings.", "example": true, "type": "boolean" } }, "required": [ "amount", "currency" ], "type": "object" }, "type": "array" }, "Virtual-Items-Currency_admin-regions": { "description": "Array of regions where the item is available. If the array is empty or not passed, the item is available in all regions.", "items": { "properties": { "id": { "description": "Region ID within the project.\n\nRefer to the [regional sale restriction documentation](https://developers.xsolla.com/ko/items-catalog/catalog-features/regional-restrictions/) and [region management API calls](https://developers.xsolla.com/ko/api/catalog/common-regions) for detailed information.", "example": 1, "minimum": 1, "type": "integer" } }, "type": "object" }, "type": "array" }, "Virtual-Items-Currency_admin-virtual-currency": { "properties": { "attributes": { "$ref": "#/components/schemas/Virtual-Items-Currency_admin-attributes" }, "custom_attributes": { "$ref": "#/components/schemas/item-custom-attributes-response" }, "description": { "$ref": "#/components/schemas/description-localization-object" }, "groups": { "$ref": "#/components/schemas/Virtual-Items-Currency_admin-groups-response" }, "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" }, "is_show_in_store": { "$ref": "#/components/schemas/Virtual-Items-Currency_is_show_in_store" }, "limits": { "$ref": "#/components/schemas/admin-item-limit-response" }, "long_description": { "$ref": "#/components/schemas/long-description-localization-object" }, "media_list": { "$ref": "#/components/schemas/Virtual-Items-Currency_admin-media_list" }, "name": { "$ref": "#/components/schemas/name-localization-object" }, "order": { "$ref": "#/components/schemas/Virtual-Items-Currency_order" }, "periods": { "$ref": "#/components/schemas/item-periods-response" }, "prices": { "$ref": "#/components/schemas/Virtual-Items-Currency_admin-prices" }, "regions": { "$ref": "#/components/schemas/Virtual-Items-Currency_admin-regions" }, "sku": { "$ref": "#/components/schemas/Virtual-Items-Currency_sku" }, "type": { "$ref": "#/components/schemas/Virtual-Items-Currency_type" }, "vc_prices": { "$ref": "#/components/schemas/Virtual-Items-Currency_admin-get-vc_prices" } }, "type": "object" }, "Virtual-Items-Currency_admin-virtual-currency-package": { "properties": { "attributes": { "$ref": "#/components/schemas/Virtual-Items-Currency_admin-attributes" }, "bundle_type": { "default": "virtual_currency_package", "example": "virtual_currency_package", "type": "string" }, "content": { "items": { "properties": { "description": { "$ref": "#/components/schemas/description-localization-object" }, "image_url": { "$ref": "#/components/schemas/Virtual-Items-Currency_admin-image_url" }, "name": { "$ref": "#/components/schemas/name-localization-object" }, "quantity": { "type": "integer" }, "sku": { "$ref": "#/components/schemas/Virtual-Items-Currency_sku" }, "type": { "$ref": "#/components/schemas/Virtual-Items-Currency_type" } }, "type": "object" }, "type": "array" }, "custom_attributes": { "$ref": "#/components/schemas/item-custom-attributes" }, "description": { "$ref": "#/components/schemas/description-localization-object" }, "groups": { "$ref": "#/components/schemas/Virtual-Items-Currency_admin-groups-response" }, "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" }, "is_show_in_store": { "$ref": "#/components/schemas/Virtual-Items-Currency_is_show_in_store" }, "limits": { "$ref": "#/components/schemas/admin-item-limit-response" }, "long_description": { "$ref": "#/components/schemas/long-description-localization-object" }, "media_list": { "$ref": "#/components/schemas/Virtual-Items-Currency_admin-media_list" }, "name": { "$ref": "#/components/schemas/name-localization-object" }, "order": { "$ref": "#/components/schemas/Virtual-Items-Currency_order" }, "periods": { "$ref": "#/components/schemas/item-periods-response" }, "prices": { "$ref": "#/components/schemas/Virtual-Items-Currency_admin-prices" }, "regions": { "$ref": "#/components/schemas/Virtual-Items-Currency_admin-regions" }, "sku": { "$ref": "#/components/schemas/Virtual-Items-Currency_sku" }, "type": { "$ref": "#/components/schemas/Virtual-Items-Currency_type" }, "vc_prices": { "$ref": "#/components/schemas/Virtual-Items-Currency_admin-get-vc_prices" } }, "type": "object" }, "Virtual-Items-Currency_admin-virtual-item": { "properties": { "attributes": { "$ref": "#/components/schemas/Virtual-Items-Currency_admin-attributes" }, "custom_attributes": { "$ref": "#/components/schemas/item-custom-attributes-response" }, "description": { "$ref": "#/components/schemas/description-localization-object" }, "groups": { "$ref": "#/components/schemas/Virtual-Items-Currency_admin-groups-response" }, "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" }, "is_show_in_store": { "$ref": "#/components/schemas/Virtual-Items-Currency_is_show_in_store" }, "limits": { "$ref": "#/components/schemas/admin-item-limit-response" }, "long_description": { "$ref": "#/components/schemas/long-description-localization-object" }, "media_list": { "$ref": "#/components/schemas/Virtual-Items-Currency_admin-media_list" }, "name": { "$ref": "#/components/schemas/name-localization-object" }, "order": { "$ref": "#/components/schemas/Virtual-Items-Currency_order" }, "periods": { "$ref": "#/components/schemas/item-periods-response" }, "prices": { "$ref": "#/components/schemas/Virtual-Items_admin-prices" }, "regions": { "$ref": "#/components/schemas/Virtual-Items-Currency_admin-regions" }, "sku": { "$ref": "#/components/schemas/Virtual-Items-Currency_sku" }, "type": { "$ref": "#/components/schemas/Virtual-Items-Currency_type" }, "vc_prices": { "$ref": "#/components/schemas/Virtual-Items-Currency_admin-get-vc_prices" } }, "type": "object" }, "Virtual-Items-Currency_client-attributes": { "default": [], "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" } ] } }, "items": { "properties": { "external_id": { "$ref": "#/components/schemas/admin-attribute-external_id" }, "name": { "additionalProperties": { "type": [ "string", "null" ] }, "description": "특성의 이름입니다.", "example": "Genre", "type": "object" }, "values": { "items": { "properties": { "external_id": { "$ref": "#/components/schemas/value-external_id" }, "value": { "description": "특성의 값입니다.", "example": "Strategy", "type": "string" } }, "type": "object" }, "type": "array" } }, "type": "object" }, "type": "array" }, "Virtual-Items-Currency_is_enabled": { "default": true, "description": "Whether the item is available. If `false`, the item can't be purchased in the store or obtained as part of a bundle or within a marketing campaign. Refer to our [documentation](https://developers.xsolla.com/ko/items-catalog/catalog-features/items-availability/) for detailed information about item availability.", "example": true, "type": "boolean" }, "Virtual-Items-Currency_is_show_in_store": { "default": false, "description": "Whether the item is displayed in the catalog. If `false` and `is_enabled: true`, the item is not visible in the catalog but can be obtained as part of a bundle or within marketing campaigns. Refer to our [documentation](https://developers.xsolla.com/ko/items-catalog/catalog-features/items-availability/) for detailed information about item availability.", "example": true, "type": "boolean" }, "Virtual-Items-Currency_item": { "properties": { "attributes": { "$ref": "#/components/schemas/Virtual-Items-Currency_client-attributes" }, "can_be_bought": { "$ref": "#/components/schemas/Can_be_bought" }, "custom_attributes": { "$ref": "#/components/schemas/item-custom-attributes-response" }, "description": { "additionalProperties": { "type": [ "string", "null" ] }, "description": "아이템 설명입니다.", "example": "Big Rocket - description", "type": "object" }, "groups": { "$ref": "#/components/schemas/items_client_groups_response" }, "image_url": { "description": "이미지 URL입니다.", "example": "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png", "type": "string" }, "is_free": { "$ref": "#/components/schemas/value-is_free" }, "item_id": { "description": "아이템 ID입니다.", "type": "number" }, "limits": { "$ref": "#/components/schemas/client-item-limit-response" }, "name": { "additionalProperties": { "type": [ "string", "null" ] }, "description": "아이템 이름입니다.", "example": "Big Rocket", "type": "object" }, "periods": { "$ref": "#/components/schemas/item-periods-response" }, "price": { "description": "아이템 가격입니다.", "properties": { "amount": { "description": "할인된 아이템 가격입니다.", "example": "100.99", "type": "string" }, "amount_without_discount": { "description": "아이템 가격입니다.", "example": "100.99", "type": "string" }, "currency": { "description": "아이템 가격 통화입니다. [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)에 따른 3자리 코드입니다. [엑솔라에서 지원하는 통화](https://developers.xsolla.com/ko/doc/pay-station/references/supported-currencies/)에 대한 자세한 내용은 설명서를 확인하십시오.", "example": "USD", "type": "string" } }, "type": [ "object", "null" ] }, "promotions": { "$ref": "#/components/schemas/Catalog_item_promotions" }, "sku": { "description": "고유 아이템 ID입니다. SKU는 소문자 및 대문자 라틴 영숫자, 마침표, 대시 및 밑줄만 포함할 수 있습니다.", "example": "big_rocket", "type": "string" }, "type": { "description": "아이템 유형: `virtual_good`/`virtual_currency`/`bundle`.", "example": "virtual_good", "type": "string" }, "virtual_item_type": { "description": "Type of virtual item.\n\nPossible values:\n- `consumable` — An item that disappears from the inventory after use (e.g., ammo).\n- `non_consumable` — An item that stays in the inventory for an unlimited period of time.\n- `non_renewing_subscription` — Time-limited item that can represent access to services or content for a limited period of time.", "enum": [ "consumable", "non_consumable", "non_renewing_subscription" ], "example": "non-consumable", "type": "string" }, "virtual_prices": { "description": "가상 가격입니다.", "items": { "description": "가상 가격입니다.", "properties": { "amount": { "description": "인게임 재화로 표시된 할인된 아이템 가격입니다.", "example": 100, "type": "integer" }, "amount_without_discount": { "description": "아이템 가격입니다.", "example": 200, "type": "integer" }, "description": { "description": "인게임 재화 설명입니다.", "example": "Big Rocket - description", "type": "string" }, "image_url": { "description": "인게임 재화의 이미지입니다.", "example": "http://image.png", "type": "string" }, "is_default": { "description": "아이템의 가격이 기본값인지 여부입니다.", "example": true, "type": "boolean" }, "name": { "description": "인게임 재화 이름입니다.", "example": "SHOTGUN FOR TRUE RAIDERS", "type": "string" }, "sku": { "description": "인게임 재화 아이템 SKU입니다.", "example": "vc_test", "type": "string" }, "type": { "description": "인게임 재화 유형입니다.", "example": "virtual_currency", "type": "string" } }, "type": "object" }, "type": "array" }, "vp_rewards": { "$ref": "#/components/schemas/client-item-value-point-reward" } }, "type": "object" }, "Virtual-Items-Currency_item-list": { "properties": { "has_more": { "$ref": "#/components/schemas/Pagination_has-more" }, "items": { "items": { "$ref": "#/components/schemas/Virtual-Items-Currency_item" }, "type": "array" } }, "type": "object" }, "Virtual-Items-Currency_order": { "default": 1, "description": "Item display order in the catalog. The higher the value, the lower the item appears in the list.\nIf the values are the same, items are sorted by creation date, with newer items displayed higher.", "example": 1, "type": "integer" }, "Virtual-Items-Currency_schemas-admin-attributes": { "description": "특성 목록입니다.", "items": { "$ref": "#/components/schemas/attribute" }, "type": "array" }, "Virtual-Items-Currency_schemas-admin-image_url": { "description": "이미지 URL입니다.", "example": "https://image.example.com", "type": "string" }, "Virtual-Items-Currency_schemas-sku": { "description": "고유 아이템 ID입니다. SKU는 소문자 및 대문자 라틴 영숫자, 마침표, 대시 및 밑줄만 포함할 수 있습니다.", "example": "bundle_1", "type": "string" }, "Virtual-Items-Currency_sku": { "description": "고유 아이템 ID입니다. SKU는 소문자 및 대문자 라틴 영숫자, 마침표, 대시 및 밑줄만 포함할 수 있습니다.", "example": "booster_mega_1", "maxLength": 255, "minLength": 1, "pattern": "^[a-zA-Z0-9_\\-–.]*$", "type": "string" }, "Virtual-Items-Currency_type": { "description": "아이템의 유형: `virtual_good`/`virtual_currency`/`bundle`/`physical_good`/`unit`.", "type": "string" }, "Virtual-Items-Currency_virtual-currency": { "properties": { "attributes": { "$ref": "#/components/schemas/Virtual-Items-Currency_client-attributes" }, "can_be_bought": { "$ref": "#/components/schemas/Can_be_bought" }, "custom_attributes": { "$ref": "#/components/schemas/item-custom-attributes-response" }, "description": { "description": "아이템 설명입니다.", "example": "Crystals - description", "type": "string" }, "groups": { "$ref": "#/components/schemas/items_client_groups_response" }, "image_url": { "description": "이미지 URL입니다.", "example": "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png", "type": "string" }, "is_free": { "$ref": "#/components/schemas/value-is_free" }, "item_id": { "type": "integer" }, "limits": { "$ref": "#/components/schemas/Catalog_item_limits" }, "name": { "description": "아이템 이름입니다.", "example": "Big Rocket", "type": "string" }, "periods": { "$ref": "#/components/schemas/item-periods-response" }, "price": { "description": "아이템 가격입니다.", "properties": { "amount": { "description": "할인된 아이템 가격입니다.", "example": "100.99", "type": "string" }, "amount_without_discount": { "description": "아이템 가격입니다.", "example": "100.99", "type": "string" }, "currency": { "description": "아이템 가격 통화입니다. [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)에 따른 3자리 코드입니다. [엑솔라에서 지원하는 통화](https://developers.xsolla.com/ko/doc/pay-station/references/supported-currencies/)에 대한 자세한 내용은 설명서를 확인하십시오.", "example": "USD", "type": "string" } }, "type": [ "object", "null" ] }, "promotions": { "$ref": "#/components/schemas/Catalog_item_promotions" }, "sku": { "description": "고유 아이템 ID입니다. SKU는 소문자 및 대문자 라틴 영숫자, 마침표, 대시 및 밑줄만 포함할 수 있습니다.", "example": "big_rocket", "type": "string" }, "type": { "description": "아이템 유형: `virtual_good`/`virtual_currency`/`bundle`.", "example": "virtual_currency", "type": "string" }, "virtual_prices": { "description": "가상 가격입니다.", "example": [ { "amount": 100, "amount_without_discount": 100, "image_url": "http://image.png", "is_default": true, "sku": "com.xsolla.crystals_1" } ], "items": { "description": "가상 가격입니다.", "properties": { "amount": { "description": "인게임 재화로 표시된 할인된 아이템 가격입니다.", "example": 100, "type": "integer" }, "amount_without_discount": { "description": "아이템 가격입니다.", "example": 200, "type": "integer" }, "description": { "description": "인게임 재화 설명입니다.", "example": "Crystals - description", "type": "string" }, "image_url": { "description": "인게임 재화의 이미지입니다.", "example": "http://image.png", "type": "string" }, "is_default": { "description": "아이템의 가격이 기본값인지 여부입니다.", "example": true, "type": "boolean" }, "name": { "description": "인게임 재화 이름입니다.", "example": "Crystals", "type": "string" }, "sku": { "description": "인게임 재화 아이템 SKU입니다.", "example": "com.xsolla.vc_1", "type": "string" }, "type": { "description": "인게임 재화 유형입니다.", "example": "virtual_currency", "type": "string" } }, "type": "object" }, "type": "array" }, "vp_rewards": { "type": "array" } }, "type": "object" }, "Virtual-Items-Currency_virtual-currency-list": { "properties": { "has_more": { "$ref": "#/components/schemas/Pagination_has-more" }, "items": { "items": { "$ref": "#/components/schemas/Virtual-Items-Currency_virtual-currency" }, "type": "array" } }, "type": "object" }, "Virtual-Items-Currency_virtual-currency-package": { "properties": { "attributes": { "$ref": "#/components/schemas/Virtual-Items-Currency_client-attributes" }, "bundle_type": { "description": "번들 유형: `standard`/`virtual_currency_package`.", "example": "virtual_currency_package", "type": "string" }, "can_be_bought": { "$ref": "#/components/schemas/Can_be_bought" }, "content": { "description": "인게임 재화 패키지 콘텐츠입니다.", "example": [ { "description": "Crystal Pack - short description", "image_url": "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png", "name": "Crystal Pack", "quantity": 100, "sku": "com.xsolla.crystal_pack_1", "type": "virtual_currency" } ], "items": { "description": "패키지의 인게임 재화입니다.", "properties": { "description": { "description": "아이템 설명입니다.", "example": "Big Rocket - description", "type": "string" }, "image_url": { "description": "이미지 URL입니다.", "example": "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png", "type": "string" }, "item_id": { "type": "integer" }, "limits": { "$ref": "#/components/schemas/Catalog_item_limits" }, "name": { "description": "아이템 이름입니다.", "example": "Big Rocket", "type": "string" }, "quantity": { "description": "패키지의 인게임 재화의 수량입니다.", "example": 250, "type": "integer" }, "sku": { "description": "고유 아이템 ID입니다. SKU는 소문자 및 대문자 라틴 영숫자, 마침표, 대시 및 밑줄만 포함할 수 있습니다.", "example": "com.xsolla.big_rocket_1", "type": "string" }, "type": { "description": "아이템 유형: `virtual_good`/`virtual_currency`/`bundle`.", "example": "virtual_currency", "type": "string" } }, "type": "object" }, "type": "array" }, "custom_attributes": { "$ref": "#/components/schemas/item-custom-attributes-response" }, "description": { "description": "아이템 설명입니다.", "example": "Crystal Pack Description", "type": "string" }, "groups": { "$ref": "#/components/schemas/items_client_groups_response" }, "image_url": { "description": "이미지 URL입니다.", "example": "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png", "type": "string" }, "is_free": { "$ref": "#/components/schemas/value-is_free" }, "item_id": { "type": "integer" }, "limits": { "$ref": "#/components/schemas/Catalog_item_limits" }, "name": { "description": "아이템 이름입니다.", "example": "Crystal Pack", "type": "string" }, "periods": { "$ref": "#/components/schemas/item-periods-response" }, "price": { "description": "아이템 가격입니다.", "properties": { "amount": { "description": "할인된 아이템 가격입니다.", "example": "100.99", "type": "string" }, "amount_without_discount": { "description": "아이템 가격입니다.", "example": "100.99", "type": "string" }, "currency": { "description": "아이템 가격 통화입니다. [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)에 따른 3자리 코드입니다. [엑솔라에서 지원하는 통화](https://developers.xsolla.com/ko/doc/pay-station/references/supported-currencies/)에 대한 자세한 내용은 설명서를 확인하십시오.", "example": "USD", "type": "string" } }, "type": "object" }, "promotions": { "$ref": "#/components/schemas/Catalog_item_promotions" }, "sku": { "description": "고유 아이템 ID입니다. SKU는 소문자 및 대문자 라틴 영숫자, 마침표, 대시 및 밑줄만 포함할 수 있습니다.", "example": "crystal-pack", "type": "string" }, "type": { "description": "아이템 유형: `virtual_good`/`virtual_currency`/`bundle`.", "example": "bundle", "type": "string" }, "virtual_prices": { "description": "가상 가격입니다.", "items": { "description": "가상 가격입니다.", "properties": { "amount": { "description": "인게임 재화로 표시된 할인된 아이템 가격입니다.", "example": 100, "type": "integer" }, "amount_without_discount": { "description": "아이템 가격입니다.", "example": 200, "type": "integer" }, "description": { "description": "인게임 재화 설명입니다.", "example": "Big Rocket - description", "type": "string" }, "image_url": { "description": "인게임 재화의 이미지입니다.", "example": "http://image.png", "type": "string" }, "is_default": { "description": "아이템의 가격이 기본값인지 여부입니다.", "example": true, "type": "boolean" }, "name": { "description": "인게임 재화 이름입니다.", "example": "SHOTGUN FOR TRUE RAIDERS", "type": "string" }, "sku": { "description": "인게임 재화 아이템 SKU입니다.", "example": "vc_test", "type": "string" }, "type": { "description": "인게임 재화 유형입니다.", "example": "virtual_currency", "type": "string" } }, "type": "object" }, "type": "array" }, "vp_rewards": { "type": "array" } }, "type": "object" }, "Virtual-Items-Currency_virtual-currency-packages": { "properties": { "has_more": { "$ref": "#/components/schemas/Pagination_has-more" }, "items": { "items": { "$ref": "#/components/schemas/Virtual-Items-Currency_virtual-currency-package" }, "type": "array" } }, "type": "object" }, "Virtual-Items_admin-prices": { "items": { "example": { "amount": 10.5, "currency": "USD", "is_default": true, "is_enabled": true }, "properties": { "amount": { "description": "금액.", "exclusiveMinimum": 0, "type": "number" }, "country_iso": { "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", "type": "string" }, "currency": { "description": "아이템 가격 통화입니다. [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)에 따른 3자리 코드입니다. [엑솔라에서 지원하는 통화](https://developers.xsolla.com/ko/doc/pay-station/references/supported-currencies/)에 대한 자세한 내용은 설명서를 확인하십시오.", "example": "USD", "type": "string" }, "is_default": { "default": false, "type": "boolean" }, "is_enabled": { "default": true, "type": "boolean" } }, "required": [ "amount", "currency" ], "type": "object" }, "type": "array" }, "admin-attribute-external_id": { "description": "고유 특성 ID입니다. `external_id`는 소문자 및 대문자 라틴 영숫자, 대시 및 밑줄만 포함할 수 있습니다.", "example": "attribute_1", "maxLength": 255, "minLength": 1, "pattern": "^[a-zA-Z0-9-_]+$", "type": "string" }, "admin-attribute-name": { "additionalProperties": { "type": "string" }, "default": { "de": "Genre", "en": "Genre" }, "description": "특성의 이름에 대한 현지화가 있는 개체입니다. 키는 ISO 3166-1에 따라 지정되어 있습니다.", "example": { "de": "Genre", "en": "Genre" }, "type": "object" }, "admin-group-create-request": { "description": "Item group data.", "properties": { "description": { "$ref": "#/components/schemas/group-description-localization-object" }, "external_id": { "description": "External ID of the item group. Can contain only alphanumeric characters, hyphens, and underscores.", "example": "weapons", "pattern": "^[A-Za-z0-9_\\-]+$", "type": "string" }, "iconUrl": { "$ref": "#/components/schemas/group-image-url" }, "isEnabled": { "allOf": [ { "$ref": "#/components/schemas/group-is-enabled" } ], "default": true }, "name": { "$ref": "#/components/schemas/group-name-localization-object" }, "order": { "allOf": [ { "$ref": "#/components/schemas/group-display-order" } ] } }, "required": [ "external_id", "name" ], "type": "object" }, "admin-group-detail-response-by-item-type": { "allOf": [ { "$ref": "#/components/schemas/admin-group-response-base" }, { "properties": { "is_contains_any_items": { "$ref": "#/components/schemas/group-is-contains-any-items" } }, "type": "object" } ] }, "admin-group-response-base": { "properties": { "description": { "$ref": "#/components/schemas/group-description-localization-object" }, "external_id": { "description": "External item group ID specified during creation.", "example": "weapons", "type": "string" }, "id": { "description": "Item group ID assigned by Xsolla.", "example": 1, "type": "integer" }, "image_url": { "$ref": "#/components/schemas/group-image-url" }, "is_enabled": { "$ref": "#/components/schemas/group-is-enabled" }, "items_count": { "description": "Total number of items in the group.", "example": 5, "type": "integer" }, "name": { "$ref": "#/components/schemas/group-name-localization-object" }, "order": { "$ref": "#/components/schemas/group-display-order" } }, "required": [ "id", "external_id", "name", "is_enabled" ], "type": "object" }, "admin-group-response-by-item-type": { "allOf": [ { "$ref": "#/components/schemas/admin-group-response-base" }, { "properties": { "is_contains_any_items": { "$ref": "#/components/schemas/group-is-contains-any-items" } }, "type": "object" } ] }, "admin-group-update-request": { "description": "Item group data to update. The `external_id` and `name` fields are required in every request. Other fields are optional — omitted fields will retain their current values.", "properties": { "description": { "$ref": "#/components/schemas/group-description-localization-object" }, "external_id": { "description": "Unique group external ID. Can contain only alphanumeric characters, hyphens, and underscores. Can be used to rename the group's external ID.", "example": "weapons", "pattern": "^[A-Za-z0-9_\\-]+$", "type": "string" }, "iconUrl": { "$ref": "#/components/schemas/group-image-url" }, "isEnabled": { "allOf": [ { "$ref": "#/components/schemas/group-is-enabled" } ] }, "name": { "$ref": "#/components/schemas/group-name-localization-object" }, "order": { "allOf": [ { "$ref": "#/components/schemas/group-display-order" } ] } }, "required": [ "external_id", "name" ], "type": "object" }, "admin-item-limit-response": { "description": "아이템 제한 사항입니다.", "properties": { "per_item": { "description": "전역 항목 제한 사항입니다.", "properties": { "available": { "description": "모든 사용자가 구매할 수 있는 남은 아이템 수량.", "type": "integer" }, "reserved": { "type": "integer" }, "sold": { "type": "integer" }, "total": { "description": "모든 사용자가 구매할 수 있는 최대 아이템 수량.", "type": "integer" } }, "type": [ "object", "null" ] }, "per_user": { "description": "개별 사용자에 대한 아이템 제한 사항입니다.", "properties": { "limit_exceeded_visibility": { "$ref": "#/components/schemas/limit_exceeded_visibility" }, "total": { "description": "사용자 한 명이 구매할 수 있는 최대 아이템 수량.", "type": "integer" } }, "type": [ "object", "null" ] }, "recurrent_schedule": { "$ref": "#/components/schemas/admin_recurrent_schedule_response" } }, "type": [ "object", "null" ] }, "admin-post-put-attribute-item": { "maxItems": 6, "properties": { "external_id": { "$ref": "#/components/schemas/admin-attribute-external_id" }, "name": { "$ref": "#/components/schemas/admin-attribute-name" }, "values": { "description": "
주의. 각 특성 당 6개 이상의 값을 생성할 수 없습니다. 제한을 초과하려고 하면 오류가 발생합니다.
", "example": [ { "external_id": "strategy", "value": { "de": "Strategie", "en": "Strategy" } }, { "external_id": "action", "value": { "de": "Aktion", "en": "Action" } } ], "items": { "$ref": "#/components/schemas/attribute-value" }, "type": "array" } }, "required": [ "external_id", "values" ], "type": "object" }, "admin_attribute_response": { "example": { "value": [ { "external_id": "genre", "name": { "de": "Genre", "en": "Genre" } } ] }, "properties": { "external_id": { "$ref": "#/components/schemas/admin-attribute-external_id" }, "name": { "$ref": "#/components/schemas/admin-attribute-name" } }, "type": "object" }, "admin_recurrent_schedule_response": { "description": "새로고침 기간을 제한합니다.", "properties": { "per_user": { "description": "사용자 제한 새로고침 기간입니다.", "oneOf": [ { "description": "일일 사용자 유형 제한 설정을 새로고침합니다.", "properties": { "displayable_reset_next_date": { "description": "제한 설정을 재설정해야 하는 날짜 및 시간입니다(ISO 8601).", "example": "2023-02-28T11:00:00+08:00", "format": "date-time", "type": "string" }, "displayable_reset_start_date": { "description": "첫 번째 제한 설정을 새로고침하는 날짜 및 시간입니다(ISO 8601).", "example": "2023-02-28T11:00:00+08:00", "format": "date-time", "type": "string" }, "interval_type": { "description": "반복 새로고침 기간 유형입니다.", "enum": [ "daily" ], "type": "string" }, "reset_next_date": { "description": "새로고침 제한 설정이 적용되는 날짜 및 시간입니다(Unix 타임스탬프)", "example": 1677553200, "type": "integer" }, "time": { "description": "원하는 시간대의 제한 시간 새로고침 시간입니다(시간 단위로 반올림).", "example": "11:00:00+03:00", "format": "full-time", "type": "string" } }, "title": "interval_type = 일일", "type": "object" }, { "description": "주간 사용자 유형 제한 설정을 새로고침합니다.", "properties": { "day_of_week": { "description": "제한을 새로고침하는 요일입니다. 여기서 1은 월요일이고 7은 일요일입니다. `weekly` 제한 설정 새로고침 기간 유형만 `null`이 아닙니다.", "maximum": 7, "minimum": 1, "type": [ "integer", "null" ] }, "displayable_reset_next_date": { "description": "제한 설정을 재설정해야 하는 날짜 및 시간입니다(ISO 8601).", "example": "2023-02-28T11:00:00+08:00", "format": "date-time", "type": "string" }, "displayable_reset_start_date": { "description": "첫 번째 제한 설정을 새로고침하는 날짜 및 시간입니다(ISO 8601).", "example": "2023-02-28T11:00:00+08:00", "format": "date-time", "type": "string" }, "interval_type": { "description": "반복 새로고침 기간 유형입니다.", "enum": [ "weekly" ], "type": "string" }, "reset_next_date": { "description": "새로고침 제한 설정이 적용되는 날짜 및 시간입니다(Unix 타임스탬프)", "example": 1677553200, "type": "integer" }, "time": { "description": "원하는 시간대의 제한 시간 새로고침 시간입니다(시간 단위로 반올림).", "example": "11:00:00+03:00", "format": "full-time", "type": "string" } }, "title": "interval_type = 주간", "type": "object" }, { "description": "월간 사용자 제한 설정 새로고침 유형입니다.", "properties": { "day_of_month": { "description": "제한 설정을 새로고침하는 날짜입니다. 해당 월의 일수가 짧아 선택한 날짜가 없으면 해당 월의 마지막 날에 새로고침합니다. `monthly` 제한 설정 새로고침 기간 유형만 `null`이 아닙니다.", "maximum": 31, "minimum": 1, "type": [ "integer", "null" ] }, "displayable_reset_next_date": { "description": "제한 설정을 재설정해야 하는 날짜 및 시간입니다(ISO 8601).", "example": "2023-02-28T11:00:00+08:00", "format": "date-time", "type": "string" }, "displayable_reset_start_date": { "description": "첫 번째 제한 설정을 새로고침하는 날짜 및 시간입니다(ISO 8601).", "example": "2023-02-28T11:00:00+08:00", "format": "date-time", "type": "string" }, "interval_type": { "description": "반복 새로고침 기간 유형입니다.", "enum": [ "monthly" ], "type": "string" }, "reset_next_date": { "description": "새로고침 제한 설정이 적용되는 날짜 및 시간입니다(Unix 타임스탬프)", "example": 1677553200, "type": "integer" }, "time": { "description": "원하는 시간대의 제한 시간 새로고침 시간입니다(시간 단위로 반올림).", "example": "11:00:00+03:00", "format": "full-time", "type": "string" } }, "title": "interval_type = 월간", "type": "object" }, { "description": "사용자 제한이 지정된 시간 간격(시간 단위)으로 재설정됩니다.", "properties": { "displayable_reset_next_date": { "description": "제한 설정을 재설정해야 하는 날짜 및 시간입니다(ISO 8601).", "example": "2023-02-28T11:00:00+08:00", "format": "date-time", "type": "string" }, "displayable_reset_start_date": { "description": "첫 번째 제한 설정을 새로고침하는 날짜 및 시간입니다(ISO 8601).", "example": "2023-02-28T11:00:00+08:00", "format": "date-time", "type": "string" }, "hours_interval": { "description": "제한 업데이트 간격(시간).

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

예를 들어, `date_from = \"2025-11-15T18:15:00+05:00\"`이고 `hours_interval = 2`인 경우, 해당 아이템의 구매 제한은 `\"2025-11-15T20:15:00+05:00\"`부터 2시간마다 갱신됩니다.", "maximum": 10000, "minimum": 1, "type": "integer" }, "interval_type": { "description": "반복 새로고침 기간 유형입니다.", "enum": [ "hourly" ], "type": "string" }, "reset_next_date": { "description": "새로고침 제한 설정이 적용되는 날짜 및 시간입니다(Unix 타임스탬프)", "example": 1677553200, "type": "integer" } }, "title": "interval_type = 시간", "type": "object" } ], "type": [ "object", "null" ] } }, "type": [ "object", "null" ] }, "attribute": { "example": { "external_id": "attribute_external_id", "name": { "de": "Attributname", "en": "Attribute name" }, "values": [ { "external_id": "value_1", "name": { "de": "wert 1", "en": "value 1" } }, { "external_id": "value_2", "name": { "de": "wert 2", "en": "value 2" } } ] }, "properties": { "external_id": { "$ref": "#/components/schemas/admin-attribute-external_id" }, "name": { "$ref": "#/components/schemas/admin-attribute-name" }, "values": { "example": [ { "external_id": "strategy", "value": { "de": "Strategie", "en": "Strategy" } }, { "external_id": "action", "value": { "de": "Aktion", "en": "Action" } } ], "items": { "$ref": "#/components/schemas/attribute-value" }, "type": "array" } }, "required": [ "external_id", "values" ], "type": "object" }, "attribute-value": { "example": { "external_id": "value_external_id", "name": { "de": "Wert 1", "en": "Value 1" } }, "properties": { "external_id": { "$ref": "#/components/schemas/value-external_id" }, "value": { "$ref": "#/components/schemas/value-name" } }, "required": [ "value", "external_id" ], "type": "object" }, "bundle-item-limit": { "description": "아이템 제한 사항입니다.", "properties": { "per_item": { "$ref": "#/components/schemas/limit_per_item" }, "per_user": { "$ref": "#/components/schemas/limit_per_user" }, "recurrent_schedule": { "$ref": "#/components/schemas/bundle_recurrent_schedule" } }, "type": "object" }, "bundle_recurrent_schedule": { "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" } ] } }, "type": [ "object", "null" ] }, "bundle_type": { "description": "번들 유형입니다. 아이템 유형이 번들인 경우 반환됩니다.", "enum": [ "standard", "virtual_currency_package", "partner_side_content" ], "type": "string" }, "catalog_recurrent_schedule_client_response": { "description": "아이템이 사용자의 반복 새로고침 기간을 제한합니다.", "oneOf": [ { "description": "일일 사용자 유형 제한 설정을 새로고침합니다.", "properties": { "interval_type": { "description": "반복 새로고침 기간 유형입니다.", "enum": [ "daily" ], "type": "string" }, "reset_next_date": { "description": "재설정 제한이 적용되는 날짜 및 시간입니다(Unix 타임스탬프)", "example": 1677553200, "type": "integer" } }, "title": "interval_type = 일일", "type": "object" }, { "description": "주간 사용자 유형 제한 설정을 새로고침합니다.", "properties": { "interval_type": { "description": "반복 새로고침 기간 유형입니다.", "enum": [ "weekly" ], "type": "string" }, "reset_next_date": { "description": "재설정 제한이 적용되는 날짜 및 시간입니다(Unix 타임스탬프)", "example": 1677553200, "type": "integer" } }, "title": "interval_type = 주간", "type": "object" }, { "description": "월간 사용자 제한 설정 새로고침 유형입니다.", "properties": { "interval_type": { "description": "반복 새로고침 기간 유형입니다.", "enum": [ "monthly" ], "type": "string" }, "reset_next_date": { "description": "재설정 제한이 적용되는 날짜 및 시간입니다(Unix 타임스탬프)", "example": 1677553200, "type": "integer" } }, "title": "interval_type = 월간", "type": "object" }, { "description": "사용자 제한이 지정된 시간 간격(시간 단위)으로 재설정됩니다.", "properties": { "interval_type": { "description": "반복 새로고침 기간 유형입니다.", "enum": [ "hourly" ], "type": "string" }, "reset_next_date": { "description": "재설정 제한이 적용되는 날짜 및 시간입니다(Unix 타임스탬프)", "example": 1677553200, "type": "integer" } }, "title": "interval_type = 시간", "type": "object" } ], "type": [ "object", "null" ] }, "client-item-limit-response": { "description": "아이템 제한 사항입니다.", "properties": { "per_item": { "description": "전역 항목 제한 사항입니다.", "properties": { "available": { "description": "모든 사용자가 구매할 수 있는 남은 아이템 수량.", "type": "integer" }, "total": { "description": "모든 사용자가 구매할 수 있는 최대 아이템 수량.", "type": "integer" } }, "type": [ "object", "null" ] }, "per_user": { "description": "개별 사용자에 대한 아이템 제한 사항입니다.", "properties": { "available": { "description": "현재 사용자가 구매할 수 있는 남은 아이템 수량.", "type": "integer" }, "limit_exceeded_visibility": { "$ref": "#/components/schemas/limit_exceeded_visibility" }, "recurrent_schedule": { "$ref": "#/components/schemas/catalog_recurrent_schedule_client_response" }, "total": { "description": "사용자 한 명이 구매할 수 있는 최대 아이템 수량.", "type": "integer" } }, "type": [ "object", "null" ] } }, "type": [ "object", "null" ] }, "client-item-value-point-reward": { "description": "가치 포인트 아이템 보상입니다.", "items": { "properties": { "amount": { "$ref": "#/components/schemas/value-point-amount" }, "image_url": { "$ref": "#/components/schemas/Common_admin-image_url" }, "is_clan": { "$ref": "#/components/schemas/is_clan" }, "item_id": { "$ref": "#/components/schemas/item_id" }, "name": { "$ref": "#/components/schemas/value-point-name" }, "sku": { "$ref": "#/components/schemas/value-point-sku" } }, "type": "object" }, "type": "array" }, "description-localization-object": { "anyOf": [ { "$ref": "#/components/schemas/two-letter-locale" }, { "$ref": "#/components/schemas/five-letter-locale" } ], "description": "아이템 설명에 대한 현지화가 있는 개체입니다. 두 글자 소문자 언어 코드(예: `en`) 또는 다섯 글자 로케일 코드(예: `en-US`) 두 가지 형식 중 하나로 되어 있는 값을 허용합니다. 두 형식 모두 입력으로 허용되지만 응답은 두 글자 소문자 언어 코드를 반환합니다. 동일한 언어에 대한 두 옵션(예: `en` 및 `en-US`)이 모두 제공되면 마지막으로 제공된 값이 저장됩니다. 지원되는 언어의 전체 목록은 [문서](/ko/doc/shop-builder/references/supported-languages/)에서 확인할 수 있습니다.", "type": [ "object", "null" ] }, "error-message-extended-validation": { "description": "Validation error details. Contains an array of property-level errors describing which fields failed validation and why.", "items": { "properties": { "message": { "description": "Validation error message for the field.", "example": "The property external_id is required", "type": "string" }, "property": { "description": "Name of the field that failed validation.", "example": "external_id", "type": "string" } }, "type": "object" }, "type": "array" }, "error-response-base": { "properties": { "errorCode": { "description": "오류 코드입니다.", "type": "integer" }, "errorMessage": { "description": "Short error description.", "type": "string" }, "statusCode": { "description": "HTTP response status.", "type": "integer" }, "transactionId": { "description": "Request ID. The ID used to track and associate log entries related to this specific request or operation. This ID can be helpful for troubleshooting, debugging, and auditing purposes.", "type": "string" } }, "type": "object" }, "five-letter-locale": { "description": "다섯 글자 로케일 코드.", "properties": { "ar-AE": { "description": "아랍어", "type": [ "string", "null" ] }, "bg-BG": { "description": "불가리아어", "type": [ "string", "null" ] }, "cs-CZ": { "description": "체코어", "type": [ "string", "null" ] }, "de-DE": { "description": "독일어", "type": [ "string", "null" ] }, "en-US": { "description": "영어", "type": [ "string", "null" ] }, "es-ES": { "description": "스페인어(스페인)", "type": [ "string", "null" ] }, "fr-FR": { "description": "프랑스어", "type": [ "string", "null" ] }, "he-IL": { "description": "히브리어", "type": [ "string", "null" ] }, "id-ID": { "description": "인도네시아어", "type": [ "string", "null" ] }, "it-IT": { "description": "이탈리아어", "type": [ "string", "null" ] }, "ja-JP": { "description": "일본어", "type": [ "string", "null" ] }, "km-KH": { "description": "크메르어", "type": [ "string", "null" ] }, "ko-KR": { "description": "한국어", "type": [ "string", "null" ] }, "lo-LA": { "description": "라오스어", "type": [ "string", "null" ] }, "my-MM": { "description": "버마어", "type": [ "string", "null" ] }, "ne-NP": { "description": "네팔어", "type": [ "string", "null" ] }, "ph-PH": { "description": "필리핀어", "type": [ "string", "null" ] }, "pl-PL": { "description": "폴란드어", "type": [ "string", "null" ] }, "pt-BR": { "description": "포르투갈어(브라질)", "type": [ "string", "null" ] }, "ro-RO": { "description": "로마니아어", "type": [ "string", "null" ] }, "ru-RU": { "description": "러시아어", "type": [ "string", "null" ] }, "th-TH": { "description": "태국어", "type": [ "string", "null" ] }, "tr-TR": { "description": "터키어", "type": [ "string", "null" ] }, "vi-VN": { "description": "베트남어", "type": [ "string", "null" ] }, "zh-CN": { "description": "중국어(간체)", "type": [ "string", "null" ] }, "zh-TW": { "description": "중국어(번체)", "type": [ "string", "null" ] } }, "title": "five-letter", "type": [ "object", "null" ] }, "game_key_recurrent_schedule": { "description": "새로고침 기간을 제한합니다.", "properties": { "per_user": { "oneOf": [ { "$ref": "#/components/schemas/per_user_daily" }, { "$ref": "#/components/schemas/per_user_weekly" }, { "$ref": "#/components/schemas/per_user_monthly" } ] } }, "type": [ "object", "null" ] }, "group-description-localization-object": { "anyOf": [ { "$ref": "#/components/schemas/two-letter-locale" }, { "$ref": "#/components/schemas/five-letter-locale" } ], "description": "Object with localizations for group's description. Accepts value in one of two formats: two-letter lowercase language codes (e.g., `en`) or five-character locale codes (e.g., `en-US`). While both formats are accepted as input, responses return two-letter lowercase language codes. When both options for the same language are provided (e.g., `en` and `en-US`), the last provided value is stored. You can find the full list of supported languages in the [documentation](/ko/doc/shop-builder/references/supported-languages/).", "type": [ "object", "null" ] }, "group-display-order": { "default": 1, "description": "Display order of the item group in the catalog. The higher the value, the lower the group appears in the list. If the values are the same, groups are sorted by creation date, with newer groups displayed higher.", "example": 1, "type": "integer" }, "group-image-url": { "description": "URL of the item group image.", "example": "https://example.com/weapons.png", "type": [ "string", "null" ] }, "group-is-contains-any-items": { "description": "Whether the group contains any items, regardless of the specified `item_type`. A group can have `items_count: 0` for the specified type, while `is_contains_any_items` is `true` if the group contains items of other types.", "example": true, "type": "boolean" }, "group-is-enabled": { "default": true, "description": "Whether the item group is enabled in the catalog.", "example": true, "type": "boolean" }, "group-name-localization-object": { "anyOf": [ { "$ref": "#/components/schemas/two-letter-locale" }, { "$ref": "#/components/schemas/five-letter-locale" } ], "description": "Object with localizations for group's name. Accepts value in one of two formats: two-letter lowercase language codes (e.g., `en`) or five-character locale codes (e.g., `en-US`). While both formats are accepted as input, responses return two-letter lowercase language codes. When both options for the same language are provided (e.g., `en` and `en-US`), the last provided value is stored. You can find the full list of supported languages in the [documentation](/ko/doc/shop-builder/references/supported-languages/).", "type": [ "object", "null" ] }, "hours_interval": { "maximum": 10000, "minimum": 1, "type": "integer" }, "interval_type_hourly": { "description": "반복 새로고침 기간입니다.", "enum": [ "hourly" ], "type": "string" }, "is_clan": { "description": "값 포인트가 클랜 보상 체인에서 사용되는지 여부입니다.", "example": true, "type": "boolean" }, "item-custom-attributes": { "description": "아이템 특성과 값이 포함된 JSON 개체입니다. 특성을 사용하면 아이템을 사용할 수 있는 플레이어의 레벨과 같은 추가 정보를 아이템에 추가할 수 있습니다. 특성은 게임의 내부 논리를 강화하며 전용 GET 메소드와 웹훅을 통해 이용할 수 있습니다.", "format": "json", "maxLength": 500, "type": "object" }, "item-custom-attributes-response": { "description": "아이템 특성 및 값이 포함된 JSON 개체입니다.", "format": "json", "type": "object" }, "item-in-group-order-request-item": { "additionalProperties": false, "properties": { "item_id": { "description": "Internal item ID assigned by Xsolla. Use the item ID returned in the [item catalog API call](/ko/api/catalog/common-catalog) responses.", "example": 101, "minimum": 0, "type": "integer" }, "order": { "description": "New display order value.", "example": 1, "minimum": 0, "type": "integer" } }, "required": [ "item_id", "order" ], "type": "object" }, "item-periods": { "description": "아이템 판매 기간입니다.", "items": { "properties": { "date_from": { "description": "지정된 아이템을 판매할 수 있는 날짜입니다.", "example": "2020-08-11T10:00:00+03:00", "format": "date-time", "type": "string" }, "date_until": { "description": "지정된 아이템을 판매할 수 없게 되는 날짜입니다. `null`일 수 있습니다.", "example": "2020-08-11T20:00:00+03:00", "format": "date-time", "type": [ "string", "null" ] } }, "type": "object" }, "type": [ "array", "null" ] }, "item-periods-response": { "description": "아이템 판매 기간입니다.", "items": { "properties": { "date_from": { "description": "지정된 아이템을 판매할 수 있는 날짜입니다.", "example": "2020-08-11T10:00:00+03:00", "format": "date-time", "type": [ "string", "null" ] }, "date_until": { "description": "지정된 아이템을 판매할 수 없게 되는 날짜입니다. `null`일 수 있습니다.", "example": "2020-08-11T20:00:00+03:00", "format": "date-time", "type": [ "string", "null" ] } }, "type": "object" }, "type": "array" }, "item_id": { "description": "내부의 고유 아이템 ID입니다.", "example": 1, "type": "integer" }, "items_client_groups_response": { "default": [], "description": "아이템이 속한 그룹입니다.", "example": [ { "external_id": "exclusive", "name": "Exclusive" } ], "items": { "properties": { "external_id": { "description": "그룹의 고유 식별자로, 일반적으로 API 요청 또는 외부 시스템에서 참조하는 데 사용됩니다.", "example": "exclusive", "type": "string" }, "item_order_in_group": { "description": "그룹 내 아이템 위치로, 표시 순서를 결정하는 데 사용됩니다.\n이 필드는 additional_fields[] 쿼리 매개 변수를 통해 요청된 경우에만 응답에 포함됩니다.", "example": 1, "type": "integer" }, "name": { "description": "그룹의 이름입니다.", "example": "Exclusive", "type": "string" } }, "type": "object" }, "type": "array" }, "limit_exceeded_visibility": { "default": "show", "description": "Determines the visibility of the item in the catalog after the purchase limit is reached, until the next limit reset.\n\nApplies to items for which recurring limit resets are configured in the `recurrent_schedule` array.\n\nIf limit resets are not configured, the item doesn't appear in the catalog after the purchase limit is reached,\nregardless of the `limit_exceeded_visibility` value.\n\nPossible values:\n- `show` — The item is returned in catalog retrieval API calls after the purchase limit is reached. In client-side\ncatalog retrieval API calls, once the limit is reached, the item is returned with the `can_be_bought: false` flag. The\nnext reset date is returned in `reset_next_date`.\n- `hide` — The item is not returned in catalog retrieval API calls after the purchase limit is reached, until the\nlimit is reset.", "enum": [ "show", "hide" ], "example": "show", "type": "string" }, "limit_per_item": { "description": "전역 항목 제한 사항입니다.", "example": 10, "type": [ "integer", "null" ] }, "limit_per_user": { "anyOf": [ { "description": "사용자당 아이템 구매 제한이 없습니다.", "type": "null" }, { "description": "사용자 한 명이 구매할 수 있는 최대 아이템 수량.", "example": 5, "type": "integer" }, { "description": "자세한 구매 한도 설정.", "properties": { "limit_exceeded_visibility": { "$ref": "#/components/schemas/limit_exceeded_visibility" }, "total": { "description": "사용자 한 명이 구매할 수 있는 최대 아이템 수량.", "example": 5, "type": "integer" } }, "type": "object" } ], "description": "개별 사용자에 대한 아이템 제한 사항입니다." }, "long-description-localization-object": { "anyOf": [ { "$ref": "#/components/schemas/two-letter-locale" }, { "$ref": "#/components/schemas/five-letter-locale" } ], "description": "아이템의 긴 설명에 대한 현지화가 있는 개체입니다. 두 글자 소문자 언어 코드(예: `en`) 또는 5자 로케일 코드(예 `en-US`: ) 두 가지 형식 중 하나로 값을 허용합니다. 두 형식 모두 입력으로 허용되지만 응답은 두 글자 소문자 언어 코드를 반환합니다. 동일한 언어에 대한 두 변수(예: `en` 및 `en-US`)가 모두 제공되면 마지막으로 제공된 값이 저장됩니다. 지원되는 언어의 전체 목록은 [문서](/ko/doc/shop-builder/references/supported-languages/)에서 확인할 수 있습니다.", "type": [ "object", "null" ] }, "name-localization-object": { "anyOf": [ { "$ref": "#/components/schemas/two-letter-locale" }, { "$ref": "#/components/schemas/five-letter-locale" } ], "description": "아이템 이름에 대한 현지화가 있는 개체입니다. 두 글자 소문자 언어 코드(예: `en`) 또는 다섯 글자 언어 코드(예: `en-US`) 두 가지 형식 중 하나로 되어 있는 값을 허용합니다. 두 형식 모두 입력으로 허용되지만 응답은 두 글자 소문자 언어 코드를 반환합니다. 동일한 언어에 대한 두 옵션(예: `en` 및 `en-US`)이 모두 제공되면 마지막으로 제공된 값이 저장됩니다. 지원되는 언어의 전체 목록은 [문서](/ko/doc/shop-builder/references/supported-languages/)에서 확인할 수 있습니다.", "type": [ "object", "null" ] }, "per_user_daily": { "description": "일일 사용자 유형 제한 설정을 새로고침합니다.", "properties": { "interval_type": { "description": "반복 새로고침 기간입니다.", "enum": [ "daily" ], "type": "string" }, "time": { "description": "원하는 시간대의 제한 시간 새로고침 시간입니다(시간 단위로 반올림).", "example": "02:00:00+03:00", "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])", "type": "string" } }, "required": [ "interval_type", "time" ], "title": "interval_type = 일일", "type": "object" }, "per_user_hourly_bundle": { "properties": { "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시간마다 재설정됩니다." } ] }, "interval_type": { "$ref": "#/components/schemas/interval_type_hourly" } }, "required": [ "interval_type", "hours_interval" ], "title": "interval_type = 시간", "type": "object" }, "per_user_hourly_vc": { "properties": { "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시간마다 재설정됩니다." } ] }, "interval_type": { "$ref": "#/components/schemas/interval_type_hourly" } }, "required": [ "interval_type", "hours_interval" ], "title": "interval_type = 시간", "type": "object" }, "per_user_hourly_vcp": { "properties": { "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시간마다 재설정됩니다." } ] }, "interval_type": { "$ref": "#/components/schemas/interval_type_hourly" } }, "required": [ "interval_type", "hours_interval" ], "title": "interval_type = 시간", "type": "object" }, "per_user_hourly_vi": { "properties": { "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시간마다 재설정됩니다." } ] }, "interval_type": { "$ref": "#/components/schemas/interval_type_hourly" } }, "required": [ "interval_type", "hours_interval" ], "title": "interval_type = 시간", "type": "object" }, "per_user_monthly": { "description": "월간 사용자 제한 설정 새로고침 유형입니다.", "properties": { "day_of_month": { "description": "제한 설정을 새로고침하는 날짜입니다. 해당 월의 일수가 짧아 선택한 날짜가 없으면 해당 월의 마지막 날에 새로고침합니다.", "maximum": 31, "minimum": 1, "type": "integer" }, "interval_type": { "description": "반복 새로고침 기간입니다.", "enum": [ "monthly" ], "type": "string" }, "time": { "description": "원하는 시간대의 제한 시간 새로고침 시간입니다(시간 단위로 반올림).", "example": "23:00:00+03:00", "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])", "type": "string" } }, "required": [ "interval_type", "time", "day_of_month" ], "title": "interval_type = 월간", "type": "object" }, "per_user_weekly": { "description": "주간 사용자 유형 제한 설정을 새로고침합니다.", "properties": { "day_of_week": { "description": "제한을 새로고침하는 요일입니다. 여기서 1은 월요일이고 7은 일요일입니다.", "maximum": 7, "minimum": 1, "type": "integer" }, "interval_type": { "description": "반복 새로고침 기간입니다.", "enum": [ "weekly" ], "type": "string" }, "time": { "description": "원하는 시간대의 제한 시간 새로고침 시간입니다(시간 단위로 반올림).", "example": "11:00:00+03:00", "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])", "type": "string" } }, "title": "interval_type = 주간", "type": "object" }, "request-attribute-value": { "example": { "external_id": "value_id", "value": { "de": "Wert", "en": "Value" } }, "properties": { "external_id": { "$ref": "#/components/schemas/value-external_id" }, "value": { "$ref": "#/components/schemas/value-name" } }, "required": [ "external_id", "value" ], "type": "object" }, "schemas-422-invalid-request": { "properties": { "errorCode": { "example": 1102, "type": "integer" }, "errorMessage": { "example": "[0401-1102]: Unprocessable Entity. The property `property_name` is required", "type": "string" }, "statusCode": { "example": 422, "type": "integer" }, "transactionId": { "example": "x-x-x-x-transactionId-mock-x-x-x", "type": "string" } }, "type": "object" }, "two-letter-locale": { "description": "두 글자 소문자 언어 코드입니다.", "properties": { "ar": { "description": "아랍어", "type": [ "string", "null" ] }, "bg": { "description": "불가리아어", "type": [ "string", "null" ] }, "cn": { "description": "중국어(간체)", "type": [ "string", "null" ] }, "cs": { "description": "체코어", "type": [ "string", "null" ] }, "de": { "description": "독일어", "type": [ "string", "null" ] }, "en": { "description": "영어", "type": [ "string", "null" ] }, "es": { "description": "스페인어(스페인)", "type": [ "string", "null" ] }, "fr": { "description": "프랑스어", "type": [ "string", "null" ] }, "he": { "description": "히브리어", "type": [ "string", "null" ] }, "id": { "description": "인도네시아어", "type": [ "string", "null" ] }, "it": { "description": "이탈리아어", "type": [ "string", "null" ] }, "ja": { "description": "일본어", "type": [ "string", "null" ] }, "km": { "description": "크메르어", "type": [ "string", "null" ] }, "ko": { "description": "한국어", "type": [ "string", "null" ] }, "lo": { "description": "라오스어", "type": [ "string", "null" ] }, "my": { "description": "버마어", "type": [ "string", "null" ] }, "ne": { "description": "네팔어", "type": [ "string", "null" ] }, "ph": { "description": "필리핀어", "type": [ "string", "null" ] }, "pl": { "description": "폴란드어", "type": [ "string", "null" ] }, "pt": { "description": "포르투칼어", "type": [ "string", "null" ] }, "ro": { "description": "로마니아어", "type": [ "string", "null" ] }, "ru": { "description": "러시아어", "type": [ "string", "null" ] }, "th": { "description": "태국어", "type": [ "string", "null" ] }, "tr": { "description": "터키어", "type": [ "string", "null" ] }, "tw": { "description": "중국어(번체)", "type": [ "string", "null" ] }, "vi": { "description": "베트남어", "type": [ "string", "null" ] } }, "title": "two-letter", "type": [ "object", "null" ] }, "value-cart_is_free": { "default": false, "description": "`true`이면 장바구니는 무료입니다.", "example": false, "type": "boolean" }, "value-external_id": { "description": "특성의 고유한 값 ID입니다. `external_id`에는 소문자 라틴어 영숫자, 대시, 밑줄만 사용할 수 있습니다.", "example": "attribute_value", "maxLength": 255, "minLength": 1, "pattern": "^[-_.\\d\\w]+$", "type": "string" }, "value-is_free": { "default": false, "description": "아이템이 무료인지 여부입니다.", "example": false, "type": "boolean" }, "value-is_paid_randomized_reward": { "default": false, "description": "아이템이 예를 들어, 루트 박스와 같이 무작위로 지급되었는지 여부.", "example": false, "type": "boolean" }, "value-name": { "additionalProperties": { "type": "string" }, "default": { "de": "Strategie", "en": "Strategy" }, "description": "값의 이름에 대한 현지화가 있는 개체입니다. 키는 ISO 3166-1에 따라 지정되어 있습니다.", "example": { "de": "Strategie", "en": "Strategy" }, "type": "object" }, "value-point-amount": { "description": "가치 포인트의 금액입니다.", "type": "integer" }, "value-point-name": { "description": "가치 포인트 이름입니다.", "type": "string" }, "value-point-sku": { "description": "고유 가치 포인트 ID입니다.", "type": "string" }, "virtual_currency_package_recurrent_schedule": { "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" } ] } }, "type": [ "object", "null" ] }, "virtual_currency_recurrent_schedule": { "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" } ] } }, "type": [ "object", "null" ] }, "virtual_item_recurrent_schedule": { "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" } ] } }, "type": [ "object", "null" ] } }, "securitySchemes": { "AuthForCart": { "description": "이 `AuthForCart` 인증 체계는 장바구니 구매에 사용되며 두 가지 모드를 지원합니다.\n\n1. 사용자의 JWT로 인증. 토큰은 `Authorization: Bearer ` 형식으로 인증 헤더에 전달됩니다. ``는 사용자 토큰입니다. 이 토큰은 사용자를 식별하고 개인화된 데이터에 대한 액세스를 제공합니다. 다음 테스트 토큰을 사용하여 이 호출을 시도해 볼 수 있습니다. `Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHAiOjE5NjIyMzQwNDgsImlzcyI6Imh0dHBzOi8vbG9naW4ueHNvbGxhLmNvbSIsImlhdCI6MTU2MjE0NzY0OCwidXNlcm5hbWUiOiJ4c29sbGEiLCJ4c29sbGFfbG9naW5fYWNjZXNzX2tleSI6IjA2SWF2ZHpDeEVHbm5aMTlpLUc5TmMxVWFfTWFZOXhTR3ZEVEY4OFE3RnMiLCJzdWIiOiJkMzQyZGFkMi05ZDU5LTExZTktYTM4NC00MjAxMGFhODAwM2YiLCJlbWFpbCI6InN1cHBvcnRAeHNvbGxhLmNvbSIsInR5cGUiOiJ4c29sbGFfbG9naW4iLCJ4c29sbGFfbG9naW5fcHJvamVjdF9pZCI6ImU2ZGZhYWM2LTc4YTgtMTFlOS05MjQ0LTQyMDEwYWE4MDAwNCIsInB1Ymxpc2hlcl9pZCI6MTU5MjR9.GCrW42OguZbLZTaoixCZgAeNLGH2xCeJHxl8u8Xn2aI`\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`.", "scheme": "bearer", "type": "http" }, "XsollaLoginUserJWT": { "bearerFormat": "JWT", "description": "클라이언트 측 호출은 `XsollaLoginUserJWT` 인증 체계를 사용합니다. 요청에는 Bearer `` 형식으로 `Authorization` 헤더에 사용자의 JWT를 포함해야 합니다. 이 토큰은 사용자를 식별하고 개인화된 데이터에 대한 액세스 를 제공합니다. 토큰 생성 방법에 대한 자세한 내용은 [엑솔라 로그인 API 문서(/api/login/authentication-schemes#getting-user-token)를 참조하십시오.\n\n테스트 토큰을 사용하여 이 호출을 시도해 볼 수 있습니다. `Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHAiOjE5NjIyMzQwNDgsImlzcyI6Imh0dHBzOi8vbG9naW4ueHNvbGxhLmNvbSIsImlhdCI6MTU2MjE0NzY0OCwidXNlcm5hbWUiOiJ4c29sbGEiLCJ4c29sbGFfbG9naW5fYWNjZXNzX2tleSI6IjA2SWF2ZHpDeEVHbm5aMTlpLUc5TmMxVWFfTWFZOXhTR3ZEVEY4OFE3RnMiLCJzdWIiOiJkMzQyZGFkMi05ZDU5LTExZTktYTM4NC00MjAxMGFhODAwM2YiLCJlbWFpbCI6InN1cHBvcnRAeHNvbGxhLmNvbSIsInR5cGUiOiJ4c29sbGFfbG9naW4iLCJ4c29sbGFfbG9naW5fcHJvamVjdF9pZCI6ImU2ZGZhYWM2LTc4YTgtMTFlOS05MjQ0LTQyMDEwYWE4MDAwNCIsInB1Ymxpc2hlcl9pZCI6MTU5MjR9.GCrW42OguZbLZTaoixCZgAeNLGH2xCeJHxl8u8Xn2aI`\n\n또는 [결제 UI를 여는 토큰](/ko/api/pay-station/token/create-token)을 사용할 수 있습니다.", "scheme": "bearer", "type": "http" }, "basicAuth": { "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 * **회사 설정 > 회사** 섹션에서\n * 관리자 페이지의 브라우저 주소 표시줄에 있는 URL에 있습니다. URL의 형식은 \n `https://publisher.xsolla.com/`입니다.\n* `api_key`는 관리자 페이지가 생성될 때 한 번만 표시되며 사용자 측에 저장해야 합니다. 다음 섹션에서 새 키를 만들 수 있습니다. \n * [회사 설정 > API 키](https://publisher.xsolla.com/0/settings/api_key)\n * [프로젝트 설정 > API 키](https://publisher.xsolla.com/0/projects/0/edit/api_key)\n\n{% html name=\"div\" attrs={\"class\": \"notice\"} %}\n**주의**\n\n필수 API 호출에 `project_id` 경로 매개 변수가 포함되어 있지 않은으면 인증 시 모든 회사 프로젝트에서 유효한 API 키를 사용하십시오.\n{% /html %}\n\n * **회사 설정 > API 키**\n * **프로젝트 설정 > API 키**\n* `project_id`는 다음과 같이 표시됩니다.\n * 프로젝트 이름 옆의 관리자 페이지에 있습니다.\n * 브라우저 주소 표시줄의 URL에서 관리자 페이지의 프로젝트 작업 시 URL의 형식은 \n `https://publisher.xsolla.com//projects/`입니다.\n\nAPI 키 작업에 대한 자세한 정보는 [API 레퍼런스](https://developers.xsolla.com/ko/api/getting-started/#api_keys_overview)를 참조하세요.", "scheme": "basic", "type": "http" }, "basicMerchantAuth": { "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 * **회사 설정 > 회사** 섹션에서\n * 관리자 페이지의 브라우저 주소 표시줄에 있는 URL에 있습니다. URL의 형식은 \n `https://publisher.xsolla.com/`입니다.\n* `api_key`는 관리자 페이지가 생성될 때 한 번만 표시되며 사용자 측에 저장해야 합니다. 새 키는 [회사 설정 > API 키](https://publisher.xsolla.com/0/settings/api_key) 섹션에서 만들 수 있습니다.\n\nAPI 키 작업에 대한 자세한 정보는 [API 레퍼런스](https://developers.xsolla.com/ko/api/getting-started/#api_keys_overview)를 참조하세요.", "scheme": "basic", "type": "http" } } }, "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. You can try this call using the following test token:\n```\neyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHAiOjE5NjIyMzQwNDgsImlzcyI6Imh0dHBzOi8vbG9naW4ueHNvbGxhLmNvbSIsImlhdCI6MTU2MjE0NzY0OCwidXNlcm5hbWUiOiJ4c29sbGEiLCJ4c29sbGFfbG9naW5fYWNjZXNzX2tleSI6IjA2SWF2ZHpDeEVHbm5aMTlpLUc5TmMxVWFfTWFZOXhTR3ZEVEY4OFE3RnMiLCJzdWIiOiJkMzQyZGFkMi05ZDU5LTExZTktYTM4NC00MjAxMGFhODAwM2YiLCJlbWFpbCI6InN1cHBvcnRAeHNvbGxhLmNvbSIsInR5cGUiOiJ4c29sbGFfbG9naW4iLCJ4c29sbGFfbG9naW5fcHJvamVjdF9pZCI6ImU2ZGZhYWM2LTc4YTgtMTFlOS05MjQ0LTQyMDEwYWE4MDAwNCIsInB1Ymxpc2hlcl9pZCI6MTU5MjR9.GCrW42OguZbLZTaoixCZgAeNLGH2xCeJHxl8u8Xn2aI\n```\nAlternatively, you can use a [token for opening the payment UI](/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\nThe `AuthForCart` authentication scheme is used for cart purchases and supports two modes:\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. You can try this call using the following test token:\n```\neyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHAiOjE5NjIyMzQwNDgsImlzcyI6Imh0dHBzOi8vbG9naW4ueHNvbGxhLmNvbSIsImlhdCI6MTU2MjE0NzY0OCwidXNlcm5hbWUiOiJ4c29sbGEiLCJ4c29sbGFfbG9naW5fYWNjZXNzX2tleSI6IjA2SWF2ZHpDeEVHbm5aMTlpLUc5TmMxVWFfTWFZOXhTR3ZEVEY4OFE3RnMiLCJzdWIiOiJkMzQyZGFkMi05ZDU5LTExZTktYTM4NC00MjAxMGFhODAwM2YiLCJlbWFpbCI6InN1cHBvcnRAeHNvbGxhLmNvbSIsInR5cGUiOiJ4c29sbGFfbG9naW4iLCJ4c29sbGFfbG9naW5fcHJvamVjdF9pZCI6ImU2ZGZhYWM2LTc4YTgtMTFlOS05MjQ0LTQyMDEwYWE4MDAwNCIsInB1Ymxpc2hlcl9pZCI6MTU5MjR9.GCrW42OguZbLZTaoixCZgAeNLGH2xCeJHxl8u8Xn2aI\n```\nAlternatively, you can use a [token for opening the payment UI](/ko/api/pay-station/token/create-token).\n\n2. **Simplified mode without Authorization header.** This mode is used only for unauthorized users and can be applied only for [game key sales](/ko/doc/buy-button/how-to/set-up-authentication/#guides_buy_button_selling_items_not_authenticated_users). Instead of a token, the request must include the following headers:\n - `x-unauthorized-id` with a request ID\n - `x-user` with the user's email address encoded in Base64\n\n## Useful links\n\n- [API calls by interaction model](https://developers.xsolla.com/ko/api/catalog/)\n- [Endpoint types](https://developers.xsolla.com/ko/api/catalog/)\n- [Errors handling](https://developers.xsolla.com/ko/api/catalog/)\n- [API keys](https://developers.xsolla.com/ko/api/catalog/)\n\n# Core entity structure\n\nItems of all types (virtual items, bundles, virtual currency, and keys) use a similar data structure. Understanding the basic structure simplifies working with the API and helps you navigate the documentation more easily.\n\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# 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\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` — payment 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# 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.", "title": "Catalog API", "version": "2.0.0" }, "openapi": "3.1.0", "paths": { "/v1/admin/projects/{project_id}/connectors/import_items/import/status": { "get": { "description": "프로젝트로 아이템을 가져오는 진행률에 대한 정보를 검색합니다. 이 API 호출은 API 또는 관리자 페이지 API를 통해 수행된 마지막 가져오기에 대한 데이터를 검색합니다.", "operationId": "get-items-import-status", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" } ], "responses": { "200": { "$ref": "#/components/responses/200-items-import-status-model" }, "401": { "$ref": "#/components/responses/401-invalid-basic-auth" } }, "security": [ { "basicAuth": [] } ], "servers": [ { "url": "https://connector.xsolla.com" } ], "summary": "아이템 가져오기 상태 검색", "tags": [ "connector-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v1/projects/{project_id}/import/from_external_file": { "post": { "description": "지정된 URL을 통해 JSON 파일에서 스토어로 아이템을 가져옵니다. JSON 파일에서 가져오기에 대한 자세한 정보는 [설명서](https://developers.xsolla.com/ko/doc/shop-builder/how-to/json-import/)를 참조하세요.", "operationId": "import-items-from-external-file", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" } ], "requestBody": { "$ref": "#/components/requestBodies/connector-import-items-body" }, "responses": { "201": { "content": { "application/json": { "schema": { "properties": { "import_id": { "description": "가져오기 작업 ID입니다. JSON 파일을 가져오는 데 문제가 있는 경우, 이 ID를 고객 성공 관리자에게 보고하거나 csm@Xsolla.com으로 이메일을 보내십시오.", "example": "af9f3638a16e11ef880da2cd677d2d24", "type": "string" } }, "type": "object" } } }, "description": "파일을 성공적으로 가져와서 처리 중입니다." }, "401": { "$ref": "#/components/responses/401-invalid-basic-auth" }, "422": { "$ref": "#/components/responses/connector-422-validation-failed" } }, "security": [ { "basicAuth": [] } ], "servers": [ { "url": "https://connector.xsolla.com" } ], "summary": "JSON 파일을 통해 아이템 가져오기", "tags": [ "connector-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v2/admin/project/{project_id}/cart/fill": { "put": { "description": "현재 장바구니를 아이템으로 채웁니다. 장바구니에 동일한 SKU를 가진 아이템이 이미 있으면 기존 아이템이 전달된 값으로 교체됩니다.", "operationId": "admin-cart-fill", "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" } ], "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" } }, "security": [ { "basicAuth": [] } ], "summary": "아이템으로 장바구니 채우기", "tags": [ "cart-server-side" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" } ] } }, "/v2/admin/project/{project_id}/cart/{cart_id}/fill": { "put": { "description": "장바구니 ID별로 장바구니를 아이템으로 채웁니다. 장바구니에 동일한 SKU를 가진 아이템이 이미 있으면 기존 아이템이 전달된 값으로 교체됩니다.", "operationId": "admin-fill-cart-by-id", "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" } ], "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" } }, "security": [ { "basicAuth": [] } ], "summary": "장바구니 ID를 사용하는 장바구니 아이템으로 채우기", "tags": [ "cart-server-side" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" } ] } }, "/v2/merchant/{merchant_id}/projects": { "get": { "description": "판매자의 프로젝트 목록을 가져옵니다.\n\n
\n

참고

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

\n
", "operationId": "get-projects", "parameters": [ { "$ref": "#/components/parameters/limit-query-param" }, { "$ref": "#/components/parameters/offset-query-param" }, { "$ref": "#/components/parameters/merchant_id-path-param" } ], "responses": { "200": { "content": { "application/json": { "examples": { "response": { "value": { "has_more": false, "items": [ { "project_id": 17558 }, { "project_id": 17559 } ], "total_items_count": 2 } } }, "schema": { "properties": { "has_more": { "example": true, "type": "boolean" }, "items": { "properties": { "project_id": { "example": 17558, "type": "integer" } }, "type": "array" }, "total_items_count": { "example": 3, "type": "integer" } }, "type": "object" } } }, "description": "프로젝트 정보를 성공적으로 수신했습니다." }, "401": { "description": "기본 인증이 전달되지 않았거나 잘못되었습니다. 기본 인증 또는 올바른 자격 증명을 사용했는지 확인해야 합니다." }, "422": { "description": "잘못된 `limit` 또는 `offset` 쿼리 매개 변수입니다." } }, "security": [ { "basicMerchantAuth": [] } ], "summary": "프로젝트 가져오기", "tags": [ "common-merchant" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v2/project/{project_id}/admin/attribute": { "get": { "description": "관리 대상 프로젝트에서 특성 목록을 가져옵니다.", "operationId": "admin-get-attribute-list", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/limit-query-param" }, { "$ref": "#/components/parameters/offset-query-param" } ], "responses": { "200": { "$ref": "#/components/responses/200-admin-get-attribute-list-response" }, "401": { "$ref": "#/components/responses/401-invalid-basic-auth" } }, "security": [ { "basicAuth": [] } ], "summary": "특성 목록 가져오기(관리자)", "tags": [ "attribute-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] }, "post": { "description": "특성을 생성합니다.", "operationId": "admin-create-attribute", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" } ], "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" } }, "security": [ { "basicAuth": [] } ], "summary": "특성 생성하기", "tags": [ "attribute-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v2/project/{project_id}/admin/attribute/{external_id}": { "delete": { "description": "특성을 삭제합니다.\n
참고

아이템 특성을 삭제하면 해당 아이템의 모든 데이터와 아이템 연결을 잃게 됩니다.
", "operationId": "delete-attribute", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/external_id-attr-path-param" } ], "responses": { "204": { "description": "특성을 성공적으로 삭제했습니다." }, "401": { "$ref": "#/components/responses/401-invalid-basic-auth" } }, "security": [ { "basicAuth": [] } ], "summary": "특성 삭제", "tags": [ "attribute-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] }, "get": { "description": "지정된 특성을 가져옵니다.", "operationId": "admin-get-attribute", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/external_id-attr-path-param" } ], "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" } }, "security": [ { "basicAuth": [] } ], "summary": "지정된 특성 가져오기", "tags": [ "attribute-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] }, "put": { "description": "특성을 업데이트합니다.", "operationId": "admin-update-attribute", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/external_id-attr-path-param" } ], "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" } }, "security": [ { "basicAuth": [] } ], "summary": "특성 업데이트", "tags": [ "attribute-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v2/project/{project_id}/admin/attribute/{external_id}/value": { "delete": { "description": "특성의 모든 값을 삭제합니다.\n
참고

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

모든 프로젝트는 특성 값의 수를 제한합니다. 기본값과 최대값은 특성당 20개입니다.
", "operationId": "admin-create-attribute-value", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/external_id-attr-path-param" } ], "requestBody": { "$ref": "#/components/requestBodies/create-update-attribute-value" }, "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" } }, "security": [ { "basicAuth": [] } ], "summary": "특성 값 생성하기", "tags": [ "attribute-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v2/project/{project_id}/admin/attribute/{external_id}/value/{value_external_id}": { "delete": { "description": "특성 값을 삭제합니다.\n
참고

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

DRM Free 플랫폼용 게임 코드 또는 게임에만 권한을 부여할 수 있습니다.
", "operationId": "grant-entitlement-admin", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" } ], "requestBody": { "content": { "application/json": { "schema": { "example": { "code": "AAAA-BBBB-CCCC-DDDD", "drm": { "sku": "com.xsolla.key_1" }, "game": { "sku": "com.xsolla.game_1" }, "mode": "default", "user_country": "US", "user_external_id": "user-external-id" }, "properties": { "code": { "description": "게임의 게임 코드입니다.", "example": "AAAA-BBBB-CCCC-DDDD", "type": [ "string", "null" ] }, "drm": { "description": "DRM 특성이 있는 개체입니다.", "example": { "drm": { "sku": "com.xsolla.key_1" } }, "properties": { "sku": { "$ref": "#/components/schemas/Game-Keys_drm_sku" } }, "required": [ "sku" ], "type": "object" }, "game": { "description": "게임 특성이 있는 개체입니다.", "example": { "game": { "sku": "com.xsolla.game_1" } }, "properties": { "sku": { "$ref": "#/components/schemas/Game-Keys_game_sku" } }, "required": [ "sku" ], "type": "object" }, "mode": { "description": "부여해야 하는 권한 유형입니다. 매개 변수를 `sandbox`로 설정하면 샌드박스 모드의 사용자에게 권한이 부여됩니다. 매개 변수를 `default`로 설정하면 라이브 모드의 사용자에게 권한이 부여됩니다.", "enum": [ "default", "sandbox" ], "example": "default", "type": "string" }, "user_country": { "description": "사용자의 국가입니다.", "example": "US", "type": [ "string", "null" ] }, "user_external_id": { "description": "고유 사용자 식별자입니다.", "example": "user-external-id", "type": "string" } }, "required": [ "user_external_id", "game", "drm", "mode" ], "type": "object" } } }, "required": true }, "responses": { "200": { "description": "권한이 부여되었습니다." }, "403": { "$ref": "#/components/responses/Game-Keys_403-auth-header-not-sent" }, "404": { "content": { "application/json": { "examples": { "Game code not found": { "$ref": "#/components/examples/404-game-code-not-found" }, "Game not found": { "value": { "errorCode": 4604, "errorMessage": "[0401-4604]: Game not found.", "statusCode": 404, "transactionId": "transaction id" } } }, "schema": { "properties": { "errorCode": { "example": 4603, "type": "integer" }, "errorMessage": { "example": "[0401-4603]: Game code not found.", "type": "string" }, "statusCode": { "example": 404, "type": "integer" }, "transactionId": { "example": "x-x-x-x-transactionId-mock-x-x-x", "type": "string" } }, "type": "object" } } }, "description": "게임 코드를 찾을 수 없습니다. `code`와 `project_id`가 올바른지 확인합니다." }, "422": { "content": { "application/json": { "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" } }, "schema": { "properties": { "errorCode": { "example": 5103, "type": "integer" }, "errorMessage": { "example": "[0401-5103]: Selected drm is not drmfree.", "type": "string" }, "statusCode": { "example": 422, "type": "integer" }, "transactionId": { "example": "x-x-x-x-transactionId-mock-x-x-x", "type": "string" } }, "type": "object" } } }, "description": "잘못된 요청입니다." } }, "security": [ { "basicAuth": [] } ], "summary": "권한 부여(관리자)", "tags": [ "game-keys-entitlement" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v2/project/{project_id}/admin/entitlement/revoke": { "post": { "description": "사용자의 권한을 취소합니다.\n\n
주의

DRM Free 플랫폼용 게임 코드 또는 게임만 취소할 수 있습니다.
", "operationId": "revoke-entitlement-admin", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" } ], "requestBody": { "content": { "application/json": { "schema": { "example": { "drm": { "sku": "com.xsolla.key_1" }, "game": { "sku": "com.xsolla.game_1" }, "mode": "default", "user_external_id": "user-external-id" }, "properties": { "drm": { "description": "DRM 특성이 있는 개체입니다.", "example": { "drm": { "sku": "com.xsolla.key_1" } }, "properties": { "sku": { "$ref": "#/components/schemas/Game-Keys_drm_sku" } }, "required": [ "sku" ], "type": "object" }, "game": { "description": "게임 특성이 있는 개체입니다.", "example": { "game": { "sku": "com.xsolla.game_1" } }, "properties": { "sku": { "$ref": "#/components/schemas/Game-Keys_game_sku" } }, "required": [ "sku" ], "type": "object" }, "mode": { "description": "취소해야 하는 권한 유형입니다. 매개 변수를 `sandbox`로 설정하면 샌드박스 모드의 사용자 권한이 취소됩니다. 매개 변수를 `default`로 설정하면 라이브 모드의 사용자 권한이 취소됩니다.", "enum": [ "default", "sandbox" ], "example": "default", "type": "string" }, "user_external_id": { "description": "고유 사용자 식별자입니다.", "example": "user-external-id", "type": "string" } }, "required": [ "user_external_id", "game", "drm", "mode" ], "type": "object" } } }, "required": true }, "responses": { "204": { "description": "성공적으로 취소했습니다." }, "403": { "$ref": "#/components/responses/Game-Keys_403-auth-header-not-sent" }, "422": { "content": { "application/json": { "examples": { "DRM is not DRM free": { "value": { "errorCode": 5103, "errorMessage": "[0401-5103]: Selected drm is not drmfree.", "statusCode": 422, "transactionId": "transaction id" } } }, "schema": { "properties": { "errorCode": { "example": 5103, "type": "integer" }, "errorMessage": { "example": "[0401-5103]: Selected drm is not drmfree.", "type": "string" }, "statusCode": { "example": 422, "type": "integer" }, "transactionId": { "example": "x-x-x-x-transactionId-mock-x-x-x", "type": "string" } }, "type": "object" } } }, "description": "잘못된 요청입니다." } }, "security": [ { "basicAuth": [] } ], "summary": "권한 취소(관리자)", "tags": [ "game-keys-entitlement" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v2/project/{project_id}/admin/group/id/{id}/order/item": { "put": { "description": "Sets the display order of items within a group identified by its internal numeric ID. Pass an array of items with their new order values.", "operationId": "admin-reorder-items-in-group-by-id", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/id-group-path-param" } ], "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" } }, "security": [ { "basicAuth": [] } ], "summary": "Reorder items within a group (by ID)", "tags": [ "item-groups-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v2/project/{project_id}/admin/group/order": { "put": { "description": "Sets the display order for item groups within a project. Pass an array of groups with their new order values.", "operationId": "admin-reorder-item-groups", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" } ], "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" } }, "security": [ { "basicAuth": [] } ], "summary": "Reorder item groups", "tags": [ "item-groups-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v2/project/{project_id}/admin/group/{external_id}/order/item": { "put": { "description": "Sets the display order of items within a group identified by its external ID. Pass an array of items with their new order values.", "operationId": "admin-reorder-items-in-group", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/external_id-group-path-param" } ], "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" } }, "security": [ { "basicAuth": [] } ], "summary": "Reorder items within a group (by external ID)", "tags": [ "item-groups-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v2/project/{project_id}/admin/items/bundle": { "get": { "description": "관리를 위해 프로젝트 내부의 번들 목록을 가져옵니다.\n\n
참고

스토어 카탈로그를 빌드하기 위해 이 엔드포인트를 사용해선 안 됩니다.
", "operationId": "admin-get-bundle-list", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/limit-query-param" }, { "$ref": "#/components/parameters/offset-query-param" } ], "responses": { "200": { "$ref": "#/components/responses/Bundles_200-admin-get-bundle-list" }, "401": { "$ref": "#/components/responses/Bundles_401-invalid-basic-auth" } }, "security": [ { "basicAuth": [] } ], "summary": "번들 목록 가져오기", "tags": [ "bundles-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] }, "post": { "description": "번들을 생성합니다.", "operationId": "admin-create-bundle", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" } ], "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" } }, "security": [ { "basicAuth": [] } ], "summary": "번들 생성하기", "tags": [ "bundles-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v2/project/{project_id}/admin/items/bundle/group/external_id/{external_id}": { "get": { "description": "관리를 위해 그룹 내부의 번들 목록을 가져옵니다.\n\n
참고

스토어 카탈로그를 빌드하기 위해 이 엔드포인트를 사용해선 안 됩니다.
", "operationId": "admin-get-bundle-list-in-group-by-external-id", "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" } ], "responses": { "200": { "$ref": "#/components/responses/Bundles_200-admin-get-bundle-list-in-group" }, "401": { "$ref": "#/components/responses/Bundles_401-invalid-basic-auth" } }, "security": [ { "basicAuth": [] } ], "summary": "지정한 그룹 외부 ID로 번들 목록 가져오기", "tags": [ "bundles-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v2/project/{project_id}/admin/items/bundle/group/id/{group_id}": { "get": { "description": "관리를 위해 그룹 내부의 번들 목록을 가져옵니다.\n\n
참고

스토어 카탈로그를 빌드하기 위해 이 엔드포인트를 사용해선 안 됩니다.
", "operationId": "admin-get-bundle-list-in-group-by-id", "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" } ], "responses": { "200": { "$ref": "#/components/responses/Bundles_200-admin-get-bundle-list-in-group" }, "401": { "$ref": "#/components/responses/Bundles_401-invalid-basic-auth" } }, "security": [ { "basicAuth": [] } ], "summary": "지정한 그룹 ID로 번들 목록 가져오기", "tags": [ "bundles-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v2/project/{project_id}/admin/items/bundle/sku/{sku}": { "delete": { "description": "번들을 삭제합니다.", "operationId": "admin-delete-bundle", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/sku-path-param" } ], "responses": { "204": { "$ref": "#/components/responses/Bundles_204-admin-delete-bundle" }, "401": { "$ref": "#/components/responses/Bundles_401-invalid-basic-auth" } }, "security": [ { "basicAuth": [] } ], "summary": "번들 삭제", "tags": [ "bundles-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] }, "get": { "description": "관리를 위해 프로젝트 내부의 번들을 가져옵니다.\n\n
참고

스토어 카탈로그를 빌드하기 위해 이 엔드포인트를 사용해선 안 됩니다.
", "operationId": "admin-get-bundle", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/sku-path-param" } ], "responses": { "200": { "$ref": "#/components/responses/Bundles_200-admin-get-bundle" }, "401": { "$ref": "#/components/responses/Bundles_401-invalid-basic-auth" } }, "security": [ { "basicAuth": [] } ], "summary": "번들 가져오기", "tags": [ "bundles-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] }, "put": { "description": "번들을 업데이트합니다.", "operationId": "admin-update-bundle", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/sku-path-param" } ], "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" } }, "security": [ { "basicAuth": [] } ], "summary": "번들 업데이트", "tags": [ "bundles-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v2/project/{project_id}/admin/items/bundle/sku/{sku}/hide": { "put": { "description": "카탈로그에서 번들을 숨깁니다.", "operationId": "admin-hide-bundle", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/sku-path-param" } ], "responses": { "204": { "$ref": "#/components/responses/Bundles_204-admin-hide-bundle" }, "401": { "$ref": "#/components/responses/Bundles_401-invalid-basic-auth" } }, "security": [ { "basicAuth": [] } ], "summary": "카탈로그에서 번들 숨기기", "tags": [ "bundles-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v2/project/{project_id}/admin/items/bundle/sku/{sku}/show": { "put": { "description": "카탈로그에 번들을 표시합니다.", "operationId": "admin-show-bundle", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/sku-path-param" } ], "responses": { "204": { "$ref": "#/components/responses/Bundles_204-admin-show-bundle" }, "401": { "$ref": "#/components/responses/Bundles_401-invalid-basic-auth" } }, "security": [ { "basicAuth": [] } ], "summary": "카탈로그에 번들 표시", "tags": [ "bundles-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v2/project/{project_id}/admin/items/game": { "get": { "description": "관리를 위해 프로젝트 내부의 게임 목록을 가져옵니다.\n게임은 사용자가 구매할 수 있는 게임 키로 구성되어 있습니다.\n\n
참고

스토어 카탈로그를 빌드하기 위해 이 엔드포인트를 사용해선 안 됩니다.
", "operationId": "admin-get-game-list", "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" } ], "responses": { "200": { "$ref": "#/components/responses/Game-Keys_200-admin-get-games-list" }, "401": { "$ref": "#/components/responses/Game-Keys_401-invalid-basic-auth" } }, "security": [ { "basicAuth": [] } ], "summary": "게임 목록 가져오기(관리자)", "tags": [ "game-keys-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] }, "post": { "description": "프로젝트에서 게임을 생성합니다.", "operationId": "admin-create-game", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" } ], "requestBody": { "$ref": "#/components/requestBodies/Game-Keys_create-update-game-model" }, "responses": { "201": { "content": { "application/json": { "examples": { "response": { "value": { "item_id": 101, "sku": "com.xsolla.game_1" } } }, "schema": { "properties": { "item_id": { "example": 101, "type": "integer" }, "sku": { "example": "com.xsolla.game_1", "type": "string" } }, "type": "object" } } }, "description": "게임을 성공적으로 생성했습니다." }, "401": { "$ref": "#/components/responses/Game-Keys_401-invalid-basic-auth" }, "422": { "$ref": "#/components/responses/Game-Keys_422-invalid-request" } }, "security": [ { "basicAuth": [] } ], "summary": "게임 생성하기", "tags": [ "game-keys-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v2/project/{project_id}/admin/items/game/id/{item_id}": { "delete": { "description": "ID로 프로젝트의 게임을 삭제합니다.", "operationId": "admin-delete-game-by-id", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/item_id-path-param" } ], "responses": { "204": { "description": "게임을 성공적으로 삭제했습니다." }, "401": { "$ref": "#/components/responses/Game-Keys_401-invalid-basic-auth" } }, "security": [ { "basicAuth": [] } ], "summary": "ID로 게임 삭제", "tags": [ "game-keys-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] }, "get": { "description": "관리를 위해 게임을 가져옵니다.\n게임은 사용자가 구매할 수 있는 게임 키로 구성되어 있습니다.\n\n
참고

스토어 카탈로그를 빌드하기 위해 이 엔드포인트를 사용해선 안 됩니다.
", "operationId": "admin-get-game-by-id", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/item_id-path-param" }, { "$ref": "#/components/parameters/promo_code-query-param" } ], "responses": { "200": { "$ref": "#/components/responses/Game-Keys_200-admin-get-game-by-sku" }, "401": { "$ref": "#/components/responses/Game-Keys_401-invalid-basic-auth" }, "404": { "content": { "application/json": { "examples": { "response": { "value": { "errorCode": 4001, "errorMessage": "[0401-4001]: Item with id = 1 not found", "statusCode": 404 } } }, "schema": { "properties": { "errorCode": { "example": 4001, "type": "integer" }, "errorMessage": { "example": "[0401-4001]: Item with id = 1 not found", "type": "string" }, "statusCode": { "example": 404, "type": "integer" } }, "type": "object" } } }, "description": "게임을 찾을 수 없습니다." } }, "security": [ { "basicAuth": [] } ], "summary": "ID로 게임 가져오기(관리자)", "tags": [ "game-keys-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] }, "put": { "description": "프로젝트의 게임을 ID로 업데이트합니다.", "operationId": "admin-update-game-by-id", "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": { "content": { "application/json": { "examples": { "response": { "value": { "errorCode": 4001, "errorMessage": "[0401-4001]: Item with id = 1 not found", "statusCode": 404 } } }, "schema": { "properties": { "errorCode": { "example": 4001, "type": "integer" }, "errorMessage": { "example": "[0401-4001]: Item with id = 1 not found", "type": "string" }, "statusCode": { "example": 404, "type": "integer" } }, "type": "object" } } }, "description": "게임을 찾을 수 없습니다." }, "422": { "$ref": "#/components/responses/Game-Keys_422-invalid-request" } }, "security": [ { "basicAuth": [] } ], "summary": "ID로 게임 업데이트", "tags": [ "game-keys-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v2/project/{project_id}/admin/items/game/key/delete/id/{item_id}": { "delete": { "description": "게임 키 ID로 모든 코드를 삭제합니다.", "operationId": "admin-delete-codes-by-id", "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": { "content": { "application/json": { "examples": { "response": { "value": { "errorCode": 4001, "errorMessage": "[0401-4001]: Item with sku = 'game_1' not found", "statusCode": 404 } } }, "schema": { "properties": { "errorCode": { "example": 4001, "type": "integer" }, "errorMessage": { "example": "[0401-4001]: Item with sku = 'game_1' not found", "type": "string" }, "statusCode": { "example": 404, "type": "integer" } }, "type": "object" } } }, "description": "게임 키 또는 지역을 찾을 수 없습니다." } }, "security": [ { "basicAuth": [] } ], "summary": "ID로 코드 삭제하기", "tags": [ "game-keys-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v2/project/{project_id}/admin/items/game/key/delete/sku/{item_sku}": { "delete": { "description": "게임 키 SKU로 모든 코드를 삭제합니다.", "operationId": "admin-delete-codes-by-sku", "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": { "content": { "application/json": { "examples": { "response": { "value": { "errorCode": 4001, "errorMessage": "[0401-4001]: Item with sku = 'game_1' not found", "statusCode": 404 } } }, "schema": { "properties": { "errorCode": { "example": 4001, "type": "integer" }, "errorMessage": { "example": "[0401-4001]: Item with sku = 'game_1' not found", "type": "string" }, "statusCode": { "example": 404, "type": "integer" } }, "type": "object" } } }, "description": "게임 키 또는 지역을 찾을 수 없습니다." } }, "security": [ { "basicAuth": [] } ], "summary": "코드 삭제하기", "tags": [ "game-keys-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v2/project/{project_id}/admin/items/game/key/request/id/{item_id}": { "get": { "description": "게임 키 ID로 특정 수의 코드를 가져옵니다.", "operationId": "admin-get-codes-by-id", "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": { "content": { "application/json": { "examples": { "response": { "value": { "errorCode": 4001, "errorMessage": "[0401-4001]: Item with sku = 'game_1' not found", "statusCode": 404 } } }, "schema": { "properties": { "errorCode": { "example": 4001, "type": "integer" }, "errorMessage": { "example": "[0401-4001]: Item with sku = 'game_1' not found", "type": "string" }, "statusCode": { "example": 404, "type": "integer" } }, "type": "object" } } }, "description": "게임 키 또는 지역을 찾을 수 없습니다." } }, "security": [ { "basicAuth": [] } ], "summary": "ID로 코드 가져오기", "tags": [ "game-keys-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v2/project/{project_id}/admin/items/game/key/request/sku/{item_sku}": { "get": { "description": "게임 키 SKU로 특정 수의 코드를 가져옵니다.", "operationId": "admin-get-codes-by-sku", "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": { "content": { "application/json": { "examples": { "response": { "value": { "errorCode": 4001, "errorMessage": "[0401-4001]: Item with sku = 'game_1' not found", "statusCode": 404 } } }, "schema": { "properties": { "errorCode": { "example": 4001, "type": "integer" }, "errorMessage": { "example": "[0401-4001]: Item with sku = 'game_1' not found", "type": "string" }, "statusCode": { "example": 404, "type": "integer" } }, "type": "object" } } }, "description": "게임 키 또는 지역을 찾을 수 없습니다." } }, "security": [ { "basicAuth": [] } ], "summary": "코드 가져오기", "tags": [ "game-keys-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v2/project/{project_id}/admin/items/game/key/upload/id/{item_id}": { "post": { "description": "게임 키 ID로 코드를 업로드합니다.", "operationId": "admin-upload-codes-by-id", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/item_id-path-param" } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "example": { "file": "keys.txt", "region_id": 1 }, "properties": { "file": { "description": "코드가 있는 파일입니다.", "format": "binary", "type": "string" }, "region_id": { "description": "지역 ID입니다.", "type": "integer" } }, "required": [ "file" ], "type": "object" } } } }, "responses": { "200": { "$ref": "#/components/responses/Game-Keys_200-session-information" }, "401": { "$ref": "#/components/responses/Game-Keys_401-invalid-basic-auth" }, "404": { "content": { "application/json": { "examples": { "response": { "value": { "errorCode": 4001, "errorMessage": "[0401-4001]: Item with sku = 'game_1' not found", "statusCode": 404 } } }, "schema": { "properties": { "errorCode": { "example": 4001, "type": "integer" }, "errorMessage": { "example": "[0401-4001]: Item with sku = 'game_1' not found", "type": "string" }, "statusCode": { "example": 404, "type": "integer" } }, "type": "object" } } }, "description": "게임 키 또는 지역을 찾을 수 없습니다." } }, "security": [ { "basicAuth": [] } ], "summary": "ID로 코드 업로드", "tags": [ "game-keys-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v2/project/{project_id}/admin/items/game/key/upload/session/{session_id}": { "get": { "description": "세션 정보를 로드하는 코드를 가져옵니다.", "operationId": "admin-get-codes-session", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "description": "세션 ID입니다.", "in": "path", "name": "session_id", "required": true, "schema": { "default": "fc7105b6e8ee01339582970b37697242", "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Game-Keys_200-session-information" }, "401": { "$ref": "#/components/responses/Game-Keys_401-invalid-basic-auth" }, "404": { "description": "코드 로드 세션을 찾을 수 없습니다." } }, "security": [ { "basicAuth": [] } ], "summary": "세션 정보를 로드하는 코드 가져오기", "tags": [ "game-keys-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v2/project/{project_id}/admin/items/game/key/upload/sku/{item_sku}": { "post": { "description": "게임 키 SKU로 코드를 업로드합니다.", "operationId": "admin-upload-codes-by-sku", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/item_sku-path-param" } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "example": { "file": "keys.txt", "region_id": 1 }, "properties": { "file": { "description": "코드가 있는 파일입니다.", "format": "binary", "type": "string" }, "region_id": { "description": "지역 ID입니다.", "type": "integer" } }, "required": [ "file" ], "type": "object" } } }, "required": true }, "responses": { "200": { "$ref": "#/components/responses/Game-Keys_200-session-information" }, "401": { "$ref": "#/components/responses/Game-Keys_401-invalid-basic-auth" }, "404": { "content": { "application/json": { "examples": { "response": { "value": { "errorCode": 4001, "errorMessage": "[0401-4001]: Item with sku = 'game_1' not found", "statusCode": 404 } } }, "schema": { "properties": { "errorCode": { "example": 4001, "type": "integer" }, "errorMessage": { "example": "[0401-4001]: Item with sku = 'game_1' not found", "type": "string" }, "statusCode": { "example": 404, "type": "integer" } }, "type": "object" } } }, "description": "게임 키 또는 지역을 찾을 수 없습니다." } }, "security": [ { "basicAuth": [] } ], "summary": "코드 업로드", "tags": [ "game-keys-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v2/project/{project_id}/admin/items/game/sku/{item_sku}": { "delete": { "description": "SKU로 프로젝트에 있는 게임을 삭제합니다.", "operationId": "admin-delete-game-by-sku", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/item_sku-path-param" } ], "responses": { "204": { "description": "게임을 성공적으로 삭제했습니다." }, "401": { "$ref": "#/components/responses/Game-Keys_401-invalid-basic-auth" } }, "security": [ { "basicAuth": [] } ], "summary": "SKU로 게임 삭제", "tags": [ "game-keys-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] }, "get": { "description": "관리를 위해 게임을 가져옵니다.\n게임은 사용자가 구매할 수 있는 게임 키로 구성되어 있습니다.\n\n
참고

스토어 카탈로그를 빌드하기 위해 이 엔드포인트를 사용해선 안 됩니다.
", "operationId": "admin-get-game-by-sku", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/item_sku-path-param" }, { "$ref": "#/components/parameters/promo_code-query-param" } ], "responses": { "200": { "$ref": "#/components/responses/Game-Keys_200-admin-get-game-by-sku" }, "401": { "$ref": "#/components/responses/Game-Keys_401-invalid-basic-auth" }, "404": { "content": { "application/json": { "examples": { "response": { "value": { "errorCode": 4001, "errorMessage": "[0401-4001]: Item with sku = 'game_1' not found", "statusCode": 404 } } }, "schema": { "properties": { "errorCode": { "example": 4001, "type": "integer" }, "errorMessage": { "example": "[0401-4001]: Item with sku = 'game_1' not found", "type": "string" }, "statusCode": { "example": 404, "type": "integer" } }, "type": "object" } } }, "description": "게임을 찾을 수 없습니다." } }, "security": [ { "basicAuth": [] } ], "summary": "게임 가져오기(관리자)", "tags": [ "game-keys-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] }, "put": { "description": "SKU로 프로젝트에 있는 게임을 업데이트합니다.", "operationId": "admin-update-game-by-sku", "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": { "content": { "application/json": { "examples": { "response": { "value": { "errorCode": 4001, "errorMessage": "[0401-4001]: Item with sku = 'game_1' not found", "statusCode": 404 } } }, "schema": { "properties": { "errorCode": { "example": 4001, "type": "integer" }, "errorMessage": { "example": "[0401-4001]: Item with sku = 'game_1' not found", "type": "string" }, "statusCode": { "example": 404, "type": "integer" } }, "type": "object" } } }, "description": "게임을 찾을 수 없습니다." }, "422": { "$ref": "#/components/responses/Game-Keys_422-invalid-request" } }, "security": [ { "basicAuth": [] } ], "summary": "SKU로 게임 업데이트", "tags": [ "game-keys-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v2/project/{project_id}/admin/items/groups": { "get": { "description": "Retrieves the full list of item groups within a project without pagination. For administrative purposes.\n
Note

Do not use this endpoint for building a store catalog. Use the Get item group list client-side endpoint instead.
", "operationId": "admin-get-item-group-list", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" } ], "responses": { "200": { "$ref": "#/components/responses/ItemGroup_200-admin-get-group-list" }, "401": { "$ref": "#/components/responses/ItemGroup_401-invalid-basic-auth" } }, "security": [ { "basicAuth": [] } ], "summary": "아이템 그룹 목록 가져오기", "tags": [ "item-groups-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] }, "post": { "description": "Creates an item group within a project.\nTo retrieve item groups for building a catalog, use the Get item group list client-side endpoint.", "operationId": "admin-create-item-group", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" } ], "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" } }, "security": [ { "basicAuth": [] } ], "summary": "Create item group", "tags": [ "item-groups-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v2/project/{project_id}/admin/items/groups/{external_id}": { "delete": { "description": "Deletes an item group by its external ID.", "operationId": "admin-delete-item-group", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/external_id-group-path-param" } ], "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" } }, "security": [ { "basicAuth": [] } ], "summary": "Delete item group", "tags": [ "item-groups-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] }, "get": { "description": "Retrieves an item group by its external ID for administrative purposes.\n
Note

Do not use this endpoint for building a store catalog. Use the Get item group list client-side endpoint instead.
", "operationId": "admin-get-item-group", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/external_id-group-path-param" } ], "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" } }, "security": [ { "basicAuth": [] } ], "summary": "Get item group by external ID", "tags": [ "item-groups-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] }, "put": { "description": "Updates an item group by its external ID.", "operationId": "admin-update-item-group", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/external_id-group-path-param" } ], "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" } }, "security": [ { "basicAuth": [] } ], "summary": "Update item group", "tags": [ "item-groups-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v2/project/{project_id}/admin/items/pre_order/limit/item/sku/{item_sku}": { "delete": { "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}", "operationId": "remove-pre-order-limit", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/item_sku-path-param" } ], "requestBody": { "content": { "application/json": { "example": { "quantity": 100000 }, "schema": { "properties": { "quantity": { "description": "제거할 수량입니다.", "type": "integer" } }, "required": [ "quantity" ], "type": "object" } } } }, "responses": { "204": { "description": "제한한 수량 설정을 성공적으로 제거했습니다." }, "401": { "$ref": "#/components/responses/Common_401-invalid-basic-auth" }, "404": { "description": "아이템을 찾을 수 없습니다." } }, "security": [ { "basicAuth": [] } ], "summary": "아이템의 사전 판매 수량 제한 제거", "tags": [ "common-pre-orders" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] }, "get": { "description": "아이템의 사전 판매 수량 제한을 가져옵니다.\n\n사전 판매 제한 API를 사용하면 제한된 수량의 아이템을 판매할 수 있습니다. 사전 판매를 구성하려면 원하는 아이템 모듈의 관리자 섹션으로 이동합니다.\n* [게임 키](https://developers.xsolla.com/ko/api/shop-builder/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}", "operationId": "get-pre-order-limit", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/item_sku-path-param" } ], "responses": { "200": { "content": { "application/json": { "examples": { "response": { "value": { "available": 431, "is_pre_order_limit_enabled": true, "item_id": 1, "reserved": 13, "sku": "com.xsolla.item_1", "sold": 556 } } }, "schema": { "properties": { "available": { "example": 431, "type": "integer" }, "is_pre_order_limit_enabled": { "example": true, "type": "boolean" }, "item_id": { "example": 1, "type": "integer" }, "reserved": { "example": 13, "type": "integer" }, "sku": { "example": "com.xsolla.item_1", "type": "string" }, "sold": { "example": 556, "type": "integer" } }, "type": "object" } } }, "description": "아이템 사전 판매 제한에 대한 정보를 성공적으로 수신했습니다." }, "401": { "$ref": "#/components/responses/Common_401-invalid-basic-auth" }, "404": { "description": "아이템을 찾을 수 없습니다." } }, "security": [ { "basicAuth": [] } ], "summary": "아이템의 사전 판매 제한에 대한 정보 가져오기", "tags": [ "common-pre-orders" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] }, "post": { "description": "아이템의 사전 판매 수량 제한에 수량을 추가합니다.\n\n사전 판매 제한 API를 사용하면 제한된 수량의 아이템을 판매할 수 있습니다. 사전 판매를 구성하려면 원하는 아이템 모듈의 관리자 섹션으로 이동합니다.\n* [게임 키](https://developers.xsolla.com/ko/api/shop-builder/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}", "operationId": "add-pre-order-limit", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/item_sku-path-param" } ], "requestBody": { "content": { "application/json": { "example": { "quantity": 100000 }, "schema": { "properties": { "quantity": { "description": "추가할 수량입니다.", "type": "integer" } }, "required": [ "quantity" ], "type": "object" } } } }, "responses": { "201": { "description": "제한할 수량이 성공적으로 추가했습니다." }, "401": { "$ref": "#/components/responses/Common_401-invalid-basic-auth" }, "404": { "description": "아이템을 찾을 수 없습니다." } }, "security": [ { "basicAuth": [] } ], "summary": "아이템 사전 판매 제한에 수량 추가하기", "tags": [ "common-pre-orders" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] }, "put": { "description": "아이템의 사전 판매 수량 제한에 대한 수량을 설정합니다.\n\n사전 판매 제한 API를 사용하면 제한된 수량의 아이템을 판매할 수 있습니다. 사전 판매를 구성하려면 원하는 아이템 모듈의 관리자 섹션으로 이동합니다.\n* [게임 키](https://developers.xsolla.com/ko/api/shop-builder/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}", "operationId": "set-pre-order-limit", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/item_sku-path-param" } ], "requestBody": { "content": { "application/json": { "example": { "quantity": 100000 }, "schema": { "properties": { "quantity": { "description": "설정할 수량입니다.", "type": "integer" } }, "required": [ "quantity" ], "type": "object" } } } }, "responses": { "204": { "description": "제한할 수량이 성공적으로 설정했습니다." }, "401": { "$ref": "#/components/responses/Common_401-invalid-basic-auth" }, "404": { "description": "아이템을 찾을 수 없습니다." } }, "security": [ { "basicAuth": [] } ], "summary": "아이템의 사전 판매 수량 제한 설정", "tags": [ "common-pre-orders" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v2/project/{project_id}/admin/items/pre_order/limit/item/sku/{item_sku}/all": { "delete": { "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}", "operationId": "remove-all-pre-order-limit", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/item_sku-path-param" } ], "responses": { "204": { "description": "제한 설정을 성공적으로 제거했습니다." }, "401": { "$ref": "#/components/responses/Common_401-invalid-basic-auth" }, "404": { "description": "아이템을 찾을 수 없습니다." } }, "security": [ { "basicAuth": [] } ], "summary": "아이템의 모든 사전 판매 수량 제한 제거", "tags": [ "common-pre-orders" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v2/project/{project_id}/admin/items/pre_order/limit/item/sku/{item_sku}/toggle": { "put": { "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}", "operationId": "toggle-pre-order-limit", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/item_sku-path-param" } ], "requestBody": { "content": { "application/json": { "example": { "is_pre_order_limit_enabled": true }, "schema": { "properties": { "is_pre_order_limit_enabled": { "type": "boolean" } }, "required": [ "is_pre_order_limit_enabled" ], "type": "object" } } } }, "responses": { "204": { "description": "제한을 비활성화/활성화되었습니다." }, "401": { "$ref": "#/components/responses/Common_401-invalid-basic-auth" }, "404": { "description": "아이템을 찾을 수 없습니다." } }, "security": [ { "basicAuth": [] } ], "summary": "아이템의 사전 판매 제한 토글", "tags": [ "common-pre-orders" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v2/project/{project_id}/admin/items/virtual_currency": { "get": { "description": "관리를 위해 프로젝트 내부의 인게임 재화 목록을 가져옵니다.\n\n
참고

스토어 카탈로그를 빌드하기 위해 이 엔드포인트를 사용해선 안 됩니다.
", "operationId": "admin-get-virtual-currencies-list", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/limit-query-param" }, { "$ref": "#/components/parameters/offset-query-param" } ], "responses": { "200": { "$ref": "#/components/responses/Virtual-Items-Currency_200-admin-get-virtual-currencies" }, "401": { "$ref": "#/components/responses/Virtual-Items-Currency_401-invalid-basic-auth" } }, "security": [ { "basicAuth": [] } ], "summary": "인게임 재화 목록 가져오기", "tags": [ "virtual-items-currency-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] }, "post": { "description": "인게임 재화를 생성합니다.", "operationId": "admin-create-virtual-currency", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" } ], "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" } }, "security": [ { "basicAuth": [] } ], "summary": "인게임 재화 생성하기", "tags": [ "virtual-items-currency-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v2/project/{project_id}/admin/items/virtual_currency/package": { "get": { "description": "관리를 위해 프로젝트 내부의 인게임 재화 목록을 가져옵니다.\n\n
참고

스토어 카탈로그를 빌드하기 위해 이 엔드포인트를 사용해선 안 됩니다.
", "operationId": "admin-get-virtual-currency-packages-list", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/limit-query-param" }, { "$ref": "#/components/parameters/offset-query-param" } ], "responses": { "200": { "$ref": "#/components/responses/Virtual-Items-Currency_200-admin-get-virtual-currency-packages" }, "401": { "$ref": "#/components/responses/Virtual-Items-Currency_401-invalid-basic-auth" } }, "security": [ { "basicAuth": [] } ], "summary": "인게임 재화 패키지 목록 가져오기(관리자)", "tags": [ "virtual-items-currency-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] }, "post": { "description": "인게임 재화 패키지를 생성합니다.", "operationId": "admin-create-virtual-currency-package", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" } ], "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" } }, "security": [ { "basicAuth": [] } ], "summary": "인게임 재화 패키지 생성하기", "tags": [ "virtual-items-currency-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v2/project/{project_id}/admin/items/virtual_currency/package/sku/{item_sku}": { "delete": { "description": "인게임 재화 패키지를 삭제합니다.", "operationId": "admin-delete-virtual-currency-package", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/item_sku-path-param" } ], "responses": { "204": { "description": "인게임 재화 패키지를 성공적으로 업데이트했습니다." }, "401": { "$ref": "#/components/responses/Virtual-Items-Currency_401-invalid-basic-auth" } }, "security": [ { "basicAuth": [] } ], "summary": "인게임 재화 패키지 삭제", "tags": [ "virtual-items-currency-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] }, "get": { "description": "관리를 위해 프로젝트 내부의 인게임 재화 패키지를 가져옵니다.\n\n
참고

스토어 카탈로그를 빌드하기 위해 이 엔드포인트를 사용해선 안 됩니다.
", "operationId": "admin-get-virtual-currency-package", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/item_sku-path-param" } ], "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" } }, "security": [ { "basicAuth": [] } ], "summary": "인게임 재화 패키지 가져오기", "tags": [ "virtual-items-currency-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] }, "put": { "description": "인게임 재화 패키지 업데이트", "operationId": "admin-update-virtual-currency-package", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/item_sku-path-param" } ], "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" } }, "security": [ { "basicAuth": [] } ], "summary": "인게임 재화 패키지 업데이트", "tags": [ "virtual-items-currency-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v2/project/{project_id}/admin/items/virtual_currency/sku/{virtual_currency_sku}": { "delete": { "description": "인게임 재화를 삭제합니다.", "operationId": "admin-delete-virtual-currency", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/virtual_currency_sku-path-param" } ], "responses": { "204": { "content": {}, "description": "인게임 재화를 성공적으로 삭제했습니다." }, "401": { "$ref": "#/components/responses/Virtual-Items-Currency_401-invalid-basic-auth" } }, "security": [ { "basicAuth": [] } ], "summary": "인게임 재화 삭제", "tags": [ "virtual-items-currency-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] }, "get": { "description": "관리를 위해 프로젝트 내부의 인게임 재화를 가져옵니다.\n\n
참고

스토어 카탈로그를 빌드하기 위해 이 엔드포인트를 사용해선 안 됩니다.
", "operationId": "admin-get-virtual-currency", "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" } }, "security": [ { "basicAuth": [] } ], "summary": "인게임 재화 가져오기", "tags": [ "virtual-items-currency-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] }, "put": { "description": "인게임 재화를 업데이트합니다.", "operationId": "admin-update-virtual-currency", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/virtual_currency_sku-path-param" } ], "requestBody": { "$ref": "#/components/requestBodies/Virtual-Items-Currency_admin-create-virtual-currency" }, "responses": { "204": { "content": {}, "description": "인게임 재화를 성공적으로 업데이트했습니다." }, "401": { "$ref": "#/components/responses/Virtual-Items-Currency_401-invalid-basic-auth" }, "422": { "$ref": "#/components/responses/Virtual-Items-Currency_422-invalid-request" } }, "security": [ { "basicAuth": [] } ], "summary": "인게임 재화 업데이트", "tags": [ "virtual-items-currency-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v2/project/{project_id}/admin/items/virtual_items": { "get": { "description": "관리를 위해 프로젝트 내부의 가상 아이템 목록을 가져옵니다.\n\n
참고

스토어 카탈로그를 빌드하기 위해 이 엔드포인트를 사용해선 안 됩니다.
", "operationId": "admin-get-virtual-items-list", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/limit-query-param" }, { "$ref": "#/components/parameters/offset-query-param" } ], "responses": { "200": { "$ref": "#/components/responses/Virtual-Items-Currency_200-admin-get-virtual-items" }, "401": { "$ref": "#/components/responses/Virtual-Items-Currency_401-invalid-basic-auth" } }, "security": [ { "basicAuth": [] } ], "summary": "가상 아이템 목록 가져오기", "tags": [ "virtual-items-currency-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] }, "post": { "description": "가상 아이템을 생성합니다.", "operationId": "admin-create-virtual-item", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" } ], "requestBody": { "$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" } }, "security": [ { "basicAuth": [] } ], "summary": "가상 아이템 생성하기", "tags": [ "virtual-items-currency-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v2/project/{project_id}/admin/items/virtual_items/group/external_id/{external_id}": { "get": { "description": "관리를 위해 그룹 내부의 가상 아이템 목록을 가져옵니다.\n\n
참고

스토어 카탈로그를 빌드하기 위해 이 엔드포인트를 사용해선 안 됩니다.
", "operationId": "admin-get-virtual-items-list-by-group-external-id", "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" } ], "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" } }, "security": [ { "basicAuth": [] } ], "summary": "지정한 그룹 외부 ID로 가상 아이템 목록 가져오기", "tags": [ "virtual-items-currency-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v2/project/{project_id}/admin/items/virtual_items/group/id/{group_id}": { "get": { "description": "관리를 위해 그룹 내부의 가상 아이템 목록을 가져옵니다.\n\n
참고

스토어 카탈로그를 빌드하기 위해 이 엔드포인트를 사용해선 안 됩니다.
", "operationId": "admin-get-virtual-items-list-by-group-id", "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" } ], "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" } }, "security": [ { "basicAuth": [] } ], "summary": "지정한 그룹 ID로 가상 아이템 목록 가져오기", "tags": [ "virtual-items-currency-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v2/project/{project_id}/admin/items/virtual_items/sku/{item_sku}": { "delete": { "description": "가상 아이템을 삭제합니다.", "operationId": "admin-delete-virtual-item", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/item_sku-path-param" } ], "responses": { "204": { "content": {}, "description": "가상 아이템을 성공적으로 삭제했습니다." }, "401": { "$ref": "#/components/responses/Virtual-Items-Currency_401-invalid-basic-auth" } }, "security": [ { "basicAuth": [] } ], "summary": "가상 아이템 삭제", "tags": [ "virtual-items-currency-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] }, "get": { "description": "관리를 위해 프로젝트 내부의 가상 아이템을 가져옵니다.\n\n
참고

스토어 카탈로그를 빌드하기 위해 이 엔드포인트를 사용해선 안 됩니다.
", "operationId": "admin-get-virtual-item", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/item_sku-path-param" } ], "responses": { "200": { "$ref": "#/components/responses/Virtual-Items-Currency_200-admin-get-item" }, "401": { "$ref": "#/components/responses/Virtual-Items-Currency_401-invalid-basic-auth" } }, "security": [ { "basicAuth": [] } ], "summary": "가상 아이템 가져오기", "tags": [ "virtual-items-currency-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] }, "put": { "description": "가상 아이템을 업데이트합니다.", "operationId": "admin-update-virtual-item", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/item_sku-path-param" } ], "requestBody": { "$ref": "#/components/requestBodies/Virtual-Items-Currency_admin-create-virtual-item" }, "responses": { "204": { "content": {}, "description": "가상 아이템을 성공적으로 업데이트했습니다." }, "401": { "$ref": "#/components/responses/Virtual-Items-Currency_401-invalid-basic-auth" }, "422": { "$ref": "#/components/responses/Virtual-Items-Currency_422-invalid-request" } }, "security": [ { "basicAuth": [] } ], "summary": "가상 아이템 업데이트", "tags": [ "virtual-items-currency-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v2/project/{project_id}/admin/items/{item_type}/groups": { "get": { "description": "Retrieves item group list with filtering by item type. Only items of the specified type are counted for the group. This is similar to the [Get item group list](/ko/api/catalog/item-groups-admin/admin-get-item-group-list) endpoint, with additional filtering of items by type when counting them.", "operationId": "admin-get-item-group-list-by-item-type", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/item_type-group-path-param" } ], "responses": { "200": { "$ref": "#/components/responses/ItemGroup_200-admin-get-group-list-by-item-type" }, "401": { "$ref": "#/components/responses/ItemGroup_401-invalid-basic-auth" } }, "security": [ { "basicAuth": [] } ], "summary": "Get item group list filtered by item type", "tags": [ "item-groups-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v2/project/{project_id}/admin/items/{item_type}/groups/{external_id}": { "get": { "description": "Retrieves an item group by external ID. Only items of the specified type are counted for the group. This is similar to the [Get item group by external ID](/ko/api/catalog/item-groups-admin/admin-get-item-group) endpoint, with additional filtering of items by type when counting them.", "operationId": "admin-get-item-group-by-item-type", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/item_type-group-path-param" }, { "$ref": "#/components/parameters/external_id-group-path-param" } ], "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" } }, "security": [ { "basicAuth": [] } ], "summary": "Get item group by external ID filtered by item type", "tags": [ "item-groups-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v2/project/{project_id}/admin/region": { "get": { "description": "지역 목록을 가져옵니다.\n\n지역을 사용하여 지역 제한을 관리할 수 있습니다.", "operationId": "admin-get-regions", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" } ], "responses": { "200": { "$ref": "#/components/responses/200-admin-get-regions-list" }, "401": { "$ref": "#/components/responses/401-invalid-basic-auth" } }, "security": [ { "basicAuth": [] } ], "summary": "지역 목록 가져오기", "tags": [ "common-regions" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] }, "post": { "description": "지역을 생성합니다.\n\n지역을 사용하여 지역 제한을 관리할 수 있습니다.", "operationId": "admin-create-region", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" } ], "requestBody": { "$ref": "#/components/requestBodies/create-update-region" }, "responses": { "201": { "$ref": "#/components/responses/201-admin-create-region" }, "401": { "$ref": "#/components/responses/401-invalid-basic-auth" } }, "security": [ { "basicAuth": [] } ], "summary": "지역 생성하기", "tags": [ "common-regions" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v2/project/{project_id}/admin/region/{region_id}": { "delete": { "description": "특정 지역을 삭제합니다.", "operationId": "admin-delete-region", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/region_id-path-param" } ], "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" } }, "security": [ { "basicAuth": [] } ], "summary": "지역 삭제", "tags": [ "common-regions" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] }, "get": { "description": "특정 지역을 가져옵니다.\n\n지역을 사용하여 지역 제한을 관리할 수 있습니다.", "operationId": "admin-get-region", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/region_id-path-param" } ], "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" } }, "security": [ { "basicAuth": [] } ], "summary": "지역 가져오기", "tags": [ "common-regions" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] }, "put": { "description": "특정 지역을 업데이트합니다.\n\n지역을 사용하여 지역 제한을 관리할 수 있습니다.", "operationId": "admin-update-region", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/region_id-path-param" } ], "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" } }, "security": [ { "basicAuth": [] } ], "summary": "지역 업데이트", "tags": [ "common-regions" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v2/project/{project_id}/admin/user/limit/item/all": { "delete": { "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/)", "operationId": "reset-all-user-items-limit", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" } ], "requestBody": { "$ref": "#/components/requestBodies/reset-user-limits" }, "responses": { "200": { "description": "제한 설정을 성공적으로 새로고침했습니다." }, "401": { "$ref": "#/components/responses/Common_401-invalid-basic-auth" }, "404": { "content": { "application/json": { "examples": { "User not found": { "value": { "errorCode": 5008, "errorMessage": "[0401-5008]: Could not find User", "statusCode": 404 } } }, "schema": { "properties": { "errorCode": { "type": "integer" }, "errorMessage": { "type": "string" }, "statusCode": { "type": "integer" }, "transactionId": { "type": "string" } }, "type": "object" } } }, "description": "아이템을 찾을 수 없습니다." }, "422": { "content": { "application/json": { "examples": { "Invalid user_external_id": { "value": { "errorCode": 1102, "errorMessage": "[0401-1102]: Unprocessable Entity", "errorMessageExtended": [ { "message": "Must be at least 1 characters long", "property": "user_external_id" }, { "message": "Does not match the regex pattern ^\\S+$", "property": "user_external_id" } ], "statusCode": 404 } } }, "schema": { "properties": { "errorCode": { "type": "integer" }, "errorMessage": { "type": "string" }, "errorMessageExtended": { "items": { "properties": { "message": { "type": "string" }, "property": { "type": "string" } }, "type": "object" }, "type": "array" }, "statusCode": { "type": "integer" }, "transactionId": { "type": "string" } }, "type": "object" } } }, "description": "잘못된 요청입니다." } }, "security": [ { "basicAuth": [] } ], "summary": "지정된 사용자의 모든 구매 제한 설정 새로고침", "tags": [ "user-limits-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v2/project/{project_id}/admin/user/limit/item/sku/{item_sku}": { "delete": { "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/)", "operationId": "remove-user-item-limit", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/item_sku-path-param" } ], "requestBody": { "$ref": "#/components/requestBodies/update-user-limits-strict" }, "responses": { "200": { "$ref": "#/components/responses/200-admin-get-user-item-limits" }, "401": { "$ref": "#/components/responses/Common_401-invalid-basic-auth" }, "404": { "content": { "application/json": { "examples": { "Item not found": { "$ref": "#/components/examples/404-item-by-sku-not-found" }, "User not found": { "$ref": "#/components/examples/404-user-not-found" } }, "schema": { "properties": { "errorCode": { "type": "integer" }, "errorMessage": { "type": "string" }, "statusCode": { "type": "integer" }, "transactionId": { "type": "string" } }, "type": "object" } } }, "description": "아이템을 찾을 수 없습니다." }, "422": { "content": { "application/json": { "examples": { "Available item limit is out of range": { "$ref": "#/components/examples/422-item-out-of-range-available-user-limit" }, "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" } }, "schema": { "properties": { "errorCode": { "type": "integer" }, "errorMessage": { "type": "string" }, "errorMessageExtended": { "type": "array" }, "statusCode": { "type": "integer" }, "transactionId": { "type": "string" } }, "type": "object" } } }, "description": "잘못된 요청입니다." } }, "security": [ { "basicAuth": [] } ], "summary": "지정된 사용자가 사용할 수 있는 아이템 개수를 줄입니다", "tags": [ "user-limits-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] }, "get": { "description": "적용된 제한 설정 내에서 지정된 사용자가 사용할 수 있는 남은 아이템 개수를 가져옵니다.\n\n사용자 제한 API를 사용하면 제한된 수량만 아이템을 판매할 수 있습니다. 구매 한도를 구성하려면 원하는 아이템 유형 모듈의 관리 섹션으로 이동합니다.\n* [게임 키](https://developers.xsolla.com/ko/api/shop-builder/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/)", "operationId": "get-user-item-limit", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/item_sku-path-param" }, { "$ref": "#/components/parameters/user_external_id-query-param" } ], "responses": { "200": { "$ref": "#/components/responses/200-admin-get-user-item-limits" }, "401": { "$ref": "#/components/responses/Common_401-invalid-basic-auth" }, "404": { "content": { "application/json": { "examples": { "Item not found": { "$ref": "#/components/examples/404-item-by-sku-not-found" }, "User not found": { "$ref": "#/components/examples/404-user-not-found" } }, "schema": { "properties": { "errorCode": { "type": "integer" }, "errorMessage": { "type": "string" }, "statusCode": { "type": "integer" }, "transactionId": { "type": "string" } }, "type": "object" } } }, "description": "아이템을 찾을 수 없습니다." }, "422": { "content": { "application/json": { "examples": { "Invalid user_external_id": { "$ref": "#/components/examples/422-user_external_id_invalid" }, "Item does not have configured user limits": { "$ref": "#/components/examples/422-item-without-user-limit" } }, "schema": { "properties": { "errorCode": { "type": "integer" }, "errorMessage": { "type": "string" }, "errorMessageExtended": { "type": "array" }, "statusCode": { "type": "integer" }, "transactionId": { "type": "string" } }, "type": "object" } } }, "description": "잘못된 요청입니다." } }, "security": [ { "basicAuth": [] } ], "summary": "지정된 사용자가 사용할 수 있는 아이템의 수량을 가져옵니다", "tags": [ "user-limits-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] }, "post": { "description": "적용된 제한 설정 내에서 지정된 사용자가 사용할 수 있는 남은 아이템 개수를 늘립니다.\n\n사용자 제한 API를 사용하면 제한된 수량만 아이템을 판매할 수 있습니다. 구매 한도를 구성하려면 원하는 아이템 유형 모듈의 관리 섹션으로 이동합니다.\n* [게임 키](https://developers.xsolla.com/ko/api/shop-builder/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/)", "operationId": "add-user-item-limit", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/item_sku-path-param" } ], "requestBody": { "$ref": "#/components/requestBodies/update-user-limits-strict" }, "responses": { "200": { "$ref": "#/components/responses/200-admin-get-user-item-limits" }, "401": { "$ref": "#/components/responses/Common_401-invalid-basic-auth" }, "404": { "content": { "application/json": { "examples": { "Item not found": { "$ref": "#/components/examples/404-item-by-sku-not-found" }, "User not found": { "$ref": "#/components/examples/404-user-not-found" } }, "schema": { "properties": { "errorCode": { "type": "integer" }, "errorMessage": { "type": "string" }, "statusCode": { "type": "integer" }, "transactionId": { "type": "string" } }, "type": "object" } } }, "description": "아이템을 찾을 수 없습니다." }, "422": { "content": { "application/json": { "examples": { "Available item limit is out of range": { "$ref": "#/components/examples/422-item-out-of-range-available-user-limit" }, "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" } }, "schema": { "properties": { "errorCode": { "type": "integer" }, "errorMessage": { "type": "string" }, "errorMessageExtended": { "type": "array" }, "statusCode": { "type": "integer" }, "transactionId": { "type": "string" } }, "type": "object" } } }, "description": "잘못된 요청입니다." } }, "security": [ { "basicAuth": [] } ], "summary": "지정된 사용자가 사용할 수 있는 아이템의 수량을 늘립니다", "tags": [ "user-limits-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] }, "put": { "description": "지정된 사용자가 제한 설정이 증가되거나 감소된 후 적용된 제한 설정 내에서 구매할 수 있는 아이템 개수를 설정합니다.\n\n사용자 제한 API를 사용하면 제한된 수량만 아이템을 판매할 수 있습니다. 구매 한도를 구성하려면 원하는 아이템 유형 모듈의 관리 섹션으로 이동합니다.\n* [게임 키](https://developers.xsolla.com/ko/api/shop-builder/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/)", "operationId": "set-user-item-limit", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/item_sku-path-param" } ], "requestBody": { "$ref": "#/components/requestBodies/update-user-limits-flexible" }, "responses": { "200": { "$ref": "#/components/responses/200-admin-get-user-item-limits" }, "401": { "$ref": "#/components/responses/Common_401-invalid-basic-auth" }, "404": { "content": { "application/json": { "examples": { "Item not found": { "$ref": "#/components/examples/404-item-by-sku-not-found" }, "User not found": { "$ref": "#/components/examples/404-user-not-found" } }, "schema": { "properties": { "errorCode": { "type": "integer" }, "errorMessage": { "type": "string" }, "statusCode": { "type": "integer" }, "transactionId": { "type": "string" } }, "type": "object" } } }, "description": "아이템을 찾을 수 없습니다." }, "422": { "content": { "application/json": { "examples": { "Invalid user_external_id": { "$ref": "#/components/examples/422-user_external_id_invalid" }, "Item does not have configured user limits": { "$ref": "#/components/examples/422-item-without-user-limit" } }, "schema": { "properties": { "errorCode": { "type": "integer" }, "errorMessage": { "type": "string" }, "errorMessageExtended": { "type": "array" }, "statusCode": { "type": "integer" }, "transactionId": { "type": "string" } }, "type": "object" } } }, "description": "잘못된 요청입니다." } }, "security": [ { "basicAuth": [] } ], "summary": "지정된 사용자가 사용할 수 있는 아이템의 수량을 설정합니다", "tags": [ "user-limits-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v2/project/{project_id}/admin/user/limit/item/sku/{item_sku}/all": { "delete": { "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/)", "operationId": "reset-user-item-limit", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/item_sku-path-param" } ], "requestBody": { "$ref": "#/components/requestBodies/reset-user-limits-flexible" }, "responses": { "200": { "description": "제한 설정을 성공적으로 새로고침했습니다." }, "401": { "$ref": "#/components/responses/Common_401-invalid-basic-auth" }, "404": { "content": { "application/json": { "examples": { "Item not found": { "$ref": "#/components/examples/404-item-by-sku-not-found" }, "User not found": { "$ref": "#/components/examples/404-user-not-found" } }, "schema": { "properties": { "errorCode": { "type": "integer" }, "errorMessage": { "type": "string" }, "statusCode": { "type": "integer" }, "transactionId": { "type": "string" } }, "type": "object" } } }, "description": "아이템을 찾을 수 없습니다." }, "422": { "content": { "application/json": { "examples": { "Invalid user_external_id": { "$ref": "#/components/examples/422-user_external_id_invalid" }, "Item does not have configured user limits": { "$ref": "#/components/examples/422-item-without-user-limit" } }, "schema": { "properties": { "errorCode": { "type": "integer" }, "errorMessage": { "type": "string" }, "errorMessageExtended": { "type": "array" }, "statusCode": { "type": "integer" }, "transactionId": { "type": "string" } }, "type": "object" } } }, "description": "잘못된 요청입니다." } }, "security": [ { "basicAuth": [] } ], "summary": "구매 한도 새로고침", "tags": [ "user-limits-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v2/project/{project_id}/cart": { "get": { "description": "현재 사용자의 장바구니를 반환합니다.", "operationId": "get-user-cart", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/currency-query-param" }, { "$ref": "#/components/parameters/locale-query-param" } ], "responses": { "200": { "$ref": "#/components/responses/Cart-Payment_200-get-cart-json-model" } }, "security": [ { "AuthForCart": [] } ], "summary": "현재 사용자의 장바구니 가져오기", "tags": [ "cart-client-side" ], "x-badges": [ { "color": "#80eaff", "name": "Client-side" } ] } }, "/v2/project/{project_id}/cart/clear": { "put": { "description": "모든 장바구니 아이템을 삭제합니다.", "operationId": "cart-clear", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" } ], "responses": { "204": { "description": "장바구니 아이템이 성공적으로 삭제되었습니다." } }, "security": [ { "AuthForCart": [] } ], "summary": "현재 장바구니에서 모든 장바구니 아이템 삭제", "tags": [ "cart-client-side" ], "x-badges": [ { "color": "#80eaff", "name": "Client-side" } ] } }, "/v2/project/{project_id}/cart/fill": { "put": { "description": "장바구니를 아이템으로 채웁니다. 장바구니에 동일한 SKU를 가진 아이템이 이미 있으면 기존 아이템이 전달된 값으로 교체됩니다.", "operationId": "cart-fill", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" } ], "requestBody": { "$ref": "#/components/requestBodies/Cart-Payment_fill-cart-json-model" }, "responses": { "200": { "$ref": "#/components/responses/Cart-Payment_200-fill-cart-json-model" } }, "security": [ { "AuthForCart": [] } ], "summary": "아이템으로 장바구니 채우기", "tags": [ "cart-client-side" ], "x-badges": [ { "color": "#80eaff", "name": "Client-side" } ] } }, "/v2/project/{project_id}/cart/item/{item_sku}": { "delete": { "description": "장바구니에서 아이템을 제거합니다.", "operationId": "delete-item", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/item_sku-path-param" } ], "responses": { "204": { "description": "장바구니에서 아이템을 성공적으로 삭제했습니다." }, "404": { "$ref": "#/components/responses/Cart-Payment_404-item" } }, "security": [ { "AuthForCart": [] } ], "summary": "현재 장바구니에서 장바구니 아이템 삭제", "tags": [ "cart-client-side" ], "x-badges": [ { "color": "#80eaff", "name": "Client-side" } ] }, "put": { "description": "기존 장바구니 아이템을 업데이트하거나 장바구니에서 아이템을 생성합니다.", "operationId": "put-item", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/item_sku-path-param" } ], "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" } }, "security": [ { "AuthForCart": [] } ], "summary": "현재 장바구니에서 장바구니 아이템 업데이트", "tags": [ "cart-client-side" ], "x-badges": [ { "color": "#80eaff", "name": "Client-side" } ] } }, "/v2/project/{project_id}/cart/{cart_id}": { "get": { "description": "장바구니 ID로 사용자의 장바구니를 반환합니다.", "operationId": "get-cart-by-id", "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" } ], "responses": { "200": { "$ref": "#/components/responses/Cart-Payment_200-get-cart-json-model" } }, "security": [ { "AuthForCart": [] } ], "summary": "장바구니 ID로 장바구니 가져오기", "tags": [ "cart-client-side" ], "x-badges": [ { "color": "#80eaff", "name": "Client-side" } ] } }, "/v2/project/{project_id}/cart/{cart_id}/clear": { "put": { "description": "모든 장바구니 아이템을 삭제합니다.", "operationId": "cart-clear-by-id", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/cart_id-path-param" } ], "responses": { "204": { "description": "장바구니 아이템이 성공적으로 삭제되었습니다." } }, "security": [ { "AuthForCart": [] } ], "summary": "장바구니 ID로 모든 장바구니 아이템 삭제하기", "tags": [ "cart-client-side" ], "x-badges": [ { "color": "#80eaff", "name": "Client-side" } ] } }, "/v2/project/{project_id}/cart/{cart_id}/fill": { "put": { "description": "특정 장바구니를 아이템으로 채웁니다. 장바구니에 동일한 SKU를 가진 아이템이 이미 있으면 기존 아이템의 위치가 전달된 값으로 교체됩니다.", "operationId": "cart-fill-by-id", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/cart_id-path-param" } ], "requestBody": { "$ref": "#/components/requestBodies/Cart-Payment_fill-cart-json-model" }, "responses": { "200": { "$ref": "#/components/responses/Cart-Payment_200-fill-cart-json-model" } }, "security": [ { "AuthForCart": [] } ], "summary": "아이템으로 특정 장바구니 채우기", "tags": [ "cart-client-side" ], "x-badges": [ { "color": "#80eaff", "name": "Client-side" } ] } }, "/v2/project/{project_id}/cart/{cart_id}/item/{item_sku}": { "delete": { "description": "장바구니에서 아이템을 제거합니다.", "operationId": "delete-item-by-cart-id", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/cart_id-path-param" }, { "$ref": "#/components/parameters/item_sku-path-param" } ], "responses": { "204": { "description": "장바구니에서 아이템을 성공적으로 삭제했습니다." }, "404": { "$ref": "#/components/responses/Cart-Payment_404-item" } }, "security": [ { "AuthForCart": [] } ], "summary": "장바구니 ID로 장바구니 아이템 삭제하기", "tags": [ "cart-client-side" ], "x-badges": [ { "color": "#80eaff", "name": "Client-side" } ] }, "put": { "description": "기존 장바구니 아이템을 업데이트하거나 장바구니에서 아이템을 생성합니다.", "operationId": "put-item-by-cart-id", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/cart_id-path-param" }, { "$ref": "#/components/parameters/item_sku-path-param" } ], "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" } }, "security": [ { "AuthForCart": [] } ], "summary": "장바구니 ID로 장바구니 아이템 업데이트하기", "tags": [ "cart-client-side" ], "x-badges": [ { "color": "#80eaff", "name": "Client-side" } ] } }, "/v2/project/{project_id}/entitlement": { "get": { "description": "Get the list of games owned by the user. The response will contain an array of games owned by a particular user.\n
\n Attention

\n All projects have the limitation to the number of items that you can\n get in the response. The default and maximum value is 50 items\n per response. To get more data page by page, use limit\n and offset fields.\n

\n Note

\n This API call returns generic item catalog data when used without\n authorization. Use authorization to retrieve\n personalized\n user data, such as limits and promotions associated with the item.\n To do this, pass the user JWT in the Authorization header.\n For more information about user JWT, see the Security block\n for this call.\n
", "operationId": "get-user-games", "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" } }, "security": [ { "XsollaLoginUserJWT": [] } ], "summary": "사용자가 소유한 게임 목록 가져오기", "tags": [ "game-keys-entitlement" ], "x-badges": [ { "color": "#80eaff", "name": "Client-side" } ] } }, "/v2/project/{project_id}/entitlement/redeem": { "post": { "description": "Grants entitlement by a provided game code.\n
\n Notice

\n You can redeem codes only for the DRM-free platform.\n

\n Note

\n This API call returns generic item catalog data when used without\n authorization. Use authorization to retrieve\n personalized\n user data, such as limits and promotions associated with the item.\n To do this, pass the user JWT in the Authorization header.\n For more information about user JWT, see the Security block\n for this call.\n
", "operationId": "redeem-game-pin-code", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "code": { "description": "게임 코드입니다.", "example": "AAAA-BBBB-CCCC-DDDD", "type": "string" }, "sandbox": { "default": false, "description": "샌드박스 모드로 게임 코드를 사용합니다. 이 옵션은 회사 사용자 목록에 지정한 사용자에게 사용할 수 있습니다.", "example": false, "type": "boolean" } }, "required": [ "code" ], "type": "object" } } }, "required": true }, "responses": { "201": { "description": "성공한 사용입니다." }, "403": { "$ref": "#/components/responses/Game-Keys_403-auth-header-not-sent" }, "404": { "content": { "application/json": { "examples": { "Game code not found": { "$ref": "#/components/examples/404-game-code-not-found" } }, "schema": { "properties": { "errorCode": { "example": 4603, "type": "integer" }, "errorMessage": { "example": "[0401-4603]: Game code not found.", "type": "string" }, "statusCode": { "example": 404, "type": "integer" }, "transactionId": { "example": "x-x-x-x-transactionId-mock-x-x-x", "type": "string" } }, "type": "object" } } }, "description": "게임 코드를 찾을 수 없습니다. `code`와 `project_id`가 올바른지 확인합니다." }, "422": { "content": { "application/json": { "examples": { "DRM is not DRM free": { "$ref": "#/components/examples/422-drm-is-not-drm-free" }, "Game code is already activated": { "value": { "errorCode": 5107, "errorMessage": "[0401-5107]: Game code has been already activated", "statusCode": 422, "transactionId": "transaction id" } }, "Game is in pre-order state": { "value": { "errorCode": 5106, "errorMessage": "[0401-5106]: Item: game_sku is in pre-order state and can not be redeemed", "statusCode": 422, "transactionId": "transaction id" } }, "User already has entitlement": { "$ref": "#/components/examples/422-user-already-has-entitlement" } }, "schema": { "properties": { "errorCode": { "example": 5103, "type": "integer" }, "errorMessage": { "example": "[0401-5103]: Selected drm is not drmfree.", "type": "string" }, "statusCode": { "example": 422, "type": "integer" }, "transactionId": { "example": "x-x-x-x-transactionId-mock-x-x-x", "type": "string" } }, "type": "object" } } }, "description": "잘못된 요청입니다." } }, "security": [ { "XsollaLoginUserJWT": [] } ], "summary": "클라이언트로 게임 코드 사용하기", "tags": [ "game-keys-entitlement" ], "x-badges": [ { "color": "#80eaff", "name": "Client-side" } ] } }, "/v2/project/{project_id}/free/cart": { "post": { "description": "무료 장바구니의 모든 아이템으로 주문을 생성합니다. 생성된 주문은 `done` 주문 상태를 가져옵니다.", "operationId": "create-free-order", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" } ], "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" } }, "security": [ { "AuthForCart": [] } ], "summary": "무료 장바구니로 주문 생성하기", "tags": [ "free-item" ], "x-badges": [ { "color": "#80eaff", "name": "Client-side" } ] } }, "/v2/project/{project_id}/free/cart/{cart_id}": { "post": { "description": "특정 무료 장바구니의 모든 아이템으로 주문을 생성합니다. 생성된 주문은 `done` 주문 상태를 가져옵니다.", "operationId": "create-free-order-by-cart-id", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/cart_id-path-param" } ], "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" } }, "security": [ { "AuthForCart": [] } ], "summary": "특정 무료 장바구니로 주문 생성하기", "tags": [ "free-item" ], "x-badges": [ { "color": "#80eaff", "name": "Client-side" } ] } }, "/v2/project/{project_id}/free/item/{item_sku}": { "post": { "description": "Creates an order with a specified free item. The created order will get a `done` order status.
\n Note

\n This API call returns generic item catalog data when used without\n authorization. Use authorization to retrieve\n personalized\n user data, such as limits and promotions associated with the item.\n To do this, pass the user JWT in the Authorization header.\n For more information about user JWT, see the Security block\n for this call.\n
", "operationId": "create-free-order-with-item", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/item_sku-path-param" } ], "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" } }, "security": [ { "XsollaLoginUserJWT": [] } ], "summary": "지정한 무료 아이템으로 주문 생성하기", "tags": [ "free-item" ], "x-badges": [ { "color": "#80eaff", "name": "Client-side" } ] } }, "/v2/project/{project_id}/items": { "get": { "description": "Gets a sellable items list for building a catalog.\n
\n Attention

\n All projects have the limitation to the number of items that you can\n get in the response. The default and maximum value is 50 items\n per response. To get more data page by page, use limit\n and offset fields.\n

\n Note

\n This API call returns generic item catalog data when used without\n authorization. Use authorization to retrieve\n personalized\n user data, such as limits and promotions associated with the item.\n To do this, pass the user JWT in the Authorization header.\n For more information about user JWT, see the Security block\n for this call.\n
", "operationId": "get-sellable-items", "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" } ], "responses": { "200": { "$ref": "#/components/responses/sellable_items_200-get-items-list" } }, "security": [ { "XsollaLoginUserJWT": [] } ], "summary": "판매할 수 있는 아이템 목록 가져오기", "tags": [ "common-catalog" ], "x-badges": [ { "color": "#80eaff", "name": "Client-side" } ] } }, "/v2/project/{project_id}/items/bundle": { "get": { "description": "Gets a list of bundles for building a catalog.\n
\n Attention

\n All projects have the limitation to the number of items that you can\n get in the response. The default and maximum value is 50 items\n per response. To get more data page by page, use limit\n and offset fields.\n

\n Note

\n This API call returns generic item catalog data when used without\n authorization. Use authorization to retrieve\n personalized\n user data, such as limits and promotions associated with the item.\n To do this, pass the user JWT in the Authorization header.\n For more information about user JWT, see the Security block\n for this call.\n
", "operationId": "get-bundle-list", "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/Bundles_200-get-bundle-list" } }, "security": [ { "XsollaLoginUserJWT": [] } ], "summary": "번들 목록 가져오기", "tags": [ "bundles-catalog" ], "x-badges": [ { "color": "#80eaff", "name": "Client-side" } ] } }, "/v2/project/{project_id}/items/bundle/group/{external_id}": { "get": { "description": "Gets a list of bundles within a group for building a catalog.\n
\n Attention

\n All projects have the limitation to the number of items that you can\n get in the response. The default and maximum value is 50 items\n per response. To get more data page by page, use limit\n and offset fields.\n

\n Note

\n This API call returns generic item catalog data when used without\n authorization. Use authorization to retrieve\n personalized\n user data, such as limits and promotions associated with the item.\n To do this, pass the user JWT in the Authorization header.\n For more information about user JWT, see the Security block\n for this call.\n
", "operationId": "get-bundle-list-in-group", "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/Bundles_200-get-bundle-list" } }, "security": [ { "XsollaLoginUserJWT": [] } ], "summary": "지정한 그룹으로 번들 목록 가져오기", "tags": [ "bundles-catalog" ], "x-badges": [ { "color": "#80eaff", "name": "Client-side" } ] } }, "/v2/project/{project_id}/items/bundle/sku/{sku}": { "get": { "description": "Gets a specified bundle.\n
\n Note

\n This API call returns generic item catalog data when used without\n authorization. Use authorization to retrieve\n personalized\n user data, such as limits and promotions associated with the item.\n To do this, pass the user JWT in the Authorization header.\n For more information about user JWT, see the Security block\n for this call.\n
", "operationId": "get-bundle", "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" } ], "responses": { "200": { "content": { "application/json": { "examples": { "response": { "$ref": "#/components/examples/Bundles_200-get-bundle" } }, "schema": { "$ref": "#/components/schemas/Bundles_client_bundle" } } }, "description": "지정한 번들을 성공적으로 수신했습니다." } }, "security": [ { "XsollaLoginUserJWT": [] } ], "summary": "지정한 번들 가져오기", "tags": [ "bundles-catalog" ], "x-badges": [ { "color": "#80eaff", "name": "Client-side" } ] } }, "/v2/project/{project_id}/items/game": { "get": { "description": "Gets a games list for building a catalog.\n
\n Attention

\n All projects have the limitation to the number of items that you can\n get in the response. The default and maximum value is 50 items\n per response. To get more data page by page, use limit\n and offset fields.\n

\n Note

\n This API call returns generic item catalog data when used without\n authorization. Use authorization to retrieve\n personalized\n user data, such as limits and promotions associated with the item.\n To do this, pass the user JWT in the Authorization header.\n For more information about user JWT, see the Security block\n for this call.\n
", "operationId": "get-games-list", "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" } }, "security": [ { "XsollaLoginUserJWT": [] } ], "summary": "게임 목록 가져오기", "tags": [ "game-keys-catalog" ], "x-badges": [ { "color": "#80eaff", "name": "Client-side" } ] } }, "/v2/project/{project_id}/items/game/drm": { "get": { "description": "사용 가능한 DRM 목록을 가져옵니다.", "operationId": "get-drm-list", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" } ], "responses": { "200": { "$ref": "#/components/responses/Game-Keys_200-get-drm-list" } }, "security": [], "summary": "DRM 목록 가져오기", "tags": [ "game-keys-catalog" ], "x-badges": [ { "color": "#80eaff", "name": "Client-side" } ] } }, "/v2/project/{project_id}/items/game/group/{external_id}": { "get": { "description": "Gets a games list from the specified group for building a catalog.\n
\n Attention

\n All projects have the limitation to the number of items that you can\n get in the response. The default and maximum value is 50 items\n per response. To get more data page by page, use limit\n and offset fields.\n

\n Note

\n This API call returns generic item catalog data when used without\n authorization. Use authorization to retrieve\n personalized\n user data, such as limits and promotions associated with the item.\n To do this, pass the user JWT in the Authorization header.\n For more information about user JWT, see the Security block\n for this call.\n
", "operationId": "get-games-group", "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" } }, "security": [ { "XsollaLoginUserJWT": [] } ], "summary": "지정한 그룹으로 게임 목록 가져오기", "tags": [ "game-keys-catalog" ], "x-badges": [ { "color": "#80eaff", "name": "Client-side" } ] } }, "/v2/project/{project_id}/items/game/key/group/{external_id}": { "get": { "description": "Gets a game key list from the specified group for building a catalog.\n
\n Attention

\n All projects have the limitation to the number of items that you can\n get in the response. The default and maximum value is 50 items\n per response. To get more data page by page, use limit\n and offset fields.\n

\n Note

\n This API call returns generic item catalog data when used without\n authorization. Use authorization to retrieve\n personalized\n user data, such as limits and promotions associated with the item.\n To do this, pass the user JWT in the Authorization header.\n For more information about user JWT, see the Security block\n for this call.\n
", "operationId": "get-game-keys-group", "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" } }, "security": [ { "XsollaLoginUserJWT": [] } ], "summary": "지정한 그룹으로 게임 키 목록 가져오기", "tags": [ "game-keys-catalog" ], "x-badges": [ { "color": "#80eaff", "name": "Client-side" } ] } }, "/v2/project/{project_id}/items/game/key/sku/{item_sku}": { "get": { "description": "Gets a game key for the catalog.\n
\n Note

\n This API call returns generic item catalog data when used without\n authorization. Use authorization to retrieve\n personalized\n user data, such as limits and promotions associated with the item.\n To do this, pass the user JWT in the Authorization header.\n For more information about user JWT, see the Security block\n for this call.\n
", "operationId": "get-game-key-by-sku", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "description": "아이템 SKU입니다.", "in": "path", "name": "item_sku", "required": true, "schema": { "default": "xsollus_basic_edition_steam", "type": "string" } }, { "$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": { "content": { "application/json": { "examples": { "response": { "value": { "attributes": [ { "external_id": "OS", "name": "OS", "values": [ { "external_id": "9d5c5efb7c0f00a00fe4e3583f1215b0050bc723", "value": "Windows" } ] }, { "external_id": "genre", "name": "Genre", "values": [ { "external_id": "23fda05111c125608af8f1fa0e99db45a10ea1cc", "value": "Horror" } ] } ], "can_be_bought": true, "description": "Game description", "drm_name": "Steam", "drm_sku": "steam_key_1", "groups": [ { "external_id": "all", "name": "All games" }, { "external_id": "Xsolla", "name": "Xsolla games" } ], "has_keys": true, "image_url": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png", "is_free": false, "is_pre_order": true, "limits": null, "name": "Game name", "periods": [ { "date_from": "2020-08-11T10:00:00+03:00", "date_until": "2020-08-11T20:00:00+03:00" } ], "price": { "amount": "30.5", "amount_without_discount": "30.5", "currency": "USD" }, "promotions": [], "release_date": "2020-08-11T10:00:00+03:00", "sku": "com.xsolla.game_1", "type": "game_key", "virtual_prices": [] } } }, "schema": { "description": "게임 키 정보가 있는 개체입니다.", "example": { "attributes": [ { "external_id": "OS", "name": "OS", "values": [ { "external_id": "9d5c5efb7c0f00a00fe4e3583f1215b0050bc723", "value": "Windows" } ] }, { "external_id": "genre", "name": "Genre", "values": [ { "external_id": "23fda05111c125608af8f1fa0e99db45a10ea1cc", "value": "Horror" } ] } ], "can_be_bought": true, "description": "Game description", "drm_name": "Steam", "drm_sku": "steam_key_1", "groups": [ { "external_id": "all", "item_order_in_group": 2, "name": "All games" }, { "external_id": "Xsolla", "item_order_in_group": 1, "name": "Xsolla games" } ], "has_keys": true, "image_url": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png", "is_free": false, "is_pre_order": true, "limits": null, "name": "Game name", "periods": [ { "date_from": "2020-08-11T10:00:00+03:00", "date_until": "2020-08-11T20:00:00+03:00" } ], "price": { "amount": "30.5", "amount_without_discount": "30.5", "currency": "USD" }, "promotions": [], "release_date": "2020-08-11T10:00:00+03:00", "sku": "com.xsolla.game_1", "type": "game_key", "virtual_prices": [] }, "properties": { "attributes": { "$ref": "#/components/schemas/Game-Keys_schemas-client-attributes" }, "can_be_bought": { "$ref": "#/components/schemas/Can_be_bought" }, "description": { "description": "아이템 설명입니다.", "example": "Game description", "type": "string" }, "drm_name": { "description": "DRM 이름입니다.", "example": "Steam", "type": "string" }, "drm_sku": { "description": "고유 DRM ID입니다. SKU는 소문자 및 대문자 라틴 영숫자, 마침표, 대시 및 밑줄만 포함할 수 있습니다.", "example": "steam_key_1", "type": "string" }, "groups": { "$ref": "#/components/schemas/items_client_groups_response" }, "has_keys": { "description": "`true`인 경우 게임 키에 판매용 키가 있습니다.", "example": false, "type": "boolean" }, "image_url": { "description": "이미지 URL입니다.", "example": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png", "type": "string" }, "is_free": { "$ref": "#/components/schemas/value-is_free" }, "is_pre_order": { "description": "`true`인 경우 사전 판매 게임 키이며 출시 날짜가 전달되지 않은 상태입니다.", "example": true, "type": "boolean" }, "limits": { "$ref": "#/components/schemas/Catalog_item_limits" }, "name": { "description": "아이템 이름입니다.", "example": "Game name", "type": "string" }, "periods": { "$ref": "#/components/schemas/item-periods" }, "price": { "description": "아이템 가격입니다.", "properties": { "amount": { "description": "할인된 아이템 가격입니다.", "example": "2.9900", "type": "string" }, "amount_without_discount": { "description": "아이템 가격입니다.", "example": "2.9900", "type": "string" }, "currency": { "description": "아이템 가격 통화입니다. [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)에 따른 3자리 코드입니다.", "example": "USD", "type": "string" } }, "type": "object" }, "promotions": { "$ref": "#/components/schemas/Catalog_item_promotions" }, "release_date": { "description": "ISO 8601 형식으로 된 게임 키 출시 날짜입니다.", "example": "2020-08-11T10:00:00+03:00", "type": "string" }, "sku": { "description": "고유 아이템 ID입니다. SKU는 소문자 및 대문자 라틴 영숫자, 마침표, 대시 및 밑줄만 포함할 수 있습니다.", "example": "com.xsolla.game_01", "type": "string" }, "type": { "description": "아이템의 유형: `game_key`.", "example": "game_key", "type": "string" }, "virtual_prices": { "description": "가상 가격입니다.", "items": { "description": "가상 가격입니다.", "properties": { "amount": { "description": "인게임 재화로 표시된 할인된 아이템 가격입니다.", "example": 100, "type": "integer" }, "amount_without_discount": { "description": "아이템 가격입니다.", "example": 200, "type": "integer" }, "description": { "description": "인게임 재화 설명입니다.", "example": "Big Rocket - description", "type": "string" }, "image_url": { "description": "인게임 재화의 이미지입니다.", "example": "http://image.png", "type": "string" }, "is_default": { "description": "아이템의 가격이 기본값인지 여부입니다.", "example": true, "type": "boolean" }, "name": { "description": "인게임 재화 이름입니다.", "example": "SHOTGUN FOR TRUE RAIDERS", "type": "string" }, "sku": { "description": "인게임 재화 아이템 SKU입니다.", "example": "com.xsolla.vc_1", "type": "string" }, "type": { "description": "인게임 재화 유형입니다.", "example": "virtual_currency", "type": "string" } }, "type": "object" }, "type": "array" } }, "type": "object" } } }, "description": "게임 키를 성공적으로 수신했습니다." }, "404": { "content": { "application/json": { "examples": { "response": { "value": { "errorCode": 4001, "errorMessage": "[0401-4001]: Item with sku = 'game_key_1' not found", "statusCode": 404 } } }, "schema": { "properties": { "errorCode": { "example": 4001, "type": "integer" }, "errorMessage": { "example": "[0401-4001]: Item with sku = 'game_key_1' not found", "type": "string" }, "statusCode": { "example": 404, "type": "integer" } }, "type": "object" } } }, "description": "게임 키를 찾을 수 없습니다." } }, "security": [ { "XsollaLoginUserJWT": [] } ], "summary": "카탈로그에 게임 키 가져오기", "tags": [ "game-keys-catalog" ], "x-badges": [ { "color": "#80eaff", "name": "Client-side" } ] } }, "/v2/project/{project_id}/items/game/sku/{item_sku}": { "get": { "description": "Gets a game for the catalog.\n
\n Note

\n This API call returns generic item catalog data when used without\n authorization. Use authorization to retrieve\n personalized\n user data, such as limits and promotions associated with the item.\n To do this, pass the user JWT in the Authorization header.\n For more information about user JWT, see the Security block\n for this call.\n
", "operationId": "get-game-by-sku", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "description": "아이템 SKU입니다.", "in": "path", "name": "item_sku", "required": true, "schema": { "default": "full_game_1", "type": "string" } }, { "$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": { "content": { "application/json": { "examples": { "response": { "value": { "attributes": [ { "external_id": "OS", "name": "OS", "values": [ { "external_id": "9d5c5efb7c0f00a00fe4e3583f1215b0050bc723", "value": "Windows" } ] }, { "external_id": "genre", "name": "Genre", "values": [ { "external_id": "9c5774997fc072b973bd5c231075c13841413f62", "value": "Casual, Logic" } ] } ], "description": "Game description", "groups": [ { "external_id": "all", "item_order_in_group": 2, "name": "All games" }, { "external_id": "Xsolla", "item_order_in_group": 1, "name": "Xsolla games" } ], "image_url": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png", "name": "Game name", "promotions": [], "sku": "com.xsolla.game_1", "type": "unit", "unit_items": [ { "can_be_bought": true, "drm_name": "Steam", "drm_sku": "steam_key_1", "has_keys": true, "is_free": false, "is_pre_order": true, "limits": null, "periods": [ { "date_from": "2020-08-11T10:00:00+03:00", "date_until": "2020-08-11T20:00:00+03:00" } ], "price": { "amount": "30.5", "amount_without_discount": "30.5", "currency": "USD" }, "promotions": [], "release_date": "2020-08-11T10:00:00+03:00", "sku": "com.xsolla.game_key_01", "type": "game_key", "virtual_prices": [], "vp_rewards": [ { "amount": 130, "image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg", "item_id": 175232, "name": "Value point", "sku": "com.xsolla.value_point_1" }, { "amount": 50, "image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg", "is_clan": true, "item_id": 186321, "name": "Clan Reward VP 1", "sku": "com.xsolla.clan_value_point_1" } ] }, { "can_be_bought": true, "drm_name": "Origin", "drm_sku": "origin_key_1", "has_keys": false, "is_free": false, "is_pre_order": false, "limits": null, "periods": [], "price": { "amount": "30.5", "amount_without_discount": "30.5", "currency": "USD" }, "promotions": [], "release_date": null, "sku": "com.xsolla.game_key_02", "type": "game_key", "virtual_prices": [], "vp_rewards": [] } ], "unit_type": "game" } } }, "schema": { "description": "게임 정보가 있는 개체입니다.", "properties": { "attributes": { "$ref": "#/components/schemas/Game-Keys_schemas-client-attributes" }, "description": { "description": "아이템 설명입니다.", "example": "Game description", "type": "string" }, "groups": { "$ref": "#/components/schemas/items_client_groups_response" }, "image_url": { "description": "이미지 URL입니다.", "example": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png", "type": "string" }, "name": { "description": "아이템 이름입니다.", "example": "Game name", "type": "string" }, "promotions": { "$ref": "#/components/schemas/Catalog_item_promotions" }, "sku": { "description": "고유 아이템 ID입니다. SKU는 소문자 및 대문자 라틴 영숫자, 마침표, 대시 및 밑줄만 포함할 수 있습니다.", "example": "game_01", "type": "string" }, "type": { "description": "아이템의 유형: `virtual_good`/`virtual_currency`/`bundle`/`physical_good`/`unit`.", "example": "unit", "type": "string" }, "unit_items": { "items": { "properties": { "can_be_bought": { "$ref": "#/components/schemas/Can_be_bought" }, "drm_name": { "description": "DRM 이름입니다.", "example": "Steam", "type": "string" }, "drm_sku": { "description": "고유 DRM ID입니다. SKU는 소문자 및 대문자 라틴 영숫자, 마침표, 대시 및 밑줄만 포함할 수 있습니다.", "example": "steam", "type": "string" }, "has_keys": { "description": "`true`인 경우 게임 키에 판매용 키가 있습니다.", "example": false, "type": "boolean" }, "is_free": { "$ref": "#/components/schemas/value-is_free" }, "is_pre_order": { "description": "`true`인 경우 사전 판매 게임 키이며 출시 날짜가 전달되지 않은 상태입니다.", "example": true, "type": "boolean" }, "limits": { "$ref": "#/components/schemas/Catalog_item_limits" }, "periods": { "$ref": "#/components/schemas/item-periods" }, "price": { "description": "아이템 가격입니다.", "properties": { "amount": { "description": "할인된 아이템 가격입니다.", "example": "2.9900", "type": "string" }, "amount_without_discount": { "description": "아이템 가격입니다.", "example": "2.9900", "type": "string" }, "currency": { "description": "아이템 가격 통화입니다. [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)에 따른 3자리 코드입니다.", "example": "USD", "type": "string" } }, "type": "object" }, "promotions": { "$ref": "#/components/schemas/Catalog_item_promotions" }, "release_date": { "description": "ISO 8601 형식으로 된 게임 키 출시 날짜입니다.", "example": "2020-08-11T10:00:00+03:00", "type": [ "string", "null" ] }, "sku": { "description": "고유 아이템 ID입니다. SKU는 소문자 및 대문자 라틴 영숫자, 마침표, 대시 및 밑줄만 포함할 수 있습니다.", "example": "game_01", "type": "string" }, "type": { "description": "아이템의 유형: `game_key`.", "example": "game_key", "type": "string" }, "virtual_prices": { "description": "가상 가격입니다.", "items": { "description": "가상 가격입니다.", "properties": { "amount": { "description": "인게임 재화로 표시된 할인된 아이템 가격입니다.", "example": 100, "type": "integer" }, "amount_without_discount": { "description": "아이템 가격입니다.", "example": 200, "type": "integer" }, "description": { "description": "인게임 재화 설명입니다.", "example": "Big Rocket - description", "type": "string" }, "image_url": { "description": "인게임 재화의 이미지입니다.", "example": "http://image.png", "type": "string" }, "is_default": { "description": "아이템의 가격이 기본값인지 여부입니다.", "example": true, "type": "boolean" }, "name": { "description": "인게임 재화 이름입니다.", "example": "SHOTGUN FOR TRUE RAIDERS", "type": "string" }, "sku": { "description": "인게임 재화 아이템 SKU입니다.", "example": "vc_test", "type": "string" }, "type": { "description": "인게임 재화 유형입니다.", "example": "virtual_currency", "type": "string" } }, "type": "object" }, "type": "array" }, "vp_rewards": { "$ref": "#/components/schemas/client-item-value-point-reward" } }, "type": "object" }, "type": "array" }, "unit_type": { "description": "유닛의 유형: `game`.", "example": "game", "type": "string" } }, "type": "object" } } }, "description": "게임을 성공적으로 수신했습니다." }, "404": { "content": { "application/json": { "examples": { "response": { "value": { "errorCode": 4001, "errorMessage": "[0401-4001]: Item with sku = 'game_1' not found", "statusCode": 404 } } }, "schema": { "properties": { "errorCode": { "example": 4001, "type": "integer" }, "errorMessage": { "example": "[0401-4001]: Item with sku = 'game_1' not found", "type": "string" }, "statusCode": { "example": 404, "type": "integer" } }, "type": "object" } } }, "description": "게임을 찾을 수 없습니다." } }, "security": [ { "XsollaLoginUserJWT": [] } ], "summary": "카탈로그에 게임 가져오기", "tags": [ "game-keys-catalog" ], "x-badges": [ { "color": "#80eaff", "name": "Client-side" } ] } }, "/v2/project/{project_id}/items/group/{external_id}": { "get": { "description": "Gets a sellable items list from the specified group for building a catalog.\n
\n Attention

\n All projects have the limitation to the number of items that you can\n get in the response. The default and maximum value is 50 items\n per response. To get more data page by page, use limit\n and offset fields.\n

\n Note

\n This API call returns generic item catalog data when used without\n authorization. Use authorization to retrieve\n personalized\n user data, such as limits and promotions associated with the item.\n To do this, pass the user JWT in the Authorization header.\n For more information about user JWT, see the Security block\n for this call.\n
", "operationId": "get-sellable-items-group", "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" } ], "responses": { "200": { "$ref": "#/components/responses/sellable_items_200-get-items-by-group-id" }, "404": { "$ref": "#/components/responses/Virtual-Items-Currency_404-item-group" } }, "security": [ { "XsollaLoginUserJWT": [] } ], "summary": "지정한 그룹으로 판매할 수 있는 아이템 목록 가져오기", "tags": [ "common-catalog" ], "x-badges": [ { "color": "#80eaff", "name": "Client-side" } ] } }, "/v2/project/{project_id}/items/groups": { "get": { "description": "Retrieves an item group list for building a catalog without pagination.\n
Note

The use of the item catalog API calls is available without authorization, but to get a personalized catalog, you must pass the user JWT in the Authorization header.
", "operationId": "get-item-groups", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/locale-query-param" }, { "$ref": "#/components/parameters/with_geo-query-param" } ], "responses": { "200": { "$ref": "#/components/responses/Virtual-Items-Currency_200-get-items-groups" } }, "security": [], "summary": "아이템 그룹 목록 가져오기", "tags": [ "item-groups-catalog" ], "x-badges": [ { "color": "#80eaff", "name": "Client-side" } ] } }, "/v2/project/{project_id}/items/id/{item_id}": { "get": { "description": "Gets a sellable item by its ID.\n
\n Note

\n This API call returns generic item catalog data when used without\n authorization. Use authorization to retrieve\n personalized\n user data, such as limits and promotions associated with the item.\n To do this, pass the user JWT in the Authorization header.\n For more information about user JWT, see the Security block\n for this call.\n
", "operationId": "get-sellable-item-by-id", "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" } ], "responses": { "200": { "$ref": "#/components/responses/sellable_items_200-get-item-by-id" }, "404": { "$ref": "#/components/responses/sellable-item-by-id_404" } }, "security": [ { "XsollaLoginUserJWT": [] } ], "summary": "ID를 사용하여 판매 가능한 아이템 가져오기", "tags": [ "common-catalog" ], "x-badges": [ { "color": "#80eaff", "name": "Client-side" } ] } }, "/v2/project/{project_id}/items/sku/{sku}": { "get": { "description": "Gets a sellable item by SKU for building a catalog.\n
\n Note

\n This API call returns generic item catalog data when used without\n authorization. Use authorization to retrieve\n personalized\n user data, such as limits and promotions associated with the item.\n To do this, pass the user JWT in the Authorization header.\n For more information about user JWT, see the Security block\n for this call.\n
", "operationId": "get-sellable-item-by-sku", "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" } ], "responses": { "200": { "$ref": "#/components/responses/sellable_items_200-get-item-by-id" }, "404": { "$ref": "#/components/responses/sellable-item-by-sku_404" } }, "security": [ { "XsollaLoginUserJWT": [] } ], "summary": "SKU로 판매할 수 있는 아이템 가져오기", "tags": [ "common-catalog" ], "x-badges": [ { "color": "#80eaff", "name": "Client-side" } ] } }, "/v2/project/{project_id}/items/virtual_currency": { "get": { "description": "Gets a virtual currency list for building a catalog.\n
\n Attention

\n All projects have the limitation to the number of items that you can\n get in the response. The default and maximum value is 50 items\n per response. To get more data page by page, use limit\n and offset fields.\n

\n Note

\n This API call returns generic item catalog data when used without\n authorization. Use authorization to retrieve\n personalized\n user data, such as limits and promotions associated with the item.\n To do this, pass the user JWT in the Authorization header.\n For more information about user JWT, see the Security block\n for this call.\n
", "operationId": "get-virtual-currency", "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/Virtual-Items-Currency_200-get-virtual-currency-list" } }, "security": [ { "XsollaLoginUserJWT": [] } ], "summary": "인게임 재화 목록 가져오기", "tags": [ "virtual-items-currency-catalog" ], "x-badges": [ { "color": "#80eaff", "name": "Client-side" } ] } }, "/v2/project/{project_id}/items/virtual_currency/package": { "get": { "description": "Gets a virtual currency packages list for building a catalog.\n
\n Attention

\n All projects have the limitation to the number of items that you can\n get in the response. The default and maximum value is 50 items\n per response. To get more data page by page, use limit\n and offset fields.\n

\n Note

\n This API call returns generic item catalog data when used without\n authorization. Use authorization to retrieve\n personalized\n user data, such as limits and promotions associated with the item.\n To do this, pass the user JWT in the Authorization header.\n For more information about user JWT, see the Security block\n for this call.\n
", "operationId": "get-virtual-currency-package", "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/Virtual-Items-Currency_200-get-virtual-currency-packages-list" } }, "security": [ { "XsollaLoginUserJWT": [] } ], "summary": "인게임 재화 패키지 목록 가져오기", "tags": [ "virtual-items-currency-catalog" ], "x-badges": [ { "color": "#80eaff", "name": "Client-side" } ] } }, "/v2/project/{project_id}/items/virtual_currency/package/sku/{virtual_currency_package_sku}": { "get": { "description": "Gets a virtual currency packages by SKU for building a catalog.\n
\n Note

\n This API call returns generic item catalog data when used without\n authorization. Use authorization to retrieve\n personalized\n user data, such as limits and promotions associated with the item.\n To do this, pass the user JWT in the Authorization header.\n For more information about user JWT, see the Security block\n for this call.\n
", "operationId": "get-virtual-currency-package-sku", "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" } ], "responses": { "200": { "$ref": "#/components/responses/Virtual-Items-Currency_200-get-virtual-currency-package" } }, "security": [ { "XsollaLoginUserJWT": [] } ], "summary": "SKU별 인게임 재화 패키지 받기", "tags": [ "virtual-items-currency-catalog" ], "x-badges": [ { "color": "#80eaff", "name": "Client-side" } ] } }, "/v2/project/{project_id}/items/virtual_currency/sku/{virtual_currency_sku}": { "get": { "description": "Gets a virtual currency by SKU for building a catalog.\n
\n Note

\n This API call returns generic item catalog data when used without\n authorization. Use authorization to retrieve\n personalized\n user data, such as limits and promotions associated with the item.\n To do this, pass the user JWT in the Authorization header.\n For more information about user JWT, see the Security block\n for this call.\n
", "operationId": "get-virtual-currency-sku", "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" } ], "responses": { "200": { "$ref": "#/components/responses/Virtual-Items-Currency_200-get-virtual-currency" } }, "security": [ { "XsollaLoginUserJWT": [] } ], "summary": "SKU별로 인게임 재화 가져오기", "tags": [ "virtual-items-currency-catalog" ], "x-badges": [ { "color": "#80eaff", "name": "Client-side" } ] } }, "/v2/project/{project_id}/items/virtual_items": { "get": { "description": "Gets a virtual items list for building a catalog.\n
\n Attention

\n All projects have the limitation to the number of items that you can\n get in the response. The default and maximum value is 50 items\n per response. To get more data page by page, use limit\n and offset fields.\n

\n Note

\n This API call returns generic item catalog data when used without\n authorization. Use authorization to retrieve\n personalized\n user data, such as limits and promotions associated with the item.\n To do this, pass the user JWT in the Authorization header.\n For more information about user JWT, see the Security block\n for this call.\n
", "operationId": "get-virtual-items", "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/Virtual-Items-Currency_200-get-items-list" } }, "security": [ { "XsollaLoginUserJWT": [] } ], "summary": "가상 아이템 목록 가져오기", "tags": [ "virtual-items-currency-catalog" ], "x-badges": [ { "color": "#80eaff", "name": "Client-side" } ] } }, "/v2/project/{project_id}/items/virtual_items/all": { "get": { "description": "Gets a list of all virtual items for searching on client-side.\n
\n Notice

\n Returns only item SKU, name, groups and description.\n

\n Note

\n This API call returns generic item catalog data when used without\n authorization. Use authorization to retrieve\n personalized\n user data, such as limits and promotions associated with the item.\n To do this, pass the user JWT in the Authorization header.\n For more information about user JWT, see the Security block\n for this call.\n
", "operationId": "get-all-virtual-items", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/locale-query-param" }, { "$ref": "#/components/parameters/promo_code-query-param" } ], "responses": { "200": { "$ref": "#/components/responses/Virtual-Items-Currency_200-get-all-items-list" } }, "security": [ { "XsollaLoginUserJWT": [] } ], "summary": "모든 가상 아이템 목록 가져오기", "tags": [ "virtual-items-currency-catalog" ], "x-badges": [ { "color": "#80eaff", "name": "Client-side" } ] } }, "/v2/project/{project_id}/items/virtual_items/group/{external_id}": { "get": { "description": "Gets an items list from the specified group for building a catalog.\n
\n Attention

\n All projects have the limitation to the number of items that you can\n get in the response. The default and maximum value is 50 items\n per response. To get more data page by page, use limit\n and offset fields.\n

\n Note

\n This API call returns generic item catalog data when used without\n authorization. Use authorization to retrieve\n personalized\n user data, such as limits and promotions associated with the item.\n To do this, pass the user JWT in the Authorization header.\n For more information about user JWT, see the Security block\n for this call.\n
", "operationId": "get-virtual-items-group", "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/Virtual-Items-Currency_200-get-items-by-group-id" }, "404": { "$ref": "#/components/responses/Virtual-Items-Currency_404-item-group" } }, "security": [ { "XsollaLoginUserJWT": [] } ], "summary": "지정한 그룹으로 아이템 목록 가져오기", "tags": [ "virtual-items-currency-catalog" ], "x-badges": [ { "color": "#80eaff", "name": "Client-side" } ] } }, "/v2/project/{project_id}/items/virtual_items/sku/{item_sku}": { "get": { "description": "Gets a virtual item by SKU for building a catalog.\n
\n Notice

\n This API call returns generic item\n catalog data when used without authorization. Use authorization to retrieve\n personalized\n user data, such as limits and promotions associated with the item.\n To do this, pass the user JWT in the Authorization header.\n For more information about user JWT, see the Security block\n for this call.\n
", "operationId": "get-virtual-items-sku", "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" } ], "responses": { "200": { "$ref": "#/components/responses/Virtual-Items-Currency_200-get-item-by-sku" }, "404": { "$ref": "#/components/responses/Virtual-Items-Currency_404-item" } }, "security": [ { "XsollaLoginUserJWT": [] } ], "summary": "SKU별로 가상 아이템 가져오기", "tags": [ "virtual-items-currency-catalog" ], "x-badges": [ { "color": "#80eaff", "name": "Client-side" } ] } }, "/v2/project/{project_id}/order/{order_id}": { "get": { "description": "지정한 주문을 검색합니다.", "operationId": "get-order", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/order_id-path-param" } ], "responses": { "200": { "$ref": "#/components/responses/Cart-Payment_200-get-order" }, "404": { "$ref": "#/components/responses/Cart-Payment_404-get-order" } }, "security": [ { "AuthForCart": [] } ], "summary": "주문 가져오기", "tags": [ "order" ], "x-badges": [ { "color": "#80eaff", "name": "Client-side" } ] } }, "/v2/project/{project_id}/payment/cart": { "post": { "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", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" } ], "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" } }, "security": [ { "AuthForCart": [] } ], "summary": "현재 장바구니의 모든 아이템을 사용하는 주문 생성", "tags": [ "payment-client-side" ], "x-badges": [ { "color": "#80eaff", "name": "Client-side" } ] } }, "/v2/project/{project_id}/payment/cart/{cart_id}": { "post": { "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", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/cart_id-path-param" } ], "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" } }, "security": [ { "AuthForCart": [] } ], "summary": "특정 장바구니의 모든 아이템으로 주문 생성", "tags": [ "payment-client-side" ], "x-badges": [ { "color": "#80eaff", "name": "Client-side" } ] } }, "/v2/project/{project_id}/payment/item/{item_sku}": { "post": { "description": "Used for client-to-server integration. Creates an order with a specified item and generates a payment token for it. The created order gets the `new` order status.\n\nThe client IP is used to determine the user’s country, which is then used to apply the corresponding currency and available payment methods for the order.\n\nTo open the payment UI in a new window, use the following link: `https://secure.xsolla.com/paystation4/?token={token}`, where `{token}` is the received token.\n\nFor testing purposes, use this URL: `https://sandbox-secure.xsolla.com/paystation4/?token={token}`.\n\n
Notice

As this method uses the IP to determine the user’s country and select a currency for the order, it is important to only use this method from the client side and not from the server side. Using this method from the server side may cause incorrect currency determination and affect payment methods in Pay Station.

\n Notice

\n This API call uses a user JWT for authorization.

\n Include the token in the Authorization header in the following format: Bearer <user_JWT>. For more information about user JWT, see the Security block for this call.\n
", "operationId": "create-order-with-item", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/item_sku-path-param" } ], "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" } }, "security": [ { "XsollaLoginUserJWT": [] } ], "summary": "특정 아이템을 사용하는 주문 생성", "tags": [ "payment-client-side" ], "x-badges": [ { "color": "#80eaff", "name": "Client-side" } ] } }, "/v2/project/{project_id}/payment/item/{item_sku}/virtual/{virtual_currency_sku}": { "post": { "description": "Creates item purchase using virtual currency.
\n Note

\n This API call returns generic item catalog data when used without\n authorization. Use authorization to retrieve\n personalized\n user data, such as limits and promotions associated with the item.\n To do this, pass the user JWT in the Authorization header.\n For more information about user JWT, see the Security block\n for this call.\n
", "operationId": "create-order-with-item-for-virtual-currency", "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" } ], "requestBody": { "content": { "application/json": { "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" } } ], "bool_param": true, "int_param": 100, "null_param": null, "object_param": { "key": "value" } } }, "schema": { "properties": { "custom_parameters": { "$ref": "#/components/schemas/Cart-Payment_custom_parameters" } }, "type": "object" } } } }, "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" } }, "security": [ { "XsollaLoginUserJWT": [] } ], "summary": "특정 아이템을 인게임 재화로 구매하는 주문 생성", "tags": [ "virtual-payment" ], "x-badges": [ { "color": "#80eaff", "name": "Client-side" } ] } }, "/v3/project/{project_id}/admin/order/search": { "post": { "description": "가장 빠른 생성 날짜부터 최근 생성 날짜 순으로 정렬된 주문 목록을 검색합니다.", "operationId": "admin-order-search", "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" } }, "security": [ { "basicAuth": [] } ], "summary": "지정된 기간의 주문 목록 가져오기", "tags": [ "order" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v3/project/{project_id}/admin/payment/token": { "post": { "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
", "operationId": "admin-create-payment-token", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" } ], "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" } }, "security": [ { "basicAuth": [] } ], "summary": "구매용 결제 토큰 생성하기", "tags": [ "payment-server-side" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" } ] } } }, "servers": [ { "url": "https://store.xsolla.com/api" } ], "tags": [ { "name": "virtual-items-currency-admin", "x-displayName": "관리자" }, { "name": "virtual-items-currency-catalog", "x-displayName": "카탈로그" }, { "name": "virtual-payment", "x-displayName": "가상 결제" }, { "name": "game-keys-catalog", "x-displayName": "카탈로그" }, { "name": "game-keys-entitlement", "x-displayName": "권한" }, { "name": "game-keys-admin", "x-displayName": "관리자" }, { "name": "bundles-admin", "x-displayName": "관리자" }, { "name": "bundles-catalog", "x-displayName": "카탈로그" }, { "name": "cart-client-side", "x-displayName": "장바구니(클라이언트 측)" }, { "name": "cart-server-side", "x-displayName": "장바구니(서버 측)" }, { "name": "payment-client-side", "x-displayName": "결제(클라이언트 측)" }, { "name": "payment-server-side", "x-displayName": "결제(서버 측)" }, { "name": "order", "x-displayName": "주문" }, { "name": "free-item", "x-displayName": "무료 아이템" }, { "name": "user-limits-admin", "x-displayName": "관리" }, { "name": "connector-admin", "x-displayName": "관리자" }, { "name": "common-pre-orders", "x-displayName": "선주문" }, { "name": "common-merchant", "x-displayName": "판매자" }, { "description": "이 API를 사용하면 모든 종류의 판매할 수 있는 아이템 또는 특정 아이템을 가져올 수 있습니다.", "name": "common-catalog", "x-displayName": "카탈로그" }, { "name": "common-regions", "x-displayName": "공통 지역" }, { "name": "attribute-admin", "x-displayName": "관리자" }, { "name": "item-groups-admin", "x-displayName": "관리자" }, { "name": "item-groups-catalog", "x-displayName": "카탈로그" } ], "x-tagGroups": [ { "name": "가상 아이템 및 인게임 재화", "tags": [ "virtual-items-currency-admin", "virtual-items-currency-catalog", "virtual-payment" ] }, { "name": "게임 키", "tags": [ "game-keys-catalog", "game-keys-entitlement", "game-keys-admin" ] }, { "name": "번들", "tags": [ "bundles-admin", "bundles-catalog" ] }, { "name": "장바구니 및 결제", "tags": [ "cart-client-side", "cart-server-side", "payment-client-side", "payment-server-side", "order", "free-item" ] }, { "name": "제한 사항", "tags": [ "user-limits-admin" ] }, { "name": "아이템 가져오기", "tags": [ "connector-admin" ] }, { "name": "일반", "tags": [ "common-pre-orders", "common-merchant", "common-catalog", "common-regions" ] }, { "name": "아이템 특성", "tags": [ "attribute-admin" ] }, { "name": "ITEM GROUPS", "tags": [ "item-groups-admin", "item-groups-catalog" ] } ] }