Static Public Member Functions
static void	GetItems (Action< StoreItems > onSuccess, Action< Error > onError, string locale=null, string country=null, string additionalFields="long_description")
	Returns a full list of virtual items. The list includes items for which display in the store is enabled in the settings. For each virtual item, complete data is returned. If called after user authentication, the method returns items that match the personalization rules for the current user. More...

static void	GetPaginatedItems (Action< StoreItems > onSuccess, Action< Error > onError, int limit, int offset, string locale=null, string country=null, string additionalFields="long_description")
	Returns a list of virtual items according to pagination settings. The list includes items for which display in the store is enabled in the settings. For each virtual item, complete data is returned. If called after user authentication, the method returns items that match the personalization rules for the current user. More...

static void	GetCatalogSimplified (Action< StoreShortItems > onSuccess, Action< Error > onError, string locale=null)
	Returns a full list of virtual items. The list includes items for which display in the store is enabled in the settings. For each virtual item, the SKU, name, description, and data about the groups it belongs to are returned. If used after user authentication, the method returns items that match the personalization rules for the current user. More...

static void	GetGroupItems (string groupExternalId, Action< StoreItems > onSuccess, Action< Error > onError, string locale=null, string country=null, string additionalFields=null)
	Returns a list of items for the specified group. The list includes items for which display in the store is enabled in the settings. In the settings of the group, the display in the store must be enabled. If called after user authentication, the method returns items that match the personalization rules for the current user. More...

static void	GetPaginatedGroupItems (string groupExternalId, Action< StoreItems > onSuccess, Action< Error > onError, int limit, int offset, string locale=null, string country=null, string additionalFields=null)
	Returns a list of items for the specified group according to pagination settings. The list includes items for which display in the store is enabled in the settings. In the settings of the group, the display in the store must be enabled. If called after user authentication, the method returns items that match the personalization rules for the current user. More...

static void	GetItemGroups (Action< Groups > onSuccess, Action< Error > onError, string locale=null, string promoCode=null)
	Returns a full list of virtual item groups. The list includes groups for which display in the store is enabled in the settings. More...

static void	GetVirtualCurrencyList (Action< VirtualCurrencyItems > onSuccess, Action< Error > onError, string locale=null, string country=null, string additionalFields=null)
	Returns a full list of virtual currencies. The list includes currencies for which display in the store is enabled in settings. More...

static void	GetPaginatedVirtualCurrencyList (Action< VirtualCurrencyItems > onSuccess, Action< Error > onError, int limit, int offset, string locale=null, string country=null, string additionalFields=null)
	Returns a list of virtual currencies according to pagination settings. The list includes currencies for which display in the store is enabled in settings. More...

static void	GetVirtualCurrencyPackagesList (Action< VirtualCurrencyPackages > onSuccess, Action< Error > onError, string locale=null, string country=null, string additionalFields=null)
	Returns a list of full virtual currency packages. The list includes packages for which display in the store is enabled in the settings. If called after user authentication, the method returns packages that match the personalization rules for the current user. More...

static void	GetPaginatedVirtualCurrencyPackagesList (Action< VirtualCurrencyPackages > onSuccess, Action< Error > onError, int limit, int offset, string locale=null, string country=null, string additionalFields=null)
	Returns a list of virtual currency packages according to pagination settings. The list includes packages for which display in the store is enabled in the settings. If called after user authentication, the method returns packages that match the personalization rules for the current user. More...

static void	GetBundles (Action< BundleItems > onSuccess, Action< Error > onError, string locale=null, string country=null, string additionalFields=null)
	Returns a full list of bundles. The list includes bundles for which display in the store is enabled in the settings. If called after user authentication, the method returns items that match the personalization rules for the current user. More...

static void	GetPaginatedBundles (Action< BundleItems > onSuccess, Action< Error > onError, int limit, int offset, string locale=null, string country=null, string additionalFields=null)
	Returns a list of bundles according to pagination settings. The list includes bundles for which display in the store is enabled in the settings. If called after user authentication, the method returns items that match the personalization rules for the current user. More...

static void	GetBundle (string sku, Action< BundleItem > onSuccess, Action< Error > onError, string locale=null, string country=null)
	Returns information about the contents of the specified bundle. In the bundle settings, display in the store must be enabled. If used after user authentication, the method returns items that match the personalization rules for the current user. More...

