API接口管理工具

删除webhook

删除webhook<|-|>deleteEventPost<|-|>删除指定名称的脚本<|-|>提交范例: event_post: [{"name":"test"},{"name":"test 2"}] name : webhook名称<|-|>a:5:{s:4:"name";a:2:{i:0;s:5:"token";i:1;s:10:"event_post";}s:9:"paramType";a:2:{i:0;s:7:"VARCHAR";i:1;s:7:"VARCHAR";}s:4:"type";a:2:{i:0;s:1:"Y";i:1;s:1:"Y";}s:7:"default";a:2:{i:0;s:0:"";i:1;s:0:"";}s:3:"des";a:2:{i:0;s:0:"";i:1;s:10:"JSON结构";}}<|-|>http://域名/api-erp-deleteEventPost.html<|-|>POST<|-|>post

更新webhook

更新webhook<|-|>updateEventPost<|-|><|-|>event_post [{"event_id":1,"name":"webhook1","delay_minute":0,"url":"https://www.xxx.com/notify"}] event_id 事件id name webhook 名称 delay_minute 延时时间以分钟为单位整数 status 状态 0 禁用 1启用 url webhook URL 数据例子： [ { "event_id": 1, "name": "webhook1", "delay_minute" : 0, "url":"https://www.xxx.com/notify" } ] event_id 事件id: 1 注册成功 user_register 4 订单创建 order_add 5 订单支付（非COD） order_pay 6 订单发货 order_ship 8 订单取消 order_cancel 9 订单完成 / COD付款 order_complete 10 留言添加（管理员） message_add 20 询盘添加（管理员） inquiry_add 22 邮件订阅 newsletter_add 24 商品删除 goods_delete 25 商品库存状态切换 goods_stock_change 26 商品上下架 goods_status_change 27 购物车更新 cart_update 29 销售模式变动 goods_sale_mode_change 30 商品价格变动 goods_price_change 31 订单支付确认中 order_pay_checking<|-|>a:5:{s:4:"name";a:2:{i:0;s:5:"token";i:1;s:10:"event_post";}s:9:"paramType";a:2:{i:0;s:7:"VARCHAR";i:1;s:7:"VARCHAR";}s:4:"type";a:2:{i:0;s:1:"Y";i:1;s:1:"Y";}s:7:"default";a:2:{i:0;s:0:"";i:1;s:0:"";}s:3:"des";a:2:{i:0;s:0:"";i:1;s:13:"json字符串";}}<|-|>http://域名/api-erp-updateEventPost.html<|-|>POST<|-|>post

更新店铺货币汇率

更新店铺货币汇率<|-|>CurrencyUpdate<|-|><|-|>status：状态，0关闭，1启用，必填 is_main：是否是店铺主货币，1表示主货币，0表示非主货币，必填 base_name：货币名称，必填 symbol_left：货币左符号，选填，与symbol_right二选一 symbol_right：货币右符号，选填，可留空 exchange_rate：货币汇率，相对于店铺当前主货币，必填 decimal_num：货币小数点位数，必填 standard_code：货币标准三位编码，必填 listorder：排序值，必填 symbol_separator：千位分隔符，选填可以留空 data ：货币更新数据例子： [ { "status": "0", "is_main": "0", "base_name": "PGK", "symbol_left": "", "symbol_right": "￥", "exchange_rate": "6.53120000", "decimal_num": "0", "standard_code": "PGK", "create_time": "1652803376", "listorder": "2", "symbol_separator": "" } ]<|-|>a:5:{s:4:"name";a:2:{i:0;s:5:"token";i:1;s:4:"data";}s:9:"paramType";a:2:{i:0;s:6:"String";i:1;s:4:"JSON";}s:4:"type";a:2:{i:0;s:1:"Y";i:1;s:1:"Y";}s:7:"default";a:2:{i:0;s:0:"";i:1;s:0:"";}s:3:"des";a:2:{i:0;s:0:"";i:1;s:0:"";}}<|-|>http://域名/api-erp-currencyUpdate.html<|-|>POST<|-|>post

获取基准货币列表

获取基准货币列表<|-|>CurrencyBaseList<|-|><|-|>base_name：货币名称 symbol_left：货币左符号 symbol_right：货币右符号 exchange_rate：货币汇率，相对于美元 decimal_num：货币小数点位数 standard_code：货币标准三位编码<|-|>a:5:{s:4:"name";a:1:{i:0;s:5:"token";}s:9:"paramType";a:1:{i:0;s:6:"String";}s:4:"type";a:1:{i:0;s:1:"Y";}s:7:"default";a:1:{i:0;s:0:"";}s:3:"des";a:1:{i:0;s:0:"";}}<|-|>http://域名/api-erp-currencyBaseList.html<|-|>POST<|-|>post

