{"templateId":"openapi_docs","sharedDataIds":{"openAPIDocsStore":"oas-api/liveops/index.yaml","sidebar":"sidebar-liveops-en.sidebars.yaml"},"props":{"definitionId":"api/liveops/index.yaml","dynamicMarkdocComponents":[],"baseSlug":"/api/liveops","seo":{"title":"Overview","llmstxt":{"hide":false,"sections":[{"title":"Table of contents","includeFiles":["**/*"],"excludeFiles":[]}],"excludeFiles":[]},"description":"Upsell is a sales method in which the user is offered to buy an item with additional value. For example, this could be the item that is in the greatest demand among other users. You can also configure regional restrictions for upsell items. For detailed information, refer to the [Upsell](/liveops/promotion-tools/upsell/) section.\n\nThe list of items configured for upsell and the upsell status (enabled or disabled) are returned by the [Get information about upsell in project](/api/liveops/upsell-admin/get-upsell-configurations-for-project-admin) API method. On the client side, the list of items is returned by the [Get list of upsell items in project](/api/liveops/upsell-client/get-upsell-for-project-client) API method and displayed to the user at the appropriate point in the purchase flow.\n\nUpsell configuration scenario:\n\n1. Create items using the API calls from the **Admin** subsection of the [Virtual items and currency](/api/catalog/virtual-items-currency-admin/admin-get-virtual-items-list/), [Bundles](/api/catalog/bundles-admin/admin-create-bundle), or [Game keys](/api/catalog/game-keys-admin) groups.\n2. Set up the upsell using the [Create upsell](/api/liveops/upsell-admin/post-upsell) API call. Pass the SKUs of the required items in the `items` array.\n3. Activate upsell for the project using the [Activate/Deactivate project's upsell](/api/liveops/upsell-admin/put-upsell-toggle-active-inactive) API call.\n4. Display the upsell offer to the user at the appropriate point in the purchase flow using the [Get list of upsell items in project](/api/liveops/upsell-client/get-upsell-for-project-client) API call.\n5. Implement the opening of the payment UI to pay for the order. For example, you can use the [Create order with all items from particular cart](/api/catalog/payment-client-side/create-order-by-cart-id) API call. The response returns a token to open the payment UI.\n6. Configure order status tracking, e.g., using [webhooks](/webhooks/overview), to promptly receive data about successfully paid items and grant them to the user.\n\n![Upsell scenario](https://cdn.xsolla.net/developers/current/images/api_docs/Upsell.svg)\n"},"itemId":"upsell-overview","disableAutoScroll":true,"metadata":{},"compilationErrors":[],"markdown":{"partials":{},"variables":{"rbac":{"teams":["anonymous"]},"user":{},"remoteAddr":{"hostname":"xsolla.redocly.app","port":4000,"ipAddress":"185.30.21.18"},"lang":"en","env":{"PUBLIC_REDOCLY_BRANCH_NAME":"realm"}}},"pagePropGetterError":{"message":"","name":""}},"slug":"/api/liveops/upsell-overview","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}