리터니즈 API 기술문서

리터니즈(Returneeds)는 브랜드(고객사)의 반품 수거 → 검품 → 출고를 대행하는 반품 물류 서비스입니다. 이 문서는 고객사 시스템(브랜드 BO, 쇼핑몰 등)이 리터니즈와 연동하기 위한 REST API 명세입니다.

정보

본 문서는 향후 내용이 변경될 수 있으며, 접근권한에 따라 해당 API 이용이 제한될 수 있습니다. 우측 상단 버전 드롭다운에서 배포된 규격서 버전을 선택할 수 있고, 변경 이력은 Changelog에서 확인합니다.

문서 구성

섹션	리소스	설명
0. 접속 및 인증	—	도메인, API KEY 발급 및 인증 헤더
1. 브랜드	`/api/ecommerce/`	반품 상품을 판매한 브랜드(쇼핑몰/판매 서비스) 조회·생성·수정, 반품지 연결
3. 반품지	`/api/return-address/`	브랜드의 반품 배송지 수정
19. 일반회원 주문	`/api/bmrmember-order/`	반품 주문 접수·조회·취소·재접수, 반품 아이템·출고 박스 상태
20. 배송	`/api/logis/status/`	주문/출고 박스 배송 상태 조회

모든 요청은 Api-Key 헤더로 인증합니다. → 접속 및 인증
응답은 JSON이며, 처리 결과는 status 필드(SUCCESS / FAIL / NOT_FOUND)와 실패 시 err_code로 구분합니다.
일시(DateTime) 값은 ISO 8601 형식이며 한국 표준시(KST, +09:00)로 회신됩니다.
상태값(코드)은 소문자 영문 코드로 전달됩니다. 각 코드의 의미는 해당 필드 표의 비고를 참조하세요.

브랜드(ecommerce): 리터니즈 내 고유 식별값은 3자리 알파벳 ecommerceId. 하위 브랜드는 parentEcommerceId로 상위 브랜드와 연결됩니다.
주문(Order): 접수 시 bulkNumber(주문번호)가 자동 채번됩니다. orderNumber(송장번호)는 고유값이 아닙니다.
반품 아이템(ReturnItem): 주문에 포함된 반품 상품. quantityOrder > 1로 접수하면 수량만큼 아이템(itemCode)이 분할 생성됩니다.
출고 박스(OutBox): 검품 완료된 아이템을 고객사 반품지로 보내는 운송 단위.