Appearance

销售管理 API ​

1. 接口概述 ​

销售管理 API 提供了销售单信息的查询功能。通过这些接口，您可以获取系统中的销售单列表、销售金额统计、发货单列表以及销售单更新列表信息。

2. 接口列表 ​

接口名方法功能描述
sales.getListPOST批量获取指定条件下的销售单列表
sales.getSalesAmountPOST按条件汇总销售金额
sales.getDeliveryListPOST获取销售单发货列表

3. 系统级参数 ​

系统级参数是调用所有接口都必须提供的参数：

参数名类型必填名称描述
flagstring是应用标识用于标识调用方身份
methodstring是接口方法名例如：sales.getList
vernumber是版本号固定为1
charsetstring是字符集固定为utf-8
typestring是返回格式固定为json
timestampstring是时间戳格式：yyyyMMddHHmmss
signstring是签名用于验证请求的合法性

4. 接口详细说明 ​

4.1 批量获取指定条件下的销售单列表 ​

请求参数 ​

参数名类型必填描述
start_timestring否创建时间开始（格式：yyyy-MM-dd HH:mm:ss）
end_timestring否创建时间结束（格式：yyyy-MM-dd HH:mm:ss）
page_noint是页码，默认 1
page_sizeint是每页条数，默认 50，最大 1000
shop_bnstring否店铺编号
bnstring否销售单号
statusstring否状态：succ-成功, failure-失败, pending-待处理

响应参数 ​

参数名类型描述
countint总记录数
listsarray销售单列表

lists 数组中的每个对象包含以下字段：

参数名类型描述
shop_codestring店铺编码
shop_namestring店铺名称
order_nostring订单编号
order_typestring订单类型
member_namestring会员名称
sale_nostring销售单号
pay_methodstring支付方式
sale_timestring销售时间（格式：yyyy-MM-dd HH:mm:ss）
order_create_timestring订单创建时间（格式：yyyy-MM-dd HH:mm:ss）
pay_timestring支付时间（格式：yyyy-MM-dd HH:mm:ss）
ship_timestring发货时间（格式：yyyy-MM-dd HH:mm:ss）
order_check_opstring订单审核操作员
order_check_timestring订单审核时间（格式：yyyy-MM-dd HH:mm:ss）
goods_amountdecimal商品金额
freight_amountdecimal运费金额
additional_amountdecimal附加费用
has_taxstring是否含税（是/否）
pmt_amountdecimal优惠金额
sale_amountdecimal销售金额
logi_namestring物流公司名称
logi_codestring物流公司编码
logi_nostring物流单号
branch_namestring仓库名称
branch_bnstring仓库编码
delivery_nostring发货单号
consigneestring收货人
consignee_areastring收货地区
consignee_addrstring收货地址
consignee_zipstring邮政编码
consignee_telstring收货电话
consignee_mobilestring收货手机
consignee_emailstring收货邮箱
weightdecimal重量
delivery_cost_actualdecimal实际运费
order_memostring订单备注
tax_titlestring发票抬头
relate_order_bnstring关联订单号
settlement_amountdecimal结算金额
platform_amountdecimal平台承担金额
order_sourcestring订单来源
agent_infostring代销信息
sale_itemsarray销售商品明细

sale_items 数组中的每个对象包含以下字段：

参数名类型描述
item_idint商品ID
bnstring商品编码
namestring商品名称
spec_namestring规格名称
barcodestring条码
pricedecimal价格
numsint数量
pmt_pricedecimal优惠价格
sale_pricedecimal销售价格
apportion_pmtdecimal分摊优惠
sales_amountdecimal销售金额
costdecimal成本
cost_amountdecimal成本金额
order_item_idint订单明细ID
item_typestring商品类型
type_namestring类型名称
sales_material_bnstring销售物料编码
sales_material_namestring销售物料名称
retail_pricedecimal基础物料价格
brand_codestring物料品牌
cat_namestring物料分类
goods_typestring物料属性
shop_goods_idstring平台商品ID
shop_product_idstring平台SkuID
settlement_amountdecimal结算金额
platform_amountdecimal平台承担金额

