GET /public/v2/product-catalog/items/search

This method searches for items in your product catalog.

Use the query parameter to search in title, SKU, description, category name, custom fields name and value. You can also search for items by their type, billing type, and category id.

Order search results, in both ascending and descending order, by these item properties:

Use the exclude_uuids parameter to exclude particular uuids from the search request.

Servers

Query parameters

Name Type Required Description
page Number No

Page number.

exclude_uuids[] Array No

A list of item uuids to be excluded from search.

query String No

Search query. Searches the following fields: Title, SKU, description, category name, custom fields name and value.

billing_types[] Array No

Filter by billing types.

types[] Array No

Filter by catalog item types.

no_category Boolean No
per_page Number No

Items per page.

category_id String No

Category id.

order_by String No

Ordering principle for displaying search results.

Valid values:

  • "price"
  • "sku"
  • "-price"
  • "-sku"
  • "-title"
  • "-date_modified"
  • "title"
  • "date_modified"

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.