Url: https://api.playkey.net/rest/PlaykeyAPI.svc/gameshipments/all/catalog-category
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 cover_type - Game cover images 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": 2005313302, "ga_clientId": "gaclientid", "token": "token", "filter_name": "filtername", "filter_categories_and_genres": [ "filtercategoriesandgenres", "filtercategoriesandgenres" ], "offset": 1026735120, "limit": 123899487, "filter_input_devices": null, "filter_codes": [ "filtercodes", "filtercodes" ], "filter_game_shipments_any_type": "filtergameshipmentsanytype", "ignore_categories": [ "ignorecategorycodes", "ignorecategorycodes" ], "ignore_platforms": [ "ignoreplatformcodes", "ignoreplatformcodes" ], "cover_type": "covertype" }
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 for main catalog category [ title - Game title cover - Game cover images category_codes - Categories Empty - [ ] preview - List of trailers link code - Game code status - Status of the game is_preorder - Is game preorder platforms - Supported gaming platform Empty - [ ] ]
The following is an example response Json body:
{ "error": { "code": 0, "message": "string" }, "game_shipments_any": [ { "title": "string", "cover": "string", "category_codes": [ "", "" ], "preview": "string", "code": "string", "status": "string", "is_preorder": true, "platforms": [ "", "" ] }, { "title": "string", "cover": "string", "category_codes": [ "", "" ], "preview": "string", "code": "string", "status": "string", "is_preorder": true, "platforms": [ "", "" ] } ] }
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> <title>string</title> <cover>string</cover> <category_codes xmlns:a="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <a:string /> <a:string /> </category_codes> <preview>string</preview> <code>string</code> <status>string</status> <is_preorder>true</is_preorder> <platforms xmlns:a="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <a:string /> <a:string /> </platforms> </game_shipment_any> <game_shipment_any> <title>string</title> <cover>string</cover> <category_codes xmlns:a="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <a:string /> <a:string /> </category_codes> <preview>string</preview> <code>string</code> <status>string</status> <is_preorder>true</is_preorder> <platforms xmlns:a="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <a:string /> <a:string /> </platforms> </game_shipment_any> </game_shipments_any> </result>