Programme d'affiliation de Shopzilla Shopzilla API FAQs

Shopzilla API FAQs

Get started with the Shopzilla Catalogue API

The Product Service

  • How do I get the access to the Shopzilla Catalogue API?
  • Can I search for a product by EAN number?
  • How do I access the Shopzilla API portal?
  • The API only allows me to return 250 results per query, how can I get all the results where there are more than 250?
  • I am connected to the API portal but when I launch a query it returns an error message, why?
  • What is the difference between the value “SZPID” and the value “SZOID” in the Product Type parameter?
  • Where can I find the ID of a product (PID) or the ID of an offer (OID)?
  • What are the minMarkdown filter and the maxAge filter?
  • The Taxonomy Service

    The Brand Service

  • What does the term of Taxonomy refer to?
  • Questions will be updated soon
  • What is the parameter “ancestors” useful for?
  • How can I find the minimum bid by category?
  • The Merchant Service

    Miscellaneous

  • Are Merchant ratings and reviews available for all merchants?
  • Can I change the size of the images included in the API feeds?
  • What does it mean when the price tag in the API feed displays “£100,000”?
  • Do all redirects to Shopzilla merchants’ sites generate revenue?



  • Get Started with the Shopzilla Catalogue API

      Q: How do i get the access to the Shopzilla Catalogue API?

    A: If you want to use the Shopzilla API, you’ll need a Publisher ID (if not already registered) and an API key. If you are not already a Shopzilla publisher, you can register for the Shopzilla Publisher Program by clicking here. If you are already a Shopzilla publisher, simply contact the Publisher team, give them your Publisher ID and notify them that you wish to use the API solution. The team will then review your application and get back to you within the following 24-48hrs. Once your application is approved, you will receive a Publisher ID (for the new publishers), an API key and the API’s URL location.
    Note: a Publisher ID and its API key are only valid for the country you have applied for.

    back to top

      Q: How do I access the Shopzilla API portal?

    A: You can access the UK, FR and DE Shopzilla Catalogue API portal via these 3 links:
    For each of the API URL’s, you will need a unique API key associated with your relevant Publisher ID (1 publisher ID by country).

    back to top

      Q: I am connected to the API portal but when I launch a query it returns an error message, why?

    A: When launching a query, you have to make sure that you are using the Publisher ID and relevant API key corresponding to the country of registration (UK, FR or DE). If you don’t do so, then an “Internal Server Error” message will be returned when a query is launched.

    back to top


    The Product Service

      Q: Can I search for a product by EAN number?

    A: No, unfortunately you can’t. EAN numbers are not included in the API XML feeds. However, the Shopzilla Catalogue API includes 4 different types of Product ID with which you can search for products. These are: Note that each of these Product ID types has a different use (see API documentation for more information about these Product ID types).

    back to top

      Q: The API only allows me to return 250 results per query, how can I get all the results where there are more than 250?

    A: An API query will display up to 250 results at any one time. If you do wish to see more than 250 results when possible, you will have to collect the first 250 results followed by the next 250 results etc. until you have collected all returned required.

    This can be done as shown below:

    Step 1: Pull the first 250 results

    Step 2: Pull the next 250 results

    You should repeat the process until all required results have been gathered.

    back to top

      Q: What is the difference between the value “SZPID” and the value “SZOID” in the Product Type parameter?

    A: SZPIDstands for Shopzilla Product ID and is unique to each product. If you want the API to return all the offers for a specific product then you should launch a query using “SZPID” and set the “ProductTypeID” parameter to its according type, “SZPID” as shown in the example below:

    (Note: at least one keyword or category ID must be entered when using a SZPID value)

    Example of a query for “Ipod Nano 16GB Silver – 6th generation”:


    SZOID stands for Shopzilla Offer ID and is unique to an offer for a given product. Therefore, if you only wish to display a specific offer from a specific product on your website, then you should launch a query using “SZOID” and set the “ProductTypeID” parameter to “SZOID” as shown in the example below:


    (Note: at least one keyword or category ID must be entered when using a SZPID value)

    Example of a query for an offer from the merchant “Laskys” for the Ipod Nano 16GB Silver – 6th generation:

    back to top

      Q: Where can I find the ID of a product (PID) or the ID of an offer (OID)?

    A: PIDs and OIDs can be found in the API XML feed under the “Offer” element as shown in the example below:

    back to top

      Q: What are the minMarkdown filter and the maxAge filter?

    A:



    back to top


    The Taxonomy Service

      Q: What does the term of Taxonomy refer to?

    A:The term of taxonomy refers to the Shopzilla category tree as displayed on Shopzilla websites. This is how our categories are built and how it is structured. The purpose of the taxonomy is to make visitor experience on Shopzilla as simple as possible when looking for a product.

    The Taxonomy Service will therefore enable you to browse and explore the Shopzilla category tree.

    back to top

      Q: What is the parameter “ancestors” useful for?

    A:You should use the “ancestors” parameter in the Taxonomy Service if you want to see the path from the “root” category to the “target” category, or in other words the category for which you want to use the content. In order to include the ancestor path in the API XML feed, you should to set the “ancestors” parameter to “true”.

    This parameter may be useful if you’re building your own price comparison website with our API and want to get a better understanding of how to create a category tree.

    Example of a query including the “ancestors” element for the category “Laptop” (category ID: 13969)


    (Note: the "ancestors" parameter should always be used in conjunction with the categoryID parameter)

    back to top

      Q: How can I find the minimum bid by category?

    A:The minimum bid by category can be found using the Taxonomy Service, under the “MinimumBid” element in the API XML feed.

    E.g:

    To know the minimum bid for a specific category, simply launch a query using the Taxonomy Service. Once in the Taxonomy Service, enter the category ID for which you wish to find out the minimum bid, then submit the query.

    back to top

    The Brand Service

      Questions will be updated soon


    The Merchant Service

      Q: Are Merchant ratings and reviews available for all merchants?

    A:Merchant ratings and reviews on Shopzilla are only available for merchants who have collected more than 20 survey responses from buyers. Below this amount, we consider that ratings or reviews are not accurate enough and are not displayed on Shopzilla.
    As a consequence, you will only be able to find Merchant ratings and reviews in the API feeds when these merchants have collected more than 20 survey responses.

    back to top

    Miscellaneous

      Q: Can I change the size of the images included in the API feeds?

    A:Yes, it is possible to change image sizes by modifying their format. In order to do so, simply take the image’s URL located under the “Image” element in the API XML feed and modify the size as shown below:

    back to top

      Q: What does it mean when the price tag in the API feed displays “£100,000”?

    It simply means that pricing information is not available in the feed. This can either be because the store hasn’t shared this information with Shopzilla or because different factors (only available on the merchant’s site) determine the final price of a product.
    i.e. A good example would be mobile phones for which the final price often depends on the contract chosen by the customer.

    back to top

      Q: Do all redirects to Shopzilla merchants’ sites generate revenue?

    You are normally remunerated for each click sent to one of Shopzilla merchants. However there are two exceptions that you should be aware of when using the Shopzilla Catalogue API: