开放Api-未支付订单列表

接口信息

  • 接口地址: {your-site-url}/manager/api/apps/openapi/order/get-pending-order-list
  • 基础 URL: {your-site-url} 需替换为你自己的独立站 URL 地址,如 https://your-domain.com
  • 请求方式: GET
  • 说明: 此接口通过 OpenAPI 通道获取店铺的订单列表,支持多条件筛选和分页

认证

此接口使用 OpenAPI 通道认证,需要同时携带以下请求头:

Header 说明
open-access-token {your-open-access-token} OpenAPI 访问令牌

请求参数 (Query String)

字段 类型 必填 说明
pageNum int 选填 第几页,不填写则默认第 1 页
pageSize int 选填 每页的数据个数,不填写则使用系统默认值
customer_id int 选填 客户 ID(前台商城注册用户的 ID),用于筛选指定客户的订单
recall_status int 选填 召回状态。1 = 可召回,2 = 召回成功
created_at_begin string 选填 订单创建时间区间 - 开始,如 2026-05-01 00:00:00
created_at_end string 选填 订单创建时间区间 - 结束,如 2026-05-25 23:59:59
search_key string 选填 搜索的键名,值可为下面枚举之一
search_val string 选填 搜索的值,与 search_key 对应

search_key 枚举值

对应搜索字段
order_number 订单编号
order_id 订单 ID
fist_loading_url 首单来源 URL
customer_email 客户邮箱
customer_phone 客户电话
coupon_code 优惠券码

search_keysearch_val 必须成对使用。


请求示例

cURL

curl --location --request GET '{your-site-url}/manager/api/apps/openapi/order/get-pending-order-list?pageNum=1&pageSize=20' \
--header 'open-access-token: {your-open-access-token}' \
--data-raw ''

按订单编号搜索

curl --location --request GET '{your-site-url}/manager/api/apps/openapi/order/get-pending-order-list?search_key=order_number&search_val=E522522103542077' \
--header 'open-access-token: {your-open-access-token}' \
--data-raw ''

按客户邮箱筛选

curl --location --request GET '{your-site-url}/manager/api/apps/openapi/order/get-pending-order-list?search_key=customer_email&search_val=fecify@126.com' \
--header 'open-access-token: {your-open-access-token}' \
--data-raw ''

返回结果

code200 表示调用成功;code 不为 200 表示调用失败。

成功响应

{
    "code": 200,
    "data": {
        "list": [
            {
                "id": 6385,
                "shop_id": 15,
                "order_number": "E522522103542077",
                "order_status": 4,
                "customer_email": "fecify@126.com",
                "customer_phone": "8632132",
                "created_at": "2026-05-22 20:16:50",
                "updated_at": "2026-05-22 20:16:52",
                "payment_status": 1,
                "currency_code": "USD",
                "curr_grand_total": "103.70",
                "payed_at": 0,
                "fulfillment_status": 1,
                "shipping_method_name": "Fast Shipping (UPS/DHL Express):5-7 Days",
                "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": 7771,
                        "shop_id": 15,
                        "order_id": 6385,
                        "product_id": 6827,
                        "variant_id": 48402,
                        "spu": "",
                        "sku": "copy-of-braided-sandals-black-0",
                        "variant_title": "S / Red",
                        "product_title": "24/7™ Classic T-Shirt Bra",
                        "image": "/product/15/image/2026/05/16/7d244a53e388e73a092839371c39f44a.png",
                        "gram": "0.00",
                        "base_price": "79.00",
                        "curr_price": "79.00",
                        "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": "79.00",
                        "row_gram": "0.00",
                        "base_row_price": "79.00",
                        "is_reviewed": 2,
                        "over_sold_count": 0,
                        "created_at": 1779452210,
                        "updated_at": 1779452212,
                        "product_source_id": "",
                        "variant_source_id": "",
                        "source_type": 0
                    }
                ],
                "shippingAddress": {
                    "id": 4276,
                    "shop_id": 15,
                    "order_id": 6385,
                    "first_name": "Terry",
                    "last_name": "zhao",
                    "phone": "8632132",
                    "company": "",
                    "address_1": "chong qing zhong lu 227",
                    "address_2": "",
                    "city": "qingdao",
                    "country_code": "US",
                    "province_code": "AA",
                    "zip": "323232",
                    "created_at": 1779452210,
                    "updated_at": 1779452210,
                    "province_name": "Armed Forces Americas"
                },
                "txnid": null,
                "callSts": 2
            }
        ],
        "total": 2434,
        "pageSize": 20,
        "totalPage": 122
    },
    "message": "success"
}

返回字段说明

data 顶层字段

字段 类型 说明
total int 订单总数
pageSize int 每页的数据个数
totalPage int 总页数
list Array[Object] 订单列表

list 子项字段(订单基本信息)

