상품연동 시 브랜드 정보 전송을 위한 조회 api 입니다.
브랜드명 혹은 브랜드 ID로 일치하는 브랜드가 있을 경우에만 조회 가능합니다.
브랜드 검색 요청은 페이징을 지원하지 않습니다.
브랜드 단위로 계약한 판매자의 경우, 계약된 브랜드만 조회 결과에 노출됩니다.
요청
GET /v1/gift/brands/search?id={id}
GET /v1/gift/brands/search?name={name}
<요청 파라미터 설명>
필드명 | 타입 | 필수여부 | 설명 |
---|---|---|---|
id | Long | 선택 | 브랜드ID |
name | String | 선택 | 브랜드명 |
응답
요청이 성공하면, 응답 바디에 브랜드가 조회 됩니다.
조회 조건에 해당하지 않는 경우 contents 에 빈 목록이 조회 됩니다.
<응답 바디>
필드명 | 타입 | 설명 |
---|---|---|
contents | Array |
브랜드 목록 id: 브랜드ID name: 브랜드명 |
totalCount | String | 전체 수 |
last | Long | 마지막 페이지 여부 |
<응답 바디 샘플>
정상 응답
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
{
"contents": [
{
"id": 2,
"name": "버거킹"
}
],
"totalCount": 1,
"last": true
}
계약하지 않는 브랜드를 조회할 경우
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
{
"contents": [
{
"errorMessage": "수수료 계약 정보를 찾을 수 없습니다."
}
],
"totalCount": 1,
"last": true
}