可通过按天分页的方式查询订单列表。例) (2022-02-01~2022-02-03)
注意:CGF 订单不会通过 Open API 返回给您。 请通过 Wing 查看。
可通过maxPerPage参数调整每页row的大小,下一页可通过[nextToken]获取。除部分Path Parameter外,整体配置与订单列表查询相同(以分钟为单位)。
※ 顾客可在付款完成后修改收货地址,因此将商品状态处理为“商品准备中”后,请务必更新配送地信息("receiver")(使用单个订单查询API更便捷)。
※ 订单数量较多时,订单列表查询可能会出现超时错误。请确认[如何解决超时错误],延长超时时间。
※ 订单列表中无法查看已完成退货的订单,请通过“退货/取消申请列表查询”API查看。
- 发货前,请一定要确认"sellerProductName + sellerProductItemName"和"vendorItemName"上的信息是否一致。
- 构成、数量、容量等有不同时,请先暂停发货,通过在线咨询申请的话我们会尽快给予帮助的。(商品信息显示错误。> 请选择“是”来申请。)
- 若确认为错误显示,扣除的卖家分数就会恢复。
路径
GET
/v2/providers/openapi/apis/api/v4/vendors/{vendorId}/ordersheets
示例
请求参数
Name |
|
Required |
Type |
Description |
vendorId |
O |
|
String |
卖家ID 酷澎提供给卖家的固有代码 ex) A00012345 |
链接查询参数
Name | Required | Type | Description | |||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
createdAtFrom | O | 字符串 |
查询起始时间
查询起始时间请按照此格式填写 "yyyy-mm-dd"
ex) 2018-07-01 |
|||||||||||||||||
createdAtTo | O | 字符串 |
查询结束时间
查询结束时间请按照此格式填写 "yyyy-mm-dd"
ex) 2018-07-31 最多可以查询31天
|
|||||||||||||||||
status | O | 字符串 |
订单状态
|
|||||||||||||||||
nextToken | 字符串 |
请求下一页内容时所需的 Token 值
查询第一页内容时无需填写此字段值.
每页最多返回50个订单. 请使用 [nextToken] 来查询之后的页面
|
||||||||||||||||||
maxPerPage | 数值 |
每页返回的最大订单数量
默认为 50
|
||||||||||||||||||
searchType | 字符串 |
订单列表查询类型
当 "searchType=timeFrame" 时,使用的是按分钟查询订单列表功能。除此之外,使用的是按天查询订单列表功能。
|
请求体
无
返回消息
Name | Type | Description | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
code | 数值 |
服务器返回码
|
||||||||||||||||||
message | 字符串 |
服务器返回消息
|
||||||||||||||||||
data | 数组 |
结果列表
若没有结果,则返回空白列表 |
||||||||||||||||||
shipmentBoxId | 数值 |
合并配送号码
|
||||||||||||||||||
orderId | 数值 |
订单号码
|
||||||||||||||||||
orderedAt | 字符串 |
订单日期/时间
yyyy-MM-dd'T'HH:mm:ss
|
||||||||||||||||||
orderer | 对象 |
订购人信息
|
||||||||||||||||||
name | 字符串 |
订购人名称
|
||||||||||||||||||
字符串 |
订购人邮箱
未使用/则会显示空值(“”)
|
|||||||||||||||||||
safeNumber | 字符串 |
收货人电话号码(安全号码)
|
||||||||||||||||||
ordererNumber | 字符串 |
订购人联系方式 (真实电话号码)
null
|
||||||||||||||||||
paidAt | 字符串 |
付款完成时的日期/时间
yyyy-MM-dd'T'HH:mm:ss
|
||||||||||||||||||
status | 字符串 |
订单状态
|
||||||||||||||||||
shippingPrice | 数值 |
配送费
|
||||||||||||||||||
remotePrice | 数值 |
偏远地区运送费
|
||||||||||||||||||
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 | 数值 |
产品单项的价格
|
||||||||||||||||||
orderPrice | 数值 |
付款金额: salesPrice*shippingCount
|
||||||||||||||||||
discountPrice | 数值 |
打折金额总和,
discountPrice(打折金额总和) = instantCouponDiscount(立减优惠券) + downloadableCoupon(下载优惠券) + coupangDiscount(Coupang 专享优惠) |
||||||||||||||||||
instantCouponDiscount | 数值 |
立减优惠券数额
|
||||||||||||||||||
downloadableCouponDiscount | 数值 |
下载优惠券数额
|
||||||||||||||||||
coupangDiscount | 数值 |
Coupang 专享优惠
酷澎专享购物车/品类折扣等金额
|
||||||||||||||||||
externalVendorSkuCode | 字符串 |
卖家产品 SKU 代码
|
||||||||||||||||||
etcInfoHeader | 字符串 |
各商品单项输入项
可选输入
|
||||||||||||||||||
etcInfoValue | 字符串 |
各商品单项输入项的用户输入值
可选输入
此字段存在,但是没有任何值. 如果需要,请使用以下 etcInfoValues.
|
||||||||||||||||||
etcInfoValues | 数组 |
用户产品单项各属性输入值列表
可选输入
|
||||||||||||||||||
sellerProductId | 数值 |
卖家产品ID
|
||||||||||||||||||
sellerProductName | 字符串 |
注册产品名称
|
||||||||||||||||||
sellerProductItemName | 字符串 |
产品单项名称
|
||||||||||||||||||
firstSellerProductItemName | 字符串 |
原始注册产品单项名称
|
||||||||||||||||||
cancelCount | 数值 | 已取消产品数量 | ||||||||||||||||||
holdCountForCancel | 数值 |
被取消待退款的产品数量
|
||||||||||||||||||
estimatedShippingDate | 字符串 |
收到订单后预计发货日期
yyyy-MM-dd
|
||||||||||||||||||
plannedShippingDate | 字符串 |
计划发货日期(拆分发货订单)
yyyy-MM-dd
|
||||||||||||||||||
invoiceNumberUploadDate | 字符串 |
运单号上传日期
yyyy-MM-dd'T'HH:mm:ss
|
||||||||||||||||||
extraProperties | 对象 |
卖家商品属性的其它信息
key:value 类型
|
||||||||||||||||||
pricingBadge | 布尔 |
是否为最低价
true/false
|
||||||||||||||||||
usedProduct | 布尔 |
是否为二手货
true/false
|
||||||||||||||||||
confirmDate | 字符串 |
确认收货日期时间
yyyy-MM-dd HH:mm:ss
|
||||||||||||||||||
deliveryChargeTypeName | 字符串 |
配送收费类型
not-free, free
|
||||||||||||||||||
canceled | 布尔 |
订单是否被取消
true/false
|
||||||||||||||||||
overseaShippingInfoDto | 对象 |
海外运送信息
|
||||||||||||||||||
personalCustomsClearanceCode | 字符串 |
个人海关通关码 |
||||||||||||||||||
orderersSsn | 字符串 |
未使用 |
||||||||||||||||||
ordererPhoneNumber | 字符串 |
订购人电话号码 |
||||||||||||||||||
deliveryCompanyName | 字符串 |
物流配送公司名称
CJ Logistics, Hanjin Express, etc.
|
||||||||||||||||||
invoiceNumber | 字符串 |
运单号码
|
||||||||||||||||||
inTrasitDateTime | 字符串 |
配送日期时间 (开始运送时间)
yyyy-MM-dd HH:mm:ss
|
||||||||||||||||||
deliveredDate | 字符串 |
配送完成日期时间
yyyy-MM-dd HH:mm:ss
|
||||||||||||||||||
refer | 字符串 |
付款设备信息:
iPhone, Android APP 或者 PC/Mobile 网页。
|
||||||||||||||||||
shipmentType | 字符串 |
运送类型
THIRD_PARTY, CGF, CGF LITE
|
||||||||||||||||||
nextToken | 字符串 |
请求下一页内容时所需的 Token 值。若无下一页,则为 “”。
|
返回消息示例
{
"code": 200,
"message": "OK",
"data": [
{
"shipmentBoxId": 64253897***6401429,
"orderId": 22000009546234,
"orderedAt": "2017-10-10T10:20:16",
"orderer": {
"name": "신*희",
"email": "",
"safeNumber": "0503-**-5464",
"ordererNumber": null
},
"paidAt": "2017-10-10T10:20:16",
"status": "FINAL_DELIVERY",
"shippingPrice": 2500,
"remotePrice": null,
"remoteArea": false,
"parcelPrintMessage": "문 앞",
"splitShipping": false,
"ableSplitShipping": false,
"receiver": {
"name": "신*희",
"safeNumber": "0503-**-5464",
"receiverNumber": null,
"addr1": "경기 오산시 가수동 **아파트",
"addr2": "109동 *호",
"postCode": "447-700"
},
"orderItems": [
{
"vendorItemPackageId": 0,
"vendorItemPackageName": "인디고뱅크키즈 기모 테잎배색 트레이닝 팬츠 IKTM17WG1",
"productId": 31846051,
"vendorItemId": 3242596358,
"vendorItemName": "인디고뱅크키즈 기모 테잎배색 트레이닝 팬츠 IKTM17WG1, 07 DARK GREY, 160호",
"shippingCount": 1,
"salesPrice": 19000,
"orderPrice": 19000,
"discountPrice": 3000,
"instantCouponDiscount": 2000,
"downloadableCouponDiscount": 1000,
"coupangDiscount": 0,
"externalVendorSkuCode": "170816368810",
"etcInfoHeader": null,
"etcInfoValue": null,
"etcInfoValues": [
"추가메시지1",
"추가메시지2"
],
"sellerProductId": 80240831,
"sellerProductName": "인디고뱅크키즈 A5 기모 배색츄키니 IKTM17WG1",
"sellerProductItemName": "07 DARK GREY 160호",
"firstSellerProductItemName": "07 DARK GREY/160호",
"cancelCount": 0,
"holdCountForCancel": 0,
"estimatedShippingDate": "2017-10-16",
"plannedShippingDate": "",
"invoiceNumberUploadDate": "",
"extraProperties": {},
"pricingBadge": false,
"usedProduct": false,
"confirmDate": "2017-10-25 00:10:33",
"deliveryChargeTypeName": "유료",
"canceled": false
}
],
"overseaShippingInfoDto": {
"personalCustomsClearanceCode": "",
"ordererSsn": "",
"ordererPhoneNumber": ""
},
"deliveryCompanyName": "CJ 대한통운",
"invoiceNumber": "340010913442",
"inTrasitDateTime": "2017-10-16 22:08:04",
"deliveredDate": "2017-10-17 17:17:52",
"refer": "안드로이드앱"
},
{
"shipmentBoxId": 64253897***6401428,
"orderId": 22000009546630,
"orderedAt": "2017-10-10T10:35:04",
"orderer": {
"name": "김*숙",
"email": "hs*****@na",
"safeNumber": "0503-**-5013",
"ordererNumber": null
},
"paidAt": "2017-10-10T10:35:04",
"status": "FINAL_DELIVERY",
"shippingPrice": 0,
"remotePrice": null,
"remoteArea": false,
"parcelPrintMessage": "직접 받고 부재 시 문 앞",
"splitShipping": false,
"ableSplitShipping": false,
"receiver": {
"name": "김*숙",
"safeNumber": "0502-344-6681",
"receiverNumber": null,
"addr1": "경기 광명시 하안1동 두산트레지움아파트",
"addr2": "107동701호",
"postCode": "423-747"
},
"orderItems": [
{
"vendorItemPackageId": 0,
"vendorItemPackageName": "리틀브렌 후드달이 구스 경량 점퍼 LBJD17WG5",
"productId": 34047877,
"vendorItemId": 3261300431,
"vendorItemName": "리틀브렌 후드달이 구스 경량 점퍼 LBJD17WG5, 04 MIDDLE MELANGE GR, 170호",
"shippingCount": 1,
"salesPrice": 27800,
"orderPrice": 27800,
"discountPrice": 2470,
"instantCouponDiscount": 560,
"downloadableCouponDiscount": 1910,
"coupangDiscount": 0,
"externalVendorSkuCode": "170824416510",
"etcInfoHeader": null,
"etcInfoValue": null,
"etcInfoValues": [
"추가메시지1",
"추가메시지2"
],
"sellerProductId": 87037167,
"sellerProductName": "리틀브렌 후드달이 구스 경량 점퍼 LBJD17WG5",
"sellerProductItemName": "04 MIDDLE MELANGE GR 170호",
"firstSellerProductItemName": "04 MIDDLE MELANGE GR/170호",
"cancelCount": 0,
"holdCountForCancel": 0,
"estimatedShippingDate": "2017-10-16",
"plannedShippingDate": "",
"invoiceNumberUploadDate": "",
"extraProperties": {},
"pricingBadge": false,
"usedProduct": false,
"confirmDate": "2017-10-25 02:10:27",
"deliveryChargeTypeName": "무료",
"canceled": false
}
],
"overseaShippingInfoDto": {
"personalCustomsClearanceCode": "",
"ordererSsn": "",
"ordererPhoneNumber": ""
},
"deliveryCompanyName": "CJ 대한통운",
"invoiceNumber": "340010912565",
"inTrasitDateTime": "2017-10-16 22:08:04",
"deliveredDate": "2017-10-17 20:42:23",
"refer": "안드로이드앱",
"shipmentType": "CGF LITE"
}
],
"nextToken": "448537989"
}
错误代码
HTTP状态代码(错误类型) |
错误信息 |
解决方案 |
400 (确认请求参数) |
Invalid vendor ID |
请确认您输入的卖家ID(vendorId) 是否正确。 例) A00012345 |
400 (确认请求参数) |
endTime-startTime range should less than31. |
请确认查询时间段是否小于31天。 |
接口名称
GET_ORDERSHEET