1. 下载 & 通告
1-1. 下载
点击下方链接即可下载.
[Download] SDK 1.0.19 for Coupang OPENAPI
若无法下载，请输入请求SDK文件的卖家名/VendorID/开发语言和版本/简单原因说明，线上咨询。
1-2. 通告
* 详细信息，请参阅部署文件中的发布说明。
|
版本. |
详细内容 |
日期 |
| 1.0.19 | 在 OPEN API SDK OrderSheetDTO 类中添加了 shipmentType 字段 | 2022-01-07 |
| 1.0.18 | 在销售历史查询 API 中增加 downaloableCoupon 属性 | 2021-11-05 |
|
1.0.17 |
[确认酷澎客服咨询API] bug fix |
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 |
删除Courantee终止相关内容及示例代码 |
2020-02-12 |
|
1.0.11 |
新增添加到结算API的seller store相关项目。 |
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. 开始使用
2-1. 什么是SDK?
SDK（软件开发工具包）包含了在实现酷澎OPEN API 时所需的各种Class / Method / Sample。作为单个 Java 库（.jar 文件），它可以Import到特定的Class路径并在客户端代码中使用。 酷澎Open API 可以利用丰富的Sample数据进行更方便地开发。
SDK支持环境
SDK 支持 Java 1.7 及以上版本
2-2. SDK的优势是什么?
1) 所有API均提供Sample代码，方便使用SDK轻松设计OPEN API。
2) 创建HMAC 不需要额外的代码开发。
3) 无需使用 JSON 字符串。
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 等其它工具中也可以同样使用。
1）SDK下载解压后，按照如下路径可看到每个API类别下准备的sample。 请选择一个sample文件进行测试。
2）调用每个API时所需的Log in / Product & item level信息可以在sample/config/vendor.properties中定义
Note
" data:595634700”是通过 CreateSellerProduct.java 示例成功创建的注册商品 ID。
3-3. SDK Sample Scope
1）物流中心（Logistics） API
|
API name |
SDK sample |
|
创建出库地址 |
CreateOutboundShippingCenter |
|
查看出库地址 |
GetOutboundShippingPlace |
|
查看出库地址列表 |
GetOutboundShippingCenter |
|
修改出库地址 |
UpdateOutboundShippingCenter |
|
创建退货地址 |
CreateReturnShippingCenter |
|
查看退货地址列表 |
GetReturnShippingCenter |
|
修改退货地址 |
UpdateReturnShippingCenter |
2）品类（Category） API
|
API name |
SDK sample |
|
查看品类 |
GetDisplayCategoryByCode |
|
查看品类列表 |
GetDisplayCategories |
|
查看品类有效性 |
CheckCategoryStatus |
|
查看品类元数据 (Code) |
GetCategoryRelatedMetaByDisplayCategoryCode |
|
推荐品类 |
GetCategoryPrediction |
3）商品（Product）API
|
API name |
SDK sample |
|
创建商品 |
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 |
|
按商品查看顾客咨询 |
GetCustomerServiceRequest |
|
回复顾客咨询 |
UpdateCustomerServiceRequest |
|
查看酷澎客服中心咨询 |
GetInquiryByQuery |
|
回复酷澎客服中心咨询 |
UpdateInquiry |
|
确认酷澎客服中心咨询 |
ConfirmInquiry |
9) 结算（Settlement）API
|
Open API |
SDK Sample |
|
查看销售明细 |
GetRevenueHistory |
|
查看付款明细 |
GetSettlementHistories |
4. Contact & License
4-1. Contact
API政策与请求/响应信息相关咨询，访问 : '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.