1. Download & Notice
1-1. Download
아래 링크를 클릭해서 다운로드 받을 수 있습니다.
다운로드 받기가 안되시는 경우,
SDK 파일을 요청하는 셀러 명 / VendorID / 개발언어 & 버젼/ 간단한 사유를 적어서 온라인 문의로 요청해주시기 바랍니다.
1-2. Notice
* 자세한 내용은 배포파일 내 릴리즈 노트를 참고해주세요.
| 버전 | 상세 내용 | 날짜 |
|---|---|---|
| 1.0.19 | OrderSheetDto 에 shipmentType 속성 추가 | 2022-01-07 |
| 1.0.18 | 매출내역 API에 downloadableCoupon 속성 추가 | 2021-11-05 |
| 1.0.17 | [쿠팡 콜센터 문의확인 API] 의 오류 수정 | 2020-11-19 |
| 1.0.16 | [반품/취소 요청 목록 조회 API]에 "nextToken" 속성 추가 | 2020-08-10 |
| 1.0.15 | 주문 상품 취소 처리 API URL 변경 | 2020-05-15 |
| 1.0.14 | 반품프로세스 변경에 따른 반품조회 API 변경사항 반영 | 2020-04-16 |
| 1.0.13 | [상품 아이템별 가격변경] api에 forceSalePriceUpdate 파라메터 추가 | 2020-03-02 |
| 1.0.12 | 쿠런티 종료에 따른 관련 내용 및 예제코드 삭제 | 2020-02-12 |
| 1.0.11 | 정산 API 에 추가된 셀러 스토어 관련 항목들이 반영되었습니다. | 2019-12-09 |
| 1.0.10 | 상품 목록 조회시 nextToken 값을 Long 타입으로 변경 반품목록 조회 API에 cancelType파라메터가 추가되었습니다. |
2019-11-27 |
| 1.0.9 | 카테고리 메타정보 조회시 exposed 항목을 조회할 수 있도록 추가 | 2019-10-28 |
| 1.0.8 | 상품등록/수정 시 extraInfoMessage를 입력할 수 있도록 추가 | 2019-10-18 |
| 1.0.7 | 주문조회시 nextToken 추가 | 2019-08-29 |
| 1.0.6 | 쿠폰,정산 API 지원 추가 | 2019-08-23 |
| 1.0.5 | 반품 API 지원 추가 | 2019-08-05 |
| 1.0.4 | API 업데이트 반영 및 예제 추가 | 2019-07-10 |
| 1.0.3 | 무료배송조건 업데이트 외 다수 | 2019-06-13 |
| 1.0.2 | 다운로드 링크 제공 | 2019-05-24 |
| 1.0.1 | 불필요한 dependency 제거 | 2019-04-05 |
| 1.0.0 | 정산 매출 내역 API 추가 | 2019-03-29 |
| V1.0 | SDK 다운로드 & 관련 가이드 확인 | 2019-02-15 |
2. Getting Started
2-1. SDK란 무엇인가요?
SDK(Software Development Kit)에는 Coupang OPEN API를 구현하는 데 필요한 다양한 Class / Method / Sample 등이 포함되어 있습니다. 싱글 Java Library (.jar file)로 특정 클래스 패스에 Import 될 수 있고, 클라이언트 코드에서 사용할 수 있습니다. 풍부한 Sample 데이터를 활용하여 더욱 편리하게 쿠팡 Open API를 개발할 수 있습니다.
SDK 지원 환경
SDK는 Java 1.7 이상의 버젼을 지원하고 있습니다.
2-2. SDK의 장점은 무엇인가요?
1) SDK를 이용하여 손쉽게 OPEN API 설계할 수 있도록 모든 API에 Sample 코드를 제공합니다.
2) HMAC 생성을 위한 추가 코드 개발이 필요 없습니다.
3) JSON 스트링을 사용할 필요 없습니다.
4) 다언어를 지원할 예정입니다. (현재는 Java Client만 가능하나, 이후 확장 예정입니다.)
2-3. SDK 설치방법
1) SDK를 직접 다운로드 받거나, 온라인문의를 통해서 SDK를 요청합니다.( 업체명, VendorID, 개발언어&버젼 기재 )
2) 작업중인 디렉토리에 SDK를 다운받고 압축을 해제합니다.
3) 각 Sample을 참고하여 API 어플리케이션을 개발합니다.
4) 컴파일 및 어플리케이션을 실행합니다.
3. SDK Sample
3-1. SDK Sample?
SDK Sample을 활용하면, SDK에 포함된 각각의 라이브러리의 활용법을 쉽게 파악할 수 있습니다. 개발하고자 하는 OPEN API가 어떤 파라미터로 구성되어 있는지 한 눈에 볼 수 있으며, 개발에 앞서 빠르게 OPEN API를 호출 및 테스트를 할 수 있습니다.
3-2. Sample 사용법
아래 사용법은 IntelliJ 기반으로 설명하였으며, Eclipse를 비롯한 타 Tool에서도 동일한 방법으로 사용가능합니다.
1) SDK를 다운로드 하고 압축을 풀면, 아래와 같은 경로에 API 카테고리별로 샘플이 준비되어 있습니다. 테스트할 sample 파일을 선택해주세요.
2) 각 API를 호출하는데 필요한 Log in / Product & item level 정보를 sample/config/vendor.properties에 정의할 수 있습니다.
3) API별 필수 파라미터를 추가로 세팅하고, 샘플파일을 실행합니다. (실제 개발 시에는DB를 직접 연결합니다.)
4) 실행 결과를 확인합니다. (아래 예시는 CreateSellerProduct.java를 성공적으로 실행한 결과입니다.)
Note
"data:595634700" 은 CreateSellerProduct.java 샘플을 통해 성공적으로 생성된 등록상품 ID입니다.
3-3. SDK Sample Scope
1) 물류센터(Logistics) API
| API 명칭 | SDK 샘플명 |
|---|---|
| 출고지 생성 | CreateOutboundShippingCenter |
| 출고지 조회 | GetOutboundShippingPlace |
| 출고지 목록조회 | GetOutboundShippingCenter |
| 출고지 수정 | UpdateOutboundShippingCenter |
| 반품지 생성 | CreateReturnShippingCenter |
| 반품지 목록조회 | GetReturnShippingCenter |
| 반품지 수정 | UpdateReturnShippingCenter |
2) 카테고리(Category) API
| API 명칭 | SDK 샘플명 |
|---|---|
| 카테고리 조회 | GetDisplayCategoryByCode |
| 카테고리 목록 조회 | GetDisplayCategories |
| 카테고리 유효성 검사 | CheckCategoryStatus |
| 카테고리 메타 정보 조회(Code) | GetCategoryRelatedMetaByDisplayCategoryCode |
| 카테고리 추천 | GetCategoryPrediction |
3) 상품(Product) API
| API 명칭 | SDK 샘플명 |
|---|---|
| 상품 생성 | CreateSellerProduct |
| 상품 승인 요청 | SendApprovalRequest |
| 상품 수정 | UpdateSellerProduct |
| 상품 삭제 | DeleteSellerProductBySellerProductId |
| 상품 조회 | ReadSellerProduct |
| 상품 목록 페이징 조회 | SearchSellerProduct |
| 상품 목록 구간 조회 | ReadSellerProducts |
| 노출 상품 목록 페이징 조회 | SearchExistingProducts |
| 상품 상태변경이력 조회 | ReadSellerProductHistory |
| 상품 요약 정보 조회 | ReadSellerProductsByExternalVendorSkuCode |
| 상품 아이템별 수량/가격/상태 조회 | GetInventoryInformation |
| 상품 아이템별 수량 변경 | ChangeInventoryQuantity |
| 상품 아이템별 가격 변경 | ChangeSalesPrice |
| 상품 아이템별 판매 재개 | ResumeSelling |
| 상품 아이템별 판매 중지 | StopSelling |
| 상품 아이템별 할인율 기준가격 변경 | ChangeOriginalPrice |
| 상품 캐시백 적용 | SetCashbacksV4 |
| 상품 캐시백 검색 | GetCashback |
| 상품 캐시백 삭제 | StopCashbackV4 |
4) 배송/환불(Order) API
| Open API | SDK Sample |
|---|---|
| 발주서 목록 조회 (일 단위 페이징) | ReadOrderSheetByVendorId |
| 발주서 목록 조회 (분 단위 페이징) | ReadOrderSheetByVendorId |
| 발주서 단건 조회 (shipmentBoxId) | ReadOrderByShipmentBoxId |
| 발주서 단건 조회 (orderId) | ReadOrderSheetByOrderId |
| 배송상태 변경 히스토리 조회 | GetShipmentHistory |
| 상품준비중 처리 | AcknowledgePrepareShipmentStatus |
| 송장업로드 처리 | ProcessingInvoiceUpload |
| 송장업데이트 처리 | UpdateOrderInvoice |
| 출고중지완료 처리 | StopOrderRelease |
| 이미출고 처리 | AlreadyReleaseOrder |
| 결제완료건 환불 처리 | CancelOrder |
| 상품준비중 취소 처리 | CancelOrderV5 |
| 장기미배송 배송완료 처리 | CompleteDelivery |
5) 교환(Exchange) API
| Open API | SDK Sample |
|---|---|
| 교환요청 목록 조회 | ReadExchangeByVendorId |
| 교환요청상품 입고 확인처리 | ExchangeGoodsReceiptConfirmation |
| 교환요청 거부 처리 | UpdateExchangeRejection |
| 교환상품 송장 업로드 처리 | UpdateInvoiceToExchange |
6) 반품(ReturnOrder) API
| Open API | SDK Sample |
|---|---|
| 반품요청 목록 조회 (일단위 페이징) | ReadReturnsByVendorId |
| 반품요청 목록 조회 (분단위 페이징) | ReadReturnsByVendorId |
| 반품요청 단건 조회 | ReadReturnsByReceiptId |
| 반품상품 입고 확인처리 | ReturnReceiveConfirmation |
| 반품요청 승인 처리 | ProcessReturnRequestAuthorization |
| 반품철회 이력 기간별 조회 | GetReturnWithdrawRequestsByPageV4 |
| 반품철회 이력 접수번호로 조회 | GetReturnwithdrawByCancelIds |
| 회수 송장 등록 | CreateReturnExchangeInvoice |
7) 쿠폰(Coupon) API
| Open API | SDK Sample |
|---|---|
| (공통)예산현황 조회 | ReadSellerBudgets |
| (공통)계약서 단건 조회 | GetContract |
| (공통)계약서 목록 조회 | GetContracts |
| (공통)자유계약 생성 | CreateNonContractInfo |
| 다운로드쿠폰 생성 | CreateDownloadableCoupon |
| 다운로드쿠폰 파기 | ExpireDownloadableCoupon |
| 다운로드쿠폰 아이템 생성 | AddVendorItemsToDownloadableCoupons |
| 다운로드쿠폰 단건 조회(couponId) | GetDownloadableCouponById |
| 다운로드쿠폰 요청상태 확인 | GetTransactionStatus |
| 즉시할인쿠폰 생성 | CreateCoupon |
| 즉시할인쿠폰 파기 | ExpireOfCoupon |
| 즉시할인쿠폰 아이템 생성 | GetCouponByVendor |
| 즉시할인쿠폰 아이템 파기 | GetItemByCoupon |
| 즉시할인쿠폰 단건 조회(couponId) | GetCouponByVendor |
| 즉시할인쿠폰 단건 조회(couponItemId) | GetItemByCoupon |
| 즉시할인쿠폰 단건 조회(vendorItemId) | GetItemByVendorItemIdAndCoupon |
| 즉시할인쿠폰 목록 조회(status) | GetCouponsByVendor |
| 즉시할인쿠폰 목록 조회(orderId) | GetCouponsByOrder |
| 즉시할인쿠폰 아이템 목록 조회(status) | GetItemsByCoupon |
| 즉시할인쿠폰 요청상태 확인 | GetItemByRequestedId |
8) CS API
| Open API | SDK Sample |
|---|---|
| 상품별 고객문의 조회 | GerCustomerServiceRequest |
| 고객문의 답변 | UpdateCustomerServiceRequest |
| 쿠팡 콜센터 문의 조회 | GetInquiryByQuery |
| 쿠팡 콜센터 문의 답변 | UpdateInquiry |
| 쿠팡 콜센터 문의 확인 | ConfirmInquiry |
9) Settlement API
| Open API | SDK Sample |
|---|---|
| 매출 내역 조회 | GetRevenueHistory |
| 지급 내역 조회 | GetSettlementHistories |
4. Contact & License
4-1. Contact
API 정책 및 Request / Response Message 관련 문의 : 'WING -> 온라인문의 항목 이용'
SDK 관련 기술 문의 : 'WING -> 온라인문의 항목 이용'
4-2. License
Open Source License Announcement
This application contains copyrighted software under MIT License.
---------------------------------------------------
Copyright 2019 Coupang Corp.
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.