背景

本文旨在为自动化立体仓库数据同步条件的平台开放服务，提供统一的HTTP接口调用与交互规范。

本文中描述的规范包括AS/RS功能模块的数据同步接口。

规范适用对象说明

本规范仅适用于由平台之间服务器端发起调用请求，包括POST提交数据以及GET请求数据。

名词解释

URL及数据包格式规范

URL

参数

系统级参数

参数名类型是否必须描述
appkeystring是平台认证唯一密钥

业务级参数

遵守数据交换规范中业务级通用参数的约定。

表格4-2业务级参数的通用约定

ERP遵守数据交换规范中业务级通用参数的约定。

响应数据包格式规范

目前接口的返回格式全部采用JSON格式。

JSON输出格式

响应包符合如下规范的标准JSON字符串：

接口响应输出格式

  • 响应输出格式
    •  
                        
    {
        "code":200,
        "msg":"操作成功",
        "data":null
    }
  • 获取成功信息
    •
    codemsgdata
    200操作成功接口返回业务数据

    错误响应输出格式

    错误响应输出内容符合以下规范：

  • 返回内容由code,msg,data此三类属性组成，分别用于描述错误编码，以及错误信息。
    •

    { "code":500, "msg":"服务器内部错误", "data":null }

    错误码定义如下表所示：

    code描述
    201暂无数据
    401参数为空
    403权限不足
    407请勿重复提交
    500服务器错误

    相关业务接口

    商品信息同步

    接口前言

    请求规范

    请求头：

    参数名描述
    MethodPost
    Urlhttp://{prefix}/open/asrs/order/matSync/default/v1
    Content-Typeapplication/json;charset=UTF-8
    appkeyea1f0459efc02a79f046f982767939ae

    注：appkey、prefix由管理员提供

    请求体：

    字段名称必需类型说明
    createTime是字符串单据时间（yyyy-MM-ddHH:mm:ss）
    matDetails是列表单据明细

    注：JSON提交

    matDetails列表对象

    字段名称必需类型说明
    matnr是字符串商品编号
    maktx是字符串商品名称
    groupCode是字符串商品分类
    groupName是字符串分类名称
    name否字符串存货代码
    specs否字符串规格
    model否字符串型号
    color否字符串颜色
    brand否字符串品牌
    unit否字符串单位
    price否字符串单价
    sku否字符串sku
    units否Double单位量
    barcode否字符串条码
    origin否字符串产地
    manu否字符串厂家
    manuDate否Double生产日期
    itemNum否字符串品项数
    safeQty否Double安全库存量
    weight否Double重量
    length否Double长度
    volume否Double体积
    threeCode否字符串三方编码
    Supp否字符串供应商
    suppCode否字符串供应商编码
    beBatch否Integer是否批次1:是0:否
    deadTime否字符串保质期
    deadWarn否Integer预警天数
    source否Integer制购1:制造2:采购3:外协
    inspect否Integer要求检验1:是0:否
    danger是Integer危险品1:是0:否
    status是Integer状态1:正常0:禁用
    createBy是Long填1即可
    createTime是Date添加时间
    memo是字符串备注

    请求示例：

                        
                        {
"createTime":"2022-04-1109:28:10",
"matDetails":[
{
"matnr":"Y9000P",
"maktx":"联想拯救者电脑",
"groupCode":"A01",
"groupName":"laptop",
"name":"联想笔记本电脑",
"specs":"3070显卡",
"model":"非公模具",
"color":"黑色",
"brand":"联想",
"unit":"台",
"price":10999,
"sku":"无sku",
"units":1000,
"barcode":"90000001",
"origin":"中国",
"manu":"中国联想",
"manuDate":"2022-04-1109:28:10",
"itemNum":"1000",
"safeQty":30,
"weight":5,
"length":3,
"volume":10,
"threeCode":"无三方编码",
"supp":"浙江中扬立库",
"suppCode":"supp01",
"beBatch":1,
"deadTime":"2022-08-1109:28:10",
"deadWarn":1,
"source":1,
"inspect":1,
"danger":2,
"status":1,
"createBy":1,
"createTime":"2022-08-1109:28:10",
"memo":"测试用"
}
]
}

    返回值

    响应字段：

    字段名称类型说明
    code数字响应码
    msg字符串响应描述
    data列表响应内容

    响应示例：

                        
{
"msg":"操作成功",
"code":200
}

    生成入库单据

    接口前言

    请求规范

    请求头:

    参数名描述
    MethodPost
    UrlPost
    Content-Typeapplication/json;charset=UTF-8
    appkeyea1f0459efc02a79f046f982767939ae

    注：appkey、prefix由管理员提供

    请求体：

    字段名称必需类型说明
    orderNo是字符串单据编号
    orderType是字符串单据类型
    orderTime是字符串单据时间（yyyy-MM-ddHH:mm:ss）
    orderDetails是列表单据明细

    注：JSON提交

    注:如果orderDetails中出现两条有相同商品编号(matnr)和相同生产批号(batch)的 信息,立库仅会生成一条,并将数量累加.

    orderDetails列表对象：

    字段名称必需类型说明
    matnr是字符串商品编号（确保此商品已同步至立库）
    batch否字符串生产批号
    anfme是数字型入库数量

    请求示例：

                        
{
"orderNo":"963007546090586112",
"orderTime":"2022-04-1109:28:10",
"orderType":"采购入库单",
"orderDetails":[
{
"matnr":"MDH020030530",
"anfme":18.0,
"batch":"500"
},
{
"matnr":"LSH90152025",
"anfme":50.0
}
]
}

    返回值

    响应字段：

    字段名称类型说明
    code数字响应码
    msg字符串响应描述
    data列表响应内容

    响应示例：

                        
{
"msg":"操作成功",
"code":200
}

    入库完成回写

    接口前言

    请求规范

    请求头：

    参数名描述
    MethodPost
    Urlhttp://{prefix}/open/asrs/order/matSync/default/v1
    Content-Typeapplication/json;charset=UTF-8
    appkeyea1f0459efc02a79f046f982767939ae

    注：appkey、prefix由管理员提供

    请求体：

    字段名称必需类型说明
    orderNo否字符串单据编号（此参数为空时，获取所有已 完成的入库单据，数据被获取后，下次 请求此接口，数据不会重复出现；反 之，则获取指定单据编号数据，指定单 据数据可重复出现。

    返回值

    响应字段：

    字段名称类型说明
    code数字响应码
    msg字符串响应描述
    data列表响应内容

    data列表对象：

    字段名称类型说明
    orderNo字符串单据编号
    orderType字符串单据类型
    orderTime字符串单据时间（yyyy-MM-ddHH:mm:ss）
    orderDetails列表单据明细

    orderDetails列表对象：

    字段名称类型说明
    matnr字符串商品编号
    batch字符串生产批号
    anfme数字型入库数量
    orderNo字符串单据编号

    响应示例：

                        
{
    "msg":"操作成功",
    "code":200,
    "data":[
        {
            "orderNo":"963007546090586112",
            "orderType":"采购入库单",
            "orderTime":"2022-04-11 09:30:35",
            "orderDetils":[
                    {
                        "orderNo":"963007546090586112",
                        "matnr":"MDH020030530",
                        "batch":"500",
                        "anfme":18.0
                    },
                    {
                        "orderNo":"963007546090586112",
                        "matnr":"MDH020030530",
                        "batch":"500",
                        "anfme":18.0
                    }
            ]
        }
    ]
}