未完成订单-列表
未完成订单指顾客在结账流程中未完成的订单,包括:顾客填写收货地址后就停止的订单、已提交但未支付的订单、支付失败的订单等。即顾客没有完成整个结账流程、没有进入订单完成页面的订单
接口信息
- 接口地址:
{your-site-url}/api/skill/order/get-pending-order-list
- 基础 URL:
{your-site-url} 需替换为你自己的独立站 URL 地址,如 https://your-domain.com/apimanager666
- 请求方式:
GET
- 说明: 此接口用于分页查询未完成订单列表。未完成订单指顾客在结账流程中未完成的订单,包括:顾客填写收货地址后就停止的订单、已提交但未支付的订单、支付失败的订单等。即顾客没有完成整个结账流程、没有进入订单完成页面的订单。
认证
请求头中需要携带 skill-access-token:
| Header |
值 |
skill-access-token |
{your-skill-access-token} (请替换为你自己的 token) |
请求参数 (Query String)
| 字段 |
类型 |
必填 |
说明 |
pageNum |
int |
否 |
页码,默认 1 |
pageSize |
int |
否 |
每页记录数 |
customer_id |
int |
否 |
顾客 ID,筛选指定顾客的订单 |
recall_status |
int |
否 |
召回状态。1 = 可召回,2 = 召回成功 |
created_at_begin |
string |
否 |
订单创建时间区间起始 |
created_at_end |
string |
否 |
订单创建时间区间结束 |
search_key |
string |
否 |
搜索字段,配合 search_val 使用。可选值:order_number、order_id、fist_loading_url、customer_email、customer_phone、coupon_code |
search_val |
string |
否 |
搜索值,配合 search_key 使用 |
请求示例
cURL
curl --location --request GET '{your-site-url}/api/skill/order/get-pending-order-list?pageNum=1&pageSize=20' \
--header 'skill-access-token: {your-skill-access-token}'
返回结果
code 为 200 表示调用成功;code 不为 200 表示调用失败。
成功响应
{
"code": 200,
"data": {
"list": [
{
"id": 6411,
"shop_id": 15,
"order_number": "FECE529650377664143",
"order_status": 1,
"customer_email": "1186735711@qq.com",
"customer_phone": "",
"created_at": "2026-05-29 22:30:37",
"updated_at": "2026-05-29 22:35:59",
"payment_status": 1,
"currency_code": "USD",
"curr_grand_total": "92.43",
"payed_at": 0,
"fulfillment_status": 1,
"shipping_method_name": "价格运费",
"payment_method": "",
"payment_name": "",
"recall_send_email_count": 0,
"recall_status": 2,
"client_type": 1,
"recalled_at": 0,
"recall_send_email_time": 0,
"items": [
{
"id": 7797,
"shop_id": 15,
"order_id": 6411,
"product_id": 7049,
"variant_id": 48964,
"spu": "",
"sku": "diamond-detail-in-gold-vermeil-0",
"variant_title": "",
"product_title": "Diamond Detail In Gold Vermeil复制",
"image": "/product/15/image/2026/05/23/c95f68bbf27f44d98b6882e6d8a1a301.jpg",
"gram": "0.00",
"base_price": "71.10",
"curr_price": "71.10",
"base_row_tax": "0.00",
"curr_row_tax": "0.00",
"addition_attr_base_price": "0.00",
"addition_attr_curr_price": "0.00",
"addition_attr": "",
"glasses_custom_base_price": "0.00",
"glasses_custom_curr_price": "0.00",
"glasses_customized": null,
"qty": 1,
"curr_row_price": "71.10",
"row_gram": "0.00",
"base_row_price": "71.10",
"is_reviewed": 2,
"over_sold_count": 0,
"created_at": 1780065037,
"updated_at": 1780065359,
"product_source_id": "",
"variant_source_id": "",
"source_type": 0
}
],
"shippingAddress": {
"id": 4302,
"shop_id": 15,
"order_id": 6411,
"first_name": "张",
"last_name": "三",
"phone": "",
"company": "",
"address_1": "辽源路街道",
"address_2": "4-4-403",
"city": "青岛",
"country_code": "AC",
"province_code": "",
"zip": "3443",
"created_at": 1780065037,
"updated_at": 1780065037
},
"txnid": null,
"callSts": 2
}
],
"total": 2450,
"pageSize": 20,
"totalPage": 123
},
"message": "success"
}
返回字段说明
订单主字段
| 字段 |
类型 |
说明 |
code |
Number |
状态码,200 表示成功 |
message |
String |
执行结果的文字描述 |
data.list |
Array[Object] |
未完成订单列表 |
data.total |
int |
总记录数 |
data.pageSize |
int |
每页记录数 |
data.totalPage |
int |
总页数 |
data.list[].id |
int |
订单 ID |
data.list[].shop_id |
int |
店铺 ID |
data.list[].order_number |
string |
订单编号 |
data.list[].order_status |
int |
订单状态。1 = 结账初始,2 = 已创建/进入订单流程,3 = 归档,4 = 已取消 |
data.list[].customer_email |
string |
下单用户邮箱 |
data.list[].customer_phone |
string |
用户手机号 |
data.list[].payment_method |
string |
支付方式标识 |
data.list[].payment_name |
string |
支付方式名称 |
data.list[].payment_status |
int |
支付状态。1 = 初始状态,2 = 待支付,21 = 等待支付审核,3 = 已支付,4 = 部分退款,5 = 已全部退款 |
data.list[].currency_code |
string |
下单当前货币 |
data.list[].curr_grand_total |
string |
订单总额(当前货币) |
data.list[].shipping_method_name |
string |
货运方式名称 |
data.list[].fulfillment_status |
int |
发货/履行状态。1 = 初始,2 = 未发货,3 = 挂起,4 = 部分发货,5 = 已全部发货,6 = 部分收货,7 = 全部收货,8 = 已全部退货 |
data.list[].client_type |
int |
客户端类型。1 = PC,2 = 平板,3 = 手机,4 = 后台创建,5 = 外部导入 |
data.list[].recall_status |
int |
召回状态。1 = 可召回,2 = 召回成功 |
data.list[].recalled_at |
string/int |
召回成功时间。0 或 null 表示未召回 |
data.list[].recall_send_email_count |
int |
召回邮件发送次数 |
data.list[].recall_send_email_time |
int |
召回邮件最后一次发送时间 |
data.list[].payed_at |
string/int |
支付时间。0 表示未支付 |
data.list[].created_at |
string |
创建时间 |
data.list[].updated_at |
string |
最后更新时间 |
data.list[].callSts |
int |
呼叫状态 |
订单商品 items
| 字段 |
类型 |
说明 |
data.list[].items[].id |
int |
订单商品记录 ID |
data.list[].items[].order_id |
int |
所属订单 ID |
data.list[].items[].product_id |
int |
商品 ID |
data.list[].items[].variant_id |
int |
规格变体 ID |
data.list[].items[].spu |
string |
商品 SPU |
data.list[].items[].sku |
string |
规格 SKU |
data.list[].items[].variant_title |
string |
规格变体名称 |
data.list[].items[].product_title |
string |
商品标题 |
data.list[].items[].image |
string |
商品图片。可能是相对路径或完整 URL。相对路径需拼接 attachment_url(从 得到网站基础URL 获取) |
data.list[].items[].gram |
string |
单品重量(克) |
data.list[].items[].base_price |
string |
单品单价(基础货币) |
data.list[].items[].curr_price |
string |
单品单价(当前货币) |
data.list[].items[].qty |
int |
购买数量 |
data.list[].items[].curr_row_price |
string |
行总金额 = 单价 × 数量(当前货币) |
data.list[].items[].row_gram |
string |
行总重量(克) |
data.list[].items[].base_row_price |
string |
行总金额(基础货币) |
data.list[].items[].base_row_tax |
string |
行税费(基础货币) |
data.list[].items[].curr_row_tax |
string |
行税费(当前货币) |
data.list[].items[].is_reviewed |
int |
是否已评价。1 = 已评价,2 = 未评价 |
data.list[].items[].over_sold_count |
int |
超卖个数 |
data.list[].items[].source_type |
int |
商品来源类型。0 = 自建,1 = 1688 |
data.list[].items[].product_source_id |
string |
商品来源 ID |
data.list[].items[].variant_source_id |
string |
规格来源 ID |
收货地址 shippingAddress
| 字段 |
类型 |
说明 |
data.list[].shippingAddress.id |
int |
地址记录 ID |
data.list[].shippingAddress.order_id |
int |
所属订单 ID |
data.list[].shippingAddress.first_name |
string |
收货人名字 |
data.list[].shippingAddress.last_name |
string |
收货人姓氏 |
data.list[].shippingAddress.phone |
string |
收货人电话 |
data.list[].shippingAddress.company |
string |
公司名称 |
data.list[].shippingAddress.address_1 |
string |
地址行 1 |
data.list[].shippingAddress.address_2 |
string |
地址行 2 |
data.list[].shippingAddress.city |
string |
城市 |
data.list[].shippingAddress.country_code |
string |
国家简码 |
data.list[].shippingAddress.province_code |
string |
省/州简码 |
data.list[].shippingAddress.province_name |
string |
省/州名称 |
data.list[].shippingAddress.zip |
string |
邮政编码 |
支付交易 txnid
| 字段 |
类型 |
说明 |
data.list[].txnid |
Object/null |
支付交易信息。未支付时为 null |
data.list[].txnid.order_id |
int |
所属订单 ID |
data.list[].txnid.txn_id |
string |
支付交易号 |
data.list[].txnid.payment_method |
string |
支付方式标识 |
注意事项
- 未完成订单与待处理订单的数据结构类似,但未完成订单的典型特征是
payed_at 为 0(未支付)、txnid 经常为 null
- 所有筛选参数均为选填,不传时返回全部未完成订单
items[].image 为相对路径时,完整图片 URL = attachment_url + image
recall_status 可用于筛选可召回(1)和已召回(2)的订单,适用于召回邮件营销场景
- 时间筛选可单独传起始或结束,也可组合使用