背景

本文旨在为自动化立体仓库数据同步条件的平台开放服务,提供统一的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服务器错误

    相关业务接口

    商品信息同步

    接口前言

    请求规范

    请求头:

    参数名描述
    Methodhttp://{prefix}/open/asrs/order/matSync/default/v1
    UrlPost
    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
    unitsDouble单位量
    barcode字符串条码
    origin字符串产地
    manu字符串厂家
    manuDateDouble生产日期
    itemNum字符串品项数
    safeQtyDouble安全库存量
    weightDouble重量
    lengthDouble长度
    volumeDouble体积
    threeCode字符串三方编码
    Supp字符串供应商
    suppCode字符串供应商编码
    beBatchInteger是否批次1:是0:否
    deadTime字符串保质期
    deadWarnInteger预警天数
    sourceInteger制购1:制造2:采购3:外协
    inspectInteger要求检验1:是0:否
    dangerInteger危险品1:是0:否
    statusInteger状态1:正常0:禁用
    createByLong填1即可
    createTimeDate添加时间
    memo字符串备注