OPEN API 공통 가이드
메이크샵 조회, 처리 API를 제공합니다.
API 이용을 위해서는 라이선스 키 와 상점키 가 필요합니다.
-
라이선스 등록을 통해 라이선스 키를 발급 받을 수 있습니다.
등록 시 기능 사용에 대한 권한을 부여 받습니다. -
라이선스 등록이 완료된 후 API 기능을 이용할 상점으로부터 업체 등록과
업체 사용 권한을 부여 받습니다.
-
OPEN API 조회 기본 정책은
조회 기능 이용시 시간 당 최대 500회 호출 가능하며
이는 주문 / 상품 / 회원 / 게시판 모두 포함 횟수입니다.
처리 기능 이용시 각 권한당 기능 이용시 최대 500회 호출 가능합니다.
(라이선스 업체 단위가 아닌, 메이크샵 상점 단위) -
조회 기능
- 조회 요청 전문은 GET 방식이며, 대소문자를 준수해 주시기 바랍니다.
-
처리 기능
- 처리 요청 전문은 POST 방식이며, 대소문자를 준수해 주시기 바랍니다.
-
업데이트 내역
- 추가사항 발생 시 매뉴얼은 지속적으로 업데이트 됩니다.
- 연동관리 > 오픈 API 메뉴에서 업체를 선택하시면 자동으로 상점 키 발급됩니다.
-
curl "http://{상점도메인}/list/open_api.html?mode=search&type=product&uid=4"
-H "Shopkey: {Shopkey}" -H "Licensekey: {Licensekey}" -
curl "http://{상점도메인}/list/open_api_process.html?mode=save&type=product&process=store"
-H "Shopkey: {Shopkey}" -H "Licensekey: {Licensekey}" -d 'product_name=메이크샵&sellprice=1000'
상점 키(Shopkey) 발급 방법
조회 요청 예제 (curl)
처리 요청 예제 (curl)
A.1.1 delivery
코드 값 | 설명 |
---|---|
N | 미처리 |
S | 발송준비 |
Y | 발송완료 |
D | 취소요청 |
C | 주문취소 |
R | 반송 |
X | 배송요청 |
P | 부분배송 |
E | 환불대기 |
A.1.2 paymethod
코드 값 | 설명 |
---|---|
B | 무통장입금 |
C | 카드결제 |
D | 휴대폰결제 |
Y | 우리은행 매매 보호 가상계좌 |
V | 뱅크타운 계좌이체, PG사 계좌이체 |
H | 하나은행 에스크로 결제 |
M | 국민은행 에스크로 결제 |
R | 적립금으로만 결제 |
E | 예치금으로만 결제 |
J | 적립금+예치금으로만 결제 |
N | 네이버마일리지로만 결제 |
S | PG에스크로 |
A | 페이팔 |
A.1.3 simple_pay
코드 값 | 설명 |
---|---|
PC | 페이코(간편결제) |
KK | 카카오페이(간편결제) |
KKC | 카카오페이(카드) |
KKM | 카카오페이(머니) |
KDC | 카카오페이 바로구매(카드) |
KDM | 카카오페이 바로구매(머니) |
PCC | 페이코(바로구매) |
SP | 삼성페이 |
SGC | 쓱페이 카드 |
SGM | 쓱페이 머니 |
STB | 내통장결제 |
SMP | 스마일페이 |
TOS | 토스 |
CHA | 차이페이 |
NPY | 네이버페이 |
A.2.1 order_status
코드 값 | 설명 |
---|---|
N | 배송 전 |
S | 발송 준비 |
Y | 발송 완료 |
D | 취소 요청 |
C | 주문 취소 |
R | 반품 |
X | 배송 요청 |
P | 부분 배송 |
E | 환불 대기 |
Q | 부분 배송 준비 |
A.2.2 basket_status
코드 값 | 설명 |
---|---|
S11 | 상품준비 (미처리) |
C11 | 입금전취소-구매자 |
C12 | 입금전취소-판매자 |
C13 | 입금전취소-시스템 |
C21 | 입금후 취소요청 |
C31 | 입금후 취소요청-구매자 |
C22 | 입금후 취소불가 |
C27 | 입금후 취소완료 |
C41 | 배송전교환 취소요청 |
C51 | 배송전교환 취소요청-구매자 |
C42 | 배송전교환 취소불가 |
C47 | 배송전교환 취소완료 |
D11 | 배송준비 |
D12 | 배송보류 |
D13 | 송장출력대기 |
D15 | 배송중 |
D17 | 배송완료 |
D19 | 거래완료 |
R11 | 반품요청 |
R31 | 반품요청-구매자 |
R12 | 반품 접수후 거부 |
R13 | 반품접수 |
R15 | 반품수거완료 |
R16 | 반품보류 |
R17 | 반품완료 |
R18 | 반품불가 |
T11 | 교환요청 |
T31 | 교환요청-구매자 |
T12 | 교환 접수후 거부 |
T13 | 교환접수 |
T15 | 교환수거완료 |
T16 | 교환보류 |
T17 | 교환완료 |
T18 | 교환불가 |
T21 | 맞교환요청 |
T23 | 맞교환접수 |
T25 | 맞교환수거 요청 |
T27 | 맞교환완료 |
T23 | 맞교환접수 |
A.2.3 issue_status
코드 값 | 설명 |
---|---|
REFUND1 | 환불전 |
REFUND3 | 환불접수 |
REFUND6 | 환불보류 |
REFUND7 | 환불완료 |
REFUNDC | 환불-변경 |
REPAY1 | 재결제대기 |
REPAY7 | 재결제완료 |
REPAYC | 재결제-변경 |
REPAYA | 재결제대기 |
A.2.4 deli_type
코드 값 | 설명 |
---|---|
KOR | 국내배송 |
EMS | 해외배송 |
HAND | 직접수령 |
잘못된정보 |
A.2.5 refund_status
코드 값 | 설명 |
---|---|
QUEUE | 환불전 |
STATNDBY | 환불접수(재결제대기) |
HOLD | 환불/재결제 보류 |
COMPLETE | 환불/재결제 완료 |
A.3.1 option_type
코드 값 | 설명 |
---|---|
NO | 옵션 없음 |
NU | 2단 옵션 |
NL | 2단 재고 옵션 |
OC | 옵션 까페테리아 |
PC | 고객작성형(파워옵션) |
PP | 추가금액형(파워옵션) |
PS | 고객선택형(파워옵션) |
A.3.2 options
필드 명 | 필드 정의 | 필드 타입 | 비고 | |
---|---|---|---|---|
NU / NL(주문 1.0 전용) | option_value | 옵션 값 | String | |
option_price | 옵션가 | String | ||
option_stock | 옵션 재고 | String | ||
PC / PP / PS - 주문 1.0 - 주문 2.0 |
option_value | 옵션 값 | String | |
option_price | 옵션가 | String | ||
option_id | 옵션 번호 | String | ||
option_title | 옵션명 | String | ||
option_code | 옵션 품목 별 코드 | String | ||
option (통합옵션) |
opt_id | 옵션 아이디 | String | |
opt_type | 옵션타입 | Code | SELECT:중복부과 SINGLE:단일부과 CUSTOM:작성형 ADDITION:개별옵션 HYBRID:하이브리드 |
|
opt_name | 옵션명 | String | ||
opt_value | 옵션값 | String | ||
opt_price | 옵션가 | String | ||
opt_guide | 안내문구 | String | ||
opt_use | 옵션 사용 여부 | Code | Y, N | |
opt_mix | 옵션 조합 유무 | Code | Y, N | |
opt_mandatory | 옵션 필수 여부 | Code | Y, N | |
basic (통합옵션 - option 조합) addition (통합옵션 - 개별옵션) |
sto_id | 조합 아이디 | String | |
opt_ids | 조합 옵션 아이디 | String | option (통합옵션) 항목 opt_id (조합 시 콤마로 연결) | |
sto_type | 옵션타입 | Code | BASIC:조합옵션 및 기본더미 옵션 (기본더미 옵션의 경우 sto_matrix를 0:0으로 유지함) ADDITION:개별옵션 DUMMY:미조합옵션 |
|
sto_opt_values | 조합 옵션 값 | String | option(통합옵션) 항목 opt_value (조합 시 콤마로 연결) | |
sto_price | 조합옵션가격 | String | ||
sto_provide_price | 조합옵션 공급가격 | String | ||
sto_real_stock | 조합옵션수량 | String | ||
sto_unlimit | 무제한사용여부 | Code | Y, N | |
sto_stop_use | 옵션판매중지 사용여부 | Code | Y, N | |
sto_stop_stock | 옵션판매중지수량 | String | ||
sto_order_stock | 옵션판매수량 | String | ||
sto_code | 관리코드 | String | ||
sto_option_code | 옵션 품목 별 코드 | String | ||
sto_state_code | 옵션상태 | Code | HIDE : 노출안함 SOLDOUT : 품절TEMPOUT : 일시품절 DELAY : 배송지연SALE : 판매 |
A.3.3 stocks
필드 명 | 필드 정의 | 필드 타입 | 비고 |
---|---|---|---|
value | 옵션 정보 | String | 콤마(,)로 구분 |
price | 가격 정보 | String | |
stock | 재고 수량 | String |
A.6.1 cate_type
코드 값 | 설명 |
---|---|
M | 중분류 |
N | 가상중분류 |
O | 중분류 없는 대분류 (단일분류) |
P | 중분류 없는 가상대분류 |
X | 중분류 있는 대분류 |
Y | 중분류 있는 가상대분류 |
B.1.1 return_code
코드 값 | 설명 |
---|---|
0000 | 정상 |
9000 | 기본 요청 정보가 없습니다. |
9001 | 상점키가 없습니다. |
9002 | 검색된 상점키가 없습니다. |
9003 | 라이센스키가 없습니다. |
9004 | 검색된 라이센스키가 없습니다. |
9005 | 허가된 업체가 아닙니다. |
9006 | API 연동이 초과되었습니다. |
9007 | API 조회 권한이 없습니다. 상점에 문의해 주시기 바랍니다. |
9008 | API 조회 권한이 없습니다. 메이크샵 담당자에게 문의해 주시기 바랍니다. |
9009 | 허가된 IP가 아닙니다. |
9011 | 검색된 내역이 없습니다. |
9012 | 조회 시작일이 없습니다. |
9013 | 조회 시작일 날짜의 형식이 맞지 않습니다. 예) 0000-00-00 00:00:00 |
9014 | 조회 시작일이 맞지 않습니다. |
9015 | 조회 종료일 날짜의 형식이 맞지 않습니다. 예) 0000-00-00 00:00:00 |
9016 | 조회 종료일이 맞지 않습니다. |
9017 | 조회 기간을 확인해 주세요. |
9018 | 조회 기간은 30일을 초과할 수 없습니다. |
9019 | 조회 날짜 형식이 맞지 않습니다. 예)0000-00-00 |
9021 | 조회할 주문번호가 없습니다. |
9031 | 조회할 아이디가 없습니다. |
9032 | 조회는 1000개 이상 할 수 없습니다. |
9033 | 다중 조회 횟수를 초과하였습니다. |
9034 | 다중 검색 값이 배열이 아닙니다. |
9041 | 숫자가 아닙니다. |
9051 | 게시판 조회 코드가 필요합니다. |
9061 | 쿠폰 코드가 필요합니다. |
9062 | 쿠폰 검색타입이 필요합니다. |
9063 | 스마트쿠폰 적용 상점은 사용할수 없습니다. |
9064 | 스마트쿠폰 미적용 상점은 사용할수 없습니다. |
9071 | 상품번호가 없습니다. |
9081 | 서버 부하로 인한 조회 기간이 조정되었습니다.(최대 1일로 검색가능합니다.) |
9101 | 상점 관리자가 Open API 서비스 이용 동의를 하지 않았습니다. |
9102 | 상점 관리자가 Open API 제 3자 제공 동의를 하지 않았습니다. |
9103 | API 처리 권한이 없습니다. 상점에 문의해 주시기 바랍니다. |
9104 | API 처리 권한이 없습니다. 메이크샵 담당자에게 문의해 주시기 바랍니다. |
9201 | datas 값이 없습니다. |
9202 | datas 값이 배열이 아닙니다. |
9203 | 1회 최대 처리 한도를 초과하였습니다. |
9204 | POST로 전달받은 값이 없습니다. |
9221 | 상품 준비중 리스트 미사용 |
9401 | 디자인 버전 D4를 사용해야 합니다. |
9901 | 지원하지 않는 mode 입니다.(endpoint를 확인주시길 바랍니다.) |
9902 | 해당 기능(포인트, emoney 등)이 사용 안함 상태인 경우 출력됩니다.(상점 관리자를 통해 기능 상태를 사용함으로 변경해주세요.) |
9997 | DB 등록 실패 |
9998 | 상점 이용 기간이 만료되었습니다. |
9999 | fail, message가 출력됩니다. |
C.1.1 택배사 코드
택배사 코드는 택배사 조회 기능을 통해서 조회가 가능합니다. |
---|
-
{{ change_log.subject }}
{{ guide.subject }}
-
Permission
-
Method
- {{ guide.method }}
-
Caution
요청 예제 CURL
curl
-H 'Shopkey: {상점키}'
-H 'Licensekey: {라이센스키}'
'http://{상점 도메인}/list/{{ guide.method === 'GET' ? 'open_api' : 'open_api_process' }}.html?
mode={{ guide.mode }}&type={{ guide.type }}{{ requestParamater(guide) }}'
{{ requestContent(guide) }}
응답 예제JSON
{{ guide.response_content }}