获取店铺货币列表

获取店铺货币列表<|-|>CurrencyList<|-|><|-|>is_main：是否是店铺主货币，1表示主货币，0表示非主货币 base_name：货币名称 symbol_left：货币左符号 symbol_right：货币右符号 exchange_rate：货币汇率，相对于店铺当前主货币 decimal_num：货币小数点位数 standard_code：货币标准三位编码 listorder：排序值 symbol_separator：千位分隔符<|-|>a:5:{s:4:"name";a:1:{i:0;s:5:"token";}s:9:"paramType";a:1:{i:0;s:6:"String";}s:4:"type";a:1:{i:0;s:1:"Y";}s:7:"default";a:1:{i:0;s:0:"";}s:3:"des";a:1:{i:0;s:0:"";}}<|-|>http://域名/api-erp-currencyList.html<|-|>POST<|-|>post

获取支付方式

获取支付方式<|-|>Payments<|-|><|-|>id int store_id int 店铺id base_name 支付方式的名称 formula 公式 interface_type 接口类型 config_param 参数配置 image 支付Logo listorder 排序 status 状态 0关闭 1启用 create_time 创建时间 is_billing 是否使用账单地址 1是 0否 site_type 激活类型 0全部 1PC 2手机 display_param 限制条件参数 remark 备注<|-|>a:5:{s:4:"name";a:3:{i:0;s:5:"token";i:1;s:9:"base_name";i:2;s:14:"interface_type";}s:9:"paramType";a:3:{i:0;s:7:"varchar";i:1;s:7:"varchar";i:2;s:7:"varchar";}s:4:"type";a:3:{i:0;s:1:"Y";i:1;s:1:"N";i:2;s:1:"N";}s:7:"default";a:3:{i:0;s:0:"";i:1;s:0:"";i:2;s:0:"";}s:3:"des";a:3:{i:0;s:17:"接口访问token";i:1;s:23:"支付名称(左匹配)";i:2;s:23:"接口类型(全匹配)";}}<|-|>http://域名/api-erp-payments.html<|-|>POST<|-|>post

更新员工账号

