클레임

굿웨어몰 클레임 처리를 위한 다양한 API를 제공하고 있습니다.

POST/v1/claim/list

1. 클레임 목록 조회

굿웨어몰 클레임 목록을 검색할 수 있습니다. 기본적으로 페이지당 최대 50 개의 주문이 표시됩니다.

필수 파라미터

Enum
dateType
Children
검색일자 유형
Type
enum
Name
fromDate
Children
클레임 조회 일시 (시작) - YYYYMMDD
Type
string
Name
toDate
Children
클레임 조회 일시 (종료) - YYYYMMDD
Type
string

옵션 파라미터

Enum
clmTp
Children
클레임 유형
Type
enum
Name
pageNo
Children
조회 페이지
Type
int
Name
limitCnt
Children
페이지당 표시 개수
Type
int

응답 모델

프로퍼티명	설명	타입	상위객체
data	클레임 목록	Array	N/A
clmNo	클레임 번호	String	data
clmWrhsGodTurn	클레임 상품 순번	Number	data
ordNo	주문 번호	String	data
ordGodTurn	주문 상품 순번	Number	data
ordDt	주문 일시	String	data
clmDt	클레임 생성 일시	String	data
rceptDt	클레임 접수일	String	data
comptDt	클레임 완료일	String	data
clmTpCd	클레임 유형 코드	String	data
clmTpNm	클레임 유형 코드명	String	data
clmStatCd	클레임 상태 코드	String	data
clmStatNm	클레임 상태 코드명	String	data
clmResnCd	클레임 사유 코드	String	data
clmResnNm	클레임 사유 코드명	String	data
clmResnCont	클레임 사유 상세	String	data
rfdStatCd	환불 상태 코드	String	data
rfdStatNm	환불 상태 코드명	String	data
rfdAmt	환불 총 금액	Number	data
mbrId	회원ID	String	data
cstmrNm	고객명	String	data
cstmrEmail	고객 이메일	String	data
cstmrMobilNo	고객 휴대전화번호	String	data
cstmrTelNo	고객 전화번호	String	data
ordQty	주문 수량	Number	data
clmQty	클레임 수량	Number	data
clmWthdrawQty	클레임 철회 수량	Number	data
saleAmt	판매 금액	Number	data
ordDcAmt	주문 할인 금액	Number	data
godDcAmt	상품 할인 금액	Number	data
cpnDcAmt	쿠폰 할인 금액	Number	data
pointUseAmt	포인트 사용 금액	Number	data
realAmt	실결제 금액	Number	data
rtnDlvCst	반품 배송비 (정책 배송비)	Number	data
rtnDlvCstCpnDcAmt	반품 배송비 할인 금액 (배송비 쿠폰 할인금액)	Number	data
rtnRealityDlvCst	반품 실 배송비	Number	data
rtnDlvCstAddAmt	반품 추가 배송비 (+ 도서산간)	Number	data
rtnAddrseNm	반품 수거지명	String	data
rtnAddrseTelNo	반품 수거지 연락처	String	data
rtnAddrseMobilNo	반품 수거지 휴대전화번호	String	data
rtnAddrseBaseAddr	반품 수거지 기본주소	String	data
rtnAddrseDetailAddr	반품 수거지 상세주소	String	data
rtnAddrsePostNo	반품 수거지 우편번호	String	data
exchgOrdQty	교환 출고 수량	Number	data
exchgDlvCst	교환 배송비 (정책 배송비)	Number	data
exchgDlvCstCpnDcAmt	교환 배송비 할인 금액 (배송비 쿠폰 할인금액)	Number	data
exchgRealityDlvCst	교환 실 배송비	Number	data
exchgDlvCstAddAmt	교환 추가 배송비 (+ 도서산간)	Number	data
exchgAddrseNm	교환 수취인명	String	data
exchgAddrseTelNo	교환 수취인 연락처	String	data
exchgAddrseMobilNo	교환 수취인 휴대전화번호	String	data
exchgAddrseBaseAddr	교환 수취인 기본주소	String	data
exchgAddrseDetailAddr	교환 수취인 상세주소	String	data
exchgAddrsePostNo	교환 수취인 우편번호	String	data
exchgDlvMemo	교환 배송 메모	String	data
pageNo	현재 페이지	Number	N/A
pageSize	페이지당 표시 개수	Number	N/A
totalCount	전체 개수	Number	N/A
totalPage	전체 페이지 수	Number	N/A

Request

POST

/v1/claim/list

curl -X POST "https://store-api.goodwearmall.com/v1/claim/list" \
    -H "Authorization: ${API_AUTH_INFO}" \
    -H "Content-Type: application/json" \
    -d '{
        "dateType": "CLM",
        "fromDate": "YYYYMMDD",
        "toDate": "YYYYMMDD",
        "clmTp": "ALL_CNCL"
    }'

Response

