# Catalog API # Overview - **Version:** 2.0.0 - **Servers:** `https://store.xsolla.com/api` - [Contact Us by Email](mailto:integration@xsolla.com) - **Contact URL:** https://xsolla.com/ - **Required TLS version:** 1.2 The 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. The API allows you to manage the following catalog entities: * **Virtual items** — in-game items such as weapons, skins, boosters. * **Virtual currency** — virtual money used to purchase virtual goods. * **Virtual currency packages** — predefined bundles of virtual currency. * **Bundles** — combined packages of virtual items, currency, or game keys sold as a single SKU. * **Game keys** — keys for games and DLCs distributed via platforms like Steam or other DRM providers. * **Groups** — logical groupings for organizing and sorting items within the catalog. ## API calls The API is divided into the following groups: * **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. * **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. # Authentication API 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. ## Authentication using user's JWT User'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). 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: ``` eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHAiOjE5NjIyMzQwNDgsImlzcyI6Imh0dHBzOi8vbG9naW4ueHNvbGxhLmNvbSIsImlhdCI6MTU2MjE0NzY0OCwidXNlcm5hbWUiOiJ4c29sbGEiLCJ4c29sbGFfbG9naW5fYWNjZXNzX2tleSI6IjA2SWF2ZHpDeEVHbm5aMTlpLUc5TmMxVWFfTWFZOXhTR3ZEVEY4OFE3RnMiLCJzdWIiOiJkMzQyZGFkMi05ZDU5LTExZTktYTM4NC00MjAxMGFhODAwM2YiLCJlbWFpbCI6InN1cHBvcnRAeHNvbGxhLmNvbSIsInR5cGUiOiJ4c29sbGFfbG9naW4iLCJ4c29sbGFfbG9naW5fcHJvamVjdF9pZCI6ImU2ZGZhYWM2LTc4YTgtMTFlOS05MjQ0LTQyMDEwYWE4MDAwNCIsInB1Ymxpc2hlcl9pZCI6MTU5MjR9.GCrW42OguZbLZTaoixCZgAeNLGH2xCeJHxl8u8Xn2aI ``` Alternatively, you can use a [token for opening the payment UI](/ko/api/pay-station/token/create-token). ## Basic HTTP authentication Basic 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.
Note

