Game Properties

Each game has the following properties. Complete details in GameProperties.

id

The unique id for this game. It will never change.

wing_object_type

game.

date_created

A date when the game was created.

date_updated

A date when the game was last updated.

name

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.

designer_id

The unique id of a designer that has control over the game.

description

A brief text description of the game.

description_html

The description field formatted as HTML.

short_description

A short phrase to describe the game, like you'd put on a movie poster.

has_promoed_featured

A boolean indicating whether this game has been featured in TGC's featured section yet or not.

website_uri

The URI for the web site for this specific game, or the product page on the designer's web site for this specific game.

cool_factor_1

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.

cool_factor_2

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.

cool_factor_3

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.

public

A boolean indicating whether the game is ready to be sold in TGC's shop.

archived

A boolean that indicates whether this game should be displayed in the designer's game library default.

collection

A string that a designer can use to group this game with other games to make it easier to find in their games library.

date_published

A date when the game was first made public in TGC's shop.

edition

Usually "First" or "1". Some indication of the version number of the game in case you've made changes.

min_age

The minimum age to play the game. See Game Options below for details.

min_players

The minimum number of players required to play the game. Default 1. Max 99.

max_players

The maximum number of players that can play the game. Default 99. Min see min_players.

play_time

The average amount of minutes it takes to play the game. See Game Options below for details.

average_rating

An integer between 1 and 5 representing the average rating of a game across all reviews and ratings.

bayesian_ranking

A believability score for the average_rating based upon the number of ratings it has received compared to other games in the system.

ratings_at_5

An integer which represents how many 5 star ratings have been made of this game.

ratings_at_4

An integer which represents how many 4 star ratings have been made of this game.

ratings_at_3

An integer which represents how many 3 star ratings have been made of this game.

ratings_at_2

An integer which represents how many 2 star ratings have been made of this game.

ratings_at_1

An integer which represents how many 1 star ratings have been made of this game.

msrp

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.

cost

The minimum cost to produce one copy of the game, based upon all the components it has in it.

price

The higher of msrp or cost.

sku_id

A Sku id. The stock keeping unit to be used when adding this to the Cart.

staff_pick

A boolean indicating whether this game is picked as one of the TGC staff's favorites.

featured

A boolean indicating whether this game is marked as a featured product in the shop.

featured_expires

A date indicating when the featured status of the game will expire.

shop_uri

The URI to this game in the TGC shop.

bgg_id

The unique id for this game on Board Game Geek (http://www.boardgamegeek.com).

backdrop_id

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.

logo_id

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.

advertisement_id

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.

my_review_id

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.

Game Relationships

gametags
dotds

Deal of the Day

gameledgerentries

Breakdown of costs.

games_related_to_this_game
games_this_game_is_related_to
arttests

ArtTest

customwoodd6s

CustomWoodD6

customcolord6s

CustomColorD6

customcolord4s

CustomColorD4

customcolord8s

CustomColorD8

customprintedmeeples

CustomPrintedMeeple

acrylicshapes

AcrylicShape

sanitytests
bofgames
gameparts

GamePart

embeddedgames
embeddedin
perfectboundbooks

PerfectBoundBook

coilbooks

CoilBook

decks

Deck

onesidedglosses

OneSidedGloss

twosideds

TwoSided

onesideds

OneSided

dials

Dial

documents

Document

actionshots

ActionShot

downloads

GameDownload

owners
reviews

GameOwner

accolades
tuckboxes

TuckBox

hookboxes

HookBox

twosidedboxes

TwoSidedBox

boxfaces

BoxFace

boxtops

BoxTop

twosidedboxglosses

TwoSidedBoxGloss

boxtopglosses

BoxTopGloss

twosidedsluggeds

TwoSidedSlugged

onesidedsluggeds

OneSidedSlugged

customcuttwosidedsluggeds

CustomCutTwoSidedSlugged

customcutonesidedsluggeds

CustomCutOneSidedSlugged

booklets

Booklet

scorepads

ScorePad

crowdsale_game1
crowdsale_game2
crowdsale_game3
contestentries
images

Related Objects

designer

The Designer that this game is controlled by.

my_review

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.

logo

Returns the details of the logo image.

backdrop

Returns the details of the backdrop image.

advertisement

Returns the details of the advertisement image.

sku

Sku

Game Methods

The methods used to fetch and manipulate games.

Game Options

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.

Create Game

 POST /api/game
session_id

Required. The unique session id provided by a Session method.

name

Required.

designer_id

Required.

description

Optional.

short_description

Optional.

website_uri

Optional.

cool_factor_1

Optional.

cool_factor_2

Optional.

cool_factor_3

Optional.

edition

Optional.

min_age

Optional.

play_time

Optional.

min_players

Optional.

max_players

Optional.

play_time

Optional.

genre

Optional.

theme

Optional.

setting

Optional.

game_type

Optional.

audience

Optional.

primary_mechanic

Optional.

msrp

Optional.

bgg_id

Optional.

backdrop_id

Optional.

advertisement_id

Optional.

logo_id

Optional.

Returns:

 {
   "id" : "xxx",
   "name" : "Prison Break",
   ...
 }

Update Game

 PUT /api/game/xxx

See Create Game for details.

Delete Game

 DELETE /api/game/xxx
session_id

Required. The unique session id provided by a Session method.

Returns:

 {
   "success" : 1
 }

Fetch Game

 GET /api/game/xxx
session_id

Optional. The unique session id provided by a Session method.

_include_options

Optional. See "Options" in Intro and Game Options above for details.

_include_relationships

Optional. See "Relationships" in Intro and Game Relationships above for details.

Returns:

 {
   "id" : "xxx",
   "name" : "Prison Break",
   ...
 }

Fetch Game By URI Part

 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.

Add/Update Review

 POST /api/game/xxx/review

Adds or updates a Review for this game by the current User.

session_id

Required.

rating

Optional. See Review for details.

review

Optional. See Review for details.

Copy Game

 POST /api/game/xxx/copy
session_id

Required.

Returns:

 {
    "wing_object_type" : "game",
    "id" : "xxx",
    "name" : "Jail Break (Copy)",
    ...
 }

Publish Game

 POST /api/game/xxx/public
session_id

Required.

Unpublish Game

 DELETE /api/game/xxx/public
session_id

Required.

Search All Games

See Search.

Bulk Pricing

 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" },
    ]
 }

Cost Breakdown

 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",
        }
        ...
    ]
 }
^ Back to Top ^