Search product brands

GET https://app.ecwid.com/api/v3/{storeId}/brands

Request and response example

Request:

GET /api/v3/1003/brands HTTP/1.1
Authorization: Bearer secret_token
Host: app.ecwid.com

Response:

{
  "total": 4,
  "limit": 0,
  "count": 4,
  "offset": 0,
  "items": [
    {
      "name": "BRANDING3",
      "productsFilteredByBrandUrl": "https://example.company.site/products/search?attribute_Brand=BRANDING3"
    },
    {
      "name": "Branding4",
      "productsFilteredByBrandUrl": "https://example.company.site/products/search?attribute_Brand=Branding4"
    },
    {
      "name": "HIDDEN ONE",
      "productsFilteredByBrandUrl": "https://example.company.site/products/search?attribute_Brand=HIDDEN+ONE"
    },
    {
      "name": "branding2",
      "productsFilteredByBrandUrl": "https://example.company.site/products/search?attribute_Brand=branding2"
    }
  ]
}

Required access scopes

Your app must have the following access scopes to make this request: read_brands

Path params

All path params are required.

Param	Type	Description
storeId	number	Ecwid store ID.

Query params

All query params are optional.

Name	Type	Description
limit	number	Limit to the number of returned items. Maximum and default value (if not specified) is 100.
offset	number	Offset from the beginning of the returned items list. Used when the response contains more items than limit allows to receive in one request. Usually used to receive all items in several requests with multiple of a hundred, for example: ?offset=0 for the first request, ?offset=100, for the second request, ?offset=200, for the third request, etc.
sortBy	string	Sorting order for the results. One of: PRODUCT_COUNT_DESC (default) PRODUCT_COUNT_ASC NAME_DESC NAME_ASC
hidden_brands	boolean	Defines if the response should contain brands of disabled products. Set true to get such brands. Default value: false
lang	string	Language ISO code for translations in JSON response, e.g. en, fr. Translates fields like: title, description, pickupInstruction, text, etc. If not specified, the default store language is used.
baseUrl	string	Set base URL for URLs in response. If not specified, Ecwid will use the main URL from store settings.
cleanURLs	boolean	Set true to force receiving clean URLs – catalog links without hashbang (/#!/). By default Ecwid checks if this setting is enabled for the store and responds with matching URLs.

Headers

The Authorization header is required.

Header	Format	Description
Authorization	Bearer secret_ab***cd	Access token of the application.

Response JSON

A JSON object with the following fields:

Field	Type	Description
total	number	Total number of found items (might be more than the number of returned items).
count	number	Total number of items returned in the response.
offset	number	Offset from the beginning of the returned items list specified in the request.
limit	number	Maximum number of returned items specified in the request. Maximum and default value: 100.
items	array of objects items	Detailed information about returned brands.

items

Field	Type	Description
name	string	Brand name visible on the storefront.
nameTranslated	object translations	Available translations for the brand name.
productsFilteredByBrandUrl	string	Link to your website's search page with applied brand filter. Page will show all products related to the brand.

translations

Object with text field translations in the "lang": "text" format, where the "lang" is an ISO 639-1 language code. For example:

{
    "en": "Sample text",
    "nl": "Voorbeeldtekst"
}

Translations are available for all active store languages. Only the default language translations are returned if no other translations are provided for the field. Find active store languages with GET /profile request > languages > enabledLanguages.