기타정산/공제 조회 API는 '상품 구매결정 외 기타 케이스'의 상세 데이터를 제공합니다. (ex. CS상품대금, 정산보정 등)
등록 시점부터 조회 가능하며, 데이터 대사 등의 상황으로 +/- 시간편차는 존재할 수 있습니다.
* 공통헤더영역의 channel-ids을 통해 채널별 검색이 가능합니다.
채널ID는 1(선물하기), 101(톡스토어)로 설정 가능하며, 채널값을 입력하지 않을 경우 정산 데이터 조회가 불가한 점 참고 부탁드립니다.
요청
GET /v1/shopping/settlement/adjustments?page=0&size=500&startDate={YYYY-MM-DD}
&endDate={YYYY-MM-DD}&periodType=SETTLEMENT_CONFIRM_DATE
HTTP/1.1
Content-type: application/json| 키 | 타입 | 필수여부 | 설명 |
|---|---|---|---|
| page | String | X | 요청 페이지 번호. 기본값 1 |
| size | String | X | 요청 페이지 당 데이터수. 기본값 500 최대값 1000 |
| periodType | SettlementEtcPeriodType | O | SETTLEMENT_BASE_DATE(정산기준일) SETTLEMENT_CONFIRM_DATE(정산확정일) |
| startDate | String | O | 시작일 (YYYY-MM-DD) |
| endDate | String | O | 종료일 (YYYY-MM-DD) (최대 31일) |
응답
<응답바디>
| 필드명 | 타입 | 설명 |
|---|---|---|
| channelName | String | 채널 [선물하기/톡스토어] |
| settlementConfirmDate | String |
정산확정일 : 정산주기에 따라 판매대금이 확정되는 일자
- 톡스토어(일1회) : 정산기준일+1일+1영업일 - 선물하기(월1회) : 정산기준일 당월 1일~말일 => 다음월 1일 - 선물하기(월2회) : 정산기준일 당월 1일~15일 => 당월 16일 정산기준일 당월 16일~말일 => 다음월 1일 |
| sellerId | Long | 판매자번호 |
| sellerName | String | 판매자명 |
| etcType | EtcType | 구분 |
| etcReason | String | 사유 |
| kakaoComment | String | 카카오관리자 메모 |
| etcPlusAmount | BigDecimal | 정산금액(+) |
| etcMinusAmount | BigDecimal | 공제금액(-) |
| orderId | Long | 주문번호 |
| etcCommissionPlusAmount | BigDecimal | 수수료매출 추가 |
| etcCommissionMinusAmount | BigDecimal | 수수료매출 취소 |
| etcAdminDiscountPlusAmount | BigDecimal | 카카오할인 추가 |
| etcAdminDiscountMinusAmount | BigDecimal | 카카오할인 취소 |
| settlementBaseDate | String | 정산기준일(등록일) |
예시
<응답성공>
- 요청
GET /v1/shopping/settlement/adjustments?
periodType=SETTLEMENT_BASE_DATE&startDate=2024-01-10&endDate=2024-02-01
HTTP/1.1
Content-type: application/json
- 응답값
{
"contents": [
{
"channelName": "선물하기",
"settlementConfirmDate": "2024-02-01",
"sellerId": 10000582,
"sellerName": "API테스트",
"etcType": "EtcPlus",
"etcReason": "CS 상품대금",
"kakaoComment": "대금지급현황 상태 업데이트 테스트",
"orderId": null,
"settlementBaseDate": "2024-01-29",
"etcCommissionMinusAmount": 0,
"etcPlusAmount": 200,
"etcMinusAmount": 0,
"etcCommissionPlusAmount": 0,
"etcAdminDiscountPlusAmount": 0,
"etcAdminDiscountMinusAmount": 0
}
],
"last": true,
"totalCount": 1,
"condition": {
"page": 0,
"size": 500,
"startDate": "2024-01-10",
"endDate": "2024-02-01",
"periodType": "SETTLEMENT_BASE_DATE"
}
}