软猫引擎API开放平台
  1. 商城配置API
软猫引擎API开放平台
  • 接口安全API(必看)
    • 重要说明
    • 数据签名与验签方式
    • 获取AccessToken
      POST
  • 用户基础API
    • 获取永久用户标识
      • 获取永久用户标识UserId(根据临时用户标识userCode)
      • 获取永久用户标识UserId(根据已注册的手机号码)
    • 用户登录/退出
      • 发送短信验证码(用户登录)
      • 用户登录(通过短信验证码)
      • 用户登录(通过密码)
      • 用户退出登录
    • 用户注册
      • 发送短信验证码(用户注册)
      • 上传用户头像(用户注册)
      • 用户注册
    • 修改用户登录密码
      • 发送短信验证码(修改用户登录密码)
      • 修改用户登录密码
    • 查看/修改用户安全密码
      • 查看用户安全密码状态
      • 发送短信验证码(修改用户安全密码)
      • 修改用户安全密码
    • 修改用户手机号码
      • 发送短信验证码(修改用户手机号码-新手机号码)
      • 发送短信验证码(修改用户手机号码-原手机号码)
      • 修改用户手机号码
    • 用户资料
      • 获取用户资料
      • 获取用户等级
      • 获取用户职称
      • 设置用户头像
      • 设置用户昵称
      • 设置用户性别
      • 设置用户所在地
    • 用户邀请人
      • 推广卡片生成与邀请人绑定
      • 绑定邀请人(通过推广人ID)
      • 绑定邀请人(通过手机号码)
      • 获取用户邀请人信息
    • 用户统计
      • 批量获取用户统计数据
      • 获取用户统计数据(高级版)
      • 获取用户统计数据(高级+周期版)
    • 用户配置
      • 配置Key说明
      • 读取用户配置
      • 批量读取用户配置
      • 修改用户配置
  • 用户收件地址API
    • 获取用户的收件地址列表
      POST
    • 获取用户的收件地址(根据id获取)
      POST
    • 添加用户收件地址
      POST
    • 修改用户收件地址
      POST
    • 删除用户收件地址
      POST
    • 设置默认用户收件地址
      POST
  • 用户资产API
    • 余额配置
      • 配置Key说明
      • 读取余额配置
      • 批量读取余额配置
      • 修改余额配置
    • 积分配置
      • 配置Key说明
      • 读取积分配置
      • 批量读取积分配置
      • 修改积分配置
    • 代币配置
      • 配置Key说明
      • 读取代币配置
      • 批量读取代币配置
      • 修改代币配置
    • 用户转账
      • 根据收款人手机号码获取转账句柄(用于发起转账)
      • 根据收款人ID获取转账句柄(用于发起转账)
      • 根据收款人ID获取转账句柄(用于发起聚合转账)
      • 发起余额转账
      • 发起代币转账
      • 发起积分转账
      • 获取余额转账日志记录(转出)
      • 获取余额收款日志记录(转入)
      • 获取代币转账日志记录(转出)
      • 获取代币收款日志记录(转入)
      • 获取积分转账日志记录(转出)
      • 获取积分收款日志记录(转入)
    • 余额提现
      • 读取余额提现配置
      • 发起提现到银行卡
      • 发起提现到微信零钱
      • 取消提现到微信零钱
      • 获取提现到银行卡的日志记录
      • 获取提现到微信零钱的日志记录
      • 获取用户提现统计
    • 用户银行卡
      • 获取支持的银行列表
      • 验证银行卡号是否正确
      • 绑定用户银行卡
      • 解绑用户银行卡
      • 获取已绑定的用户银行卡列表
    • 获取用户资产(可用余额/冻结余额/积分/代币)
      POST
    • 获取用户余额明细日志
      POST
    • 获取用户积分明细日志
      POST
    • 获取用户代币明细日志
      POST
    • 获取用户冻结余额明细
      POST
    • 创建用户余额充值订单
      POST
  • 用户消息API
    • 获取用户消息列表
    • 获取用户消息数量
    • 设置消息已读
    • 批量设置消息已读
  • 商品/分类/购物车/收藏/订单/退换货/评论句柄API
    • 商品API
      • 获取商品列表(分页获取)
      • 获取商品列表(仅获取前N个)
      • 获取完整的商品信息(用于商品详情页,不含款式数据)
      • 获取商品款式集合(用于客户端的商品款式选择器)
      • 获取商品分享卡片绘制数据
      • 获取微信小程序分享到聊天窗口的商品卡片图片(固定尺寸为800px*640px)
      • 读取线下销量/线下评论/线下收藏量的显示配置
      • 获取商品评价统计
      • 获取商品评价列表
      • 获取前N个正在进行的拼团(根据商品ID获取)
    • 商品分类API
      • 获取商品分类树
    • 购物车API
      • 获取购物车商品数量
      • 获取购物车商品列表
      • 更新购物车
      • 批量更新购物车(仅支持扣除,不支持增加)
    • 商品收藏API
      • 获取商品收藏列表
      • 切换商品收藏状态(收藏/取消收藏)
      • 批量取消收藏商品
    • 商品订单API
      • 生成订单提交句柄
      • 计算快递费
      • 提交并创建订单
      • 获取用户的商品订单数量
      • 获取用户的商品订单列表
      • 获取全平台的商品订单列表
      • 获取用户的商品订单详情
      • 修改订单收件地址(根据收件地址ID)
      • 修改订单收件地址(无需收件地址ID)
      • 取消订单
      • 签收订单
      • 读取订单收件信息(含收件地址、快递信息)
      • 设置订单的管理员备注
      • 设置商品订单后台付款
      • 修改订单价格
      • 订单发货(仅发货,不录入快递单号)
      • 订单发货(需录入快递单号)
      • 设置订单线下取货(无需发货)
      • 对已发货的订单补充更多快递单号
      • 读取拼团详情
    • 退换货API
      • 获取订单退/换货申请句柄
      • 获取订单退/换货详情
      • 上传图片(用于申请退/换货)
      • 发起订单退/换货申请
      • 取消订单退/换货申请
    • 评论句柄API
      • 获取用户的商品评论数量
      • 获取评论句柄列表
      • 获取评论句柄
      • 获取评论详情
      • 上传图片(用于发表商品评论)
      • 上传视频(用于发表商品评论)
      • 发表商品评论
      • 追加商品评论
      • 删除评论
    • 其他API
      • 获取用户最近买过的商品列表
      • 获取全商城最近的下单历史记录(用于客户端展示)
      • 汇总指定用户的订单
  • 文件API
    • 上传临时图片文件
    • 上传临时视频文件
    • 上传临时音频文件
  • 系统功能API
    • 功能Key说明
    • 获取所有已开通的功能列表
    • 验证是否已开通指定功能
  • 行政区划API
    • 获取省市区树
    • 获取省份列表(一级行政区划)
    • 获取城市列表(二级行政区划)
    • 获取区/县/镇列表(三级行政区划)
  • 收银台API
    • 获取订单支付句柄(用于发起支付)
    • 发起余额支付
    • 发起积分支付
    • 发起代币支付
    • 判断是否已开通微信支付
    • 发起微信支付
    • 判断(微信支付)订单是否已付款
    • 判断订单是否已付款
  • 商城配置API
    • 配置Key说明
    • 读取商城配置
      POST
    • 批量读取商城配置
      POST
    • 修改商城配置
      POST
  • 快递API
    • 获取快递公司列表
    • 获取所有快递计费规则
    • 判断是否指定区域是否开放配送
  • 多商户系统API
    • 获取商户类型列表
    • 获取商户品牌信息
    • 获取商户列表
    • 获取商户详情
  • 表单系统API
    • 获取表单详情
    • 上传图片(用于提交表单)
    • 提交表单
    • 获取用户的提交记录列表
    • 获取用户的提交记录详情
  • 核销券API
    • 根据商品订单号获取用户核销券列表
    • 获取用户的核销券列表
    • 对用户发行/赠予核销券
    • 使核销券过期(作废)
    • 使核销券已核销
  • 文案系统API
    • 设置“关于我们”内容
    • 获取“关于我们”内容
    • 设置“用户服务条款”内容
    • 获取“用户服务条款”内容
  • 万能信息公示系统API
    • 获取公示信息模型基础信息
    • 获取公示信息的查询权限
    • 获取公示信息列表(分页获取)
    • 获取公示信息列表(仅获取前N条)
    • 获取公示信息详情
    • 获取我阅读过的公示信息列表(分页获取)
    • 获取我点赞的公示信息列表(分页获取)
    • 获取我收藏的公示信息列表(分页获取)
    • 收藏公示信息
    • 取消收藏公示信息
    • 点赞公示信息
    • 取消点赞公示信息
  • 微信小程序API
    • 特别声明
    • 用户登录(通过微信小程序的用户登录凭证code)
    • 关联微信小程序用户
    • 根据微信小程序jsCode获取OpenId
    • 根据用户标识获取已关联的OpenId
    • 解除关联微信小程序用户
    • 生成小程序码
    • 根据小程序场景码(code)获取场景信息(url)
  • 数据模型
    • 标准响应模型
    • 标准数据分页模型
    • 用户银行卡数据模型
    • 用户收件地址数据模型
    • 基础商品数据模型(客户端专用)
    • 完整商品数据模型(客户端专用,不含款式数据和详情HTML)
    • 商品评论数据模型(客户端专用)
    • 商品款式集合数据模型(客户端专用)
    • 商品款式项数据模型(客户端专用)
    • 商品订单数据模型(客户端专用)
    • 商品订单中的商品数据模型(客户端专用)
    • 商品订单数据模型
    • 商品订单中的商品数据模型
    • 公示信息基础数据模型(客户端专用)
  1. 商城配置API

