List categories

(Available with Premium v3 access)

Request URL

[GET] http://popshops.com/v3/categories.xml
[GET] http://popshops.com/v3/categories.json

Response Formats

XML, JSON

Required request parameters

Parameter name Type Kind Allowed values Default value Description
account account Your API account key. You can find this on your API keys account page.

Optional request parameters

None

Response results

Node Attribute Kind Data Type Description
categories Contains all individual categories.
category An individual category
idrequired primary_key integer The unique identifier for the category. This acts as a primary key that can be used to reference the category.
leaf display boolean Indicates whether or not the category is a leaf in the category tree and doesn't have any child categories.
namerequired display string The display name of the category.

Resources

None

Sample response


<?xml version="1.0" encoding="UTF-8"?>
<response status="200" message="ok">
  <parameters>
    <parameter kind="account" value="d1lg0my9c6y3j5iv5vkc6ayrd" name="account"/>
  </parameters>
  <results>
    <categories>
      <category id="1" name="All">
        <categories>
          <category id="32194" name="Arts & Crafts">
            <categories>
              <category id="1000" name="Art & Collectibles">
                <categories>
                  <category id="1100" name="Artwork" leaf="true"/>
                  <category id="1200" name="Collectibles" leaf="true"/>
                </categories>
              </category>
              <category id="1300" name="Craft Supplies">
                <categories>
                  <category id="32465" name="Art Supplies" leaf="true"/>
                  <category id="32900" name="Brushes & Paints" leaf="true"/>
                  <category id="1355" name="Clay & Pottery Supplies" leaf="true"/>
                  <category id="33185" name="Craft Organization & Storage" leaf="true"/>
                  <category id="32451" name="Drafting Supplies" leaf="true"/>
                  <category id="1345" name="Magic & Novelties Kits & Supplies" leaf="true"/>
                  <category id="1370" name="Needlework & Sewing Supplies" leaf="true"/>
                  <category id="1360" name="Other Craft Supplies" leaf="true"/>
                  <category id="1365" name="Scrapbooking" leaf="true"/>
                </categories>
              </category>
              <category id="32528" name="Posters & Prints" leaf="true"/>
            </categories>
          </category>
        </categories>
      </category>
    </categories>
    ...
  </results>
</response>

{
   "results":
   {
       "categories":
       {
           "category":
           [
               {
                   "name": "All",
                   "categories":
                   {
                       "category":
                       [
                           {
                               "name": "Arts & Crafts",
                               "categories":
                               {
                                   "category":
                                   [
                                       {
                                           "name": "Art & Collectibles",
                                           "categories":
                                           {
                                               "category":
                                               [
                                                   {
                                                       "name": "Artwork",
                                                       "leaf": "true",
                                                       "id": "1100"
                                                   },
                                                   {
                                                       "name": "Collectibles",
                                                       "leaf": "true",
                                                       "id": "1200"
                                                   }
                                               ]
                                           },
                                           "id": "1000"
                                       },
                                       {
                                           "name": "Craft Supplies",
                                           "categories":
                                           {
                                               "category":
                                               [
                                                   {
                                                       "name": "Art Supplies",
                                                       "leaf": "true",
                                                       "id": "32465"
                                                   },
                                                   {
                                                       "name": "Brushes & Paints",
                                                       "leaf": "true",
                                                       "id": "32900"
                                                   },
                                                   {
                                                       "name": "Clay & Pottery Supplies",
                                                       "leaf": "true",
                                                       "id": "1355"
                                                   },
                                                   {
                                                       "name": "Craft Organization & Storage",
                                                       "leaf": "true",
                                                       "id": "33185"
                                                   },
                                                   {
                                                       "name": "Drafting Supplies",
                                                       "leaf": "true",
                                                       "id": "32451"
                                                   },
                                                   {
                                                       "name": "Magic & Novelties Kits & Supplies",
                                                       "leaf": "true",
                                                       "id": "1345"
                                                   },
                                                   {
                                                       "name": "Needlework & Sewing Supplies",
                                                       "leaf": "true",
                                                       "id": "1370"
                                                   },
                                                   {
                                                       "name": "Other Craft Supplies",
                                                       "leaf": "true",
                                                       "id": "1360"
                                                   },
                                                   {
                                                       "name": "Scrapbooking",
                                                       "leaf": "true",
                                                       "id": "1365"
                                                   }
                                               ]
                                           },
                                           "id": "1300"
                                       },
                                       {
                                           "name": "Posters & Prints",
                                           "leaf": "true",
                                           "id": "32528"
                                       }
                                   ]
                               },
                               "id": "32194"
                           },
                           ...