구매결정된 주문 건들에 대해 주문번호 단위의 기간별 상세 정보를 제공합니다.
구매결정일+1일 오전 9시부터 조회 가능하며, 데이터 대사 등의 상황으로 +/- 시간편차는 존재할 수 있습니다.
* 공통헤더영역의 channel-ids을 통해 채널별 검색이 가능합니다.
채널ID는 1(선물하기), 101(톡스토어)로 설정 가능하며, 채널값을 입력하지 않을 경우 정산 데이터 조회가 불가한 점 참고 부탁드립니다.
요청
GET /v1/shopping/settlement/details?page=0&size=500&periodType=SETTLEMENT_BASE_DATE
&startDate={YYYY-MM-DD}&endDate={YYYY-MM-DD}
HTTP/1.1
Content-type: application/json| 키 | 타입 | 필수여부 | 설명 |
|---|---|---|---|
| page | Integer | X | 요청 페이지 번호. 기본값 1 |
| size | Integer | X | 요청 페이지당 데이터 수. 기본값 500 최대 1000 |
| periodType | SettlementPeriodType | 필수 | SETTLEMENT_BASE_DATE(정산기준일) / SETTLEMENT_CONFIRM_DATE(정산확정일) |
| startDate | String | 필수 | 시작일 (YYYY-MM-DD) |
| endDate | String | 필수 | 종료일 (YYYY-MM-DD) |
응답
<응답바디>
| 필드명 | 타입 | 설명 |
|---|---|---|
| paymentId | Long | 결제번호 |
| originDeliveryAmountId | Long | 최초배송비번호 |
| orderId | Long | 주문번호 |
| settlementType | SettlementType | 주문상태 |
| settlementTermType | SettlementTermType | 정산주기 |
| settlementBaseDate | String |
정산기준일 : ‘구매결정일’ 또는 ‘구매결정 후 취소/환불일’ |
| settlementConfirmDate | String |
정산확정일 : 정산주기에 따라 판매대금이 확정되는 일자
- 톡스토어(일1회) : 정산기준일+1일+1영업일 - 선물하기(월1회) : 정산기준일 당월 1일~말일 => 다음월 1일 - 선물하기(월2회) : 정산기준일 당월 1일~15일 => 당월 16일 정산기준일 당월 16일~말일 => 다음월 1일 |
| channelName | String | 채널 [선물하기/톡스토어] |
| productItemId | Long | 상품번호 |
| productName | String | 상품명 |
| sellerId | Long | 판매자번호 |
| sellerName | String | 판매자명 |
| payMainMethod | PayMainMethod | 결제수단 |
| productStandardAmount | BigDecimal | 상품주문금액 |
| sellerDiscountAmount | BigDecimal | 판매자할인금액 |
| settlementBaseAmount | BigDecimal |
정산기준금액 : 수수료를 산정하는 기준금액
= 상품주문금액-판매자할인금액 |
| deliveryAmount | BigDecimal | 선불배송비 |
| returnDeliveryAmount | BigDecimal | 반품배송비 |
| orderQuantity | Long | 수량 |
| commissionTotalRate | BigDecimal | 수수료율합계 |
| commissionTotalAmount | BigDecimal |
수수료합계 : 주문 건에 대해 산정된 최종수수료
= 기본수수료+추가수수료 |
| settlementConfirmAmount | BigDecimal |
판매정산금액 : 주문 건에 대해 산정된 정산금액
= 정산기준금액-수수료합계 |
| orderAdminTotalDiscountAmount | BigDecimal | 카카오할인금액 |
예시
<응답성공>
- 요청
GET /v1/shopping/settlement/details?page=0&size=500&periodType=SETTLEMENT_BASE_DATE
&startDate=2023-06-20&endDate=2023-07-20
HTTP/1.1
Content-type: application/json
- 응답값
{
"contents": [
{
"paymentId": 3000100891,
"originDeliveryAmountId": 1410965,
"orderId": 3000126952,
"settlementType": "DeliveryItemDecision",
"settlementTermType": "Monthly",
"settlementBaseDate": "2023-06-21",
"settlementConfirmDate": "2023-07-01",
"channelName": "선물하기",
"productItemId": "1015696",
"productName": "[API테스트]선물하기_1회_일반판매자_에이전시X",
"sellerId": 10000582,
"sellerName": "테스트셀러02",
"payMainMethod": "Card",
"productStandardAmount": 10000,
"sellerDiscountAmount": 0,
"settlementBaseAmount": 10000,
"deliveryAmount": 0,
"returnDeliveryAmount": 0,
"orderQuantity": 1,
"commissionTotalRate": 10,
"commissionTotalAmount": 1000,
"settlementConfirmAmount": 9000,
"orderAdminTotalDiscountAmount": 0
},
{
"paymentId": 3000101629,
"originDeliveryAmountId": 1411566,
"orderId": null,
"settlementType": "DeliveryAmountDecision",
"settlementTermType": "Monthly",
"settlementBaseDate": "2023-06-29",
"settlementConfirmDate": "2023-07-01",
"channelName": "선물하기",
"productItemId": null,
"productName": null,
"sellerId": 10000582,
"sellerName": "9999922222",
"payMainMethod": "Card",
"productStandardAmount": 0,
"sellerDiscountAmount": 0,
"settlementBaseAmount": 0,
"deliveryAmount": 0,
"returnDeliveryAmount": 6000,
"orderQuantity": 0,
"commissionTotalRate": 0,
"commissionTotalAmount": 0,
"settlementConfirmAmount": 6000,
"orderAdminTotalDiscountAmount": 0
}
],
"last": true,
"totalCount": 2,
"condition": {
"page": 0,
"size": 500,
"startDate": "2023-06-20",
"endDate": "2023-07-20",
"periodType": "SETTLEMENT_CONFIRM_DATE"
}
}