> For the complete documentation index, see [llms.txt](https://tech.x2bee.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://tech.x2bee.com/api/api-en/back-office-api-reference/popup-bo-api/brand-common-popup.md).

# Brand Common Popup

## Retrieve Brand List

> \## Function Description\
> \* Retrieves the brand list.\
> \---\
> \## Detailed Description\
> \* Retrieves the brand list according to the search conditions.<br>

```json
{"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"servers":[{"url":"https://api-bo.x2bee.com/api/bo/","description":"prd"}],"security":[{"accessToken":[]}],"paths":{"/v1/popup/brandPopupApi/getBrandList":{"get":{"tags":["Brand Common Popup"],"summary":"Retrieve Brand List","description":"## Function Description\n* Retrieves the brand list.\n---\n## Detailed Description\n* Retrieves the brand list according to the search conditions.\n","operationId":"getBrandList","parameters":[{"name":"request","in":"query","required":true,"schema":{"$ref":"#/components/schemas/BrandPopupApiRequest"}}],"responses":{"200":{"description":"Retrieve Brand List Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResponseRealGridListResponseBrandPopupApiResponse"}}}},"900":{"description":"Retrieve Brand List Failure","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorCode"}}}}}}}},"components":{"schemas":{"BrandPopupApiRequest":{"type":"object","properties":{"argUseYn":{"type":"string","description":"Usage Status"},"brandNo":{"type":"string","description":"Brand No."},"brandNm":{"type":"string","description":"Brand Name"},"useYn":{"type":"string","description":"Usage Status"}}},"ResponseRealGridListResponseBrandPopupApiResponse":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time","description":"result time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"$ref":"#/components/schemas/RealGridListResponseBrandPopupApiResponse","description":"payload"},"error":{"type":"boolean","description":"is error"},"errors":{"type":"array","description":"validation error list","items":{"$ref":"#/components/schemas/ValidationError"}}}},"RealGridListResponseBrandPopupApiResponse":{"type":"object","properties":{"totalCount":{"type":"integer","format":"int32"},"payloads":{"type":"array","items":{"$ref":"#/components/schemas/BrandPopupApiResponse"}}}},"BrandPopupApiResponse":{"type":"object","properties":{"brandNo":{"type":"string","description":"Brand No."},"useYn":{"type":"string","description":"Usage Status"},"brandNm":{"type":"string","description":"Brand Name"},"schKwdNm":{"type":"string","description":"Search Keyword"},"totalCount":{"type":"integer","format":"int32"}}},"ValidationError":{"type":"object","properties":{"field":{"type":"string","description":"field"},"message":{"type":"string","description":"field message"}}},"ErrorCode":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"httpStatus":{"type":"integer","format":"int32"},"isProcess":{"type":"boolean"}}}}}}
```