정산확정일 기준으로 '상품 구매결정'과 '기타정산'의 확정데이터를 합산한 '최종정산금액(=지급예정액)'을 제공합니다.
정산확정 당일 오전 9시부터 조회 가능하며, 데이터 대사 등의 상황으로 +/- 시간편차는 존재할 수 있습니다.
* 공통헤더영역의 channel-ids을 통해 채널별 검색이 가능합니다.
채널ID는 1(선물하기), 101(톡스토어)로 설정 가능하며, 채널값을 입력하지 않을 경우 정산 데이터 조회가 불가한 점 참고 부탁드립니다.
요청
GET /v1/shopping/settlement/total-confirms?page=0&size500&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 | SettlementConfirmPeriodType | O |
SETTLEMENT_CONFIRM_DATE(정산확정일) |
| startDate | String | O | 시작일 (YYYY-MM-DD) |
| endDate | String | O | 종료일 (YYYY-MM-DD) (최대 31일) |
응답
<응답바디>
| 필드명 | 타입 | 설명 |
|---|---|---|
| channelName | String | 채널 |
| sellerId | Long | 판매자번호 |
| sellerName | String | 판매자명 |
| productStandardAmount | BigDecimal | 상품주문금액 |
| sellerDiscountAmount | BigDecimal | 판매자할인금액(-) |
| settlementBaseAmount | BigDecimal |
정산기준금액 : ‘구매결정일’ 또는 ‘구매결정 후 취소/환불일’ |
| deliveryAmount | BigDecimal | 선불배송비(+) |
| returnDeliveryAmount | BigDecimal | 반품배송비(+) |
| commissionTotalAmount | BigDecimal |
수수료합계 : 주문 건에 대해 산정된 최종수수료
= 기본수수료+추가수수료 |
| settlementConfirmAmount | BigDecimal |
판매정산금액 : 주문 건에 대해 산정된 정산금액
= 정산기준금액-수수료합계 |
| etcPlusAmount | BigDecimal | 기타정산(+) |
| etcMinusAmount | BigDecimal | 기타공제(-) |
| sellerMoneyAmount | BigDecimal |
마이너스 셀러머니 공제(-) : 취소/환불 등으로 인해 발생한 마이너스를 정산대금 발생 시 상계하는 공제금액 |
| pointRewardAmount | BigDecimal |
포인트리워드금액합계(-) : 명품 구매 고객에게 지급하는 판매자부담 포인트금액 |
| settlementTotalConfirmAmount | BigDecimal |
최종정산금액 : 구매결정된 판매정산금액과 기타 금액 등을 모두 합한 최종 지급금액
= 판매정산금액+기타정산-기타공제-마이너스셀러머니공제-포인트리워드 |
| settlementStatus | SettlementStatus | 상태 |
| settlementTermType | SettlementTermType | 정산주기 |
| settlementConfirmDate | String |
정산확정일 : 정산주기에 따라 판매대금이 확정되는 일자 - 톡스토어(일1회) : 정산기준일+1일+1영업일 - 선물하기(월1회) : 정산기준일 당월 1일~말일 => 다음월 1일 - 선물하기(월2회) : 정산기준일 당월 1일~15일 => 당월 16일 정산기준일 당월 16일~말일 => 다음월 1일 |
| sendCompleteDate | String | 송금완료일 |
| payAmount | BigDecimal | 결제금액(+) |
| orderAdminTotalDiscountAmount | BigDecimal | 카카오할인금액합계 |
예시
<응답성공>
- 요청
GET /v1/shopping/settlement/total-confirms?periodType=SETTLEMENT_CONFIRM_DATE
&startDate=2023-07-01&endDate=2023-08-01
HTTP/1.1
Content-type: application/json
- 응답값
{
"contents": [
{
"channelName": "선물하기",
"sellerId": 10000582,
"sellerName": "테스트셀러02",
"productStandardAmount": 10000,
"sellerDiscountAmount": 0,
"settlementBaseAmount": 10000,
"deliveryAmount": 0,
"returnDeliveryAmount": 6000,
"commissionTotalAmount": 1000,
"settlementConfirmAmount": 15000,
"etcPlusAmount": 0,
"etcMinusAmount": 0,
"sellerMoneyAmount": 0,
"pointRewardAmount": 0,
"settlementTotalConfirmAmount": 15000,
"settlementStatus": "SendPrepare",
"settlementTermType": "Monthly",
"settlementConfirmDate": "2023-07-01",
"sendCompleteDate": "2023-07-07",
"payAmount": 16000,
"orderAdminTotalDiscountAmount": 0
}
],
"last": true,
"totalCount": 1,
"condition": {
"page": 0,
"size": 500,
"startDate": "2023-07-10",
"endDate": "2023-08-01",
"periodType": "SETTLEMENT_CONFIRM_DATE"
}
}