shopping24 documentation

s is for shopping

API category browsing

This API leverages category browsing endpoints to implement browsing capabilites. You can refine the category browsing result supplying filter information, e.g in the brand or color parameter.

Full category tree

You’re able to retrieve the full or partial category tree using the /categories endpoint:

GET /v3/:appid/categories
<ns3:category xmlns:ns2="http://api.s24.com/v3/1.0/common" 
      xmlns:ns3="http://api.s24.com/v3/1.0/products" 
      count="825772" id="27165">
      
  <!-- a meta tree name, ignore -->
  <name>smatch skin apiv3 08 2012</name>
  <children>
  
    <!-- product count and id -->
    <category count="326471" id="27166">
    
      <!-- displayable name -->
      <name>Damenmode</name>
      
      <!-- child categories -->
      <children> ... </children>
      
      <!-- link to retrieve products in this category -->
      <link href="https://api...166/products" rel="products" />
      <link href="https://api...166" rel="self" />
    </category>
    <category count="185340" id="27442"> ... </category>
    <category count="44844" id="27443"> ... </category>
    <category count="306359" id="27444">
  </children>
  <link href="http://api...165/products" rel="products" />
  <link href="http://api...165" rel="self" />
</ns3:category>

Base category tree

With appid base you can retrieve the base category tree, which represents our normalized category tree. It’s not possible, to browse to products in this tree, retrieve it for normalization purposes.

GET /v3/base/categories

Products in a category

In order to browse the products in categories, just call the products endpoint for the specific category. See the API product search section for details on sort, paginating and filtering product result lists. See the API product details section for product marshalling details.

GET /v3/:appid/category/:id/products

You can only request products of one category in each request! You can only request up to 150 characters as searchterm!

Filter

To filter the category result, you are able to do an additional search by term inside the selected category like:

GET /v3/:appid/category/:id/products?q=:term

The following mechanisms are built into the product search api to find related results.

If a category contains less than about 10 products, the category result contains related products. They are encapuslated in a <related> block as <products> element and are somewhat related to the products matching the ones from this category. See the API product details section for product marshalling details.

<categoryProducts>
  <products>
    <product>...</product>
  </products>
  <related>
    <products>
	  <product>...</product>
    </products>
  </related>
</categoryProducts>

Related categories are available for most categories. They are also encapsulated in the <related> block as <categories> element with a source element <source>. The category in <source> is the currently selected one, all others are related categories.

<categoryProducts>
  <products>
    <product>...</product>
  </products>
  <related>
    <categories>
      <source>
        <ns2:category id="42">
          <name>Herren Hosen</name>
          <link href="http://..." rel="products"/>
          <link href="http://..." rel="self"/>
        </ns2:category>
      </source>
      <ns2:category id="43">
        <name>Herren Jacken</name>
        <link href="http://..." rel="products"/>
        <link href="http://..." rel="self"/>
      </ns2:category>
      ...
  	</categories>
  </related>
</categoryProducts>