API支持的买家用户地区:韩国、台湾
此为通过合并配送号码(shipmentBoxId)查询单个订单的API。
注意:由于 CGF 订单不会通过 Open API 返回给您,请不要使用CGF 合并配送号码来请求,以免产生错误。请通过 Wing 查看 CGF 订单。
顾客可在付款完成后修改收货地址,因此将商品状态处理为“商品准备中”后,请务必通过单件订单查询来确认是否修改或更新了配送地信息("receiver")。
- 发货前,请一定要确认"sellerProductName + sellerProductItemName"和"vendorItemName"上的信息是否一致。
- 构成、数量、容量等有不同时,请先暂停发货,通过在线咨询申请的话我们会尽快给予帮助的。(商品信息显示错误。> 请选择“是”来申请。)
- 若确认为错误显示,扣除的卖家分数就会恢复。
路径
GET
/v2/providers/openapi/apis/api/v5/vendors/{vendorId}/ordersheets/{shipmentBoxId}
示例
请求参数
| Name | Required | Type | Description |
| vendorId | O |
卖家代码 酷澎提供给卖家的固有代码 可登录Wing后查看 |
|
| shipmentBoxId | O |
配送编号(捆绑配送编号) 通过Wing或以分钟/天为单位的订单列表查询确认该信息 shipmentBoxId为 Number type |
请求体
无
返回消息
| Name | Type | Description | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| code | 数值 | 服务器返回码 |
||||||||||||||||||
| message | 字符串 | 服务器返回消息 |
||||||||||||||||||
| data | 对象 | 若没有结果,则返回空白 |
||||||||||||||||||
| shipmentBoxId | 数值 | 合并配送号码 |
||||||||||||||||||
| orderId | 数值 | 订单号码 |
||||||||||||||||||
| orderedAt | 字符串 | YYYY-MM-DDThh:mm:ss.ssssss±hh:mm
|
||||||||||||||||||
| orderer | 对象 | 订购人信息 |
||||||||||||||||||
| name | 字符串 | 订购人名称 |
||||||||||||||||||
| 字符串 | 订购人邮箱
未使用/则会显示空值(“”)
|
|||||||||||||||||||
| safeNumber | 字符串 | |||||||||||||||||||
| ordererNumber | 字符串 | null
|
||||||||||||||||||
| paidAt | 字符串 | YYYY-MM-DDThh:mm:ss.ssssss±hh:mm
|
||||||||||||||||||
| status | 字符串 |
订单状态
|
||||||||||||||||||
| shippingPrice | 对象 | 配送费 |
||||||||||||||||||
| currencyCode | 字符串 | 货币码(符合ISO-4217標準),3位大写字母 | ||||||||||||||||||
| units | 数值 | 货币整数部分,64-bit | ||||||||||||||||||
| nanos | 数值 | 货币小数部分,32-bit,取值范围 [-999999999, 999999999] | ||||||||||||||||||
| remotePrice | 对象 | 偏远地区运送费 |
||||||||||||||||||
| currencyCode | 字符串 | 货币码(符合ISO-4217標準),3位大写字母 | ||||||||||||||||||
| units | 数值 | 货币整数部分,64-bit | ||||||||||||||||||
| nanos | 数值 | 货币小数部分,32-bit,取值范围 [-999999999, 999999999] | ||||||||||||||||||
| remoteArea | 布尔 | 收货地址是否为偏远地区 |
||||||||||||||||||
| parcelPrintMessage | 字符串 | 买家备注信息 |
||||||||||||||||||
| splitShipping | 布尔 | 是否为分开配送 |
||||||||||||||||||
| ableSplitShipping | 布尔 | 是否可以分开配送 |
||||||||||||||||||
| receiver | 对象 |
收货人信息
只有订单在付款完成状态下买家可以更改。 请在确认订单更改为“产品准备中”状态时检查收货地址是否有改变。
|
||||||||||||||||||
| name | 字符串 | 收货人姓名 |
||||||||||||||||||
| safeNumber | 字符串 | |||||||||||||||||||
| receiverNumber | 字符串 | null
|
||||||||||||||||||
| addr1 | 字符串 | 收货人地址1 |
||||||||||||||||||
| addr2 | 字符串 | 收货人地址2 |
||||||||||||||||||
| postCode | 字符串 | 收货人邮编 |
||||||||||||||||||
| orderItems | 数组 | 订单信息 |
||||||||||||||||||
| vendorItemPackageId | 数值 |
vendorItemPackageId
未使用/不存在则返回0
|
||||||||||||||||||
| vendorItemPackageName | 字符串 | vendorItemPackageName |
||||||||||||||||||
| productId | 数值 |
产品ID
未使用/不存在则返回0
|
||||||||||||||||||
| vendorItemId | 数值 | 产品单项ID/OptionID |
||||||||||||||||||
| vendorItemName | 字符串 | 产品显示名称 |
||||||||||||||||||
| shippingCount | 数值 |
shippingCount = 订购时的产品数量 holdCountForCancel = 被取消待退款的产品数量 cancelCount = 已经确认要被取消的产品数量 可配送产品数量 = shippingCount - (holdCountForCancel + cancelCount ) |
||||||||||||||||||
| salesPrice | 对象 | 产品单项的价格 |
||||||||||||||||||
| currencyCode | 字符串 | 货币码(符合ISO-4217標準),3位大写字母 | ||||||||||||||||||
| units | 数值 | 货币整数部分,64-bit | ||||||||||||||||||
| nanos | 数值 | 货币小数部分,32-bit,取值范围 [-999999999, 999999999] | ||||||||||||||||||
| orderPrice | 对象 | 付款金额: salesPrice*shippingCount |
||||||||||||||||||
| currencyCode | 字符串 | 货币码(符合ISO-4217標準),3位大写字母 | ||||||||||||||||||
| units | 数值 | 货币整数部分,64-bit | ||||||||||||||||||
| nanos | 数值 | 货币小数部分,32-bit,取值范围 [-999999999, 999999999] | ||||||||||||||||||
| discountPrice | 对象 | 打折金额总和, discountPrice(打折金额总和) = instantCouponDiscount(立减优惠券) + downloadableCoupon(下载优惠券) + coupangDiscount(Coupang 专享优惠) |
||||||||||||||||||
| currencyCode | 字符串 | 货币码(符合ISO-4217標準),3位大写字母 | ||||||||||||||||||
| units | 数值 | 货币整数部分,64-bit | ||||||||||||||||||
| nanos | 数值 | 货币小数部分,32-bit,取值范围 [-999999999, 999999999] | ||||||||||||||||||
| instantCouponDiscount | 对象 | 立减优惠券数额 |
||||||||||||||||||
| currencyCode | 字符串 | 货币码(符合ISO-4217標準),3位大写字母 | ||||||||||||||||||
| units | 数值 | 货币整数部分,64-bit | ||||||||||||||||||
| nanos | 数值 | 货币小数部分,32-bit,取值范围 [-999999999, 999999999] | ||||||||||||||||||
| downloadableCouponDiscount | 对象 | 下载优惠券数额 |
||||||||||||||||||
| currencyCode | 字符串 | 货币码(符合ISO-4217標準),3位大写字母 | ||||||||||||||||||
| units | 数值 | 货币整数部分,64-bit | ||||||||||||||||||
| nanos | 数值 | 货币小数部分,32-bit,取值范围 [-999999999, 999999999] | ||||||||||||||||||
| coupangDiscount | 对象 | Coupang 专享优惠
酷澎专享购物车/品类折扣等金额
|
||||||||||||||||||
| currencyCode | 字符串 | 货币码(符合ISO-4217標準),3位大写字母 | ||||||||||||||||||
| units | 数值 | 货币整数部分,64-bit | ||||||||||||||||||
| nanos | 数值 | 货币小数部分,32-bit,取值范围 [-999999999, 999999999] | ||||||||||||||||||
| externalVendorSkuCode | 字符串 | 卖家产品 SKU 代码 |
||||||||||||||||||
| etcInfoHeader | 字符串 |
各商品单项输入项
可选输入
|
||||||||||||||||||
| etcInfoValue | 字符串 | 各商品单项输入项的用户输入值
可选输入
此字段存在,但是没有任何值. 如果需要,请使用以下 etcInfoValues.
|
||||||||||||||||||
| etcInfoValues | 数组 | 用户产品单项各属性输入值列表
可选输入
|
||||||||||||||||||
| sellerProductId | 数值 | 卖家产品ID |
||||||||||||||||||
| sellerProductName | 字符串 | 注册产品名称 |
||||||||||||||||||
| sellerProductItemName | 字符串 | 产品单项名称 |
||||||||||||||||||
| firstSellerProductItemName | 字符串 | 原始注册产品单项名称 |
||||||||||||||||||
| cancelCount | 数值 | 已取消产品数量 | ||||||||||||||||||
| holdCountForCancel | 数值 | 被取消待退款的产品数量 |
||||||||||||||||||
| estimatedShippingDate | 字符串 |
yyyy-MM-dd
|
||||||||||||||||||
| plannedShippingDate | 字符串 |
yyyy-MM-dd
|
||||||||||||||||||
| invoiceNumberUploadDate | 字符串 |
YYYY-MM-DDThh:mm:ss.ssssss±hh:mm
|
||||||||||||||||||
| extraProperties | 对象 | 卖家商品属性的其它信息
key:value 类型
|
||||||||||||||||||
| pricingBadge | 布尔 |
是否为最低价
true/false
|
||||||||||||||||||
| usedProduct | 布尔 | 是否为二手货
true/false
|
||||||||||||||||||
| confirmDate | 字符串 |
YYYY-MM-DDThh:mm:ss.ssssss±hh:mm
|
||||||||||||||||||
| deliveryChargeTypeName | 字符串 | 配送收费类型
not-free, free
|
||||||||||||||||||
| canceled | 布尔 | 订单是否被取消
true/false
|
||||||||||||||||||
| overseaShippingInfoDto | 对象 | 海外运送信息 |
||||||||||||||||||
| personalCustomsClearanceCode | 字符串 | 个人海关通关码 |
||||||||||||||||||
| orderersSsn | 字符串 | 未使用 |
||||||||||||||||||
| ordererPhoneNumber | 字符串 | 收货人电话号码 (格式需符合E.164標準) |
||||||||||||||||||
| deliveryCompanyName | 字符串 | 物流配送公司名称
CJ Logistics, Hanjin Express, etc.
|
||||||||||||||||||
| invoiceNumber | 字符串 | 运单号码 |
||||||||||||||||||
| inTrasitDateTime | 字符串 |
YYYY-MM-DDThh:mm:ss.ssssss±hh:mm
|
||||||||||||||||||
| deliveredDate | 字符串 |
YYYY-MM-DDThh:mm:ss.ssssss±hh:mm
|
||||||||||||||||||
| refer | 字符串 | 付款设备信息:
iPhone, Android APP 或者 PC/Mobile 网页。
|
||||||||||||||||||
| shipmentType | 字符串 | 运送类型
THIRD_PARTY, CGF, CGF LITE
|
||||||||||||||||||
| isCod | 字符串 |
订单是否为货到付款配送 true/false |
||||||||||||||||||
| extraProperties | 对象 |
订单属性的其他信息 key:value 类型 有发票的市场会看到以下信息: receiptOption:
appliedType:发票类型,取值:
appliedValue:发票统编信息,取值:
SameDayShipping:是否当日出货(可选值):
cutOffTimeHour:晚于此时间当日出货不适用(可选值)
|
||||||||||||||||||
返回消息示例
{
"code": "200",
"message": "OK",
"data": {
"shipmentBoxId": 64253897***6401429,
"orderId": 500000596,
"orderedAt": "2025-01-15T14:17:13.973885-08:00",
"orderer": {
"name": "김문근",
"email": "",
"safeNumber": "+1(555)444-1234",
"ordererNumber": null
},
"paidAt": "2025-01-15T14:17:13.973885-08:00",
"status": "FINAL_DELIVERY",
"shippingPrice": {
"currencyCode": "KRW",
"units": 2500,
"nanos": 0
},
"remotePrice": {
"currencyCode": "KRW",
"units": 0,
"nanos": 0
},
"remoteArea": false,
"parcelPrintMessage": null,
"splitShipping": false,
"ableSplitShipping": false,
"receiver": {
"name": "test",
"safeNumber": "+1(555)444-1234",
"receiverNumber": null,
"addr1": "addr1",
"addr2": "addr2",
"postCode": "284-60"
},
"orderItems": [
{
"vendorItemPackageId": 0,
"vendorItemPackageName": "러비더비 섬유향수 보솔레이",
"productId": 2429,
"vendorItemId": 3000000177,
"vendorItemName": "러비더비 섬유향수 보솔레이, 500ml",
"shippingCount": 1,
"salesPrice": {
"currencyCode": "KRW",
"units": 14000,
"nanos": 0
},
"orderPrice": {
"currencyCode": "KRW",
"units": 14000,
"nanos": 0
},
"discountPrice": {
"currencyCode": "KRW",
"units": 500,
"nanos": 0
},
"instantCouponDiscount": {
"currencyCode": "KRW",
"units": 0,
"nanos": 0
},
"downloadableCouponDiscount": {
"currencyCode": "KRW",
"units": 500,
"nanos": 0
},
"coupangDiscount": {
"currencyCode": "KRW",
"units": 0,
"nanos": 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": "2025-01-15T14:17:13.973885-08:00",
"deliveryChargeTypeName": "무료",
"canceled": false
}
],
"overseaShippingInfoDto": {
"personalCustomsClearanceCode": null,
"ordererSsn": "",
"ordererPhoneNumber": ""
},
"deliveryCompanyName": "CJ 대한통운",
"invoiceNumber": "337398446274",
"inTrasitDateTime": "2025-01-15T14:17:13.973885-08:00",
"deliveredDate": "2025-01-15T14:17:13.973885-08:00",
"refer": "PC웹",
"shipmentType": "CGF LITE",
"isCod": false,
"extraProperties": {
"taxReceiptInfo": {
"appliedValue": null,
"receiptOption": "PAPER",
"appliedType": "PERSONAL_COUPANG_MEMBER_CARRIER"
},
"sameDayShipping": "true",
"cutOffTimeHour": "18"
}
}
}错误代码
| HTTP状态代码(错误类型) | 错误信息 | 解决方案 |
| 400 (确认请求参数) | 该订单已取消或退货。 | 请通过退货/取消申请列表查询API确认订单是否已被取消或退货,并确保该订单不被重复调用。 |
| 400 (确认请求参数) | 卖家ID无效。 | 请确认您输入的卖家ID(vendorld)是否正确。例】) A00012345 |
接口名称
GET_ORDERSHEET_BY_SHIPMENTBOX