static void	RedeemCouponCode (string couponCode, Action< CouponRedeemedItems > onSuccess, Action< Error > onError)
	Redeems the coupon code and delivers a reward to the user in one of the following ways: More...

static void	GetCouponRewards (string couponCode, Action< CouponReward > onSuccess, Action< Error > onError)
	Returns a list of items that can be credited to the user when the coupon is redeemed. Can be used to let users choose one of many items as a bonus. The usual case is choosing a DRM if the coupon contains a game as a bonus. More...

static void	CreateOrder (string itemSku, Action< OrderData > onSuccess, Action< Error > onError, PurchaseParams purchaseParams=null, Dictionary< string, string > customHeaders=null)
	Creates an order with a specified item. The created order will get a `new` order status. More...

static void	CreateOrderByVirtualCurrency (string itemSku, string priceSku, Action< OrderId > onSuccess, Action< Error > onError, PurchaseParams purchaseParams=null, string platform=null, Dictionary< string, string > customHeaders=null)
	Creates an order with a specified item, returns unique identifier of the created order and the Pay Station token for the purchase of the specified product by virtual currency. The created order will get a `new` order status. More...

static void	CreateOrderWithFreeItem (string itemSku, Action< OrderId > onSuccess, Action< Error > onError, PurchaseParams purchaseParams=null, Dictionary< string, string > customHeaders=null)
	Create order with specified free item. The created order will get a `done` order status. More...

static void	Purchase (string itemSku, Action< OrderStatus > onSuccess, Action< Error > onError, Action< OrderData > onOrderCreated=null, Action< BrowserCloseInfo > onBrowseClosed=null, PurchaseParams purchaseParams=null, Dictionary< string, string > customHeaders=null, PlatformSpecificAppearance platformSpecificAppearance=null)
	Launches purchase process for a specified item. This method encapsulates methods for creating an order, opening a payment UI, and tracking the order status. More...

static void	PurchaseForVirtualCurrency (string itemSku, string priceSku, Action< OrderStatus > onSuccess, Action< Error > onError, Action< OrderId > onOrderCreated=null, PurchaseParams purchaseParams=null, string platform=null, Dictionary< string, string > customHeaders=null)
	Launch purchase process for a specified item by virtual currency. This method encapsulates methods for creating an order and tracking the order status. More...

static void	PurchaseFreeItem (string itemSku, Action< OrderStatus > onSuccess, Action< Error > onError, Action< OrderId > onOrderCreated=null, PurchaseParams purchaseParams=null, Dictionary< string, string > customHeaders=null)
	Launches purchase process for a specified free item. This method encapsulates methods for creating an order and tracking the order status. More...

static void	GetCatalog (Action< StoreItems > onSuccess, Action< Error > onError, int limit=50, int offset=0, string locale=null, string country=null, string additionalFields="long_description")
	[Obsolete. Use GetItems instead.] Returns a list of virtual items according to pagination settings. The list includes items for which display in the store is enabled in the settings. For each virtual item, complete data is returned. If used after user authentication, the method returns items that match the personalization rules for the current user. More...

Member Function Documentation

◆ CreateOrder()

static void Xsolla.Catalog.XsollaCatalog.CreateOrder	(	string	itemSku,
		Action< OrderData >	onSuccess,
		Action< Error >	onError,
		PurchaseParams	purchaseParams = `null`,
		Dictionary< string, string >	customHeaders = `null`
	)

inlinestatic

Creates an order with a specified item. The created order will get a new order status.

More about the use cases.

Parameters

itemSku	Item SKU to purchase.
onSuccess	Called after server response.
onError	Called after the request resulted with an error.
purchaseParams	Purchase parameters such as `country`, `locale`, and `currency`.
customHeaders	Custom web request headers

◆ CreateOrderByVirtualCurrency()

static void Xsolla.Catalog.XsollaCatalog.CreateOrderByVirtualCurrency	(	string	itemSku,
		string	priceSku,
		Action< OrderId >	onSuccess,
		Action< Error >	onError,
		PurchaseParams	purchaseParams = `null`,
		string	platform = `null`,
		Dictionary< string, string >	customHeaders = `null`
	)

inlinestatic

Creates an order with a specified item, returns unique identifier of the created order and the Pay Station token for the purchase of the specified product by virtual currency. The created order will get a new order status.

More about the use cases.

Parameters

