주문리스트

기능 : 주문 리스트 요청
방식 : HTTP GET

URL

https://블로그페이아이디.shop.blogpay.co.kr/Api/orderList

코드샘플

PHP
curl

                
                    $url = 'https://블로그페이아이디.shop.blogpay.co.kr/Api/orderList';
                    $param = [
                        'token' => 'API 토큰',
                        'sDateS' => '검색 시작 날짜(예: 2018-08-11)',
                        'sDateE' => '검색 종료 날짜(예:2018-08-11)',
                        'sOrderState' => 결제 상태 번호,
                        'sPayMethod' => 결제 방식 번호
                    ];
                    $ch = curl_init();
                    curl_setopt($ch, CURLOPT_URL, $url.'?'.http_build_query($param));
                    curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
                    $response = curl_exec($ch);
                    curl_close($ch);

                
                    curl "https://블로그페이아이디.shop.blogpay.co.kr/Api/orderList?token=API 토큰&sDateS=검색 시작 날짜(예: 2018-08-11)&sDateE=검색 종료 날짜(예:2018-08-11)&sOrderState=결제 상태 번호&sPayMethod=결제 방식 번호"

응답보기↓

                
                    {
                    "result":{
                        "resCode":"1",
                        "resMsg":"정상 처리 되었습니다."
                    },
                    "orderList":{
                        "18122617-101e0uC0YaF":{
                            "orderNum":"18122617-101e0uC0YaF",
                            "siteid":null,
                            "cartOrderNum":null,
                            "memNo":"41281",
                            "shipCost":"0",
                            "shipLocalCost":"0",
                            "basisPrice":"0",
                            "couponCost":"0",
                            "smCost":"0",
                            "dcCost":"0",
                            "gbCost":"0",
                            "goodsSmRate":"0",
                            "expectGoodsSm":"0",
                            "sumGoodPrice":"10000",
                            "orderName":"TEST_NAME",
                            "orderTel":"01000000000",
                            "orderEmail":"",
                            "recvName":"TEST_NAME",
                            "recvTel":"01000000000",
                            "recvPhone":"01000000000",
                            "recvZip":"06114",
                            "recvAddr1":"서울 강남구 강남대로124길 3-6 (논현동, 호은빌딩)",
                            "recvAddr2":"상세주소",
                            "orderRequest":"배송시 요청사항",
                            "orderMessage":null,
                            "orderPassword":null,
                            "registDate":"2018-12-26 17:31:38",
                            "remoteAddr":"192.168.33.1",
                            "payMethod":"128",
                            "payInfo":"",
                            "orderState":"1",
                            "orderPayDate":null,
                            "orderCancelDate":null,
                            "orderUpdateDate":"2018-12-26 17:31:38",
                            "shipCode":null,
                            "shipNum":null,
                            "shipDate":null,
                            "shipingDate":null,
                            "payCancelState":null,
                            "expectSmDate":null,
                            "expectShipEndDate":null,
                            "autoShipEnd":"0",
                            "payCancelDate":null,
                            "cusNum":null,
                            "refundBank":"",
                            "orderPayBankInfo":"NH농협 - 222 - 333 - TEST_NAME",
                            "orderPayBankDepositor":"TEST_NAME",
                            "taxUse":null,
                            "payType":"2",
                            "deliveryReserveDate":null,
                            "adminMemo":null,
                            "payMemo":null,
                            "cancelOrderState":"0",
                            "cancelOrderPrice":null,
                            "bankAlarmCheck":"0",
                            "taxType":null,
                            "cashSaveNum":"",
                            "cancelUserCheck":"0",
                            "supplySm":"0",
                            "cpGbn":"",
                            "appPurchase":"0",
                            "cntGoods":null,
                            "sellNum":null,
                            "spuserId":null,
                            "calcState":null,
                            "backState":null,
                            "cancelState":"0",
                            "cancelId":null,
                            "shipType":null,
                            "totalShipCost":null,
                            "totalLocalCost":null,
                            "totalBasicCost":null,
                            "totalGoodsCost":null,
                            "totalSmCost":null,
                            "totalCouponCost":null,
                            "totaldcCost":null,
                            "totalgbCost":null,
                            "cancelCost":null,
                            "isBlog":null,
                            "create_at":null,
                            "id":null,
                            "cancelOrderNum":null,
                            "cancelType":null,
                            "cancelDetail":null,
                            "isShipped":null,
                            "refundMethod":null,
                            "cancelRegDate":null,
                            "cancel_msg":null,
                            "remote_addr":null,
                            "assi_id":"633",
                            "assi_OrderNum":"18122617-101e0uC0YaF",
                            "ostype":"0",
                            "corpTaxType":"1",
                            "goodTaxType":"TG01",
                            "subInfo":"{\"newOrder\":1,\"noTaxable\":null,\"tgMixed\":1,\"payData\":{\"amount_taxable\":9091,\"amount_taxfree\":0,\"amount_vat\":909},\"taxPrice\":null,\"divShip\":null,\"memCP\":null,\"rePayPrice\":null,\"gradeType\":null}",
                            "cancelPrice":null,
                            "reqPrice":null,
                            "cashSaveState":null,
                            "isSimplePay":"0",
                            "sTax":"0",
                            "slcTax":"0",
                            "buyShop":null,
                            "supplyUserId":"",
                            "payMethodStr":"무통장",
                            "shipCodeStr":null,
                            "payTypeStr":"무통장",
                            "orderStateStr":"미입금",
                            "bankName":"NH농협",
                            "bankNumber":"222",
                            "bankOwner":"333",
                            "orderPayBankDepositName":"TEST_NAME",
                            "totalGoodPrice":10000,
                            "goodList":{
                                "1031":{
                                    "orderGoodNum":"1031",
                                    "orderNum":"18122617-101e0uC0YaF",
                                    "goodNum":"309",
                                    "cateName":null,
                                    "basisPrice":"0",
                                    "goodName":"상품명",
                                    "goodPrice":"10000",
                                    "orderQty":"1",
                                    "goodImg":"",
                                    "orderPrice":"10000",
                                    "supplyUserid":"",
                                    "goodsCode":"123123",
                                    "bundleShip":"0",
                                    "gBindNum":"0",
                                    "bsFree":"0",
                                    "goodMaker":"",
                                    "isDeliveryPrice":"1",
                                    "ori_goodNum":"309",
                                    "goodImgUri":""
                                }
                            },
                            "orderGoodSimple":"상품명",
                            "totalQty":1
                        }
                    },
                    "pagenation":{
                        "page":1,
                        "pageCount":1,
                        "linkFirst":[
                        ],
                        "linkPrev":[
                        ],
                        "linkCurr":[
                            {
                                "link":"page=1&sDateType=registDate&sDateS=2018-12-26&sDateE=2018-12-26&sOrderState=1&sPayMethod=128&sPageSize=50",
                                "page":1,
                                "selected":true
                            }
                        ],
                        "linkNext":[
                        ],
                        "linkLast":[
                        ],
                        "limit":"LIMIT 0,50",
                        "limitFirst":0,
                        "limitLast":"50",
                        "totalData":"1"
                    },
                    "search":{
                        "sDateType":"registDate",
                        "sDateS":"2018-12-26",
                        "sDateE":"2018-12-26",
                        "sOrderState":"1",
                        "sPayMethod":"128",
                        "sGoodName":null,
                        "sPageSize":"50",
                        "sSearchStr":null,
                        "sOrderName":null,
                        "sOrderNum":null,
                        "sOrderPhone":null,
                        "sGoodNum":null,
                        "ostype":null
                    }
                    }

