Unlock Container Instance
NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2. Opens a specific container (ContainerItemInstanceId), with a specific key (KeyItemInstanceId, when required), and returns the contents of the opened container. If the container (and key when relevant) are consumable (RemainingUses > 0), their RemainingUses will be decremented, consistent with the operation of ConsumeItem.
Error codes
This operation may return the following PlayFab errors:
| Error | Code |
|---|---|
| ContainerKeyInvalid | 1205 |
| ContainerNotOwned | 1018 |
| InvalidContainerItem | 1017 |
| InvalidItemIdInTable | 1020 |
| InvalidItemProperties | 1091 |
| KeyNotOwned | 1019 |
| ProductDisabledForTitle | 1609 |
Authorizations
This API requires a title secret key, available to title admins, from PlayFab Game Manager.
Body
Specify the container and optionally the catalogVersion for the container to open
Specify the container and optionally the catalogVersion for the container to open
ItemInstanceId of the container to unlock.
Unique PlayFab assigned ID of the user on whom the operation will be performed.
Specifies the catalog version that should be used to determine container contents. If unspecified, uses catalog associated with the item instance.
Unique PlayFab assigned ID for a specific character owned by a user
The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
ItemInstanceId of the key that will be consumed by unlocking this container. If the container requires a key, this parameter is required.
Response
The items and vc found within the container. These will be added and stacked in your inventory as appropriate.
The Http status code. If X-ReportErrorAsSuccess header is set to true, this will report the actual http error code.
The Http status code as a string.
The items and vc found within the container. These will be added and stacked in your inventory as appropriate.
