此为通过合并配送号码（shipmentBoxId）查询单个订单的API。
顾客可在付款完成后修改收货地址，因此将商品状态处理为“商品准备中”后，请务必通过单件订单查询来确认是否修改或更新了配送地信息("receiver")。
路径
GET
/v2/providers/openapi/apis/api/v4/vendors/{vendorId}/ordersheets/{shipmentBoxId}
示例
请求参数
|
Name |
Required |
Type |
Description |
|
vendorId |
O |
|
卖家代码 酷澎提供给卖家的固有代码 可登录Wing后查看 |
|
shipmentBoxId |
O |
|
配送编号(捆绑配送编号) 通过Wing或以分钟/天为单位的订单列表查询确认该信息 shipmentBoxId为 Number type |
请求体
无
返回消息
|
Name |
Type |
Description |
||
|
code |
Number |
服务器响应码 |
||
|
message |
String |
服务器响应消息 |
||
|
data |
Object |
|
||
|
|
shipmentBoxId |
Number |
配送编号 |
|
|
|
orderId |
Number |
订单号 |
|
|
|
orderedAt |
String |
订单日期 yyyy-MM-dd'T'HH:mm:ss |
|
|
|
orderer |
Object |
订购人 |
|
|
|
|
name |
String |
订购人姓名 |
|
|
|
|
String |
订购人邮箱地址 (进行模糊处理) |
|
|
|
safeNumber |
String |
收货人联系方式(安心码) |
|
|
|
ordererNumber |
String |
订购人联系方式(真实电话号码) null |
|
|
paidAt |
String |
付款日期 yyyy-MM-dd'T'HH:mm:ss |
|
|
|
status |
String |
订单状态
|
|||||||||||||||
|
|
shippingPrice |
Number |
配送费 |
|||||||||||||||
|
|
remotePrice |
Number |
偏远地区配送费 |
|||||||||||||||
|
|
remoteArea |
Boolean |
是否为偏远地区 |
|||||||||||||||
|
|
parcelPrintMessage |
String |
配送信息 |
|||||||||||||||
|
|
splitShipping |
Boolean |
是否分批配送 |
|||||||||||||||
|
|
ableSplitShipping |
Boolean |
可否分批配送 |
|||||||||||||||
|
|
receiver |
Object |
收货人信息 |
|||||||||||||||
|
|
|
name |
String |
收货人姓名 |
||||||||||||||
|
|
|
safeNumber |
String |
收货人联系方式(安心码) |
||||||||||||||
|
|
|
receiverNumber |
String |
收货人联系方式(真实电话号码) null |
||||||||||||||
|
|
|
addr1 |
String |
收货地址1 |
||||||||||||||
|
|
|
addr2 |
String |
收货地址2 |
||||||||||||||
|
|
|
postCode |
String |
收货人邮政编码 |
||||||||||||||
|
|
orderItems |
Array |
订单商品信息 |
|||||||||||||||
|
|
|
vendorItemPackageId |
Number |
vendorItemPackageId 未使用/不存在则返回0 |
||||||||||||||
|
|
|
vendorItemPackageName |
String |
vendorItemPackageName 未使用 |
||||||||||||||
|
|
|
productId |
Number |
显示商品ID 不存在则返回0 |
||||||||||||||
|
|
|
vendorItemId |
Number |
属性ID |
||||||||||||||
|
|
|
vendorItemName |
String |
属性商品名 |
||||||||||||||
|
|
|
shippingCount |
Number |
shippingCount = 下单时的item购买数量holdCountForCancel = 订单取消后的预计退款数量 cancelCount = 已确定的取消数量 可发货量 = shippingCount - (holdCountForCancel + cancelCount ) |
||||||||||||||
|
|
|
salesPrice |
Number |
单品价格(price of one item) |
||||||||||||||
|
|
|
orderPrice |
Number |
付款金额 : salesPrice*shippingCount |
||||||||||||||
|
|
|
discountPrice |
Number |
总折扣金额， discountPrice(总折扣金额) = instantCouponDiscount(立减优惠券)+downloadableCoupon(下载优惠券)+coupangDiscount(酷澎专享折扣) |
||||||||||||||
|
|
|
instantCouponDiscount |
Number |
立减优惠券 立减优惠券折扣金额 |
||||||||||||||
|
|
|
|
|
|
||||||||||||||
|
|
|
downloadableCouponDiscount |
Number |
下载优惠券 下载优惠券折扣金额 |
||||||||||||||
|
|
|
coupangDiscount |
Number |
酷澎专享折扣 酷澎专享购物车/品类折扣等金额 |
||||||||||||||
|
|
|
externalVendorSkuCode |
String |
卖家外部商品代码 |
||||||||||||||
|
|
|
etcInfoHeader |
String |
各商品单个输入项 optional |
||||||||||||||
|
|
|
etcInfoValue |
String |
各商品单个输入项的用户输入值 Optional 未使用 |
||||||||||||||
|
|
|
etcInfoValues |
Array |
各商品单个输入项的用户输入值列表 optional |
|
|
|
sellerProductId |
Number |
卖家商品ID |
|
|
|
sellerProductName |
String |
卖家商品名 |
|
|
|
sellerProductItemName |
String |
注册属性名 |
|
|
|
firstSellerProductItemName |
String |
初始注册属性名 |
|
|
|
cancelCount |
Number |
取消数量 |
|
|
|
holdCountForCancel |
Number |
待退款数量 |
|
|
|
estimatedShippingDate |
String |
下单时的预计发货日 yyyy-MM-dd |
|
|
|
plannedShippingDate |
String |
实际预计发货日(分批配送) yyyy-MM-dd |
|
|
|
invoiceNumberUploadDate |
String |
运单号上传日期 yyyy-MM-dd'T'HH:mm:ss |
|
|
|
extraProperties |
Object |
卖家商品属性的其它信息 key: value 类型 |
|
|
|
pricingBadge |
Boolean |
Courantee (是否为最低价) 是/否 |
|
|
|
usedProduct |
Boolean |
是否为二手商品 是/否 |
|
|
|
confirmDate |
String |
确认收货日期 yyyy-MM-dd HH:mm:ss |
|
|
|
deliveryChargeTypeName |
String |
配送费类型 免费、付费 |
|
|
|
canceled |
Boolean |
是否取消订单 是/否 |
|
|
overseaShippingInfoDto |
Object |
海外配送信息 |
|
|
|
|
personalCustomsClearanceCode |
String |
|
|
|
|
orderersSsn |
String |
|
|
|
|
ordererPhoneNumber |
String |
|
|
|
deliveryCompanyName |
String |
物流公司 CJ 大韩通运、韩进物流等 |
|
|
|
invoiceNumber |
String |
运单号 |
|
|
|
inTrasitDateTime |
String |
发货日 (配送日) yyyy-MM-dd HH:mm:ss |
|
|
|
deliveredDate |
String |
配送完成日 yyyy-MM-dd HH:mm:ss |
|
|
|
refer |
String |
付款方式 iPhone App、Android App、PC端 |
|
|
|
ShipmentType |
String |
物流方式 "Third Party", "CGF LITE" |
|
返回消息示例
{
"code": "200",
"message": "OK",
"data": {
"shipmentBoxId": 102392001,
"orderId": 500000596,
"orderedAt": "2017-10-06T22:59:37",
"orderer": {
"name": "김문근",
"email": "mg*****@co",
"safeNumber": "0501-111-2222",
"ordererNumber": null
},
"paidAt": "2017-10-06T22:59:37",
"status": "FINAL_DELIVERY",
"shippingPrice": 2500,
"remotePrice": 0,
"remoteArea": false,
"parcelPrintMessage": null,
"splitShipping": false,
"ableSplitShipping": false,
"receiver": {
"name": "test",
"safeNumber": "0501-111-2222",
"receiverNumber": null,
"addr1": "addr1",
"addr2": "addr2",
"postCode": "284-60"
},
"orderItems": [
{
"vendorItemPackageId": 0,
"vendorItemPackageName": "러비더비 섬유향수 보솔레이",
"productId": 2429,
"vendorItemId": 3000000177,
"vendorItemName": "러비더비 섬유향수 보솔레이, 500ml",
"shippingCount": 1,
"salesPrice": 14000,
"orderPrice": 14000,
"discountPrice": 500,
"instantCouponDiscount": 0,
"downloadableCouponDiscount": 500,
"coupangDiscount": 0,
"externalVendorSkuCode": "800022867",
"etcInfoHeader": null,
"etcInfoValue": null,
"etcInfoValues": [
"추가메시지1",
"추가메시지2"
],
"sellerProductId": 26758514,
"sellerProductName": "[러비더비] 대용량 섬유향수 보솔레이 500ml",
"sellerProductItemName": "01_보솔레이 500ml",
"firstSellerProductItemName": "01_보솔레이 500ml",
"cancelCount": 0,
"holdCountForCancel": 0,
"estimatedShippingDate": "2017-10-12",
"plannedShippingDate": "",
"invoiceNumberUploadDate": "",
"extraProperties": {},
"pricingBadge": false,
"usedProduct": false,
"confirmDate": "2017-10-18 18:10:28",
"deliveryChargeTypeName": "무료",
"canceled": false
}
],
"overseaShippingInfoDto": {
"personalCustomsClearanceCode": null,
"ordererSsn": "",
"ordererPhoneNumber": ""
},
"deliveryCompanyName": "CJ 대한통운",
"invoiceNumber": "337398446274",
"inTrasitDateTime": "2017-10-11 19:04:45",
"deliveredDate": "2017-10-13 19:34:50",
"refer": "PC웹",
"shipmentType": "CGF"
}
}错误代码
|
HTTP状态代码(错误类型) |
错误信息 |
解决方案 |
|
400 (确认请求参数) |
该订单已取消或退货。 |
请通过退货/取消申请列表查询API确认订单是否已被取消或退货，并确保该订单不被重复调用。 |
|
400 (确认请求参数) |
卖家ID无效。 |
请确认您输入的卖家ID(vendorld)是否正确。例】) A00012345 |
接口名称
GET_ORDERSHEET_BY_SHIPMENTBOX