诺云开放平台

Appearance

供应商履约商品列表 ​

请求路径 ​

  • 请求方式：POST
  • 请求头：Content-Type:application/json
  • 接口地址：https://gateway.nuoyunapi.com/Api/Supplier/getFulfillGoodsList/2.0.0
  • 频率限制：10秒1000次

说明 ​

  • 按履约批次分页返回诺云商品、订单、供应商、发货目标和发货时间。
  • 一条 list 记录对应一个履约批次，批次中的订单商品或 SKU 明细通过 goods_list 返回。
  • 批次级返回同步数量、应发数量、已发数量和取消数量；商品明细不返回无法准确归属的 SKU 已发数量。
  • 商户 uid 由 API 鉴权结果带入，仅返回当前账号的数据，请求参数无需传入 uid。

请求参数 ​

参数必选类型描述
page是integer页码，从 1 开始
page_size是integer每页数量，范围 1～100
supplier_id否integer供应商 ID，精确查询
goods_id否integer诺云商品 ID，精确查询
ship_start_time否string发货开始时间，格式：YYYY-MM-DD HH:mm:ss
ship_end_time否string发货结束时间，格式：YYYY-MM-DD HH:mm:ss

请求示例 ​

json
{
    "page": 1,
    "page_size": 20,
    "supplier_id": 10001,
    "goods_id": 20001,
    "ship_start_time": "2026-09-01 00:00:00",
    "ship_end_time": "2026-09-30 23:59:59"
}

响应参数 ​

参数必选类型描述
code是integer状态码：200-成功，400-失败
msg是string提示信息
trace_id否string链路追踪 ID
data是object响应内容

data 参数结构 ​

参数必选类型描述
total是integer符合条件的履约批次总数
list是array履约批次列表

list 参数结构 ​

参数必选类型描述
batch_no是string履约批次编号
supplier_id是integer供应商 ID
supplier_name是string供应商名称
store_id是integer发货目标门店、自提点或虚拟商品门店 ID
store_name是string发货目标名称
receiver_name是string收货联系人
receiver_phone是string收货联系方式
receiver_address是string收货地址
fulfill_type是integer履约方式：1-门店物流，2-快递到家
ship_status是integer发货状态：1-待发货，2-发货中，3-已完成，4-已关闭，5-部分发货
sync_qty是integer批次锁单同步数量
need_deliver_qty是integer批次应发数量：同步数量减取消数量
delivered_qty是integer批次普通发货物流单累计已发数量
cancel_qty是integer批次锁单后成功退款形成的取消数量
lock_time是string锁单时间
ship_time是string首次发货时间；未发货时为空字符串
complete_ship_time是string完成发货时间
create_time是string履约批次创建时间
goods_list是array批次中的订单商品或 SKU 明细

goods_list 参数结构 ​

参数必选类型描述
order_id是integer订单 ID
order_sn是string订单号
goods_id是integer诺云商品 ID
sku_id是integerSKU ID，非 SKU 商品为 0
goods_name是string商品名称
sync_qty是integer锁单同步数量
need_deliver_qty是integer应发数量：同步数量减取消数量
cancel_qty是integer锁单后成功退款形成的取消数量

响应示例 ​

json
{
    "code": 200,
    "msg": "Success",
    "trace_id": "trace_****",
    "data": {
        "total": 1,
        "list": [
            {
                "batch_no": "SF202609180001",
                "supplier_id": 10001,
                "supplier_name": "示例供应商",
                "store_id": 50001,
                "store_name": "示例门店",
                "receiver_name": "门店联系人",
                "receiver_phone": "138****8000",
                "receiver_address": "示例省示例市示例区示例路",
                "fulfill_type": 1,
                "ship_status": 3,
                "sync_qty": 3,
                "need_deliver_qty": 2,
                "delivered_qty": 2,
                "cancel_qty": 1,
                "lock_time": "2026-09-18 10:00:00",
                "ship_time": "2026-09-18 11:00:00",
                "complete_ship_time": "2026-09-18 11:00:00",
                "create_time": "2026-09-18 10:00:00",
                "goods_list": [
                    {
                        "order_id": 40001,
                        "order_sn": "26091800000000000000000001",
                        "goods_id": 20001,
                        "sku_id": 21001,
                        "goods_name": "示例商品",
                        "sync_qty": 2,
                        "need_deliver_qty": 1,
                        "cancel_qty": 1
                    },
                    {
                        "order_id": 40002,
                        "order_sn": "26091800000000000000000002",
                        "goods_id": 20001,
                        "sku_id": 21002,
                        "goods_name": "示例商品",
                        "sync_qty": 1,
                        "need_deliver_qty": 1,
                        "cancel_qty": 0
                    }
                ]
            }
        ]
    }
}

状态码说明 ​

状态码描述
200成功
400失败，如参数格式不正确

鉴权说明 ​

本接口为 OpenAPI 2.0.0 接口，需使用 API 鉴权（X-Ca-Key、X-Ca-Secret 或 X-Ca-Timestamp + X-Ca-Md5 签名），详见 接口签名介绍。