배송등록 및 매입요청 처리해주는 API에 대한 설명입니다.
배송등록 요청데이터 스펙과 함께 APP의 배송등록 API를 호출하여 배송등록 처리합니다.
(배송등록 및 매입처리가 별도로 필요없는 곳은 미사용)
배송등록을 위해서는 사전에 [카페24 개발자센터 > APP관리 > 배송등록 API URL] 입력이 되어있어야 합니다.
에스크로 주문 생성을 하신 다음 배송완료 상태로 변경하시면, 주문 상세정보에서 '에스크로 배송등록' 버튼을 누름으로써 배송등록이 가능합니다.
- Home
- PG 앱
- PG 앱 제작방법
- API 레퍼런스
- 배송등록(매입요청)
배송등록(매입요청)
배송등록(매입요청) 호출 예시
- URL : 배송등록(매입요청) APP API URL
- 응답데이터 포맷 : JSON
배송등록(매입요청) 호출 요청 형식
POST 배송등록 APP API URL Content-Type: application/json Accept: application/json Accept-Charset: utf-8
요청코드 예시
curl -X POST '배송등록 APP API URL' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Accept-Charset: utf-8' \
-d '{"key1":"value1", "key2":"value2"}' \
배송등록(매입요청) 요청데이터 사양
| 파라미터 | 용도 | 데이터타입 | 필수 | 데이터 | 비고 |
|---|---|---|---|---|---|
| request_type | 처리 요청타입 | varchar(10) | 필수 | invoice(※고정값) | |
| partner_id | 가맹점ID | varchar(50) | 필수 | ||
| shop_no | 가맹점(멀티샵) 번호 | int | 권장 | ||
| tid | PG사 거래번호 | varchar(100) | 필수 | ||
| order_id | 가맹점 주문번호 | varchar(30) | 필수 | ||
| paymethod | 결제수단 | varchar(10) | 필수 | 기본연동코드-결제수단 | |
| invoice_express_code | 택배사 코드 | varchar(10) | 필수 | 배송사코드 | |
| invoice_express_name | 택배사 명 | varchar(20) | |||
| invoice_no | 운송장 번호 | varchar(30) | 필수 | ||
| invoice_charge | 배송비 지급형태 | char(2) | 필수 | ㆍ01 : 판매자부담 ㆍ02 : 구매자부담 |
|
| invoice_transactor | 배송등록 처리자 이름 | varchar(30) | 필수 | ||
| invoice_send_name | 송신자(판매자) 이름 | varchar(30) | 필수 | ||
| invoice_send_zipcode | 송신자(판매자) 우편번호 | varchar(30) | 권장 | 구분자( - )없이 숫자만 허용 | |
| invoice_send_addr_1 | 송신자(판매자) 주소1 | text | 필수 | 동단위까지 | |
| invoice_send_addr_2 | 송신자(판매자) 주소2 | text | 권장 | 나머지 주소 | |
| invoice_send_tel | 송신자(판매자) 전화번호 | varchar(40) | 권장 | ||
| invoice_recv_name | 수신자 이름 | varchar(30) | 필수 | ||
| invoice_recv_zipcode | 수신자 우편번호 | varchar(30) | 권장 | 구분자( - )없이 숫자만 허용 | |
| invoice_recv_addr_1 | 수신자 주소1 | text | 필수 | 동단위까지 | |
| invoice_recv_addr_2 | 수신자 주소2 | text | 권장 | 나머지 주소 | |
| invoice_recv_tel | 수신자 전화번호 | varchar(40) | 권장 | ||
| invoice_product_name | 상품명 | varchar(40) | 필수 | ||
| invoice_product_price | 상품 가격 | varchar(12) | 필수 | ||
| invoice_product_code | 상품 코드 | varchar(50) | |||
| invoice_product_count | 상품 수량 | int | |||
| hash_data | 위∙변조 방지 암호화데이터 | text | 필수 | 형식) base64_encode(hash_hmac('sha256', 평문, service_key, true)) ㆍ평문 (파라미터명 오름차순으로 나열) ㆍorder_id : 가맹점 주문번호 ㆍpartner_id : 가맹점 ID ㆍtid : PG사 거래번호 ㆍservice_key : 앱 생성시 개발자센터에서 발급받은 Service_key ex) base64_encode(hash_hmac('sha256', 'order_id+partner_id+tid', service_key, true)) |
배송등록(매입요청) 응답데이터 사양
| 파라미터 | 용도 | 데이터타입 | 필수 | 데이터 | 비고 |
|---|---|---|---|---|---|
| result_code | 응답코드 | char(4) | 필수 | 0000 이외에는 모두 실패 | |
| result_message | 응답메세지 | text | 필수 | 응답코드에 따른 응답메시지 전문 ㆍ메세지 조합 ㆍ성공시 : 성공 ㆍ실패시 : 앱 메세지 - [PG사 리턴코드] PG사 메세지 |
다음 문서
이 페이지가 얼마나 도움이 되었나요?
0자 입력 /최대 300자