List Brands

GET 
/api/v1/brands

List Brands

Request

Query Parameters

offset integer

Default value: 0

limit integer

Possible values: >= 1 and <= 100

Default value: 10

Limit result of list

Responses

200

OK

application/json

Schema

Schema

data

object[]

Brands data

Array [

brandId stringrequired

Unique identifier of the brand

description string

Brand description

name stringrequired

Brand name

]

limit integerrequired

Possible values: >= 1 and <= 100

offset integerrequired
total integerrequired

Example (from schema)

{
  "data": [
    {
      "brandId": "brand_1",
      "description": "Modern Menswear",
      "name": "Acme"
    }
  ],
  "limit": 0,
  "offset": 0,
  "total": 0
}

400

Bad request

application/json

Schema

Schema

errorCode string
message string

Example (from schema)

{
  "errorCode": "Generic",
  "message": "Bad Request"
}

401

Unauthorized

application/json

Schema

Schema

errorCode string
message string

Example (from schema)

{
  "errorCode": "Generic",
  "message": "Cannot retrieve session data because of expired token"
}

422

Validation Error

application/json

Schema

Schema

errorCode string
errors object
message string

Example (from schema)

{
  "errorCode": "Generic",
  "errors": {
    "type": [
      "Input type is not valid"
    ]
  },
  "message": "Validation error"
}

429

Rate-limiting Error

application/json

Schema

Schema

errorCode string
message string

Example (from schema)

{
  "errorCode": "Generic",
  "message": "Too many requests"
}

500

Internal Error

application/json

Schema

Schema

errorCode string
errors object
message string

Example (from schema)

{
  "errorCode": "Generic",
  "errors": {
    "system": [
      "Internal error detail message"
    ]
  },
  "message": "Internal server error"
}

Loading...