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

Criar promoção de bônusServer-sideAdmin

Pedido

Cria a promoção de bônus.

A promoção adiciona itens bônus gratuitos à compra feita por um usuário. A promoção pode ser aplicada a cada compra dentro de um projeto ou a uma compra que inclua itens específicos.

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
Corpoapplication/json
attribute_conditionsArray of tipo = string (object) or tipo = number (object) or tipo = data (object)(promotion_user-attribute_conditions_model-post)[ 1 .. 100 ] items

Condições para validação de atributos do usuário. Determine a disponibilidade da promoção com base em se os atributos do usuário correspondem a todas as condições especificadas.

bonusArray of objects or nullobrigatório
bonus[].​quantitynumber

Quantidade do item.

Padrão 1
bonus[].​skustring

SKU do item.

Padrão "elven_shield"
conditionArray of objects or nullobrigatório

Conjunto de itens que devem ser incluídos na compra para aplicar uma promoção. Se esse parâmetro for null, uma promoção será aplicada a todas as compras dentro de um projeto.

condition[].​skustring

SKU do item.

Padrão "elven_sword"
excluded_promotionsArray of integers(excluded_promotions)

Lista de IDs de promoção a serem excluídos ao aplicar esta promoção.
Example: [12, 789]

Exemplo: [12,789]
idinteger

ID de promoção. Identificador exclusivo da promoção dentro do projeto.

is_enabledboolean(Promotions_is_enabled)

Se a promoção está habilitada ou não.

Exemplo: true
limitsobject(Promotions_promotion_limits)

Limites da promoção.

nameobjectobrigatório

Nome da promoção. Deve conter pares chave/valor onde chave é uma localidade com formato "^[a-z]{2}-[A-Z]{2}$", e o valor é uma cadeia de caracteres.

Exemplo: {"de-DE":"Sommersaison Bonus","en-US":"Summer season bonus"}
name.​property name*stringpropriedade adicional
price_conditionsArray of objects or null(price_conditions_bonus)

Matriz de objetos com condições que definem a faixa de preço para aplicar a promoção.
A promoção se aplica apenas a itens cujo preço atenda a todas as condições da matriz. Se você passar essa matriz, defina o valor do objeto condition como null.

promotion_periodsArray of objects(promotion_periods)

Períodos de validade da promoção. Se múltiplos períodos forem especificados, tanto date_from quanto date_until são necessários.

curl -i -X POST \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/pt/api/shop-builder/v3/project/44056/admin/promotion/bonus \
  -H 'Content-Type: application/json' \
  -d '{
    "attribute_conditions": [
      {
        "attribute": "account_status",
        "can_be_missing": false,
        "operator": "eq",
        "type": "string",
        "value": "golden"
      }
    ],
    "bonus": [
      {
        "quantity": 50000,
        "sku": "com.xsolla.mp_credits"
      }
    ],
    "condition": [
      {
        "sku": "com.xsolla.year_1_season_pass"
      }
    ],
    "name": {
      "de-DE": "Neujahrsbonus",
      "en-US": "New Year Bonus"
    },
    "promotion_periods": [
      {
        "date_from": "2020-04-15T18:16:00+05:00",
        "date_until": "2020-04-25T18:16:00+05:00"
      }
    ]
  }'

Respostas

Promoção criada com sucesso.

Corpoapplication/json
promotion_idinteger

ID de promoção. Identificador exclusivo da promoção dentro do projeto.

Resposta
application/json
{ "promotion_id": 2384756 }

Excluir promoção bônusServer-sideAdmin

Pedido

Exclui a promoção bônus. A promoção excluída:

  • Desaparece da lista de promoções configuradas no seu projeto.
  • Não se aplica mais ao catálogo de itens e ao carrinho. O usuário não pode obter itens bônus com esta promoção.

Após a exclusão, a promoção não poderá ser restaurada.

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
promotion_idintegerobrigatório

ID de promoção. Identificador exclusivo da promoção dentro do projeto.

Exemplo: 111425
curl -i -X DELETE \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/pt/api/shop-builder/v3/project/44056/admin/promotion/111425/bonus

Respostas

A promoção foi excluída com sucesso.

Resposta
Sem conteúdo

Obter promoção bônusServer-sideAdmin

Pedido

Recebe a promoção bônus.

A promoção adiciona itens bônus gratuitos à compra feita por um usuário. A promoção pode ser aplicada a cada compra dentro de um projeto ou a uma compra que inclua itens específicos.

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
promotion_idintegerobrigatório

ID de promoção. Identificador exclusivo da promoção dentro do projeto.

Exemplo: 111425
curl -i -X GET \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/pt/api/shop-builder/v3/project/44056/admin/promotion/111425/bonus

Respostas

Promoção bônus recebida com sucesso.

Corpoapplication/json
attribute_conditionsArray of tipo = string (object) or tipo = number (object) or tipo = data (object)(promotion_user-attribute_conditions_model-get)[ 1 .. 100 ] items

Condições para validação de atributos do usuário. Determine a disponibilidade da promoção com base em se os atributos do usuário correspondem a todas as condições especificadas.

bonusArray of objects or null
conditionArray of objects or null

Conjunto de itens que devem ser incluídos na compra para aplicar uma promoção. Se esse parâmetro for null, uma promoção será aplicada a todas as compras dentro de um projeto.

excluded_promotionsArray of integers(excluded_promotions)

Lista de IDs de promoção a serem excluídos ao aplicar esta promoção.
Example: [12, 789]

Exemplo: [12,789]
idinteger

ID de promoção. Identificador exclusivo da promoção dentro do projeto.

is_enabledboolean
Padrão true
limitsobject(Promotions_promotion_limits_response)

Limites da promoção.

nameobject

Nome da promoção. Deve conter pares chave/valor onde a chave é uma localidade com formato "^[a-z]{2}-[A-Z]{2}$", e valor sendo uma cadeia de caracteres.

Exemplo: {"de-DE":"Sommersaison Bonus","en-US":"Summer season bonus"}
price_conditionsArray of objects or null(price_conditions_bonus)

Matriz de objetos com condições que definem a faixa de preço para aplicar a promoção.
A promoção se aplica apenas a itens cujo preço atenda a todas as condições da matriz. Se você passar essa matriz, defina o valor do objeto condition como null.

promotion_periodsArray of objects(promotion_periods)

Períodos de validade da promoção. Se múltiplos períodos forem especificados, tanto date_from quanto date_until são necessários.

Resposta
application/json
{ "bonus": [ {}, {}, {} ], "condition": [ {}, {} ], "excluded_promotions": [ 23, 45 ], "id": 1, "is_enabled": true, "limits": { "per_item": null, "per_user": {}, "recurrent_schedule": {} }, "name": { "de-DE": "Neujahrsbonus", "en-US": "New Year Bonus" }, "price_conditions": [ {}, {} ], "promotion_periods": [ {} ] }
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
Operações