Inventory - Redeem Microsoft Store Inventory Items
Redeem items.
Allowed entity token types: title, master_player_account, title_player_account
POST https://titleId.playfabapi.com/Inventory/RedeemMicrosoftStoreInventoryItemsRequest Header
| Name | Required | Type | Description |
|---|---|---|---|
| X-EntityToken | True |
string |
This API requires an Entity Session Token, available from the Entity GetEntityToken method. |
Request Body
| Name | Type | Description |
|---|---|---|
| CollectionId |
string |
The id of the entity's collection to perform this action on. (Default="default") |
| CollectionsIdKey |
string |
The OneStore Collections Id Key used for AAD authentication. |
| CustomTags |
object |
The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). |
| Entity |
The entity to perform this action on. |
|
| XboxToken |
string |
Xbox Token used for delegated business partner authentication. Token provided by the Xbox Live SDK method GetTokenAndSignatureAsync("POST", "https://playfabapi.com/", ""). |
Responses
| Name | Type | Description |
|---|---|---|
| 200 OK | ||
| 400 Bad Request |
This is the outer wrapper for all responses with errors |
Security
X-EntityToken
This API requires an Entity Session Token, available from the Entity GetEntityToken method.
Type:
apiKey
In:
header
Definitions
| Name | Description |
|---|---|
|
Api |
The basic wrapper around every failed API response |
|
Entity |
Combined entity type and ID structure which uniquely identifies a single entity. |
|
Redeem |
Redeem items from the Microsoft Store. |
|
Redeem |
|
|
Redemption |
|
|
Redemption |
ApiErrorWrapper
The basic wrapper around every failed API response
| Name | Type | Description |
|---|---|---|
| code |
integer |
Numerical HTTP code |
| error |
string |
Playfab error code |
| errorCode |
integer |
Numerical PlayFab error code |
| errorDetails |
object |
Detailed description of individual issues with the request object |
| errorMessage |
string |
Description for the PlayFab errorCode |
| status |
string |
String HTTP code |
EntityKey
Combined entity type and ID structure which uniquely identifies a single entity.
| Name | Type | Description |
|---|---|---|
| Id |
string |
Unique ID of the entity. |
| Type |
string |
Entity type. See https://docs.microsoft.com/gaming/playfab/features/data/entities/available-built-in-entity-types |
RedeemMicrosoftStoreInventoryItemsRequest
Redeem items from the Microsoft Store.
| Name | Type | Description |
|---|---|---|
| CollectionId |
string |
The id of the entity's collection to perform this action on. (Default="default") |
| CollectionsIdKey |
string |
The OneStore Collections Id Key used for AAD authentication. |
| CustomTags |
object |
The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). |
| Entity |
The entity to perform this action on. |
|
| XboxToken |
string |
Xbox Token used for delegated business partner authentication. Token provided by the Xbox Live SDK method GetTokenAndSignatureAsync("POST", "https://playfabapi.com/", ""). |
RedeemMicrosoftStoreInventoryItemsResponse
| Name | Type | Description |
|---|---|---|
| Failed |
The list of failed redemptions from the external marketplace. |
|
| Succeeded |
The list of successful redemptions from the external marketplace. |
|
| TransactionIds |
string[] |
The Transaction IDs associated with the inventory modifications |
RedemptionFailure
| Name | Type | Description |
|---|---|---|
| FailureCode |
string |
The marketplace failure code. |
| FailureDetails |
string |
The marketplace error details explaining why the offer failed to redeem. |
| MarketplaceAlternateId |
string |
The Marketplace Alternate ID being redeemed. |
| MarketplaceTransactionId |
string |
The transaction id in the external marketplace. |
RedemptionSuccess
| Name | Type | Description |
|---|---|---|
| MarketplaceAlternateId |
string |
The Marketplace Alternate ID being redeemed. |
| MarketplaceTransactionId |
string |
The transaction id in the external marketplace. |
| SuccessTimestamp |
string |
The timestamp for when the redeem was completed. |
Error Codes
| Name | Code |
|---|---|
| AccountNotLinked | 1014 |
| InvalidCatalogItemConfiguration | 4015 |
| InvalidXboxLiveToken | 1188 |
| XboxInaccessible | 1339 |
| XboxXASSExchangeFailure | 1306 |