itemSku	Item SKU to purchase.
priceSku	Virtual currency SKU.
onSuccess	Called after server response.
onError	Called after the request resulted with an error.
purchaseParams	Purchase parameters such as `country`, `locale`, `currency`, and `quantity`.
platform	Publishing platform the user plays on. Can be `xsolla` (default), `playstation_network`, `xbox_live`, `pc_standalone`, `nintendo_shop`, `google_play`, `app_store_ios`, `android_standalone`, `ios_standalone`, `android_other`, `ios_other`, or `pc_other`.
customHeaders	Custom HTTP request headers.

◆ CreateOrderWithFreeItem()

static void Xsolla.Catalog.XsollaCatalog.CreateOrderWithFreeItem	(	string	itemSku,
		Action< OrderId >	onSuccess,
		Action< Error >	onError,
		PurchaseParams	purchaseParams = `null`,
		Dictionary< string, string >	customHeaders = `null`
	)

inlinestatic

Create order with specified free item. The created order will get a done order status.

More about the use cases.

Parameters

itemSku	Desired free item SKU.
onSuccess	Called after the order was successfully created.
onError	Called after the request resulted with an error.
purchaseParams	Purchase parameters such as `country`, `locale`, and `currency`.
customHeaders	Custom web request headers

◆ GetBundle()

static void Xsolla.Catalog.XsollaCatalog.GetBundle	(	string	sku,
		Action< BundleItem >	onSuccess,
		Action< Error >	onError,
		string	locale = `null`,
		string	country = `null`
	)

inlinestatic

Returns information about the contents of the specified bundle. In the bundle settings, display in the store must be enabled. If used after user authentication, the method returns items that match the personalization rules for the current user.

More about the use cases.

Parameters

sku	Bundle SKU.
onSuccess	Called after the cart is successfully filled.
onError	Called after the request resulted with an error.
locale	Defines localization of the item text fields. Two-letter lowercase language code. Leave empty to use the default value.
country	Country for which to calculate regional prices and restrictions in a catalog. Two-letter uppercase country code per ISO 3166-1 alpha-2. Calculations are based on the user's IP address if the country is not specified. Check the documentation for detailed information about countries supported by Xsolla.

◆ GetBundles()

static void Xsolla.Catalog.XsollaCatalog.GetBundles	(	Action< BundleItems >	onSuccess,
		Action< Error >	onError,
		string	locale = `null`,
		string	country = `null`,
		string	additionalFields = `null`
	)

inlinestatic

Returns a full list of bundles. The list includes bundles for which display in the store is enabled in the settings. If called after user authentication, the method returns items that match the personalization rules for the current user.

More about the use cases.

Parameters

onSuccess	Called after bundles are successfully received.
onError	Called after the request resulted with an error.
locale	Defines localization of the item text fields. Two-letter lowercase language code. Leave empty to use the default value.
country	Country for which to calculate regional prices and restrictions in a catalog. Two-letter uppercase country code per ISO 3166-1 alpha-2. Calculations are based on the user's IP address if the country is not specified. Check the documentation for detailed information about countries supported by Xsolla.
additionalFields	The list of additional fields. This fields will be in a response if you send its in a request. Available fields `media_list`, `order`, `long_description`.

◆ GetCatalog()

static void Xsolla.Catalog.XsollaCatalog.GetCatalog	(	Action< StoreItems >	onSuccess,
		Action< Error >	onError,
		int	limit = `50`,
		int	offset = `0`,
		string	locale = `null`,
		string	country = `null`,
		string	additionalFields = `"long_description"`
	)

inlinestatic

[Obsolete. Use GetItems instead.] Returns a list of virtual items according to pagination settings. The list includes items for which display in the store is enabled in the settings. For each virtual item, complete data is returned. If used after user authentication, the method returns items that match the personalization rules for the current user.

More about the use cases.

Parameters

onSuccess	Called after virtual items were successfully received.
onError	Called after the request resulted with an error.
limit	Limit for the number of elements on the page. The maximum number of elements on a page is 50.
offset	Number of the element from which the list is generated (the count starts from 0).
locale	Response language. Two-letter lowercase language code. Leave empty to use the default value.
country	Country for which to calculate regional prices and restrictions in a catalog. Two-letter uppercase country code per ISO 3166-1 alpha-2. Calculations are based on the user's IP address if the country is not specified. Check the documentation for detailed information about countries supported by Xsolla.
additionalFields	The list of additional fields. These fields will be in a response if you send them in a request. Available fields `media_list`, `order`, and `long_description`.

