# 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

Catalog API provides endpoints to manage your in-game store catalog and process purchases.
Use the endpoints to configure virtual items, virtual currencies, game keys, bundles,
cart and payment flows, item attributes, and import items from external sources.

Version: 2.0.0

## Servers

```
https://store.xsolla.com/api
```

## Security

### basicAuth

Xsolla API uses basic access authentication. All requests to API must
contain the `Authorization: Basic <your_authorization_basic_key>`
header, where `your_authorization_basic_key` is the `project_id:api_key`
pair encoded according to the Base64 standard.

You can use `merchant_id` instead of `project_id` if you need. It doesn't affect functionality.

Go to [Publisher Account](https://publisher.xsolla.com/) to find values of the parameters:

* `merchant_id` is shown:
  * In the **Company settings > Company** section
  * In the URL in the browser address bar on any Publisher Account page. The URL has the following format: `https://publisher.xsolla.com/<merchant_id>`.
* `api_key` is shown in Publisher Account only once when it is created and must be stored on your side. You can create a new key in the following section:
  * **Company settings > API keys**
  * **Project settings > API keys**
* `project_id` is shown:
  * In Publisher Account next to the name of the project.
  * In the URL in the browser address bar when working on project in Publisher Account. The URL has the following format: `https://publisher.xsolla.com/<merchant_id>/projects/<project_id>`.

For more information about working with API keys, see the [API reference](https://developers.xsolla.com/api/getting-started/#api_keys_overview).


Type: http
Scheme: basic

### XsollaLoginUserJWT

By default, the Xsolla Login User JWT (Bearer token) is used for authorization. You can try calling this endpoint with a test Xsolla Login User JWT token: `Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHAiOjE5NjIyMzQwNDgsImlzcyI6Imh0dHBzOi8vbG9naW4ueHNvbGxhLmNvbSIsImlhdCI6MTU2MjE0NzY0OCwidXNlcm5hbWUiOiJ4c29sbGEiLCJ4c29sbGFfbG9naW5fYWNjZXNzX2tleSI6IjA2SWF2ZHpDeEVHbm5aMTlpLUc5TmMxVWFfTWFZOXhTR3ZEVEY4OFE3RnMiLCJzdWIiOiJkMzQyZGFkMi05ZDU5LTExZTktYTM4NC00MjAxMGFhODAwM2YiLCJlbWFpbCI6InN1cHBvcnRAeHNvbGxhLmNvbSIsInR5cGUiOiJ4c29sbGFfbG9naW4iLCJ4c29sbGFfbG9naW5fcHJvamVjdF9pZCI6ImU2ZGZhYWM2LTc4YTgtMTFlOS05MjQ0LTQyMDEwYWE4MDAwNCIsInB1Ymxpc2hlcl9pZCI6MTU5MjR9.GCrW42OguZbLZTaoixCZgAeNLGH2xCeJHxl8u8Xn2aI`.

You can use the [Pay Station access token](https://developers.xsolla.com/api/pay-station/operation/create-token/) as an alternative.

Type: http
Scheme: bearer
Bearer Format: JWT

### AuthForCart

When selling a cart with games, you can [call the endpoint without authorization](/doc/buy-button/how-to/set-up-authentication/#guides_buy_button_selling_items_not_authenticated_users).

To do this:

* Add a unique identifier to the `x-unauthorized-id` parameter in the header for games.
* Add user’s email to the `x-user` parameter (Base64 encoded) in the header for games.

By default, the Xsolla Login User JWT (Bearer token) is used for authorization. You can try calling this endpoint with a test Xsolla Login User JWT token: `Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHAiOjE5NjIyMzQwNDgsImlzcyI6Imh0dHBzOi8vbG9naW4ueHNvbGxhLmNvbSIsImlhdCI6MTU2MjE0NzY0OCwidXNlcm5hbWUiOiJ4c29sbGEiLCJ4c29sbGFfbG9naW5fYWNjZXNzX2tleSI6IjA2SWF2ZHpDeEVHbm5aMTlpLUc5TmMxVWFfTWFZOXhTR3ZEVEY4OFE3RnMiLCJzdWIiOiJkMzQyZGFkMi05ZDU5LTExZTktYTM4NC00MjAxMGFhODAwM2YiLCJlbWFpbCI6InN1cHBvcnRAeHNvbGxhLmNvbSIsInR5cGUiOiJ4c29sbGFfbG9naW4iLCJ4c29sbGFfbG9naW5fcHJvamVjdF9pZCI6ImU2ZGZhYWM2LTc4YTgtMTFlOS05MjQ0LTQyMDEwYWE4MDAwNCIsInB1Ymxpc2hlcl9pZCI6MTU5MjR9.GCrW42OguZbLZTaoixCZgAeNLGH2xCeJHxl8u8Xn2aI`.

You can use the [Pay Station access token](https://developers.xsolla.com/api/pay-station/operation/create-token/) as an alternative.


Type: http
Scheme: bearer

### basicMerchantAuth

Xsolla API uses basic access authentication. All requests to API must
contain the `Authorization: Basic <your_authorization_basic_key>`
header, where `your_authorization_basic_key` is the `merchant_id:api_key`
pair encoded according to the Base64 standard.

Go to [Publisher Account](https://publisher.xsolla.com/) to find values of the parameters:

* `merchant_id` is shown:
  * In the **Company settings > Company** section
  * In the URL in the browser address bar on any Publisher Account page. The URL has the following format: `https://publisher.xsolla.com/<merchant_id>`
* `api_key` is shown in Publisher Account only once when it is created and must be stored on your side. You can create a new key in the following section:
  * **Company settings > API keys**
  * **Project settings > API keys**

For more information about working with API keys, see the [API reference](https://developers.xsolla.com/api/getting-started/#api_keys_overview).


Type: http
Scheme: basic

## Download OpenAPI description

[Catalog API](https://developers.xsolla.com/_bundle/api/catalog/index.yaml)

## Admin

### Get list of virtual items

 - [GET /v2/project/{project_id}/admin/items/virtual_items](https://developers.xsolla.com/api/catalog/virtual-items-currency-admin/admin-get-virtual-items-list.md): Gets the list of virtual items within a project for administration.

NoteDo not use this endpoint for building a store catalog.

### Create virtual item

 - [POST /v2/project/{project_id}/admin/items/virtual_items](https://developers.xsolla.com/api/catalog/virtual-items-currency-admin/admin-create-virtual-item.md): Creates a virtual item.

### Get list of virtual items by specified group external id

 - [GET /v2/project/{project_id}/admin/items/virtual_items/group/external_id/{external_id}](https://developers.xsolla.com/api/catalog/virtual-items-currency-admin/admin-get-virtual-items-list-by-group-external-id.md): Gets the list of virtual items within a group for administration.

NoteDo not use this endpoint for building a store catalog.

### Get list of virtual items by specified group id

 - [GET /v2/project/{project_id}/admin/items/virtual_items/group/id/{group_id}](https://developers.xsolla.com/api/catalog/virtual-items-currency-admin/admin-get-virtual-items-list-by-group-id.md): Gets the list of virtual items within a group for administration.

NoteDo not use this endpoint for building a store catalog.

### Get virtual item

 - [GET /v2/project/{project_id}/admin/items/virtual_items/sku/{item_sku}](https://developers.xsolla.com/api/catalog/virtual-items-currency-admin/admin-get-virtual-item.md): Gets the virtual item within a project for administration.

NoteDo not use this endpoint for building a store catalog.

### Update virtual item

 - [PUT /v2/project/{project_id}/admin/items/virtual_items/sku/{item_sku}](https://developers.xsolla.com/api/catalog/virtual-items-currency-admin/admin-update-virtual-item.md): Updates a virtual item.

### Delete virtual item

 - [DELETE /v2/project/{project_id}/admin/items/virtual_items/sku/{item_sku}](https://developers.xsolla.com/api/catalog/virtual-items-currency-admin/admin-delete-virtual-item.md): Deletes a virtual item.

### Get list of virtual currencies

 - [GET /v2/project/{project_id}/admin/items/virtual_currency](https://developers.xsolla.com/api/catalog/virtual-items-currency-admin/admin-get-virtual-currencies-list.md): Gets the list of virtual currencies within a project for administration.

NoteDo not use this endpoint for building a store catalog.

### Create virtual currency

 - [POST /v2/project/{project_id}/admin/items/virtual_currency](https://developers.xsolla.com/api/catalog/virtual-items-currency-admin/admin-create-virtual-currency.md): Creates a virtual currency.

### Get virtual currency

 - [GET /v2/project/{project_id}/admin/items/virtual_currency/sku/{virtual_currency_sku}](https://developers.xsolla.com/api/catalog/virtual-items-currency-admin/admin-get-virtual-currency.md): Gets the virtual currency within a project for administration.

NoteDo not use this endpoint for building a store catalog.

### Update virtual currency

 - [PUT /v2/project/{project_id}/admin/items/virtual_currency/sku/{virtual_currency_sku}](https://developers.xsolla.com/api/catalog/virtual-items-currency-admin/admin-update-virtual-currency.md): Updates a virtual currency.

### Delete virtual currency

 - [DELETE /v2/project/{project_id}/admin/items/virtual_currency/sku/{virtual_currency_sku}](https://developers.xsolla.com/api/catalog/virtual-items-currency-admin/admin-delete-virtual-currency.md): Deletes a virtual currency.

### Get list of virtual currency packages (admin)

 - [GET /v2/project/{project_id}/admin/items/virtual_currency/package](https://developers.xsolla.com/api/catalog/virtual-items-currency-admin/admin-get-virtual-currency-packages-list.md): Gets the list of virtual currency packages within a project for administration.

NoteDo not use this endpoint for building a store catalog.

### Create virtual currency package

 - [POST /v2/project/{project_id}/admin/items/virtual_currency/package](https://developers.xsolla.com/api/catalog/virtual-items-currency-admin/admin-create-virtual-currency-package.md): Creates a virtual currency package.

### Update virtual currency package

 - [PUT /v2/project/{project_id}/admin/items/virtual_currency/package/sku/{item_sku}](https://developers.xsolla.com/api/catalog/virtual-items-currency-admin/admin-update-virtual-currency-package.md): Updates a virtual currency package.

### Delete virtual currency package

 - [DELETE /v2/project/{project_id}/admin/items/virtual_currency/package/sku/{item_sku}](https://developers.xsolla.com/api/catalog/virtual-items-currency-admin/admin-delete-virtual-currency-package.md): Deletes a virtual currency package.

### Get virtual currency package

 - [GET /v2/project/{project_id}/admin/items/virtual_currency/package/sku/{item_sku}](https://developers.xsolla.com/api/catalog/virtual-items-currency-admin/admin-get-virtual-currency-package.md): Gets the virtual currency package within a project for administration.

NoteDo not use this endpoint for building a store catalog.

## Catalog

### Get virtual items list

 - [GET /v2/project/{project_id}/items/virtual_items](https://developers.xsolla.com/api/catalog/virtual-items-currency-catalog/get-virtual-items.md): Gets a virtual items list for building a catalog.

AttentionAll 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.  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.

### Get virtual item by SKU

 - [GET /v2/project/{project_id}/items/virtual_items/sku/{item_sku}](https://developers.xsolla.com/api/catalog/virtual-items-currency-catalog/get-virtual-items-sku.md): Gets a virtual item by SKU for building a catalog.
NoteThis endpoint, accessible without authorization, returns generic data. However, authorization enriches the response with user-specific details for a personalized result, such as available user limits and promotions.

### Get all virtual items list

 - [GET /v2/project/{project_id}/items/virtual_items/all](https://developers.xsolla.com/api/catalog/virtual-items-currency-catalog/get-all-virtual-items.md): Gets a list of all virtual items for searching on client-side.

AttentionReturns only item SKU, name, groups and description  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.

### Get virtual currency list

 - [GET /v2/project/{project_id}/items/virtual_currency](https://developers.xsolla.com/api/catalog/virtual-items-currency-catalog/get-virtual-currency.md): Gets a virtual currency list for building a catalog.

AttentionAll 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.  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.

### Get virtual currency by SKU

 - [GET /v2/project/{project_id}/items/virtual_currency/sku/{virtual_currency_sku}](https://developers.xsolla.com/api/catalog/virtual-items-currency-catalog/get-virtual-currency-sku.md): Gets a virtual currency by SKU for building a catalog.
NoteThis endpoint, accessible without authorization, returns generic data. However, authorization enriches the response with user-specific details for a personalized result, such as available user limits and promotions.

### Get virtual currency package list

 - [GET /v2/project/{project_id}/items/virtual_currency/package](https://developers.xsolla.com/api/catalog/virtual-items-currency-catalog/get-virtual-currency-package.md): Gets a virtual currency packages list for building a catalog.

AttentionAll 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.  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.

### Get virtual currency package by SKU

 - [GET /v2/project/{project_id}/items/virtual_currency/package/sku/{virtual_currency_package_sku}](https://developers.xsolla.com/api/catalog/virtual-items-currency-catalog/get-virtual-currency-package-sku.md): Gets a virtual currency packages by SKU for building a catalog.
NoteThis endpoint, accessible without authorization, returns generic data. However, authorization enriches the response with user-specific details for a personalized result, such as available user limits and promotions.

### Get items list by specified group

 - [GET /v2/project/{project_id}/items/virtual_items/group/{external_id}](https://developers.xsolla.com/api/catalog/virtual-items-currency-catalog/get-virtual-items-group.md): Gets an items list from the specified group for building a catalog.

AttentionAll 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.  NoteThis endpoint, accessible without authorization, returns generic data. However, authorization enriches the response with user-specific details for a personalized result, such as available user limits and promotions.

### Get item group list

 - [GET /v2/project/{project_id}/items/groups](https://developers.xsolla.com/api/catalog/virtual-items-currency-catalog/get-item-groups.md): Gets an item group list for building a catalog.

## Virtual payment

### Create order with specified item purchased by virtual currency

 - [POST /v2/project/{project_id}/payment/item/{item_sku}/virtual/{virtual_currency_sku}](https://developers.xsolla.com/api/catalog/virtual-payment/create-order-with-item-for-virtual-currency.md): Creates item purchase using virtual currency.

## Catalog

### Get games list

 - [GET /v2/project/{project_id}/items/game](https://developers.xsolla.com/api/catalog/game-keys-catalog/get-games-list.md): Gets a games list for building a catalog.

AttentionAll 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.  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.

### Get games list by specified group

 - [GET /v2/project/{project_id}/items/game/group/{external_id}](https://developers.xsolla.com/api/catalog/game-keys-catalog/get-games-group.md): Gets a games list from the specified group for building a catalog.

AttentionAll 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.  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.

### Get game for catalog

 - [GET /v2/project/{project_id}/items/game/sku/{item_sku}](https://developers.xsolla.com/api/catalog/game-keys-catalog/get-game-by-sku.md): Gets a game for the catalog.

NoteThis endpoint, accessible without authorization, returns generic data. However, authorization enriches the response with user-specific details for a personalized result, such as available user limits and promotions.

### Get game key for catalog

 - [GET /v2/project/{project_id}/items/game/key/sku/{item_sku}](https://developers.xsolla.com/api/catalog/game-keys-catalog/get-game-key-by-sku.md): Gets a game key for the catalog.

NoteThis endpoint, accessible without authorization, returns generic data. However, authorization enriches the response with user-specific details for a personalized result, such as available user limits and promotions.

### Get game keys list by specified group

 - [GET /v2/project/{project_id}/items/game/key/group/{external_id}](https://developers.xsolla.com/api/catalog/game-keys-catalog/get-game-keys-group.md): Gets a game key list from the specified group for building a catalog.

AttentionAll 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.  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.

### Get DRM list

 - [GET /v2/project/{project_id}/items/game/drm](https://developers.xsolla.com/api/catalog/game-keys-catalog/get-drm-list.md): Gets the list of available DRMs.

## Entitlement

### Get list of games owned by user

 - [GET /v2/project/{project_id}/entitlement](https://developers.xsolla.com/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.

AttentionAll 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.

### Redeem game code by client

 - [POST /v2/project/{project_id}/entitlement/redeem](https://developers.xsolla.com/api/catalog/game-keys-entitlement/redeem-game-pin-code.md): Grants entitlement by a provided game code.

AttentionYou can redeem codes only for the DRM-free platform.

### Grant entitlement (admin)

 - [POST /v2/project/{project_id}/admin/entitlement/grant](https://developers.xsolla.com/api/catalog/game-keys-entitlement/grant-entitlement-admin.md): Grants entitlement to user.

AttentionGame codes or games for DRM free platform can be granted only.

### Revoke entitlement (admin)

 - [POST /v2/project/{project_id}/admin/entitlement/revoke](https://developers.xsolla.com/api/catalog/game-keys-entitlement/revoke-entitlement-admin.md): Revokes entitlement of user.

AttentionGame codes or games for DRM free platform can be revoked only.

## Admin

### Create game

 - [POST /v2/project/{project_id}/admin/items/game](https://developers.xsolla.com/api/catalog/game-keys-admin/admin-create-game.md): Creates a game in the project.

### Get list of games (admin)

 - [GET /v2/project/{project_id}/admin/items/game](https://developers.xsolla.com/api/catalog/game-keys-admin/admin-get-game-list.md): Gets the list of games within a project for administration.
Game consists of game keys which could be purchased by a user.

NoteDo not use this endpoint for building a store catalog.

### Get game (admin)

 - [GET /v2/project/{project_id}/admin/items/game/sku/{item_sku}](https://developers.xsolla.com/api/catalog/game-keys-admin/admin-get-game-by-sku.md): Gets a game for administration.
Game consists of game keys which could be purchased by a user.

NoteDo not use this endpoint for building a store catalog.

### Update game by SKU

 - [PUT /v2/project/{project_id}/admin/items/game/sku/{item_sku}](https://developers.xsolla.com/api/catalog/game-keys-admin/admin-update-game-by-sku.md): Updates a game in the project by SKU.

### Delete game by SKU

 - [DELETE /v2/project/{project_id}/admin/items/game/sku/{item_sku}](https://developers.xsolla.com/api/catalog/game-keys-admin/admin-delete-game-by-sku.md): Deletes a game in the project by SKU.

### Get game by ID (admin)

 - [GET /v2/project/{project_id}/admin/items/game/id/{item_id}](https://developers.xsolla.com/api/catalog/game-keys-admin/admin-get-game-by-id.md): Gets a game for administration.
Game consists of game keys which could be purchased by a user.

NoteDo not use this endpoint for building a store catalog.

### Update game by ID

 - [PUT /v2/project/{project_id}/admin/items/game/id/{item_id}](https://developers.xsolla.com/api/catalog/game-keys-admin/admin-update-game-by-id.md): Updates a game in the project by ID.

### Delete game by ID

 - [DELETE /v2/project/{project_id}/admin/items/game/id/{item_id}](https://developers.xsolla.com/api/catalog/game-keys-admin/admin-delete-game-by-id.md): Deletes a game in the project by ID.

### Upload codes

 - [POST /v2/project/{project_id}/admin/items/game/key/upload/sku/{item_sku}](https://developers.xsolla.com/api/catalog/game-keys-admin/admin-upload-codes-by-sku.md): Uploads codes by game key SKU.

### Upload codes by ID

 - [POST /v2/project/{project_id}/admin/items/game/key/upload/id/{item_id}](https://developers.xsolla.com/api/catalog/game-keys-admin/admin-upload-codes-by-id.md): Uploads codes by game key ID.

### Get codes loading session information

 - [GET /v2/project/{project_id}/admin/items/game/key/upload/session/{session_id}](https://developers.xsolla.com/api/catalog/game-keys-admin/admin-get-codes-session.md): Gets codes loading session information.

### Get codes

 - [GET /v2/project/{project_id}/admin/items/game/key/request/sku/{item_sku}](https://developers.xsolla.com/api/catalog/game-keys-admin/admin-get-codes-by-sku.md): Gets a certain number of codes by game key SKU.

### Get codes by ID

 - [GET /v2/project/{project_id}/admin/items/game/key/request/id/{item_id}](https://developers.xsolla.com/api/catalog/game-keys-admin/admin-get-codes-by-id.md): Gets a certain number of codes by game key ID.

### Delete codes

 - [DELETE /v2/project/{project_id}/admin/items/game/key/delete/sku/{item_sku}](https://developers.xsolla.com/api/catalog/game-keys-admin/admin-delete-codes-by-sku.md): Deletes all codes by game key SKU.

### Delete codes by ID

 - [DELETE /v2/project/{project_id}/admin/items/game/key/delete/id/{item_id}](https://developers.xsolla.com/api/catalog/game-keys-admin/admin-delete-codes-by-id.md): Deletes all codes by game key ID.

## Admin

### Get list of bundles

 - [GET /v2/project/{project_id}/admin/items/bundle](https://developers.xsolla.com/api/catalog/bundles-admin/admin-get-bundle-list.md): Gets the list of bundles within a project for administration.

NoteDo not use this endpoint for building a store catalog.

### Create bundle

 - [POST /v2/project/{project_id}/admin/items/bundle](https://developers.xsolla.com/api/catalog/bundles-admin/admin-create-bundle.md): Creates a bundle.

### Get list of bundles by specified group id

 - [GET /v2/project/{project_id}/admin/items/bundle/group/id/{group_id}](https://developers.xsolla.com/api/catalog/bundles-admin/admin-get-bundle-list-in-group-by-id.md): Gets the list of bundles within a group for administration.

NoteDo not use this endpoint for building a store catalog.

### Get list of bundles by specified group external id

 - [GET /v2/project/{project_id}/admin/items/bundle/group/external_id/{external_id}](https://developers.xsolla.com/api/catalog/bundles-admin/admin-get-bundle-list-in-group-by-external-id.md): Gets the list of bundles within a group for administration.

NoteDo not use this endpoint for building a store catalog.

### Update bundle

 - [PUT /v2/project/{project_id}/admin/items/bundle/sku/{sku}](https://developers.xsolla.com/api/catalog/bundles-admin/admin-update-bundle.md): Updates a bundle.

### Delete bundle

 - [DELETE /v2/project/{project_id}/admin/items/bundle/sku/{sku}](https://developers.xsolla.com/api/catalog/bundles-admin/admin-delete-bundle.md): Deletes a bundle.

### Get bundle

 - [GET /v2/project/{project_id}/admin/items/bundle/sku/{sku}](https://developers.xsolla.com/api/catalog/bundles-admin/admin-get-bundle.md): Gets the bundle within a project for administration.

NoteDo not use this endpoint for building a store catalog.

### Show bundle in catalog

 - [PUT /v2/project/{project_id}/admin/items/bundle/sku/{sku}/show](https://developers.xsolla.com/api/catalog/bundles-admin/admin-show-bundle.md): Shows a bundle in a catalog.

### Hide bundle in catalog

 - [PUT /v2/project/{project_id}/admin/items/bundle/sku/{sku}/hide](https://developers.xsolla.com/api/catalog/bundles-admin/admin-hide-bundle.md): Hides a bundle in a catalog.

## Catalog

### Get list of bundles

 - [GET /v2/project/{project_id}/items/bundle](https://developers.xsolla.com/api/catalog/bundles-catalog/get-bundle-list.md): Gets a list of bundles for building a catalog.

AttentionAll 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.  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.

### Get specified bundle

 - [GET /v2/project/{project_id}/items/bundle/sku/{sku}](https://developers.xsolla.com/api/catalog/bundles-catalog/get-bundle.md): Gets a specified bundle.

NoteThis endpoint, accessible without authorization, returns generic data. However, authorization enriches the response with user-specific details for a personalized result, such as available user limits and promotions.

### Get list of bundles by specified group

 - [GET /v2/project/{project_id}/items/bundle/group/{external_id}](https://developers.xsolla.com/api/catalog/bundles-catalog/get-bundle-list-in-group.md): Gets a list of bundles within a group for building a catalog.

AttentionAll 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.  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.

## Cart (client-side)

### Get cart by cart ID

 - [GET /v2/project/{project_id}/cart/{cart_id}](https://developers.xsolla.com/api/catalog/cart-client-side/get-cart-by-id.md): Returns user’s cart by cart ID.

### Get current user's cart

 - [GET /v2/project/{project_id}/cart](https://developers.xsolla.com/api/catalog/cart-client-side/get-user-cart.md): Returns the current user's cart.

### Delete all cart items by cart ID

 - [PUT /v2/project/{project_id}/cart/{cart_id}/clear](https://developers.xsolla.com/api/catalog/cart-client-side/cart-clear-by-id.md): Deletes all cart items.

### Delete all cart items from current cart

 - [PUT /v2/project/{project_id}/cart/clear](https://developers.xsolla.com/api/catalog/cart-client-side/cart-clear.md): Deletes all cart items.

### Fill cart with items

 - [PUT /v2/project/{project_id}/cart/fill](https://developers.xsolla.com/api/catalog/cart-client-side/cart-fill.md): Fills the cart with items. If the cart already has an item with the same SKU, the existing item will be replaced by the passed value.

### Fill specific cart with items

 - [PUT /v2/project/{project_id}/cart/{cart_id}/fill](https://developers.xsolla.com/api/catalog/cart-client-side/cart-fill-by-id.md): Fills the specific cart with items. If the cart already has an item with the same SKU, the existing item position will be replaced by the passed value.

### Update cart item by cart ID

 - [PUT /v2/project/{project_id}/cart/{cart_id}/item/{item_sku}](https://developers.xsolla.com/api/catalog/cart-client-side/put-item-by-cart-id.md): Updates an existing cart item or creates the one in the cart.

### Delete cart item by cart ID

 - [DELETE /v2/project/{project_id}/cart/{cart_id}/item/{item_sku}](https://developers.xsolla.com/api/catalog/cart-client-side/delete-item-by-cart-id.md): Removes an item from the cart.

### Update cart item from current cart

 - [PUT /v2/project/{project_id}/cart/item/{item_sku}](https://developers.xsolla.com/api/catalog/cart-client-side/put-item.md): Updates an existing cart item or creates the one in the cart.

### Delete cart item from current cart

 - [DELETE /v2/project/{project_id}/cart/item/{item_sku}](https://developers.xsolla.com/api/catalog/cart-client-side/delete-item.md): Removes an item from the cart.

## Cart (server-side)

### Fill cart with items

 - [PUT /v2/admin/project/{project_id}/cart/fill](https://developers.xsolla.com/api/catalog/cart-server-side/admin-cart-fill.md): Fills the current cart with items. If the cart already has an item with the same SKU, the existing item will be replaced by the passed value.

### Fill cart by cart ID with items

 - [PUT /v2/admin/project/{project_id}/cart/{cart_id}/fill](https://developers.xsolla.com/api/catalog/cart-server-side/admin-fill-cart-by-id.md): Fills the cart by cart ID with items. If the cart already has an item with the same SKU, the existing item will be replaced by the passed value.

## Payment (client-side)

### Create order with all items from particular cart

 - [POST /v2/project/{project_id}/payment/cart/{cart_id}](https://developers.xsolla.com/api/catalog/payment-client-side/create-order-by-cart-id.md): Used for client-to-server integration. Creates an order with all items from the particular cart 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.

### Create order with all items from current cart

 - [POST /v2/project/{project_id}/payment/cart](https://developers.xsolla.com/api/catalog/payment-client-side/create-order.md): Used for client-to-server integration. Creates an order with all items from the cart 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.

### Create order with specified item

 - [POST /v2/project/{project_id}/payment/item/{item_sku}](https://developers.xsolla.com/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.

## Payment (server-side)

### Create payment token for purchase

 - [POST /v3/project/{project_id}/admin/payment/token](https://developers.xsolla.com/api/catalog/payment-server-side/admin-create-payment-token.md): Generates an order and a payment token for it. The order is generated based on the items passed in the request body.

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
   
   user.country.value parameter is used to select a currency for the order. If user's country is unknown,
providing the user's IP in X-User-Ip header is an alternative option.  One of these two options is required for the correct work of this method.  The selected currency is used for payment methods at Pay Station.

## Order

### Get order

 - [GET /v2/project/{project_id}/order/{order_id}](https://developers.xsolla.com/api/catalog/order/get-order.md): Retrieves a specified order.

### Get orders list for specified period

 - [POST /v3/project/{project_id}/admin/order/search](https://developers.xsolla.com/api/catalog/order/admin-order-search.md): Retrieves orders list, arranged from the earliest to the latest creation date.

## Free items

### Create order with free cart

 - [POST /v2/project/{project_id}/free/cart](https://developers.xsolla.com/api/catalog/free-item/create-free-order.md): Creates an order with all items from the free cart. The created order will get a done order status.

### Create order with particular free cart

 - [POST /v2/project/{project_id}/free/cart/{cart_id}](https://developers.xsolla.com/api/catalog/free-item/create-free-order-by-cart-id.md): Creates an order with all items from the particular free cart. The created order will get a done order status.

### Create order with specified free item

 - [POST /v2/project/{project_id}/free/item/{item_sku}](https://developers.xsolla.com/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.

## Management

### Refresh all purchase limits for specified user

 - [DELETE /v2/project/{project_id}/admin/user/limit/item/all](https://developers.xsolla.com/api/catalog/user-limits-admin/reset-all-user-items-limit.md): Refreshes all purchase limits across all items for a specified user so they can purchase these items again.

User limit API allows you to sell an item in a limited quantity. To configure the purchase limits, go to the Admin section of the desired item type module:
* Game Keys
* Virtual Items & Currency
* Bundles

### Refresh purchase limit

 - [DELETE /v2/project/{project_id}/admin/user/limit/item/sku/{item_sku}/all](https://developers.xsolla.com/api/catalog/user-limits-admin/reset-user-item-limit.md): Refreshes the purchase limit for an item so a user can buy it again. If the user parameter is null, this call refreshes this limit for all users.

User limit API allows you to sell an item in a limited quantity. To configure the purchase limits, go to the Admin section of the desired item type module:
* Game Keys
* Virtual Items & Currency
* Bundles

### Get number of items available to specified user

 - [GET /v2/project/{project_id}/admin/user/limit/item/sku/{item_sku}](https://developers.xsolla.com/api/catalog/user-limits-admin/get-user-item-limit.md): Gets the remaining number of items available to the specified user within the limit applied.

User limit API allows you to sell an item in a limited quantity. To configure the purchase limits, go to the Admin section of the desired item type module:
* Game Keys
* Virtual Items & Currency
* Bundles

### Increase number of items available to specified user

 - [POST /v2/project/{project_id}/admin/user/limit/item/sku/{item_sku}](https://developers.xsolla.com/api/catalog/user-limits-admin/add-user-item-limit.md): Increases the remaining number of items available to the specified user within the limit applied.

User limit API allows you to sell an item in a limited quantity. To configure the purchase limits, go to the Admin section of the desired item type module:
* Game Keys
* Virtual Items & Currency
* Bundles

### Set number of items available to specified user

 - [PUT /v2/project/{project_id}/admin/user/limit/item/sku/{item_sku}](https://developers.xsolla.com/api/catalog/user-limits-admin/set-user-item-limit.md): Sets the number of items the specified user can buy within the limit applied after it was increased or decreased.

User limit API allows you to sell an item in a limited quantity. To configure the purchase limits, go to the Admin section of the desired item type module:
* Game Keys
* Virtual Items & Currency
* Bundles

### Decrease number of items available to specified user

 - [DELETE /v2/project/{project_id}/admin/user/limit/item/sku/{item_sku}](https://developers.xsolla.com/api/catalog/user-limits-admin/remove-user-item-limit.md): Decreases the remaining number of items available to the specified user within the limit applied.

User limit API allows you to sell an item in a limited quantity. To configure the purchase limits, go to the Admin section of the desired item type module:
* Game Keys
* Virtual Items & Currency
* Bundles

## Admin

### Import items via JSON file

 - [POST /v1/projects/{project_id}/import/from_external_file](https://developers.xsolla.com/api/catalog/connector-admin/import-items-from-external-file.md): Imports items into the store from a JSON file via the specified URL. Refer to the documentation for more information about import from a JSON file.

### Get status of items import

 - [GET /v1/admin/projects/{project_id}/connectors/import_items/import/status](https://developers.xsolla.com/api/catalog/connector-admin/get-items-import-status.md): Retrieves information about the progress of importing items into the project. This API call retrieves data on the last import carried out through the API or Publisher Account.

## Webhooks

### Get information about webhook settings

 - [GET /v2/project/{project_id}/admin/webhook](https://developers.xsolla.com/api/catalog/common-webhooks/get-webhook.md): Gets the information about the webhook settings in Store.
Check webhooks documentation to learn more.

### Update information about webhook settings

 - [PUT /v2/project/{project_id}/admin/webhook](https://developers.xsolla.com/api/catalog/common-webhooks/update-webhook.md): Updates the information about the webhook settings in Store.
Check webhooks documentation to learn more.

## Pre-Orders

### Get information about item pre-order limit

 - [GET /v2/project/{project_id}/admin/items/pre_order/limit/item/sku/{item_sku}](https://developers.xsolla.com/api/catalog/common-pre-orders/get-pre-order-limit.md): Get pre-order limit of the item.

Pre-Order limit API allows you to sell an item in a limited quantity. For configuring the pre-order itself, go to the Admin section of the desired item module:
* Game Keys
* Virtual Items & Currency
* Bundles

Aliases for this endpoint:
* /v2/project/{project_id}/admin/items/pre_order/limit/item/id/{item_id}

### Add quantity to item pre-order limit

 - [POST /v2/project/{project_id}/admin/items/pre_order/limit/item/sku/{item_sku}](https://developers.xsolla.com/api/catalog/common-pre-orders/add-pre-order-limit.md): Add quantity to pre-order limit of the item.

Pre-Order limit API allows you to sell an item in a limited quantity. For configuring the pre-order itself, go to the Admin section of the desired item module:
* Game Keys
* Virtual Items & Currency
* Bundles

Aliases for this endpoint:
* /v2/project/{project_id}/admin/items/pre_order/limit/item/id/{item_id}

### Set quantity of item pre-order limit

 - [PUT /v2/project/{project_id}/admin/items/pre_order/limit/item/sku/{item_sku}](https://developers.xsolla.com/api/catalog/common-pre-orders/set-pre-order-limit.md): Set quantity of pre-order limit of the item.

Pre-Order limit API allows you to sell an item in a limited quantity. For configuring the pre-order itself, go to the Admin section of the desired item module:
* Game Keys
* Virtual Items & Currency
* Bundles

Aliases for this endpoint:
* /v2/project/{project_id}/admin/items/pre_order/limit/item/id/{item_id}

### Remove quantity of item pre-order limit

 - [DELETE /v2/project/{project_id}/admin/items/pre_order/limit/item/sku/{item_sku}](https://developers.xsolla.com/api/catalog/common-pre-orders/remove-pre-order-limit.md): Remove quantity of pre-order limit of the item.

Pre-Order limit API allows you to sell an item in a limited quantity. For configuring the pre-order itself, go to the Admin section of the desired item module:
* Game Keys
* Virtual Items & Currency
* Bundles

Aliases for this endpoint:
* /v2/project/{project_id}/admin/items/pre_order/limit/item/id/{item_id}

### Toggle item's pre-order limit

 - [PUT /v2/project/{project_id}/admin/items/pre_order/limit/item/sku/{item_sku}/toggle](https://developers.xsolla.com/api/catalog/common-pre-orders/toggle-pre-order-limit.md): Enable/disable pre-order limit of the item.

Pre-Order limit API allows you to sell an item in a limited quantity. For configuring the pre-order itself, go to the admin section of the desired item module:
* Game Keys
* Virtual Items & Currency
* Bundles

Aliases for this endpoint:
* /v2/project/{project_id}/admin/items/pre_order/limit/item/id/{item_id}/toggle

### Remove all quantity of item pre-order limit

 - [DELETE /v2/project/{project_id}/admin/items/pre_order/limit/item/sku/{item_sku}/all](https://developers.xsolla.com/api/catalog/common-pre-orders/remove-all-pre-order-limit.md): Remove all quantity of pre-order limit of the item.

Pre-Order limit API allows you to sell an item in a limited quantity. For configuring the pre-order itself, go to the admin section of the desired item module:
* Game Keys
* Virtual Items & Currency
* Bundles

Aliases for this endpoint:
* /v2/project/{project_id}/admin/items/pre_order/limit/item/id/{item_id}/all

## Merchant

### Get projects

 - [GET /v2/merchant/{merchant_id}/projects](https://developers.xsolla.com/api/catalog/common-merchant/get-projects.md): Gets the list of merchant's projects.


  NoticeThis API call does not contain the project_id path parameter, so you need to use the API key that is valid in all the company’s projects to set up authorization.

## Catalog

This API allows getting any kind of sellable items or specific item.


### Get sellable items list

 - [GET /v2/project/{project_id}/items](https://developers.xsolla.com/api/catalog/common-catalog/get-sellable-items.md): Gets a sellable items list for building a catalog.

AttentionAll 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.  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.

### Get sellable item by ID

 - [GET /v2/project/{project_id}/items/id/{item_id}](https://developers.xsolla.com/api/catalog/common-catalog/get-sellable-item-by-id.md): Gets a sellable item by its ID.
NoteThis endpoint, accessible without authorization, returns generic data. However, authorization enriches the response with user-specific details for a personalized result, such as available user limits and promotions.

### Get sellable item by SKU

 - [GET /v2/project/{project_id}/items/sku/{sku}](https://developers.xsolla.com/api/catalog/common-catalog/get-sellable-item-by-sku.md): Gets a sellable item by SKU for building a catalog.
NoteThis endpoint, accessible without authorization, returns generic data. However, authorization enriches the response with user-specific details for a personalized result, such as available user limits and promotions.

### Get sellable items list by specified group

 - [GET /v2/project/{project_id}/items/group/{external_id}](https://developers.xsolla.com/api/catalog/common-catalog/get-sellable-items-group.md): Gets a sellable items list from the specified group for building a catalog.

AttentionAll 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.  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.

## Common regions

### Get list of regions

 - [GET /v2/project/{project_id}/admin/region](https://developers.xsolla.com/api/catalog/common-regions/admin-get-regions.md): Gets list of regions.

You can use a region for managing your regional restrictions.

### Create region

 - [POST /v2/project/{project_id}/admin/region](https://developers.xsolla.com/api/catalog/common-regions/admin-create-region.md): Creates region.

You can use a region for managing your regional restrictions.

### Get region

 - [GET /v2/project/{project_id}/admin/region/{region_id}](https://developers.xsolla.com/api/catalog/common-regions/admin-get-region.md): Gets particular region.

You can use a region for managing your regional restrictions.

### Update region

 - [PUT /v2/project/{project_id}/admin/region/{region_id}](https://developers.xsolla.com/api/catalog/common-regions/admin-update-region.md): Updates particular region.

You can use a region for managing your regional restrictions.

### Delete region

 - [DELETE /v2/project/{project_id}/admin/region/{region_id}](https://developers.xsolla.com/api/catalog/common-regions/admin-delete-region.md): Deletes particular region.

## Admin

### Get list of attributes (admin)

 - [GET /v2/project/{project_id}/admin/attribute](https://developers.xsolla.com/api/catalog/attribute-admin/admin-get-attribute-list.md): Gets the list of attributes from a project for administration.

### Create attribute

 - [POST /v2/project/{project_id}/admin/attribute](https://developers.xsolla.com/api/catalog/attribute-admin/admin-create-attribute.md): Creates an attribute.

### Update attribute

 - [PUT /v2/project/{project_id}/admin/attribute/{external_id}](https://developers.xsolla.com/api/catalog/attribute-admin/admin-update-attribute.md): Updates an attribute.

### Get specified attribute

 - [GET /v2/project/{project_id}/admin/attribute/{external_id}](https://developers.xsolla.com/api/catalog/attribute-admin/admin-get-attribute.md): Gets a specified attribute.

### Delete attribute

 - [DELETE /v2/project/{project_id}/admin/attribute/{external_id}](https://developers.xsolla.com/api/catalog/attribute-admin/delete-attribute.md): Deletes an attribute.
NoticeIf you delete an item attribute, all its data and connections with items will be lost.

### Create attribute value

 - [POST /v2/project/{project_id}/admin/attribute/{external_id}/value](https://developers.xsolla.com/api/catalog/attribute-admin/admin-create-attribute-value.md): Creates an attribute value.

AttentionAll projects have the limitation to the number of attribute values. The default and maximum value is 20 values per attribute.

### Delete all values of attribute

 - [DELETE /v2/project/{project_id}/admin/attribute/{external_id}/value](https://developers.xsolla.com/api/catalog/attribute-admin/admin-delete-all-attribute-value.md): Deletes all values of the attribute.
NoticeIf you delete an attribute's value, all connections between the attribute and items will be lost. To change the attribute value for an item, use the Update attribute value API call instead of deleting the value and creating a new one.

### Update attribute value

 - [PUT /v2/project/{project_id}/admin/attribute/{external_id}/value/{value_external_id}](https://developers.xsolla.com/api/catalog/attribute-admin/admin-update-attribute-value.md): Updates an attribute values.

### Delete attribute value

 - [DELETE /v2/project/{project_id}/admin/attribute/{external_id}/value/{value_external_id}](https://developers.xsolla.com/api/catalog/attribute-admin/admin-delete-attribute-value.md): Deletes an attribute value.
NoticeIf you delete an attribute's value, all connections  between the attribute and items will be lost. To change the attribute value for an item, use the Update attribute value API call instead of deleting the value and creating a new one.