Saltar para o conteúdo
/
Obter lista de cadeias de...

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

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

Obter lista de cadeias de ofertasServer-sideAdmin

Pedido

Obtém a lista de cadeias de ofertas para administração.

Aviso

Todos os projetos têm um limite no número de itens que podem ser retornados em uma única resposta. O valor padrão e máximo é de 10 itens por resposta. Para obter mais dados, use os parâmetros de consulta limit e offset para a paginação.
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
enabledinteger

Filtrar elementos pela flag is_enabled.

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

Respostas

A lista de cadeias de ofertas foi recuperada com êxito.

Corpoapplication/json
has_moreboolean(Pagination_has-more)

Usado como um indicador de que há mais páginas.

Exemplo: true
itemsArray of objects(admin-offer-chain-short-model)
Resposta
application/json
{
  "has_more": false,
  "items": [
    { … },
    { … },
    { … },
    { … }
  ]
}

Criar cadeia de ofertasServer-sideAdmin

Pedido

Cria uma cadeia de ofertas.

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)(chain_user-attribute_conditions_model-post)[ 1 .. 100 ] items

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

date_endstring or null(date-time)(offer_chain_date_end)

Data em que a cadeia de ofertas termina. Pode ser null. Se date_end for null, a cadeia de ofertas não terá um limite de tempo.

Exemplo: "2020-04-15T18:16:00+05:00"
date_startstring(date-time)(offer_chain_date_start)obrigatório

Data em que a cadeia de ofertas é iniciada.

Exemplo: "2020-04-15T18:16:00+05:00"
description(two-letter (object or null)) or (five-letter (object or null))(description-localization-object)

Objeto com traduções para a descrição do item. Aceita valores em um dos dois formatos: códigos de idioma minúsculos de duas letras (por exemplo, en) ou códigos de localidade de cinco caracteres (por exemplo, en-US). Embora ambos os formatos sejam aceitos, as respostas retornam códigos de idioma minúsculos de duas letras. Quando ambas as opções para o mesmo idioma são fornecidas (por exemplo, en e en-US), o último valor fornecido é armazenado. Você pode encontrar a lista completa de idiomas suportados na documentação.

One of:

Objeto com traduções para a descrição do item. Aceita valores em um dos dois formatos: códigos de idioma minúsculos de duas letras (por exemplo, en) ou códigos de localidade de cinco caracteres (por exemplo, en-US). Embora ambos os formatos sejam aceitos, as respostas retornam códigos de idioma minúsculos de duas letras. Quando ambas as opções para o mesmo idioma são fornecidas (por exemplo, en e en-US), o último valor fornecido é armazenado. Você pode encontrar a lista completa de idiomas suportados na documentação.

is_always_visibleboolean(chain_is_always_visible)

Se a cadeia deve ser visível para todos os usuários:

  • Se true, a cadeia é sempre exibida, independentemente do status de autenticação ou dos atributos do usuário.
  • Se false, a cadeia é exibida apenas se nenhuma cadeia personalizada for encontrada. Por exemplo, se o usuário não estiver autenticado, ou se seus atributos não corresponderem a nenhuma cadeia personalizada.

Aplica-se somente no contexto de cadeias personalizadas e é usado se a matriz attribute_conditions não for passada.

Padrão true
Exemplo: true
is_enabledboolean(is_enabled)obrigatório
Exemplo: true
name(two-letter (object or null)) or (five-letter (object or null))(name-localization-object)obrigatório

Objeto com traduções para o nome do item. Aceita valores em um dos dois formatos: códigos de idioma minúsculos de duas letras (por exemplo, en) ou códigos de idioma de cinco caracteres (por exemplo, en-US). Embora ambos os formatos sejam aceitos, as respostas retornam códigos de idioma minúsculos de duas letras. Quando ambas as opções para o mesmo idioma são fornecidas (por exemplo, en e en-US), o último valor fornecido é armazenado. Você pode encontrar a lista completa de idiomas suportados na documentação.

One of:

Objeto com traduções para o nome do item. Aceita valores em um dos dois formatos: códigos de idioma minúsculos de duas letras (por exemplo, en) ou códigos de idioma de cinco caracteres (por exemplo, en-US). Embora ambos os formatos sejam aceitos, as respostas retornam códigos de idioma minúsculos de duas letras. Quando ambas as opções para o mesmo idioma são fornecidas (por exemplo, en e en-US), o último valor fornecido é armazenado. Você pode encontrar a lista completa de idiomas suportados na documentação.

name.​arstring or null

Árabe

name.​bgstring or null

Búlgaro

name.​cnstring or null

Chinês (Simplificado)

name.​csstring or null

Tcheco

name.​destring or null

Alemão

name.​enstring or null

Inglês

name.​esstring or null

Espanhol (Espanha)

