--- title: Pin rules for product listing pages slug: o5sf0214 canonical_url: https://docs.coveo.com/en/o5sf0214/ collection: coveo-merchandising-hub source_format: adoc --- # Pin rules for product listing pages In the [Product listings manager](https://docs.coveo.com/en/p64e0262/) of the [Coveo Merchandising Hub (CMH)](https://docs.coveo.com/en/o5290573/), merchandisers can define _pin_ ranking rules to make specific products appear in specific numbered positions on one or more [product listing pages (PLPs)](https://docs.coveo.com/en/m1sf3187/). ![Pin rule for product listing pages | Coveo](https://docs.coveo.com/en/assets/images/coveo-for-commerce/images/cmh/cmh-listings-pin-rule.png) A on a [product listing page (PLP)](https://docs.coveo.com/en/m1sf3187/) can be viewed as a grid (or list) of products in numbered positions. These numbers correspond to their ranking when they're returned from the Coveo [index](https://docs.coveo.com/en/204/). A pin rule reserves a specific numbered position for a specific product or [sponsored product](https://docs.coveo.com/en/pakd0058/), regardless of that product's actual ranking. However, pin rules with the same target can [conflict with one another](#pin-rule-conflicts), so merchandisers must not create multiple pin rules that target the same position for the same listing pages. **Example** The first four products returned pass:q,a[for the `Canoes` PLP] are the following: [%header,cols="^1,^1,^1,^1"] |=== |1 |2 |3 |4 |`Orangecraft canoe` |`Bluewater canoe` |`Kayaker canoe` |`Ocarina canoe` |=== You create a pin rule to reserve position 2 for the product `Aqua Blue canoe`. The first four products on the PLP are now the following: [%header,cols="^1,^1,^1,^1"] |=== |1 |2 (reserved) |3 |4 |`Orangecraft canoe` |`Aqua Blue canoe` |`Bluewater canoe` |`Kayaker canoe` |=== ## Use case examples Pin ranking rules can be used to address a variety of use cases. Here are a few examples: * **Enforce a specific order**: Pin products to the top of specific PLPs to enforce a specific order. * **Pin best sellers**: Pin the best-selling products of a given category to the top of that category's PLP. * **Pin clearance items**: Pin clearance items to the top of specific PLPs to increase their visibility. ## Pin rule conflicts Pin rules override the content that should otherwise appear at a specific position on a [product listing page (PLP)](https://docs.coveo.com/en/m1sf3187/). This includes other product pins or [sponsored product pins](https://docs.coveo.com/en/pakd0058/) that target the same position, so merchandisers must not create multiple pin rules that target the same position for the same listing page. Pin rule conflicts are resolved as follows: * If there's a conflict between product pins, priority is given to the most recent product pin rule. * If there's a conflict between a product pin and a sponsored product pin, the sponsored product pin always takes precedence. However, if there are no sponsored products to feature in the reserved position, then any product pin rules for that position apply as normal, with priority given to the most recent product pin rule. * If there's a conflict between sponsored product pins, priority is given to the most recent sponsored product pin rule. **Example** On March 1, you create a rule that pins the product "Eco-Bag" at position 2 on the `Accessories|Bags` PLP. On March 10, you create another rule that pins the product "Limespace DryBag" at position 2 on the `Accessories|Bags` and `Accessories|Bags|Drybags` PLPs. Because both pin rules target the same position on the `Accessories|Bags` PLP, only the most recent rule applies. When a user navigates to the `Accessories|Bags` PLP, "Limespace DryBag" is pinned at position 2. ## Prerequisites Before you create rules in the [Coveo Merchandising Hub (CMH)](https://docs.coveo.com/en/o5290573/): * [Create query pipelines](https://docs.coveo.com/en/o48e0216#storefront-associations-and-query-pipelines). * [Choose the correct property](https://docs.coveo.com/en/o6lb0453#property-and-locale-selectors) to ensure that your changes affect the intended listing pages. ## Create pin rules To create pin rules . In the CMH, access the **Product listings** manager. . From the navigation tabs, select **ranking rules** and then click **Create ranking rule**. . Under **This rule will apply to**, define the scope of the rule. .. **Locale**: Select the [locale](https://docs.coveo.com/en/p4tf0351/) that the pin rule applies to. By default, a rule applies to all available [locales](https://docs.coveo.com/en/p4tf0351/). .. **Audiences**: Select the audience that the pin rule will target. You can choose between predefined audience profiles or create custom profiles. You can only select one audience profile per rule. > **Important** > > The **Audience** option is currently in early access. > Contact your Customer Success Manager (CSM) to enable this option. *** **All visitors**: By default, the rule applies to all [visitors](https://docs.coveo.com/en/nbub9475/). *** **Device & technology**: Target [visitors](https://docs.coveo.com/en/nbub9475/) visiting a [storefront](https://docs.coveo.com/en/p33g0410/) using a specific device type. The device type is determined by the information sent by the [visitor](https://docs.coveo.com/en/nbub9475/)'s browser, not by the device's screen size. Available options are: **** **Desktop**: Encompasses desktop computers and laptops. **** **Mobile**: Encompasses all mobile phones. **** **Tablet**: Encompasses all tablets. *** **Visitor type**: Target the [visitors](https://docs.coveo.com/en/nbub9475/) who are logged into the [storefront](https://docs.coveo.com/en/p33g0410/) or those who aren't. *** **Your audiences**: Create a custom audience profile that you can reuse in other rules sharing the same [property](https://docs.coveo.com/en/p4ue0547/). After a custom audience profile is created, it can't be changed once the rule is published. If all rules containing a custom audience profile are deleted, the custom audience profile will no longer be available as an option when creating new rules. **** **Visitor URL**: Target [visitors](https://docs.coveo.com/en/nbub9475/) based on the URL of the [storefront](https://docs.coveo.com/en/p33g0410/) page they're on. **** **Referrer URL**: Target [visitors](https://docs.coveo.com/en/nbub9475/) based on the URL they came from before landing on the [storefront](https://docs.coveo.com/en/p33g0410/). > **Important** > > For URL-based audiences to function correctly with query parameters (such as campaign tracking parameters like `?brand=barca&model=sp&color=red`), you can pass the complete URL including query parameters to Headless or the Commerce API directly. > See [Navigating between pages (CSR)](https://docs.coveo.com/en/o7v87331/), [Build product listing pages (SSR)](https://docs.coveo.com/en/p25b0072/), and [Use the Commerce API directly](https://docs.coveo.com/en/p5je0317#retrieve-products-for-a-listing-page) for implementation details. .. [.initial]**listing page**: pin rules are only available when the rule is scoped to specific listing pages. If you choose **All listing pages**, the [.initial]**pin** option is hidden. To scope the rule to specific listing pages: ... Select **Specific listing pages**. ... Select an **Operator**. **** `Is`: This operator identifies listing pages that exactly match the specified value. For example, you can use it to create a rule that only targets the listing page `accessories`. **** `Page name contains`: This operator identifies listing pages where the specified value is found within the full value of the listing page name. For example, you can use it to create a rule that targets all listing pages whose name contains the term `accessories`, including `Accessories|Bags` and `Accessories|Life Jackets`. **** `Page URL contains`: This operator identifies listing pages where the specified value is found within the full value of the listing page URL. For example, you can use it to create a rule that targets all listing pages whose URLs contain the term `kayak`, including `sports.barca.group/plp/canoes-kayaks` and `sports.barca.group/plp/canoes-kayaks/kayaks/sea-kayaks`. ... Select one or more [.initial]**listing pages** that the pin rule applies to. ... Click **Done**. . Under **Choose an action**, select **Pin**. . To pin a product, you can either search for the product or use the preview to select the products to pin. ** To search for a product: ... Under **Product ID or name**, select the product to pin. ... Under **Position number**, enter the number of the position where the product will appear on the PLP. ... (Optional) To pin more than one product, click **Pin another product** and repeat the previous steps. ** When using the preview, drag a product and drop it at a position to pin it there. . Click **Next: Review and publish**. . Review your rule configuration. > **Leading practices** > > Use the panel on the right to preview how the rule affects > the products on the listing page for a given [locale](https://docs.coveo.com/en/p4tf0351/). > > The preview is an approximate simulation that won't cover every scenario encountered in a live environment. . Click **Next: Publish**. . Under **Rule name**, enter a meaningful name for your rule. . Under **Choose when to publish**, select one of the following: ** To apply the rule immediately, select **Publish now**. ** To set a schedule for the rule, select **Set a schedule**, and then select the time frame in which the rule should apply. . Click **Publish now**. The rule now applies or will apply as scheduled. ## Modify pin rules To modify pin rules . In the CMH, access the **Product listings** manager. . From the navigation tabs, select **ranking rules**. . Locate the rule that you want to modify. . Click [dots], and then click **Modify**. . You can modify the rule's scope (**Locale**, **Audiences**, or [.initial]**listing page**) or its configuration by clicking **Edit** on the relevant card. These are the same settings covered in the [rule creation](#create-pin-rules) section. > **Important** > > The **Audience** option is currently in early access. > Contact your Customer Success Manager (CSM) to enable this option. . When you've finished editing the rule, or to modify its publishing settings, click **Next: Publish**. . Update the publishing settings, if applicable, and then click **Publish now**. The modified rule now applies, or will apply as scheduled. ## Copy pin rules To copy pin rules . In the CMH, access the **Product listings** manager. . From the navigation tabs, select **ranking rules**. . Locate the rule that you want to copy. . Click [dots], and then click **Copy to...**. . In the **Copy rule** modal that opens, you can choose whether to copy the rule to other [properties](https://docs.coveo.com/en/p4ue0547/) or listing pages. ** To copy the rule to other [properties](https://docs.coveo.com/en/p4ue0547/): ... Select **Property** and click **Next**. ... Use the dropdown menu to select one or more [properties](https://docs.coveo.com/en/p4ue0547/). > **Important** > > If any of the listing pages that the rule is scoped to > don't exist in the target [property](https://docs.coveo.com/en/p4ue0547/), you'll see an error message and be unable to proceed with the copy. > > The error message will list the listing pages that are missing from the destination [property](https://docs.coveo.com/en/p4ue0547/). ... Click **Confirm copy**. ** To copy the rule to other listing pages (if applicable): ... Select [.initial]**listing page** and click **Next**. ... Use the dropdown menu to select one or more listing pages. ... Click **Confirm copy**. The rule is copied to the target [properties](https://docs.coveo.com/en/p4ue0547/) or listing pages. ## Delete pin rules To delete pin rules . In the CMH, access the **Product listings** manager. . From the navigation tabs, select **ranking rules**. . Locate the rule that you want to delete. . Click [dots], and then click **Delete**. . Click **Delete** again to confirm. The rule is deleted.