Url: https://api.playkey.net/rest/PlaykeyAPI.svc/gameshipments/all/auth
HTTP Method: POST
The following is an description request Json body:
lang - Display language api_version - API version (default equal 1) ga_clientId - Google Analytics ID token - Authentication token (optional) filter_name - Filter by name filter_categories_and_genres - Filter by categories and genres Empty - [ ] offset - Initial item number in response limit - Max count items in response filter_input_devices - Filter by input devices filter_codes - Filter by codes Empty - [ ] filter_game_shipments_any_type - Filter by game shipments any type ignore_categories - Ignore category codes for games Empty - [ ] ignore_platforms - Ignore platform codes for games Empty - [ ]
The following is an example request Json body:
{ "lang": "lang", "api_version": 163799633, "ga_clientId": "gaclientid", "token": "token", "filter_name": "filtername", "filter_categories_and_genres": [ "filtercategoriesandgenres", "filtercategoriesandgenres" ], "offset": 1559653140, "limit": 798389021, "filter_input_devices": "filterinputdevicesserialized", "filter_codes": [ "filtercodes", "filtercodes" ], "filter_game_shipments_any_type": "filtergameshipmentsanytype", "ignore_categories": [ "ignorecategorycodes", "ignorecategorycodes" ], "ignore_platforms": [ "ignoreplatformcodes", "ignoreplatformcodes" ] }
Description of how to response:
error - Error information code - Error code. Error 0 - no error message - Error message. Empty if none game_shipments_any - Information on any game shipments game_shipment_any - Information on any game shipments [ code - Game code title - Game title description - Game description year - Year of release plot_outline - Game teaser tag_line - Tags writer - Publisher in Russia premiered - Release date top250 - Position in TOP-250 rating - Rating votes - Number of votes mpaa - International MPAA rating demo_time - Free time rightholder - Rightsholder content - Content link - Link info [ type - Type links - Link Empty - [ ] ] genres - Genres genre - Genre info [ code - Code name - Title is_main - Is main game genre metadata - Genre metadata keywords - Keywords description - Description ] products - Products including the game product - Product information [ code - Code name - Title ] count_players - Number of players input_devices - Game input devices input_device - Input devices info [ code - Code name - Title ] categories - Categories caregories - Categories [ code - Code name - Title type - Type metadata - Category metadata keywords - Keywords description - Description ] metadata - Game metadata keywords - Keywords description - Description buy - Purchase a license key for the game buy - Information about buying the game [ id_game_shipment - ID buy games cost - Cost is_sale - The game is on sale price - Selling price currency - Currency code is_preorder - Is game preorder discount - Discount info ] run - Run game parameters run - Run game configuration [ name - Configuration name code - Configuration code priority - Priority number parameters - Run game parameters run - Run game configuration [ parameter - Parameter name value - Parameter value ] ] game_platforms - Supported gaming platforms. Property is obsolete: Use game_platform. - [ ] game_platform - Supported gaming platform platform_code - Platform code game_status - Status of the game child_game - Child game info child_games - Child game info - Information on child game [ code - Game code game_status_code - Status of the game run - Run game parameters run - Run game configuration [ name - Configuration name code - Configuration code priority - Priority number parameters - Run game parameters run - Run game configuration [ parameter - Parameter name value - Parameter value ] ] game_platforms - Supported gaming platforms. Property is obsolete: Use game_platform. - [ ] game_platform - Supported gaming platform platform_code - Platform code card_info - Information about game launches for game card ] available_in_regions - Game platforms info Empty - [ ] game_shipment_any_type - Type of game shipment is_dlc_available_without_game - Is dlc available without game main_game_code - Game code main_game_title - Game title bundles - Bundle codes, which contains this product shipment Empty - [ ] card_info - Information about game launches for game card ]
The following is an example response Json body:
{ "error": { "code": 0, "message": "string" }, "game_shipments_any": [ { "code": "string", "title": "string", "description": "string", "year": 1208281249, "plot_outline": "string", "tag_line": "string", "writer": "string", "premiered": "\/Date(1677155147129)\/", "top250": 1204942348, "rating": 2097241075, "votes": 462219987, "mpaa": "string", "demo_time": 55247044, "rightholder": "string", "content": [ { "type": "string", "links": [ "", "" ] }, { "type": "string", "links": [ "", "" ] } ], "genres": [ { "code": "string", "name": "string", "is_main": true, "metadata": { "keywords": "string", "description": "string" } }, { "code": "string", "name": "string", "is_main": true, "metadata": { "keywords": "string", "description": "string" } } ], "products": [ { "code": "string", "name": "string" }, { "code": "string", "name": "string" } ], "count_players": 0, "input_devices": [ { "code": "string", "name": "string" }, { "code": "string", "name": "string" } ], "categories": [ { "code": "string", "name": "string", "type": "string", "metadata": { "keywords": "string", "description": "string" } }, { "code": "string", "name": "string", "type": "string", "metadata": { "keywords": "string", "description": "string" } } ], "metadata": { "keywords": "string", "description": "string" }, "buy": [ { "id_game_shipment": 1208281249, "cost": 1660129678, "is_sale": true, "price": 1204942348, "currency": "string", "is_preorder": true, "discount": { "code": "string", "active_from": "01-01-0001 00:00:00", "active_to": "01-01-0001 00:00:00" } }, { "id_game_shipment": 1208281249, "cost": 1660129678, "is_sale": true, "price": 1204942348, "currency": "string", "is_preorder": true, "discount": { "code": "string", "active_from": "01-01-0001 00:00:00", "active_to": "01-01-0001 00:00:00" } } ], "run": [ { "name": "string", "code": "string", "priority": 1208281249, "parameters": [ { "parameter": "string", "value": "string" }, { "parameter": "string", "value": "string" } ] }, { "name": "string", "code": "string", "priority": 1208281249, "parameters": [ { "parameter": "string", "value": "string" }, { "parameter": "string", "value": "string" } ] } ], "game_platforms": [ { }, { } ], "game_platform": { }, "platform_code": "string", "game_status": "string", "child_game": { "code": "string", "game_status_code": "string", "run": [ { "name": "string", "code": "string", "priority": 1208281249, "parameters": [ { "parameter": "string", "value": "string" }, { "parameter": "string", "value": "string" } ] }, { "name": "string", "code": "string", "priority": 1208281249, "parameters": [ { "parameter": "string", "value": "string" }, { "parameter": "string", "value": "string" } ] } ], "game_platforms": [ { }, { } ], "game_platform": { }, "platform_code": "string", "card_info": { "game_card_type": "string", "has_play_attempt": true } }, "child_games": [ { "code": "string", "game_status_code": "string", "run": [ { "name": "string", "code": "string", "priority": 1208281249, "parameters": [ { "parameter": "string", "value": "string" }, { "parameter": "string", "value": "string" } ] }, { "name": "string", "code": "string", "priority": 1208281249, "parameters": [ { "parameter": "string", "value": "string" }, { "parameter": "string", "value": "string" } ] } ], "game_platforms": [ { }, { } ], "game_platform": { }, "platform_code": "string", "card_info": { "game_card_type": "string", "has_play_attempt": true } }, { "code": "string", "game_status_code": "string", "run": [ { "name": "string", "code": "string", "priority": 1208281249, "parameters": [ { "parameter": "string", "value": "string" }, { "parameter": "string", "value": "string" } ] }, { "name": "string", "code": "string", "priority": 1208281249, "parameters": [ { "parameter": "string", "value": "string" }, { "parameter": "string", "value": "string" } ] } ], "game_platforms": [ { }, { } ], "game_platform": { }, "platform_code": "string", "card_info": { "game_card_type": "string", "has_play_attempt": true } } ], "available_in_regions": [ "", "" ], "game_shipment_any_type": "string", "is_dlc_available_without_game": true, "main_game_code": "string", "main_game_title": "string", "bundles": [ "", "" ], "card_info": { "game_card_type": "string", "has_play_attempt": true } }, { "code": "string", "title": "string", "description": "string", "year": 1208281249, "plot_outline": "string", "tag_line": "string", "writer": "string", "premiered": "\/Date(1677155147129)\/", "top250": 1204942348, "rating": 2097241075, "votes": 462219987, "mpaa": "string", "demo_time": 55247044, "rightholder": "string", "content": [ { "type": "string", "links": [ "", "" ] }, { "type": "string", "links": [ "", "" ] } ], "genres": [ { "code": "string", "name": "string", "is_main": true, "metadata": { "keywords": "string", "description": "string" } }, { "code": "string", "name": "string", "is_main": true, "metadata": { "keywords": "string", "description": "string" } } ], "products": [ { "code": "string", "name": "string" }, { "code": "string", "name": "string" } ], "count_players": 0, "input_devices": [ { "code": "string", "name": "string" }, { "code": "string", "name": "string" } ], "categories": [ { "code": "string", "name": "string", "type": "string", "metadata": { "keywords": "string", "description": "string" } }, { "code": "string", "name": "string", "type": "string", "metadata": { "keywords": "string", "description": "string" } } ], "metadata": { "keywords": "string", "description": "string" }, "buy": [ { "id_game_shipment": 1208281249, "cost": 1660129678, "is_sale": true, "price": 1204942348, "currency": "string", "is_preorder": true, "discount": { "code": "string", "active_from": "01-01-0001 00:00:00", "active_to": "01-01-0001 00:00:00" } }, { "id_game_shipment": 1208281249, "cost": 1660129678, "is_sale": true, "price": 1204942348, "currency": "string", "is_preorder": true, "discount": { "code": "string", "active_from": "01-01-0001 00:00:00", "active_to": "01-01-0001 00:00:00" } } ], "run": [ { "name": "string", "code": "string", "priority": 1208281249, "parameters": [ { "parameter": "string", "value": "string" }, { "parameter": "string", "value": "string" } ] }, { "name": "string", "code": "string", "priority": 1208281249, "parameters": [ { "parameter": "string", "value": "string" }, { "parameter": "string", "value": "string" } ] } ], "game_platforms": [ { }, { } ], "game_platform": { }, "platform_code": "string", "game_status": "string", "child_game": { "code": "string", "game_status_code": "string", "run": [ { "name": "string", "code": "string", "priority": 1208281249, "parameters": [ { "parameter": "string", "value": "string" }, { "parameter": "string", "value": "string" } ] }, { "name": "string", "code": "string", "priority": 1208281249, "parameters": [ { "parameter": "string", "value": "string" }, { "parameter": "string", "value": "string" } ] } ], "game_platforms": [ { }, { } ], "game_platform": { }, "platform_code": "string", "card_info": { "game_card_type": "string", "has_play_attempt": true } }, "child_games": [ { "code": "string", "game_status_code": "string", "run": [ { "name": "string", "code": "string", "priority": 1978809177, "parameters": [ { "parameter": "string", "value": "string" }, { "parameter": "string", "value": "string" } ] }, { "name": "string", "code": "string", "priority": 1978809177, "parameters": [ { "parameter": "string", "value": "string" }, { "parameter": "string", "value": "string" } ] } ], "game_platforms": [ { }, { } ], "game_platform": { }, "platform_code": "string", "card_info": { "game_card_type": "string", "has_play_attempt": true } }, { "code": "string", "game_status_code": "string", "run": [ { "name": "string", "code": "string", "priority": 1978809177, "parameters": [ { "parameter": "string", "value": "string" }, { "parameter": "string", "value": "string" } ] }, { "name": "string", "code": "string", "priority": 1978809177, "parameters": [ { "parameter": "string", "value": "string" }, { "parameter": "string", "value": "string" } ] } ], "game_platforms": [ { }, { } ], "game_platform": { }, "platform_code": "string", "card_info": { "game_card_type": "string", "has_play_attempt": true } } ], "available_in_regions": [ "", "" ], "game_shipment_any_type": "string", "is_dlc_available_without_game": true, "main_game_code": "string", "main_game_title": "string", "bundles": [ "", "" ], "card_info": { "game_card_type": "string", "has_play_attempt": true } } ] }
The following is an example response Xml body:
<result xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <error> <code>0</code> <message>string</message> </error> <game_shipments_any> <game_shipment_any> <code>string</code> <title>string</title> <description>string</description> <year>1978809177</year> <plot_outline>string</plot_outline> <tag_line>string</tag_line> <writer>string</writer> <premiered>2023-09-23T12:25:47.1455165Z</premiered> <top250>1599666695</top250> <rating>841149735</rating> <votes>942766346</votes> <mpaa>string</mpaa> <demo_time>17375970</demo_time> <rightholder>string</rightholder> <content> <link> <type>string</type> <links xmlns:a="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <a:string /> <a:string /> </links> </link> <link> <type>string</type> <links xmlns:a="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <a:string /> <a:string /> </links> </link> </content> <genres> <genre> <code>string</code> <name>string</name> <is_main>true</is_main> <metadata> <keywords>string</keywords> <description>string</description> </metadata> </genre> <genre> <code>string</code> <name>string</name> <is_main>true</is_main> <metadata> <keywords>string</keywords> <description>string</description> </metadata> </genre> </genres> <products> <product> <code>string</code> <name>string</name> </product> <product> <code>string</code> <name>string</name> </product> </products> <count_players>0</count_players> <input_devices> <input_device> <code>string</code> <name>string</name> </input_device> <input_device> <code>string</code> <name>string</name> </input_device> </input_devices> <categories> <caregories> <code>string</code> <name>string</name> <type>string</type> <metadata> <keywords>string</keywords> <description>string</description> </metadata> </caregories> <caregories> <code>string</code> <name>string</name> <type>string</type> <metadata> <keywords>string</keywords> <description>string</description> </metadata> </caregories> </categories> <metadata> <keywords>string</keywords> <description>string</description> </metadata> <buy> <buy> <id_game_shipment>1978809177</id_game_shipment> <cost>1004498371</cost> <is_sale>true</is_sale> <price>1599666695</price> <currency>string</currency> <is_preorder>true</is_preorder> <discount> <code>string</code> <active_from>01-01-0001 00:00:00</active_from> <active_to>01-01-0001 00:00:00</active_to> </discount> </buy> <buy> <id_game_shipment>1978809177</id_game_shipment> <cost>1004498371</cost> <is_sale>true</is_sale> <price>1599666695</price> <currency>string</currency> <is_preorder>true</is_preorder> <discount> <code>string</code> <active_from>01-01-0001 00:00:00</active_from> <active_to>01-01-0001 00:00:00</active_to> </discount> </buy> </buy> <run> <run> <name>string</name> <code>string</code> <priority>1978809177</priority> <parameters> <run> <parameter>string</parameter> <value>string</value> </run> <run> <parameter>string</parameter> <value>string</value> </run> </parameters> </run> <run> <name>string</name> <code>string</code> <priority>1978809177</priority> <parameters> <run> <parameter>string</parameter> <value>string</value> </run> <run> <parameter>string</parameter> <value>string</value> </run> </parameters> </run> </run> <game_platforms> <GamePlatformParametersInfo /> <GamePlatformParametersInfo /> </game_platforms> <game_platform /> <platform_code>string</platform_code> <game_status>string</game_status> <child_game> <code>string</code> <game_status_code>string</game_status_code> <run> <run> <name>string</name> <code>string</code> <priority>1978809177</priority> <parameters> <run> <parameter>string</parameter> <value>string</value> </run> <run> <parameter>string</parameter> <value>string</value> </run> </parameters> </run> <run> <name>string</name> <code>string</code> <priority>1978809177</priority> <parameters> <run> <parameter>string</parameter> <value>string</value> </run> <run> <parameter>string</parameter> <value>string</value> </run> </parameters> </run> </run> <game_platforms> <GamePlatformParametersInfo /> <GamePlatformParametersInfo /> </game_platforms> <game_platform /> <platform_code>string</platform_code> <card_info> <game_card_type>string</game_card_type> <has_play_attempt>true</has_play_attempt> </card_info> </child_game> <child_games> <ChildGameResultInfo> <code>string</code> <game_status_code>string</game_status_code> <run> <run> <name>string</name> <code>string</code> <priority>1978809177</priority> <parameters> <run> <parameter>string</parameter> <value>string</value> </run> <run> <parameter>string</parameter> <value>string</value> </run> </parameters> </run> <run> <name>string</name> <code>string</code> <priority>1978809177</priority> <parameters> <run> <parameter>string</parameter> <value>string</value> </run> <run> <parameter>string</parameter> <value>string</value> </run> </parameters> </run> </run> <game_platforms> <GamePlatformParametersInfo /> <GamePlatformParametersInfo /> </game_platforms> <game_platform /> <platform_code>string</platform_code> <card_info> <game_card_type>string</game_card_type> <has_play_attempt>true</has_play_attempt> </card_info> </ChildGameResultInfo> <ChildGameResultInfo> <code>string</code> <game_status_code>string</game_status_code> <run> <run> <name>string</name> <code>string</code> <priority>1978809177</priority> <parameters> <run> <parameter>string</parameter> <value>string</value> </run> <run> <parameter>string</parameter> <value>string</value> </run> </parameters> </run> <run> <name>string</name> <code>string</code> <priority>1978809177</priority> <parameters> <run> <parameter>string</parameter> <value>string</value> </run> <run> <parameter>string</parameter> <value>string</value> </run> </parameters> </run> </run> <game_platforms> <GamePlatformParametersInfo /> <GamePlatformParametersInfo /> </game_platforms> <game_platform /> <platform_code>string</platform_code> <card_info> <game_card_type>string</game_card_type> <has_play_attempt>true</has_play_attempt> </card_info> </ChildGameResultInfo> </child_games> <available_in_regions xmlns:a="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <a:string /> <a:string /> </available_in_regions> <game_shipment_any_type>string</game_shipment_any_type> <is_dlc_available_without_game>true</is_dlc_available_without_game> <main_game_code>string</main_game_code> <main_game_title>string</main_game_title> <bundles xmlns:a="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <a:string /> <a:string /> </bundles> <card_info> <game_card_type>string</game_card_type> <has_play_attempt>true</has_play_attempt> </card_info> </game_shipment_any> <game_shipment_any> <code>string</code> <title>string</title> <description>string</description> <year>1978809177</year> <plot_outline>string</plot_outline> <tag_line>string</tag_line> <writer>string</writer> <premiered>2023-09-23T12:25:47.1455165Z</premiered> <top250>1599666695</top250> <rating>841149735</rating> <votes>942766346</votes> <mpaa>string</mpaa> <demo_time>17375970</demo_time> <rightholder>string</rightholder> <content> <link> <type>string</type> <links xmlns:a="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <a:string /> <a:string /> </links> </link> <link> <type>string</type> <links xmlns:a="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <a:string /> <a:string /> </links> </link> </content> <genres> <genre> <code>string</code> <name>string</name> <is_main>true</is_main> <metadata> <keywords>string</keywords> <description>string</description> </metadata> </genre> <genre> <code>string</code> <name>string</name> <is_main>true</is_main> <metadata> <keywords>string</keywords> <description>string</description> </metadata> </genre> </genres> <products> <product> <code>string</code> <name>string</name> </product> <product> <code>string</code> <name>string</name> </product> </products> <count_players>0</count_players> <input_devices> <input_device> <code>string</code> <name>string</name> </input_device> <input_device> <code>string</code> <name>string</name> </input_device> </input_devices> <categories> <caregories> <code>string</code> <name>string</name> <type>string</type> <metadata> <keywords>string</keywords> <description>string</description> </metadata> </caregories> <caregories> <code>string</code> <name>string</name> <type>string</type> <metadata> <keywords>string</keywords> <description>string</description> </metadata> </caregories> </categories> <metadata> <keywords>string</keywords> <description>string</description> </metadata> <buy> <buy> <id_game_shipment>1978809177</id_game_shipment> <cost>1004498371</cost> <is_sale>true</is_sale> <price>1599666695</price> <currency>string</currency> <is_preorder>true</is_preorder> <discount> <code>string</code> <active_from>01-01-0001 00:00:00</active_from> <active_to>01-01-0001 00:00:00</active_to> </discount> </buy> <buy> <id_game_shipment>1978809177</id_game_shipment> <cost>1004498371</cost> <is_sale>true</is_sale> <price>1599666695</price> <currency>string</currency> <is_preorder>true</is_preorder> <discount> <code>string</code> <active_from>01-01-0001 00:00:00</active_from> <active_to>01-01-0001 00:00:00</active_to> </discount> </buy> </buy> <run> <run> <name>string</name> <code>string</code> <priority>1978809177</priority> <parameters> <run> <parameter>string</parameter> <value>string</value> </run> <run> <parameter>string</parameter> <value>string</value> </run> </parameters> </run> <run> <name>string</name> <code>string</code> <priority>1978809177</priority> <parameters> <run> <parameter>string</parameter> <value>string</value> </run> <run> <parameter>string</parameter> <value>string</value> </run> </parameters> </run> </run> <game_platforms> <GamePlatformParametersInfo /> <GamePlatformParametersInfo /> </game_platforms> <game_platform /> <platform_code>string</platform_code> <game_status>string</game_status> <child_game> <code>string</code> <game_status_code>string</game_status_code> <run> <run> <name>string</name> <code>string</code> <priority>1978809177</priority> <parameters> <run> <parameter>string</parameter> <value>string</value> </run> <run> <parameter>string</parameter> <value>string</value> </run> </parameters> </run> <run> <name>string</name> <code>string</code> <priority>1978809177</priority> <parameters> <run> <parameter>string</parameter> <value>string</value> </run> <run> <parameter>string</parameter> <value>string</value> </run> </parameters> </run> </run> <game_platforms> <GamePlatformParametersInfo /> <GamePlatformParametersInfo /> </game_platforms> <game_platform /> <platform_code>string</platform_code> <card_info> <game_card_type>string</game_card_type> <has_play_attempt>true</has_play_attempt> </card_info> </child_game> <child_games> <ChildGameResultInfo> <code>string</code> <game_status_code>string</game_status_code> <run> <run> <name>string</name> <code>string</code> <priority>1978809177</priority> <parameters> <run> <parameter>string</parameter> <value>string</value> </run> <run> <parameter>string</parameter> <value>string</value> </run> </parameters> </run> <run> <name>string</name> <code>string</code> <priority>1978809177</priority> <parameters> <run> <parameter>string</parameter> <value>string</value> </run> <run> <parameter>string</parameter> <value>string</value> </run> </parameters> </run> </run> <game_platforms> <GamePlatformParametersInfo /> <GamePlatformParametersInfo /> </game_platforms> <game_platform /> <platform_code>string</platform_code> <card_info> <game_card_type>string</game_card_type> <has_play_attempt>true</has_play_attempt> </card_info> </ChildGameResultInfo> <ChildGameResultInfo> <code>string</code> <game_status_code>string</game_status_code> <run> <run> <name>string</name> <code>string</code> <priority>1978809177</priority> <parameters> <run> <parameter>string</parameter> <value>string</value> </run> <run> <parameter>string</parameter> <value>string</value> </run> </parameters> </run> <run> <name>string</name> <code>string</code> <priority>1978809177</priority> <parameters> <run> <parameter>string</parameter> <value>string</value> </run> <run> <parameter>string</parameter> <value>string</value> </run> </parameters> </run> </run> <game_platforms> <GamePlatformParametersInfo /> <GamePlatformParametersInfo /> </game_platforms> <game_platform /> <platform_code>string</platform_code> <card_info> <game_card_type>string</game_card_type> <has_play_attempt>true</has_play_attempt> </card_info> </ChildGameResultInfo> </child_games> <available_in_regions xmlns:a="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <a:string /> <a:string /> </available_in_regions> <game_shipment_any_type>string</game_shipment_any_type> <is_dlc_available_without_game>true</is_dlc_available_without_game> <main_game_code>string</main_game_code> <main_game_title>string</main_game_title> <bundles xmlns:a="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <a:string /> <a:string /> </bundles> <card_info> <game_card_type>string</game_card_type> <has_play_attempt>true</has_play_attempt> </card_info> </game_shipment_any> </game_shipments_any> </result>