Each game has the following properties. Complete details in GameProperties.
The unique id for this game. It will never change.
game.
A date when the game was created.
A date when the game was last updated.
The name the game is known by.
Setting this will also set the shop URI for the game.
A game name like Ninjas: Kill Or Be Killed!!! will generate a URI like ninjas-kill-or-be-killed.
It should also be said that Kill Or Be Killed probably belongs in the short_description field,
unless it is part of the game name.
The unique id of a designer that has control over the game.
A brief text description of the game.
The description field formatted as HTML.
A short phrase to describe the game, like you'd put on a movie poster.
A boolean indicating whether this game has been featured in TGC's featured section yet or not.
The URI for the web site for this specific game, or the product page on the designer's web site for this specific game.
If you could tell a potential buyer just one thing about your game to make them want to buy it, this is the place you'd put that.
If you could tell a potential buyer a second thing about your game to make them want to buy it, this is the place you'd put that.
If you were lucky enough to be able to tell a potential buyer a third reason they should buy your game, this is where you'd put that.
A boolean indicating whether the game is ready to be sold in TGC's shop.
A boolean that indicates whether this game should be displayed in the designer's game library default.
A string that a designer can use to group this game with other games to make it easier to find in their games library.
A date when the game was first made public in TGC's shop.
Usually "First" or "1". Some indication of the version number of the game in case you've made changes.
The minimum age to play the game. See Game Options below for details.
The minimum number of players required to play the game. Default 1. Max 99.
The maximum number of players that can play the game.
Default 99.
Min see min_players.
The average amount of minutes it takes to play the game. See Game Options below for details.
An integer between 1 and 5 representing the average rating of a game across all reviews and ratings.
A believability score for the average_rating based upon the number of ratings it has received compared to other games in the system.
An integer which represents how many 5 star ratings have been made of this game.
An integer which represents how many 4 star ratings have been made of this game.
An integer which represents how many 3 star ratings have been made of this game.
An integer which represents how many 2 star ratings have been made of this game.
An integer which represents how many 1 star ratings have been made of this game.
The manufacturer's suggested retail price of the game as set by the Designer. Must be an integer between 0 and 99. All prices automatically have .99 tacked on to them in the shop.
The minimum cost to produce one copy of the game, based upon all the components it has in it.
The higher of msrp or cost.
A Sku id. The stock keeping unit to be used when adding this to the Cart.
A boolean indicating whether this game is picked as one of the TGC staff's favorites.
A boolean indicating whether this game is marked as a featured product in the shop.
A date indicating when the featured status of the game will expire.
The URI to this game in the TGC shop.
The unique id for this game on Board Game Geek (http://www.boardgamegeek.com).
A File id.
Sets the image used at the top of the shop page.
The ID is from a File.
If a backdrop_id is specified,
then an extra property called backdrop will be added which will briefly describe the image.
A File id.
Sets the image used inline in the shop page.
The ID is from a File.
If a logo_id is specified,
then an extra property called logo will be added which will briefly describe the image.
A File id.
Sets the image used to advertise the game on the site.
The ID is from a File.
If a advertisement_id is specified,
then an extra property called advertisement will be added which will briefly describe the image.
A Review id.
The unique id of the Review that the current user,
as identified by the session_id,
has posted about this game.
If no session_id is specified in the request,
or the user has not posted a review,
then nothing will be listed here.
Deal of the Day
Breakdown of costs.
The Designer that this game is controlled by.
The Review that the current user,
as identified by the session_id,
has posted about this game.
If no session_id is specified in the request,
or the user has not posted a review,
then nothing will be listed here.
Returns the details of the logo image.
Returns the details of the backdrop image.
Returns the details of the advertisement image.
The methods used to fetch and manipulate games.
Provides a list of the options that can be used to fill out various fields when creating or updating a game.
GET /api/game/_options
Returns:
{
"min_age" : [...],
"play_time" : [...],
"audience" : [...],
"game_type" : [...],
"genre" : [...],
"theme" : [...],
"setting" : [...],
"primary_mechanic" : [...],
...
}
NOTE: You can also get this data by adding _include_options=1 to the parameter list when fetching a game.
POST /api/game
Required. The unique session id provided by a Session method.
Required.
Required.
Optional.
Optional.
Optional.
Optional.
Optional.
Optional.
Optional.
Optional.
Optional.
Optional.
Optional.
Optional.
Optional.
Optional.
Optional.
Optional.
Optional.
Optional.
Optional.
Optional.
Optional.
Optional.
Optional.
Returns:
{
"id" : "xxx",
"name" : "Prison Break",
...
}
PUT /api/game/xxx
See Create Game for details.
DELETE /api/game/xxx
Required. The unique session id provided by a Session method.
Returns:
{
"success" : 1
}
GET /api/game/xxx
Optional. The unique session id provided by a Session method.
Optional. See "Options" in Intro and Game Options above for details.
Optional. See "Relationships" in Intro and Game Relationships above for details.
Returns:
{
"id" : "xxx",
"name" : "Prison Break",
...
}
GET /api/game/uri/xxx
Replace xxx with a URI Part for a game from https://www.thegamecrafter.com/games/uri-part-goes-here and then this will return a game the same as "Fetch Game" above.
POST /api/game/xxx/review
Adds or updates a Review for this game by the current User.
Required.
Optional. See Review for details.
Optional. See Review for details.
POST /api/game/xxx/copy
Required.
Returns:
{
"wing_object_type" : "game",
"id" : "xxx",
"name" : "Jail Break (Copy)",
...
}
POST /api/game/xxx/public
Required.
DELETE /api/game/xxx/public
Required.
See Search.
GET /api/game/xxx/bulk-pricing
Returns the pricing the user can expect when buying lots of copies of their own game.
{
"id" : "xxx",
"name" : "Prison Break",
"msrp" : "24.99",
"prices" : [
{ "units" : 1, "price" : "19.00" },
{ "units" : 10, "price" : "18.00" },
{ "units" : 20, "price" : "17.00" },
{ "units" : 30, "price" : "16.00" },
{ "units" : 40, "price" : "15.00" },
{ "units" : 50, "price" : "14.00" },
{ "units" : 60, "price" : "13.00" },
{ "units" : 70, "price" : "12.00" },
{ "units" : 80, "price" : "12.00" },
{ "units" : 90, "price" : "10.00" },
{ "units" : 100, "price" : "9.00" },
]
}
GET /api/game/xxx/gameledgerentries
Returns an array with a breakdown of the game's costs:
{
[
{
"name" : "PokerDeck",
"price1" : "0.89",
"weight" : 0.02,
"surfacing" : 1,
"sheets_used" : 1,
"slugs_used" : 0,
"count" : 1,
"group" : "Decks",
}
...
]
}