1.1. ecommerce GET

팁

브랜드 목록을 조회

GET[DOMAIN]/api/ecommerce/

• Headers: Api-Key: {APIKEY}

반환값

필드	설명
count	전체 조회건수
next	다음 페이지, 없을 경우 null
previous	이전 페이지, 없을 경우 null
lastPage	마지막 페이지 번호
current	현재 조회 페이지의 조회건수
countItemsOnPage	페이지 당 건수
currentPage	현재 페이지 번호
results	브랜드 목록 (아래 표)

results

파라미터 명	데이터 타입	값	비고
id	Integer	id
ecommerceId	String	브랜드 ID	알파벳 3자리, 리터니즈 내 고유 식별값
name	String	브랜드명
url	Text	브랜드 URL
isInspection	Boolean	검수여부: true / false
isUsePickupService	Boolean	수거 서비스 사용 여부 (기본값 true)	false인 브랜드는 주문 접수 시 픽업지 정보(pickupName/pickupAddress/pickupContact)가 필수가 아니며, 운송사 회수 자동 접수 대상에서 제외됨 (BMR-845)
returnAddress	Array	반품지	반품지 항목 배열
owner_account	Object	브랜드 소유 사업자 계정	id, accountType, companyName, bizNo
createdAt	DateTime	브랜드 생성일시
updatedAt	DateTime	브랜드 수정일시
deletedAt	DateTime	브랜드 삭제일시

호출 예제

{
  "id": 18,
  "ecommerceId": "AAA",
  "name": "브랜드 A",
  "url": "https://brand-a.example.com",
  "isInspection": false,
  "isUsePickupService": true,
  "returnAddress": [
    {
      "id": 2,
      "location": "wh",
      "address": "경기도 군포시 ...",
      "addressDetail": "G동 2층",
      "postalCode": "15878",
      "createdAt": "2023-06-14T12:51:05.507181+09:00",
      "updatedAt": "2023-06-14T12:51:05.507191+09:00",
      "deletedAt": null
    }
  ],
  "owner_account": null,
  "createdAt": "2023-06-20T14:30:52.466408+09:00",
  "updatedAt": "2023-06-20T14:30:52.466418+09:00",
  "deletedAt": null
}