Gutscheincode einlösen

Gutscheincode einlösenClient-side

post/v2/project/{project_id}/coupon/redeem

Löst einen Gutscheincode ein. Der Benutzer erhält nach dem Einlösen eines Gutscheins einen Bonus.

SecurityXsollaLoginUserJWT

Request

path Parameters

project_id

required

integer

Projekt-ID. Dieser Parameter wird im Kundenportal neben dem Projektnamen angezeigt.

Example: 44056

Request Body schema: application/json

coupon_code

string [ 1 .. 128 ] characters

Default: "WINTER2021"

Eindeutiger Gutscheincode. Enthält Buchstaben und Ziffern.

object

Die von einem Benutzer ausgewählte Belohnung. Der Objektschlüssel ist eine SKU einer Einheit und der Wert ist eine SKU eines der Artikel in einer Einheit.

property name*

additional property

string

Responses

200

Gutschein wurde erfolgreich eingelöst.

401

Authentifizierung nicht bestanden oder falsch.

403

Autorisierungs-Header nicht gesendet.

404

Geben Sie einen gültigen Gutscheincode ein.

422

Ungültige Anfrage.

Request samples

application/json

{"coupon_code": "WINTER2021",
"selected_unit_items": {"game_1": "game_1_steam",
"game_2": "game_2_playstation"
}
}

Response samples

application/json

{"items": [{"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",
"inventory_options": {"consumable": {"usages_count": 1
},
"expiration_period": null
},
"is_free": true,
"name": "Xsolla Booster Mega",
"price": null,
"quantity": 1,
"sku": "booster_mega_1",
"type": "virtual_good",
"virtual_item_type": "consumable",
"virtual_prices": [ ]
}
]
}