Cupom resgatado com sucesso.
- Obter lista de promoções de cupons
Obtenha limites de código de cupom exclusivos
Ativar promoção de cupom
Obter códigos de cupom
Criar código de cupom
Gerar códigos de cupom
Desativar promoção de cupom
Obter limite de cupons de um usuário específico
Obter recompensas de cupom
Resgatar código de cupom
Criar promoção de cupom
Excluir promoção de cupom
Ganhe promoção de cupom
Promoção de cupom de atualização
Obter lista de promoções...
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
Caminho
Corpoapplication/jsonID do projeto. Você pode encontrar esse parâmetro em sua Conta de Distribuidor ao lado do nome do projeto.
Exemplo: 44056
Código de cupom exclusivo. Contém letras e números.
Padrão "WINTER2021"
Exemplo: "WINTER2021"
- Mock serverhttps://xsolla.redocly.app/_mock/pt/api/shop-builder/v2/project/{project_id}/coupon/redeem
- https://store.xsolla.com/api/v2/project/{project_id}/coupon/redeem
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
https://xsolla.redocly.app/_mock/pt/api/shop-builder/v2/project/44056/coupon/redeem \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"coupon_code": "WINTER2021",
"selected_unit_items": {
"game_1": "game_1_steam",
"game_2": "game_2_playstation"
}
}' Exemplo: [{"attributes":[],"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,"name":"Xsolla Booster Mega","price":{"amount":"50.0000000000000000","amount_without_discount":"100.0000000000000000","currency":"USD"},"quantity":1,"sku":"com.xsolla.booster_mega_1","type":"virtual_good","virtual_item_type":"consumable","virtual_prices":[]}]
Resposta
application/json
{ "items": [ { … } ] }
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/v3/project/{project_id}/admin/coupon
- https://store.xsolla.com/api/v3/project/{project_id}/admin/coupon
- 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/coupon?limit=50&offset=0'Resposta
application/json
{ "active_promotions_count": 2, "inactive_promotions_count": 0, "items": [ { … }, { … } ], "total_promotions_count": 2 }
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)(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.
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"
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"}
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.
Padrão 10
Exemplo: 10
Limita o número total de cupons.
Padrão 10
Exemplo: 10
- Mock serverhttps://xsolla.redocly.app/_mock/pt/api/shop-builder/v3/project/{project_id}/admin/coupon
- https://store.xsolla.com/api/v3/project/{project_id}/admin/coupon
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
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
}'Resposta
application/json
{ "external_id": "coupon_external_id" }