# Browse

#Available from v.3.6.0 The browse endpoints allows external partners access to a specified dataset within the PIM system

GET /browse/categories Browse categories

#Available from v.3.6.0

Request parameters

Property name Parameter type Data type Description
page query integer

Page number

lastModifiedAfter query string

Request only entities modified after the provided timestamp

Response status OK (200)

object : BrowseCategoriesResultSet
BrowseCategoriesResultSet
Property name Data type Description
Page integer

Page number

TotalPages integer

Total pages

Categories array : BrowseCategoryResult

Category results

BrowseCategoryResult
Property name Data type Description
Id integer

Id

ParentId integer

Parent Id

Created string

Created

LastModified string

Last modified

InternalName array : LocalizedData[String]

Internal name

Values object

Dictionary of attribute alias and the corresponding attribute value as an object representation

The table below shows how different attributes translates to this value model.

Attribute type data type
Text attribute string
Number attribute decimal
Boolean attribute bool
Fixedlist attribute value/value[] (depending on whether attribute allows selecting multiple global list values). The datatype of this value model depends on the underlying attribute for the global list of the refernced global list value(s)
Media attribute string/string[] (depending on whether attribute allows selecting multiple medias)
Datetime attribute DateTimeOffset
Category attribute int/int[] (depending on whether attribute allows selecting multiple categories)
Product attribute int/int[] (depending on whether attribute allows selecting multiple products)
Variant attribute int/int[] (depending on whether attribute allows selecting multiple variants)
Collection attribute uuid/uuid[] (depending on whether attribute allows selecting multiple collections)
Attribute attribute string/string[] (depending on whether attribute allows selecting multiple attributes)
Complex attribute object (Each property of the object corresponds to each sub attribute of the complex attribute. The value of each property then corresponds to the data type of that sub attribute)
List attribute value[] (Each value in the array represents each row in the list. The model of each row corresponds to the datatype of the row template set up on the list attribute)
LocalizedData[String]
Property name Data type Description
CultureCode string

ISO culture code of the value

Data string

The localized value


GET /browse/products Browse products

#Available from v.3.6.0

Request parameters

Property name Parameter type Data type Description
page query integer

Page number

lastModifiedAfter query string

Request only entities modified after the provided timestamp

Response status OK (200)

object : BrowseProductsResultSet
BrowseProductsResultSet
Property name Data type Description
Page integer

Page number

TotalPages integer

Total pages

Products array : BrowseProductResult

Product results

BrowseProductResult
Property name Data type Description
Id integer

Id

Created string

Created

LastModified string

Last modified

InternalName array : LocalizedData[String]

Internal name

Categories array

Categories

VariantDefiningValues array

Variant defining values

Values object

Dictionary of attribute alias and the corresponding attribute value as an object representation

The table below shows how different attributes translates to this value model.

Attribute type data type
Text attribute string
Number attribute decimal
Boolean attribute bool
Fixedlist attribute value/value[] (depending on whether attribute allows selecting multiple global list values). The datatype of this value model depends on the underlying attribute for the global list of the refernced global list value(s)
Media attribute string/string[] (depending on whether attribute allows selecting multiple medias)
Datetime attribute DateTimeOffset
Category attribute int/int[] (depending on whether attribute allows selecting multiple categories)
Product attribute int/int[] (depending on whether attribute allows selecting multiple products)
Variant attribute int/int[] (depending on whether attribute allows selecting multiple variants)
Collection attribute uuid/uuid[] (depending on whether attribute allows selecting multiple collections)
Attribute attribute string/string[] (depending on whether attribute allows selecting multiple attributes)
Complex attribute object (Each property of the object corresponds to each sub attribute of the complex attribute. The value of each property then corresponds to the data type of that sub attribute)
List attribute value[] (Each value in the array represents each row in the list. The model of each row corresponds to the datatype of the row template set up on the list attribute)
LocalizedData[String]
Property name Data type Description
CultureCode string