name.​frstring or null

Francês

name.​hestring or null

Hebraico

name.​idstring or null

Indonésio

name.​itstring or null

Italiano

name.​jastring or null

Japonês

name.​kmstring or null

Khmer

name.​kostring or null

Coreano

name.​lostring or null

Lao

name.​mystring or null

Birmanês

name.​nestring or null

Nepalês

name.​phstring or null

Filipino

name.​plstring or null

Polonês

name.​ptstring or null

Português

name.​rostring or null

Romeno

name.​rustring or null

Russo

name.​thstring or null

Tailandês

name.​trstring or null

Turco

name.​twstring or null

Chinês (Tradicional)

name.​vistring or null

Vietnamita

orderinteger(order)

Define a ordem do arranjo.

Exemplo: 1
recurrent_schedule(interval_type = weekly (object or null)) or (interval_type = monthly (object or null)) or (interval_type = a cada hora (object or null))(offer_chain_recurrent_schedule_create_update)

Período de redefinição da cadeia de ofertas.

One of:

Período de redefinição da cadeia de ofertas.

stepsArray of objects(create-offer-chain-step-model)obrigatório
steps[].​is_freeboolean(offer_chain_is_free)obrigatório

Indica se a etapa da cadeia de ofertas é gratuita:

steps[].​itemsArray of objects(modify-offer-chain-item-model)non-emptyobrigatório
steps[].​items[].​orderinteger or null>= 0

Ordem de recompensa para a etapa da cadeia de ofertas.

steps[].​items[].​quantityinteger>= 1obrigatório

Quantidade da recompensa de itens para esta etapa da cadeia.

steps[].​items[].​skustring(sku)[ 1 .. 255 ] characters^[a-zA-Z0-9_\-–.]*$obrigatório

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

Exemplo: "booster_mega_1"
steps[].​step_numberinteger(offer_chain_step_number)>= 1obrigatório

Número da etapa.

Exemplo: 2
curl -i -X POST \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/pt/api/shop-builder/v2/project/44056/admin/offer_chain \
  -H 'Content-Type: application/json' \
  -d '{
    "date_end": null,
    "date_start": "2023-04-15T18:16:00+05:00",
    "description": {
      "de": "Eine kurze Beschreibung einer regulären Angebotskette",
      "en": "A short description of a regular offer chain",
      "fr": "Une brève description d'\''une chaîne d'\''offres régulière",
      "it": "Una breve descrizione di una catena di offerte regolare",
      "ru": "Краткое описание обычной цепочки предложений"
    },
    "is_always_visible": true,
    "is_enabled": true,
    "name": {
      "de": "Neue Angebotskette",
      "en": "New offer chain",
      "fr": "Nouvelle chaîne d'\''offres",
      "it": "Nuova catena di offerte",
      "ru": "Новая цепочка предложений"
    },
    "order": 4,
    "recurrent_schedule": null,
    "steps": [
      {
        "is_free": false,
        "items": [
          {
            "quantity": 2,
            "sku": "chain_step_1_paid_bundle_sku"
          }
        ],
        "step_number": 1
      },
      {
        "is_free": true,
        "items": [
          {
            "quantity": 1,
            "sku": "chain_step_2_free_virtual_good_sku"
          }
        ],
        "step_number": 2
      },
      {
        "is_free": false,
        "items": [
          {
            "quantity": 5,
            "sku": "chain_step_3_paid_virtual_currency_package_sku"
          }
        ],
        "step_number": 3
      },
      {
        "is_free": true,
        "items": [
          {
            "quantity": 1,
            "sku": "chain_step_4_free_bundle_sku"
          }
        ],
        "step_number": 4
      }
    ]
  }'

Respostas

A cadeia de ofertas foi criada com sucesso.

Corpoapplication/json
offer_chain_idinteger
Exemplo: 10
Resposta
application/json
{
  "offer_chain_id": 10
}

Excluir cadeia de ofertasServer-sideAdmin

Pedido

Exclui uma cadeia de ofertas específica.

Após a exclusão:

  • Todas as recompensas já recebidas pelos usuários são retidas.
  • Etapas não concluídas ficam indisponíveis e suas recompensas não podem mais ser obtidas.

Ao contrário de desabilitar a cadeia de ofertas por meio da chamada da chamada Alternar cadeia de ofertas, a exclusão é irreversível e o progresso do usuário não é preservado.

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

ID de cadeia de ofertas.

Exemplo: 101
curl -i -X DELETE \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/pt/api/shop-builder/v2/project/44056/admin/offer_chain/id/101

Respostas

Cadeia de ofertas excluída com sucesso.

Corpo
Resposta
Sem conteúdo

Cliente

Operações

Admin

Operações

Cliente

Operações

Admin

Operações

Cliente

Operações

Admin

Operações