◆ GetCatalogSimplified()

static void Xsolla.Catalog.XsollaCatalog.GetCatalogSimplified	(	Action< StoreShortItems >	onSuccess,
		Action< Error >	onError,
		string	locale = `null`
	)

inlinestatic

Returns a full list of virtual items. The list includes items for which display in the store is enabled in the settings. For each virtual item, the SKU, name, description, and data about the groups it belongs to are returned. If used after user authentication, the method returns items that match the personalization rules for the current user.

More about the use cases.

Parameters

onSuccess	Called after server response.
onError	Called after the request resulted with an error.
locale	Response language. Two-letter lowercase language code. Leave empty to use the default value.

◆ GetCouponRewards()

static void Xsolla.Catalog.XsollaCatalog.GetCouponRewards	(	string	couponCode,
		Action< CouponReward >	onSuccess,
		Action< Error >	onError
	)

inlinestatic

Returns a list of items that can be credited to the user when the coupon is redeemed. Can be used to let users choose one of many items as a bonus. The usual case is choosing a DRM if the coupon contains a game as a bonus.

More about the use cases.

Parameters

couponCode	Unique case sensitive code. Contains letters and numbers.
onSuccess	Called after receiving coupon rewards successfully.
onError	Called after the request resulted with an error.

◆ GetGroupItems()

static void Xsolla.Catalog.XsollaCatalog.GetGroupItems	(	string	groupExternalId,
		Action< StoreItems >	onSuccess,
		Action< Error >	onError,
		string	locale = `null`,
		string	country = `null`,
		string	additionalFields = `null`
	)

inlinestatic

Returns a list of items for the specified group. The list includes items for which display in the store is enabled in the settings. In the settings of the group, the display in the store must be enabled. If called after user authentication, the method returns items that match the personalization rules for the current user.

More about the use cases.

Parameters

groupExternalId	Group external ID.
onSuccess	Called after server response.
onError	Called after the request resulted with an error.
locale	Response language. Two-letter lowercase language code. Leave empty to use the default value.
country	Country for which to calculate regional prices and restrictions in a catalog. Two-letter uppercase country code per ISO 3166-1 alpha-2. Calculations are based on the user's IP address if the country is not specified. Check the documentation for detailed information about countries supported by Xsolla.
additionalFields	The list of additional fields. This fields will be in a response if you send its in a request. Available fields `media_list`, `order`, `long_description`.

◆ GetItemGroups()

static void Xsolla.Catalog.XsollaCatalog.GetItemGroups	(	Action< Groups >	onSuccess,
		Action< Error >	onError,
		string	locale = `null`,
		string	promoCode = `null`
	)

inlinestatic

Returns a full list of virtual item groups. The list includes groups for which display in the store is enabled in the settings.

More about the use cases.

Parameters

onSuccess	Called after virtual item groups were successfully received.
onError	Called after the request resulted with an error.
locale	Defines localization of the item text fields.Two-letter lowercase language code. Leave empty to use the default value.
promoCode	Promo code. Unique case-sensitive code. Contains letters and numbers.

◆ GetItems()

static void Xsolla.Catalog.XsollaCatalog.GetItems	(	Action< StoreItems >	onSuccess,
		Action< Error >	onError,
		string	locale = `null`,
		string	country = `null`,
		string	additionalFields = `"long_description"`
	)

inlinestatic

Returns a full list of virtual items. The list includes items for which display in the store is enabled in the settings. For each virtual item, complete data is returned. If called after user authentication, the method returns items that match the personalization rules for the current user.

More about the use cases.

Parameters

onSuccess	Called after virtual items were successfully received.
onError	Called after the request resulted with an error.
locale	Response language. Two-letter lowercase language code. Leave empty to use the default value.
country	Country for which to calculate regional prices and restrictions in a catalog. Two-letter uppercase country code per ISO 3166-1 alpha-2. Calculations are based on the user's IP address if the country is not specified. Check the documentation for detailed information about countries supported by Xsolla.
additionalFields	The list of additional fields. These fields will be in a response if you send them in a request. Available fields `media_list`, `order`, and `long_description`.

◆ GetPaginatedBundles()

static void Xsolla.Catalog.XsollaCatalog.GetPaginatedBundles	(	Action< BundleItems >	onSuccess,
		Action< Error >	onError,
		int	limit,
		int	offset,
		string	locale = `null`,
		string	country = `null`,
		string	additionalFields = `null`
	)

