Skip to content

Brands

Managing brands in the e-shop.

Please note, the field code is deprecated - use indexName instead. Parameter code accepts both:

guid string style, e.g. d467bfbe-4334-11ef-ad70-0242ac1f0005, and index name string style, e.g. willy-wonka.

The index name string style is deprecated - use guid style.

Operations

List of brands

Request

Returns the list of brands. Supports the Paging

Security
shoptetAccessToken or shoptetPrivateApiToken
Query
itemsPerPageinteger

Returned items per page. Default value is 500. Max value is 1000.

Example:itemsPerPage=888
pageinteger

Page number to return. Default value is 1.

Example:page=3
Headers
Content-Typestringrequired
Default:"application/json"
curl -i -X GET \
  'https://api.docs.shoptet.com/_mock/shoptet-api/openapi/api/brands?itemsPerPage=888&page=3' \
  -H 'Content-Type: application/json' \
  -H 'Shoptet-Access-Token: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/json
dataobjectrequired
errorsArray of objects or null(Errors)required
metadataobject(Metadata)required
Response
{
  "data": {
    "brands": [ … ],
    "paginator": { … }
  },
  "errors": [
    { … }
  ],
  "metadata": {
    "requestId": "019c8c34-64f3-7328-af43-bf1e34fa39d7"
  }
}