跳轉到主要內容
POST
Redeem Coupon

授權

X-Authorization
string
header
必填

This API requires a client session ticket, available from any Client Login function.

主體

application/json

Coupon codes can be created for any item, or set of items, in the catalog for the title. This operation causes the coupon to be consumed, and the specific items to be awarded to the user. Attempting to re-use an already consumed code, or a code which has not yet been created in the service, will result in an error.

Coupon codes can be created for any item, or set of items, in the catalog for the title. This operation causes the coupon to be consumed, and the specific items to be awarded to the user. Attempting to re-use an already consumed code, or a code which has not yet been created in the service, will result in an error.

CouponCode
string
必填

Generated coupon code to redeem.

CatalogVersion
string

Catalog version of the coupon. If null, uses the default catalog

CharacterId
string

Optional identifier for the Character that should receive the item. If null, item is added to the player

CustomTags
object

The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).

回應

code
integer

The Http status code. If X-ReportErrorAsSuccess header is set to true, this will report the actual http error code.

status
string

The Http status code as a string.

data
object
範例:
最後修改於 2026年10月6日