다음을 통해 공유


Inventory - Update Inventory Items

Update inventory items

POST https://titleId.playfabapi.com/Inventory/UpdateInventoryItems

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
CollectionId

string

The id of the entity's collection to perform this action on. (Default="default"). The number of inventory collections is unlimited.

CustomTags

object

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

ETag

string

ETags are used for concurrency checking when updating resources. More information about using ETags can be found here: https://learn.microsoft.com/en-us/gaming/playfab/features/economy-v2/catalog/etags

Entity

EntityKey

The entity to perform this action on.

IdempotencyId

string

The Idempotency ID for this request. Idempotency IDs can be used to prevent operation replay in the medium term but will be garbage collected eventually.

Item

InventoryItem

The inventory item to update with the specified values.

Responses

Name Type Description
200 OK

UpdateInventoryItemsResponse

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

EntityKey

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

InventoryItem
UpdateInventoryItemsRequest

Given an entity type, entity identifier and container details, will update the entity's inventory items

UpdateInventoryItemsResponse

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

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

InventoryItem

Name Type Description
Amount

number

The amount of the item.

DisplayProperties

object

Game specific properties for display purposes. This is an arbitrary JSON blob. The Display Properties field has a 1000 byte limit.

ExpirationDate

string

Only used for subscriptions. The date of when the item will expire in UTC.

Id

string

The id of the item. This should correspond to the item id in the catalog.

StackId

string

The stack id of the item.

Type

string

The type of the item. This should correspond to the item type in the catalog.

UpdateInventoryItemsRequest

Given an entity type, entity identifier and container details, will update the entity's inventory items

Name Type Description
CollectionId

string

The id of the entity's collection to perform this action on. (Default="default"). The number of inventory collections is unlimited.

CustomTags

object

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

ETag

string

ETags are used for concurrency checking when updating resources. More information about using ETags can be found here: https://learn.microsoft.com/en-us/gaming/playfab/features/economy-v2/catalog/etags

Entity

EntityKey

The entity to perform this action on.

IdempotencyId

string

The Idempotency ID for this request. Idempotency IDs can be used to prevent operation replay in the medium term but will be garbage collected eventually.

Item

InventoryItem

The inventory item to update with the specified values.

UpdateInventoryItemsResponse

Name Type Description
ETag

string

ETags are used for concurrency checking when updating resources. More information about using ETags can be found here: https://learn.microsoft.com/en-us/gaming/playfab/features/economy-v2/catalog/etags

IdempotencyId

string

The idempotency id used in the request.

TransactionIds

string[]

The ids of transactions that occurred as a result of the request.

Error Codes

Name Code
DatabaseThroughputExceeded 1113
ItemNotFound 1047