Xsolla::Cart::XsollaCart

Public Functions

Public Functions Documentation

function GetCartItems

1static void GetCartItems(
2    Action< Cart > onSuccess,
3    Action< Error > onError,
4    string cartId =null,
5    string locale =null,
6    string currency =null
7)

Returns a list of items from the cart with the specified ID or from the cart of the current user. For each item, complete data is returned.

Parameters:

• onSuccess Called after local cache of cart items was successfully updated.
• onError Called after the request resulted with an error.
• cartId Unique cart identifier.
• locale Defines localization of item’s text fields. Two-letter lowercase language code . Leave empty to use the default value.
• currency The currency in which prices are displayed (USD by default). Three-letter currency code per ISO 4217 . Check the documentation for detailed information about currencies supported by Xsolla .

More about the use cases .

function FillCart

1static void FillCart(
2    List< CartFillItem > items,
3    Action onSuccess,
4    Action< Error > onError,
5    string cartId =null
6)

Fills the cart with the specified ID or the cart of the current user with items. If there is already an item with the same SKU in the cart, the existing item position will be replaced by the passed value.

Parameters:

• items Item for filling the cart. If there is already an item with the same SKU in the cart, the existing item position will be replaced by the passed value.
• onSuccess Called after cart is successfully filled.
• onError Called after the request resulted with an error.
• cartId Unique cart identifier.

More about the use cases .

function UpdateItemInCart

1static void UpdateItemInCart(
2    string itemSku,
3    int quantity,
4    Action onSuccess,
5    Action< Error > onError,
6    string cartId =null
7)

Updates the quantity of a previously added item in the cart with the specified ID or in the current user cart. If there is no item with the specified SKU in the cart, it will be added.

Parameters:

• itemSku SKU of item for purchase.
• quantity Quantity of purchased items.
• onSuccess Called after successfully adding a new item to the cart.
• onError Called after the request resulted with an error.
• cartId Unique cart identifier.

More about the use cases .

function RemoveItemFromCart

1static void RemoveItemFromCart(
2    string itemSku,
3    Action onSuccess,
4    Action< Error > onError,
5    string cartId =null
6)

Removes the item from the cart with the specified ID or from the cart of the current user.

Parameters:

• itemSku Item SKU to delete.
• onSuccess Called after successfully removing an item from the cart.
• onError Called after the request resulted with an error.
• cartId Unique cart identifier.

More about the use cases .

function ClearCart

1static void ClearCart(
2    Action onSuccess,
3    Action< Error > onError,
4    string cartId =null
5)

Removes all items from the cart with the specified ID or from the cart of the current user.

Parameters:

• onSuccess Called after successful cart clearing.
• onError Called after the request resulted with an error.
• cartId Unique cart identifier.

More about the use cases .

function RedeemPromocode

1static void RedeemPromocode(
2    string promocode,
3    string cartId,
4    Action< Cart > onSuccess,
5    Action< Error > onError
6)

Redeems a promo code. After activating the promo code, the user gets free items and/or the price of the cart is reduced.

Parameters:

• promocode Unique code of promocode. Contains letters and numbers.
• cartId Unique cart identifier. The current user cart will be updated if empty.
• onSuccess Called after successful promocode redemption.
• onError Called after the request resulted with an error.

More about the use cases .

function GetPromocodeReward

1static void GetPromocodeReward(
2    string promocode,
3    Action< PromocodeReward > onSuccess,
4    Action< Error > onError
5)

Returns a list of items that can be credited to the user when the promo code is activated. Allows users to choose from several available items.

Parameters:

• promocode Unique code of promocode. Contains letters and numbers.
• onSuccess Called after successfully receiving promocode rewards.
• onError Called after the request resulted with an error.

More about the use cases .

function RemovePromocodeFromCart

1static void RemovePromocodeFromCart(
2    string cartId,
3    Action< RemovePromocodeFromCartResult > onSuccess,
4    Action< Error > onError =null
5)

Removes a promo code from a cart. After the promo code is removed, the total price of all items in the cart will be recalculated without bonuses and discounts provided by a promo code.

Parameters:

• cartId Cart ID. The current user cart will be updated if empty.
• onSuccess Called after the promo code has been successful removed from cart.
• onError Called after the request resulted with an error.

More about the use cases .

function CreateOrder

1static void CreateOrder(
2    Action< OrderData > onSuccess,
3    Action< Error > onError,
4    string cartId =null,
5    PurchaseParams purchaseParams =null,
6    Dictionary< string, string > customHeaders =null
7)

Creates an order with items from the cart with the specified ID. Returns the payment token and order ID. The created order will get a new order status.

Parameters:

• onSuccess Called after the order was successfully created.
• onError Called after the request resulted with an error.
• cartId Unique cart identifier.
• purchaseParams Purchase parameters such as country, locale, currency, and quantity.
• customHeaders Custom HTTP request headers.

More about the use cases .

function CreateOrderWithFreeCart

1static void CreateOrderWithFreeCart(
2    Action< OrderId > onSuccess,
3    Action< Error > onError,
4    string cartId =null,
5    PurchaseParams purchaseParams =null,
6    Dictionary< string, string > customHeaders =null
7)

Create order with particular free cart. The created order will get a done order status.

Parameters:

• onSuccess Called after server response.
• onError Called after the request resulted with an error.
• cartId Unique cart identifier.
• purchaseParams Purchase parameters such as country, locale, currency, and quantity.
• customHeaders Custom HTTP request headers.

More about the use cases .

function Purchase

 1static void Purchase(
 2    Action< OrderStatus > onSuccess,
 3    Action< Error > onError,
 4    string cartId =null,
 5    Action< BrowserCloseInfo > onBrowseClosed =null,
 6    PurchaseParams purchaseParams =null,
 7    Dictionary< string, string > customHeaders =null,
 8    PlatformSpecificAppearance platformSpecificAppearance =null,
 9    SdkType sdkType =SdkType.Store
10)

Launches purchase process for the cart with the specified ID or for the cart of the current user. This method encapsulates methods for creating an order, opening a payment UI, and tracking the order status.

Parameters:

• onSuccess Called after the order transitions to the ‘done’ status.
• onError Called after the request resulted with an error.
• cartId Unique cart identifier.
• 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 parameters such as country, locale, and currency.
• customHeaders Custom HTTP request headers.
• platformSpecificAppearance Additional settings of payment UI appearance for different platforms.
• sdkType SDK type. Used for internal analytics.

More about the use cases .

function PurchaseFreeCart

1static void PurchaseFreeCart(
2    Action< OrderStatus > onSuccess,
3    Action< Error > onError,
4    string cartId =null,
5    PurchaseParams purchaseParams =null,
6    Dictionary< string, string > customHeaders =null,
7    SdkType sdkType =SdkType.Store
8)

Launches purchase process for the free cart with the specified ID or for the free cart of the current user. This method encapsulates methods for creating an order and tracking the order status.

Parameters:

• onSuccess Called after the order transitions to the ‘done’ status.
• onError Called after the request resulted with an error.
• cartId Unique cart identifier.
• purchaseParams Purchase parameters such as country, locale, and currency.
• customHeaders Custom HTTP request headers.
• sdkType SDK type. Used for internal analytics.

More about the use cases .