Saltar para o conteúdo
/
Obter conjunto

Catalog API (2.0.0)

Overview

  • Version: 2.0.0
  • Servers: https://store.xsolla.com/api
  • Contact Us by Email
  • Contact URL: https://xsolla.com/
  • Required TLS version: 1.2

The Catalog API allows you to configure a catalog of in-game items on the Xsolla side and display the catalog to users in your store.

The API allows you to manage the following catalog entities:

  • Virtual items — in-game items such as weapons, skins, boosters.
  • Virtual currency — virtual money used to purchase virtual goods.
  • Virtual currency packages — predefined bundles of virtual currency.
  • Bundles — combined packages of virtual items, currency, or game keys sold as a single SKU.
  • Game keys — keys for games and DLCs distributed via platforms like Steam or other DRM providers.
  • Groups — logical groupings for organizing and sorting items within the catalog.

API calls

The API is divided into the following groups:

  • Admin — calls for creating, updating, deleting, and configuring catalog items and groups. Authenticated via basic access authentication with your merchant or project credentials. Not intended for storefront use.
  • Catalog — calls for retrieving items and building custom storefronts for end users. Designed to handle high-load scenarios. Support optional user JWT authorization to return personalized data such as user-specific limits and active promotions.

Authentication

API calls require authentication either on behalf of a user or on behalf of a project. The authentication scheme used is specified in the Security section in the description of each call.

Authentication using user's JWT

User's JWT authentication is used when a request is sent from a browser, mobile application, or game. By default, the XsollaLoginUserJWT scheme is applied. For details on how to create a token, see the Xsolla Login API documentation.

The token is passed in the Authorization header in the following format: Authorization: Bearer <user_JWT>, where <user_JWT> is the user token. The token identifies the user and provides access to personalized data.

Alternativamente, você pode usar um token para abrir a interface de pagamento.

Basic HTTP authentication

Basic HTTP authentication is used for server-to-server interactions, when an API call is sent directly from your server rather than from a user's browser or mobile application. HTTP Basic authentication with an API key is typically used.

Note

The API key is confidential and must not be stored or used in client applications.

With basic server-side authentication, all API requests must include the following header:

  • for basicAuth — Authorization: Basic <your_authorization_basic_key>, where your_authorization_basic_key is the project_id:api_key pair encoded in Base64
  • for basicMerchantAuth — Authorization: Basic <your_authorization_basic_key>, where your_authorization_basic_key is the merchant_id:api_key pair encoded in Base64

You can find the parameter values in Publisher Account:

  • merchant_id is displayed:
    • In Company settings > Company.
    • In the URL in the browser address bar on any Publisher Account page. The URL has the following format: https://publisher.xsolla.com/<merchant_id>.
  • project_id is displayed:
    • Next to the project name in Publisher Account.
    • In the URL in the browser address bar when working on a project in Publisher Account. The URL has the following format: https://publisher.xsolla.com/<merchant_id>/projects/<project_id>.
  • api_key is shown in Publisher Account only at the time of creation and must be stored securely on your side. You can create an API key in the following sections:
Notice

If a required API call doesn't include the project_id path parameter, use an API key that is valid across all company projects for authorization.

For more information about working with API keys, see the API references.

Authentication with guest access support

O esquema de autenticação AuthForCart é utilizado para as compras de carrinhos e suporta dois modos:

  1. Authentication with a user's JWT. The token is passed in the Authorization header in the following format: Authorization: Bearer <user_JWT>, where <user_JWT> is the user token. The token identifies the user and provides access to personalized data. Alternatively, you can use a token for opening the payment UI.

  2. Simplified mode without Authorization header. This mode is used only for unauthorized users and can be applied only for game key sales. Instead of a token, the request must include the following headers:

    • x-unauthorized-id with a request ID
    • x-user with the user's email address encoded in Base64

Core entity structure

Items of all types (virtual items, bundles, virtual currency, and keys) use a similar data structure. Understanding the basic structure simplifies working with the API and helps you navigate the documentation more easily.

Note

Some calls may include additional fields but they don't change the basic structure.

Identification

  • merchant_id — company ID in Publisher Account
  • project_id — project ID in Publisher Account
  • sku — item SKU, unique within the project

Store display

  • name — item name
  • description — item description
  • image_url — image URL
  • is_enabled — item availability
  • is_show_in_store — whether the item is displayed in the catalog

For more information about managing item availability in the catalog, see the documentation.

Organization

  • type — item type, for example, a virtual item (virtual_item) or bundle (bundle)
  • groups — groups the item belongs to
  • order — display order in the catalog

Sale conditions

  • prices — prices in real or virtual currency
  • limits — purchase limits
  • periods — availability periods
  • regions — regional restrictions

Example of core entity structure:

{
  "attributes": [],
  "bundle_type": "virtual_currency_package",
  "content": [
    {
      "description": {
        "en": "Main in-game currency"
      },
      "image_url": "https://.../image.png",
      "name": {
        "en": "Crystals",
        "de": "Kristalle"
      },
      "quantity": 500,
      "sku": "com.xsolla.crystal_2",
      "type": "virtual_currency"
    }
  ],
  "description": {
    "en": "Crystals x500"
  },
  "groups": [],
  "image_url": "https://.../image.png",
  "is_enabled": true,
  "is_free": false,
  "is_show_in_store": true,
  "limits": {
    "per_item": null,
    "per_user": null,
    "recurrent_schedule": null
  },
  "long_description": null,
  "media_list": [],
  "name": {
    "en": "Medium crystal pack"
  },
  "order": 1,
  "periods": [
    {
      "date_from": null,
      "date_until": "2020-08-11T20:00:00+03:00"
    }
  ],
  "prices": [
    {
      "amount": 20,
      "country_iso": "US",
      "currency": "USD",
      "is_default": true,
      "is_enabled": true
    }
  ],
  "regions": [],
  "sku": "com.xsolla.crystal_pack_2",
  "type": "bundle",
  "vc_prices": []
}

Basic purchase flow

The Xsolla API allows you to implement in-game store logic, including retrieving the item catalog, managing the cart, creating orders, and tracking their status. Depending on the integration scenario, API calls are divided into Admin and Catalog subsections, which use different authentication schemes.

The following example shows a basic flow for setting up and operating a store, from item creation to purchase.

Create items and groups (Admin)

Create an item catalog for your store, such as virtual items, bundles, or virtual currency.

Example API calls:

Set up promotions, chains, and limits (Admin)

Configure user acquisition and monetization tools, such as discounts, bonuses, daily rewards, or offer chains.

Example API calls:

Get item information (Client)

Configure item display in your application.

Notice

Do not use API calls from the Admin subsection to build a user catalog. These API calls have rate limits and aren't intended for user traffic.

