Player Item Management - Purchase Item

  • Reference
Service:
Client
API Version:
240412

NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2. Buys a single item with virtual currency. You must specify both the virtual currency to use to purchase, as well as what the client believes the price to be. This lets the server fail the purchase if the price has changed.

POST https://titleId.playfabapi.com/Client/PurchaseItem

Request Header

Name Required Type Description
X-Authorization True

string

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

Request Body

Name Required Type Description
ItemId True

string

Unique identifier of the item to purchase.
Price True

number

Price the client expects to pay for the item (in case a new catalog or store was uploaded, with new prices).
VirtualCurrency True

string

Virtual currency to use to purchase the item.
CatalogVersion

string

Catalog version for the items to be purchased (defaults to most recent version.
CharacterId

string

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

object

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

string

Store to buy this item through. If not set, prices default to those in the catalog.

Responses

Name Type Description
200 OK

PurchaseItemResult

400 Bad Request

ApiErrorWrapper

This is the outer wrapper for all responses with errors

Security

X-Authorization

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

Type: apiKey
In: header

Definitions

Name Description
ApiErrorWrapper

The basic wrapper around every failed API response
ItemInstance

A unique instance of an item in a user's inventory. Note, to retrieve additional information for an item such as Tags, Description that are the same across all instances of the item, a call to GetCatalogItems is required. The ItemID of can be matched to a catalog entry, which contains the additional information. Also note that Custom Data is only set when the User's specific instance has updated the CustomData via a call to UpdateUserInventoryItemCustomData. Other fields such as UnitPrice and UnitCurrency are only set when the item was granted via a purchase.
PurchaseItemRequest

Please note that the processing time for inventory grants and purchases increases fractionally the more items are in the inventory, and the more items are in the grant/purchase operation (with each item in a bundle being a distinct add).
PurchaseItemResult

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

ItemInstance

A unique instance of an item in a user's inventory. Note, to retrieve additional information for an item such as Tags, Description that are the same across all instances of the item, a call to GetCatalogItems is required. The ItemID of can be matched to a catalog entry, which contains the additional information. Also note that Custom Data is only set when the User's specific instance has updated the CustomData via a call to UpdateUserInventoryItemCustomData. Other fields such as UnitPrice and UnitCurrency are only set when the item was granted via a purchase.

Name Type Description
Annotation

string

Game specific comment associated with this instance when it was added to the user inventory.
BundleContents

string[]

Array of unique items that were awarded when this catalog item was purchased.
BundleParent

string

Unique identifier for the parent inventory item, as defined in the catalog, for object which were added from a bundle or container.
CatalogVersion

string

Catalog version for the inventory item, when this instance was created.
CustomData

object

A set of custom key-value pairs on the instance of the inventory item, which is not to be confused with the catalog item's custom data.
DisplayName

string

CatalogItem.DisplayName at the time this item was purchased.
Expiration

string

Timestamp for when this instance will expire.
ItemClass

string

Class name for the inventory item, as defined in the catalog.
ItemId

string

Unique identifier for the inventory item, as defined in the catalog.
ItemInstanceId

string

Unique item identifier for this specific instance of the item.
PurchaseDate

string

Timestamp for when this instance was purchased.
RemainingUses

number

Total number of remaining uses, if this is a consumable item.
UnitCurrency

string

Currency type for the cost of the catalog item. Not available when granting items.
UnitPrice

number

Cost of the catalog item in the given currency. Not available when granting items.
UsesIncrementedBy

number

The number of uses that were added or removed to this item in this call.

PurchaseItemRequest

Please note that the processing time for inventory grants and purchases increases fractionally the more items are in the inventory, and the more items are in the grant/purchase operation (with each item in a bundle being a distinct add).

Name Type Description
CatalogVersion

string

Catalog version for the items to be purchased (defaults to most recent version.
CharacterId

string

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

object

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

string

Unique identifier of the item to purchase.
Price

number

Price the client expects to pay for the item (in case a new catalog or store was uploaded, with new prices).
StoreId

string

Store to buy this item through. If not set, prices default to those in the catalog.
VirtualCurrency

string

Virtual currency to use to purchase the item.

PurchaseItemResult

Name Type Description
Items

ItemInstance[]

Details for the items purchased.

Error Codes

Name Code
CharacterNotFound 1135
InsufficientFunds 1059
InvalidVirtualCurrency 1051
ItemNotFound 1047
OperationNotSupportedForPlatform 1219
StoreNotFound 1221
WrongPrice 1053
WrongVirtualCurrency 1052