- Obter promoção de código promocional
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.
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.
Pedido
Exclui a promoção de código promocional. A promoção excluída:
- Desaparece da lista de promoções configuradas em seu projeto.
- Não é mais aplicada ao catálogo de itens e ao carrinho. O usuário não pode obter itens bônus ou comprar itens usando esta promoção.
Após a exclusão, a promoção não pode ser restaurada. Os códigos promocionais da promoção excluída podem ser adicionados às promoções existentes.
ID do projeto. Você pode encontrar esse parâmetro em sua Conta de Distribuidor ao lado do nome do projeto.
- Mock serverhttps://xsolla.redocly.app/_mock/pt/api/shop-builder/v3/project/{project_id}/admin/promocode/{external_id}
- https://store.xsolla.com/api/v3/project/{project_id}/admin/promocode/{external_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/v3/project/44056/admin/promocode/coupon_44056_1ID do projeto. Você pode encontrar esse parâmetro em sua Conta de Distribuidor ao lado do nome do projeto.
- Mock serverhttps://xsolla.redocly.app/_mock/pt/api/shop-builder/v3/project/{project_id}/admin/promocode/{external_id}
- https://store.xsolla.com/api/v3/project/{project_id}/admin/promocode/{external_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/v3/project/44056/admin/promocode/coupon_44056_1O código promocional foi recebido com sucesso.
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.
Lista de itens que são descontados por um código promocional.
Lista de IDs de promoção a serem excluídos ao aplicar esta promoção.
Example: [12, 789]
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.
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.
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.
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.
Períodos de validade da promoção. Se múltiplos períodos forem especificados, tanto date_from quanto date_until são necessários.
Número de resgates por código.
Limita o número total de cupons.
Limita o número total de cupons resgatados por um único usuário.
{ "bonus": [ { … } ], "discount": { "percent": "10.99" }, "discounted_items": null, "excluded_promotions": [ 23, 45 ], "external_id": "summer20221", "is_enabled": true, "name": { "en-US": "Coupon name", "ru-RU": "Название купона" }, "promotion_periods": [ { … }, { … } ], "redeem_code_limit": 1, "redeem_total_limit": 100, "redeem_user_limit": null, "total_limit_state": { "available": 50, "reserved": 10, "used": 40 } }
ID do projeto. Você pode encontrar esse parâmetro em sua Conta de Distribuidor ao lado do nome do projeto.
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.
Lista de itens que são descontados por um código promocional.
Lista de IDs de promoção a serem excluídos ao aplicar esta promoção.
Example: [12, 789]
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.
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.
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.
Períodos de validade da promoção. Se múltiplos períodos forem especificados, tanto date_from quanto date_until são necessários.
Número de resgates por código.
Limita o número total de cupons.
- Mock serverhttps://xsolla.redocly.app/_mock/pt/api/shop-builder/v3/project/{project_id}/admin/promocode/{external_id}
- https://store.xsolla.com/api/v3/project/{project_id}/admin/promocode/{external_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/v3/project/44056/admin/promocode/coupon_44056_1 \
-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"
},
"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
}'