The WooCommerce Product Search extension introduces a new REST API, which allows to use the Search Engine to build customized components and Apps which support holistic search and filtering. [1]
The new REST API includes the following endpoints:
- Shop :
GET /wp-json/wps/v1/shop - Products :
GET /wp-json/wps/v1/products - Terms :
GET /wp-json/wps/v1/terms
The REST API endpoints discussed here are part of the WooCommerce Product Search extension.
Shop
↑ Back to topProvide products, related terms and additional data for all products or those that match a specified set of search and filter constraints. Additional data includes stats about products on sale, stock status, price range data, ratings, stats on featured products and other relevant data.
HTTP Request : GET /wp-json/wps/v1/shop
The REST API – Shop documentation page provides a detailed description of the endpoint and its parameters.
Products
↑ Back to topProvide all products or those that match a specified set of search and filter constraints.
HTTP Request : GET /wp-json/wps/v1/products
The REST API – Products documentation page provides a detailed description of the endpoint and its parameters.
Terms
↑ Back to topProvide all taxonomy terms or those that match a specified set of search and filter constraints.
HTTP Request : GET /wp-json/wps/v1/terms
The REST API – Terms documentation page provides a detailed description of the endpoint and its parameters.
[1] The new REST API is available as of version 6.0.0 of the extension.
This section and its subsections will be further enhanced with information and examples shortly. If you are a developer and have questions on the use of the REST API for your components or App, you can reach out and Contact Support for the extension.