호출 파라메터 목록

파라메터	필수여부	설명
token	필수	API 토큰
sDateS	필수	검색 시작 날짜(예: 2018-08-11)
sDateE	필수	검색 종료 날짜(예:2018-08-11)
sOrderState	선택	결제 상태 1: 미입금, 4: 신규주문, 8: 배송준비, 9: 배송중, 10: 배송예약, 16: 배송완료, 32: 취소접수 64: 취소완료, 65: 반품중, 66: 반품완료, 67: 교환중, 68: 교환완료,69: 대여중,70: 대여완료
sPayMethod	선택	결제 방식 1:신용카드, 4:휴대전화, 8:계좌이체, 16:가상계좌, 128:무통장, 256:적립금, 512:페이코, 1024:카카오페이, 2048:네이버페이
sGoodName	선택	상품이름
sPageSize	선택	목록수 ( ※ 최대 : 500개 제한 )
sOrderName	선택	주문자, 수령자 검색
sOrderPhone	선택	주문자, 수령자 번호 검색
sOrderNum	선택	주문 번호 검색

응답

파라메터	설명
resCode	처리결과코드 (1: 성공, 0: 실패)
resMsg	처리메시지
orderList	주문 정보 (세부내용 아래 참고)
pagenation	목록 정보 (세부내용 아래 참고)
search	검색 정보 (세부내용 아래 참고)

