Pirates of the Caribbean Kraken mouth.Enjoy Free 888+200 Daily Legal Bonus

Resolved lrddrl
(@lrddrl)

1 year ago

Hi everyone,

I’m currently working with the WooCommerce REST API to query all products. The endpoint I’m using is /wp-json/wc/v3/products. By default, the API allows sorting (orderby) by several object attributes, such as date, id, include, title, slug, price, popularity, and rating, with date being the default sorting method.

However, I need to implement a sorting method by relevance. While relevance is a default sorting option within WooCommerce itself, it doesn’t seem to be available by default in the REST API, where date is the preset default.

Could anyone guide me on how to add relevance as a sorting option to the WooCommerce REST API for product queries? Any advice or pointers to documentation that might help with this would be greatly appreciated.

Thank you in advance for your assistance!

The api i am using :

const response = await fetch(my-website/wp-json/wc/v3/products/?post_type=product&search=searchTerm&page=${page}&per_page=10&orderby=relevance,{method: ‘GET’,});

Viewing 2 replies - 1 through 2 (of 2 total)

Plugin Support Shameem R. a11n
(@shameemreza)

1 year ago
Hi @lrddrl,

You’re correct; the WC REST API doesn’t support sorting by relevance out-of-the-box. However, you can extend the functionality of the API by creating a custom endpoint or modifying the existing endpoint using WordPress hooks.

In your case, you might need to use the rest_product_collection_params filter to add relevance as a new orderby parameter. Then, you would use the rest_product_query filter to modify the query if orderby is set to relevance.
- https://wordpress.stackexchange.com/questions/411839/how-can-i-set-the-default-orderby-and-order-parameters-for-a-rest-api-call
- https://iamshishir.com/sorting-orderby-for-custom-meta-fields-in-wordpress/
Please note that writing or providing custom code is not within the scope of our support policy. If you still need assistance, we recommend asking development questions on the #developers channel of the WooCommerce Community Slack. Many of our developers hang out there and will be able to offer insights into your question. You can also seek help from the following:
- A local web developer
- Codeable.io
- WooExperts
I wish I could help more, but hopefully, this gets you going in the right direction to get the job done.
Plugin Support Shameem R. a11n
(@shameemreza)

11 months, 2 weeks ago

Hi @lrddrl

I’m marking this topic as “resolved” due to recent inactivity. If more assistance is needed, feel free to post back here or open a new topic.

Thanks!

Viewing 2 replies - 1 through 2 (of 2 total)

The topic ‘[NSFW] How to Add ‘Relevance’ Sorting to WooCommerce REST API for Products’ is closed to new replies.

Tags