Example API calls:

Note

By default, catalog API calls return items that are currently available in the store at the time of the request. To retrieve items that are not yet available or are no longer available, include the parameter "show_inactive_time_limited_items": 1 in the catalog request.

Sell items

You can sell items using the following methods:

  • Fast purchase — sell one SKU multiple times.
  • Cart purchase — the user adds items to the cart, removes items, and updates quantities within a single order.

If an item is purchased using virtual currency instead of real money, use the Create order with specified item purchased by virtual currency API call. The payment UI is not required, as the charge is processed when the API call is executed.

For free item purchase, use the Create order with specified free item API call or the Create order with free cart API call. The payment UI is not required — the order is immediately set to the done status.

Fast purchase

Use the client-side API call to create an order with a specified item. The call returns a token used to open the payment UI.

Note

Discount information is available to the user only in the payment UI. Promo codes are not supported.

Cart purchase

Cart setup and purchase can be performed on the client or on the server side.

Set up and purchase a cart on the client

Implement the logic of adding and removing items by yourself. Before calling the API for setting up a cart, you will not have information about which promotions will be applied to the purchase. This means that the total cost and details of the added bonus items will not be known.

Implement the following cart logic:

  1. After the player has filled a cart, use the Fill cart with items API call. The call returns the current information about the selected items (prices before and after discounts, bonus items).
  2. Update the cart contents based on user actions:
Note

To get the current status of the cart, use the Get current user's cart API call.
  1. Use the Create order with all items from current cart API call. The call returns the order ID and payment token. The newly created order is set to new status by default.

Set up and purchase a cart on the server

This setup option may take longer for setting the cart up, since each change to the cart must be accompanied by API calls.

Implement the following cart logic:

  1. After the player has filled a cart, use the Fill cart with items API call. The call returns current information about the selected items (prices before and after discounts, bonus items).
  2. Use the Create order with all items from current cart API call. The call returns the order ID and payment token. The newly created order is set to new status by default.

Open payment UI

Use the returned token to open the payment UI in a new window. Other ways to open the payment UI are described in the documentation.

ActionEndpoint
Open in production environment.https://secure.xsolla.com/paystation4/?token={token}
Open in sandbox mode.https://sandbox-secure.xsolla.com/paystation4/?token={token}
Note

Use sandbox mode during development and testing. Test purchases don't charge real accounts. You can use test bank cards.

After the first real payment is made, a strict sandbox payment policy takes effect. A payment in sandbox mode is available only to users specified in Publisher Account > Company settings > Users.

Buying virtual currency and items for real currency is possible only after signing a license agreement with Xsolla. To do this, in Publisher Account, go to Agreements & Taxes > Agreements, complete the agreement form, and wait for confirmation. It may take up to 3 business days to review the agreement.

To enable or disable sandbox mode, change the value of the sandbox parameter in the request for fast purchase and cart purchase. Sandbox mode is off by default.

Possible order statuses:

  • new — order created
  • paid — payment received
  • done — item delivered
  • canceled — order canceled
  • expired — order expired

Track order status using one of the following methods:

Pagination

API calls that return large sets of records (for example, when building a catalog) return data in pages. Pagination is a mechanism that limits the number of items returned in a single API response and allows you to retrieve subsequent pages sequentially.

Use the following parameters to control the number of returned items:

  • limit — number of items per page
  • offset — index of the first item on the page (numbering starts from 0)
  • has_more — indicates whether another page is available
  • total_items_count — total number of items

Example request:

GET /items?limit=20&offset=40

Response example:

{
  "items": [...],
  "has_more": true,
  "total_items_count": 135
}

It is recommended to send subsequent requests until the response returns has_more = false.

Date and time format

Dates and time values are passed in the ISO 8601 format.

The following are supported:

  • UTC offset
  • null value when there is no time restriction for displaying an item
  • Unix timestamp (in seconds) used in some fields

Format: YYYY-MM-DDTHH:MM:SS±HH:MM

Example: 2026-03-16T10:00:00+03:00

Localization

Xsolla supports localization of user-facing fields such as item name and description. Localized values are passed as an object where the language code is used as the key. The full list of supported languages is available in the documentation.

Supported fields

Localization can be specified for the following parameters:

  • name
  • description
  • long_description

Locale format

The locale key can be specified in one of the following formats:

  • Two-letter language code: en, ru
  • Five-letter language code: en-US, ru-RU, de-DE

Examples

Example with a two-letter language code:

{
  "name": {
    "en": "Starter Pack",
    "ru": "Стартовый набор"
  }
}

Example with a five-letter language code:

{
  "description": {
    "en-US": "Premium bundle",
    "de-DE": "Premium-Paket"
  }
}

Country and currency determination

The user's country determines catalog prices, the payment currency, and available payment methods in the payment UI. Depending on the API call, the country is determined as follows:

  • In client-side API calls, the country is determined by the IP address of the request.
  • In server-side API calls, the country is determined by the value of the user.country.value parameter or by the user's IP address from the X-User-Ip header. If both are passed, the user.country.value parameter takes precedence.
Note

Only IPv4 addresses are supported for country determination. Passing an IPv6 address may result in incorrect country and currency detection. If you use the server-side API call and cannot provide the user's IPv4 address, pass the country in the user.country.value parameter.

Error response format

If an error occurs, the API returns an HTTP status and a JSON response body. The full list of store-related errors is available in the documentation.

Response example:

{
  "errorCode": 1102,
  "errorMessage": "Validation error",
  "statusCode": 422,
  "transactionId": "c9e1a..."
}
  • errorCode — error code.
  • errorMessage — short error description.
  • statusCode — HTTP response status.
  • transactionId — request ID. Returned only in some cases.
  • errorMessageExtended — additional error details, such as request parameters. Returned only in some cases.

Extended response example:

{
  "errorCode": 7001,
  "errorMessage": "Chain not found",
  "errorMessageExtended": {
    "chain_id": "test_chain_id",
    "project_id": "test_project_id",
    "step_number": 2
  },
  "statusCode": 404
}

Common HTTP status codes

  • 400 — invalid request
  • 401 — authentication error
  • 403 — insufficient permissions
  • 404 — resource not found
  • 422 — validation error
  • 429 — rate limit exceeded

Recommendations

  • Handle the HTTP status and the response body together.
  • Use errorCode to process errors related to application logic.
  • Use transactionId to identify requests more quickly when analyzing errors.
Transferir a descrição da OpenAPI
index.json
index.yaml
Idiomas
Servidores
https://store.xsolla.com/api/
Mock server
https://xsolla.redocly.app/_mock/pt/api/catalog/

Visão geral