{
    "data": [
        {
            "clmNo": "CL123456789000001",
            "clmWrhsGodTurn": 1,
            "ordNo": "OD123456789000001",
            "ordGodTurn": 1,
            "ordDt": "YYYY-MM-DDTHH:MI:SS.000+00:00",
            "clmDt": "YYYY-MM-DDTHH:MI:SS.000+00:00",
            "rceptDt": "YYYY-MM-DDTHH:MI:SS.000+00:00",
            "comptDt": "YYYY-MM-DDTHH:MI:SS.000+00:00",
			"clmTpCd": "ALL_CNCL",
			"clmTpNm": "전체취소",
			"clmStatCd": "COMPT",
			"clmStatNm": "완료",
			"clmResnCd": "CLM_RSN_02",
			"clmResnNm": "색상/사이즈 잘못 선택함",
            "clmResnCont": "",
			"rfdStatCd": "RFD_COMPT",
			"rfdStatNm": "환불 완료",
            "rfdAmt": 0,
            "mbrId": "john_doe",
            "cstmrNm": "홍길동",
            "cstmrEmail": "test@test.com",
            "cstmrMobilNo": "010-1234-5678",
            "cstmrTelNo": "02-111-1111",
            "ordQty": 1,
            "clmQty": 1,
            "clmWthdrawQty": 0,
            "saleAmt": 0,
            "ordDcAmt": 0,
            "godDcAmt": 0,
            "cpnDcAmt": 0,
            "pointUseAmt": 0,
            "realAmt": 0,
            "rtnDlvCst": null,
            "rtnDlvCstCpnDcAmt": null,
            "rtnRealityDlvCst": null,
            "rtnDlvCstAddAmt": 0,
            "rtnAddrseNm": "",
            "rtnAddrseTelNo": "",
            "rtnAddrseMobilNo": "",
            "rtnAddrseBaseAddr": "",
            "rtnAddrseDetailAddr": "",
            "rtnAddrsePostNo": "",
            "exchgOrdQty": null,
            "exchgDlvCst": null,
            "exchgDlvCstCpnDcAmt": null,
            "exchgRealityDlvCst": null,
            "exchgDlvCstAddAmt": 0,
            "exchgAddrseNm": "",
            "exchgAddrseTelNo": "",
            "exchgAddrseMobilNo": "",
            "exchgAddrseBaseAddr": "",
            "exchgAddrseDetailAddr": "",
            "exchgAddrsePostNo": "",
            "exchgDlvMemo": null
        }
    ],
    "pageNo": 1,
    "pageSize": 50,
    "totalCount": 1,
    "totalPage": 1
}

POST/v1/claim/detail

2. 클레임 상세 조회

클레임 상세 내역을 조회할 수 있습니다.

필수 파라미터

Name
ordNos
Children
주문 번호 (최대 100개 조회)
Type
array of string

옵션 파라미터

Name
pageNo
Children
조회 페이지
Type
int
Name
limitCnt
Children
페이지당 표시 개수
Type
int

응답 모델

