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

ApiKey

AuthorizationstringRequired

Query parameters

pageinteger · int32Optional

Page number

Default: 1

lastModifiedAfterstring · date-timeOptional

Request only entities modified after the provided timestamp

includeArchivedbooleanOptional

Include archived products

Default: false

renderValuesbooleanOptional

Return rendered values instead of object representations

Default: false

Responses

200

OK

application/json

Browse products result set

Pageinteger · int32Optional

Page number

TotalPagesinteger · int32Optional

Total pages

get

/v1/browse/products

HTTPcURLJavaScriptPython

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

200

OK

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

Browse variants

get

#Available from v.3.6.0

Authorizations

ApiKey

AuthorizationstringRequired

Query parameters

pageinteger · int32Optional

Page number

Default: 1

lastModifiedAfterstring · date-timeOptional

Request only entities modified after the provided timestamp

includeArchivedbooleanOptional

Include archived variants

Default: false

renderValuesbooleanOptional

Return rendered values instead of object representations

Default: false

Responses

200

OK

application/json

Browse variants result set

Pageinteger · int32Optional

Page number

TotalPagesinteger · int32Optional

Total pages

get

/v1/browse/variants

HTTPcURLJavaScriptPython

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

200

OK

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

Browse variant groups

get

#Available from v.3.13.14

Authorizations

ApiKey

AuthorizationstringRequired

Query parameters

pageinteger · int32Optional

Page number

Default: 1

lastModifiedAfterstring · date-timeOptional

Request only entities modified after the provided timestamp

includeArchivedbooleanOptional

Include archived variant groups

Default: false

renderValuesbooleanOptional

Return rendered values instead of object representations

Default: false

Responses

200

OK

application/json

Browse variant groups result set

Pageinteger · int32Optional

Page number

TotalPagesinteger · int32Optional

Total pages

get

/v1/browse/variantgroups

HTTPcURLJavaScriptPython

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

200

OK

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

Browse categories

get

#Available from v.3.6.0

Authorizations

ApiKey

AuthorizationstringRequired

Query parameters

pageinteger · int32Optional

Page number

Default: 1

lastModifiedAfterstring · date-timeOptional

Request only entities modified after the provided timestamp

renderValuesbooleanOptional

Return rendered values instead of object representations

Default: false

Responses

200

OK

application/json

Browse categories result set

Pageinteger · int32Optional

Page number

TotalPagesinteger · int32Optional

Total pages

get

/v1/browse/categories

HTTPcURLJavaScriptPython

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

200

OK

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