Skip to main content

GET a list of products with a keyword Search

GET 

/sv//:searchWord

This API allows you to retrieve information about products in the PIMS system using a search term.

Returns


Specify a search word or phrase (search term).

The endpoint returns a list of products that match the search keywords.

Additionally, the returned list of products contains detailed information about each product, although the specific details may vary. This information can include the product name, description, price, images, and other characteristics. This information helps users better understand and choose the most suitable product, and also allows application developers to more flexibly use the obtained data in their projects.

Request

Path Parameters

    searchWord stringrequired

    Search phrase for searching within attribute

Query Parameters

    order-by string[]

    Possible values: Value must match regular expression ^\w+\|(asc|desc)$

    Sorting field and the sorting order for this field, separator '|' example order by SKU in ascending order: sku|asc

    pageSize integer

    The number of items per page

    pageNum integer

    The page number

Header Parameters

    ApiView string

    View name from the PIM's view Dictionary. ✔If the ApiView parameter is not passed- data is returned according to default View defined for access group.

Responses

success

Schema
    products object[]

    Collection objects Product

  • Array [
  • data objectrequired
    attributes object

    Detailed information about the product, its variants, their corresponding attributes, and values

    sku string

    Unique product code or number.

    categories string[]

    Collection of categories that the product is assigned to.

    Presented the relative path of the category that is calculated and uses '>' as a separator for the category name.

    status string

    Status of the product. Can only take the following values: active, inactive, deleted.

    thumbnail string

    Link to internal or external image asset in the form of a url.

    title string

    Short description of the product.

    price string

    Presented as a recommended attribute

    rod_diameter string

    It can be any attribute from your Pims system. The attribute 'rod_diameter' is provided here as an example for the variation SKU.

    variation_attributes string[]

    Collection of attributes for the current product and the SKUs in the variation_skus collection. The values of these attribute data are set as variations of the product.

    variation_of string

    Collection of sku's that are variations of the current product. This field value is automatically maintained by the PIMS.

    variation_skus string[]

    List of sku's that are variations of the current product. This field value is automatically maintained by the PIMS.

    variation_matrix object

    A JSON object in which the variation SKUs act as keys, and their attribute-value pairs act as values. It represents dynamic data that can vary depending on the product and its variations.

    The following JSON schema is provided as an example only, where:

    Part-number01, Part-number02- are the variation SKU keys.

    rod_diameter- is an attribute of the variation SKUs, which can be any attribute from your Pims system. The attribute 'rod_diameter' is provided here as an example.

    Part-number01 object
    rod_diameter string[]
    Part-number02 object
    rod_diameter string[]
    Part-number00 object
    rod_diameter string[]
    sku stringrequired

    Unique product code or number.

  • ]
  • search_phrase stringrequired
    found_total integerrequired
    status stringrequired
    found_in_categories object[]
  • Array [
  • cat_path_id string
    cat_name string
    cat_path string
    cat_sku_qty integer
    cat_id string
  • ]
  • filters object
    cat_filters object[]
  • Array [
  • filter_name stringrequired

    The name of the filter.

    filter_values object[]required

    An array of values for the filter, with each item having a "label" and "value" option.

  • Array [
  • label stringrequired

    The label option for the filter value.

    value stringrequired

    The value option for the filter value.

  • ]
  • filter_var stringrequired

    The attribute name by which products will be filtered within this category.

    filter_type stringrequired

    Possible values: [multiselect, dropdown]

    The type of the filter.

  • ]
  • cat_image string
Loading...