Obter inventário do usuário

NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2. Retrieves the user’s current inventory of virtual goods

Error codes

This operation may return the following PlayFab errors:

Error	Code
ProductDisabledForTitle	1609

POST

Client

GetUserInventory

Get User Inventory

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

import requests

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

payload = {}
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({})
};

fetch('https://{titleId}.playfabapi.com/Client/GetUserInventory', 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/GetUserInventory",
  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([
    
  ]),
  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/GetUserInventory"

	payload := strings.NewReader("{}")

	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/GetUserInventory")
  .header("X-Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{}")
  .asString();

require 'uri'
require 'net/http'

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

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 = "{}"

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

{
  "code": 200,
  "status": "OK",
  "data": {
    "Inventory": [
      {
        "ItemId": "shield_level_5",
        "ItemInstanceId": "9879843",
        "ItemClass": "shields",
        "CatalogVersion": "5"
      },
      {
        "ItemId": "energy_boost_1",
        "ItemInstanceId": "3854637",
        "ItemClass": "boosts",
        "RemainingUses": 4,
        "CatalogVersion": "5"
      }
    ],
    "VirtualCurrency": {
      "GC": 15
    },
    "VirtualCurrencyRechargeTimes": {
      "GC": {
        "SecondsToRecharge": 3600,
        "RechargeTime": "2014-01-01T12:00:00",
        "RechargeMax": 50
      }
    }
  }
}

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

Autorizações

X-Authorization

string

header

obrigatório

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

Corpo

application/json

CustomTags

object

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

Resposta

All items currently in the user inventory will be returned, irrespective of how they were acquired (via purchasing, grants, coupons, etc.). Items that are expired, fully consumed, or are no longer valid are not considered to be in the user's current inventory, and so will not be not included.

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

Show child attributes

Exemplo:

{
  "Inventory": [
    {
      "ItemId": "shield_level_5",
      "ItemInstanceId": "9879843",
      "ItemClass": "shields",
      "CatalogVersion": "5"
    },
    {
      "ItemId": "energy_boost_1",
      "ItemInstanceId": "3854637",
      "ItemClass": "boosts",
      "RemainingUses": 4,
      "CatalogVersion": "5"
    }
  ],
  "VirtualCurrency": { "GC": 15 },
  "VirtualCurrencyRechargeTimes": {
    "GC": {
      "SecondsToRecharge": 3600,
      "RechargeTime": "2014-01-01T12:00:00",
      "RechargeMax": 50
    }
  }
}

Última modificação em 6 de outubro de 2026

⌘I