inlinestatic

Returns a list of bundles according to pagination settings. The list includes bundles for which display in the store is enabled in the settings. If called after user authentication, the method returns items that match the personalization rules for the current user.

More about the use cases.

Parameters

onSuccess	Called after bundles are successfully received.
onError	Called after the request resulted with an error.
limit	Limit for the number of elements on the page. The maximum number of elements on a page is 50.
offset	Number of the element from which the list is generated (the count starts from 0).
locale	Defines localization of the item text fields. Two-letter lowercase language code. Leave empty to use the default value.
country	Country for which to calculate regional prices and restrictions in a catalog. Two-letter uppercase country code per ISO 3166-1 alpha-2. Calculations are based on the user's IP address if the country is not specified. Check the documentation for detailed information about countries supported by Xsolla.
additionalFields	The list of additional fields. This fields will be in a response if you send its in a request. Available fields `media_list`, `order`, `long_description`.

◆ GetPaginatedGroupItems()

static void Xsolla.Catalog.XsollaCatalog.GetPaginatedGroupItems	(	string	groupExternalId,
		Action< StoreItems >	onSuccess,
		Action< Error >	onError,
		int	limit,
		int	offset,
		string	locale = `null`,
		string	country = `null`,
		string	additionalFields = `null`
	)

inlinestatic

Returns a list of items for the specified group according to pagination settings. The list includes items for which display in the store is enabled in the settings. In the settings of the group, the display in the store must be enabled. If called after user authentication, the method returns items that match the personalization rules for the current user.

More about the use cases.

Parameters

groupExternalId	Group external ID.
onSuccess	Called after server response.
onError	Called after the request resulted with an error.
limit	Limit for the number of elements on the page. The maximum number of elements on a page is 50.
offset	Number of the element from which the list is generated (the count starts from 0).
locale	Response language. Two-letter lowercase language code. Leave empty to use the default value.
country	Country for which to calculate regional prices and restrictions in a catalog. Two-letter uppercase country code per ISO 3166-1 alpha-2. Calculations are based on the user's IP address if the country is not specified. Check the documentation for detailed information about countries supported by Xsolla.
additionalFields	The list of additional fields. This fields will be in a response if you send its in a request. Available fields `media_list`, `order`, `long_description`.

◆ GetPaginatedItems()

static void Xsolla.Catalog.XsollaCatalog.GetPaginatedItems	(	Action< StoreItems >	onSuccess,
		Action< Error >	onError,
		int	limit,
		int	offset,
		string	locale = `null`,
		string	country = `null`,
		string	additionalFields = `"long_description"`
	)

inlinestatic

Returns a list of virtual items according to pagination settings. The list includes items for which display in the store is enabled in the settings. For each virtual item, complete data is returned. If called after user authentication, the method returns items that match the personalization rules for the current user.

More about the use cases.

Parameters

onSuccess	Called after virtual items were successfully received.
onError	Called after the request resulted with an error.
limit	Limit for the number of elements on the page. The maximum number of elements on a page is 50.
offset	Number of the element from which the list is generated (the count starts from 0).
locale	Response language. Two-letter lowercase language code. Leave empty to use the default value.
country	Country for which to calculate regional prices and restrictions in a catalog. Two-letter uppercase country code per ISO 3166-1 alpha-2. Calculations are based on the user's IP address if the country is not specified. Check the documentation for detailed information about countries supported by Xsolla.
additionalFields	The list of additional fields. These fields will be in a response if you send them in a request. Available fields `media_list`, `order`, and `long_description`.

◆ GetPaginatedVirtualCurrencyList()

static void Xsolla.Catalog.XsollaCatalog.GetPaginatedVirtualCurrencyList	(	Action< VirtualCurrencyItems >	onSuccess,
		Action< Error >	onError,
		int	limit,
		int	offset,
		string	locale = `null`,
		string	country = `null`,
		string	additionalFields = `null`
	)

inlinestatic

Returns a list of virtual currencies according to pagination settings. The list includes currencies for which display in the store is enabled in settings.

More about the use cases.

Parameters

