Player Item Management - Move Item To Character From Character
NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2. Moves an item from a character's inventory into another of the users's character's inventory.
POST https://titleId.playfabapi.com/Server/MoveItemToCharacterFromCharacterRequest Header
| Name | Required | Type | Description |
|---|---|---|---|
| X-SecretKey | True |
string |
This API requires a title secret key, available to title admins, from PlayFab Game Manager. |
Request Body
| Name | Required | Type | Description |
|---|---|---|---|
| GivingCharacterId | True |
string |
Unique identifier of the character that currently has the item. |
| ItemInstanceId | True |
string |
Unique PlayFab assigned instance identifier of the item |
| PlayFabId | True |
string |
Unique PlayFab assigned ID of the user on whom the operation will be performed. |
| ReceivingCharacterId | True |
string |
Unique identifier of the character that will be receiving the item. |
Responses
| Name | Type | Description |
|---|---|---|
| 200 OK | ||
| 400 Bad Request |
This is the outer wrapper for all responses with errors |
Security
X-SecretKey
This API requires a title secret key, available to title admins, from PlayFab Game Manager.
Type:
apiKey
In:
header
Definitions
| Name | Description |
|---|---|
|
Api |
The basic wrapper around every failed API response |
|
Move |
Transfers an item from a character to another character that is owned by the same user. This will remove the item from the character's inventory (until and unless it is moved back), and will enable the other character to make use of the item instead. |
|
Move |
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 |
MoveItemToCharacterFromCharacterRequest
Transfers an item from a character to another character that is owned by the same user. This will remove the item from the character's inventory (until and unless it is moved back), and will enable the other character to make use of the item instead.
| Name | Type | Description |
|---|---|---|
| GivingCharacterId |
string |
Unique identifier of the character that currently has the item. |
| ItemInstanceId |
string |
Unique PlayFab assigned instance identifier of the item |
| PlayFabId |
string |
Unique PlayFab assigned ID of the user on whom the operation will be performed. |
| ReceivingCharacterId |
string |
Unique identifier of the character that will be receiving the item. |
MoveItemToCharacterFromCharacterResult
Error Codes
| Name | Code |
|---|---|
| CharacterNotFound | 1135 |
| ItemNotOwned | 1048 |