Saltar para o conteúdo

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

Shop Builder API provides a third-party solution for implementing the server side for your store interface. Use the endpoints to manage in-game items, in-game currencies, cart, player inventory, promotions, game library, etc.

Transferir a descrição da OpenAPI
Idiomas
Servidores
Mock server
https://xsolla.redocly.app/_mock/pt/api/shop-builder/
https://store.xsolla.com/api/
Operações

Catálogo personalizado

Essa API permite especificar regras para atributos de usuário. Se o usuário atender a todas as condições para uma regra concreta, serão exibidos itens personalizados.

Para promoções personalizadas, consulte a seção Promotions.

Para passar atributos antes de uma compra, você pode usar a Xsolla Login API ou passá-los para a propriedade user.attributes ao gerar o token usando a Pay Station API.

Operações
Operações
Operações
Operações
Operações
Operações
Operações
Operações
Operações
Operações
Operações
Operações

Catálogo

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

Operações
Operações
Operações
Operações
Operações
Operações

Cupons

Esta API permite que você gerencie cupons.

Operações

Códigos promocionais

Esta API permite gerenciar códigos promocionais.

Operações

Ofertas de catálogo exclusivas

Essa API permite que você gerencie ofertas de catálogo exclusivas.

Operações

Descontos

Esta API permite-lhe gerir promoções de desconto.

Operações

Bônus

Esta API permite gerenciar promoções de bônus.

Operações
Operações
Operações
Operações
Operações
Operações
Operações
Operações
Operações
Operações
Operações
Operações
Operações

Criar venda cruzadaServer-sideAdmin

Pedido

Cria uma venda cruzada para um projeto.

Segurança
XsollaLoginUserJWT
Caminho
project_idintegerobrigatório

ID do projeto. Você pode encontrar esse parâmetro em sua Conta de Distribuidor ao lado do nome do projeto.

Exemplo: 44056
Corpoapplication/json
One of:

Tipo de venda cruzada.

is_enabledboolean(is_enabled)obrigatório
Exemplo: true
itemsArray of stringsobrigatório

Matriz de itens SKU.

Padrão null
Exemplo: ["game_sku"]
typestringobrigatório
Valor"fixed_list"
Exemplo: true
curl -i -X POST \
  https://xsolla.redocly.app/_mock/pt/api/shop-builder/v2/project/44056/admin/items/upsell \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "is_enabled": true,
    "items": [
      "game_sku_1",
      "game_sku_2",
      "game_sku_3"
    ],
    "type": "fixed_list"
  }'

Respostas

A venda cruzada foi criada para o projeto.

Resposta
Sem conteúdo

Atualizar venda cruzadaServer-sideAdmin

Pedido

Atualize uma venda cruzada para um projeto.

Segurança
XsollaLoginUserJWT
Caminho
project_idintegerobrigatório

ID do projeto. Você pode encontrar esse parâmetro em sua Conta de Distribuidor ao lado do nome do projeto.

Exemplo: 44056
Corpoapplication/json
One of:

Tipo de venda cruzada.

is_enabledboolean(is_enabled)obrigatório
Exemplo: true
itemsArray of stringsobrigatório

Matriz de itens SKU.

Padrão null
Exemplo: ["game_sku"]
typestringobrigatório
Valor"fixed_list"
Exemplo: true
curl -i -X PUT \
  https://xsolla.redocly.app/_mock/pt/api/shop-builder/v2/project/44056/admin/items/upsell \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "is_enabled": true,
    "items": [
      "game_sku_1",
      "game_sku_2",
      "game_sku_3"
    ],
    "type": "fixed_list"
  }'

Respostas

A venda cruzada foi atualizada para o projeto.

Resposta
Sem conteúdo

Ativar/desativar a venda cruzada do projetoServer-sideAdmin

Pedido

Altera o status de uma venda cruzada em um projeto para ativo ou inativo.

Segurança
XsollaLoginUserJWT
Caminho
project_idintegerobrigatório

ID do projeto. Você pode encontrar esse parâmetro em sua Conta de Distribuidor ao lado do nome do projeto.

Exemplo: 44056
togglestringobrigatório

Status de ativação.

Exemplo: activate
curl -i -X PUT \
  https://xsolla.redocly.app/_mock/pt/api/shop-builder/v2/project/44056/admin/items/upsell/activate \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Respostas

Uma venda cruzada em um projeto foi ativada ou desativada.

Resposta
Sem conteúdo
Operações
Operações