配置Key说明

推广配置#

配置Key说明默认值示例
InvitePowersExcept指定等级无推广权限,格式为["等级ID_1",""等级ID_2",...]]`[]["78e05d92-8a82-4ae0-a0a2-87dfb097472e","777e875e-f932-49f5-b8d1-1da2e0391e3c"]
InviteScheme最终邀请人绑定方案,0=以最终消费为准,1=最先邀请为准,2=以N天内至少消费N元为准,3=以最后邀请为准(完全自由推广)01
InviteLevelLimit被邀请人的等级限制,0=无限制,1=只能邀请初始等级会员10
InviteComsumeLimit被邀请人的消费限制,0=无限制,1=只能邀请未消费过的会员10
InviteScheme2_DayNLimitInviteScheme=2时生效,指N天限制,可设置1-3663010
InviteScheme2_MoneyNLimitInviteScheme=2时生效,指N元限制,单位:分,必须大于或等于1110

模式配置#

配置Key说明默认值示例
AreaAgentCheckRule区域代理判定规则,0=以收件地址为准,1=以用户所在地为准01

商品配置#

配置Key说明默认值示例
AddToShopCart(商品默认)是否允许商品加入购物车,1=允许,0=不允许10
SalesVirtualShow(商品默认)是否显示线下销量,1=显示,0=不显示10
CollecsVirtualShow(商品默认)是否显示线下收藏量,1=显示,0=不显示10
CommentVirtualShow(商品默认)是否显示线下评论,1=显示,0=不显示10
StockWarnValue库存预警值,当库存小于等于该值时,后台显示库存预警提示5010

购买权限配置#

配置Key说明默认值示例
BuyLimitMode(商品默认)限制购买模式,0=不限购,1=仅限指定等级可购买,2=除了指定等级可购买,3=仅限指定用户可购买,4=除了指定用户可购买01
BuyLimitLevels(商品默认)仅限指定等级可购买,BuyLimitMode=1时生效,格式为["等级ID_1",""等级ID_2",...][]["78e05d92-8a82-4ae0-a0a2-87dfb097472e","777e875e-f932-49f5-b8d1-1da2e0391e3c"]
BuyLimitLevelsExcept(商品默认)除了指定等级可购买,BuyLimitMode=2时生效,格式为["等级ID_1",""等级ID_2",...][]["78e05d92-8a82-4ae0-a0a2-87dfb097472e","777e875e-f932-49f5-b8d1-1da2e0391e3c"]
BuyLimitUsers(商品默认)仅限指定用户可购买,BuyLimitMode=3时生效,格式为["用户ID_1",""用户ID_2",...][]["78e05d92-8a82-4ae0-a0a2-87dfb097472e","777e875e-f932-49f5-b8d1-1da2e0391e3c"]
BuyLimitUsersExcept(商品默认)除了指定用户可购买,BuyLimitMode=4时生效,格式为["用户ID_1",""用户ID_2",...][]["78e05d92-8a82-4ae0-a0a2-87dfb097472e","777e875e-f932-49f5-b8d1-1da2e0391e3c"]
InviterLimit(商品默认)是否必须有邀请人才能下单,0=不限制,1=必须存在邀请人才能下单,2=必须存在邀请人且邀请人累计消费必须达到n分时,才能下单01
InviterLimitDemand(商品默认)邀请人累计消费必须达到指定金额时,才能下单,单位:分;InviterLimit=2时生效1001000
FreeInviterItems(商品默认)指定邀请人无需消费,其下家可不受限制直接下单,格式为["用户ID_1",""用户ID_2",...];InviterLimit=2时生效[]["78e05d92-8a82-4ae0-a0a2-87dfb097472e","777e875e-f932-49f5-b8d1-1da2e0391e3c"]
FreeUserItems(商品默认)指定会员无需邀请人也可直接下单,格式为["用户ID_1",""用户ID_2",...];InviterLimit=1或InviterLimit=2时生效[]["78e05d92-8a82-4ae0-a0a2-87dfb097472e","777e875e-f932-49f5-b8d1-1da2e0391e3c"]
LocationLimitMode(商品默认)是否限定必须已设置所在地才能购买,0=不限制,1=限制01
OrderLimitRules更多下单限制规则,请参考下述的下单规则项OrderLimitRule JSON格式[]``
下单规则项OrderLimitRule JSON格式#
{
    /*
     * 限制的等级ID,null表示任意等级
     */
    "LevelId": null,
    /*
     * 限制活动类型,null表示任意活动
     * 0=无活动,1=秒杀,2=砍价(预留),3=拼团,4=积分兑换,5=预售
     */
    "ActiveType": 0,
    /*
     * 限制类型
     * 0=最低下单金额为N,1=下单金额必须为N的整数倍,2=最低下单商品数量为N,3=下单商品数量必须为N的整数倍
     */
    "RuleType": 0,
    /*
     * 指定N值(如果RuleType=0或1,则为金额,单位:分;fRuleType=2或3,则为数量,单位:件)
     */
     "Value": 100
}

订单配置#

配置Key说明默认值示例
AllowPayMethods(商品默认)允许的付款方式,(1=余额支付,2=积分支付,4=代币支付,8=微信支付,16=支付宝支付(预留),32=银联支付(预留),256=代付),请通过|符号进行组合,例如[余额支付、微信支付、支付宝支付]用1|8|16=25表示31725
BalancePayThreshold余额支付最低门槛,单位:分0100
IntegralPayThreshold积分支付最低门槛,单位:分0100
CoinPayThreshold代币支付最低门槛,单位:分0100
WechatPayThreshold微信支付最低门槛,单位:分0100
AliPayThreshold支付宝支付最低门槛,单位:分0100
HelpPayThreshold代付最低门槛,单位:分0100
PayTimeout(商品默认)付款有效期(分钟,可设置1~120分钟)12060
AddresseeUpdateTimeout下单后N分钟内支持修改收件信息(单位:分钟,可设置0~144000分钟);该配置仅限制客户端操作修改,不限制后台操作修改收件信息;
订单付款前支持随时修改收件地址;订单发货后不可修改收件地址;
0分钟表示付款后不支持修改收件信息。72014400
SendAsReceived(商品默认)自动签收模式,0=发货即签收,1=自发货起N分钟后自动签收10
ReceivedTimeout(商品默认)订单自动签收时间(分钟),自订单发货之日起计算,SendAsReceived=1时生效144007200
ReturnMode(商品默认)是否允许退换货,0=不允许,1=可退货但不可换货,2=可换货但不可退货,3=可退货也可换货31
ReturnTimeout(商品默认)退货有效期(分钟),自订单付款之日计算;ReturnMode=1或3时生效4320014400
ExchangeTimeout(商品默认)换货有效期(分钟),自订单付款之日计算;ReturnMode=2或3时生效4320014400
OrderPriceRandMode订单金额随机调整模式,0=不随机,1=随机递减金额N1元,2=随机递增金额N2元,3=随机递减或等增指定金额N3元, 4=随机递减百分比N4,5=随机递增百分比N5,6=随机递减或递增百分比N601
OrderPriceRandModeN1订单金额随机递减金额(单位:分),OrderPriceRandMode=1时生效10050
OrderPriceRandModeN2订单金额随机递增金额(单位:分),OrderPriceRandMode=2时生效10050
OrderPriceRandModeN3订单金额随机递减或递增金额(单位:分),OrderPriceRandMode=3时生效10050
OrderPriceRandModeN4订单金额随机递减百分比(可设置0~1,如:0.05表示5%),OrderPriceRandMode=4时生效0.010.05
OrderPriceRandModeN5订单金额随机递增百分比(可设置0~1,如:0.05表示5%),OrderPriceRandMode=5时生效0.010.05
OrderPriceRandModeN6订单金额随机递减或递增百分比(可设置0~1,如:0.05表示5%),OrderPriceRandMode=6时生效0.010.05
OrderPriceRandModeLimit订单金额随机调整模式限制,仅OrderPriceRandMode不为0时生效,0表示不限制分区/所有商品分区均生效,1表示仅限指定商品分区支持,2表示除了指定商品分区支持01
OrderPriceRandModeLimit_Partitions仅限指定商品分区支持订单金额随机调整,仅OrderPriceRandMode不为0且OrderPriceRandModeLimit=1时生效,格式为["分区ID_1","分区ID_2",...],可用null代表无分区[][null,"9fdc0115-fafa-47bc-8f75-49409b7e32e4","7d7490f7-8629-4535-ab64-c9e976e588b2"]
OrderPriceRandModeLimit_PartitionsExcept除了指定商品分区,其他分区都支持订单金额随机调整,仅OrderPriceRandMode不为0且OrderPriceRandModeLimit=2时生效,格式为["分区ID_1","分区ID_2",...],可用null代表无分区[][null,"9fdc0115-fafa-47bc-8f75-49409b7e32e4","7d7490f7-8629-4535-ab64-c9e976e588b2"]

评论配置#

配置Key说明默认值示例
CanComment(商品默认)是否允许对商品评论,1=允许,0=不允许10
CommentTimeout(商品默认)评论有效期(分钟),自订单付款之日计算;CanComment=1时生效432004320
CommentAwardType(商品默认)订单评论后系统赠送奖励类型,0=无奖励,1=人民币,2=代币,3=积分;CanComment=1时生效31
CommentAwardMode(商品默认)评论奖励模式,0=按比例,1=按固定值;CanComment=1时生效01
CommentAwardRatio(商品默认)评论奖励比例(可设置0~1,如:0.05表示5%),CommentAwardMode=0时生效0.10.2
CommentAwardValue(商品默认)评论奖励固定值;CommentAwardType=1或2时,单位为分;CommentAwardMode=1时生效100200
CommentAwardActive(商品默认)活动订单发表评论是否有奖励,1=有奖励,0=无奖励10

快递配置#

配置Key说明默认值示例
ExpressFeeRuleId(商品默认)快递费规则ID,请参考【快递API->获取所有快递计费规则
】接口获取-79f959af-8705-4286-bebc-5f0c48689df1

积分兑换配置#

配置Key说明默认值示例
AutoRmbConvertForIntegralExchange(商品默认)积分不足时,是否支持使用人民币(根据人民币兑积分比率)足额补齐订单所需积分。1=支持,0=不支持01

云仓配置#

配置Key说明默认值示例
CloudWarehousePowers指定等级拥有云仓,只有拥有云仓的用户,在下单时可选择将(真实)商品加入云仓,格式为["等级ID_1","等级ID_2",...][]["1b7583e1-d0f1-487c-8747-3b2045bd9735","a9ed347f-e3ce-472a-99b1-1c24dccffd71"]
CloudWarehouseAdd(商品默认)是否允许商品加入云仓,仅对真实商品有效,对虚拟商品/混合虚拟商品无效,1=允许,0=不允许10
CloudWarehouseOutBound_LocationLimitMode用户是否必须设置所在地才能提货,1=是,0=否01
CloudWarehouseOutBound_AreaAgentCheckRule(云仓提货)区域代理判定规则,0=以收件地址为准,1=以用户所在地为准01
CloudWarehouseExpressFeeMode(云仓提货)快递规则,0=免快递费,1=与商品一致,2=自定义12
CloudWarehouseExpressFeeRuleId(云仓提货)快递费规则ID,CloudWarehouseExpressFeeMode=2时生效,请参考【快递API->获取所有快递计费规则】接口获取-79f959af-8705-4286-bebc-5f0c48689df1
CloudWarehouseOutBound_AllowPayMethods(云仓提货)允许的付款方式,(1=余额支付,2=积分支付,4=代币支付,8=微信支付,16=支付宝支付(预留),32=银联支付(预留),256=代付),请通过|符号进行组合,例如[余额支付、微信支付、支付宝支付]用1|8|16=25表示31725
CloudWarehouseOutBound_BalancePayThreshold(云仓提货)余额支付最低门槛,单位:分0100
CloudWarehouseOutBound_IntegralPayThreshold(云仓提货)积分支付最低门槛,单位:分0100
CloudWarehouseOutBound_CoinPayThreshold(云仓提货)代币支付最低门槛,单位:分0100
CloudWarehouseOutBound_WechatPayThreshold(云仓提货)微信支付最低门槛,单位:分0100
CloudWarehouseOutBound_AliPayThreshold(云仓提货)支付宝支付最低门槛,单位:分0100
CloudWarehouseOutBound_HelpPayThreshold(云仓提货)代付最低门槛,单位:分0100
CloudWarehouseOutBound_PayTimeout(云仓提货)付款有效期(分钟,可设置1~120分钟)12060
CloudWarehouseOutBound_AddresseeUpdateTimeout(云仓提货)下单后N分钟内支持修改收件信息(单位:分钟,可设置0~144000分钟);该配置仅限制客户端操作修改,不限制后台操作修改收件信息;订单付款前支持随时修改收件地址;订单发货后不可修改收件地址;0分钟表示付款后不支持修改收件信息。72014400
CloudWarehouseOutBound_SendAsReceived(云仓提货)自动签收模式,0=发货即签收,1=自发货起N分钟后自动签收10
CloudWarehouseOutBound_ReceivedTimeout(云仓提货)订单自动签收时间(分钟),自订单发货之日起计算,SendAsReceived=1时生效144007200
CloudWarehouseOutBound_ExchangeMode(云仓提货)是否允许换货,0=不允许,1=可换货10
CloudWarehouseOutBound_ExchangeTimeout(云仓提货)换货有效期(分钟),自订单付款之日计算;CloudWarehouseOutBound_ExchangeMode=1时生效4320014400
修改于 2026-01-15 19:10:04
上一页
判断订单是否已付款
下一页
读取商城配置
Built with