接口定义-优链.DOCVIP

优链对外接口说明书 技术文件编号：YS100001 共25页 (包括封面) 拟制 王明 审核 　　　 会签 标准化 批准　　 　 修改记录 文件编号 版本号 拟制人/ 修改人 拟制日期/ 修改日期 更改理由 主要更改内容 （写要点即可） YS100001 1.0 王明 2016.03.01 无 无 YS100001 1.01 王明 2016.03.17 扩展接口功能 增加物料推送接口 注：文件第一次归档时，“更改理由”、“主要更改内容”栏写“无”。 目 录 1 引言 4 1.1 编写目的 4 1.2 文档约定 4 2 术语、定义和缩略语 4 2.1 术语、定义 4 2.2 缩略语 4 3 相关文档 4 4 概述 4 4.1 功能概述 4 4.2 接口说明 5 4.2.1 接口统一返回消息格式说明 5 4.3 接口定义 5 4.3.1 下单接口 5 4.3.2 查询供应商接口 8 4.3.3 查询供应商提货地址接口 9 4.3.4 查询客户国内送货地址接口 10 4.3.5 查询下单产品物料接口 11 4.3.6 产品物料批量推送接口 13 5 错误码说明 15 6 附录 15 6.1 币制代码 15 6.2 国家代码 15 6.3 单位代码 22 6.4 供应商交货方式 25 6.5 国内送货方式 25 6.6 快递类型 25 引言 编写目的 本文描述的对象是优链下单接口说明书，通过该文档描述，明确第三方和优链服务端之方式、数据格式数据定义等内容 文档约定 本文档遵循以下约定： 表头文字使用了25%灰度背景。 插图一律“嵌入”于描述正文中，而非“浮于文字上方”。 用同号、同体但加粗的文字来强调需要读者重视的内容。 术语、定义和缩略语 术语、定义 本文使用的专用术语、定义见表2.1。 表2.1 术语/定义 英文对应词 含义 缩略语 本文使用的缩略语见表2.2 表2.2 缩略语 英文原文 中文含义 相关文档 本文的相关文档见表3.1。 表3.1 文件编号 文件名称 版本号 说明 概述 功能概述 本模块描述了以下一些主要的功能：优链下单及其附带功能，具体详情见下章节。 接口说明 接口统一返回消息格式说明 1.接口请求方式http协议，数据组织方式为方式 2.接口地址：=http(https)://ip:port/scsp/api 3.所有接口统一返回json格式消息，消息字段为：class、code、msg和data。示例数据格式为： ｛ “class”:”com.runintime.scsp.youscm.restful.Jo”， “code”:0， “msg”:”成功”， “data”：｛｝ ｝ 字段名称 类型 说明 c int 如果处理成功，结果码为值表示有误错误码说明） msg 错误描述 json 接口返回的数据 class string 接口标识字段，接口调用方无需理会 4.以下表格中的响应参数均指data字段不为空下的返回值说明。 接口定义 接口描述 Http_method POST 接口说明 实现远程优链下单 请求参数 名称 是否可空 字段说明 ”pick”时必填； 供应商要求提货时间，24小时制，格式：yyyy-MM-dd HH:mm supplierAddressId string 是 当receivingType=”pick”时必填； 供应商提货地址标识，来源见4.3.3 inDeliveryFile string 是 当receivingType=”pick”时必填； 提货文件的Base64编码，必须是PDF文档 packingFile string 是 当receivingType=”pick”时必填； 装箱单文件的Base64编码，必须是PDF文档 expressNo string 是 当receivingType=”express”时可传，快递单号 deliveryWay string 否 国内送货方式，代码见6.5 pickGoodsPerName string 是 当deliveryWay=”02”时必填；国内送货自提方式下提货人姓名 pickGoodsPerTel string 是 当deliveryWay=”02”时可传；国内送货自提方式下提货人电话 pickGoodsPerId string 是 当deliveryWay=”02”时必填；国内送货自提方式下提货人身份证 pickGoodsPlateNur string 是 当deliveryWay=”02”时可传；国内送货自提方式下提货人车牌号 pickGoodsDate da