ISO culture code of the value

Data string

The localized value


GET /browse/variantgroups Browse variant groups

#Available from v.3.13.14

Request parameters

Property name Parameter type Data type Description
page query integer

Page number

lastModifiedAfter query string

Request only entities modified after the provided timestamp

Response status OK (200)

object : BrowseVariantGroupsResultSet
BrowseVariantGroupsResultSet
Property name Data type Description
Page integer

Page number

TotalPages integer

Total pages

VariantGroups array : BrowseVariantGroupResult

Variant group results

BrowseVariantGroupResult
Property name Data type Description
Id integer

Id

ProductId integer

Product Id

Created string

Created

LastModified string

Last modified

InternalName array : LocalizedData[String]

Internal name

Values object

Dictionary of attribute alias and the corresponding attribute value as an object representation

The table below shows how different attributes translates to this value model.

Attribute type data type
Text attribute string
Number attribute decimal
Boolean attribute bool
Fixedlist attribute value/value[] (depending on whether attribute allows selecting multiple global list values). The datatype of this value model depends on the underlying attribute for the global list of the refernced global list value(s)
Media attribute string/string[] (depending on whether attribute allows selecting multiple medias)
Datetime attribute DateTimeOffset
Category attribute int/int[] (depending on whether attribute allows selecting multiple categories)
Product attribute int/int[] (depending on whether attribute allows selecting multiple products)
Variant attribute int/int[] (depending on whether attribute allows selecting multiple variants)
Collection attribute uuid/uuid[] (depending on whether attribute allows selecting multiple collections)
Attribute attribute string/string[] (depending on whether attribute allows selecting multiple attributes)
Complex attribute object (Each property of the object corresponds to each sub attribute of the complex attribute. The value of each property then corresponds to the data type of that sub attribute)
List attribute value[] (Each value in the array represents each row in the list. The model of each row corresponds to the datatype of the row template set up on the list attribute)
LocalizedData[String]
Property name Data type Description
CultureCode string

ISO culture code of the value

Data string

The localized value


GET /browse/variants Browse variants

#Available from v.3.6.0

Request parameters

Property name Parameter type Data type Description
page query integer

Page number

lastModifiedAfter query string

Request only entities modified after the provided timestamp

Response status OK (200)

object : BrowseVariantsResultSet
BrowseVariantsResultSet
Property name Data type Description
Page integer

Page number

TotalPages integer

Total pages

Variants array : BrowseVariantResult

Variant results

BrowseVariantResult
Property name Data type Description
Id integer

Id

ProductId integer

Product Id

Created string

Created

LastModified string

Last modified

InternalName array : LocalizedData[String]

Internal name

Values object

Dictionary of attribute alias and the corresponding attribute value as an object representation

The table below shows how different attributes translates to this value model.

Attribute type data type
Text attribute string
Number attribute decimal
Boolean attribute bool
Fixedlist attribute value/value[] (depending on whether attribute allows selecting multiple global list values). The datatype of this value model depends on the underlying attribute for the global list of the refernced global list value(s)
Media attribute string/string[] (depending on whether attribute allows selecting multiple medias)
Datetime attribute DateTimeOffset
Category attribute int/int[] (depending on whether attribute allows selecting multiple categories)
Product attribute int/int[] (depending on whether attribute allows selecting multiple products)
Variant attribute int/int[] (depending on whether attribute allows selecting multiple variants)
Collection attribute uuid/uuid[] (depending on whether attribute allows selecting multiple collections)
Attribute attribute string/string[] (depending on whether attribute allows selecting multiple attributes)
Complex attribute object (Each property of the object corresponds to each sub attribute of the complex attribute. The value of each property then corresponds to the data type of that sub attribute)
List attribute value[] (Each value in the array represents each row in the list. The model of each row corresponds to the datatype of the row template set up on the list attribute)
LocalizedData[String]
Property name Data type Description
CultureCode string

ISO culture code of the value

Data string

The localized value