更新员工账号<|-|>updateAdmin<|-|>添加或更新员工账号以及拥有的权限<|-|>response: 关于code： 0：处理成功 100：部分成功 400-1000：参数验证未通过 1000以上：code验证未通过 request: {"admin_res":[{"email:"xxx_tmp_admin_tech@35zh.com","status":1,"password":"pass","real_name":"张三","auth":{"base_name":"商品管理","auth_desc":"描述","auth_menus":"setting_country,product_trash"}}],"token":"k"} email: 用户邮箱 status: 用户状态上下架 password: 密码 real_name:真实名称 base_name:角色名称 auth_desc: 角色描述 auth_menus: 权限列表 admin_res 限制最多200条<|-|>a:5:{s:4:"name";a:2:{i:0;s:5:"token";i:1;s:9:"admin_res";}s:9:"paramType";a:2:{i:0;s:7:"varchar";i:1;s:7:"varchar";}s:4:"type";a:2:{i:0;s:1:"Y";i:1;s:1:"Y";}s:7:"default";a:2:{i:0;s:0:"";i:1;s:0:"";}s:3:"des";a:2:{i:0;s:17:"接口访问token";i:1;s:25:"json结构接口参数";}}<|-|>http://域名/api-erp-updateAdmin.html<|-|>POST<|-|>post

更新支付方式

更新支付方式<|-|>updatePayment<|-|><|-|>可选更新字段： base_name：支付名称，字符串 status：状态，int 类型，0 表示禁用，1表示启用 listorder：排序，int 类型，排序值，按从大到小降序排列 descript：备注，字符串，下单流程显示，尽量60个字符内 detail：收款账号描述，字符串，支持html site_type：站点类型，int类型，0表示所有站点，1表示仅在PC端显示2表示仅在移动端显示 is_billing：是否需要账单地址，int 类型 0表示不需要 1表示需要 config_param 接口参数, json 类型如{"exp_xxx":"xx","exp":"xxx"}, 参数名称前必须加 "exp_" 必填字段：payment_id，支付方式id<|-|>a:5:{s:4:"name";a:2:{i:0;s:5:"token";i:1;s:11:"payment_res";}s:9:"paramType";a:2:{i:0;s:6:"string";i:1;s:11:"json string";}s:4:"type";a:2:{i:0;s:1:"Y";i:1;s:1:"Y";}s:7:"default";a:2:{i:0;s:0:"";i:1;s:288:"[{"base_name":"Credit Card","payment_id":1275,"status":1,"listorder":10000,"descript":"5% payment fee","detail":"account:aaa","site_type":0,"is_billing":0}]";}s:3:"des";a:2:{i:0;s:0:"";i:1;s:0:"";}}<|-|>http://域名/api-erp-updatePayment.html<|-|>POST<|-|>post

删除脚本

删除脚本<|-|>deleteScript<|-|>删除指定名称的脚本<|-|>提交范例: script_res : [{"name":"test"},{"name":"test 2"}] name : 脚本名称<|-|>a:5:{s:4:"name";a:2:{i:0;s:5:"token";i:1;s:10:"script_res";}s:9:"paramType";a:2:{i:0;s:7:"VARCHAR";i:1;s:7:"VARCHAR";}s:4:"type";a:2:{i:0;s:1:"Y";i:1;s:1:"Y";}s:7:"default";a:2:{i:0;s:0:"";i:1;s:0:"";}s:3:"des";a:2:{i:0;s:0:"";i:1;s:10:"JSON结构";}}<|-|>http://域名/api-erp-deleteScript.html<|-|>POST<|-|>post

更新脚本

更新脚本<|-|>updateScript<|-|>更新网站的脚本,如果有存在名称相同的脚本将会被删除<|-|>提交范例: script_res : [{"name":"test","mc_key":"","detail":"detail1","type":1,"site_type":0,"status":1}] name : 脚本名称 mc_key : model+controller 例如:product_detail detail : 脚本代码 type : 脚本位置 0:头部 1:底部 site_type : 脚本类型 0所有站点 1电脑网站 2手机网站 3企业官网 status : 脚本状态 0:关闭 1:开启 list_order: 排序根据list_order 倒叙进行加载 script<|-|>a:5:{s:4:"name";a:2:{i:0;s:5:"token";i:1;s:10:"script_res";}s:9:"paramType";a:2:{i:0;s:7:"VARCHAR";i:1;s:7:"VARCHAR";}s:4:"type";a:2:{i:0;s:1:"Y";i:1;s:1:"Y";}s:7:"default";a:2:{i:0;s:0:"";i:1;s:0:"";}s:3:"des";a:2:{i:0;s:0:"";i:1;s:10:"JSON结构";}}<|-|>http://域名/api-erp-updateScript.html<|-|>POST<|-|>post

首页 - Setting - API

最后修改: 2023-05-31 17:11:15

删除webhook

编号 : deleteEventPost

POST - http://域名/api-erp-deleteEventPost.html

删除指定名称的脚本

请求参数

参数名	参数类型	必传	缺省值	描述
token	VARCHAR	Y
event_post	VARCHAR	Y		JSON结构

返回值

更新成功:{"code":0,"status":1,"msg":[]}

备注

提交范例:
event_post:  [{"name":"test"},{"name":"test 2"}]
name : webhook名称

最后修改: 2023-06-01 11:33:37

更新webhook

编号 : updateEventPost

POST - http://域名/api-erp-updateEventPost.html

请求参数

参数名	参数类型	必传	缺省值	描述
token	VARCHAR	Y
event_post	VARCHAR	Y		json字符串

返回值

{"code":0,"status":1}

备注

event_post  [{"event_id":1,"name":"webhook1","delay_minute":0,"url":"https://www.xxx.com/notify"}]
event_id  事件id
name  webhook 名称
delay_minute 延时时间以分钟为单位 整数
status 状态 0 禁用 1启用
url   webhook URL
数据例子：
[
    {
      "event_id": 1,
       "name": "webhook1",
       "delay_minute" : 0,
       "url":"https://www.xxx.com/notify"
    }
]
event_id  事件id:
1	注册成功	user_register
4	订单创建	order_add
5	订单支付（非COD）	order_pay
6	订单发货	order_ship
8	订单取消	order_cancel
9	订单完成 / COD付款	order_complete
10	留言添加（管理员）	message_add
20	询盘添加（管理员）	inquiry_add
22	邮件订阅	newsletter_add
24	商品删除	goods_delete
25	商品库存状态切换	goods_stock_change
26	商品上下架	goods_status_change
27	购物车更新	cart_update
29	销售模式变动	goods_sale_mode_change
30	商品价格变动	goods_price_change
31	订单支付确认中	order_pay_checking

最后修改: 2022-05-20 14:12:47

更新店铺货币汇率

编号 : CurrencyUpdate

POST - http://域名/api-erp-currencyUpdate.html

请求参数

参数名	参数类型	必传	缺省值	描述
token	String	Y
data	JSON	Y

返回值

{"code":0,"status":1}

备注

status：状态，0关闭，1启用， 必填
is_main：是否是店铺主货币，1表示主货币，0表示非主货币， 必填
base_name：货币名称， 必填
symbol_left：货币左符号， 选填， 与symbol_right二选一
symbol_right：货币右符号， 选填，可留空
exchange_rate：货币汇率，相对于店铺当前主货币， 必填
decimal_num：货币小数点位数， 必填
standard_code：货币标准三位编码， 必填
listorder：排序值， 必填
symbol_separator：千位分隔符，选填 可以留空

data ：货币更新数据例子：
[
    {
        "status": "0",
        "is_main": "0",
        "base_name": "PGK",
        "symbol_left": "",
        "symbol_right": "￥",
        "exchange_rate": "6.53120000",
        "decimal_num": "0",
        "standard_code": "PGK",
        "create_time": "1652803376",
        "listorder": "2",
        "symbol_separator": ""
    }
]

最后修改: 2022-05-19 09:14:05

获取基准货币列表

编号 : CurrencyBaseList

POST - http://域名/api-erp-currencyBaseList.html

请求参数

参数名	参数类型	必传	缺省值	描述
token	String	Y

返回值

{
    "code": 0,
    "status": 1,
    "data": {
        "list": [
            {
                "id": "1",
                "base_name": "USD",
                "symbol_left": "US$",
                "symbol_right": null,
                "exchange_rate": "1.0000",
                "decimal_num": "2",
                "standard_code": "USD",
                "modify_time": "1509688773",
                "cn_name": "美元"
            },
            {
                "id": "2",
                "base_name": "EUR",
                "symbol_left": "€",
                "symbol_right": null,
                "exchange_rate": "0.9559",
                "decimal_num": "2",
                "standard_code": "EUR",
                "modify_time": "1652349806",
                "cn_name": "欧元"
            }
        ]
    }
}

备注

base_name：货币名称
symbol_left：货币左符号
symbol_right：货币右符号
exchange_rate：货币汇率，相对于美元
decimal_num：货币小数点位数
standard_code：货币标准三位编码

最后修改: 2022-05-19 09:14:14

获取店铺货币列表

编号 : CurrencyList

POST - http://域名/api-erp-currencyList.html

请求参数

参数名	参数类型	必传	缺省值	描述
token	String	Y

返回值

{
    "code": 0,
    "status": 1,
    "data": [
        {
            "id": "14484",
            "store_id": "24073",
            "status": "1",
            "is_main": "0",
            "base_name": "OMR",
            "symbol_left": "",
            "symbol_right": "RO.",
            "exchange_rate": "0.38500000",
            "decimal_num": "3",
            "standard_code": "OMR",
            "create_time": "1652803376",
            "listorder": "15",
            "symbol_separator": ""
        },
        {
            "id": "15028",
            "store_id": "24073",
            "status": "1",
            "is_main": "0",
            "base_name": "THB",
            "symbol_left": "฿",
            "symbol_right": "",
            "exchange_rate": "34.72850000",
            "decimal_num": "2",
            "standard_code": "THB",
            "create_time": "1652803376",
            "listorder": "3",
            "symbol_separator": ""
        }
    ]
}

备注

is_main：是否是店铺主货币，1表示主货币，0表示非主货币
base_name：货币名称
symbol_left：货币左符号
symbol_right：货币右符号
exchange_rate：货币汇率，相对于店铺当前主货币
decimal_num：货币小数点位数
standard_code：货币标准三位编码
listorder：排序值
symbol_separator：千位分隔符

最后修改: 2020-09-12 11:14:15

获取支付方式

编号 : Payments

POST - http://域名/api-erp-payments.html

请求参数

参数名	参数类型	必传	描述
token	varchar	Y	接口访问token
base_name	varchar	N	支付名称(左匹配)
interface_type	varchar	N	接口类型(全匹配)

返回值

成功:{"code":0,"status":1,"data":[{"id":"2840","store_id":"24073","base_name":"Payssion\u5907\u75283","formula":"","interface_type":"payssion","config_param":"[]","image":"\/\/us01.imgcdn.ymcart.com\/0\/payment\/payssion.png","listorder":"3","status":"0","create_time":"1585734899","is_billing":"0","site_type":"0","display_param":"[]","remark":""}]}

备注

id int  
store_id  int 店铺id
base_name  支付方式的名称
formula  公式
interface_type 接口类型
config_param 参数配置
image 支付Logo
listorder 排序
status 状态 0关闭 1启用
create_time 创建时间
is_billing 是否使用账单地址 1是 0否
site_type 激活类型 0全部 1PC 2手机
display_param 限制条件参数
remark 备注

最后修改: 2020-03-04 11:18:31

更新员工账号

编号 : updateAdmin

POST - http://域名/api-erp-updateAdmin.html

添加或更新员工账号以及拥有的权限

请求参数

参数名	参数类型	必传	缺省值	描述
token	varchar	Y		接口访问token
admin_res	varchar	Y		json结构接口参数

返回值

全部成功:{"code":0,"status":1,"msg":[]}
部分成功:{"code":100,"status":1,"msg":[]} 
更新失败:{"code":400,"status":1,"msg":[]}

备注

response:
关于code：
0：处理成功
100：部分成功
400-1000：参数验证未通过
1000以上：code验证未通过


request:
{"admin_res":[{"email:"xxx_tmp_admin_tech@35zh.com","status":1,"password":"pass","real_name":"张三","auth":{"base_name":"商品管理","auth_desc":"描述","auth_menus":"setting_country,product_trash"}}],"token":"k"}

email: 用户邮箱
status: 用户状态  上下架
password: 密码
real_name:真实名称
base_name:角色名称
auth_desc: 角色描述
auth_menus: 权限列表

admin_res 限制最多200条

最后修改: 2020-09-12 10:48:17

更新支付方式

编号 : updatePayment

POST - http://域名/api-erp-updatePayment.html

请求参数

参数名	参数类型	必传	缺省值	描述

返回值

成功：{"code":0,"status":1,"msg":"success"}
失败：{"code":404,"status":0}

备注

可选更新字段： 
           base_name：支付名称， 字符串
           status：状态，int 类型，0 表示禁用，1表示启用
           listorder：排序，int 类型，排序值，按从大到小降序排列
           descript：备注，字符串，下单流程显示，尽量60个字符内
           detail：收款账号描述，字符串，支持html
           site_type：站点类型，int类型，0表示所有站点，1表示仅在PC端显示2表示仅在移动端显示
           is_billing：是否需要账单地址，int 类型 0表示不需要 1表示需要
           config_param 接口参数, json 类型   如{"exp_xxx":"xx","exp":"xxx"},  参数名称前必须加 "exp_"
必填字段：payment_id，支付方式id

最后修改: 2018-09-04 17:37:05

删除脚本

编号 : deleteScript

POST - http://域名/api-erp-deleteScript.html

删除指定名称的脚本

请求参数

参数名	参数类型	必传	缺省值	描述
token	VARCHAR	Y
script_res	VARCHAR	Y		JSON结构

返回值

更新成功:{"code":0,"status":1,"msg":[]}

备注

提交范例:
script_res :  [{"name":"test"},{"name":"test 2"}]
name : 脚本名称

最后修改: 2023-05-31 17:15:14

更新脚本

编号 : updateScript

POST - http://域名/api-erp-updateScript.html

更新网站的脚本,如果有存在名称相同的脚本将会被删除

请求参数

参数名	参数类型	必传	缺省值	描述
token	VARCHAR	Y
script_res	VARCHAR	Y		JSON结构

返回值

更新成功:{"code":0,"status":1,"msg":[]}
更新失败:{"code":400,"status":1}

备注

提交范例:
script_res :  [{"name":"test","mc_key":"","detail":"detail1","type":1,"site_type":0,"status":1}]
name : 脚本名称
mc_key : model+controller 例如:product_detail
detail : 脚本代码
type : 脚本位置 0:头部 1:底部
site_type : 脚本类型  0所有站点 1电脑网站 2手机网站 3企业官网
status : 脚本状态 0:关闭 1:开启
list_order: 排序   根据list_order  倒叙 进行加载  script