Você pode usar itens virtuais e moedas virtuais para construir uma loja no jogo e configurar como ela é exibida para os usuários. Os seguintes tipos de itens estão disponíveis:

  • Itens virtuais — bens no jogo como armas, skins ou impulsionadores. Podem ser vendidos por dinheiro real ou moedas virtuais.
  • Moeda virtual — moeda no jogo usada para comprar itens virtuais. Pode ser vendida por moedas reais ou moedas virtuais.
  • Pacotes de moedas virtuais — uma quantidade fixa de moedas virtuais. Pode ser vendida por moedas reais ou moedas virtuais.

Grupos são usados para organizar itens no catálogo. Eles permitem agrupar logicamente os itens e gerenciar como eles são exibidos.

Use chamadas de API da subseção Admin para criar, atualizar e excluir itens.

Use chamadas de API da subseção Catálogo para recuperar listas de itens e exibi-los aos usuários.

Aviso

Não use chamadas de API da subseção Admin para construir um catálogo de loja.

Nota

A chamada de API Obter lista de itens virtuais retorna dados detalhados dos itens, incluindo preços e atributos, e suporta paginação. Use-a para exibir páginas de catálogo na vitrine.

A chamada de API Obter lista de todos os itens virtuais retorna o SKU do item, nome, descrição, bem como ID e nome do grupo sem paginação. Use-a para busca ou indexação do lado do cliente.

Para compras com moedas virtuais, use a chamada de API Criar pedido com item especificado comprado por moeda virtual. A interface de pagamento não é necessária — a cobrança é processada quando a chamada de API é executada.

Exemplo de fluxo de compra com moeda virtual:

Exemplo de fluxo de compra com moeda virtual

Admin

Operações

Catálogo

Operações

Pagamento virtual

Operações

Visão geral

Chaves de jogo são códigos alfanuméricos exclusivos de uso único que concedem acesso a um jogo ou DLC em plataformas de jogos para usuários. Você pode vender chaves de jogo via link direto, pela interface da loja, ou via widget. Você também pode configurar restrições regionais para vender chaves de jogo em países específicos. Para obter informações detalhadas, consulte a seção pacotes de chaves de jogo.

Não é necessário estar autenticado para vender chaves de jogo — as chaves são enviadas ao e-mail que o usuário especifica na compra. Você pode configurar a autenticação para habilitar cenários adicionais: personalização, limites de compra, ou um sistema de direitos. Para obter informações mais detalhadas, consulte a seção Como configurar a autenticação ao vender chaves de jogo.

Fluxo de venda de chaves de jogo:

  1. Crie um jogo usando a chamada de API Criar jogo API call.
  2. Configure restrições regionais.
  3. Envie chaves a um pacote de chaves de jogo usando a chamada de API Enviar códigos para torná-las disponíveis para compra.
  4. Exiba o catálogo de jogos com preços para a região do usuário usando a chamada de API Obter lista de jogos API call.
  5. Crie um pedido. Para criar uma compra rápida, você pode usar a chamada de API Criar pedido com todos os itens do carrinho atual, passando o SKU da chave de jogo. A resposta retorna um token para abrir a interface de pagamento.
  6. Implemente a abertura da interface de pagamento para pagar pelo pedido.

Para receber notificações sobre pagamentos bem-sucedidos e entregar itens ao usuário, configure o rastreamento do status de pedidos, por exemplo, usando webhooks. As chaves são enviadas ao e-mail especificado pelo usuário na compra, e o pedido transita para o status done.

Chaves de jogo

Catálogo

Operações

Direito

Operações

Admin

Operações

Visão geral

Conjuntos são grupos de itens vendidos como uma unidade única. Um conjunto pode incluir itens virtuais, moedas virtuais, pacotes de moedas virtuais, chaves de jogo, e outros conjuntos. Use conjuntos para criar pacotes de iniciantes, ofertas sazonais e ofertas especiais.

Use os seguintes grupos de chamada de API com conjuntos:

  • Use chamadas de API da subseção Admin para criar, atualizar, excluir conjuntos e gerenciar sua visibilidade.
  • Use chamadas de API da subseção Catálogo para recuperar conjuntos.

Os limites de compra são configurados pelo objeto limits ao criar ou atualizar um conjunto. Para mais informações, consulte a visão geral de limites. Você também pode configurar restrições regionais para vender itens em países específicos.

Nota

Para mais informações sobre a configuração de conjuntos, consulte a seção Conjuntos.

Cenário de gestão de conjuntos:

  1. Crie um conjunto usando a chamada de API Criar conjunto. Para verificar o conjunto criado, use a chamada de API Obter conjunto. Para recuperar todos os conjuntos no projeto, use a chamada de API Obter lista de conjuntos.
  2. Se necessário, use a chamada de API Atualizar conjunto para modificar o conteúdo do conjunto ou as configurações.
  3. Implemente a lógica de exibição do conjunto na sua vitrine usando as chamadas de API Obter lista de conjuntos, Obter conjunto específico, ou Obter lista de conjuntos por grupo especificado.
  4. Crie um pedido usando a seção Carrinho e pagamento. Por exemplo, para uma compra rápida, você pode usar a chamada de API Criar pedido com o item especificado, passando o SKU do conjunto. A resposta contém um token para abrir a interface de pagamento.
  5. Implemente usando a interface de pagamento para pagar pelo pedido.
  6. Configure o rastreamento de status de pedidos, por exemplo, usando webhooks para receber dados sobre itens pagos com sucesso prontamente e concedê-los ao usuário.

Cenário de gestão de conjuntos

Admin

Operações

Excluir conjuntoServer-sideAdmin

Pedido

Exclui um conjunto.

Segurança
basicAuth
Caminho
project_idintegerobrigatório

ID de projeto. Você pode encontrar esse parâmetro na sua Conta de Distribuidor, próximo ao nome do projeto e na barra de endereços do navegador ao trabalhar com um projeto. O URL tem o seguinte formato: https://publisher.xsolla.com/<merchant_id>/projects/<project_id>.

Exemplo: 44056
skustringobrigatório

SKU de conjunto.

Exemplo: kg_1
curl -i -X DELETE \
  -u <username>:<password> \
  https://store.xsolla.com/api/v2/project/44056/admin/items/bundle/sku/kg_1

Respostas

Conjunto excluído com sucesso.

Corpo
Resposta
Sem conteúdo

Obter conjuntoServer-sideAdmin

Pedido

Obtém o conjunto dentro de um projeto para administração.

Observação

Não use esse ponto de extremidade para criar um catálogo de loja.
Segurança
basicAuth
Caminho
project_idintegerobrigatório

ID de projeto. Você pode encontrar esse parâmetro na sua Conta de Distribuidor, próximo ao nome do projeto e na barra de endereços do navegador ao trabalhar com um projeto. O URL tem o seguinte formato: https://publisher.xsolla.com/<merchant_id>/projects/<project_id>.