The API key is confidential and must not be stored or used in client applications.
With basic server-side authentication, all API requests must include the following header: - for `basicAuth` — `Authorization: Basic `, where `your_authorization_basic_key` is the `project_id:api_key` pair encoded in Base64 - for `basicMerchantAuth` — `Authorization: Basic `, where `your_authorization_basic_key` is the `merchant_id:api_key` pair encoded in Base64 You can find the parameter values in [Publisher Account](https://publisher.xsolla.com/): - `merchant_id` is displayed: - In **Company settings > Company**. - In the URL in the browser address bar on any Publisher Account page. The URL has the following format: `https://publisher.xsolla.com/`. - `project_id` is displayed: - Next to the project name in Publisher Account. - 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/`. - `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: - [Company settings > API keys](https://publisher.xsolla.com/0/settings/api_key) - [Project settings > API key](https://publisher.xsolla.com/0/projects/0/edit/api_key)
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.
For more information about working with API keys, see the [API references](/ko/api/getting-started/#api_keys_overview). ## Authentication with guest access support The `AuthForCart` authentication scheme is used for cart purchases and supports two modes: 1. **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: ``` eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHAiOjE5NjIyMzQwNDgsImlzcyI6Imh0dHBzOi8vbG9naW4ueHNvbGxhLmNvbSIsImlhdCI6MTU2MjE0NzY0OCwidXNlcm5hbWUiOiJ4c29sbGEiLCJ4c29sbGFfbG9naW5fYWNjZXNzX2tleSI6IjA2SWF2ZHpDeEVHbm5aMTlpLUc5TmMxVWFfTWFZOXhTR3ZEVEY4OFE3RnMiLCJzdWIiOiJkMzQyZGFkMi05ZDU5LTExZTktYTM4NC00MjAxMGFhODAwM2YiLCJlbWFpbCI6InN1cHBvcnRAeHNvbGxhLmNvbSIsInR5cGUiOiJ4c29sbGFfbG9naW4iLCJ4c29sbGFfbG9naW5fcHJvamVjdF9pZCI6ImU2ZGZhYWM2LTc4YTgtMTFlOS05MjQ0LTQyMDEwYWE4MDAwNCIsInB1Ymxpc2hlcl9pZCI6MTU5MjR9.GCrW42OguZbLZTaoixCZgAeNLGH2xCeJHxl8u8Xn2aI ``` Alternatively, you can use a [token for opening the payment UI](/ko/api/pay-station/token/create-token). 2. **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: - `x-unauthorized-id` with a request ID - `x-user` with the user's email address encoded in Base64 ## Useful links - [API calls by interaction model](https://developers.xsolla.com/ko/api/catalog/) - [Endpoint types](https://developers.xsolla.com/ko/api/catalog/) - [Errors handling](https://developers.xsolla.com/ko/api/catalog/) - [API keys](https://developers.xsolla.com/ko/api/catalog/) # Core entity structure Items 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.
Note

Some calls may include additional fields but they don't change the basic structure.
**Identification** - `merchant_id` — company ID in [Publisher Account](https://publisher.xsolla.com/) - `project_id` — project ID in Publisher Account - `sku` — item SKU, unique within the project **Store display** - `name` — item name - `description` — item description - `image_url` — image URL - `is_enabled` — item availability - `is_show_in_store` — whether the item is displayed in the catalog For more information about managing item availability in the catalog, see the [documentation](/ko/items-catalog/catalog-features/items-availability/). **Organization** - `type` — item type, for example, a virtual item (`virtual_item`) or bundle (`bundle`) - `groups` — groups the item belongs to - `order` — display order in the catalog **Sale conditions** - `prices` — prices in real or virtual currency - `limits` — purchase limits - `periods` — availability periods - `regions` — regional restrictions **Example of core entity structure:** ```json { "attributes": [], "bundle_type": "virtual_currency_package", "content": [ { "description": { "en": "Main in-game currency" }, "image_url": "https://.../image.png", "name": { "en": "Crystals", "de": "Kristalle" }, "quantity": 500, "sku": "com.xsolla.crystal_2", "type": "virtual_currency" } ], "description": { "en": "Crystals x500" }, "groups": [], "image_url": "https://.../image.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": [] } ``` # Basic purchase flow The 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). The following example shows a basic flow for setting up and operating a store, from item creation to purchase. ## Create items and groups (Admin) Create an item catalog for your store, such as virtual items, bundles, or virtual currency. Example API calls: - [Create virtual item](/ko/api/catalog/virtual-items-currency-admin/admin-create-virtual-item) - [Create bundle](/ko/api/catalog/bundles-admin/admin-create-bundle) - [Create virtual currency](/ko/api/catalog/virtual-items-currency-admin/admin-create-virtual-currency) ## Set up promotions, chains, and limits (Admin) Configure user acquisition and monetization tools, such as discounts, bonuses, daily rewards, or offer chains. Example API calls: - [Create bonus promotion](/ko/api/liveops/promotions-bonuses/create-bonus-promotion) - [Create daily reward](/ko/api/liveops/daily-chain-admin/admin-create-daily-chain) - [Create unique catalog offer promotion](/ko/api/liveops/promotions-unique-catalog-offers/admin-create-unique-catalog-offer) ## Get item information (Client) Configure item display in your application.
Notice

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.

Example API calls: - [Get virtual items list](/ko/api/catalog/virtual-items-currency-catalog/get-virtual-items) - [Get item group list](/ko/api/catalog/virtual-items-currency-catalog/get-item-groups) - [Get list of bundles](/ko/api/catalog/bundles-catalog/get-bundle-list) - [Get sellable items list](/ko/api/catalog/common-catalog/get-sellable-items)
Note

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.
## Sell items You can sell items using the following methods: - Fast purchase — sell one SKU multiple times. - Cart purchase — the user adds items to the cart, removes items, and updates quantities within a single order. If 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. For 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. ### Fast purchase Use 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.
Note

Discount information is available to the user only in the payment UI. Promo codes are not supported.
### Cart purchase Cart setup and purchase can be performed on the client or on the server side. **Set up and purchase a cart on the client** Implement 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. Implement the following cart logic: 1. 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). 2. Update the cart contents based on user actions: - 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. - To remove an item, use the [Delete cart item by cart ID](/ko/api/shop-builder/operation/delete-item-by-cart-id/) API call.
Note

To get the current status of the cart, use the Get current user's cart API call.
3. 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. **Set up and purchase a cart on the server** This setup option may take longer for setting the cart up, since each change to the cart must be accompanied by API calls. Implement the following cart logic: 1. 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). 2. 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. ## Open payment UI Use 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). | Action | Endpoint | |:--------------------------------|:--------------------------------------------------------------------------| | Open in production environment. | https://secure.xsolla.com/paystation4/?token={token} | | Open in sandbox mode. | https://sandbox-secure.xsolla.com/paystation4/?token={token} |
Note

Use sandbox mode during development and testing. Test purchases don't charge real accounts. You can use test bank cards. 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). 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.
To 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. Possible order statuses: - `new` — order created - `paid` — payment received - `done` — item delivered - `canceled` — order canceled - `expired` — payment expired Track order status using one of the following methods: - [webhooks configured on your server](/ko/virtual-goods/own-ui/server-side-token-generation/set-up-order-tracking/#payments_integration_order_tracking) - [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) - [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) ## Useful links - Authentication - [API calls by interaction model](/ko/api/catalog/section/authentication) - [Payment testing](/ko/dev-resources/testing/general-info/#general_overview) - [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) - [Webhooks](/ko/webhooks/overview) - [Rate limits](/ko/api/login/rate-limits) - [Errors handling](/ko/api/getting-started/#api_errors_handling) - [API keys](/ko/api/getting-started/#api_keys_overview) # Pagination API 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. Use the following parameters to control the number of returned items: - `limit` — number of items per page - `offset` — index of the first item on the page (numbering starts from 0) - `has_more` — indicates whether another page is available - `total_items_count` — total number of items Example request: ``` GET /items?limit=20&offset=40 ``` Response example: ```json { "items": [...], "has_more": true, "total_items_count": 135 } ``` It is recommended to send subsequent requests until the response returns `has_more = false`. # Date and time format Dates and time values are passed in the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. The following are supported: - UTC offset - `null` value when there is no time restriction for displaying an item - [Unix timestamp](https://www.unixtimestamp.com/) (in seconds) used in some fields Format: `YYYY-MM-DDTHH:MM:SS±HH:MM` Example: `2026-03-16T10:00:00+03:00` # Localization Xsolla 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/). **Supported fields** Localization can be specified for the following parameters: - `name` - `description` - `long_description` **Locale format** The locale key can be specified in one of the following formats: - Two-letter language code: `en`, `ru` - Five-letter language code: `en-US`, `ru-RU`, `de-DE` **Examples** Example with a two-letter language code: ```json { "name": { "en": "Starter Pack", "ru": "Стартовый набор" } } ``` Example with a five-letter language code: ```json { "description": { "en-US": "Premium bundle", "de-DE": "Premium-Paket" } } ``` # Error response format If 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/). **Response example:** ```json { "errorCode": 1102, "errorMessage": "Validation error", "statusCode": 422, "transactionId": "c9e1a..." } ``` - `errorCode` — error code. - `errorMessage` — short error description. - `statusCode` — HTTP response status. - `transactionId` — request ID. Returned only in some cases. - `errorMessageExtended` — additional error details, such as request parameters. Returned only in some cases. **Extended response example:** ```json { "errorCode": 7001, "errorMessage": "Chain not found", "errorMessageExtended": { "chain_id": "test_chain_id", "project_id": "test_project_id", "step_number": 2 }, "statusCode": 404 } ``` **Common HTTP status codes** - `400` — invalid request - `401` — authentication error - `403` — insufficient permissions - `404` — resource not found - `422` — validation error - `429` — rate limit exceeded **Recommendations** - Handle the HTTP status and the response body together. - Use `errorCode` to process errors related to application logic. - Use `transactionId` to identify requests more quickly when analyzing errors. Version: 2.0.0 ## Servers ``` https://store.xsolla.com/api ``` ## Security ### AuthForCart 이 `AuthForCart` 인증 체계는 장바구니 구매에 사용되며 두 가지 모드를 지원합니다. 1. 사용자의 JWT로 인증. 토큰은 `Authorization: Bearer ` 형식으로 인증 헤더에 전달됩니다. ``는 사용자 토큰입니다. 이 토큰은 사용자를 식별하고 개인화된 데이터에 대한 액세스를 제공합니다. 다음 테스트 토큰을 사용하여 이 호출을 시도해 볼 수 있습니다. `Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHAiOjE5NjIyMzQwNDgsImlzcyI6Imh0dHBzOi8vbG9naW4ueHNvbGxhLmNvbSIsImlhdCI6MTU2MjE0NzY0OCwidXNlcm5hbWUiOiJ4c29sbGEiLCJ4c29sbGFfbG9naW5fYWNjZXNzX2tleSI6IjA2SWF2ZHpDeEVHbm5aMTlpLUc5TmMxVWFfTWFZOXhTR3ZEVEY4OFE3RnMiLCJzdWIiOiJkMzQyZGFkMi05ZDU5LTExZTktYTM4NC00MjAxMGFhODAwM2YiLCJlbWFpbCI6InN1cHBvcnRAeHNvbGxhLmNvbSIsInR5cGUiOiJ4c29sbGFfbG9naW4iLCJ4c29sbGFfbG9naW5fcHJvamVjdF9pZCI6ImU2ZGZhYWM2LTc4YTgtMTFlOS05MjQ0LTQyMDEwYWE4MDAwNCIsInB1Ymxpc2hlcl9pZCI6MTU5MjR9.GCrW42OguZbLZTaoixCZgAeNLGH2xCeJHxl8u8Xn2aI` 또는 [결제 UI를 여는 토큰](/ko/api/pay-station/token/create-token)을 사용할 수도 있습니다]. 2. `Authorization` 헤더가 없는 간소화된 모드. 이 모드는 인증되지 않은 사용자만 사용하며, [게임 키 판매](/ko/doc/buy-button/how-to/set-up-authentication/#guides_buy_button_selling_items_not_authenticated_users)에만 적용할 수 있습니다. 토큰 대신 요청에 다음 헤더를 포함해야 합니다. * 요청 ID와 `x-unauthorized-id` * Base64로 인코딩된 사용자의 이메일 주소와 `x-user`. Type: http Scheme: bearer ### XsollaLoginUserJWT 클라이언트 측 호출은 `XsollaLoginUserJWT` 인증 체계를 사용합니다. 요청에는 Bearer `` 형식으로 `Authorization` 헤더에 사용자의 JWT를 포함해야 합니다. 이 토큰은 사용자를 식별하고 개인화된 데이터에 대한 액세스 를 제공합니다. 토큰 생성 방법에 대한 자세한 내용은 [엑솔라 로그인 API 문서(/api/login/authentication-schemes#getting-user-token)를 참조하십시오. 테스트 토큰을 사용하여 이 호출을 시도해 볼 수 있습니다. `Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHAiOjE5NjIyMzQwNDgsImlzcyI6Imh0dHBzOi8vbG9naW4ueHNvbGxhLmNvbSIsImlhdCI6MTU2MjE0NzY0OCwidXNlcm5hbWUiOiJ4c29sbGEiLCJ4c29sbGFfbG9naW5fYWNjZXNzX2tleSI6IjA2SWF2ZHpDeEVHbm5aMTlpLUc5TmMxVWFfTWFZOXhTR3ZEVEY4OFE3RnMiLCJzdWIiOiJkMzQyZGFkMi05ZDU5LTExZTktYTM4NC00MjAxMGFhODAwM2YiLCJlbWFpbCI6InN1cHBvcnRAeHNvbGxhLmNvbSIsInR5cGUiOiJ4c29sbGFfbG9naW4iLCJ4c29sbGFfbG9naW5fcHJvamVjdF9pZCI6ImU2ZGZhYWM2LTc4YTgtMTFlOS05MjQ0LTQyMDEwYWE4MDAwNCIsInB1Ymxpc2hlcl9pZCI6MTU5MjR9.GCrW42OguZbLZTaoixCZgAeNLGH2xCeJHxl8u8Xn2aI` 또는 [결제 UI를 여는 토큰](/ko/api/pay-station/token/create-token)을 사용할 수 있습니다. Type: http Scheme: bearer Bearer Format: JWT ### basicAuth 서버측 호출은 `basicAuth` 인증 체계를 사용합니다. API에 대한 모든 요청에는 `Authorization: Basic ` 헤더가 포함되어야 하며 여기서 `your_authorization_basic_key`는 Base64 표준에 따라 인코딩된 `project_id:api_key` 쌍입니다. 필요한 경우 `project_id` 대신 `merchant_id`를 사용할 수 있습니다. 기능에는 영향을 미치지 않습니다. 다음과 같이 매개 변수 값을 확인하려면 [관리자 페이지](https://publisher.xsolla.com/)로 이동합니다. * `merchant_id` 다음과 같이 표시됩니다. * **회사 설정 > 회사** 섹션에서 * 관리자 페이지의 브라우저 주소 표시줄에 있는 URL에 있습니다. URL의 형식은 `https://publisher.xsolla.com/`입니다. * `api_key`는 관리자 페이지가 생성될 때 한 번만 표시되며 사용자 측에 저장해야 합니다. 다음 섹션에서 새 키를 만들 수 있습니다. * [회사 설정 > API 키](https://publisher.xsolla.com/0/settings/api_key) * [프로젝트 설정 > API 키](https://publisher.xsolla.com/0/projects/0/edit/api_key) {% html name="div" attrs={"class": "notice"} %} **주의** 필수 API 호출에 `project_id` 경로 매개 변수가 포함되어 있지 않은으면 인증 시 모든 회사 프로젝트에서 유효한 API 키를 사용하십시오. {% /html %} * **회사 설정 > API 키** * **프로젝트 설정 > API 키** * `project_id`는 다음과 같이 표시됩니다. * 프로젝트 이름 옆의 관리자 페이지에 있습니다. * 브라우저 주소 표시줄의 URL에서 관리자 페이지의 프로젝트 작업 시 URL의 형식은 `https://publisher.xsolla.com//projects/`입니다. API 키 작업에 대한 자세한 정보는 [API 레퍼런스](https://developers.xsolla.com/ko/api/getting-started/#api_keys_overview)를 참조하세요. Type: http Scheme: basic ### basicMerchantAuth 서버측 호출은 `basicMerchantAuth` 인증 체계를 사용합니다. API에 대한 모든 요청에는 `Authorization: Basic ` 헤더가 포함되어야 하며 여기서 `your_authorization_basic_key`는 Base64 표준에 따라 인코딩된 `merchant_id:api_key` 쌍입니다. 다음과 같이 매개 변수 값을 확인하려면 [관리자 페이지](https://publisher.xsolla.com/)로 이동합니다. * `merchant_id` 다음과 같이 표시됩니다. * **회사 설정 > 회사** 섹션에서 * 관리자 페이지의 브라우저 주소 표시줄에 있는 URL에 있습니다. URL의 형식은 `https://publisher.xsolla.com/`입니다. * `api_key`는 관리자 페이지가 생성될 때 한 번만 표시되며 사용자 측에 저장해야 합니다. 새 키는 [회사 설정 > API 키](https://publisher.xsolla.com/0/settings/api_key) 섹션에서 만들 수 있습니다. API 키 작업에 대한 자세한 정보는 [API 레퍼런스](https://developers.xsolla.com/ko/api/getting-started/#api_keys_overview)를 참조하세요. Type: http Scheme: basic ## Download OpenAPI description [Catalog API](https://developers.xsolla.com/_bundle/@l10n/ko/api/catalog/index.yaml) ## 관리자 ### 인게임 재화 목록 가져오기 - [GET /v2/project/{project_id}/admin/items/virtual_currency](https://developers.xsolla.com/ko/api/catalog/virtual-items-currency-admin/admin-get-virtual-currencies-list.md): 관리를 위해 프로젝트 내부의 인게임 재화 목록을 가져옵니다. 참고스토어 카탈로그를 빌드하기 위해 이 엔드포인트를 사용해선 안 됩니다. ### 인게임 재화 생성하기 - [POST /v2/project/{project_id}/admin/items/virtual_currency](https://developers.xsolla.com/ko/api/catalog/virtual-items-currency-admin/admin-create-virtual-currency.md): 인게임 재화를 생성합니다. ### 인게임 재화 패키지 목록 가져오기(관리자) - [GET /v2/project/{project_id}/admin/items/virtual_currency/package](https://developers.xsolla.com/ko/api/catalog/virtual-items-currency-admin/admin-get-virtual-currency-packages-list.md): 관리를 위해 프로젝트 내부의 인게임 재화 목록을 가져옵니다. 참고스토어 카탈로그를 빌드하기 위해 이 엔드포인트를 사용해선 안 됩니다. ### 인게임 재화 패키지 생성하기 - [POST /v2/project/{project_id}/admin/items/virtual_currency/package](https://developers.xsolla.com/ko/api/catalog/virtual-items-currency-admin/admin-create-virtual-currency-package.md): 인게임 재화 패키지를 생성합니다. ### 인게임 재화 패키지 삭제 - [DELETE /v2/project/{project_id}/admin/items/virtual_currency/package/sku/{item_sku}](https://developers.xsolla.com/ko/api/catalog/virtual-items-currency-admin/admin-delete-virtual-currency-package.md): 인게임 재화 패키지를 삭제합니다. ### 인게임 재화 패키지 가져오기 - [GET /v2/project/{project_id}/admin/items/virtual_currency/package/sku/{item_sku}](https://developers.xsolla.com/ko/api/catalog/virtual-items-currency-admin/admin-get-virtual-currency-package.md): 관리를 위해 프로젝트 내부의 인게임 재화 패키지를 가져옵니다. 참고스토어 카탈로그를 빌드하기 위해 이 엔드포인트를 사용해선 안 됩니다. ### 인게임 재화 패키지 업데이트 - [PUT /v2/project/{project_id}/admin/items/virtual_currency/package/sku/{item_sku}](https://developers.xsolla.com/ko/api/catalog/virtual-items-currency-admin/admin-update-virtual-currency-package.md): 인게임 재화 패키지 업데이트 ### 인게임 재화 삭제 - [DELETE /v2/project/{project_id}/admin/items/virtual_currency/sku/{virtual_currency_sku}](https://developers.xsolla.com/ko/api/catalog/virtual-items-currency-admin/admin-delete-virtual-currency.md): 인게임 재화를 삭제합니다. ### 인게임 재화 가져오기 - [GET /v2/project/{project_id}/admin/items/virtual_currency/sku/{virtual_currency_sku}](https://developers.xsolla.com/ko/api/catalog/virtual-items-currency-admin/admin-get-virtual-currency.md): 관리를 위해 프로젝트 내부의 인게임 재화를 가져옵니다. 참고스토어 카탈로그를 빌드하기 위해 이 엔드포인트를 사용해선 안 됩니다. ### 인게임 재화 업데이트 - [PUT /v2/project/{project_id}/admin/items/virtual_currency/sku/{virtual_currency_sku}](https://developers.xsolla.com/ko/api/catalog/virtual-items-currency-admin/admin-update-virtual-currency.md): 인게임 재화를 업데이트합니다. ### 가상 아이템 목록 가져오기 - [GET /v2/project/{project_id}/admin/items/virtual_items](https://developers.xsolla.com/ko/api/catalog/virtual-items-currency-admin/admin-get-virtual-items-list.md): 관리를 위해 프로젝트 내부의 가상 아이템 목록을 가져옵니다. 참고스토어 카탈로그를 빌드하기 위해 이 엔드포인트를 사용해선 안 됩니다. ### 가상 아이템 생성하기 - [POST /v2/project/{project_id}/admin/items/virtual_items](https://developers.xsolla.com/ko/api/catalog/virtual-items-currency-admin/admin-create-virtual-item.md): 가상 아이템을 생성합니다. ### 지정한 그룹 외부 ID로 가상 아이템 목록 가져오기 - [GET /v2/project/{project_id}/admin/items/virtual_items/group/external_id/{external_id}](https://developers.xsolla.com/ko/api/catalog/virtual-items-currency-admin/admin-get-virtual-items-list-by-group-external-id.md): 관리를 위해 그룹 내부의 가상 아이템 목록을 가져옵니다. 참고스토어 카탈로그를 빌드하기 위해 이 엔드포인트를 사용해선 안 됩니다. ### 지정한 그룹 ID로 가상 아이템 목록 가져오기 - [GET /v2/project/{project_id}/admin/items/virtual_items/group/id/{group_id}](https://developers.xsolla.com/ko/api/catalog/virtual-items-currency-admin/admin-get-virtual-items-list-by-group-id.md): 관리를 위해 그룹 내부의 가상 아이템 목록을 가져옵니다. 참고스토어 카탈로그를 빌드하기 위해 이 엔드포인트를 사용해선 안 됩니다. ### 가상 아이템 삭제 - [DELETE /v2/project/{project_id}/admin/items/virtual_items/sku/{item_sku}](https://developers.xsolla.com/ko/api/catalog/virtual-items-currency-admin/admin-delete-virtual-item.md): 가상 아이템을 삭제합니다. ### 가상 아이템 가져오기 - [GET /v2/project/{project_id}/admin/items/virtual_items/sku/{item_sku}](https://developers.xsolla.com/ko/api/catalog/virtual-items-currency-admin/admin-get-virtual-item.md): 관리를 위해 프로젝트 내부의 가상 아이템을 가져옵니다. 참고스토어 카탈로그를 빌드하기 위해 이 엔드포인트를 사용해선 안 됩니다. ### 가상 아이템 업데이트 - [PUT /v2/project/{project_id}/admin/items/virtual_items/sku/{item_sku}](https://developers.xsolla.com/ko/api/catalog/virtual-items-currency-admin/admin-update-virtual-item.md): 가상 아이템을 업데이트합니다. ## 카탈로그 ### 인게임 재화 목록 가져오기 - [GET /v2/project/{project_id}/items/virtual_currency](https://developers.xsolla.com/ko/api/catalog/virtual-items-currency-catalog/get-virtual-currency.md): Gets a virtual currency list for building a catalog. Attention All projects have the limitation to the number of items that you can get in the response. The default and maximum value is 50 items per response. To get more data page by page, use limit and offset fields. Note This API call returns generic item catalog data when used without authorization. Use authorization to retrieve personalized user data, such as limits and promotions associated with the item. To do this, pass the user JWT in the Authorization header. For more information about user JWT, see the Security block for this call. ### 인게임 재화 패키지 목록 가져오기 - [GET /v2/project/{project_id}/items/virtual_currency/package](https://developers.xsolla.com/ko/api/catalog/virtual-items-currency-catalog/get-virtual-currency-package.md): Gets a virtual currency packages list for building a catalog. Attention All projects have the limitation to the number of items that you can get in the response. The default and maximum value is 50 items per response. To get more data page by page, use limit and offset fields. Note This API call returns generic item catalog data when used without authorization. Use authorization to retrieve personalized user data, such as limits and promotions associated with the item. To do this, pass the user JWT in the Authorization header. For more information about user JWT, see the Security block for this call. ### SKU별 인게임 재화 패키지 받기 - [GET /v2/project/{project_id}/items/virtual_currency/package/sku/{virtual_currency_package_sku}](https://developers.xsolla.com/ko/api/catalog/virtual-items-currency-catalog/get-virtual-currency-package-sku.md): Gets a virtual currency packages by SKU for building a catalog. Note This API call returns generic item catalog data when used without authorization. Use authorization to retrieve personalized user data, such as limits and promotions associated with the item. To do this, pass the user JWT in the Authorization header. For more information about user JWT, see the Security block for this call. ### SKU별로 인게임 재화 가져오기 - [GET /v2/project/{project_id}/items/virtual_currency/sku/{virtual_currency_sku}](https://developers.xsolla.com/ko/api/catalog/virtual-items-currency-catalog/get-virtual-currency-sku.md): Gets a virtual currency by SKU for building a catalog. Note This API call returns generic item catalog data when used without authorization. Use authorization to retrieve personalized user data, such as limits and promotions associated with the item. To do this, pass the user JWT in the Authorization header. For more information about user JWT, see the Security block for this call. ### 가상 아이템 목록 가져오기 - [GET /v2/project/{project_id}/items/virtual_items](https://developers.xsolla.com/ko/api/catalog/virtual-items-currency-catalog/get-virtual-items.md): Gets a virtual items list for building a catalog. Attention All projects have the limitation to the number of items that you can get in the response. The default and maximum value is 50 items per response. To get more data page by page, use limit and offset fields. Note This API call returns generic item catalog data when used without authorization. Use authorization to retrieve personalized user data, such as limits and promotions associated with the item. To do this, pass the user JWT in the Authorization header. For more information about user JWT, see the Security block for this call. ### 모든 가상 아이템 목록 가져오기 - [GET /v2/project/{project_id}/items/virtual_items/all](https://developers.xsolla.com/ko/api/catalog/virtual-items-currency-catalog/get-all-virtual-items.md): Gets a list of all virtual items for searching on client-side. Notice Returns only item SKU, name, groups and description. Note This API call returns generic item catalog data when used without authorization. Use authorization to retrieve personalized user data, such as limits and promotions associated with the item. To do this, pass the user JWT in the Authorization header. For more information about user JWT, see the Security block for this call. ### 지정한 그룹으로 아이템 목록 가져오기 - [GET /v2/project/{project_id}/items/virtual_items/group/{external_id}](https://developers.xsolla.com/ko/api/catalog/virtual-items-currency-catalog/get-virtual-items-group.md): Gets an items list from the specified group for building a catalog. Attention All projects have the limitation to the number of items that you can get in the response. The default and maximum value is 50 items per response. To get more data page by page, use limit and offset fields. Note This API call returns generic item catalog data when used without authorization. Use authorization to retrieve personalized user data, such as limits and promotions associated with the item. To do this, pass the user JWT in the Authorization header. For more information about user JWT, see the Security block for this call. ### SKU별로 가상 아이템 가져오기 - [GET /v2/project/{project_id}/items/virtual_items/sku/{item_sku}](https://developers.xsolla.com/ko/api/catalog/virtual-items-currency-catalog/get-virtual-items-sku.md): Gets a virtual item by SKU for building a catalog. Notice This API call returns generic item catalog data when used without authorization. Use authorization to retrieve personalized user data, such as limits and promotions associated with the item. To do this, pass the user JWT in the Authorization header. For more information about user JWT, see the Security block for this call. ## 가상 결제 ### 특정 아이템을 인게임 재화로 구매하는 주문 생성 - [POST /v2/project/{project_id}/payment/item/{item_sku}/virtual/{virtual_currency_sku}](https://developers.xsolla.com/ko/api/catalog/virtual-payment/create-order-with-item-for-virtual-currency.md): Creates item purchase using virtual currency. Note This API call returns generic item catalog data when used without authorization. Use authorization to retrieve personalized user data, such as limits and promotions associated with the item. To do this, pass the user JWT in the Authorization header. For more information about user JWT, see the Security block for this call. ## 카탈로그 ### 게임 목록 가져오기 - [GET /v2/project/{project_id}/items/game](https://developers.xsolla.com/ko/api/catalog/game-keys-catalog/get-games-list.md): Gets a games list for building a catalog. Attention All projects have the limitation to the number of items that you can get in the response. The default and maximum value is 50 items per response. To get more data page by page, use limit and offset fields. Note This API call returns generic item catalog data when used without authorization. Use authorization to retrieve personalized user data, such as limits and promotions associated with the item. To do this, pass the user JWT in the Authorization header. For more information about user JWT, see the Security block for this call. ### DRM 목록 가져오기 - [GET /v2/project/{project_id}/items/game/drm](https://developers.xsolla.com/ko/api/catalog/game-keys-catalog/get-drm-list.md): 사용 가능한 DRM 목록을 가져옵니다. ### 지정한 그룹으로 게임 목록 가져오기 - [GET /v2/project/{project_id}/items/game/group/{external_id}](https://developers.xsolla.com/ko/api/catalog/game-keys-catalog/get-games-group.md): Gets a games list from the specified group for building a catalog. Attention All projects have the limitation to the number of items that you can get in the response. The default and maximum value is 50 items per response. To get more data page by page, use limit and offset fields. Note This API call returns generic item catalog data when used without authorization. Use authorization to retrieve personalized user data, such as limits and promotions associated with the item. To do this, pass the user JWT in the Authorization header. For more information about user JWT, see the Security block for this call. ### 지정한 그룹으로 게임 키 목록 가져오기 - [GET /v2/project/{project_id}/items/game/key/group/{external_id}](https://developers.xsolla.com/ko/api/catalog/game-keys-catalog/get-game-keys-group.md): Gets a game key list from the specified group for building a catalog. Attention All projects have the limitation to the number of items that you can get in the response. The default and maximum value is 50 items per response. To get more data page by page, use limit and offset fields. Note This API call returns generic item catalog data when used without authorization. Use authorization to retrieve personalized user data, such as limits and promotions associated with the item. To do this, pass the user JWT in the Authorization header. For more information about user JWT, see the Security block for this call. ### 카탈로그에 게임 키 가져오기 - [GET /v2/project/{project_id}/items/game/key/sku/{item_sku}](https://developers.xsolla.com/ko/api/catalog/game-keys-catalog/get-game-key-by-sku.md): Gets a game key for the catalog. Note This API call returns generic item catalog data when used without authorization. Use authorization to retrieve personalized user data, such as limits and promotions associated with the item. To do this, pass the user JWT in the Authorization header. For more information about user JWT, see the Security block for this call. ### 카탈로그에 게임 가져오기 - [GET /v2/project/{project_id}/items/game/sku/{item_sku}](https://developers.xsolla.com/ko/api/catalog/game-keys-catalog/get-game-by-sku.md): Gets a game for the catalog. Note This API call returns generic item catalog data when used without authorization. Use authorization to retrieve personalized user data, such as limits and promotions associated with the item. To do this, pass the user JWT in the Authorization header. For more information about user JWT, see the Security block for this call. ## 권한 ### 권한 부여(관리자) - [POST /v2/project/{project_id}/admin/entitlement/grant](https://developers.xsolla.com/ko/api/catalog/game-keys-entitlement/grant-entitlement-admin.md): 사용자에게 권한을 부여합니다. 주의DRM Free 플랫폼용 게임 코드 또는 게임에만 권한을 부여할 수 있습니다. ### 권한 취소(관리자) - [POST /v2/project/{project_id}/admin/entitlement/revoke](https://developers.xsolla.com/ko/api/catalog/game-keys-entitlement/revoke-entitlement-admin.md): 사용자의 권한을 취소합니다. 주의DRM Free 플랫폼용 게임 코드 또는 게임만 취소할 수 있습니다. ### 사용자가 소유한 게임 목록 가져오기 - [GET /v2/project/{project_id}/entitlement](https://developers.xsolla.com/ko/api/catalog/game-keys-entitlement/get-user-games.md): Get the list of games owned by the user. The response will contain an array of games owned by a particular user. Attention All projects have the limitation to the number of items that you can get in the response. The default and maximum value is 50 items per response. To get more data page by page, use limit and offset fields. Note This API call returns generic item catalog data when used without authorization. Use authorization to retrieve personalized user data, such as limits and promotions associated with the item. To do this, pass the user JWT in the Authorization header. For more information about user JWT, see the Security block for this call. ### 클라이언트로 게임 코드 사용하기 - [POST /v2/project/{project_id}/entitlement/redeem](https://developers.xsolla.com/ko/api/catalog/game-keys-entitlement/redeem-game-pin-code.md): Grants entitlement by a provided game code. Notice You can redeem codes only for the DRM-free platform. Note This API call returns generic item catalog data when used without authorization. Use authorization to retrieve personalized user data, such as limits and promotions associated with the item. To do this, pass the user JWT in the Authorization header. For more information about user JWT, see the Security block for this call. ## 관리자 ### 게임 목록 가져오기(관리자) - [GET /v2/project/{project_id}/admin/items/game](https://developers.xsolla.com/ko/api/catalog/game-keys-admin/admin-get-game-list.md): 관리를 위해 프로젝트 내부의 게임 목록을 가져옵니다. 게임은 사용자가 구매할 수 있는 게임 키로 구성되어 있습니다. 참고스토어 카탈로그를 빌드하기 위해 이 엔드포인트를 사용해선 안 됩니다. ### 게임 생성하기 - [POST /v2/project/{project_id}/admin/items/game](https://developers.xsolla.com/ko/api/catalog/game-keys-admin/admin-create-game.md): 프로젝트에서 게임을 생성합니다. ### ID로 게임 삭제 - [DELETE /v2/project/{project_id}/admin/items/game/id/{item_id}](https://developers.xsolla.com/ko/api/catalog/game-keys-admin/admin-delete-game-by-id.md): ID로 프로젝트의 게임을 삭제합니다. ### ID로 게임 가져오기(관리자) - [GET /v2/project/{project_id}/admin/items/game/id/{item_id}](https://developers.xsolla.com/ko/api/catalog/game-keys-admin/admin-get-game-by-id.md): 관리를 위해 게임을 가져옵니다. 게임은 사용자가 구매할 수 있는 게임 키로 구성되어 있습니다. 참고스토어 카탈로그를 빌드하기 위해 이 엔드포인트를 사용해선 안 됩니다. ### ID로 게임 업데이트 - [PUT /v2/project/{project_id}/admin/items/game/id/{item_id}](https://developers.xsolla.com/ko/api/catalog/game-keys-admin/admin-update-game-by-id.md): 프로젝트의 게임을 ID로 업데이트합니다. ### ID로 코드 삭제하기 - [DELETE /v2/project/{project_id}/admin/items/game/key/delete/id/{item_id}](https://developers.xsolla.com/ko/api/catalog/game-keys-admin/admin-delete-codes-by-id.md): 게임 키 ID로 모든 코드를 삭제합니다. ### 코드 삭제하기 - [DELETE /v2/project/{project_id}/admin/items/game/key/delete/sku/{item_sku}](https://developers.xsolla.com/ko/api/catalog/game-keys-admin/admin-delete-codes-by-sku.md): 게임 키 SKU로 모든 코드를 삭제합니다. ### ID로 코드 가져오기 - [GET /v2/project/{project_id}/admin/items/game/key/request/id/{item_id}](https://developers.xsolla.com/ko/api/catalog/game-keys-admin/admin-get-codes-by-id.md): 게임 키 ID로 특정 수의 코드를 가져옵니다. ### 코드 가져오기 - [GET /v2/project/{project_id}/admin/items/game/key/request/sku/{item_sku}](https://developers.xsolla.com/ko/api/catalog/game-keys-admin/admin-get-codes-by-sku.md): 게임 키 SKU로 특정 수의 코드를 가져옵니다. ### ID로 코드 업로드 - [POST /v2/project/{project_id}/admin/items/game/key/upload/id/{item_id}](https://developers.xsolla.com/ko/api/catalog/game-keys-admin/admin-upload-codes-by-id.md): 게임 키 ID로 코드를 업로드합니다. ### 세션 정보를 로드하는 코드 가져오기 - [GET /v2/project/{project_id}/admin/items/game/key/upload/session/{session_id}](https://developers.xsolla.com/ko/api/catalog/game-keys-admin/admin-get-codes-session.md): 세션 정보를 로드하는 코드를 가져옵니다. ### 코드 업로드 - [POST /v2/project/{project_id}/admin/items/game/key/upload/sku/{item_sku}](https://developers.xsolla.com/ko/api/catalog/game-keys-admin/admin-upload-codes-by-sku.md): 게임 키 SKU로 코드를 업로드합니다. ### SKU로 게임 삭제 - [DELETE /v2/project/{project_id}/admin/items/game/sku/{item_sku}](https://developers.xsolla.com/ko/api/catalog/game-keys-admin/admin-delete-game-by-sku.md): SKU로 프로젝트에 있는 게임을 삭제합니다. ### 게임 가져오기(관리자) - [GET /v2/project/{project_id}/admin/items/game/sku/{item_sku}](https://developers.xsolla.com/ko/api/catalog/game-keys-admin/admin-get-game-by-sku.md): 관리를 위해 게임을 가져옵니다. 게임은 사용자가 구매할 수 있는 게임 키로 구성되어 있습니다. 참고스토어 카탈로그를 빌드하기 위해 이 엔드포인트를 사용해선 안 됩니다. ### SKU로 게임 업데이트 - [PUT /v2/project/{project_id}/admin/items/game/sku/{item_sku}](https://developers.xsolla.com/ko/api/catalog/game-keys-admin/admin-update-game-by-sku.md): SKU로 프로젝트에 있는 게임을 업데이트합니다. ## 관리자 ### 번들 목록 가져오기 - [GET /v2/project/{project_id}/admin/items/bundle](https://developers.xsolla.com/ko/api/catalog/bundles-admin/admin-get-bundle-list.md): 관리를 위해 프로젝트 내부의 번들 목록을 가져옵니다. 참고스토어 카탈로그를 빌드하기 위해 이 엔드포인트를 사용해선 안 됩니다. ### 번들 생성하기 - [POST /v2/project/{project_id}/admin/items/bundle](https://developers.xsolla.com/ko/api/catalog/bundles-admin/admin-create-bundle.md): 번들을 생성합니다. ### 지정한 그룹 외부 ID로 번들 목록 가져오기 - [GET /v2/project/{project_id}/admin/items/bundle/group/external_id/{external_id}](https://developers.xsolla.com/ko/api/catalog/bundles-admin/admin-get-bundle-list-in-group-by-external-id.md): 관리를 위해 그룹 내부의 번들 목록을 가져옵니다. 참고스토어 카탈로그를 빌드하기 위해 이 엔드포인트를 사용해선 안 됩니다. ### 지정한 그룹 ID로 번들 목록 가져오기 - [GET /v2/project/{project_id}/admin/items/bundle/group/id/{group_id}](https://developers.xsolla.com/ko/api/catalog/bundles-admin/admin-get-bundle-list-in-group-by-id.md): 관리를 위해 그룹 내부의 번들 목록을 가져옵니다. 참고스토어 카탈로그를 빌드하기 위해 이 엔드포인트를 사용해선 안 됩니다. ### 번들 삭제 - [DELETE /v2/project/{project_id}/admin/items/bundle/sku/{sku}](https://developers.xsolla.com/ko/api/catalog/bundles-admin/admin-delete-bundle.md): 번들을 삭제합니다. ### 번들 가져오기 - [GET /v2/project/{project_id}/admin/items/bundle/sku/{sku}](https://developers.xsolla.com/ko/api/catalog/bundles-admin/admin-get-bundle.md): 관리를 위해 프로젝트 내부의 번들을 가져옵니다. 참고스토어 카탈로그를 빌드하기 위해 이 엔드포인트를 사용해선 안 됩니다. ### 번들 업데이트 - [PUT /v2/project/{project_id}/admin/items/bundle/sku/{sku}](https://developers.xsolla.com/ko/api/catalog/bundles-admin/admin-update-bundle.md): 번들을 업데이트합니다. ### 카탈로그에서 번들 숨기기 - [PUT /v2/project/{project_id}/admin/items/bundle/sku/{sku}/hide](https://developers.xsolla.com/ko/api/catalog/bundles-admin/admin-hide-bundle.md): 카탈로그에서 번들을 숨깁니다. ### 카탈로그에 번들 표시 - [PUT /v2/project/{project_id}/admin/items/bundle/sku/{sku}/show](https://developers.xsolla.com/ko/api/catalog/bundles-admin/admin-show-bundle.md): 카탈로그에 번들을 표시합니다. ## 카탈로그 ### 번들 목록 가져오기 - [GET /v2/project/{project_id}/items/bundle](https://developers.xsolla.com/ko/api/catalog/bundles-catalog/get-bundle-list.md): Gets a list of bundles for building a catalog. Attention All projects have the limitation to the number of items that you can get in the response. The default and maximum value is 50 items per response. To get more data page by page, use limit and offset fields. Note This API call returns generic item catalog data when used without authorization. Use authorization to retrieve personalized user data, such as limits and promotions associated with the item. To do this, pass the user JWT in the Authorization header. For more information about user JWT, see the Security block for this call. ### 지정한 그룹으로 번들 목록 가져오기 - [GET /v2/project/{project_id}/items/bundle/group/{external_id}](https://developers.xsolla.com/ko/api/catalog/bundles-catalog/get-bundle-list-in-group.md): Gets a list of bundles within a group for building a catalog. Attention All projects have the limitation to the number of items that you can get in the response. The default and maximum value is 50 items per response. To get more data page by page, use limit and offset fields. Note This API call returns generic item catalog data when used without authorization. Use authorization to retrieve personalized user data, such as limits and promotions associated with the item. To do this, pass the user JWT in the Authorization header. For more information about user JWT, see the Security block for this call. ### 지정한 번들 가져오기 - [GET /v2/project/{project_id}/items/bundle/sku/{sku}](https://developers.xsolla.com/ko/api/catalog/bundles-catalog/get-bundle.md): Gets a specified bundle. Note This API call returns generic item catalog data when used without authorization. Use authorization to retrieve personalized user data, such as limits and promotions associated with the item. To do this, pass the user JWT in the Authorization header. For more information about user JWT, see the Security block for this call. ## 장바구니(클라이언트 측) ### 현재 사용자의 장바구니 가져오기 - [GET /v2/project/{project_id}/cart](https://developers.xsolla.com/ko/api/catalog/cart-client-side/get-user-cart.md): 현재 사용자의 장바구니를 반환합니다. ### 현재 장바구니에서 모든 장바구니 아이템 삭제 - [PUT /v2/project/{project_id}/cart/clear](https://developers.xsolla.com/ko/api/catalog/cart-client-side/cart-clear.md): 모든 장바구니 아이템을 삭제합니다. ### 아이템으로 장바구니 채우기 - [PUT /v2/project/{project_id}/cart/fill](https://developers.xsolla.com/ko/api/catalog/cart-client-side/cart-fill.md): 장바구니를 아이템으로 채웁니다. 장바구니에 동일한 SKU를 가진 아이템이 이미 있으면 기존 아이템이 전달된 값으로 교체됩니다. ### 현재 장바구니에서 장바구니 아이템 삭제 - [DELETE /v2/project/{project_id}/cart/item/{item_sku}](https://developers.xsolla.com/ko/api/catalog/cart-client-side/delete-item.md): 장바구니에서 아이템을 제거합니다. ### 현재 장바구니에서 장바구니 아이템 업데이트 - [PUT /v2/project/{project_id}/cart/item/{item_sku}](https://developers.xsolla.com/ko/api/catalog/cart-client-side/put-item.md): 기존 장바구니 아이템을 업데이트하거나 장바구니에서 아이템을 생성합니다. ### 장바구니 ID로 장바구니 가져오기 - [GET /v2/project/{project_id}/cart/{cart_id}](https://developers.xsolla.com/ko/api/catalog/cart-client-side/get-cart-by-id.md): 장바구니 ID로 사용자의 장바구니를 반환합니다. ### 장바구니 ID로 모든 장바구니 아이템 삭제하기 - [PUT /v2/project/{project_id}/cart/{cart_id}/clear](https://developers.xsolla.com/ko/api/catalog/cart-client-side/cart-clear-by-id.md): 모든 장바구니 아이템을 삭제합니다. ### 아이템으로 특정 장바구니 채우기 - [PUT /v2/project/{project_id}/cart/{cart_id}/fill](https://developers.xsolla.com/ko/api/catalog/cart-client-side/cart-fill-by-id.md): 특정 장바구니를 아이템으로 채웁니다. 장바구니에 동일한 SKU를 가진 아이템이 이미 있으면 기존 아이템의 위치가 전달된 값으로 교체됩니다. ### 장바구니 ID로 장바구니 아이템 삭제하기 - [DELETE /v2/project/{project_id}/cart/{cart_id}/item/{item_sku}](https://developers.xsolla.com/ko/api/catalog/cart-client-side/delete-item-by-cart-id.md): 장바구니에서 아이템을 제거합니다. ### 장바구니 ID로 장바구니 아이템 업데이트하기 - [PUT /v2/project/{project_id}/cart/{cart_id}/item/{item_sku}](https://developers.xsolla.com/ko/api/catalog/cart-client-side/put-item-by-cart-id.md): 기존 장바구니 아이템을 업데이트하거나 장바구니에서 아이템을 생성합니다. ## 장바구니(서버 측) ### 아이템으로 장바구니 채우기 - [PUT /v2/admin/project/{project_id}/cart/fill](https://developers.xsolla.com/ko/api/catalog/cart-server-side/admin-cart-fill.md): 현재 장바구니를 아이템으로 채웁니다. 장바구니에 동일한 SKU를 가진 아이템이 이미 있으면 기존 아이템이 전달된 값으로 교체됩니다. ### 장바구니 ID를 사용하는 장바구니 아이템으로 채우기 - [PUT /v2/admin/project/{project_id}/cart/{cart_id}/fill](https://developers.xsolla.com/ko/api/catalog/cart-server-side/admin-fill-cart-by-id.md): 장바구니 ID별로 장바구니를 아이템으로 채웁니다. 장바구니에 동일한 SKU를 가진 아이템이 이미 있으면 기존 아이템이 전달된 값으로 교체됩니다. ## 결제(클라이언트 측) ### 현재 장바구니의 모든 아이템을 사용하는 주문 생성 - [POST /v2/project/{project_id}/payment/cart](https://developers.xsolla.com/ko/api/catalog/payment-client-side/create-order.md): 클라이언트-서버 연동에 사용됩니다. 특정 장바구니의 모든 아이템으로 주문을 생성하고 이에 대한 결제 토큰을 생성합니다. 생성된 주문은 new 주문 상태를 가져옵니다. 클라이언트 IP는 사용자의 국가를 확인하는 데 사용되며, 해당 통화 및 주문에 사용 사용할 수 있는 결제 방식을 적용하는 데 사용됩니다. 결제 UI를 새 창에서 열려면 https://secure.xsolla.com/paystation4/?token={token} 링크를 사용합니다. 여기서 {token}은 수신한 토큰입니다. 테스트를 진행할 때에는 https://sandbox-secure.xsolla.com/paystation4/?token={token} URL을 사용합니다. 참고이 방식은 IP를 사용하여 사용자의 국가를 확인하고 주문에 사용할 통화를 선택하므로 서버 측이 아닌 클라이언트 측에서만 이 방식을 사용해야 합니다. 서버 측에서 이 방식을 사용하면 통화가 잘못 결정되어 페이 스테이션의 결제 방식에 영향을 줄 수 있습니다. ### 특정 장바구니의 모든 아이템으로 주문 생성 - [POST /v2/project/{project_id}/payment/cart/{cart_id}](https://developers.xsolla.com/ko/api/catalog/payment-client-side/create-order-by-cart-id.md): 클라이언트-서버 연동에 사용됩니다. 특정 장바구니의 모든 아이템으로 주문을 생성하고 이에 대한 결제 토큰을 생성합니다. 생성된 주문은 new 주문 상태를 가져옵니다. 클라이언트 IP는 사용자의 국가를 확인하는 데 사용되며, 해당 통화 및 주문에 사용 사용할 수 있는 결제 방식을 적용하는 데 사용됩니다. 결제 UI를 새 창에서 열려면 https://secure.xsolla.com/paystation4/?token={token} 링크를 사용합니다. 여기서 {token}은 수신한 토큰입니다. 테스트를 진행할 때에는 https://sandbox-secure.xsolla.com/paystation4/?token={token} URL을 사용합니다. 참고이 방식은 IP를 사용하여 사용자의 국가를 확인하고 주문에 사용할 통화를 선택하므로 서버 측이 아닌 클라이언트 측에서만 이 방식을 사용해야 합니다. 서버 측에서 이 방식을 사용하면 통화가 잘못 결정되어 페이 스테이션의 결제 방식에 영향을 줄 수 있습니다. ### 특정 아이템을 사용하는 주문 생성 - [POST /v2/project/{project_id}/payment/item/{item_sku}](https://developers.xsolla.com/ko/api/catalog/payment-client-side/create-order-with-item.md): 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. The 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. To 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. For testing purposes, use this URL: https://sandbox-secure.xsolla.com/paystation4/?token={token}. 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. Notice This API call uses a user JWT for authorization. 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. ## 결제(서버 측) ### 구매용 결제 토큰 생성하기 - [POST /v3/project/{project_id}/admin/payment/token](https://developers.xsolla.com/ko/api/catalog/payment-server-side/admin-create-payment-token.md): 주문 및 주문에 대한 지불 토큰을 생성합니다. 주문은 요청 본문에 전달된 아이템에 기반하여 생성됩니다. 새 창에서 결제 UI를 열려면 https://secure.xsolla.com/paystation4/?token={token} 링크를 사용하십시오. 여기에서 {token}은 받은 토큰입니다. 테스트 목적으로 https://sandbox-secure.xsolla.com/paystation4/?token={token} URL을 사용합니다. 참고 user.country.value 매개 변수는 주문에 대한 통화를 선택하는 데 사용됩니다. 사용자의 국가를 알 수 없는 경우, 대신 X-User-Ip 헤더의 사용자 IP를 제공할 수 있습니다. 이 메서드가 적절히 작동하기 위해서는 두 가지 옵션 중 하나가 필요합니다. 선택한 통화는 페이 스테이션의 결제 방식에 사용됩니다. ## 주문 ### 주문 가져오기 - [GET /v2/project/{project_id}/order/{order_id}](https://developers.xsolla.com/ko/api/catalog/order/get-order.md): 지정한 주문을 검색합니다. ### 지정된 기간의 주문 목록 가져오기 - [POST /v3/project/{project_id}/admin/order/search](https://developers.xsolla.com/ko/api/catalog/order/admin-order-search.md): 가장 빠른 생성 날짜부터 최근 생성 날짜 순으로 정렬된 주문 목록을 검색합니다. ## 무료 아이템 ### 무료 장바구니로 주문 생성하기 - [POST /v2/project/{project_id}/free/cart](https://developers.xsolla.com/ko/api/catalog/free-item/create-free-order.md): 무료 장바구니의 모든 아이템으로 주문을 생성합니다. 생성된 주문은 done 주문 상태를 가져옵니다. ### 특정 무료 장바구니로 주문 생성하기 - [POST /v2/project/{project_id}/free/cart/{cart_id}](https://developers.xsolla.com/ko/api/catalog/free-item/create-free-order-by-cart-id.md): 특정 무료 장바구니의 모든 아이템으로 주문을 생성합니다. 생성된 주문은 done 주문 상태를 가져옵니다. ### 지정한 무료 아이템으로 주문 생성하기 - [POST /v2/project/{project_id}/free/item/{item_sku}](https://developers.xsolla.com/ko/api/catalog/free-item/create-free-order-with-item.md): Creates an order with a specified free item. The created order will get a done order status. Note This API call returns generic item catalog data when used without authorization. Use authorization to retrieve personalized user data, such as limits and promotions associated with the item. To do this, pass the user JWT in the Authorization header. For more information about user JWT, see the Security block for this call. ## 관리 ### 지정된 사용자의 모든 구매 제한 설정 새로고침 - [DELETE /v2/project/{project_id}/admin/user/limit/item/all](https://developers.xsolla.com/ko/api/catalog/user-limits-admin/reset-all-user-items-limit.md): 지정된 사용자가 해당 아이템을 다시 구매할 수 있도록 모든 아이템의 모든 구매 한도를 새로고침합니다. 사용자 제한 API를 사용하면 제한된 수량만 아이템을 판매할 수 있습니다. 구매 한도를 구성하려면 원하는 아이템 유형 모듈의 관리 섹션으로 이동합니다. * 게임 키 * 가상 아이템 및 인게임 재화 * 번들 ### 지정된 사용자가 사용할 수 있는 아이템 개수를 줄입니다 - [DELETE /v2/project/{project_id}/admin/user/limit/item/sku/{item_sku}](https://developers.xsolla.com/ko/api/catalog/user-limits-admin/remove-user-item-limit.md): 적용된 제한 설정 내에서 지정된 사용자가 사용할 수 있는 남은 아이템 개수를 줄입니다. 사용자 제한 API를 사용하면 제한된 수량만 아이템을 판매할 수 있습니다. 구매 한도를 구성하려면 원하는 아이템 유형 모듈의 관리 섹션으로 이동합니다. * 게임 키 * 가상 아이템 및 인게임 재화 * 번들 ### 지정된 사용자가 사용할 수 있는 아이템의 수량을 가져옵니다 - [GET /v2/project/{project_id}/admin/user/limit/item/sku/{item_sku}](https://developers.xsolla.com/ko/api/catalog/user-limits-admin/get-user-item-limit.md): 적용된 제한 설정 내에서 지정된 사용자가 사용할 수 있는 남은 아이템 개수를 가져옵니다. 사용자 제한 API를 사용하면 제한된 수량만 아이템을 판매할 수 있습니다. 구매 한도를 구성하려면 원하는 아이템 유형 모듈의 관리 섹션으로 이동합니다. * 게임 키 * 가상 아이템 및 인게임 재화 * 번들 ### 지정된 사용자가 사용할 수 있는 아이템의 수량을 늘립니다 - [POST /v2/project/{project_id}/admin/user/limit/item/sku/{item_sku}](https://developers.xsolla.com/ko/api/catalog/user-limits-admin/add-user-item-limit.md): 적용된 제한 설정 내에서 지정된 사용자가 사용할 수 있는 남은 아이템 개수를 늘립니다. 사용자 제한 API를 사용하면 제한된 수량만 아이템을 판매할 수 있습니다. 구매 한도를 구성하려면 원하는 아이템 유형 모듈의 관리 섹션으로 이동합니다. * 게임 키 * 가상 아이템 및 인게임 재화 * 번들 ### 지정된 사용자가 사용할 수 있는 아이템의 수량을 설정합니다 - [PUT /v2/project/{project_id}/admin/user/limit/item/sku/{item_sku}](https://developers.xsolla.com/ko/api/catalog/user-limits-admin/set-user-item-limit.md): 지정된 사용자가 제한 설정이 증가되거나 감소된 후 적용된 제한 설정 내에서 구매할 수 있는 아이템 개수를 설정합니다. 사용자 제한 API를 사용하면 제한된 수량만 아이템을 판매할 수 있습니다. 구매 한도를 구성하려면 원하는 아이템 유형 모듈의 관리 섹션으로 이동합니다. * 게임 키 * 가상 아이템 및 인게임 재화 * 번들 ### 구매 한도 새로고침 - [DELETE /v2/project/{project_id}/admin/user/limit/item/sku/{item_sku}/all](https://developers.xsolla.com/ko/api/catalog/user-limits-admin/reset-user-item-limit.md): 사용자가 아이템을 다시 구입할 수 있도록 아이템의 구매 한도를 새로고침합니다. user 매개변수가 null인 경우 이 호출은 모든 사용자에 대해 이 제한을 새로고침합니다. 사용자 제한 API를 사용하면 제한된 수량만 아이템을 판매할 수 있습니다. 구매 한도를 구성하려면 원하는 아이템 유형 모듈의 관리 섹션으로 이동합니다. * 게임 키 * 가상 아이템 및 인게임 재화 * 번들 ## 관리자 ### 아이템 가져오기 상태 검색 - [GET /v1/admin/projects/{project_id}/connectors/import_items/import/status](https://developers.xsolla.com/ko/api/catalog/connector-admin/get-items-import-status.md): 프로젝트로 아이템을 가져오는 진행률에 대한 정보를 검색합니다. 이 API 호출은 API 또는 관리자 페이지 API를 통해 수행된 마지막 가져오기에 대한 데이터를 검색합니다. ### JSON 파일을 통해 아이템 가져오기 - [POST /v1/projects/{project_id}/import/from_external_file](https://developers.xsolla.com/ko/api/catalog/connector-admin/import-items-from-external-file.md): 지정된 URL을 통해 JSON 파일에서 스토어로 아이템을 가져옵니다. JSON 파일에서 가져오기에 대한 자세한 정보는 설명서를 참조하세요. ## 선주문 ### 아이템의 사전 판매 수량 제한 제거 - [DELETE /v2/project/{project_id}/admin/items/pre_order/limit/item/sku/{item_sku}](https://developers.xsolla.com/ko/api/catalog/common-pre-orders/remove-pre-order-limit.md): 아이템의 사전 판매 수량 제한을 제거합니다. 사전 판매 제한 API를 사용하면 제한된 수량의 아이템을 판매할 수 있습니다. 사전 판매를 구성하려면 원하는 아이템 모듈의 관리자 섹션으로 이동합니다. * 게임 키 * 가상 아이템 및 인게임 재화 * 번들 이 엔드포인트의 별칭: * /v2/project/{project_id}/admin/items/pre_order/limit/item/id/{item_id} ### 아이템의 사전 판매 제한에 대한 정보 가져오기 - [GET /v2/project/{project_id}/admin/items/pre_order/limit/item/sku/{item_sku}](https://developers.xsolla.com/ko/api/catalog/common-pre-orders/get-pre-order-limit.md): 아이템의 사전 판매 수량 제한을 가져옵니다. 사전 판매 제한 API를 사용하면 제한된 수량의 아이템을 판매할 수 있습니다. 사전 판매를 구성하려면 원하는 아이템 모듈의 관리자 섹션으로 이동합니다. * 게임 키 * 가상 아이템 및 인게임 재화 * 번들 이 엔드포인트의 별칭: * /v2/project/{project_id}/admin/items/pre_order/limit/item/id/{item_id} ### 아이템 사전 판매 제한에 수량 추가하기 - [POST /v2/project/{project_id}/admin/items/pre_order/limit/item/sku/{item_sku}](https://developers.xsolla.com/ko/api/catalog/common-pre-orders/add-pre-order-limit.md): 아이템의 사전 판매 수량 제한에 수량을 추가합니다. 사전 판매 제한 API를 사용하면 제한된 수량의 아이템을 판매할 수 있습니다. 사전 판매를 구성하려면 원하는 아이템 모듈의 관리자 섹션으로 이동합니다. * 게임 키 * 가상 아이템 및 인게임 재화 * 번들 이 엔드포인트의 별칭: * /v2/project/{project_id}/admin/items/pre_order/limit/item/id/{item_id} ### 아이템의 사전 판매 수량 제한 설정 - [PUT /v2/project/{project_id}/admin/items/pre_order/limit/item/sku/{item_sku}](https://developers.xsolla.com/ko/api/catalog/common-pre-orders/set-pre-order-limit.md): 아이템의 사전 판매 수량 제한에 대한 수량을 설정합니다. 사전 판매 제한 API를 사용하면 제한된 수량의 아이템을 판매할 수 있습니다. 사전 판매를 구성하려면 원하는 아이템 모듈의 관리자 섹션으로 이동합니다. * 게임 키 * 가상 아이템 및 인게임 재화 * 번들 이 엔드포인트의 별칭: * /v2/project/{project_id}/admin/items/pre_order/limit/item/id/{item_id} ### 아이템의 모든 사전 판매 수량 제한 제거 - [DELETE /v2/project/{project_id}/admin/items/pre_order/limit/item/sku/{item_sku}/all](https://developers.xsolla.com/ko/api/catalog/common-pre-orders/remove-all-pre-order-limit.md): 아이템의 모든 사전 판매 수량 제한을 제거합니다. 사전 판매 제한 API를 사용하면 제한된 수량의 아이템을 판매할 수 있습니다. 사전 판매를 구성하려면 원하는 아이템 모듈의 관리자 섹션으로 이동합니다. * 게임 키 * 가상 아이템 및 인게임 재화 * 번들 이 엔드포인트의 별칭: * /v2/project/{project_id}/admin/items/pre_order/limit/item/id/{item_id} ### 아이템의 사전 판매 제한 토글 - [PUT /v2/project/{project_id}/admin/items/pre_order/limit/item/sku/{item_sku}/toggle](https://developers.xsolla.com/ko/api/catalog/common-pre-orders/toggle-pre-order-limit.md): 아이템의 사전 판매 수량 제한을 활성화/비활성화합니다. 사전 판매 제한 API를 사용하면 제한된 수량의 아이템을 판매할 수 있습니다. 사전 판매를 구성하려면 원하는 아이템 모듈의 관리자 섹션으로 이동합니다. * 게임 키 * 가상 아이템 및 인게임 재화 * 번들 이 엔드포인트의 별칭: * /v2/project/{project_id}/admin/items/pre_order/limit/item/id/{item_id} ## 판매자 ### 프로젝트 가져오기 - [GET /v2/merchant/{merchant_id}/projects](https://developers.xsolla.com/ko/api/catalog/common-merchant/get-projects.md): 판매자의 프로젝트 목록을 가져옵니다. 참고이 API 호출에는 project_id path 매개 변수가 포함되어 있지 않으므로 회사의 모든 프로젝트에서 유효한 API 키를 사용하여 권한 부여를 설정해야 합니다. ## 카탈로그 이 API를 사용하면 모든 종류의 판매할 수 있는 아이템 또는 특정 아이템을 가져올 수 있습니다. ### 판매할 수 있는 아이템 목록 가져오기 - [GET /v2/project/{project_id}/items](https://developers.xsolla.com/ko/api/catalog/common-catalog/get-sellable-items.md): Gets a sellable items list for building a catalog. Attention All projects have the limitation to the number of items that you can get in the response. The default and maximum value is 50 items per response. To get more data page by page, use limit and offset fields. Note This API call returns generic item catalog data when used without authorization. Use authorization to retrieve personalized user data, such as limits and promotions associated with the item. To do this, pass the user JWT in the Authorization header. For more information about user JWT, see the Security block for this call. ### 지정한 그룹으로 판매할 수 있는 아이템 목록 가져오기 - [GET /v2/project/{project_id}/items/group/{external_id}](https://developers.xsolla.com/ko/api/catalog/common-catalog/get-sellable-items-group.md): Gets a sellable items list from the specified group for building a catalog. Attention All projects have the limitation to the number of items that you can get in the response. The default and maximum value is 50 items per response. To get more data page by page, use limit and offset fields. Note This API call returns generic item catalog data when used without authorization. Use authorization to retrieve personalized user data, such as limits and promotions associated with the item. To do this, pass the user JWT in the Authorization header. For more information about user JWT, see the Security block for this call. ### ID를 사용하여 판매 가능한 아이템 가져오기 - [GET /v2/project/{project_id}/items/id/{item_id}](https://developers.xsolla.com/ko/api/catalog/common-catalog/get-sellable-item-by-id.md): Gets a sellable item by its ID. Note This API call returns generic item catalog data when used without authorization. Use authorization to retrieve personalized user data, such as limits and promotions associated with the item. To do this, pass the user JWT in the Authorization header. For more information about user JWT, see the Security block for this call. ### SKU로 판매할 수 있는 아이템 가져오기 - [GET /v2/project/{project_id}/items/sku/{sku}](https://developers.xsolla.com/ko/api/catalog/common-catalog/get-sellable-item-by-sku.md): Gets a sellable item by SKU for building a catalog. Note This API call returns generic item catalog data when used without authorization. Use authorization to retrieve personalized user data, such as limits and promotions associated with the item. To do this, pass the user JWT in the Authorization header. For more information about user JWT, see the Security block for this call. ## 공통 지역 ### 지역 목록 가져오기 - [GET /v2/project/{project_id}/admin/region](https://developers.xsolla.com/ko/api/catalog/common-regions/admin-get-regions.md): 지역 목록을 가져옵니다. 지역을 사용하여 지역 제한을 관리할 수 있습니다. ### 지역 생성하기 - [POST /v2/project/{project_id}/admin/region](https://developers.xsolla.com/ko/api/catalog/common-regions/admin-create-region.md): 지역을 생성합니다. 지역을 사용하여 지역 제한을 관리할 수 있습니다. ### 지역 삭제 - [DELETE /v2/project/{project_id}/admin/region/{region_id}](https://developers.xsolla.com/ko/api/catalog/common-regions/admin-delete-region.md): 특정 지역을 삭제합니다. ### 지역 가져오기 - [GET /v2/project/{project_id}/admin/region/{region_id}](https://developers.xsolla.com/ko/api/catalog/common-regions/admin-get-region.md): 특정 지역을 가져옵니다. 지역을 사용하여 지역 제한을 관리할 수 있습니다. ### 지역 업데이트 - [PUT /v2/project/{project_id}/admin/region/{region_id}](https://developers.xsolla.com/ko/api/catalog/common-regions/admin-update-region.md): 특정 지역을 업데이트합니다. 지역을 사용하여 지역 제한을 관리할 수 있습니다. ## 관리자 ### 특성 목록 가져오기(관리자) - [GET /v2/project/{project_id}/admin/attribute](https://developers.xsolla.com/ko/api/catalog/attribute-admin/admin-get-attribute-list.md): 관리 대상 프로젝트에서 특성 목록을 가져옵니다. ### 특성 생성하기 - [POST /v2/project/{project_id}/admin/attribute](https://developers.xsolla.com/ko/api/catalog/attribute-admin/admin-create-attribute.md): 특성을 생성합니다. ### 특성 삭제 - [DELETE /v2/project/{project_id}/admin/attribute/{external_id}](https://developers.xsolla.com/ko/api/catalog/attribute-admin/delete-attribute.md): 특성을 삭제합니다. 참고아이템 특성을 삭제하면 해당 아이템의 모든 데이터와 아이템 연결을 잃게 됩니다. ### 지정된 특성 가져오기 - [GET /v2/project/{project_id}/admin/attribute/{external_id}](https://developers.xsolla.com/ko/api/catalog/attribute-admin/admin-get-attribute.md): 지정된 특성을 가져옵니다. ### 특성 업데이트 - [PUT /v2/project/{project_id}/admin/attribute/{external_id}](https://developers.xsolla.com/ko/api/catalog/attribute-admin/admin-update-attribute.md): 특성을 업데이트합니다. ### 모든 특성 값 삭제 - [DELETE /v2/project/{project_id}/admin/attribute/{external_id}/value](https://developers.xsolla.com/ko/api/catalog/attribute-admin/admin-delete-all-attribute-value.md): 특성의 모든 값을 삭제합니다. 참고특성 값을 삭제하면 특성과 아이템 사이의 모든 연결이 끊어집니다. 아이템의 특성 값을 변경하려면 값을 삭제하고 새 값을 생성하는 대신특성 값 업데이트 API 호출을 사용하십시오. ### 특성 값 생성하기 - [POST /v2/project/{project_id}/admin/attribute/{external_id}/value](https://developers.xsolla.com/ko/api/catalog/attribute-admin/admin-create-attribute-value.md): 특성 값을 생성합니다. 주의모든 프로젝트는 특성 값의 수를 제한합니다. 기본값과 최대값은 특성당 20개입니다. ### 특성 값 삭제 - [DELETE /v2/project/{project_id}/admin/attribute/{external_id}/value/{value_external_id}](https://developers.xsolla.com/ko/api/catalog/attribute-admin/admin-delete-attribute-value.md): 특성 값을 삭제합니다. 참고특성 값을 삭제하면 특성과 아이템 사이의 모든 연결이 끊어집니다. 아이템의 특성 값을 변경하려면 값을 삭제하고 새 값을 생성하는 대신특성 값 업데이트 API 호출을 사용하십시오. ### 특성 값 업데이트 - [PUT /v2/project/{project_id}/admin/attribute/{external_id}/value/{value_external_id}](https://developers.xsolla.com/ko/api/catalog/attribute-admin/admin-update-attribute-value.md): 특성 값을 업데이트합니다. ## 관리자 ### Reorder items within a group (by ID) - [PUT /v2/project/{project_id}/admin/group/id/{id}/order/item](https://developers.xsolla.com/ko/api/catalog/item-groups-admin/admin-reorder-items-in-group-by-id.md): 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. ### Reorder item groups - [PUT /v2/project/{project_id}/admin/group/order](https://developers.xsolla.com/ko/api/catalog/item-groups-admin/admin-reorder-item-groups.md): Sets the display order for item groups within a project. Pass an array of groups with their new order values. ### Reorder items within a group (by external ID) - [PUT /v2/project/{project_id}/admin/group/{external_id}/order/item](https://developers.xsolla.com/ko/api/catalog/item-groups-admin/admin-reorder-items-in-group.md): Sets the display order of items within a group identified by its external ID. Pass an array of items with their new order values. ### 아이템 그룹 목록 가져오기 - [GET /v2/project/{project_id}/admin/items/groups](https://developers.xsolla.com/ko/api/catalog/item-groups-admin/admin-get-item-group-list.md): Retrieves the full list of item groups within a project without pagination. For administrative purposes. NoteDo not use this endpoint for building a store catalog. Use the Get item group list client-side endpoint instead. ### Create item group - [POST /v2/project/{project_id}/admin/items/groups](https://developers.xsolla.com/ko/api/catalog/item-groups-admin/admin-create-item-group.md): Creates an item group within a project. To retrieve item groups for building a catalog, use the Get item group list client-side endpoint. ### Delete item group - [DELETE /v2/project/{project_id}/admin/items/groups/{external_id}](https://developers.xsolla.com/ko/api/catalog/item-groups-admin/admin-delete-item-group.md): Deletes an item group by its external ID. ### Get item group by external ID - [GET /v2/project/{project_id}/admin/items/groups/{external_id}](https://developers.xsolla.com/ko/api/catalog/item-groups-admin/admin-get-item-group.md): Retrieves an item group by its external ID for administrative purposes. NoteDo not use this endpoint for building a store catalog. Use the Get item group list client-side endpoint instead. ### Update item group - [PUT /v2/project/{project_id}/admin/items/groups/{external_id}](https://developers.xsolla.com/ko/api/catalog/item-groups-admin/admin-update-item-group.md): Updates an item group by its external ID. ### Get item group list filtered by item type - [GET /v2/project/{project_id}/admin/items/{item_type}/groups](https://developers.xsolla.com/ko/api/catalog/item-groups-admin/admin-get-item-group-list-by-item-type.md): 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 endpoint, with additional filtering of items by type when counting them. ### Get item group by external ID filtered by item type - [GET /v2/project/{project_id}/admin/items/{item_type}/groups/{external_id}](https://developers.xsolla.com/ko/api/catalog/item-groups-admin/admin-get-item-group-by-item-type.md): 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 endpoint, with additional filtering of items by type when counting them. ## 카탈로그 ### 아이템 그룹 목록 가져오기 - [GET /v2/project/{project_id}/items/groups](https://developers.xsolla.com/ko/api/catalog/item-groups-catalog/get-item-groups.md): Retrieves an item group list for building a catalog without pagination. NoteThe 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.