Catalog Query

Introduction

Fanplayr offers the ability to view and query the products in an imported product catalog. This feature allows the user to filter the selected catalog and download the results into a CSV.

To access this feature, click the "View products" button from the catalog list.

Viewing Products

The catalog query page will initially load products based on a default set of filters. To learn more about they work, take a look at the section on filters.

The products that result from the catalog query will be ordered in the manner specified in the filters, with the first product appearing on the top-left and the last on the bottom-right. Each product section includes the product image, name, and price.

Clicking the "Download" button will initiate a CSV download of the listed products. The CSV will be ordered the same as in the product grid interface and will include the following fields:

  • ID

  • Name

  • Brand

  • Stock Status

  • Price

  • Categories

  • Product URL

  • Image URL

Note: The price value is defined as the displayPrice in the catalog or the originalPrice if the displayPrice is not set.

Filters

The most important aspect of the catalog query feature are the filters. Filtering the catalog allows the user to trim a potentially huge product catalog into a manageable group to visualize.

Clicking the "Edit" button near the filters will slide out this filter edit screen. Clicking "Update" will apply the filters and automatically regenerate the list of products. The available filters are defined below.

  • Name: This field should match the desired product name. Use commas to separate multiple values. Default: empty

  • Brand: This field should match the desired product brand as defined in the catalog. Use commas to separate multiple values. Default: empty

  • Category: This field should match the desired product category. Use commas to separate multiple values. Default: empty

  • Product List: Use this field if you would like to constrict the source products to a particular product list. The options here include active product lists defined in the portal. Default: none

  • Stock Status: This field should match the desired stock status. The four options are listed below. Default: In Stock, Preorder, Backorder

    • In Stock

    • Out of Stock

    • Preorder

    • Backorder

  • Sort By: This field denotes how the products should be sorted. The options are listed below. Default: First Seen Date (Ascending)

    • Ranking Algorithms (Note: Options here may depend on your account's available algorithms)

      • Ranking by Views

      • Ranking by Carts

      • Ranking by Purchases

      • Ranking by Revenue

    • Other

      • Price (Ascending)

      • Price (Descending)

      • First Seen Date (Ascending)

      • First Seen Date (Descending)

      • First in Stock Date (Ascending)

      • First in Stock Date (Descending)

  • Number of Products: This field will limit the number of resulting products. In order to guarantee a smooth user experience on the page, the maximum number of products is 300. Default: 20

  • Days of History to Use: This field is the number of days of history to use when querying for top ranked products. This value is always editable, even when a ranking algorithm is not selected in the "Sort By". The reason for this is to provide the user with control over which products to display given their relevance at this moment in time. This could be due to seasonality, relevance etc.

Last updated