Exemplo: 44056
skustringobrigatório

SKU de conjunto.

Exemplo: kg_1
curl -i -X GET \
  -u <username>:<password> \
  https://store.xsolla.com/api/v2/project/44056/admin/items/bundle/sku/kg_1

Respostas

O conjunto especificado foi recebido com sucesso.

Corpoapplication/json
item_idinteger[ 1 .. 255 ] characters

ID de item exclusivo interno.

skustring[ 1 .. 255 ] characters^[a-zA-Z0-9_\-–.]*$

ID de item exclusivo. O SKU só pode conter caracteres alfanuméricos latinos minúsculos e maiúsculos, pontos, traços e sublinhados.

name(object or null)

Objeto com traduções para o nome do item. Aceita valores em um dos dois formatos: códigos de idioma minúsculos de duas letras (por exemplo, en) ou códigos de idioma de cinco caracteres (por exemplo, en-US). Embora ambos os formatos sejam aceitos, as respostas retornam códigos de idioma minúsculos de duas letras. Quando ambas as opções para o mesmo idioma são fornecidas (por exemplo, en e en-US), o último valor fornecido é armazenado. Você pode encontrar a lista completa de idiomas suportados na documentação.

Any of:

Códigos de idioma minúsculos de duas letras.

name.​enstring or null

Inglês

name.​arstring or null

Árabe

name.​bgstring or null

Búlgaro

name.​cnstring or null

Chinês (Simplificado)

name.​csstring or null

Tcheco

name.​destring or null

Alemão

name.​esstring or null

Espanhol (Espanha)

name.​frstring or null

Francês

name.​hestring or null

Hebraico

name.​itstring or null

Italiano

name.​jastring or null

Japonês

name.​kostring or null

Coreano

name.​plstring or null

Polonês

name.​ptstring or null

Português

name.​rostring or null

Romeno

name.​rustring or null

Russo

name.​thstring or null

Tailandês

name.​trstring or null

Turco

name.​twstring or null

Chinês (Tradicional)

name.​vistring or null

Vietnamita

name.​kmstring or null

Khmer

name.​idstring or null

Indonésio

name.​lostring or null

Lao

name.​mystring or null

Birmanês

name.​phstring or null

Filipino

name.​nestring or null

Nepalês

attributesArray of objects

Lista de atributos.

Exemplo: [{"external_id":"attribute_external_id","name":{"en":"Attribute name","de":"Attributname"},"values":[{"external_id":"value_1","name":{"en":"value 1","de":"wert 1"}},{"external_id":"value_2","name":{"en":"value 2","de":"wert 2"}}]}]
attributes[].​external_idstring[ 1 .. 255 ] characters^[a-zA-Z0-9-_]+$obrigatório

ID de atributo exclusivo. O external_id só pode conter caracteres alfanuméricos latinos minúsculos e maiúsculos, traços e sublinhados.

Exemplo: "attribute_external_id"
attributes[].​nameobject

Objeto com localizações para o nome do atributo. As chaves são especificadas no formato ISO 3166-1.

Exemplo: {"en":"Attribute name","de":"Attributname"}
attributes[].​name.​property name*stringpropriedade adicional
attributes[].​valuesArray of objectsobrigatório
Exemplo: [{"external_id":"value_1","name":{"en":"value 1","de":"wert 1"}},{"external_id":"value_2","name":{"en":"value 2","de":"wert 2"}}]
attributes[].​values[].​external_idstring[ 1 .. 255 ] characters^[-_.\d\w]+$obrigatório

ID de valor exclusivo para um atributo. O external_id pode conter apenas caracteres alfanuméricos latinos minúsculos, traços e sublinhados.

Exemplo: "value_external_id"
attributes[].​values[].​valueobjectobrigatório

Objeto com traduções do nome do valor. As chaves são especificadas no formato ISO 3166-1.

attributes[].​values[].​value.​property name*stringpropriedade adicional
typestring

Tipo de item.

bundle_typestring

Tipo de pacote. Devolvido se o tipo de item for um pacote.

Enum"standard""virtual_currency_package""partner_side_content"
description(object or null)

Objeto com traduções para a descrição do item. Aceita valores em um dos dois formatos: códigos de idioma minúsculos de duas letras (por exemplo, en) ou códigos de localidade de cinco caracteres (por exemplo, en-US). Embora ambos os formatos sejam aceitos, as respostas retornam códigos de idioma minúsculos de duas letras. Quando ambas as opções para o mesmo idioma são fornecidas (por exemplo, en e en-US), o último valor fornecido é armazenado. Você pode encontrar a lista completa de idiomas suportados na documentação.

Any of:

Códigos de idioma minúsculos de duas letras.

description.​enstring or null

Inglês

description.​arstring or null

Árabe

description.​bgstring or null

Búlgaro

description.​cnstring or null

Chinês (Simplificado)

description.​csstring or null

Tcheco

description.​destring or null

Alemão

description.​esstring or null

Espanhol (Espanha)

description.​frstring or null

Francês

description.​hestring or null

Hebraico

description.​itstring or null

Italiano

description.​jastring or null

Japonês

description.​kostring or null

Coreano

description.​plstring or null

Polonês

description.​ptstring or null

Português

description.​rostring or null

Romeno

description.​rustring or null

Russo

description.​thstring or null

Tailandês

description.​trstring or null

Turco

description.​twstring or null

Chinês (Tradicional)

description.​vistring or null

Vietnamita

description.​kmstring or null

Khmer

description.​idstring or null

Indonésio

description.​lostring or null

Lao

description.​mystring or null

Birmanês

description.​phstring or null

Filipino

description.​nestring or null

Nepalês

long_description(object or null)

Objeto com traduções para a descrição longa do item. Aceita valores em um dos dois formatos: códigos de idioma minúsculos de duas letras (por exemplo, en) ou códigos de localidade de cinco caracteres (por exemplo, en-US). Embora ambos os formatos sejam aceitos, as respostas retornam códigos de idioma minúsculos de duas letras. Quando ambas as variantes para o mesmo idioma são fornecidas (por exemplo, en e en-US), o último valor fornecido é armazenado. Você pode encontrar a lista completa de idiomas suportados na documentação.

Any of:

Códigos de idioma minúsculos de duas letras.

long_description.​enstring or null

Inglês

long_description.​arstring or null

Árabe

long_description.​bgstring or null

Búlgaro

long_description.​cnstring or null

Chinês (Simplificado)

long_description.​csstring or null

Tcheco

long_description.​destring or null

Alemão

long_description.​esstring or null

Espanhol (Espanha)

long_description.​frstring or null

Francês

long_description.​hestring or null

Hebraico

long_description.​itstring or null

Italiano

long_description.​jastring or null

Japonês

long_description.​kostring or null

Coreano

long_description.​plstring or null

Polonês

long_description.​ptstring or null

Português

long_description.​rostring or null

Romeno

long_description.​rustring or null

Russo

long_description.​thstring or null

Tailandês

long_description.​trstring or null

Turco

long_description.​twstring or null

Chinês (Tradicional)

long_description.​vistring or null

Vietnamita

long_description.​kmstring or null

Khmer

long_description.​idstring or null

Indonésio

long_description.​lostring or null

Lao

long_description.​mystring or null

Birmanês

long_description.​phstring or null

Filipino

long_description.​nestring or null

Nepalês

image_urlstring or null

URL da imagem. Para que a imagem seja exibida corretamente e carregue rapidamente na interface de pagamento, confira as nossas diretrizes de imagens e URLs:

  • Formatos suportados: WebP (recomendado), PNG, JPG.
  • Tamanho do arquivo: ≤ 50 KB (para WebP) ou ≤ 150 KB (para PNG e JPG).
  • Tamanho da imagem: 280 x 280 px.
  • Espaço de cores: sRGB.
  • Protocolo: HTTPS com cache de longa duração para URLs versionados.

is_freeboolean

Se o item é gratuito ou não.

is_paid_randomized_rewardboolean

Se o item é uma recompensa paga randomizada, como uma loot box.

groupsArray of objects

Grupo aos quais o item pertence.

groups[].​external_idstring
Exemplo: "horror"
groups[].​nameobject

Nome do item. Deve conter pares chave/valor onde chave é uma localização com o formato "^[a-z]{2}", e o valor é uma cadeia de caracteres.

Padrão {"en":"Horror"}
Exemplo: {"en":"Horror","de":"Horror"}
groups[].​name.​property name*stringpropriedade adicional
pricesArray of objects

Preços em moedas reais.

prices[].​amountstring^\d*\.?\d*$obrigatório

Preço do item.

prices[].​currencystringobrigatório

Moeda do preço do item. Código de três letras de acordo com a ISO 4217.

prices[].​is_defaultbooleanobrigatório

O preço padrão é usado para criar um catálogo se nenhum preço na moeda do usuário for especificado.

prices[].​is_enabledbooleanobrigatório

O preço está habilitado.

prices[].​country_isostring or null

País onde este preço está disponível. Código de duas letras de acordo com o padrão ISO 3166-1 alpha 2.

Exemplo: "US"
virtual_pricesArray of objects
virtual_prices[].​skustring[ 1 .. 255 ] characters^[a-zA-Z0-9_\-–.]*$

ID de item exclusivo. O SKU só pode conter caracteres alfanuméricos latinos minúsculos e maiúsculos, pontos, traços e sublinhados.

virtual_prices[].​name(object or null)

Objeto com traduções para o nome do item. Aceita valores em um dos dois formatos: códigos de idioma minúsculos de duas letras (por exemplo, en) ou códigos de idioma de cinco caracteres (por exemplo, en-US). Embora ambos os formatos sejam aceitos, as respostas retornam códigos de idioma minúsculos de duas letras. Quando ambas as opções para o mesmo idioma são fornecidas (por exemplo, en e en-US), o último valor fornecido é armazenado. Você pode encontrar a lista completa de idiomas suportados na documentação.

Any of:

Códigos de idioma minúsculos de duas letras.

virtual_prices[].​name.​enstring or null

Inglês

virtual_prices[].​name.​arstring or null

Árabe

virtual_prices[].​name.​bgstring or null

Búlgaro

virtual_prices[].​name.​cnstring or null

Chinês (Simplificado)

virtual_prices[].​name.​csstring or null

Tcheco

virtual_prices[].​name.​destring or null

Alemão

virtual_prices[].​name.​esstring or null

Espanhol (Espanha)

virtual_prices[].​name.​frstring or null

Francês

virtual_prices[].​name.​hestring or null

Hebraico

virtual_prices[].​name.​itstring or null

Italiano

virtual_prices[].​name.​jastring or null

Japonês

virtual_prices[].​name.​kostring or null

Coreano

virtual_prices[].​name.​plstring or null

Polonês

virtual_prices[].​name.​ptstring or null

Português

virtual_prices[].​name.​rostring or null

Romeno

virtual_prices[].​name.​rustring or null

Russo

virtual_prices[].​name.​thstring or null

Tailandês

virtual_prices[].​name.​trstring or null

Turco

virtual_prices[].​name.​twstring or null

Chinês (Tradicional)

virtual_prices[].​name.​vistring or null

Vietnamita

virtual_prices[].​name.​kmstring or null

Khmer

virtual_prices[].​name.​idstring or null

Indonésio

virtual_prices[].​name.​lostring or null

Lao

virtual_prices[].​name.​mystring or null

Birmanês

virtual_prices[].​name.​phstring or null

Filipino

virtual_prices[].​name.​nestring or null

Nepalês

virtual_prices[].​typestring

Tipo de moeda virtual.

virtual_prices[].​description(object or null)

Objeto com traduções para a descrição do item. Aceita valores em um dos dois formatos: códigos de idioma minúsculos de duas letras (por exemplo, en) ou códigos de localidade de cinco caracteres (por exemplo, en-US). Embora ambos os formatos sejam aceitos, as respostas retornam códigos de idioma minúsculos de duas letras. Quando ambas as opções para o mesmo idioma são fornecidas (por exemplo, en e en-US), o último valor fornecido é armazenado. Você pode encontrar a lista completa de idiomas suportados na documentação.

Any of:

Códigos de idioma minúsculos de duas letras.

virtual_prices[].​description.​enstring or null

Inglês

virtual_prices[].​description.​arstring or null

Árabe

virtual_prices[].​description.​bgstring or null

Búlgaro

virtual_prices[].​description.​cnstring or null

Chinês (Simplificado)

virtual_prices[].​description.​csstring or null

Tcheco

virtual_prices[].​description.​destring or null

Alemão

virtual_prices[].​description.​esstring or null

Espanhol (Espanha)

virtual_prices[].​description.​frstring or null

Francês

virtual_prices[].​description.​hestring or null

Hebraico

virtual_prices[].​description.​itstring or null

Italiano

virtual_prices[].​description.​jastring or null

Japonês

virtual_prices[].​description.​kostring or null

Coreano

virtual_prices[].​description.​plstring or null

Polonês

virtual_prices[].​description.​ptstring or null

Português

virtual_prices[].​description.​rostring or null

Romeno

virtual_prices[].​description.​rustring or null

Russo

virtual_prices[].​description.​thstring or null

Tailandês

virtual_prices[].​description.​trstring or null

Turco

virtual_prices[].​description.​twstring or null

Chinês (Tradicional)

