Saltar para o conteúdo
/
Obtenha o número de itens...

API Shop Builder (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

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
index.json
index.yaml
Idiomas
Servidores
Mock server
https://xsolla.redocly.app/_mock/pt/api/shop-builder/
https://store.xsolla.com/api/

Admin

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

Admin

Operações

Catálogo

Operações

Carrinho (lado do cliente)

Operações

Carrinho (lado do servidor)

Operações

Pagamento (lado do cliente)

Operações

Pagamento (lado do servidor)

Operações

Pedido

Operações

Itens gratuitos

Operações

Webhooks

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

Operações

Catálogo

Operações

Direito

Operações

Admin

Operações

Comum

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

Admin

Operações

Catálogo

Operações

Pagamento virtual

Operações

Gestão

Operações

Diminuir o número de itens disponíveis para o usuário especificadoServer-sideAdmin

Pedido

Diminui o número restante de itens disponíveis para o usuário especificado dentro do limite aplicado.

A API User limit permite que você venda um item em uma quantidade limitada. Para configurar os limites de compra, vá para a seção Admin do módulo de tipo de item desejado:

Segurança
basicAuth
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
item_skustringobrigatório

SKU do item.

Exemplo: booster_mega_1
Corpoapplication/json
availableinteger(User-limit_available)>= 1obrigatório

Número restante de itens ou usos da promoção disponíveis para o usuário dentro do limite aplicado.

userobject(User-limit_user)obrigatório
user.​user_external_idstring(User-limit_user-external-id)non-empty^\S+$obrigatório

ID de usuário externo.

curl -i -X DELETE \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/pt/api/shop-builder/v2/project/44056/admin/user/limit/item/sku/booster_mega_1 \
  -H 'Content-Type: application/json' \
  -d '{
    "available": 1,
    "user": {
      "user_external_id": "d342dad2-9d59-11e9-a384-42010aa8003f"
    }
  }'

Respostas

Os limites de compra para um usuário foram recebidos com sucesso.

Corpoapplication/json
per_userobject
Resposta
application/json
{
  "per_user": {
    "available": 9,
    "total": 10
  }
}

Obtenha o número de itens disponíveis para o usuário especificadoServer-sideAdmin

Pedido

Obtém o número restante de itens disponíveis para o usuário especificado dentro do limite aplicado.

A API User limit permite que você venda um item em uma quantidade limitada. Para configurar os limites de compra, vá para a seção Admin do módulo de tipo de item desejado:

Segurança
basicAuth
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
item_skustringobrigatório

SKU do item.

Exemplo: booster_mega_1
Consulta
user_external_idstringobrigatório

ID externo de usuário

Exemplo: user_external_id=d342dad2-9d59-11e9-a384-42010aa8003f
curl -i -X GET \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/pt/api/shop-builder/v2/project/44056/admin/user/limit/item/sku/booster_mega_1?user_external_id=d342dad2-9d59-11e9-a384-42010aa8003f'

Respostas

Os limites de compra para um usuário foram recebidos com sucesso.

Corpoapplication/json
per_userobject
Resposta
application/json
{
  "per_user": {
    "available": 9,
    "total": 10
  }
}

Aumente o número de itens disponíveis para o usuário especificadoServer-sideAdmin

Pedido

Aumenta o número restante de itens disponíveis para o usuário especificado dentro do limite aplicado.

A API User limit permite que você venda um item em uma quantidade limitada. Para configurar os limites de compra, vá para a seção Admin do módulo de tipo de item desejado:

Segurança
basicAuth
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
item_skustringobrigatório

SKU do item.

Exemplo: booster_mega_1
Corpoapplication/json
availableinteger(User-limit_available)>= 1obrigatório

Número restante de itens ou usos da promoção disponíveis para o usuário dentro do limite aplicado.

userobject(User-limit_user)obrigatório
user.​user_external_idstring(User-limit_user-external-id)non-empty^\S+$obrigatório

ID de usuário externo.

curl -i -X POST \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/pt/api/shop-builder/v2/project/44056/admin/user/limit/item/sku/booster_mega_1 \
  -H 'Content-Type: application/json' \
  -d '{
    "available": 1,
    "user": {
      "user_external_id": "d342dad2-9d59-11e9-a384-42010aa8003f"
    }
  }'

Respostas

Os limites de compra para um usuário foram recebidos com sucesso.

Corpoapplication/json
per_userobject
Resposta
application/json
{
  "per_user": {
    "available": 9,
    "total": 10
  }
}

Admin

Operações

Cliente

Operações

Cliente de clãs

Operações

Admin

Operações

Cliente

Operações

Admin

Operações

Cliente

Operações

Admin

Operações

Cliente

Operações

Admin

Operações