Player Item Management - Check Limited Edition Item Availability

Service:

Admin

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. Checks the global count for the limited edition item.

POST https://titleId.playfabapi.com/Admin/CheckLimitedEditionItemAvailability

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
ItemId	True	string	The item to check for.
CatalogVersion		string	Which catalog is being updated. If null, uses the default catalog.

Responses

Name	Type	Description
200 OK	CheckLimitedEditionItemAvailabilityResult
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
CheckLimitedEditionItemAvailabilityRequest	This returns the total number of these items available.
CheckLimitedEditionItemAvailabilityResult

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

CheckLimitedEditionItemAvailabilityRequest

This returns the total number of these items available.

Name	Type	Description
CatalogVersion	string	Which catalog is being updated. If null, uses the default catalog.
ItemId	string	The item to check for.

CheckLimitedEditionItemAvailabilityResult

Name	Type	Description
Amount	number	The amount of the specified resource remaining.