Saltar para o conteúdo
/
Excluir promoção de cupom

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

Criar promoção de cupomServer-sideAdmin

Pedido

Cria uma promoção de cupom.

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)
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"
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
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/coupon \
  -H 'Content-Type: application/json' \
  -d '{
    "attribute_conditions": [
      {
        "attribute": "account_status",
        "can_be_missing": false,
        "operator": "eq",
        "type": "string",
        "value": "golden"
      }
    ],
    "bonus": [
      {
        "quantity": 1,
        "sku": "com.xsolla.elven_sword_2"
      }
    ],
    "external_id": "coupon_external_id",
    "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"
      }
    ],
    "redeem_code_limit": 1,
    "redeem_total_limit": 100,
    "redeem_user_limit": 1
  }'

Respostas

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

Excluir promoção de cupomServer-sideAdmin

Pedido

Exclui a promoção de cupom. A promoção excluída:

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

Após a exclusão, a promoção não pode ser restaurada. Os códigos de cupom da promoção excluída podem ser adicionados às promoções existentes.

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

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

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

Respostas

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

Resposta
Sem conteúdo

Ganhe promoção de cupomServer-sideAdmin

Pedido

Obtém uma promoção de cupom especificada.

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

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

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

Respostas

O cupom foi recebido 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(Promotions_coupon_bonus)
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"
is_enabledboolean(Promotions_coupon-is_enabled)
Padrão true
nameobject(Promotions_coupon_name)

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"}
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
total_limit_stateobject or null(Promotions_coupon_total_limit_state)

Limites para cada código de cupom exclusivo.

Resposta
application/json
{
  "bonus": [
    { … }
  ],
  "external_id": "summer20221",
  "is_enabled": true,
  "name": {
    "en-US": "Coupon name",
    "ru-RU": "Название купона"
  },
  "promotion_periods": [
    { … },
    { … }
  ],
  "redeem_code_limit": null,
  "redeem_total_limit": 100,
  "redeem_user_limit": null,
  "total_limit_state": {
    "available": 50,
    "reserved": 10,
    "used": 40
  }
}

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

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