docs
  1. SCAYLE Resource Center
  2. User Guide
  3. Shops
  4. Products
  5. Sorting

Sorting

Product sorting defines the ranking of products in the shop front end. Assigned sorting values determine which products display at the top of a product list in a shop or shop category.

Product sorting is distinct from user defined frontend sorting, which is a sorting filter used by the customer to sort the displayed products (for example, by price).

Sorting Key Creation

Product sortings are created on the global or shop-country levels. If a shop country does not have its own sorting, the sorting configuration from the global shop is used. Creating a new sorting will override the global default.

Create a product sorting:

  1. Navigate to Shops > Shop > Products > Sorting > New Sorting.
  2. Click New Sorting.
  3. Enter a Sorting Key. For every sorting, a unique Sorting Key must be defined.
  4. Click Add Products to add several products to the Sorting Key.
  5. Define a Sorting Value for each product. Use the up/down arrows or enter values manually.
  6. When complete click Save Sorting.

Sorting values will be saved relative to each product ID. The sorting key can be used for the Storefront API endpoints.

Product Sorting

Sorting Bulk Import

The bulk import for the product sorting can be found under Settings > Imports & Jobs > Imports > Products > Product Sorting Keys.

To import product sortings, create a CSV file with one row per product and sorting key, and the following column headers:

  • product_id: the SCAYLE product id which should get a sorting value.
  • application_id: the application / shop id for which the sorting should be used.
  • sort_key: the sorting key for the product sorting.
  • sort_value: the sorting value (Score) of the product for the sorting key.

For more general information about imports, see the Imports page.

Uses Cases

Define Sorting for a Shop Category

You can assign a product sorting to a shop category as follows:

  • Define a sorting key to be used for the shop category via the SCAYLE Panel (see above) or the Admin API.
  • Define a custom data parameter on shop category level (see Custom Data).
  • Add the sorting key (sortingKey) for the shop category in the custom data parameter.

Adding a sorting key to Custom Data

Define Sorting for a Price Campaign

You can assign a product sorting to a price campaign as follows:

  • Define a sorting key to be used for the shop category via the SCAYLE Panel (see above) or the Admin API.
  • Define a custom data parameter on Price Campaigns level via the SCAYLE Panel.
  • Add the sorting key for the price campaign in the custom data parameter.
  • The parameter will be shown as part of the price campaign creation (see image below).

Sorting as part of a price campaign