virtual_prices[].​description.​vistring or null

Vietnamita

virtual_prices[].​description.​kmstring or null

Khmer

virtual_prices[].​description.​idstring or null

Indonésio

virtual_prices[].​description.​lostring or null

Lao

virtual_prices[].​description.​mystring or null

Birmanês

virtual_prices[].​description.​phstring or null

Filipino

virtual_prices[].​description.​nestring or null

Nepalês

virtual_prices[].​image_urlstring or null

URL da imagem. Para que a imagem seja exibida corretamente e carregue rapidamente na interface de pagamento, confira as nossas diretrizes de imagens e URLs:

  • Formatos suportados: WebP (recomendado), PNG, JPG.
  • Tamanho do arquivo: ≤ 50 KB (para WebP) ou ≤ 150 KB (para PNG e JPG).
  • Tamanho da imagem: 280 x 280 px.
  • Espaço de cores: sRGB.
  • Protocolo: HTTPS com cache de longa duração para URLs versionados.

virtual_prices[].​amountstring^\d*\.?\d*$

Preço do item com desconto.

virtual_prices[].​is_defaultboolean

Se o preço é padrão para um item.

media_listArray of objects or null
Any of:

Ativos adicionais do conjunto.

media_list[].​typestring

Tipo de mídia: image/video.

Enum"image""video"
Exemplo: "image"
media_list[].​urlstring

Arquivo de recurso.

Exemplo: "https://cdn3.xsolla.com/img/misc/images/71ab1e12126f2103e1868076f0acb21a.jpg"
orderinteger

Prioridade de pedido do conjunto na lista.

is_enabledboolean

Se estiver desativado, o item não poderá ser encontrado nem comprado.

is_show_in_storeboolean

O item está disponível para compra.

regionsArray of objects
regions[].​idinteger>= 1
Exemplo: 1
contentArray of objects
content[].​skustring[ 1 .. 255 ] characters^[a-zA-Z0-9_\-–.]*$

ID de item exclusivo. O SKU só pode conter caracteres alfanuméricos latinos minúsculos e maiúsculos, pontos, traços e sublinhados.

content[].​name(object or null)

Objeto com traduções para o nome do item. Aceita valores em um dos dois formatos: códigos de idioma minúsculos de duas letras (por exemplo, en) ou códigos de idioma de cinco caracteres (por exemplo, en-US). Embora ambos os formatos sejam aceitos, as respostas retornam códigos de idioma minúsculos de duas letras. Quando ambas as opções para o mesmo idioma são fornecidas (por exemplo, en e en-US), o último valor fornecido é armazenado. Você pode encontrar a lista completa de idiomas suportados na documentação.

Any of:

Códigos de idioma minúsculos de duas letras.

content[].​name.​enstring or null

Inglês

content[].​name.​arstring or null

Árabe

content[].​name.​bgstring or null

Búlgaro

content[].​name.​cnstring or null

Chinês (Simplificado)

content[].​name.​csstring or null

Tcheco

content[].​name.​destring or null

Alemão

content[].​name.​esstring or null

Espanhol (Espanha)

content[].​name.​frstring or null

Francês

content[].​name.​hestring or null

Hebraico

content[].​name.​itstring or null

Italiano

content[].​name.​jastring or null

Japonês

content[].​name.​kostring or null

Coreano

content[].​name.​plstring or null

Polonês

content[].​name.​ptstring or null

Português

content[].​name.​rostring or null

Romeno

content[].​name.​rustring or null

Russo

content[].​name.​thstring or null

Tailandês

content[].​name.​trstring or null

Turco

content[].​name.​twstring or null

Chinês (Tradicional)

content[].​name.​vistring or null

Vietnamita

content[].​name.​kmstring or null

Khmer

content[].​name.​idstring or null

Indonésio

content[].​name.​lostring or null

Lao

content[].​name.​mystring or null

Birmanês

content[].​name.​phstring or null

Filipino

content[].​name.​nestring or null

Nepalês

content[].​typestring

Tipo de item.

content[].​description(object or null)

Objeto com traduções para a descrição do item. Aceita valores em um dos dois formatos: códigos de idioma minúsculos de duas letras (por exemplo, en) ou códigos de localidade de cinco caracteres (por exemplo, en-US). Embora ambos os formatos sejam aceitos, as respostas retornam códigos de idioma minúsculos de duas letras. Quando ambas as opções para o mesmo idioma são fornecidas (por exemplo, en e en-US), o último valor fornecido é armazenado. Você pode encontrar a lista completa de idiomas suportados na documentação.

Any of:

Códigos de idioma minúsculos de duas letras.

content[].​description.​enstring or null

Inglês

content[].​description.​arstring or null

Árabe

content[].​description.​bgstring or null

Búlgaro

content[].​description.​cnstring or null

Chinês (Simplificado)

content[].​description.​csstring or null

Tcheco

content[].​description.​destring or null

Alemão

content[].​description.​esstring or null

Espanhol (Espanha)

content[].​description.​frstring or null

Francês

content[].​description.​hestring or null

Hebraico

content[].​description.​itstring or null

Italiano

content[].​description.​jastring or null

Japonês

content[].​description.​kostring or null

Coreano

content[].​description.​plstring or null

Polonês

content[].​description.​ptstring or null

Português

content[].​description.​rostring or null

Romeno

content[].​description.​rustring or null

Russo

content[].​description.​thstring or null

Tailandês

content[].​description.​trstring or null

Turco

content[].​description.​twstring or null

Chinês (Tradicional)

content[].​description.​vistring or null

Vietnamita

content[].​description.​kmstring or null

Khmer

content[].​description.​idstring or null

Indonésio

content[].​description.​lostring or null

Lao

content[].​description.​mystring or null

Birmanês

content[].​description.​phstring or null

Filipino

content[].​description.​nestring or null

Nepalês

content[].​image_urlstring or null

URL da imagem. Para que a imagem seja exibida corretamente e carregue rapidamente na interface de pagamento, confira as nossas diretrizes de imagens e URLs:

  • Formatos suportados: WebP (recomendado), PNG, JPG.
  • Tamanho do arquivo: ≤ 50 KB (para WebP) ou ≤ 150 KB (para PNG e JPG).
  • Tamanho da imagem: 280 x 280 px.
  • Espaço de cores: sRGB.
  • Protocolo: HTTPS com cache de longa duração para URLs versionados.

content[].​quantityinteger>= 1

Quantidade do tipo de item no conjunto.

Padrão 1
limitsobject or null

Limites de itens.

limits.​per_userobject or null

Limitação de item para um usuário separado.

limits.​per_user.​totalinteger

Quantidade máxima de itens que o usuário atual pode comprar.

limits.​per_user.​limit_exceeded_visibilitystring

