Sign in

v1

latestOpenAPI 3.0.32026-07-173196215.4 KB
brands

Get a brand

Retrieve a brand by its brandId or slug, for example, /v1/brands/123 or /v1/brands/abc

get/v1/brands/{brand}

Path parameters

brandstring required
Example:123

brandId or brand slug

Query parameters

forceSlugboolean
Example:true

When forceSlug is set to true (e.g. /v1/brands/33?forceSlug=true), the response will be the brand with the slug "33" not the brand with the ID 33.

Response

request successful

idinteger required

The unique identifier of the brand (referred as attributeId), can be used for retrieving specific brand. ID which would be used to filter for brands in the products and filters endpoint

slugstring required

short text to describe the current category (usable, for example, in URLs as fashion).

namestring required
customDataBrandCustomData required

Arbitrary custom data object to be added to the brand.

externalReferencestring required

External reference set by the client to integrate a third-party party system.

groupstring required

Brand group.

isActiveboolean required

Whether the brand is currently active or not.

logoHashstring required

Logo hash used for generating the full url.

createdAtstring required

Date string, formatted according to RFC 3339, e.g. 2018-06-01T14:56:08+02:00

updatedAtstring required

Date string, formatted according to RFC 3339, e.g. 2018-06-01T14:56:08+02:00

indexedAtstring required

Date string, formatted according to RFC 3339, e.g. 2018-06-01T14:56:08+02:00

Example response

{
  "id": 21,
  "slug": "fashion",
  "name": "Fashion",
  "customData": {
    "localizedJson": [
      {
        "key1": "value1"
      }
    ],
    "localizedString": "keyValue"
  },
  "createdAt": "2023-01-26T09:30:15+00:00",
  "updatedAt": "2023-01-26T09:30:15+00:00",
  "indexedAt": "2023-01-26T09:30:15+00:00"
}