Resgatar código promocional

Resgata um código promocional de promoção. Depois de resgatar um código promocional, o usuário receberá itens gratuitos e/ou o preço do carrinho e/ou itens específicos será diminuído.

SecurityAuthForCart

Request

path Parameters

project_id

required

integer

ID do projeto. Você pode encontrar esse parâmetro em sua Conta de Distribuidor ao lado do nome do projeto.

Example: 44056

Request Body schema: application/json

object or null

required

string

Default: "current"

ID do carrinho.

coupon_code

string [ 1 .. 128 ] characters

Default: "SUMMER2021"

Código exclusivo do código promocional. Contém letras e números.

object

A recompensa selecionada por um usuário. A chave de objeto é um SKU de uma unidade, e o valor é um SKU de um dos itens em uma unidade.

property name*

additional property

string

Responses

200

Código promocional resgatado com sucesso.

401

Autenticação não aprovada ou errada.

403

Cabeçalho de autorização não enviado.

404

Insira um código promocional válido.

422

Solicitação inválida.

Request samples

Payload
curl
JavaScript
Node.js
Python
C#
Go
Java

6 more

application/json

{"cart": {"id": "current"
},
"coupon_code": "SUMMER2021",
"selected_unit_items": {"game_1": "game_1_steam",
"game_2": "game_2_playstation"
}
}

Response samples

3 more

application/json

response

{"cart_id": "cart_id",
"is_free": false,
"items": [{"attributes": [ ],
"can_be_bought": true,
"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,
"limits": {"per_user": {"available": 3,
"recurrent_schedule": {"interval_type": "weekly",
"reset_next_date": 1746057600
},
"total": 5
}
},
"name": "Xsolla Booster Mega",
"periods": [{"date_from": "2020-08-11T10:00:00+03:00",
"date_until": "2020-08-11T20:00:00+03:00"
}
],
"price": {"amount": "50.0000000000000000",
"amount_without_discount": "100.0000000000000000",
"currency": "USD"
},
"promotions": [{"bonus": [{"image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png",
"name": "Xsolla Minigun",
"quantity": 1,
"sku": "minigun_1",
"type": "virtual_good"
}
],
"date_end": "2026-04-15T16:16:00+03:00",
"date_start": "2020-04-15T16:16:00+03:00",
"discount": {"percent": "50.00"
},
"name": "Bonus promotion"
}
],
"quantity": 123,
"sku": "booster_mega_1",
"type": "virtual_good",
"virtual_item_type": "consumable",
"virtual_prices": [ ],
"vp_rewards": [{"amount": 130,
"image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg",
"is_clan": false,
"item_id": 175232,
"name": "Value point",
"sku": "value_point_1"
},
{"amount": 50,
"image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg",
"is_clan": true,
"item_id": 186321,
"name": "Clan Reward VP 1",
"sku": "clan_value_point_sku_1"
}
]
},
{"attributes": [ ],
"can_be_bought": true,
"description": "Honshu Boshin Wakizashi - Modern Tactical Samurai / Ninja Sword - Hand Forged 1060 Carbon Steel - Full Tang, Fully Functional, Battle Ready - Black TPR, Steel Guard and Pommel.",
"groups": [ ],
"image_url": "https://cdn.xsolla.net/img/misc/images/e9f2f4a634bc96ea03b5d5ceadd7c55f.png",
"is_free": true,
"limits": {"per_user": {"available": 3,
"recurrent_schedule": {"interval_type": "weekly",
"reset_next_date": 1746057600
},
"total": 5
}
},
"name": "Sword Xsolla Skin",
"periods": [{"date_from": "2020-08-11T10:00:00+03:00",
"date_until": "2020-08-11T20:00:00+03:00"
}
],
"price": [ ],
"promotions": [{"bonus": [{"image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png",
"name": "Xsolla Minigun",
"quantity": 1,
"sku": "minigun_1",
"type": "virtual_good"
}
],
"date_end": "2026-04-15T16:16:00+03:00",
"date_start": "2020-04-15T16:16:00+03:00",
"discount": {"percent": "50.00"
},
"name": "Bonus promotion"
}
],
"quantity": 1,
"sku": "swords_1",
"type": "virtual_good",
"virtual_item_type": "non_consumable",
"virtual_prices": [ ],
"vp_rewards": [{"amount": 130,
"image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg",
"item_id": 175232,
"name": "Value point",
"sku": "value_point_1"
},
{"amount": 50,
"image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg",
"is_clan": true,
"item_id": 186321,
"name": "Clan Reward VP 1",
"sku": "clan_value_point_sku_1"
}
]
}
],
"price": {"amount": "6150.0000000000000000",
"amount_without_discount": "12300.0000000000000000",
"currency": "USD"
},
"rewards": {"bonus": [{"item": {"description": "Honshu Boshin Wakizashi - Modern Tactical Samurai / Ninja Sword - Hand Forged 1060 Carbon Steel - Full Tang, Fully Functional, Battle Ready - Black TPR, Steel Guard and Pommel.",
"image_url": "https://cdn.xsolla.net/img/misc/images/e9f2f4a634bc96ea03b5d5ceadd7c55f.png",
"name": "Sword Xsolla Skin",
"sku": "swords_1",
"type": "virtual_good",
"virtual_item_type": "non_consumable"
},
"quantity": 1
}
],
"discount": {"percent": null
},
"discounted_items": [{"discount": {"percent": "50.00"
},
"sku": "booster_mega_1"
}
],
"is_selectable": false
}
}

System statusAll services operational

Privacy Settings