ERP接口文档
更新日志
2025-03-11 批量获取订单列表返回值新增拆单类型SplitType、拆单类型名SplitTypeName（getOrderList） 获取订单明细返回值新增拆单类型SplitTy...
基础说明
测试环境：http://erp.newdhb.com/ 预发环境：https://yerp.dhb168.com/ 正式环境：https://erp.dhb168.com/ 注意：这里...
获取用户令牌sKey
商品分类
商品品牌
商品规格
商品档案
addProduct：批量新增商品档案
入参 参数名称 是否必须 参数类型 参数说明 sKey Y String 密钥 ...
updateProduct：批量更新商品档案
入参 参数名称 是否必须 类型 参数说明 sKey Y String 密钥 ...
getGoodsList：批量获取商品列表
入参 参数名称 是否必须 类型 描述 sKey Y String 令牌 ...
productOuterToInner：商品内外码同步
入参 参数名称 是否必须 参数类型 参数说明 sKey Y String 密钥 ...
uploadFile：上传文件
入参 参数名称 是否必须 参数类型 参数说明 sKey Y String 密钥 ...
syncGoodsPicture：批量同步图片
该接口暂停使用，升级维护中 入参： 参数名称 是否必须 类型 描述 sKey Y Stri...
updateClientTypePrice：批量设置商品等级价
入参 参数名称 是否必须 类型 描述 sKey Y String 密钥 ...
updateClientPrice：批量设置商品指定价
入参 参数名称 是否必须 类型 描述 sKey Y String 密钥 ...
setGoodsToRecycle：商品批量回收站处理
入参 参数名称 是否必须 类型 描述 sKey Y String 密钥 ...
headBlock：商品批量上下架
入参： 参数名称 是否必须 类型 描述 sKey Y String 密钥 ...
headBlockOption：规格商品批量上下架
入参： 参数名称 是否必须 类型 描述 sKey Y String 密钥 ...
商品经营范围
getGoodsRange：获取商品经营屏蔽信息
参数 参数名称 是否必须 类型 描述 sKey Y String 令牌 ...
syncGoodsRange：批量同步商品经营屏蔽信息
入参： 参数名称 是否必须 类型 描述 sKey Y String 密钥 ...
incrementalSyncGoodsRange：批量增量同步经营屏蔽信息
增量同步的入参可以参考全量同步，增量同步的屏蔽信息，如果已经存在该信息会被合并，不存在则会新增。 入参 参数名称 是否必须 类型 描述 ...
incrementalDeleteGoodsRange：批量增量删除经营屏蔽信息
增量同步删除的入参可以参考全量同步，增量同步删除的屏蔽信息，如果已经存在该信息会被删除，不存在则会跳过。 入参 参数名称 是否必须 类型 ...
商品标签
商品仓库
batchAddStock：批量同步仓库
入参 参数名称 是否必须 类型 描述 sKey Y String 密钥 ...
getStockInfo：获取仓库列表
入参 参数名称 是否必须 类型 描述 sKey Y String 密钥 ...
syncStockGuid：批量同步仓库内外码
入参 参数名称 是否必须 参数类型 参数说明 sKey Y String 密钥...
stock：批量同步库存
入参 参数名称 是否必须 类型 描述 sKey Y String 密钥 ...
updateStock：批量通过商品编码同步库存
入参 参数名称 是否必须 类型 描述 sKey Y String 密钥 ...
getStock：获取指定商品库存
参数 参数名称 是否必须 类型 描述 sKey Y String 令牌 ...
batchGetStock：批量获取库存
参数 参数名称 是否必须 类型 描述 sKey Y String 令牌 ...
客户类型
归属地区
客户档案
addDealers：批量新增客户档案
入参 参数名称 是否必须 类型 描述 sKey Y String 密钥 ...
updateDealers：批量更新客户档案
入参 参数名称 是否必须 类型 描述 sKey Y String 密钥 ...
getDealersList：批量获取客户
入参 参数名称 是否必须 类型 描述 sKey Y String 令牌 ...
syncClientOuterToInner：客户内外码同步
入参 参数名称 是否必须 类型 描述 sKey Y String 令牌 ...
syncClientBalance：同步客户余额
备注：调用此接口需要开启允许同步客户余额配置 扣减余额：会生成一张付款单，记录流水，并且扣减相应客户余额 增加余额：会生成一张收款单，记录流水，并且增加相应客户余额（需要指定收款账户，如...
getShippingAddressList：批量获取客户收货地址
入参 参数名称 是否必须 类型 描述 sKey Y String 令牌 ...
addShippingAddress：批量新增客户收货地址
入参 参数名称 是否必须 类型 描述 sKey Y String 令牌 ...
updateShippingAddress：批量修改客户收货地址
入参 参数名称 是否必须 类型 描述 sKey Y String 令牌 ...
订货单
getOrderList：批量获取订单列表
备注：为避免订单被重复获取，已经被标记为获取的订单默认会被过滤，如果想要获取已经被标记为获取的订单，请根据需要指定apiStatus参数；订单获取状态优先以order_status_val指定的...
getOrderContent：获取订单明细
备注：执行此接口会自动审核订单和修改 is_api = T 入参 参数名称 是否必须 类型 描述或值 sKey ...
writeOrderDownloadStatus：回写订单下载成功标志
入参 参数名称 是否必须 类型 描述 sKey Y String 令牌 ...
createOrders：创建订单
注意：创建订单后，需要同步订单里面所有商品所有仓库的库存 入参 参数名称 是否必须 类型 描述 sKey Y...
cancelOrders：取消订单
入参 参数名称 是否必须 类型 描述 sKey Y String 令牌 ...
getOrdersListForCollaborate：联营版批量获取订单列表
备注：订单获取状态默认是待出库，如需获取待审核，待发货，待收货，已完成的订单，需要联系管理员配置，为避免订单被重复获取，已经被标记为获取的订单不再当前列表出现 入参 ...
getOrderContentForCollaborate:联营版获取订单明细
备注：执行此接口会默认标记为已获取 入参 参数名称 是否必须 类型 描述或值 sKey Y Str...
writeOrderDownloadStatusForCollaborate：回写联营订单下载标记
入参 参数名称 是否必须 类型 描述 sKey Y String 令牌 ...
getOrderListWithoutCollaborator：获取订单列表，会过滤掉商品全部为非自营商品的订单
备注：只有联营版且ERP开启联营模式才能使用此接口 入参 参数名称 是否必须 类型 描述 sKey Y ...
出库/发货单
getShipsList：获取出库/发货单列表
入参 参数名称 是否必须 类型 描述 sKey Y String 令牌 ...
getShipsContent：获取出库/发货单详情
入参 参数名称 是否必须 类型 描述 sKey Y String 令牌 ...
writeShipsDownloadStatus：标记出库/发货单下载状态
入参 参数名称 是否必须 类型 描述 sKey Y String 令牌 ...
getWaitShips：出库/发货/物流
入参 参数名称 是否必须 类型 描述、 返回字段 sKey Y String 密钥...
addConsignment：添加出库/发货单
入参 名称 是否必须 类型 描述 sKey Y String 用户令牌 ...
addAllShips：出库订单所有未出库商品
入参 名称 是否必须 类型 描述 sKey Y String 用户令牌 ...
addAllShipsForCollaborate：出库订单所有未出库商品（联营版）
入参 名称 是否必须 类型 描述 sKey Y String 用户令牌 ...
addConsignmentByNum：通过订货宝编码添加发货单
入参 名称 是否必须 类型 描述 sKey Y String 用户令牌 ...
addConsignmentAndModifyOrders：发货并且根据发货信息修改订单
备注：只能一次性发货，不支持多次发货，不支持联营版；商品数量可以多发少发，可以删除商品，但是不能有新商品；如果客户支付金额 > 修改后的订单结算金额，退回多余的金额到客户余额；如果客户是预付方式...
changeShipsStatus：指定发货单状态
入参 参数名称 是否必须 类型 描述、 返回字段 ships_num Y string ...
cancelOrderStock：取消出库
入参 参数名称 是否必须 类型 描述、 返回字段 ships_num Y string ...
cancelShips：取消发货（不支持联营版）
入参 参数名称 是否必须 类型 描述、 返回字段 ships_num Y string ...
confirmShipment：确认发货
当发货单数量发生变化时，为了确保出入库明细的连续性，系统会先取消当前的出库单，随后生成一张新的出库单并完成发货操作。返回结果中的 new_ships_id 和 new_ships_num 分...
退货单
getReturnsList：批量获取退货单列表
入参 参数名称 是否必须 类型 描述 sKey Y String 用户令牌 ...
getReturnsContent：获取退货单明细
入参 参数名称 是否必须 类型 描述或值 sKey Y String 用户令牌 ...
writeReturnsDownloadStatus：标记退货单下载状态
入参 参数名称 是否必须 类型 描述 sKey Y String 令牌 ...
confirmReceiptReturns：退货单确认收货
入参 参数名称 是否必须 类型 描述 sKey Y String 令牌 ...
createReturns：创建退货单（暂不支持关联订单退货）
入参 参数名称 是否必须 类型 描述 sKey Y String 密钥 ...
收付款单
getReceiptsList：获取收款单列表
入参 参数名称 是否必须 类型 描述 sKey Y String 用户令牌 ...
updateReciptsApi：回写收款单ERP下载状态
入参 参数名称 是否必须 类型 描述或值 sKey Y String 密钥 ...
addReceipts：批量同步收款单(支持预存款充值和订单收款操作)
预存款充值（IncexpId == 19）： 需要指定收款账户 生成收款单，记录收款单流水，增加客户余额 订单收款（IncexpId == 13） 需要指定订单号，只...
getPaymentList：获取付款单列表
入参 参数名称 是否必须 类型 描述 sKey Y String 密钥 ...
updatePaymentApi：回写付款单ERP下载状态
入参 参数名称 是否必须 类型 描述或值 sKey Y String 用户令牌 ...
addPayments：批量同步付款单（只支持预存款扣款操作）
备注：接口会生成一张付款单，记录流水，并且扣减相应客户余额 入参 参数名称 是否必须 类型 描述 sKey ...
payOrders：批量操作订单收款，只支持线下转账和货到付款
入参 参数名称 是否必须 类型 描述 sKey Y String 令牌 ...
addOrdersReceipts：添加订单收款记录，只支持客户余额支付订单
备注：此接口已作废，请使用：addReceipts：批量同步收款单(支持预存款充值和订单收款操作) 入参 参数名称 是否必须 类型 描述...
供应商
采购单
getPurchaseList：获取采购单列表
入参 参数名称 是否必须 类型 描述 sKey Y String 令牌 ...
getPurchaseContent：获取采购单详情
入参 参数名称 是否必须 类型 描述 sKey Y String 令牌 ...
writePurchaseDownloadStatus：标记采购单下载状态
入参 参数名称 是否必须 类型 描述 sKey Y String 令牌 ...
purchaseWarehousing：采购单入库，支持分批多次入库
入参 名称 是否必须 类型 描述 sKey Y String 用户令牌 ...
getPurchaseReturnList：获取采购退货单列表
入参 参数名称 是否必须 类型 描述 sKey Y String 令牌 ...
getPurchaseReturnContent：获取采购退货单详情
入参 参数名称 是否必须 类型 描述 sKey Y String 令牌 ...
writePurchaseReturnDownloadStatus：标记采购退货单下载状态
入参 参数名称 是否必须 类型 描述、 返回字段 skey Y String 用户...
purchaseReturnStock：采购退货单出库
入参 名称 是否必须 类型 描述 sKey Y String 用户令牌 ...
入库单
getWarehousingList：获取入库单列表
入参 参数名称 是否必须 类型 描述 sKey Y String 令牌 ...
getWarehousingContent：获取入库单详情
入参 参数名称 是否必须 类型 描述 sKey Y String 令牌 ...
writeWarehousingDownloadStatus：标记入库单下载状态
入参 参数名称 是否必须 类型 描述、 返回字段 skey Y String 用户...
addWarehousing：添加入库单
备注：联营商品和联营仓库不能添加入库单。没有开启多仓库，只能指定入库仓库为商品的默认仓库，且所有传入商品的默认仓库必须一致 入参 参数名称 是否必须 ...
客户返利
收款账户
员工账号
联营商
系统设置
第三方仓配系统对接
第三方仓配系统对接文档。订货宝已完成一下仓配系统的对接：华鼎冷链，绝配供应链