GET /browse/categories Browse categories

#Available from v.3.6.0

{
  "Page": 1,
  "TotalPages": 3,
  "Categories": [
    {
      "Id": 34,
      "Created": "2021-07-02T12:00:00+02:00",
      "LastModified": "2021-07-02T13:57:10+02:00",
      "InternalName": [
        {
          "CultureCode": "en-GB",
          "Data": "Short desc en-GB"
        },
        {
          "CultureCode": "da-DK",
          "Data": "Short desc da-DK"
        }
      ],
      "Values": {}
    }
  ]
}

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

{
  "Page": 1,
  "TotalPages": 10,
  "Products": [
    {
      "Id": 10221,
      "Created": "2021-07-02T12:00:00+02:00",
      "LastModified": "2021-07-02T13:57:10+02:00",
      "InternalName": [
        {
          "CultureCode": "en-GB",
          "Data": "Samsung UE65XXE"
        },
        {
          "CultureCode": "da-DK",
          "Data": "Samsung UE65XXE"
        }
      ],
      "Categories": [
        34,
        22
      ],
      "VariantDefiningValues": [
        "Size"
      ],
      "Values": {
        "Brand": "Samsung"
      }
    }
  ]
}

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

GET /browse/variantgroups Browse variant groups

#Available from v.3.13.14

{
  "Page": 1,
  "TotalPages": 102,
  "VariantGroups": [
    {
      "Id": 5668,
      "ProductId": 102,
      "Created": "2021-07-02T12:00:00+02:00",
      "LastModified": "2021-07-02T13:57:10+02:00",
      "InternalName": [
        {
          "CultureCode": "en-GB",
          "Data": "Samsung UE65XXE 65"
        },
        {
          "CultureCode": "da-DK",
          "Data": "Samsung UE65XXE 65"
        }
      ],
      "Values": {
        "Size": "65\""
      }
    }
  ]
}

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

{
  "Page": 1,
  "TotalPages": 102,
  "Variants": [
    {
      "Id": 5668,
      "ProductId": 102,
      "Created": "2021-07-02T12:00:00+02:00",
      "LastModified": "2021-07-02T13:57:10+02:00",
      "InternalName": [
        {
          "CultureCode": "en-GB",
          "Data": "Samsung UE65XXE 65"
        },
        {
          "CultureCode": "da-DK",
          "Data": "Samsung UE65XXE 65"
        }
      ],
      "Values": {
        "Size": "65\""
      }
    }
  ]
}

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

# Browse

GET /browse/categories Browse categories

Request parameters

Response status OK (200)

GET /browse/products Browse products

Request parameters

Response status OK (200)

GET /browse/variantgroups Browse variant groups

Request parameters

Response status OK (200)

GET /browse/variants Browse variants

Request parameters

Response status OK (200)