PApandadoc
Product catalog

List 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:

  • SKU
  • Name
  • Price
  • Modification date

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

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

Request

Query parameters

pagenumber

Page number.

per_pagenumber

Items per page.

querystring

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

order_by'sku' | '-sku' | 'title' | '-title' | 'price' | '-price' | 'date_modified' | '-date_modified'

Ordering principle for displaying search results.

typesProductCatalogTypeEnum[]

Filter by catalog item types.

[
  "regular"
]
billing_typesstring[]

Filter by billing types.

exclude_uuidsstring[]

A list of item uuids to be excluded from search.

category_idstring

Category id.

no_categoryboolean

Response

Paginated catalog items

has_more_itemsboolean
totalnumber

Example response

{
  "items": [
    {
      "type": "regular"
    }
  ]
}

Changes

No recorded changes to this operation across all 2 revisions of this API.