onSuccess	Called after virtual currencies were successfully received.
onError	Called after the request resulted with an error.
limit	Limit for the number of elements on the page. The maximum number of elements on a page is 50.
offset	Number of the element from which the list is generated (the count starts from 0).
locale	Response language. Two-letter lowercase language code. Leave empty to use the default value.
country	Country for which to calculate regional prices and restrictions in a catalog. Two-letter uppercase country code per ISO 3166-1 alpha-2. Calculations are based on the user's IP address if the country is not specified. Check the documentation for detailed information about countries supported by Xsolla.
additionalFields	The list of additional fields. These fields will be in a response if you send them in a request. Available fields `media_list`, `order`, and `long_description`.

◆ GetPaginatedVirtualCurrencyPackagesList()

static void Xsolla.Catalog.XsollaCatalog.GetPaginatedVirtualCurrencyPackagesList	(	Action< VirtualCurrencyPackages >	onSuccess,
		Action< Error >	onError,
		int	limit,
		int	offset,
		string	locale = `null`,
		string	country = `null`,
		string	additionalFields = `null`
	)

inlinestatic

Returns a list of virtual currency packages according to pagination settings. The list includes packages for which display in the store is enabled in the settings. If called after user authentication, the method returns packages that match the personalization rules for the current user.

More about the use cases.

Parameters

onSuccess	Called after virtual currency packages were successfully received.
onError	Called after the request resulted with an error.
limit	Limit for the number of elements on the page. The maximum number of elements on a page is 50.
offset	Number of the element from which the list is generated (the count starts from 0).
locale	Response language. Two-letter lowercase language code. Leave empty to use the default value.
country	Country for which to calculate regional prices and restrictions in a catalog. Two-letter uppercase country code per ISO 3166-1 alpha-2. Calculations are based on the user's IP address if the country is not specified. Check the documentation for detailed information about countries supported by Xsolla.
additionalFields	The list of additional fields. These fields will be in a response if you send them in a request. Available fields `media_list`, `order`, and `long_description`.

◆ GetVirtualCurrencyList()

static void Xsolla.Catalog.XsollaCatalog.GetVirtualCurrencyList	(	Action< VirtualCurrencyItems >	onSuccess,
		Action< Error >	onError,
		string	locale = `null`,
		string	country = `null`,
		string	additionalFields = `null`
	)

inlinestatic

Returns a full list of virtual currencies. The list includes currencies for which display in the store is enabled in settings.

More about the use cases.

Parameters

onSuccess	Called after virtual currencies were successfully received.
onError	Called after the request resulted with an error.
locale	Response language. Two-letter lowercase language code. Leave empty to use the default value.
country	Country for which to calculate regional prices and restrictions in a catalog. Two-letter uppercase country code per ISO 3166-1 alpha-2. Calculations are based on the user's IP address if the country is not specified. Check the documentation for detailed information about countries supported by Xsolla.
additionalFields	The list of additional fields. These fields will be in a response if you send them in a request. Available fields `media_list`, `order`, and `long_description`.

◆ GetVirtualCurrencyPackagesList()

static void Xsolla.Catalog.XsollaCatalog.GetVirtualCurrencyPackagesList	(	Action< VirtualCurrencyPackages >	onSuccess,
		Action< Error >	onError,
		string	locale = `null`,
		string	country = `null`,
		string	additionalFields = `null`
	)

inlinestatic

Returns a list of full virtual currency packages. The list includes packages for which display in the store is enabled in the settings. If called after user authentication, the method returns packages that match the personalization rules for the current user.

More about the use cases.

Parameters

onSuccess	Called after virtual currency packages were successfully received.
onError	Called after the request resulted with an error.
locale	Response language. Two-letter lowercase language code. Leave empty to use the default value.
country	Country for which to calculate regional prices and restrictions in a catalog. Two-letter uppercase country code per ISO 3166-1 alpha-2. Calculations are based on the user's IP address if the country is not specified. Check the documentation for detailed information about countries supported by Xsolla.
additionalFields	The list of additional fields. These fields will be in a response if you send them in a request. Available fields `media_list`, `order`, and `long_description`.

◆ Purchase()

static void Xsolla.Catalog.XsollaCatalog.Purchase	(	string	itemSku,
		Action< OrderStatus >	onSuccess,
		Action< Error >	onError,
		Action< OrderData >	onOrderCreated = `null`,
		Action< BrowserCloseInfo >	onBrowseClosed = `null`,
		PurchaseParams	purchaseParams = `null`,
		Dictionary< string, string >	customHeaders = `null`,
		PlatformSpecificAppearance	platformSpecificAppearance = `null`
	)

