브랜드 소식 목록 조회

Request

브랜드 소식의 소식 목록을 조회합니다.

get

브랜드 소식의 소식 목록을 조회합니다. 브랜드 내 소식은 최대 100개까지 유지됩니다.

Authorizations

Path parameters

brandIdstringRequired

브랜드 내 정보 접근시 사용되는 브랜드ID Path Parameter 입니다.

Query parameters

offsetintegerOptional

시작 offset 번호(default: 0) 입니다.

limitintegerOptional

maxLength: 1000 - 조회 최대 건수(default: 100, maxLength: 1000) 입니다.

Header parameters

X-RCS-BrandkeystringOptional

maxLength: 36 - RCS Biz Center에서 브랜드 등록 시 자동 생성되는 Key 입니다. 대행사가 브랜드 소식 API 연동 시 Header에 반드시 설정하여야 합니다.

get

HTTPcURLJavaScriptPython

GET /bfapi/1.0/brand/{brandId}/feed HTTP/1.1
Host: api-qa.rcsbizcenter.com
Authorization: Bearer JWT
Accept: */*

Response

필드명	타입	길이	필수여부	기본값	설명
result	array<BrandFeed>		O		브랜드소식정보
code	string	5	O	20000000	리턴코드값
status	integer	3	O	200	상태값
desc	string		O		처리메시지
pagination	Pagination		O		전체건수와 페이징조건
links	Links		O		이전/다음

result - array<BrandFeed>

필드명	타입	길이	필수여부	기본값	설명
brandId	string	13	O		브랜드 ID
feedId	string	10	O		소식 ID
title	string	40	O		브랜드 소식 제목
description	string	2000	O		브랜드 소식 내용
type	string				브랜드 소식 카드 유형 (gallery, share)
status	string		O		소식의 상태값 save: 저장(최종 등록되지 않은 임시저장 상태) ok: 등록 hide: 비공개 - 숨김처리되어 목록에 비노출 delete: 논리 삭제(삭제된 소식은 수정 불가)
publishType	string		O		소식의 게시 유형 publish: 게시 - 정상 게시됨 reservation: 예약 - 지정한 일자에 소식목록에 표시되도록 예약된 소식 internet: 숨김게시 - 소식목록에 표시되지 않지만 URL을 통해 접근 가능한 소
publishDate	string				게시 일자.
pinYn	string		O	N	소식 메인 상단 고정여부.
registerDate	string				등록 일시
updateDate	string				수정 일시
updateId	string				수정 계정 ID

Pagination

필드명	타입	길이	필수여부	기본값	설명
total	integer		O		전체건수
offset	integer		O	0	조회 기준 위치
limit	integer		O	100	페이지 당 조회 건수

Links

필드명	타입	길이	필수여부	기본값	설명
prev	string		O		이전페이지URL
next	string		O		다음페이지URL

❖ response body sample

200

{
    "code": "20000000",
    "desc": null,
    "result": {
        "feedList": [
            {
                "feedId": "BR.61hBmMP164.bTt4UKL3BN",
                "brandId": "BR.61hBmMP164",
                "title": "share feed title",
                "description": "share feed discription",
                "type": "share",
                "status": "save",
                "publishType": "publish",
                "publishDate": "20201210181411",
                "pinYn": "N",
                "registerId": "swjeong75",
                "registerDate": "2024-07-04T11:00:55.000+09",
                "updateId": "swjeong75",
                "updateDate": "2024-07-04T11:00:55.000+09"
            },
            {
                "feedId": "BR.61hBmMP164.oQ6ay6aiZd",
                "brandId": "BR.61hBmMP164",
                "title": "gallery feed title",
                "description": "gallery feed discription",
                "type": "gallery",
                "status": "save",
                "publishType": "publish",
                "publishDate": "20201210181411",
                "pinYn": "N",
                "registerId": "swjeong75",
                "registerDate": "2024-07-04T10:44:21.000+09",
                "updateId": "swjeong75",
                "updateDate": "2024-07-04T10:44:21.000+09"
            }
        ]
    },
    "pagination": {
        "offset": 0,
        "limit": 100,
        "total": 2
    },
    "links": {
        "prev": null,
        "next": null
    },
    "status": 200
}

401

{
  "status": "401",
  "error": {
    "code": "61001",
    "message": "Missing Authorization header"
  }
}

{
    "error": {
        "code": "63001",
        "message": "No Brand Permission"
    },
    "status": 401
}

error code는 브랜드소식 - Response body error code 참조