Use of Browse endpoints

How to use browse endpoints in API

HTML

GET /v1/browse/products

Using the Browse Endpoint

When browsing entities using the browse endpoints in the PIM, specific parameters are required to define the search. Below is an example with the product entity, which is also applicable to the browse endpoints for the other entities. You can view the method header below with its expected parameters.

C#

public BrowseProductsResultSet? Products(int page = 1, DateTimeOffset? lastModifiedAfter = null, bool includeArchived = false, bool renderValues = false)

Input Parameters

• Page: Specifies the page number.

• LastModifiedAfter: Filters results modified after a specified date.

• IncludeArchived: Includes archived products in the results.

• RenderValues: Determines if values should be rendered.

We can now use the browse/products endpoint to retrieve products from a specific page. Below is an example of retrieving products from page 1.

C#

BrowseProductsResultSet? products = apiService._client.Browse.Products(1, null, false, false);

The data has been retrieved successfully, but the values are nested within a complex structure. This can be seen in attributes like CountryOfOrigin or Description, where their values appear as [] instead of displaying the actual content.

Example of a browse/products result with RenderValues set to false

However, by using the RenderValues parameter, you can modify the output to provide rendered, human-readable data. An example of this can be seen below.

C#

BrowseProductsResultSet? products = apiService._client.Browse.Products(1, null, false, true);

Example of a browse/products result with RenderValues set to true

With this we can see that values such as CountryOfOrigin and Description is now rendered, which will support further handling of data without the need for formatting.

Display rendering of values

When browsing values, you can specify which attributes to display and their render pattern, for complex attributes. These settings are available when configuring or editing a complex attribute type. You can find this option under the "Hide advanced data type settings" dropdown.

Edit attribute page on a complex atrribute

In this example, 'Height' and 'Width' are chosen for display, while 'Length' is excluded. The pattern determines how the attributes are rendered and in this example it is set so pattern the attributes is displayed in is "Height - Width".

Example of Display rendering and Render pattern on a complex attribute

Once 'Display rendering' and 'Render pattern' are set, the complex attribute values will align with this configuration when retrieved via the browse/products endpoint. Below, we use the browse/variants endpoint as an example.

Example of a browse/variants result with RenderValues set to true