Browse

The browse endpoints allows external partners access to a specified dataset within the PIM system

Browse products

get

#Available from v.3.6.0

Authorizations

Query parameters

pageinteger · int32Optional

Page number

Default: 1

lastModifiedAfterstring · date-timeOptional

Request only entities modified after the provided timestamp

Responses

200

OK

text/plainapplication/jsontext/json

get

HTTPcURLJavaScriptPython

GET /v1/browse/products HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200

OK

{
  "Page": 1,
  "TotalPages": 1,
  "Products": [
    {
      "Id": 1,
      "Created": "2025-05-09T11:09:34.289Z",
      "LastModified": "2025-05-09T11:09:34.289Z",
      "InternalName": [
        {
          "CultureCode": "text",
          "Data": "text"
        }
      ],
      "Categories": [
        1
      ],
      "VariantDefiningValues": [
        "text"
      ],
      "Values": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      }
    }
  ]
}

Browse variants

get

#Available from v.3.6.0

Authorizations

Query parameters

pageinteger · int32Optional

Page number

Default: 1

lastModifiedAfterstring · date-timeOptional

Request only entities modified after the provided timestamp

Responses

200

OK

text/plainapplication/jsontext/json

get

HTTPcURLJavaScriptPython

GET /v1/browse/variants HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200

OK

{
  "Page": 1,
  "TotalPages": 1,
  "Variants": [
    {
      "Id": 1,
      "ProductId": 1,
      "Created": "2025-05-09T11:09:34.289Z",
      "LastModified": "2025-05-09T11:09:34.289Z",
      "InternalName": [
        {
          "CultureCode": "text",
          "Data": "text"
        }
      ],
      "Values": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      }
    }
  ]
}

Browse variant groups

get

#Available from v.3.13.14

Authorizations

Query parameters

pageinteger · int32Optional

Page number

Default: 1

lastModifiedAfterstring · date-timeOptional

Request only entities modified after the provided timestamp

Responses

200

OK

text/plainapplication/jsontext/json

get

HTTPcURLJavaScriptPython

GET /v1/browse/variantgroups HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200

OK

{
  "Page": 1,
  "TotalPages": 1,
  "VariantGroups": [
    {
      "Id": 1,
      "ProductId": 1,
      "Created": "2025-05-09T11:09:34.289Z",
      "LastModified": "2025-05-09T11:09:34.289Z",
      "InternalName": [
        {
          "CultureCode": "text",
          "Data": "text"
        }
      ],
      "Values": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      }
    }
  ]
}

Browse categories

get

#Available from v.3.6.0

Authorizations

Query parameters

pageinteger · int32Optional

Page number

Default: 1

lastModifiedAfterstring · date-timeOptional

Request only entities modified after the provided timestamp

Responses

200

OK

text/plainapplication/jsontext/json

get

HTTPcURLJavaScriptPython

GET /v1/browse/categories HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200

OK

{
  "Page": 1,
  "TotalPages": 1,
  "Categories": [
    {
      "Id": 1,
      "ParentId": 1,
      "Created": "2025-05-09T11:09:34.289Z",
      "LastModified": "2025-05-09T11:09:34.289Z",
      "InternalName": [
        {
          "CultureCode": "text",
          "Data": "text"
        }
      ],
      "Values": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      }
    }
  ]
}