Trading - Get Player Trades
Gets all trades the player has either opened or accepted, optionally filtered by trade status.
POST https://titleId.playfabapi.com/Client/GetPlayerTradesRequest Header
| Name | Required | Type | Description |
|---|---|---|---|
| X-Authorization | True |
string |
This API requires a client session ticket, available from any Client Login function. |
Request Body
| Name | Type | Description |
|---|---|---|
| StatusFilter |
Returns only trades with the given status. If null, returns all trades. |
Responses
| Name | Type | Description |
|---|---|---|
| 200 OK | ||
| 400 Bad Request |
This is the outer wrapper for all responses with errors |
Security
X-Authorization
This API requires a client session ticket, available from any Client Login function.
Type:
apiKey
In:
header
Definitions
| Name | Description |
|---|---|
|
Api |
The basic wrapper around every failed API response |
|
Get |
|
|
Get |
|
|
Trade |
|
|
Trade |
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 |
GetPlayerTradesRequest
| Name | Type | Description |
|---|---|---|
| StatusFilter |
Returns only trades with the given status. If null, returns all trades. |
GetPlayerTradesResponse
| Name | Type | Description |
|---|---|---|
| AcceptedTrades |
History of trades which this player has accepted. |
|
| OpenedTrades |
The trades for this player which are currently available to be accepted. |
TradeInfo
| Name | Type | Description |
|---|---|---|
| AcceptedInventoryInstanceIds |
string[] |
Item instances from the accepting player that are used to fulfill the trade. If null, no one has accepted the trade. |
| AcceptedPlayerId |
string |
The PlayFab ID of the player who accepted the trade. If null, no one has accepted the trade. |
| AllowedPlayerIds |
string[] |
An optional list of players allowed to complete this trade. If null, anybody can complete the trade. |
| CancelledAt |
string |
If set, The UTC time when this trade was canceled. |
| FilledAt |
string |
If set, The UTC time when this trade was fulfilled. |
| InvalidatedAt |
string |
If set, The UTC time when this trade was made invalid. |
| OfferedCatalogItemIds |
string[] |
The catalogItem Ids of the item instances being offered. |
| OfferedInventoryInstanceIds |
string[] |
The itemInstance Ids that are being offered. |
| OfferingPlayerId |
string |
The PlayFabId for the offering player. |
| OpenedAt |
string |
The UTC time when this trade was created. |
| RequestedCatalogItemIds |
string[] |
The catalogItem Ids requested in exchange. |
| Status |
Describes the current state of this trade. |
|
| TradeId |
string |
The identifier for this trade. |
TradeStatus
| Name | Type | Description |
|---|---|---|
| Accepted |
string |
|
| Accepting |
string |
|
| Cancelled |
string |
|
| Filled |
string |
|
| Invalid |
string |
|
| Open |
string |
|
| Opening |
string |