Request Details

Method Controller Resource Parameters
GET platform categories ebaycatid

Parameters Guide

Parameter Accepts
ebaycatid int a category id - We use a version of the Ebay Categories Hierarchy - Future development and updates due

Example Request Format

Direct Url https://api.beepxtra.com/platform/categories/1
Curl CURL -A "YOURAPPNAME|1.0|AppID|AppKEY|platform" -X GET https://api.beepxtra.com/platform/categories/1
PHP SDK $beepapi->request('get', 'card', 'categories/1');

Sample Response

Success
{  
   "success":true,
   "request":{  
      "method":"GET",
      "controller":"platform",
      "resource":"categories",
      "parameters":{  
         "\/platform\/categories\/1466":""
      },
      "url_elements":[  
         "platform",
         "categories",
         "1466"
      ]
   },
   "error":{  
      "errorid":0,
      "message":0
   },
   "data":[  
      {  
         "id":"2037",
         "name":"Not That Odd",
         "description":"Not That Odd",
         "image":"",
         "ebaycatid":"60823",
         "ebayparentid":"1466",
         "pathnames":"Collectables:Weird Stuff:Not That Odd",
         "level":"3",
         "path":"1:1466:60823"
      },
      {  
         "id":"2040",
         "name":"Rather Strange",
         "description":"Rather Strange",
         "image":"",
         "ebaycatid":"60825",
         "ebayparentid":"1466",
         "pathnames":"Collectables:Weird Stuff:Rather Strange",
         "level":"3",
         "path":"1:1466:60825"
      },
      {  
         "id":"2041",
         "name":"Really Weird",
         "description":"Really Weird",
         "image":"",
         "ebaycatid":"1468",
         "ebayparentid":"1466",
         "pathnames":"Collectables:Weird Stuff:Really Weird",
         "level":"3",
         "path":"1:1466:1468"
      },
      {  
         "id":"2038",
         "name":"Slightly Unusual",
         "description":"Slightly Unusual",
         "image":"",
         "ebaycatid":"1467",
         "ebayparentid":"1466",
         "pathnames":"Collectables:Weird Stuff:Slightly Unusual",
         "level":"3",
         "path":"1:1466:1467"
      },
      {  
         "id":"2042",
         "name":"Totally Bizarre",
         "description":"Totally Bizarre",
         "image":"",
         "ebaycatid":"1469",
         "ebayparentid":"1466",
         "pathnames":"Collectables:Weird Stuff:Totally Bizarre",
         "level":"3",
         "path":"1:1466:1469"
      },
      {  
         "id":"2039",
         "name":"Unusual",
         "description":"Unusual",
         "image":"",
         "ebaycatid":"60824",
         "ebayparentid":"1466",
         "pathnames":"Collectables:Weird Stuff:Unusual",
         "level":"3",
         "path":"1:1466:60824"
      }
   ]
}
Error
{"success":true,"request":{"method":"GET","controller":"platform","resource":"categories","parameters":{"\/platform\/categories\/1000":""},"url_elements":["platform","categories","1000"]},"error":{"errorid":0,"message":0},"data":[]}

Response Guide

Parameter Type Details
error String No errors available. Will return null Json object if no details found
id int The internal category id in Beep Platform
name string Category name
description string Category description
image string Category image path if available
ebaycatid int The ebay category id (Version 97)
ebayparentid int The current ebay category id (Parent of listed categories)
pathnames string The category names nested from root category (Separated by :)
level int The current level of the category
path string The path of ebay category ids nested from root category (Separated by :)