Accorder des articles à l'utilisateur

NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2. Adds the specified items to the specified user’s inventory

Error codes

This operation may return the following PlayFab errors:

Error	Code
AccountNotFound	1001
CatalogNotConfigured	1218
ProductDisabledForTitle	1609

POST

Server

GrantItemsToUser

Grant Items To User

curl --request POST \
  --url https://{titleId}.playfabapi.com/Server/GrantItemsToUser \
  --header 'Content-Type: application/json' \
  --header 'X-SecretKey: <api-key>' \
  --data '
{
  "PlayFabId": "20394883",
  "Annotation": "Entered Level 2",
  "ItemIds": [
    "shield_level_3",
    "shield_level_4"
  ]
}
'

import requests

url = "https://{titleId}.playfabapi.com/Server/GrantItemsToUser"

payload = {
    "PlayFabId": "20394883",
    "Annotation": "Entered Level 2",
    "ItemIds": ["shield_level_3", "shield_level_4"]
}
headers = {
    "X-SecretKey": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-SecretKey': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    PlayFabId: '20394883',
    Annotation: 'Entered Level 2',
    ItemIds: ['shield_level_3', 'shield_level_4']
  })
};

fetch('https://{titleId}.playfabapi.com/Server/GrantItemsToUser', 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/Server/GrantItemsToUser",
  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([
    'PlayFabId' => '20394883',
    'Annotation' => 'Entered Level 2',
    'ItemIds' => [
        'shield_level_3',
        'shield_level_4'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-SecretKey: <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/Server/GrantItemsToUser"

	payload := strings.NewReader("{\n  \"PlayFabId\": \"20394883\",\n  \"Annotation\": \"Entered Level 2\",\n  \"ItemIds\": [\n    \"shield_level_3\",\n    \"shield_level_4\"\n  ]\n}")

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

	req.Header.Add("X-SecretKey", "<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/Server/GrantItemsToUser")
  .header("X-SecretKey", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"PlayFabId\": \"20394883\",\n  \"Annotation\": \"Entered Level 2\",\n  \"ItemIds\": [\n    \"shield_level_3\",\n    \"shield_level_4\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{titleId}.playfabapi.com/Server/GrantItemsToUser")

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

request = Net::HTTP::Post.new(url)
request["X-SecretKey"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"PlayFabId\": \"20394883\",\n  \"Annotation\": \"Entered Level 2\",\n  \"ItemIds\": [\n    \"shield_level_3\",\n    \"shield_level_4\"\n  ]\n}"

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

{
  "code": 200,
  "status": "OK",
  "data": {
    "ItemGrantResults": [
      {
        "PlayFabId": "20394883",
        "Result": true,
        "ItemId": "shield_level_3",
        "ItemInstanceId": "133713371337",
        "ItemClass": "shields",
        "PurchaseDate": "2017-03-07T00:00:00",
        "Expiration": "2018-10-01T00:00:00",
        "RemainingUses": 10,
        "Annotation": "Entered Level 2",
        "CatalogVersion": "5",
        "BundleParent": "crate block 1"
      },
      {
        "PlayFabId": "20394883",
        "Result": true,
        "ItemId": "shield_level_4",
        "ItemInstanceId": "133713371337",
        "ItemClass": "shields",
        "PurchaseDate": "2017-03-07T00:00:00",
        "Expiration": "2018-10-01T00:00:00",
        "RemainingUses": 10,
        "Annotation": "Entered Level 2",
        "CatalogVersion": "5",
        "BundleParent": "crate block 1"
      }
    ]
  }
}

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

Autorisations

X-SecretKey

string

header

requis

This API requires a title secret key, available to title admins, from PlayFab Game Manager.

Corps

application/json

This function directly adds inventory items to the user's inventories. As a result of this operations, the user will not be charged any transaction fee, regardless of the inventory item catalog definition. Please note that the processing time for inventory grants and purchases increases fractionally the more items are in the inventory, and the more items are in the grant/purchase operation.

ItemIds

string[]

requis

Array of itemIds to grant to the user.

PlayFabId

string

requis

Unique PlayFab assigned ID of the user on whom the operation will be performed.

Annotation

string

String detailing any additional information concerning this operation.

CatalogVersion

string

Catalog version from which items are to be granted.

CustomTags

object

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

Réponse

Please note that the order of the items in the response may not match the order of items in the request.

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

Please note that the order of the items in the response may not match the order of items in the request.

Show child attributes

Exemple:

{
  "ItemGrantResults": [
    {
      "PlayFabId": "20394883",
      "Result": true,
      "ItemId": "shield_level_3",
      "ItemInstanceId": "133713371337",
      "ItemClass": "shields",
      "PurchaseDate": "2017-03-07T00:00:00",
      "Expiration": "2018-10-01T00:00:00",
      "RemainingUses": 10,
      "Annotation": "Entered Level 2",
      "CatalogVersion": "5",
      "BundleParent": "crate block 1"
    },
    {
      "PlayFabId": "20394883",
      "Result": true,
      "ItemId": "shield_level_4",
      "ItemInstanceId": "133713371337",
      "ItemClass": "shields",
      "PurchaseDate": "2017-03-07T00:00:00",
      "Expiration": "2018-10-01T00:00:00",
      "RemainingUses": 10,
      "Annotation": "Entered Level 2",
      "CatalogVersion": "5",
      "BundleParent": "crate block 1"
    }
  ]
}

Dernière modification le 6 octobre 2026

Sujets connexes

Accorder des articles aux utilisateurs Accorder un personnage à l'utilisateur Accorder des articles au personnage Déplacer un article de l'utilisateur vers un personnage Déplacer un article d'un personnage vers l'utilisateur

⌘I

Grant Items To User

curl --request POST \
  --url https://{titleId}.playfabapi.com/Server/GrantItemsToUser \
  --header 'Content-Type: application/json' \
  --header 'X-SecretKey: <api-key>' \
  --data '
{
  "PlayFabId": "20394883",
  "Annotation": "Entered Level 2",
  "ItemIds": [
    "shield_level_3",
    "shield_level_4"
  ]
}
'

import requests

url = "https://{titleId}.playfabapi.com/Server/GrantItemsToUser"

payload = {
    "PlayFabId": "20394883",
    "Annotation": "Entered Level 2",
    "ItemIds": ["shield_level_3", "shield_level_4"]
}
headers = {
    "X-SecretKey": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-SecretKey': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    PlayFabId: '20394883',
    Annotation: 'Entered Level 2',
    ItemIds: ['shield_level_3', 'shield_level_4']
  })
};

fetch('https://{titleId}.playfabapi.com/Server/GrantItemsToUser', 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/Server/GrantItemsToUser",
  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([
    'PlayFabId' => '20394883',
    'Annotation' => 'Entered Level 2',
    'ItemIds' => [
        'shield_level_3',
        'shield_level_4'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-SecretKey: <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/Server/GrantItemsToUser"

	payload := strings.NewReader("{\n  \"PlayFabId\": \"20394883\",\n  \"Annotation\": \"Entered Level 2\",\n  \"ItemIds\": [\n    \"shield_level_3\",\n    \"shield_level_4\"\n  ]\n}")

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

	req.Header.Add("X-SecretKey", "<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/Server/GrantItemsToUser")
  .header("X-SecretKey", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"PlayFabId\": \"20394883\",\n  \"Annotation\": \"Entered Level 2\",\n  \"ItemIds\": [\n    \"shield_level_3\",\n    \"shield_level_4\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{titleId}.playfabapi.com/Server/GrantItemsToUser")

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

request = Net::HTTP::Post.new(url)
request["X-SecretKey"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"PlayFabId\": \"20394883\",\n  \"Annotation\": \"Entered Level 2\",\n  \"ItemIds\": [\n    \"shield_level_3\",\n    \"shield_level_4\"\n  ]\n}"

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

{
  "code": 200,
  "status": "OK",
  "data": {
    "ItemGrantResults": [
      {
        "PlayFabId": "20394883",
        "Result": true,
        "ItemId": "shield_level_3",
        "ItemInstanceId": "133713371337",
        "ItemClass": "shields",
        "PurchaseDate": "2017-03-07T00:00:00",
        "Expiration": "2018-10-01T00:00:00",
        "RemainingUses": 10,
        "Annotation": "Entered Level 2",
        "CatalogVersion": "5",
        "BundleParent": "crate block 1"
      },
      {
        "PlayFabId": "20394883",
        "Result": true,
        "ItemId": "shield_level_4",
        "ItemInstanceId": "133713371337",
        "ItemClass": "shields",
        "PurchaseDate": "2017-03-07T00:00:00",
        "Expiration": "2018-10-01T00:00:00",
        "RemainingUses": 10,
        "Annotation": "Entered Level 2",
        "CatalogVersion": "5",
        "BundleParent": "crate block 1"
      }
    ]
  }
}

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

PlayFab API

PlayFab REST API References

Accorder des articles à l'utilisateur

Error codes

Autorisations

Corps

Réponse