Determina a visibilidade do item no catálogo após o limite de compra ser atingido, até o próximo limite ser redefinido.

Aplica-se a itens para os quais redefinições recorrentes de limite estão configurados na matriz recurrent_schedule.

Se os limites redefinidos não forem configurados, o item não aparecerá no catálogo após o limite de compra ser atingido, independentemente do valor limit_exceeded_visibility.

Possíveis valores:

  • show — O item é retornado nas chamadas API de recuperação de catálogo após o limite de compra ser atingido. Nas chamadas API de recuperação de catálogo, quando o limite for atingido, o item será retornado com a marcação can_be_bought: false. A próxima data de redefinição é retornada em reset_next_date.
  • hide — O item não é retornado nas chamadas API de recuperação de catálogo após o limite de compra ser atingido, até o limite ser redefinido.
Enum"show""hide"
limits.​per_itemobject or null

Limitação global de itens.

limits.​per_item.​totalinteger

Quantidade máxima de itens que todos os usuários podem comprar.

limits.​per_item.​availableinteger

Quantidade restante de itens que todos os usuários podem comprar.

limits.​per_item.​reservedinteger
limits.​per_item.​soldinteger
limits.​recurrent_scheduleobject or null

Limite o período de atualização.

limits.​recurrent_schedule.​per_userobject

Período de atualização do limite do usuário.

One of:

Tipo diário de atualização de limites de usuário.

limits.​recurrent_schedule.​per_user.​interval_typestring

Tipo de período de atualização recorrente.

Valor"daily"
limits.​recurrent_schedule.​per_user.​timestring(full-time)

Tempo de atualização do limite no fuso horário desejado (arredondamento para horas).

Exemplo: "11:00:00+03:00"
limits.​recurrent_schedule.​per_user.​reset_next_dateinteger

Data e hora em que os limites são atualizados (Unix Timestamp).

Exemplo: 1677553200
limits.​recurrent_schedule.​per_user.​displayable_reset_start_datestring(date-time)

Data e hora da primeira atualização de limite (ISO 8601).

Exemplo: "2023-02-28T11:00:00+08:00"
limits.​recurrent_schedule.​per_user.​displayable_reset_next_datestring(date-time)

Data e hora em que os limites devem ser redefinidos (ISO 8601).

Exemplo: "2023-02-28T11:00:00+08:00"
periodsArray of objects

Período de venda de itens.

periods[].​date_fromstring or null(date-time)

Data em que o item especificado estará disponível para venda.

Exemplo: "2020-08-11T10:00:00+03:00"
periods[].​date_untilstring or null(date-time)

Data em que o item especificado ficará indisponível para venda. Pode ser null.

Exemplo: "2020-08-11T20:00:00+03:00"
custom_attributesobject(json)

Um objeto JSON que contém atributos e valores de item.

total_content_priceobject or null

Soma dos preços do conteúdo do conjunto.

total_content_price.​amountstring

Soma dos preços do conteúdo do conjunto com um desconto.

Exemplo: "100.99"
total_content_price.​amount_without_discountstring

Soma dos preços do conteúdo do conjunto.

Exemplo: "100.99"
total_content_price.​currencystring

Moeda do preço do item. Código de três letras de acordo com a ISO 4217.

Resposta
application/json
{
  "item_id": 610316,
  "sku": "com.xsolla.EmpireBundle_1",
  "name": {
    "en": "Empire bundle"
  },
  "type": "bundle",
  "description": {
    "en": "Empire bundle with items"
  },
  "image_url": "https://cdn.xsolla.net/img/misc/images/685b21f9d9dca4aa0c953e8816b4eb4b.png",
  "long_description": {
    "en": "Empire bundle with some goods"
  },
  "attributes": [],
  "is_free": false,
  "is_paid_randomized_reward": true,
  "groups": [
    { … }
  ],
  "prices": [],
  "virtual_prices": [
    { … }
  ],
  "media_list": [],
  "order": 1,
  "is_enabled": true,
  "is_show_in_store": true,
  "regions": [],
  "bundle_type": "standard",
  "content": [
    { … },
    { … },
    { … }
  ],
  "limits": {
    "per_user": { … },
    "per_item": null,
    "recurrent_schedule": null
  },
  "periods": [
    { … }
  ],
  "custom_attributes": {
    "type": "lootbox",
    "purchased": 0
  }
}

Mostrar conjunto no catálogoServer-sideAdmin

Pedido

Mostra um conjunto em um catálogo.

Segurança
basicAuth
Caminho
project_idintegerobrigatório

ID de projeto. Você pode encontrar esse parâmetro na sua Conta de Distribuidor, próximo ao nome do projeto e na barra de endereços do navegador ao trabalhar com um projeto. O URL tem o seguinte formato: https://publisher.xsolla.com/<merchant_id>/projects/<project_id>.

Exemplo: 44056
skustringobrigatório

SKU de conjunto.

Exemplo: kg_1
curl -i -X PUT \
  -u <username>:<password> \
  https://store.xsolla.com/api/v2/project/44056/admin/items/bundle/sku/kg_1/show

Respostas

Conjunto exibido com sucesso.

Corpo
Resposta
Sem conteúdo

Catálogo

Operações

Visão geral

O carrinho é um mecanismo de compra que permite combinar vários itens em um único pedido. Um usuário pode comprar itens de qualquer tipo em qualquer quantidade com moedas reais, assim como usar códigos promocionais.

O carrinho é armazenado no lado da Xsolla. O salvamento do carrinho entre sessões depende do usuário estar autorizado ou não:

  • Para usuários autorizados, o carrinho é vinculado a um usuário específico e é salvo entre as sessões, desde que as solicitações sejam enviadas em nome do mesmo usuário.

  • Para usuários não autorizados, salvar o carrinho depende se o cabeçalho x-unauthorized-id é passado. Para salvar o carrinho de um usuário não autorizado entre sessões, passe o mesmo x-unauthorized-id em toda solicitação. Essa opção só está disponível para a venda de chaves de jogo.

Você pode identificar o carrinho de duas maneiras: automaticamente pelo JWT do usuário ou por ID do carrinho (cart_id).

A gestão do carrinho está disponível tanto no lado do cliente quanto no lado do servidor.

No lado do servidor, você pode preencher o carrinho com itens, por exemplo, ao restaurar uma sessão de usuário. As seguintes ações estão disponíveis no lado do cliente:

  • recuperar o carrinho do usuário atual ou um carrinho por ID
  • preencher o carrinho
  • atualizar itens no carrinho
  • excluir itens do carrinho

Para comprar itens do carrinho, são usadas chamadas do cliente e do servidor para criação de pedidos.

