주문

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

POST/v1/order/list

1. 주문 목록 조회

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

필수 파라미터

Name
fromDate
Children
주문 조회 일시 (시작) - YYYYMMDD
Type
string
Name
toDate
Children
주문 조회 일시 (종료) - YYYYMMDD
Type
string

옵션 파라미터

Name
brndId
Children
브랜드 ID
Type
string
Enum
ordStat
Children
주문 상태
Type
enum
Name
pageNo
Children
조회 페이지
Type
int
Name
limitCnt
Children
페이지당 표시 개수
Type
int

응답 모델

프로퍼티명	설명	타입	상위객체
data	주문 목록	Array	N/A
ordNo	주문 번호	String	data
ordStatCd	주문 상태 코드	String	data
ordStatNm	주문 상태 코드명	String	data
ordTpCd	주문 유형 코드	String	data
ordTpNm	주문 유형 코드명	String	data
ordDt	주문 일시	String	data
mbrId	회원 ID	String	data
cstmrNm	고객명	String	data
cstmrEmail	고객 이메일	String	data
cstmrMobilNo	고객 휴대전화번호	String	data
cstmrTelNo	고객 전화번호	String	data
dealTpCd	거래 유형 코드	String	data
dealTpNm	거래 유형 코드명	String	data
payDt	결제 일시	String	data
payMnCd	결제 수단 코드	String	data
payMnNm	결제 수단 코드명	String	data
ordQtySum	주문 수량	Number	data
saleAmtSum	판매 금액	Number	data
ordDcAmtSum	주문 할인 금액	Number	data
godDcAmtSum	상품 할인 금액	Number	data
cpnDcAmtSum	쿠폰 할인 금액	Number	data
pointUseAmtSum	포인트 사용 금액	Number	data
realAmtSum	실결제 금액	Number	data
dlvCstSum	기본 배송비 (정책 배송비)	Number	data
dlvCstCpnDcAmtSum	배송비 할인 금액 (배송비 쿠폰 할인 금액)	Number	data
realityDlvCstSum	실 배송비	Number	data
dlvCstAddAmtSum	추가 배송비 (+ 도서산간)	Number	data
addrseNm	수취인명	String	data
addrseTelNo	수취인 연락처	String	data
addrseMobilNo	수취인 휴대전화번호	String	data
addrseBaseAddr	수취인 기본주소	String	data
addrseDetailAddr	수취인 상세주소	String	data
addrsePostNo	수취인 우편번호	String	data
dlvMemo	배송 메모	String	data
pageNo	현재 페이지	Number	N/A
pageSize	페이지당 표시 개수	Number	N/A
totalCount	전체 개수	Number	N/A
totalPage	전체 페이지 수	Number	N/A

Request

POST

/v1/order/list

curl -X POST "https://store-api.goodwearmall.com/v1/order/list" \
    -H "Authorization: ${API_AUTH_INFO}" \
    -H "Content-Type: application/json" \
    -d '{
        "fromDate": "YYYYMMDD",
        "toDate": "YYYYMMDD",
        "brndId": "TESTBRAND",
        "ordStat": "ORD_STATUS"
    }'

Response

{
    "data": [
        {
            "ordNo": "OD000000000000000",
            "ordStatCd": "PAY_COMPT",
            "ordStatNm": "결제 완료",
            "ordTpCd": "GNRL_ORD",
            "ordTpNm": "일반주문",
            "ordDt": "YYYY-MM-DDTHH:MI:SS.000+00:00",
            "mbrId": "john_doe",
            "cstmrNm": "홍길동",
            "cstmrEmail": "test@test.com",
            "cstmrMobilNo": "01012345678",
            "cstmrTelNo": "",
            "dealTpCd": "PAY_COMPT",
            "dealTpNm": "결제 완료",
            "payDt": "YYYY-MM-DDTHH:MI:SS.000+00:00",
            "payMnCd": "TEST_PAY",
            "payMnNm": "테스트 페이",
            "ordQtySum": 1,
            "saleAmtSum": 1000,
            "ordDcAmtSum": 0,
            "godDcAmtSum": 0,
            "cpnDcAmtSum": 0,
            "pointUseAmtSum": 0,
            "realAmtSum": 1000,
            "dlvCstSum": 3000,
            "dlvCstCpnDcAmtSum": null,
            "realityDlvCstSum": 3000,
            "dlvCstAddAmtSum": 0,
            "addrseNm": "홍길동",
            "addrseTelNo": "",
            "addrseMobilNo": "01047934495",
            "addrseBaseAddr": "테스트",
            "addrseDetailAddr": "테스트",
            "addrsePostNo": "12345",
            "dlvMemo": ""
        },
        ...
    ],
    "pageNo": 1,
    "pageSize": 50,
    "totalCount": 2,
    "totalPage": 1
}