응답세부 (orderList)

파라메터	설명
orderNum	주문 번호
CartOrderNum	동일 주문 건 (상품여러개 동시 주문시 해당 같은 주문건 확인 가능)
memNo	회원번호
shipCost	배송비
shipLocalCost	지역 배송비
basisPrice	공급가
couponCost	쿠폰 사용 금액
smCost	적립금 사용 금액
goodsSmRate	상품 적립금 비율
expectGoodsSm	예상 적립금 금액
sumGoodPrice	상품 합계 금액
orderName	주문자 명
orderTel	주문자 전화번호
orderEmail	주문자 이메일
recvName	수령자
recvTel	수령자 전화번호
recvPhone	수령자 핸드폰 번호
recvZip	수령자 우편번호
recvAddr1	수령자 주소
recvAddr2	수령자 주소 상세
orderRequest	배송시 요구사항
orderPassword	배송시 패스워드
registDate	등록날짜
remoteAddr	주문자 IP
goodsCode	상품 코드
payMethod	결제방식 1:신용카드, 4:휴대전화, 8:계좌이체, 16:가상계좌, 128:무통장, 256:적립금, 512:페이코, 1024:카카오페이, 2048:네이버페이
payInfo	결제 정보
orderState	1: 미입금, 4: 신규주문, 8: 배송준비, 9: 배송중, 10: 배송완료, 16: 배송예약, 32: 취소접수
orderPayDate	주문 결제 날짜
orderCancelDate	주문 취소 날짜
orderUpdateDate	주문 상태 수정 날짜
shipCode	1: 드림택배,2: CJ대한통운,3: 우체국택배,4: 로젠,5: 한진,6: 경동,7: 현대택배,8: KGB 9: 고려택배,10: 동부익스프레스, 11: 삼성택배HTH(구), 12: 스피디익스프레스 ,13: 우체국 EMS 14: 우체국등기 ,15: 일양택배,16: 천일택배,17: 합동택배,18: 자체배송,19: ACI Express,20: AirBoyExpress 21: CVSnet,22: CGM국제택배,23: WIZWA,24: 다젠,25: 대신택배,26: 해외운송장,27: GTX로지스
shipNum	배송 번호
shipDate	배송 완료 날짜
payCancelState	페이앱 취소 상태 2: 페이앱 취소완료
payCancelDate	페이앱 취소완료 일자
expectSmDate	예상 적립금 지급 날짜
adminMemo	관리자 메모
payMemo	페이앱 결제시 메모사항
payType	1:페이앱이용 2:이용안함
orderPayBankInfo	은행 및 입금자 내용
taxUse	1:현금영수증발생 요청안함 2: 발생 요청
taxType	1:현금영수증 발급 소득공제용 2:지출증빙용
cashSaveNum	현금영수증 번호
payMethodStr	결제 방법
shipCodeStr	배송 업체
payTypeStr	페이앱 Type 방법
orderStateStr	주문 상태
bankName	은행 이름
bankNumber	통장 번호
bankOwner	통장 소유자 이름
orderPayBankDepositName	무통장 입금자
totalGoodPrice	토탈 상품 가격
orderGoodSimple	상품 이름
goodList	상품 상세 내용 (상품상세정보 참조)
orderGoodNum	주문 상품 번호
orderNum	주문 번호
goodNum	상품 번호
cateName	카테고리 이름
basisPrice	공급가
goodName	상품 이름
goodPrice	상품 가격
orderQty	주문 개수
goodImg	상품 이미지
orderPrice	상품 주문 가격
goodContent	상품 상세 내용
supplyUserid	공급자 아이디
supplySm	1:적립금 지급 0:적립금 지급 안함
cpGbn	사용쿠폰 내용
goodsCode	상품 코드
goodImgUri	상품 이미지 uri
totalQty	전체 주문 개수
appPurchase	앱내에서 구매
cntGoods	1: 장바구니 2개이상 상품 구매시 0 or Null : 장바구니 1개 상품 혹은 주문서 구매
sellNum	null 또는 빈값이 아닐 시 공급주문. 그외 기존 자체상품주문

