1. Download & Notice
1-1. Download
Click the link below to download the file.
If you can't download it, please contact us online inquiry with the following information: the name of seller asking for SDK file/VendorID/development language & version/a brief description of a reason
1-2. Notice
* For details, please refer to the release note in the file deployed.
| Ver. | Details | Date |
|---|---|---|
| 1.0.19 | Add a new CGF api and add shipmentType attr in order API. | 2022-01-07 |
| 1.0.18 | Add downaloableCoupon attribute to sales history inquiry API | 2021-11-05 |
| 1.0.17 | bug fix for [Coupang Contact Center Inquiry API]. | 2020-11-19 |
| 1.0.16 | add missing attr "nextToken" for [Return/Cancellation Request List API]. | 2020-08-10 |
| 1.0.15 | Replaced order cancellation api's url | 2020-05-15 |
| 1.0.14 | Reflect changes in return process in Return retrieve API | 2020-04-16 |
| 1.0.13 | [Price change at an item-level] Add forceSalePriceUpdate parameter to API | 2020-03-02 |
| 1.0.12 | Delete information on closing Courantee and exercise codes | 2020-02-12 |
| 1.0.11 | Items related to seller store that were added to settlement API, are updated. | 2019-12-09 |
| 1.0.10 | nextToken in retrieving a product list, changed to 'long' type. cancelType parameter was added to return list retrieve API. |
2019-11-27 |
| 1.0.9 | A feature is added to enable an inquiry of exposed items when retrieving category mete data | 2019-10-28 |
| 1.0.8 | extraInfoMessage can be entered for product registration/modification | 2019-10-18 |
| 1.0.7 | nextToken is added for order retrieving | 2019-08-29 |
| 1.0.6 | Coupon and settlement parts are added to API for support | 2019-08-23 |
| 1.0.5 | Return is added to API for support | 2019-08-05 |
| 1.0.4 | API update is reflected and exercise, added | 2019-07-10 |
| 1.0.3 | Free shipping conditions and others are updated | 2019-06-13 |
| 1.0.2 | A link for downloading the file is provided | 2019-05-24 |
| 1.0.1 | Unnecessary dependency is eliminated | 2019-04-05 |
| 1.0.0 | API on settlement history is added | 2019-03-29 |
| V1.0 | SDK download & relevant guides are checked | 2019-02-15 |
2. Getting Started
2-1. What is a SDK?
SDK(Software Development Kit) contains various class/method/sample that are required to implement Coupang OPEN API. Written in Single Java Library (.jar file), it can be imported into a particular class pass and used on a client code. Using abundant sample data, it enables us to develop a Coupang open API more easily.
SDK-supported environment
SDK supports Java 1.7 version and up.
2-2. What are the upsides of SDK?
1) Sample codes are provided to API through SDK to enable an easy design of open API.
2) Additional code development for HMAC creation is not needed.
3) JSON string is not required.
4) It will support multiple languages. (Currently, it only supports Java client but will stretch out to others later.)
2-3. SDK installation
1) You can download SDK by yourself or make a request for SDK via online inquiry (with seller name, VendorID, development language&version)
2) Download SDK into the directory you are working on and decompress the file.
3) Develop an API application based on the respective sample.
4) Compile and execute the application.
3. SDK Sample
3-1. SDK Sample?
Using SDK Sample, you can easily figure out how to use each library in SDK. At a glance, you understand what parameters comprise open API you will develop, and call/test open API prior to development work.
3-2. How to use Sample
The method is described based on IntelliJ and can apply to other tools including Eclipse.
1) After downloading and decompressing SDK, you can find sample per API category in the following path. Please select the sample file for testing.
2) You can define 'log in / product & item level data' required for calling API in sample/config/vendor.properties.
3) Set up essential parameters per API additionally and execute the sample file (Directly connect to DB in the actual development work).
4) Check execution results. (The example below shows successful execution of CreateSellerProduct.java.)
Note
"data:595634700" is a registered product ID successfully created through CreateSellerProduct.java sample.
3-3. SDK Sample Scope
1) Logistics API
| API name | SDK sample |
|---|---|
| Create outbound shipping center | CreateOutboundShippingCenter |
| Retrieve outbound place | GetOutboundShippingPlace |
| Retrieve list of outbound shipping centers | GetOutboundShippingCenter |
| Update outbound shipping center | UpdateOutboundShippingCenter |
| Create return shipping center | CreateReturnShippingCenter |
| Retrieve list of return shipping centers | GetReturnShippingCenter |
| Update return shipping centers | UpdateReturnShippingCenter |
2) Category API
| API name | SDK sample |
|---|---|
| Retrieve category | GetDisplayCategoryByCode |
| Retrieve category list | GetDisplayCategories |
| Check category status | CheckCategoryStatus |
| Retrieve category meta data(Code) | GetCategoryRelatedMetaByDisplayCategoryCode |
| Recommend categories | GetCategoryPrediction |
3) Product API
| API name | SDK sample |
|---|---|
| Create product | CreateSellerProduct |
| Request product approval | SendApprovalRequest |
| Update product | UpdateSellerProduct |
| Delete product | DeleteSellerProductBySellerProductId |
| Read product | ReadSellerProduct |
| Retrieve product list paging | SearchSellerProduct |
| Retrieve product list section | ReadSellerProducts |
| Search existing product list paging | SearchExistingProducts |
| Retrieve history of product status change | ReadSellerProductHistory |
| Retrieve product summary | ReadSellerProductsByExternalVendorSkuCode |
| Read quantity/price/status by item | GetInventoryInformation |
| Change item quantity | ChangeInventoryQuantity |
| Change item price | ChangeSalesPrice |
| Resume item selling | ResumeSelling |
| Suspend item selling | StopSelling |
| Change standard price for discount | ChangeOriginalPrice |
| Set cash back | SetCashbacksV4 |
| Search for item cash back | GetCashback |
| Delete item cash back | StopCashbackV4 |
4) Shipping/refund (Order) API
| Open API | SDK Sample |
|---|---|
| Read order sheet list (daily paging) | ReadOrderSheetByVendorId |
| Read order sheet list (minute-base paging) | ReadOrderSheetByVendorId |
| Read a single order sheet (shipmentBoxId) | ReadOrderByShipmentBoxId |
| Read a single order sheet (orderId) | ReadOrderSheetByOrderId |
| Retrieve history of change in shipping status | GetShipmentHistory |
| Process product preparation | AcknowledgePrepareShipmentStatus |
| Process invoice uploading | ProcessingInvoiceUpload |
| Update invoice | UpdateOrderInvoice |
| Stop order release | StopOrderRelease |
| Processed 'order release' | AlreadyReleaseOrder |
| Cancel order paid | CancelOrder |
| Cancel order at product preparation | CancelOrderV5 |
| Complete delivery of order undelivered for long | CompleteDelivery |
5) Exchange API
| Open API | SDK Sample |
|---|---|
| Retrieve list of requested VIs for exchange | ReadExchangeByVendorId |
| Confirm receipt of goods requested for exchange | ExchangeGoodsReceiptConfirmation |
| Reject exchange request | UpdateExchangeRejection |
| Upload invoice on exchange items | UpdateInvoiceToExchange |
6) ReturnOrder API
| Open API | SDK Sample |
|---|---|
| Retrieve a list of return requests (a daily paging) | ReadReturnsByVendorId |
| Retrieve a list of return requests (a minute-base paging) | ReadReturnsByVendorId |
| Retrieve a return request | ReadReturnsByReceiptId |
| Confirm receipt of returned product | ReturnReceiveConfirmation |
| Process authorizing return request | ProcessReturnRequestAuthorization |
| Retrieve history of return withdrawal by period | GetReturnWithdrawRequestsByPageV4 |
| Retrieve history of return withdrawal by cancel ID | GetReturnwithdrawByCancelIds |
| Register return/exchange invoice | CreateReturnExchangeInvoice |
7) Coupon API
| Open API | SDK Sample |
|---|---|
| (Common) Read budget status | ReadSellerBudgets |
| (Common) Retrieve a contract | GetContract |
| (Common) Retrieve a list of contracts | GetContracts |
| (Common) Create Non contract information | CreateNonContractInfo |
| Create a downloadable coupon | CreateDownloadableCoupon |
| Destroy downloadable coupons | ExpireDownloadableCoupon |
| Create items for downloadable coupon | AddVendorItemsToDownloadableCoupons |
| Retrieve a downloadable coupon (couponId) | GetDownloadableCouponById |
| Confirm status of request for downloadable coupon | GetTransactionStatus |
| Create a instant discount coupon | CreateCoupon |
| Destroy instant discount coupon | ExpireOfCoupon |
| Create items for instant discount coupon | GetCouponByVendor |
| Destroy coupon-applied items | GetItemByCoupon |
| Retrieve coupon Id(couponId) | GetCouponByVendor |
| Retrieve coupon-applied item ID(couponItemId) | GetItemByCoupon |
| Retrieve instant discount coupon-applied vendor item ID (vendorItemId) | GetItemByVendorItemIdAndCoupon |
| Retrieve instant discount coupon list(status) | GetCouponsByVendor |
| Retrieve instant discount coupon list(orderId) | GetCouponsByOrder |
| Retrieve a list of items for instant discount coupon(status) | GetItemsByCoupon |
| Confirm request status of instant discount coupon | GetItemByRequestedId |
8) CS API
| Open API | SDK Sample |
|---|---|
| Retrieve customer inquiries at an item-level | GetCustomerServiceRequest |
| Answer questions from customers | UpdateCustomerServiceRequest |
| Retrieve inquiries to Coupang call center | GetInquiryByQuery |
| Answer questions to Coupang call center | UpdateInquiry |
| Confirm inquiries to Coupang call center | ConfirmInquiry |
9) Settlement API
| Open API | SDK Sample |
|---|---|
| Retrieve revenue history | GetRevenueHistory |
| Retrieve payment history | GetSettlementHistories |
10) CGF API
| Open API | SDK Sample |
|---|---|
| print order label | OrderLabelPrint |
4. Contact & License
4-1. Contact
If you want to ask about API policy and Request / Response Message : please go onto 'WING -> Online inquiries'
Please inquire about SDK technology to : 'WING -> Online inquiries'
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.