POST/v1/order/detail

2. 주문 상세 조회

주문의 상세 내역을 조회할 수 있습니다. 기본적으로 페이지당 최대 50 개의 주문이 표시됩니다.

필수 파라미터

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

옵션 파라미터

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

응답 모델

프로퍼티명	설명	타입	상위객체
data	주문 목록	Array	N/A
ordNo	주문 번호	String	data
ordGodTurn	주문 상품 순번	Number	data
ordStatCd	주문 상태 코드	String	data
ordStatNm	주문 상태 코드명	String	data
ordTpCd	주문 유형 코드	String	data
ordTpNm	주문 유형 코드명	String	data
dlivyTpNm	출고 유형명	String	data
ordDt	주문 일시	String	data
mbrId	회원 ID	String	data
cstmrNm	고객명	String	data
cstmrEmail	고객 이메일	String	data
cstmrMobilNo	고객 휴대전화번호	String	data
cstmrTelNo	고객 전화번호	String	data
dealTpCd	거래 유형 코드	String	data
dealTpNm	거래 유형 코드명	String	data
payDt	결제 일시	String	data
payMnCd	결제 수단 코드	String	data
payMnNm	결제 수단 코드명	String	data
comId	업체 ID	String	data
comNm	업체명	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
brndId	브랜드 ID	String	data
brndNm	브랜드명	String	data
ordQty	주문 수량	Number	data
saleAmt	판매 금액	Number	data
ordDcAmt	주문 할인 금액	Number	data
godDcAmt	상품 할인 금액	Number	data
cpnDcAmt	쿠폰 할인 금액	Number	data
pointUseAmt	포인트 사용 금액	Number	data
realAmt	실결제 금액	Number	data
dlvCstSum	기본 배송비 (정책 배송비)	Number	data
dlvCstCpnDcAmtSum	배송비 할인 금액 (배송비 쿠폰 할인 금액)	Number	data
realityDlvCst	실 배송비	Number	data
dlvCstAddAmt	추가 배송비 (+ 도서산간)	Number	data
dlvStatCd	배송 상태 코드	String	data
dlvStatNm	배송 상태 코드명	String	data
dlvPlcNo	국내 배송비 정책 번호	String	data
dlvPlcNm	배송 정책명	String	data
dlvComNm	택배사	String	data
waybilNo	송장 번호	String	data
dlivyDrctGodNo	출고지시 상품 번호	String	data
dlivyPrearngeDt	출고 예정 일시	String	data
dlivyDrctDt	출고 지시 일시	String	data
dlivyDrctCnclDt	출고지시 취소 일시	String	data
dlivyComptDt	출고 완료 일시	String	data
dlvComptDt	배송 완료 일시	String	data
orgOrdGodTurn	원주문 상품순번	Number	N/A
pageNo	현재 페이지	Number	N/A
pageSize	페이지당 표시 개수	Number	N/A
totalCount	전체 개수	Number	N/A
totalPage	전체 페이지 수	Number	N/A

Request

POST

/v1/order/detail

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

Response