O tempo de vida (TTL) do carrinho é de 72 horas por padrão. Se o conteúdo for alterado, por exemplo, quando um novo item é adicionado, o TTL é estendido.

Após um pagamento bem-sucedido, o carrinho não é esvaziado automaticamente. Para limpar o carrinho, use as chamadas de API do lado do cliente:

Cenário de uso do carrinho:

  1. Implemente uma interface de loja onde o usuário selecionará os itens.

  2. Quando o usuário seleciona itens na loja, adicione-os ao carrinho, por exemplo, usando a chamada Preenchar carrinho com itens. Na matriz de itens, você deve passar os SKUs e a quantidade necessária dos itens.

  3. Implemente a interface de visualização do carrinho. Quando o usuário navega ao carrinho, exiba seus conteúdos usando a chamada Obter carrinho do usuário atual. A resposta retornará informações sobre o peço final dos itens, incluindo descontos e promoções aplicadas.

  4. Implemente a abertura da interface de pagamento para pagar pelo pedido. Por exemplo, você pode usar a chamada Criar pedido com todos os itens de um carrinho em particular. A resposta retorna um token para abrir a interface de pagamento.

  5. Configure o rastreamento de status de pedidos, por exemplo, usando webhooks para receber dados sobre itens pagos com sucesso prontamente e concedê-los ao usuário.

Nota

Para implementar a venda de itens no jogo e online, consulte o guia de integração.

Fluxo de carrinho e pagamento

Ciclo de vida do pedido

Compreender o ciclo de vida do pedido ajuda a rastrear pedidos e a implementar a lógica pós-compra corretamente, ou seja, a entrega dos itens.

O pedido passa pelos seguintes status:

StatusDescriçãoObservações
newO pedido é criado. O sistema aguarda pela confirmação do pagamento.As descrições dos status de transação podem ser encontrados na documentação Pay Station API.
paidO pedido é pago (a transação mudou para o status done), e o item pode ser concedido ao usuário. O pedido permanece no status new até que o pagamento seja confirmado.
doneO item é concedido ao usuário. —
canceledO pagamento foi reembolsado. O pedido muda para esse status quando o status da transação muda para refunded.
expired Criar um novo pedido para um item, código promocional ou promoção limitados move qualquer pedido não pago contendo o item para o status expired. Apenas o pedido mais recente pode ser pago. Se um usuário tentar pagar por um pedido expirado, a interface de pagamento exibirá um erro 2002, e o pagamento falhará.

Ciclo de vida do pedido

Nota

Quando o pedido muda para o status expired enquanto o usuário conclui o pagamento, mas o pagamento é bem-sucedido, o pedido muda do status expired para paid. Isso só se aplica se o limite de compra para o item do pedido não será excedido pelo pagamento.

Carrinho (lado do cliente)

Use chamadas desta seção para gerenciar o carrinho no lado do cliente.

Operações

Carrinho (lado do servidor)

Use chamadas desta seção para gerenciar o carrinho no lado do servidor.

Operações

Pagamento (lado do cliente)

Use chamadas desta seção para criar um token de pagamento no lado do cliente.

Operações

Pagamento (lado do servidor)

Use chamadas desta seção para criar um token de pagamento no lado do servidor.

Operações

Pedido

Use chamadas desta seção para obter informações sobre pedidos.

Operações

Itens gratuitos

Use calls from this section to grant free items to users.

Operações

Visão geral

Os limites de compra permitem restringir a quantidade de itens disponíveis para compra por um único usuário ou por todos os usuários. Você também pode configurar redefinições de limite agendadas.

Os limites são armazenados no lado da Xsolla e são configurados no nível de item individual na Conta de Distribuidor ou via o objeto limits nas seguintes chamadas de API:

As informações de limite são retornadas no objeto items.limits nas seguintes chamadas de API para recuperar o catálogo de itens:

As chamadas de API na subseção Gestão do grupo Limites permitem que você recupere o estado atual dos limites e os atualize para um usuário específico — por exemplo, redefina o contador após a conclusão de uma missão ou ajuste manualmente a quantidade restante.

Nota

Para informações detalhadas sobre como configurar limites no catálogo, consulte a seção Limites de compra de itens.

Gestão

Operações

Admin

Operações

Reservas

Operações

Comerciante

Operações

Catálogo

Esta API permite obter qualquer tipo de itens vendáveis ou itens específicos.

Operações

Regiões comuns

As restrições regionais de vendas permitem gerenciar a disponibilidade de itens em países ou grupos de países específicos. Por exemplo, você pode vender um jogo apenas em determinados países devido a restrições de licenciamento.

As restrições são configuradas utilizando regiões. Cada região agrupa um ou mais países sob um único identificador region_id. Você pode vincular um item a uma ou mais regiões.

A disponibilidade de itens é determinada conforme segue:

  • Se nenhuma região for especificada para o item, ele estará disponível para compra em todos os países.
  • Se regiões forem especificadas para o item e o país do usuário estiver incluído em uma delas, o item estará disponível para esse usuário.
  • Se regiões forem especificadas para o item e o país do usuário não estiver incluído em nenhuma delas, o item não estará disponível para esse usuário.

O país do usuário é informado no parâmetro country ao solicitar o catálogo por meio de chamadas de API na subseção Catalog. Se o parâmetro não for informado, o país será determinado com base no endereço IP do usuário.

A compatibilidade entre o país do usuário e as regiões do item é verificada em dois momentos: na solicitação do catálogo e na criação do pedido. Itens indisponíveis não são incluídos na resposta do catálogo, e pedidos contendo tais itens não serão criados.

Utilize chamadas de API do grupo Common regions para criar, atualizar e excluir regiões.

Fluxo de configuração de restrições regionais de venda:

  1. Crie uma região usando a chamada de API Criar região, especificando a lista de países. A resposta retorna um region_id que é necessário na etapa seguinte.
  2. Associe um item virtual à região informando o region_id correspondente na matriz regions ao criar ou atualizar o item.
  3. Exiba o catálogo para o usuário utilizando chamadas de API da subseção Catalog, como, por exemplo, a chamada Obter lista de itens virtuais. O país do usuário é determinado pelo parâmetro country ou, caso este não seja fornecido, com base no endereço IP do usuário. Itens indisponíveis no país do usuário não são incluídos na resposta do catálogo.
  4. Quando o usuário prosseguir para pagar um item ou o carrinho, crie um pedido:

A resposta contém um token para abrir a interface de pagamento.

Observação

A Xsolla verifica se o país do usuário foi incluído na região especificada do item. Se o país não tiver sido incluído na região do item, o pedido não poderá ser criado.

  1. Implemente a abertura da interface de pagamento para efetuar o pagamento do pedido.

Regiões comuns

Operações

Webhooks

Operações

Admin

Operações

Admin

Operações

Catálogo

Operações