Catalog - Delete Item

Service:

Economy

API Version:

241122

Removes an item from working catalog and all published versions from the public catalog.

POST https://titleId.playfabapi.com/Catalog/DeleteItem

Request Header

Name	Required	Type	Description
X-EntityToken	True	string	This API requires an Entity Session Token, available from the Entity GetEntityToken method.

Request Body

Name	Type	Description
AlternateId	CatalogAlternateId	An alternate ID associated with this item.
CustomTags	object	The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
Entity	EntityKey	The entity to perform this action on.
Id	string	The unique ID of the item.

Responses

Name	Type	Description
200 OK	DeleteItemResponse
400 Bad Request	ApiErrorWrapper	This is the outer wrapper for all responses with errors

Security

X-EntityToken

This API requires an Entity Session Token, available from the Entity GetEntityToken method.

Type: apiKey
In: header

Definitions

Name	Description
ApiErrorWrapper	The basic wrapper around every failed API response
CatalogAlternateId
DeleteItemRequest
DeleteItemResponse
EntityKey	Combined entity type and ID structure which uniquely identifies a single entity.

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

CatalogAlternateId

Name	Type	Description
Type	string	Type of the alternate ID.
Value	string	Value of the alternate ID.

DeleteItemRequest

Name	Type	Description
AlternateId	CatalogAlternateId	An alternate ID associated with this item.
CustomTags	object	The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
Entity	EntityKey	The entity to perform this action on.
Id	string	The unique ID of the item.

DeleteItemResponse

EntityKey

Combined entity type and ID structure which uniquely identifies a single entity.

Name	Type	Description
Id	string	Unique ID of the entity.
Type	string	Entity type. See https://docs.microsoft.com/gaming/playfab/features/data/entities/available-built-in-entity-types

Error Codes

Name	Code
DatabaseThroughputExceeded	1113
ItemNotFound	1047