Player Item Management - Increment 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. Increases the global count for the given scarce resource.

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

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
Amount	True	number	Amount to increase availability by.
ItemId	True	string	The item which needs more availability.
CatalogVersion		string	Which catalog is being updated. If null, uses the default catalog.
CustomTags		object	The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).

Responses

Name	Type	Description
200 OK	IncrementLimitedEditionItemAvailabilityResult
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
IncrementLimitedEditionItemAvailabilityRequest	This operation will increment the global counter for the number of these items available. This number cannot be decremented, except by actual grants.
IncrementLimitedEditionItemAvailabilityResult

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

IncrementLimitedEditionItemAvailabilityRequest

This operation will increment the global counter for the number of these items available. This number cannot be decremented, except by actual grants.

Name	Type	Description
Amount	number	Amount to increase availability by.
CatalogVersion	string	Which catalog is being updated. If null, uses the default catalog.
CustomTags	object	The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
ItemId	string	The item which needs more availability.

IncrementLimitedEditionItemAvailabilityResult

Error Codes

Name	Code
RequestAlreadyRunning	1249