응답세부 (pagenation)

파라메터	설명
page	페이지 번호
pageCount	페이지 수
limit	DB limit 제한
limitFirst	DB limit 처음
limitLast	DB limite 마지막
totalData	데이터 총 갯수

응답세부 (search)

파라메터	설명
sDateS	검색 시작 날짜
sDateE	검색 종료 날짜
sOrderState	1: 미입금, 4: 신규주문, 8: 배송준비, 9: 배송중, 10: 배송완료, 16: 배송예약, 32: 취소접수 64: 취소완료, 65: 반품중, 66: 반품완료, 67: 교환중, 68: 교환완료,69: 대여중,70: 대여완료
sPayMethod	결제방식 1:신용카드, 4:휴대전화, 8:계좌이체, 16:가상계좌, 128:무통장, 256:적립금, 512:페이코, 1024:카카오페이, 2048:네이버페이
sGoodName	상품이름
sPageSize	목록수
sOrderName	주문자, 수령자 검색
sOrderPhone	주문자, 수령자 번호 검색
sSearchStr	통합검색
sOrderNum	주문 번호 검색

주문 완전 삭제

기능 : 주문 삭제롤 요청한다. 취소완료 시만 삭제 가능
방식 : HTTP POST

URL

https://블로그페이아이디.shop.blogpay.co.kr/Api/orderUpdate

코드샘플

PHP
curl

                
                    $url = 'https://블로그페이아이디.shop.blogpay.co.kr/Api/orderUpdate';
                    $param = [
                        'token' => 'API 토큰',
                        'mode' => 'delete',
                        'orderNum' => '주문번호'
                    ];
                    $ch = curl_init();
                    curl_setopt($ch, CURLOPT_URL, $url);
                    curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
                    curl_setopt($ch, CURLOPT_POST, 1);
                    curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query($param));
                    $response = curl_exec($ch);
                    curl_close($ch);

                
                    curl "https://블로그페이아이디.shop.blogpay.co.kr/Api/orderUpdate" \
                    -d 'token=API 토큰' \
                    -d 'mode=delete' \
                    -d 'orderNum=주문 번호'

응답

                
                    {
                        "result":{
                            "resCode":"1",
                            "resMsg":"정상 처리 되었습니다."
                        }
                    }

호출 파라메터 목록

파라메터	필수여부	설명
token	필수	API 토큰
mode	필수	delete
orderNum	필수	주문번호

응답

파라메터	설명
resCode	처리 결과
resMsg	처리메시지

주문 상태 변경

기능 : 주문 상태를 변경한다
방식 : HTTP POST

URL

https://블로그페이아이디.shop.blogpay.co.kr/Api/orderUpdate

코드샘플

