Share via


Title-Wide Data Management - Delete Store

NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2. Deletes an existing virtual item store

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

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
StoreId True

string

unqiue identifier for the store which is to be deleted

CatalogVersion

string

catalog version of the store to delete. 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

DeleteStoreResult

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

DeleteStoreRequest

This non-reversible operation will permanently delete the requested store.

DeleteStoreResult

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

DeleteStoreRequest

This non-reversible operation will permanently delete the requested store.

Name Type Description
CatalogVersion

string

catalog version of the store to delete. If null, uses the default catalog.

CustomTags

object

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

StoreId

string

unqiue identifier for the store which is to be deleted

DeleteStoreResult

Error Codes

Name Code
CatalogNotConfigured 1218
StoreNotFound 1221