컨테이너 아이템 잠금 해제

NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2. Searches target inventory for an ItemInstance matching the given CatalogItemId, if necessary unlocks it using an appropriate key, 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
CharacterNotFound	1135
ContainerKeyInvalid	1205
ContainerNotOwned	1018
InvalidContainerItem	1017
InvalidItemIdInTable	1020
InvalidItemProperties	1091
KeyNotOwned	1019
ProductDisabledForTitle	1609

POST

Client

UnlockContainerItem

Unlock Container Item

curl --request POST \
  --url https://{titleId}.playfabapi.com/Client/UnlockContainerItem \
  --header 'Content-Type: application/json' \
  --header 'X-Authorization: <api-key>' \
  --data '
{
  "ContainerItemId": "crate block 1"
}
'

import requests

url = "https://{titleId}.playfabapi.com/Client/UnlockContainerItem"

payload = { "ContainerItemId": "crate block 1" }
headers = {
    "X-Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-Authorization': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({ContainerItemId: 'crate block 1'})
};

fetch('https://{titleId}.playfabapi.com/Client/UnlockContainerItem', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{titleId}.playfabapi.com/Client/UnlockContainerItem",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'ContainerItemId' => 'crate block 1'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-Authorization: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://{titleId}.playfabapi.com/Client/UnlockContainerItem"

	payload := strings.NewReader("{\n  \"ContainerItemId\": \"crate block 1\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://{titleId}.playfabapi.com/Client/UnlockContainerItem")
  .header("X-Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"ContainerItemId\": \"crate block 1\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{titleId}.playfabapi.com/Client/UnlockContainerItem")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"ContainerItemId\": \"crate block 1\"\n}"

response = http.request(request)
puts response.read_body

{
  "code": 200,
  "status": "OK",
  "data": {
    "UnlockedItemInstanceId": "0394760938094",
    "GrantedItems": [
      {
        "ItemId": "shield_level_5",
        "ItemInstanceId": "Unique Item ID",
        "ItemClass": "shields",
        "PurchaseDate": "2014-03-07T00:00:00",
        "Expiration": "2015-10-01T00:00:00",
        "RemainingUses": 10,
        "Annotation": "No Annotation",
        "CatalogVersion": "5",
        "BundleParent": "crate block 1"
      }
    ],
    "VirtualCurrency": {
      "GC": 20
    }
  }
}

{
  "code": 123,
  "errorCode": 123,
  "status": "<string>",
  "error": "<string>",
  "errorMessage": "<string>",
  "errorDetails": {}
}

인증

X-Authorization

string

header

필수

This API requires a client session ticket, available from any Client Login function.

본문

application/json

Specify the type of container to open and optionally the catalogVersion for the container to open

ContainerItemId

string

필수

Catalog ItemId of the container type to unlock.

CatalogVersion

string

Specifies the catalog version that should be used to determine container contents. If unspecified, uses default/primary catalog.

CharacterId

string

Unique PlayFab assigned ID for a specific character owned by a user

CustomTags

object

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

응답

The items and vc found within the container. These will be added and stacked in the appropriate inventory.

code

integer

The Http status code. If X-ReportErrorAsSuccess header is set to true, this will report the actual http error code.

status

string

The Http status code as a string.

data

object

The items and vc found within the container. These will be added and stacked in the appropriate inventory.

Show child attributes

예시:

{
  "UnlockedItemInstanceId": "0394760938094",
  "GrantedItems": [
    {
      "ItemId": "shield_level_5",
      "ItemInstanceId": "Unique Item ID",
      "ItemClass": "shields",
      "PurchaseDate": "2014-03-07T00:00:00",
      "Expiration": "2015-10-01T00:00:00",
      "RemainingUses": 10,
      "Annotation": "No Annotation",
      "CatalogVersion": "5",
      "BundleParent": "crate block 1"
    }
  ],
  "VirtualCurrency": { "GC": 20 }
}

마지막 수정일 2026년 10월 6일

⌘I

Unlock Container Item

curl --request POST \
  --url https://{titleId}.playfabapi.com/Client/UnlockContainerItem \
  --header 'Content-Type: application/json' \
  --header 'X-Authorization: <api-key>' \
  --data '
{
  "ContainerItemId": "crate block 1"
}
'

import requests

url = "https://{titleId}.playfabapi.com/Client/UnlockContainerItem"

payload = { "ContainerItemId": "crate block 1" }
headers = {
    "X-Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-Authorization': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({ContainerItemId: 'crate block 1'})
};

fetch('https://{titleId}.playfabapi.com/Client/UnlockContainerItem', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{titleId}.playfabapi.com/Client/UnlockContainerItem",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'ContainerItemId' => 'crate block 1'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-Authorization: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://{titleId}.playfabapi.com/Client/UnlockContainerItem"

	payload := strings.NewReader("{\n  \"ContainerItemId\": \"crate block 1\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://{titleId}.playfabapi.com/Client/UnlockContainerItem")
  .header("X-Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"ContainerItemId\": \"crate block 1\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{titleId}.playfabapi.com/Client/UnlockContainerItem")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"ContainerItemId\": \"crate block 1\"\n}"

response = http.request(request)
puts response.read_body

{
  "code": 200,
  "status": "OK",
  "data": {
    "UnlockedItemInstanceId": "0394760938094",
    "GrantedItems": [
      {
        "ItemId": "shield_level_5",
        "ItemInstanceId": "Unique Item ID",
        "ItemClass": "shields",
        "PurchaseDate": "2014-03-07T00:00:00",
        "Expiration": "2015-10-01T00:00:00",
        "RemainingUses": 10,
        "Annotation": "No Annotation",
        "CatalogVersion": "5",
        "BundleParent": "crate block 1"
      }
    ],
    "VirtualCurrency": {
      "GC": 20
    }
  }
}

{
  "code": 123,
  "errorCode": 123,
  "status": "<string>",
  "error": "<string>",
  "errorMessage": "<string>",
  "errorDetails": {}
}

PlayFab API

PlayFab REST API References

컨테이너 아이템 잠금 해제

Error codes

인증

본문

응답