PHP
curl

                
                    $url = 'https://블로그페이아이디.shop.blogpay.co.kr/Api/orderUpdate';
                    $param = [
                        'token' => 'API 토큰',
                        'mode' => 'updateState',
                        'orderNum' => '주문번호',
                        'prevStateCk' => 변경전 값,
                        'nextStateCk' => 변경후 값,
                        'siteid' => '블로그페이 아이디'
                    ];
                    $ch = curl_init();
                    curl_setopt($ch, CURLOPT_URL, $url);
                    curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
                    curl_setopt($ch, CURLOPT_POST, 1);
                    curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query($param));
                    $response = curl_exec($ch);
                    curl_close($ch);

                
                    curl "https://블로그페이아이디.shop.blogpay.co.kr/Api/orderUpdate" \
                    -d 'token=API 토큰' \
                    -d 'mode=updateState' \
                    -d 'orderNum=주문 번호' \
                    -d 'prevStateCk=변경전 값' \
                    -d 'nextStateCk=변경후 값' \
                    -d 'siteid=블로그페이 아이디'

응답

                
                    {
                        "result":{
                            "resCode":"1",
                            "resMsg":"정상 처리 되었습니다."
                        }
                    }

호출 파라메터 목록

파라메터	필수여부	설명
token	필수	API 토큰
mode	필수	updateState
orderNum	필수	주문번호
prevStateCk	필수	변경전 값 1: 미입금, 4: 신규주문, 8: 배송준비, 9: 배송중, 10: 배송예약, 16: 배송완료, 32: 취소접수 64: 취소완료, 65: 반품중, 66: 반품완료, 67: 교환중, 68: 교환완료,69: 대여중,70: 대여완료
nextStateCk	필수	변경후 값 1: 미입금, 4: 신규주문, 8: 배송준비, 9: 배송중, 10: 배송예약, 16: 배송완료, 32: 취소접수 64: 취소완료, 65: 반품중, 66: 반품완료, 67: 교환중, 68: 교환완료,69: 대여중,70: 대여완료
siteid	필수	블로그페이 아이디

응답

파라메터	설명
resCode	처리 결과
resMsg	처리메시지

송장 번호 변경

기능 : 송장번호를 변경한다
방식 : HTTP POST

URL

https://블로그페이아이디.shop.blogpay.co.kr/Api/orderUpdate

코드샘플

PHP
curl

                
                    $url = 'https://블로그페이아이디.shop.blogpay.co.kr/Api/orderUpdate';
                    $param = [
                        'token' => 'API 토큰',
                        'mode' => 'shipUpdate',
                        'orderNum' => '주문번호',
                        'shipNum' => 송장번호 (-) 제거,
                        'shipCode' => 택배 코드
                    ];
                    $ch = curl_init();
                    curl_setopt($ch, CURLOPT_URL, $url);
                    curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
                    curl_setopt($ch, CURLOPT_POST, 1);
                    curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query($param));
                    $response = curl_exec($ch);
                    curl_close($ch);

                
                    curl "https://블로그페이아이디.shop.blogpay.co.kr/Api/orderUpdate" \
                    -d 'token=API 토큰' \
                    -d 'orderNum=주문 번호' \
                    -d 'mode=shipUpdate' \
                    -d 'shipNum=송장 번호 (-) 제거' \
                    -d 'shipCode=택배 코드'

응답

                
                    {
                        "result":{
                            "resCode":"1",
                            "resMsg":"정상 처리 되었습니다."
                        }
                    }

호출 파라메터 목록

파라메터	필수여부	설명
token	필수	API 토큰
mode	필수	updateState
orderNum	필수	주문번호
shiping	선택	배송준비에서 송장 일괄 등록시 ex) &shiping = 1 shiping값 없을시 배송중 송장 수정으로 판단함
shipNum	필수	송장번호 (-) 제거
shipCode	필수	1: 드림택배,2: CJ대한통운,3: 우체국택배,4: 로젠,5: 한진,6: 경동,7: 롯데택배,8: KGB 9: 고려택배,10: 동부익스프레스, 11: 삼성택배HTH(구), 12: 스피디익스프레스 ,13: 우체국 EMS 14: 우체국등기 ,15: 일양택배,16: 천일택배,17: 합동택배,18: 자체배송,19: ACI Express,20: AirBoyExpress 21: CVSnet,22: CGM국제택배,23: WIZWA,24: 다젠,25: 대신택배,26: 해외운송장,28: CU 편의점택배

응답

파라메터	설명
resCode	처리 결과
resMsg	처리메시지