List merchant types

Merchant types are used to categorize merchants themselves by the broad type of store they are.

Request URL

[GET] http://api.popshops.com/v3/merchant_types.xml
[GET] http://api.popshops.com/v3/merchant_types.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

Parameter name Type Kind Allowed values Default value Description
catalog item A catalog key to limit the merchants to those for a specific catalog.

Response results

Node Attribute Kind Data Type Description
merchant_types The container for all individual merchant types.
merchant_type An individual merchant type.
idrequired primary_key The unique identifier for a merchant type. This acts as a primary key that can be used to reference the merchant type.
merchant_count count integer The number of merchants that belong to this merchant type.
namerequired display string The display name of the merchant type

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>
    <merchant_types count="51">
      <merchant_type merchant_count="22" name="Adult" id="34"></merchant_type>
      <merchant_type merchant_count="23" name="Apparel - Lingerie" id="59"></merchant_type>
      <merchant_type merchant_count="37" name="Apparel - Plus Size" id="14"></merchant_type>
      ...
    </merchant_types>
  </results>
</response>

{
   "results":
   {
       "merchant_types":
       {
           "count": 51,
           "merchant_type":
           [
               {
                   "merchant_count": 22,
                   "name": "Adult",
                   "id": 34
               },
               {
                   "merchant_count": 23,
                   "name": "Apparel - Lingerie",
                   "id": 59
               },
               ...
           ]
       }
   },
   "status": 200,
   "parameters":
   [
       {
           "kind": "account",
           "value": "d1lg0my9c6y3j5iv5vkc6ayrd",
           "name": "account"
       }
   ],
   "message": "ok"
}