Skip to main content

Get Brands​

Use this API to retrieve a full list of brands.

Query Parameters
  • page number

    Default value: 1

    By default first page will be listed. For navigating through pages, use the page parameter.

  • limit number

    Default value: 20

    The number of results to return per request.

  • id number[]

    Unique identifier of the brand.

  • slug string[]

    A common or friendly name for the brand, should be in lowercase.

Responses

Success response

{
  "statusCode": 200,
  "data": {
    "results": [
      {
        "_id": 33,
        "name": "KFC Chicken",
        "slug": "kfc-chicken",
        "logoUrl": "imageUrl"
      }
    ],
    "pagination": {
      "currentPage": 1,
      "lastPage": 1,
      "perPage": 20,
      "totalResults": 3
    }
  }
}
GET /ecommerce/v1/brands

Authorization

type: oauth2flow: clientCredentialsscopes: brand:read

Request

Bearer Token
page — query
limit — query
id — query
slug — query
curl -L -X GET 'https://posbytz.github.io/ecommerce/v1/brands' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'