字段 类型 说明
id int 订单 ID
shop_id int 店铺 ID
order_number string 订单编号
client_type int 客户端类型。1 = PC,2 = 平板,3 = 手机,4 = 后台创建,5 = 外部导入
order_status int 订单状态。1 = checkout edit 状态,2 = open 状态,3 = 归档状态,4 = 取消状态
payment_status int 支付状态。1 = 初始状态,2 = 待支付,3 = 已支付,4 = 部分退款,5 = 已全部退款
fulfillment_status int 发货状态(履行)。1 = 初始状态,2 = 未发货,3 = 挂起,4 = 部分履行发货,5 = 已发货(已全部履行),6 = 部分收货,7 = 全部收货,8 = 已全部退货
checkout_type int 结账类型。1 = 购物车结账,2 = 产品页面点击立即购买结账,3 = 后台创建结账
lang_code string 用户访问网站的语言(网站语言,非浏览器语言)
items_count int 订单产品总个数
gram int 订单总重量(克)
currency_code string 订单当前货币
base_currency_code string 基础货币
order_to_base_rate string 当前货币和基础货币之间的汇率
curr_subtotal string 订单商品总额(当前货币)
base_subtotal string 订单商品总额(基础货币)
curr_shipping_total string 订单运费(当前货币)
base_shipping_total string 订单运费(基础货币)
curr_subtotal_with_discount string 订单折扣(当前货币)
base_subtotal_with_discount string 订单折扣(基础货币)
curr_grand_total string 订单总额(当前货币)
base_grand_total string 订单总额(基础货币)
customer_type string 客户类型。1 = 游客,2 = 注册用户
customer_id string 下单用户 ID
customer_email string 下单用户 Email
customer_phone string 下单用户电话
discount_set string 折扣信息(数组格式,包含优惠券、满减折等折扣信息及金额详情)
payment_method string 支付方式
payment_fee string 支付服务费
shipping_method_id string 货运方式 ID
shipping_method_name string 货运方式名称
note string 订单备注
cancelled_at string 订单取消时间
cancel_reason int 订单取消原因。1 = 用户取消,2 = 后台取消
payed_at string 订单支付时间
created_at string 订单创建时间
updated_at string 订单更新时间
recall_status int 订单召回状态。1 = 不可召回(如游客下单还未填写地址),2 = 可召回(填写了 address/email),3 = 已召回(支付成功,货到付款类型除外)
fulfilled_at string 履行时间(发货时间)。如有多个包裹,为最后一个包裹的发货时间
post_saled_at string 售后时间
post_sale_status int 售后状态。1 = 初始状态,2 = 已发起售后/售后处理中,3 = 售后已完成
over_sold_count int 超卖个数
items Array[Object] 订单产品列表
shippingAddress Object 收货地址
billingAddress Object 选填,账单地址

items 子项字段

字段 类型 说明
id int 订单产品记录 ID
shop_id int 店铺 ID
order_id int 订单 ID
product_id int 产品 ID
variant_id int 产品变体 ID(规格 ID)
sku string 产品 SKU
variant_title string 产品变体标题
product_title string 产品标题
product_handle string 产品 URL handle
image string 产品图片
gram float 产品单重(克)
base_price float 产品单价(基础货币)
curr_price float 产品单价(当前货币)
qty int 产品个数
curr_row_price float 产品金额小计(当前货币)= 单价 × 个数
row_gram int 产品重量小计 = 单重 × 个数
base_row_price float 产品金额小计(基础货币)= 单价 × 个数
is_reviewed int 是否已评价。1 = 已评价,2 = 未评价

shippingAddress 字段

字段 类型 说明
id int 收货地址 ID
shop_id int 店铺 ID
order_id int 订单 ID
first_name string
last_name string
phone string 电话号码
address_1 string 详细地址 1
address_2 string 详细地址 2
city string 城市
country_code string 国家代码
province_code string 省份代码
zip string 邮政编码

billingAddress 字段(选填)

字段 类型 说明
id int 选填,账单地址 ID
shop_id int 选填,店铺 ID
order_id int 选填,订单 ID
first_name string 选填,名
last_name string 选填,姓
address_1 string 选填,详细地址 1
address_2 string 选填,详细地址 2
city string 选填,城市
country_code string 选填,国家代码
province_code string 选填,省份代码
zip string 选填,邮政编码

注意事项

  1. 此接口为 GET 请求,参数通过 Query String 传递
  2. search_keysearch_val 必须成对使用,单独传一个无效
  3. 订单金额有 base_(基准货币)和 curr_(当前货币)两套字段,curr_ 系列为前台用户实际看到的金额
  4. source_type1 时表示该商品来源于代发平台(如 1688),可通过 product_source_id / variant_source_id 追溯
  5. over_sold_count > 0 表示存在超卖
Copyright © fecify.com 2025 all right reserved,powered by Gitbook该文件修订时间: 2026-05-25 04:33:16

results matching ""

    No results matching ""