请求示例 ​

请参考openapi.md文档中【6. 接口调用示例】。

响应示例 ​

json
{
  "count": 100,
  "lists": [
    {
      "shop_code": "SHOP001",
      "shop_name": "测试店铺",
      "order_no": "ORDER20240101001",
      "order_type": "normal",
      "member_name": "张三",
      "sale_no": "SALES202401010001",
      "pay_method": "alipay",
      "sale_time": "2024-01-01 10:00:00",
      "order_create_time": "2024-01-01 09:00:00",
      "pay_time": "2024-01-01 09:30:00",
      "ship_time": "2024-01-01 10:30:00",
      "order_check_op": "admin",
      "order_check_time": "2024-01-01 09:15:00",
      "goods_amount": 1000.00,
      "freight_amount": 10.00,
      "additional_amount": 0.00,
      "has_tax": "否",
      "pmt_amount": 50.00,
      "sale_amount": 960.00,
      "logi_name": "顺丰速运",
      "logi_code": "SF",
      "logi_no": "SF1234567890",
      "branch_name": "测试仓库",
      "branch_bn": "WH001",
      "delivery_no": "DEL20240101001",
      "consignee": "李四",
      "consignee_area": "北京市/北京市/朝阳区",
      "consignee_addr": "测试路1号",
      "consignee_zip": "100000",
      "consignee_tel": "010-12345678",
      "consignee_mobile": "13800138000",
      "consignee_email": "test@example.com",
      "weight": 1.5,
      "delivery_cost_actual": 10.00,
      "order_memo": "测试订单",
      "tax_title": "",
      "relate_order_bn": "",
      "settlement_amount": 960.00,
      "platform_amount": 0.00,
      "order_source": "pc",
      "agent_info": "",
      "sale_items": [
        {
          "item_id": 1,
          "bn": "PROD001",
          "name": "测试商品",
          "spec_name": "标准规格",
          "barcode": "1234567890123",
          "price": 100.00,
          "nums": 10,
          "pmt_price": 95.00,
          "sale_price": 95.00,
          "apportion_pmt": 5.00,
          "sales_amount": 950.00,
          "cost": 80.00,
          "cost_amount": 800.00,
          "order_item_id": 1,
          "item_type": "normal",
          "type_name": "普通商品",
          "sales_material_bn": "SMAT001",
          "sales_material_name": "测试销售物料",
          "retail_price": 100.00,
          "brand_code": "BRAND001",
          "cat_name": "分类1",
          "goods_type": "成品",
          "shop_goods_id": "SHOP_GOODS_001",
          "shop_product_id": "SHOP_PRODUCT_001",
          "settlement_amount": 950.00,
          "platform_amount": 0.00
        }
      ]
    }
  ]
}

4.2 按条件汇总销售金额 ​

请求参数 ​

参数名类型必填描述
start_timestring否创建时间开始（格式：yyyy-MM-dd HH:mm:ss）
end_timestring否创建时间结束（格式：yyyy-MM-dd HH:mm:ss）
shop_bnstring否店铺编号，多个用逗号分隔
statusstring否状态：succ-成功, failure-失败, pending-待处理

响应参数 ​

参数名类型描述
total_amountdecimal销售总金额

请求示例 ​

请参考openapi.md文档中【6. 接口调用示例】。

响应示例 ​

json
{
  "total_amount": 10000.00
}

4.3 获取销售单发货列表 ​

请求参数 ​

参数名类型必填描述
start_timestring否创建时间开始（格式：yyyy-MM-dd HH:mm:ss）
end_timestring否创建时间结束（格式：yyyy-MM-dd HH:mm:ss）
page_noint是页码，默认 1
page_sizeint是每页条数，默认 50，最大 1000
shop_bnstring否店铺编号
bnstring否销售单号

响应参数 ​

参数名类型描述
countint总记录数
listsarray发货列表

lists 数组中的每个对象包含以下字段：

