ID de cadeia de ofertas.
/
Obter cadeia de ofertas
API Shop Builder (2.0.0)
- 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
Idiomas
Servidores
Mock server
https://xsolla.redocly.app/_mock/pt/api/shop-builder/
https://store.xsolla.com/api/
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
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
ID do projeto. Você pode encontrar esse parâmetro em sua Conta de Distribuidor ao lado do nome do projeto.
Exemplo: 44056
- Mock serverhttps://xsolla.redocly.app/_mock/pt/api/shop-builder/v2/project/{project_id}/admin/offer_chain/id/{offer_chain_id}
- https://store.xsolla.com/api/v2/project/{project_id}/admin/offer_chain/id/{offer_chain_id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X DELETE \
-u <username>:<password> \
https://xsolla.redocly.app/_mock/pt/api/shop-builder/v2/project/44056/admin/offer_chain/id/101Caminho
ID do projeto. Você pode encontrar esse parâmetro em sua Conta de Distribuidor ao lado do nome do projeto.
Exemplo: 44056
- Mock serverhttps://xsolla.redocly.app/_mock/pt/api/shop-builder/v2/project/{project_id}/admin/offer_chain/id/{offer_chain_id}
- https://store.xsolla.com/api/v2/project/{project_id}/admin/offer_chain/id/{offer_chain_id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
-u <username>:<password> \
https://xsolla.redocly.app/_mock/pt/api/shop-builder/v2/project/44056/admin/offer_chain/id/101Os dados da cadeia de ofertas foram recuperados com êxito.
attribute_conditionsArray of tipo = string (object) or tipo = number (object) or tipo = data (object)(chain_user-attribute_conditions_model-get)[ 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.
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"
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.
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
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.
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)
Período de reinicialização recorrente da cadeia de ofertas.
One of:
Período de reinicialização recorrente da cadeia de ofertas.
Resposta
application/json
{ "attribute_conditions": [ { … }, { … }, { … } ], "date_end": "2025-04-25T18:16:00+05:00", "date_start": "2023-04-15T18:16:00+05:00", "description": { "de": "Personalisierte Angebotskette mit Benutzerattributbedingungen - für Elfen der Stufe 10 und höher, die Stufe 10 spätestens am 2026-01-01 00:00:00 erreicht haben, einschließlich", "en": "Personalized offer chain with user attribute conditions - for level 10 and above elves who reached level 10 no later than 2026-01-01 00:00:00, inclusive", "fr": "Chaîne d'offres personnalisée avec des conditions d'attribut utilisateur - pour les elfes de niveau 10 et plus qui ont atteint le niveau 10 au plus tard le 2026-01-01 00:00:00, inclus", "it": "Catena di offerte personalizzata con condizioni di attributo utente - per elfi di livello 10 e superiore che hanno raggiunto il livello 10 non più tardi del 2026-01-01 00:00:00, inclusi", "ru": "Персонализированная цепочка предложений - для эльфов 10 уровня и выше, достигших 10 уровня не позднее 2026-01-01 00:00:00 включительно" }, "id": 3, "is_always_visible": false, "is_enabled": true, "name": { "de": "Angebotskette", "en": "Offer chain", "fr": "Chaîne d'offres", "it": "Catena di offerte", "ru": "Цепочка" }, "order": 1, "recurrent_schedule": null, "steps": [ { … }, { … }, { … } ] }
Caminho
Corpoapplication/jsonID do projeto. Você pode encontrar esse parâmetro em sua Conta de Distribuidor ao lado do nome do projeto.
Exemplo: 44056
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.
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"
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.
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
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.
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.
Indica se a etapa da cadeia de ofertas é gratuita:
- Se
true, a etapa deve ser resgatada usando a chamada Resgate a etapa da cadeia de oferta gratuita. - Se
false, ela deve ser comprada usando a chamada Criar ordem para a etapa da cadeia de ofertas pagas.
Quantidade da recompensa de itens para esta etapa da cadeia.
ID exclusivo da etapa da cadeia. Especifique-o durante a atualização para reter o progresso do usuário para esta etapa.
Exemplo: 10
- Mock serverhttps://xsolla.redocly.app/_mock/pt/api/shop-builder/v2/project/{project_id}/admin/offer_chain/id/{offer_chain_id}
- https://store.xsolla.com/api/v2/project/{project_id}/admin/offer_chain/id/{offer_chain_id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PUT \
-u <username>:<password> \
https://xsolla.redocly.app/_mock/pt/api/shop-builder/v2/project/44056/admin/offer_chain/id/101 \
-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": "Aktualisierte Angebotskette",
"en": "Updated offer chain",
"fr": "Chaîne d'\''offres mise à jour",
"it": "Catena di offerte aggiornata",
"ru": "Обновляемая цепочка предложений"
},
"order": 4,
"recurrent_schedule": null,
"steps": [
{
"is_free": false,
"items": [
{
"quantity": 2,
"sku": "chain_step_1_paid_bundle_sku"
}
],
"step_id": 10,
"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_id": 9,
"step_number": 4
}
]
}'