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

Remover código promocional do carrinhoClient-side

Pedido

Remove um código promocional de um carrinho. Depois que o código promocional for removido, o preço total de todos os itens no carrinho será recalculado sem bônus e descontos fornecidos por um código promocional.

Segurança
AuthForCart
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
cartobject or null
curl -i -X PUT \
  https://xsolla.redocly.app/_mock/pt/api/shop-builder/v2/project/44056/promocode/remove \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "cart": {
      "id": "current"
    }
  }'

Respostas

Código promocional cancelado com sucesso.

Corpoapplication/json
cart_idstring

ID do carrinho.

Exemplo: "cart_id"
is_freeboolean(value-is_free)

Se true, o item é gratuito.

Padrão false
Exemplo: false
itemsArray of objects
Exemplo: [{"attributes":[],"can_be_bought":true,"description":"Take it, take it all! All of Xsolla's riches in one Mega Booster.","groups":[{"external_id":"powerups","name":"Power Ups"}],"image_url":"https://cdn.xsolla.net/img/misc/images/e9f2f4a634bc96ea03b5d5ceadd7c55f.png","is_free":false,"limits":{"per_user":{"available":3,"recurrent_schedule":{"interval_type":"weekly","reset_next_date":1746057600},"total":5}},"name":"Xsolla Booster Mega","periods":[{"date_from":"2020-08-11T10:00:00+03:00","date_until":"2020-08-11T20:00:00+03:00"}],"price":{"amount":"50.0000000000000000","amount_without_discount":"100.0000000000000000","currency":"USD"},"promotions":[{"bonus":[{"image_url":"https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png","name":"Xsolla Minigun","quantity":1,"sku":"com.xsolla.minigun_1","type":"virtual_good"}],"date_end":"2026-04-15T16:16:00+03:00","date_start":"2020-04-15T16:16:00+03:00","discount":{"percent":"50.00"},"name":"Bonus promotion"}],"quantity":123,"sku":"com.xsolla.booster_mega_1","type":"virtual_good","virtual_item_type":"consumable","virtual_prices":[],"vp_rewards":[{"amount":130,"image_url":"https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg","item_id":175232,"name":"Value point","sku":"com.xsolla.value_point_1"},{"amount":50,"image_url":"https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg","is_clan":true,"item_id":186321,"name":"Clan Reward VP 1","sku":"com.xsolla.clan_value_point_1"}]}]
priceobject or null

Preço do carrinho.

Exemplo: {"amount":"6150.0000000000000000","amount_without_discount":"6150.0000000000000000","currency":"USD"}
Resposta
application/json
{
  "cart_id": "cart_id",
  "is_free": false,
  "items": [
    { … }
  ],
  "price": {
    "amount": "6150.0000000000000000",
    "amount_without_discount": "6150.0000000000000000",
    "currency": "USD"
  }
}

Obter lista de promoções de códigos promocionaisServer-sideAdmin

Pedido

Obtém a lista de códigos promocionais de um projeto.

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
Consulta
limitinteger>= 1

Limite da quantidade de elementos na página.

Exemplo: limit=50
offsetinteger>= 0

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

Exemplo: offset=0
curl -i -X GET \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/pt/api/shop-builder/v3/project/44056/admin/promocode?limit=50&offset=0'

Respostas

Lista de códigos promocionais 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.

itemsArray of objects(Promotions_200-get-promocode-promotion-model)
total_promotions_countinteger(total_promotions_count)

Número total de promoções.

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

Criar promoção de código promocionalServer-sideAdmin

Pedido

Cria uma promoção de código promocional.

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 null(Promotions_coupon_bonus)
discountobject or null
Exemplo: {"percent":"10.10"}
discounted_itemsArray of objects or null(Promotions_discounted_items)

Lista de itens que são descontados por um código promocional.

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]
external_idstring(Promotions_coupon-external_id)obrigatório

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

Padrão "coupon_external_id"
Exemplo: "coupon_external_id"
item_price_conditionsArray of objects or null(item_price_conditions_promocode)

Conjunto de objetos com condições que definem a faixa de preço para aplicar a promoção a determinados itens no carrinho.
O preço de cada item no carrinho do usuário é comparado com a faixa de preço especificada na condição. Bônus e descontos são aplicados somente aos itens no carrinho cujo preço atende à condição.
Se você passar esta matriz, defina o valor da matriz discounted_items como null.

nameobject(Promotions_coupon_name)obrigatório

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.

Padrão {"de-DE":"Gutscheintitel","en-US":"Coupon title"}
Exemplo: {"de-DE":"Gutscheintitel","en-US":"Coupon title"}
name.​property name*stringpropriedade adicional
price_conditionsArray of objects or null(price_conditions_promocode)

Matriz de objetos com condições que definem a faixa de preço para aplicar a promoção ao carrinho inteiro.
O preço total de todos os itens no carrinho do usuário é comparado com a faixa de preço especificada na condição. Bônus e descontos são aplicados a todos os itens no carrinho se o preço do carrinho atender à condição especificada.
Se você passar esta matriz, defina o valor da matriz discounted_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.

redeem_code_limitinteger or null(Promotions_redeem_code_limit)

Número de resgates por código.

Padrão 10
Exemplo: 10
redeem_total_limitinteger or null(Promotions_coupon-redeem_total_limit)

Limita o número total de cupons.

Padrão 10
Exemplo: 10
redeem_user_limitinteger or null(Promotions_coupon-redeem_user_limit)

Limita o número total de cupons resgatados por um único usuário.

Padrão 10
Exemplo: 10
curl -i -X POST \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/pt/api/shop-builder/v3/project/44056/admin/promocode \
  -H 'Content-Type: application/json' \
  -d '{
    "attribute_conditions": [
      {
        "attribute": "account_status",
        "can_be_missing": false,
        "operator": "eq",
        "type": "string",
        "value": "golden"
      }
    ],
    "discount": {
      "percent": "10.10"
    },
    "external_id": "coupon_external_id",
    "name": {
      "de-DE": "Neujahrsrabatt",
      "en-US": "New Year Discount"
    },
    "promotion_periods": [
      {
        "date_from": "2020-04-15T18:16:00+05:00",
        "date_until": "2020-04-25T18:16:00+05:00"
      }
    ],
    "redeem_code_limit": 1,
    "redeem_total_limit": 100,
    "redeem_user_limit": 1
  }'

Respostas

O código promocional foi criado com sucesso.

Corpoapplication/json
external_idstring(Promotions_coupon-external_id)

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

Padrão "coupon_external_id"
Exemplo: "coupon_external_id"
Resposta
application/json
{
  "external_id": "coupon_external_id"
}

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

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