{
    "data": [
        {
            "ordNo": "OD123456789000001",
            "ordGodTurn": 1,
            "ordStatCd": "DLV_COMPT",
            "ordStatNm": "배송완료",
            "ordTpCd": "GNRL_ORD",
            "ordTpNm": "일반주문",
            "dlivyTpNm": "주문",
            "ordDt": "YYYY-MM-DDTHH:MI:SS.000+00:00",
            "mbrId": "john_doe",
            "cstmrNm": "홍길동",
            "cstmrEmail": "test@test.com",
            "cstmrMobilNo": "010-1234-5678",
            "cstmrTelNo": "",
            "dealTpCd": "PAY_COMPT",
            "dealTpNm": "결제 완료",
            "payDt": "YYYY-MM-DDTHH:MI:SS.000+00:00",
            "payMnCd": "TEST_PAY",
            "payMnNm": "테스트 페이",
            "comId": "000000",
            "comNm": "TEST",
            "godNo": "1P123456789000",
            "godNm": "TEST",
            "comGodNo": "TEST",
            "optValCd1": "000",
            "optValNm1": "BK",
            "optValCd2": "001",
            "optValNm2": "L",
            "optValCd3": null,
            "optValNm3": null,
            "brndId": "TEST",
            "brndNm": "TEST",
            "ordQty": 1,
            "saleAmt": 0,
            "ordDcAmt": 0,
            "godDcAmt": 0,
            "cpnDcAmt": 0,
            "pointUseAmt": 0,
            "realAmt": 0,
            "dlvCst": 3000,
            "dlvCstCpnDcAmt": null,
            "realityDlvCst": 3000,
            "dlvCstAddAmt": 0,
            "dlvStatCd": "DLV_COMPT",
            "dlvStatNm": "배송완료",
            "dlvPlcNo": 0,
            "dlvPlcNm": "TEST",
            "dlvComNm": "OO택배",
            "waybilNo": "1234567890",
            "dlivyDrctGodNo": "RO12456789000000",
            "dlivyPrearngeDt": "YYYY-MM-DDTHH:MI:SS.000+00:00",
            "dlivyDrctDt": "YYYY-MM-DDTHH:MI:SS.000+00:00",
            "dlivyDrctCnclDt": null,
            "dlivyComptDt": "YYYY-MM-DDTHH:MI:SS.000+00:00",
            "dlvComptDt": null,
            "orgOrdGodTurn":null
        },
        ...
    ],
    "pageNo": 1,
    "pageSize": 50,
    "totalCount": 2,
    "totalPage": 1
}

POST/v1/order/place

3. 주문 발주

주문 발주 처리를 합니다.

필수 파라미터

Name
placeInfos
Children
발주 주문 정보 (최대 100개 조회)
Type
array of object
Name
ordNo
Children
주문 번호
Type
string
Name
ordGodTurns
Children
주문 순번
Type
array of int

응답 모델

프로퍼티명	설명	타입	상위객체
code	응답 코드	Number	N/A
message	응답 메시지	String	N/A
success/failed	발주 처리 성공/실패	Object	N/A
ordNo	주문 번호	String	success/failed
ordGodTurn	주문 순번	Number	success/failed

Request

POST

/v1/order/place

curl -X POST "https://store-api.goodwearmall.com/v1/order/place" \
    -H "Authorization: ${API_AUTH_INFO}" \
    -H "Content-Type: application/json" \
    -d '{
        "placeInfos": [
            {
                "ordNo": "OD1234567890",
                "ordGodTurns": [1, 3]
            },
            {
                "ordNo": "OD0987654321",
                "ordGodTurns": [1, 2]
            }
        ]
    }'

Response

{
    "code": 0,
    "message": "[n / n]라인의 주문 발주처리가 완료되었습니다. [발주처리 미대상 : n 라인]",
    "success": [
        {
            "ordNo": "OD1234567890",
            "ordGodTurns": 1
        },
        {
            "ordNo": "OD1234567890",
            "ordGodTurns": 3
        },
        {
            "ordNo": "OD0987654321",
            "ordGodTurns": 1
        },
        {
            "ordNo": "OD0987654321",
            "ordGodTurns": 2
        }
    ],
    "failed": []
}