GET a list of products with keyword Search and filter by the specified attributes

GET 
/sv/:categoryId/:searchWord

• Requires Data Viewer ApiKey permissions.
• Example URI: https://instancename.piminto.com/api/en-us/sv/137/searchWord?filters=price&price=100.00;;1000.00&pageSize=10&pageNum=3

This API enables the retrieval of information about products in the specified category using a search term and filtering based on specified attributes.

Returns

---

Specify a unique category identifier.

Specify a search word or phrase (search term).

To filter the results by attribute values, specify the attribute name and value. You can apply multiple filters at once.

The endpoint returns a list of products that match the search keywords and are filtered by attributes within the specified category.

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

categoryId integerrequired
searchWord stringrequired

Search phrase for searching within attribute

Query Parameters

filters string[]

if FilterParams is set. Attribute names for filtering products.

FilterParams object

Attribute names and their values for filtering products. All attribute names that you add to this field should also be listed in the filters parameter. The required input value templates are as follows:

• For multiple values, separate them using '|'

• For a value range, separate the maximum and minimum values using ';;'

  the values in the range must consist only of digits and periods (0-9, '.')

example: { "brand": "YourBrand1|YourBrand2", "price": "10.50;;25.00", "status": "active" }

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

200

success

application/json

Schema

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

Example (from schema)

{
  "products": [
    {
      "data": {
        "attributes": {
          "sku": "Part-number00",
          "categories": [
            "Category-1 Name > Category-2 Name"
          ],
          "status": "active",
          "thumbnail": "string",
          "title": "Title PART-number00",
          "price": "100.00",
          "rod_diameter": "2.875 in (7.3 cm)",
          "variation_attributes": [
            "rod_diameter"
          ],
          "variation_of": null,
          "variation_skus": [
            [
              "Part-number01",
              "Part-number02"
            ]
          ],
          "variation_matrix": {
            "Part-number01": {
              "rod_diameter": [
                "1.66 in (4.22 cm)"
              ]
            },
            "Part-number02": {
              "rod_diameter": [
                "2.625 in (6.67 cm)"
              ]
            },
            "Part-number00": {
              "rod_diameter": [
                "2.875 in (7.3 cm)"
              ]
            }
          }
        }
      },
      "sku": "Part-number00"
    }
  ],
  "search_phrase": "searchWord",
  "found_total": 1,
  "status": "OK",
  "found_in_categories": [
    {
      "cat_path_id": "1 > 137",
      "cat_name": "string",
      "cat_path": "CategoryNameParent > CategoryName",
      "cat_sku_qty": 0,
      "cat_id": "string"
    }
  ],
  "filters": {
    "cat_filters": [
      {
        "filter_name": "Brand",
        "filter_values": [
          {
            "label": "BRAND NAME",
            "value": "Brand Name"
          }
        ],
        "filter_var": "brand",
        "filter_type": "multiselect"
      }
    ],
    "cat_image": "string"
  }
}

Loading...