Saltar para o conteúdo
/
Resgatar código promocion...

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

Obter recompensas de código promocionalClient-side

Pedido

Recebe recompensas de código promocional pelo seu código. Pode ser usado para permitir que os usuários escolham um dos muitos itens como bônus. O caso usual é escolher um DRM se o código promocional contiver um jogo como bônus (type=unit).

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
promocode_codestring[ 1 .. 128 ] charactersobrigatório

Código exclusivo que diferencia maiúsculas de minúsculas. Contém letras e números.

Exemplo: SO6rew99j9
curl -i -X GET \
  https://xsolla.redocly.app/_mock/pt/api/shop-builder/v2/project/44056/promocode/code/SO6rew99j9/rewards \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Respostas

Lista de recompensas do código promocional recebida com sucesso.

Corpoapplication/json
bonusArray of objects(Promotions_200-promo-code-bonus-reward)
discountobject or null(Promotions_200-coupon-discount-reward)

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

discounted_itemsArray of objects or null(Promotions_discounted_items)

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

is_selectableboolean

Se true, o usuário deve escolher o bônus antes de resgatar um código promocional.

Resposta
application/json
{
  "bonus": [
    { … },
    { … }
  ],
  "discount": {
    "percent": "10.00"
  },
  "discounted_items": [
    { … }
  ],
  "is_selectable": true
}

Resgatar código promocionalClient-side

Pedido

Resgata um código promocional de promoção. Depois de resgatar um código promocional, o usuário receberá itens gratuitos e/ou o preço do carrinho e/ou itens específicos será diminuído.

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
coupon_codestring[ 1 .. 128 ] characters

Código exclusivo do código promocional. Contém letras e números.

Padrão "SUMMER2021"
Exemplo: "SUMMER2021"
selected_unit_itemsobject(Promotions_selected_unit_items)

A recompensa selecionada por um usuário. A chave de objeto é um SKU de uma unidade, e o valor é um SKU de um dos itens em uma unidade.

Exemplo: {"game_1":"game_1_steam","game_2":"game_2_playstation"}
curl -i -X POST \
  https://xsolla.redocly.app/_mock/pt/api/shop-builder/v2/project/44056/promocode/redeem \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "cart": {
      "id": "current"
    },
    "coupon_code": "SUMMER2021",
    "selected_unit_items": {
      "game_1": "game_1_steam",
      "game_2": "game_2_playstation"
    }
  }'

Respostas

Código promocional resgatado 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":{"$ref":"../schemas/Can_be_bought.yaml"},"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":{"$ref":"../schemas/Catalog_item_limits.yaml"},"name":"Xsolla Booster Mega","periods":{"$ref":"../schemas/item-periods.yaml"},"price":{"amount":"50.0000000000000000","amount_without_discount":"100.0000000000000000","currency":"USD"},"promotions":{"$ref":"../schemas/Catalog_item_promotions.yaml"},"quantity":123,"sku":"com.xsolla.booster_mega_1","type":"virtual_good","virtual_item_type":"consumable","virtual_prices":[],"vp_rewards":{"$ref":"../schemas/reward-chain-client/client-item-value-point-reward.yaml"}}]
priceobject or null

Preço do carrinho.

Exemplo: {"amount":"6150.0000000000000000","amount_without_discount":"6150.0000000000000000","currency":"USD"}
rewardsobject(Promo_code_rewards)
Resposta
application/json
{
  "cart_id": "cart_id",
  "is_free": false,
  "items": [
    { … },
    { … }
  ],
  "price": {
    "amount": "6150.0000000000000000",
    "amount_without_discount": "12300.0000000000000000",
    "currency": "USD"
  },
  "rewards": {
    "bonus": [ … ],
    "discount": { … },
    "discounted_items": [ … ],
    "is_selectable": false
  }
}

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"
  }
}

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