参数名类型描述
shop_codestring店铺编码
shop_namestring店铺名称
order_nostring订单编号
member_namestring会员名称
delivery_bnstring发货单号
create_timestring创建时间（格式：yyyy-MM-dd HH:mm:ss）
ship_timestring发货时间（格式：yyyy-MM-dd HH:mm:ss）
freight_amountdecimal运费金额
logi_namestring物流公司名称
logi_nostring物流单号
branch_namestring仓库名称
branch_bnstring仓库编码
delivery_nostring发货单号
consigneestring收货人
consignee_areastring收货地区
consignee_addrstring收货地址
consignee_zipstring邮政编码
consignee_telstring收货电话
consignee_mobilestring收货手机
consignee_emailstring收货邮箱
mark_memostring标记备注
custom_memostring自定义备注
packagesarray京东包裹列表（云交易订单号）
logi_statusstring物流状态
sign_statusstring签收状态
sign_timestring签收时间
itemsobject发货商品明细（以item_id为键）

items 对象中的每个子对象包含以下字段：

参数名类型描述
item_idint商品ID
bnstring商品编码
product_namestring商品名称
pricedecimal价格
numsint数量
purchase_pricedecimalWMS仓储采购价格

请求示例 ​

请参考openapi.md文档中【6. 接口调用示例】。

响应示例 ​

json
{
  "count": 50,
  "lists": [
    {
      "shop_code": "SHOP001",
      "shop_name": "测试店铺",
      "order_no": "ORDER20240101001",
      "member_name": "张三",
      "delivery_bn": "DEL20240101001",
      "create_time": "2024-01-01 10:00:00",
      "ship_time": "2024-01-01 10:30:00",
      "freight_amount": 10.00,
      "logi_name": "顺丰速运",
      "logi_no": "SF1234567890",
      "branch_name": "测试仓库",
      "branch_bn": "WH001",
      "delivery_no": "DEL20240101001",
      "consignee": "李四",
      "consignee_area": "北京市/北京市/朝阳区",
      "consignee_addr": "测试路1号",
      "consignee_zip": "100000",
      "consignee_tel": "010-12345678",
      "consignee_mobile": "13800138000",
      "consignee_email": "test@example.com",
      "mark_memo": "",
      "custom_memo": "请小心轻放",
      "packages": [],
      "logi_status": "已发货",
      "sign_status": "0",
      "sign_time": "",
      "items": {
        "1": {
          "item_id": 1,
          "bn": "PROD001",
          "product_name": "测试商品",
          "price": 100.00,
          "nums": 10,
          "purchase_price": 80.00
        }
      }
    }
  ]
}

5. 错误码说明 ​

错误码错误信息解决方案
0成功-
1参数错误检查参数格式是否正确，所有必填参数是否都已提供
400参数错误检查参数格式是否正确，所有必填参数是否都已提供
401未授权访问检查flag和sign是否正确
403禁止访问联系管理员获取权限
500服务器内部错误检查请求参数或联系技术支持
1001非法的flag请检查flag是否正确
1002请求已过期请检查timestamp是否正确，请求有效期为5分钟
1003签名错误请检查签名算法和参数是否正确
1004不支持的type格式请使用json格式
2001缺少必要的参数请检查请求参数是否完整
2002非法的请求参数请检查参数格式和范围是否正确
2003接口不存在请检查接口方法名是否正确

6. 注意事项 ​

  1. 时间格式必须为 yyyy-MM-dd HH:mm:ss，否则可能导致查询失败。
  2. page_size 参数最大支持 1000，默认50，超过100将被限制为 100。
  3. 对于大数据量的查询，建议使用时间范围进行筛选，以提高查询效率。
  4. 时间戳必须与服务器时间保持同步，误差不超过3600秒。
  5. 每个请求必须生成唯一的签名，避免重复提交。
  6. 请妥善保管接口密钥，避免泄露。
  7. 所有请求参数中的特殊字符必须进行 URL 编码，特别是在使用 GET 方法时。
  8. 请确保在请求头中设置正确的 Content-Type，对于 POST 请求建议使用 application/json。
  9. 为了系统性能和稳定性，请避免短时间内发送大量请求，建议控制调用频率。
  10. 敏感数据（如签名、密钥等）请勿在日志中记录，确保数据安全。