프로퍼티명	설명	타입	상위객체
data	클레임 상세 내역	Array	N/A
clmNo	클레임 번호	String	data
clmWrhsGodTurn	클레임 상품 순번	Number	data
ordNo	주문 번호	String	data
ordGodTurn	주문 상품 순번	Number	data
ordDt	주문 일시	String	data
clmDt	클레임 생성 일시	String	data
rceptDt	클레임 접수 일시	String	data
comptDt	클레임 완료 일시	String	data
clmWthdrawDt	클레임 철회 일시	String	data
clmTpCd	클레임 유형 코드	String	data
clmTpNm	클레임 유형 코드명	String	data
clmStatCd	클레임 상태 코드	String	data
clmStatNm	클레임 상태 코드명	String	data
clmResnCd	클레임 사유 코드	String	data
clmResnNm	클레임 사유 코드명	String	data
clmResnCont	클레임 사유 내용	String	data
brndId	브랜드 ID	String	data
brndNm	브랜드명	String	data
godNo	굿웨어몰 상품 번호	String	data
godNm	상품명	String	data
comGodNo	업체 상품 번호	String	data
optValCd1	옵션1값	String	data
optValNm1	옵션1명	String	data
optValCd2	옵션2값	String	data
optValNm2	옵션2명	String	data
optValCd3	옵션3값	String	data
optValNm3	옵션3명	String	data
ordQty	주문 수량	Number	data
clmQty	클레임 수량	Number	data
clmWthdrawQty	클레임 철회 수량	Number	data
saleAmt	판매금액	Number	data
ordDcAmt	주문 할인 금액	Number	data
godDcAmt	상품 할인 금액	Number	data
cpnDcAmt	쿠폰 할인 금액	Number	data
pointUseAmt	포인트 사용 금액	Number	data
realAmt	실결제 금액	Number	data
rtrvlStatCd	회수상태 코드	String	data
rtrvlStatNm	회수상태 코드명	String	data
rtnDlvCst	반품 기본배송비 (정책 배송비)	Number	data
rtnDlvCstCpnDcAmt	반품 배송비 할인 금액 (배송비 쿠폰 할인 금액)	Number	data
rtnRealityDlvCst	반품 실 배송비	Number	data
rtnDlvCstAddAmt	반품 추가 배송비 (+ 도서산간)	Number	data
rtnDlvComNm	회수 택배사	String	data
rtnWaybilNo	회수 송장번호	String	data
exchgGodNo	교환 굿웨어몰 상품 번호	String	data
exchgGodNm	교환 상품명	String	data
exchgComGodNo	교환 업체 상품 번호	String	data
exchgOptValCd1	교환 옵션1값	String	data
exchgOptValNm1	교환 옵션1명	String	data
exchgOptValCd2	교환 옵션2값	String	data
exchgOptValNm2	교환 옵션2명	String	data
exchgOptValCd3	교환 옵션3값	String	data
exchgOptValNm3	교환 옵션3명	String	data
exchgOrdQty	교환 주문 수량	Number	data
exchgDlvCst	교환 기본배송비 (정책 배송비)	Number	data
exchgDlvCstCpnDcAmt	교환 배송비 할인 금액 (배송비 쿠폰 할인금액)	Number	data
exchgRealityDlvCst	교환 실 배송비	Number	data
exchgDlvCstAddAmt	교환 추가 배송비 (+ 도서산간)	Number	data
exchgDlvStatCd	교환 배송 상태 코드	String	data
exchgDlvStatNm	교환 배송 상태	String	data
exchgDlvPlcNo	교환 국내 배송비 정책 번호	Number	data
exchgDlvPlcNm	교환 배송 정책명	String	data
exchgDlvComNm	교환 택배사	String	data
exchgWaybilNo	교환 송장번호	String	data
pageNo	현재 페이지	Number	N/A
pageSize	페이지당 표시 개수	Number	N/A
totalCount	전체 개수	Number	N/A
totalPage	전체 페이지 수	Number	N/A

Request

POST

/v1/claim/detail

curl -X POST "https://store-api.goodwearmall.com/v1/claim/detail" \
    -H "Authorization: ${API_AUTH_INFO}" \
    -H "Content-Type: application/json" \
    -d '{
        "ordNos": [
            "OD1234567890",
            "OD0987654321"
        ]
    }'

Response

{
    "data": [
        {
            "clmNo": "CL123456789000001",
            "clmWrhsGodTurn": 1,
            "ordNo": "OD123456789000001",
            "ordGodTurn": 1,
            "ordDt": "YYYY-MM-DDTHH:MI:SS.000+00:00",
            "clmDt": "YYYY-MM-DDTHH:MI:SS.000+00:00",
            "rceptDt": "YYYY-MM-DDTHH:MI:SS.000+00:00",
            "comptDt": "YYYY-MM-DDTHH:MI:SS.000+00:00",
            "clmWthdrawDt": null,
            "clmTpCd": "전체취소",
            "clmStatCd": "완료",
            "clmResnCd": "클레임 사유",
            "clmResnCont": null,
            "brndId": "TEST",
            "brndNm": "TEST",
            "godNo": "1P123456789000",
            "godNm": "TEST",
            "comGodNo": "TEST",
            "optValCd1": "001",
            "optValNm1": "BK",
            "optValCd2": "002",
            "optValNm2": "L",
            "optValCd3": "",
            "optValNm3": null,
            "ordQty": 1,
            "clmQty": 1,
            "clmWthdrawQty": 0,
            "saleAmt": 0,
            "ordDcAmt": 0,
            "godDcAmt": 0,
            "cpnDcAmt": 0,
            "pointUseAmt": 0,
            "realAmt": 0,
            "rtrvlStatCd": null,
            "rtnDlvCst": null,
            "rtnDlvCstCpnDcAmt": null,
            "rtnRealityDlvCst": null,
            "rtnDlvCstAddAmt": 0,
            "rtnDlvComNm": null,
            "rtnWaybilNo": null,
            "exchgGodNo": null,
            "exchgGodNm": null,
            "exchgComGodNo": null,
            "exchgOptValNm1": null,
            "exchgOptValNm2": null,
            "exchgOptValNm3": null,
            "exchgOrdQty": null,
            "exchgDlvCst": null,
            "exchgDlvCstCpnDcAmt": null,
            "exchgRealityDlvCst": null,
            "exchgDlvCstAddAmt": 0,
            "exchgDlvStatCd": null,
            "exchgDlvPlcNo": null,
            "exchgDlvPlcNm": null,
            "exchgDlvComNm": null,
            "exchgWaybilNo": null
        }
    ],
    "pageNo": 1,
    "pageSize": 50,
    "totalCount": 1,
    "totalPage": 1
}