inlinestatic

Launches purchase process for a specified item. This method encapsulates methods for creating an order, opening a payment UI, and tracking the order status.

More about the use cases.

Parameters

itemSku	Desired free item SKU.
onSuccess	Called after the order transitions to the 'done' status.
onError	Called after the request resulted with an error.
onOrderCreated	Called after the order is created.
onBrowseClosed	Called after the browser is closed. The event is tracked only when the payment UI is opened in the built-in browser. External browser events can't be tracked.
purchaseParams	Purchase and payment UI parameters, such as `locale`, `currency`, etc.
customHeaders	Custom web request headers
platformSpecificAppearance	Additional settings of payment UI appearance for different platforms.

◆ PurchaseForVirtualCurrency()

static void Xsolla.Catalog.XsollaCatalog.PurchaseForVirtualCurrency	(	string	itemSku,
		string	priceSku,
		Action< OrderStatus >	onSuccess,
		Action< Error >	onError,
		Action< OrderId >	onOrderCreated = `null`,
		PurchaseParams	purchaseParams = `null`,
		string	platform = `null`,
		Dictionary< string, string >	customHeaders = `null`
	)

inlinestatic

Launch purchase process for a specified item by virtual currency. This method encapsulates methods for creating an order and tracking the order status.

More about the use cases.

Parameters

itemSku	Desired free item SKU.
priceSku	Virtual currency SKU.
onSuccess	Called after the order transitions to the 'done' status.
onError	Called after the request resulted with an error.
onOrderCreated	Called after the order is created.
purchaseParams	Purchase parameters such as `country`, `locale`, and `currency`.
platform	Publishing platform the user plays on. Can be `xsolla` (default), `playstation_network`, `xbox_live`, `pc_standalone`, `nintendo_shop`, `google_play`, `app_store_ios`, `android_standalone`, `ios_standalone`, `android_other`, `ios_other`, or `pc_other`.
customHeaders	Custom HTTP request headers.

◆ PurchaseFreeItem()

static void Xsolla.Catalog.XsollaCatalog.PurchaseFreeItem	(	string	itemSku,
		Action< OrderStatus >	onSuccess,
		Action< Error >	onError,
		Action< OrderId >	onOrderCreated = `null`,
		PurchaseParams	purchaseParams = `null`,
		Dictionary< string, string >	customHeaders = `null`
	)

inlinestatic

Launches purchase process for a specified free item. This method encapsulates methods for creating an order and tracking the order status.

More about the use cases.

Parameters

itemSku	Desired free item SKU.
onSuccess	Called after the order transitions to the 'done' status.
onError	Called after the request resulted with an error.
onOrderCreated	Called after the order is created.
purchaseParams	Purchase parameters such as `country`, `locale`, and `currency`.
customHeaders	Custom HTTP request headers.

◆ RedeemCouponCode()

static void Xsolla.Catalog.XsollaCatalog.RedeemCouponCode	(	string	couponCode,
		Action< CouponRedeemedItems >	onSuccess,
		Action< Error >	onError
	)

inlinestatic

Redeems the coupon code and delivers a reward to the user in one of the following ways:

to their inventory (virtual items, virtual currency packages, or bundles)
via email (game keys)
to the entitlement system (game keys)

More about the use cases.

Parameters

couponCode	Unique case sensitive code. Contains letters and numbers.
onSuccess	Called after successful coupon redemption.
onError	Called after the request resulted with an error.

The documentation for this class was generated from the following file:

Assets/Xsolla/Catalog/XsollaCatalog.cs

Static Public Member Functions

Member Function Documentation

◆ CreateOrder()

◆ CreateOrderByVirtualCurrency()

◆ CreateOrderWithFreeItem()

◆ GetBundle()

◆ GetBundles()

◆ GetCatalog()

◆ GetCatalogSimplified()

◆ GetCouponRewards()

◆ GetGroupItems()

◆ GetItemGroups()

◆ GetItems()

◆ GetPaginatedBundles()

◆ GetPaginatedGroupItems()

◆ GetPaginatedItems()

◆ GetPaginatedVirtualCurrencyList()

◆ GetPaginatedVirtualCurrencyPackagesList()

◆ GetVirtualCurrencyList()

◆ GetVirtualCurrencyPackagesList()

◆ Purchase()

◆ PurchaseForVirtualCurrency()

◆ PurchaseFreeItem()

◆ RedeemCouponCode()