Saltar para o conteúdo
/
Obter lista de promoções...

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

Obter lista de promoções de itensServer-sideAdmin

Pedido

Obtenha a lista de promoções de itens de um projeto.

As promoções oferecem um desconto (%) nos itens. O desconto será aplicado a todos os preços dos itens especificados.

Segurança
basicAuth
Caminho
project_idintegerobrigatório

ID do projeto.

Padrão 59080
Consulta
limitinteger

Limite da quantidade de elementos na página.

offsetinteger

Número do elemento a partir do qual a lista é gerada (a quantidade começa a partir de 0).

curl -i -X GET \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/pt/api/shop-builder/v3/project/{project_id}/admin/promotion/item?limit=0&offset=0'

Respostas

Lista de promoções de itens recebida com sucesso.

Corpoapplication/json
active_promotions_countinteger(active_promotions_count)

Número de promoções ativas.

inactive_promotions_countinteger(inactive_promotions_count)

Número de promoções desativadas.

promotionsArray of objects
total_promotions_countinteger(total_promotions_count)

Número total de promoções.

Resposta
application/json
{
  "active_promotions_count": 4,
  "inactive_promotions_count": 0,
  "promotions": [
    { … },
    { … },
    { … },
    { … }
  ],
  "total_promotions_count": 4
}

Criar promoção de desconto para itemServer-sideAdmin

Pedido

Cria uma promoção de desconto para um item.

As promoções oferecem um desconto (%) nos itens. O desconto será aplicado a todos os preços dos itens especificados.

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/jsonobrigatório

Objeto com dados de promoção.

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.

discountobjectobrigatório
discount.​percentstringobrigatório

Percentual de desconto. O preço do item será diminuído usando um valor calculado usando essa porcentagem e, em seguida, arredondado para 2 casas decimais.

Exemplo: 10
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]
is_enabledboolean(Promotions_is_enabled)

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

Exemplo: true
itemsArray of objectsobrigatório
items[].​skustringobrigatório

SKU do item.

Padrão "elven_sword"
limitsobject(Promotions_promotion_limits)

Limites da promoção.

nameobjectobrigatório

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

Exemplo: {"en-US":"Promotion","ru-RU":"Акция"}
name.​property name*stringpropriedade adicional
price_conditionsArray of objects or null(price_conditions_discount)

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 items 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/item \
  -H 'Content-Type: application/json' \
  -d '{
    "attribute_conditions": [
      {
        "attribute": "race",
        "operator": "eq",
        "type": "string",
        "value": "ork"
      },
      {
        "attribute": "level",
        "can_be_missing": true,
        "operator": "eq",
        "type": "number",
        "value": "10"
      }
    ],
    "discount": {
      "percent": "24.00"
    },
    "is_enabled": true,
    "items": [],
    "name": {
      "en-US": "Ork set discount",
      "ru-RU": "Скидка на набор для орка"
    },
    "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 de itemServer-sideAdmin

Pedido

Exclui a promoção de desconto. 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 comprar itens 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/item

Respostas

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

Resposta
Sem conteúdo

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

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