v1

latestOpenAPI 3.0.12026-08-062555238.4 KB
Store API endpoints

List brands

Use this endpoint to view all the brands that you've created.

get/brands

Query parameters

page_numberinteger
Example:2

The page number required

page_sizeinteger

Number of brands in one page

Headers

Authorizationstring required
User-Agentstring required

Response

Brands retrieved successfully

Example response

{
  "data": [
    {
      "id": "123004",
      "name": "KFC",
      "state": "MAPPED",
      "created_at": "2020-06-22T15:01:32.895Z",
      "updated_at": "2020-06-22T15:01:32.895Z"
    }
  ],
  "meta": {
    "total": 90,
    "page_size": 20,
    "page_number": 1
  },
  "links": {
    "prev": "URL/api/brands?page_number=1",
    "next": "URL/api/brands?page_number=3"
  }
}