Player Item Management - Move Item To User 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 the owning user's inventory.

POST https://titleId.playfabapi.com/Server/MoveItemToUserFromCharacter

Request 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
CharacterId True

string

Unique PlayFab assigned ID for a specific character owned by a user

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.

Responses

Name Type Description
200 OK

MoveItemToUserFromCharacterResult

400 Bad Request

ApiErrorWrapper

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
ApiErrorWrapper

The basic wrapper around every failed API response

MoveItemToUserFromCharacterRequest

Transfers an item from a character to the owning user. This will remove the item from the character's inventory (until and unless it is moved back), and will enable the user to make use of the item instead.

MoveItemToUserFromCharacterResult

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

MoveItemToUserFromCharacterRequest

Transfers an item from a character to the owning user. This will remove the item from the character's inventory (until and unless it is moved back), and will enable the user to make use of the item instead.

Name Type Description
CharacterId

string

Unique PlayFab assigned ID for a specific character owned by a user

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.

MoveItemToUserFromCharacterResult

Error Codes

Name Code
CharacterNotFound 1135
ItemNotOwned 1048