Documentation

GetTradeStatus

Gets the current status of an existing trade.

Request Details

GetTradeStatusRequest
Request Properties
OfferingPlayerId (required) String

Player who opened trade.

TradeId (required) String

Trade identifier as returned by OpenTradeOffer.

POST https://{{TitleID}}.playfabapi.com/Client/GetTradeStatus
    Content-Type: application/json
    X-Authentication: <user_session_ticket_value>
{
  "OfferingPlayerId": "CD803BF233CE76CC",
  "TradeId": "D819CEC225EA9948C351"
}
        

Response Details

GetTradeStatusResponse
Result Properties
Trade TradeInfo

Information about the requested trade.

Sample Response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
  "code": 200,
  "status": "OK",
  "data": {
    "Trade": {
      "Status": "Open",
      "TradeId": "D819CEC225EA9948C351",
      "OfferingPlayerId": "CD803BF233CE76CC",
      "OfferedInventoryInstanceIds": [
        "1359447",
        "635691"
      ],
      "RequestedCatalogItemIds": [
        "rare_hat_7"
      ],
      "OpenedAt": "2015-04-07T09:04:28Z"
    }
  }
}

Authentication

SessionTicket

Possible Error Codes

Name Code
TradeDoesNotExist 1161