API接口说明

API接口说明

VERSION: 1.0.2844.Api.Ali.20240221.Beta

订单相关接口

订单相关接口

一、下单前校验商品是否可售

sequenceDiagram participant C as C端 participant B as B端 participant SCM as 2844供应链 C ->> +B: 该商品是否可售？ B ->> +SCM: 下单前校验商品是否可售（即此接口） SCM-->>-B: 返回可售商品列表以及运费信息 B-->>-C: 反馈是否可以下单

1.1、接口名称 ： OrdersCheckPoint（ http method：post）

示例：http://supply.2844go.com:2844/scm/api/OrdersCheckPoint.json2

使用json提交。

json 格式如下：

	{
		"skuList":[
			{"sku_id":215724,"num":1}
		],
		"consignee":{
			"province":105,
			"city":60945,
			"area":62179,
			"street":110519
		}
	}

JsonBody (Content-Type:application/json)
key类型必须备注
skuListArrayList<Map<string,number>>是
├─ sku_idnumber是商品唯一规格id（商品详情中sku_id）
├─ numnumber是购买数量
consigneeMap<string,number>是
├─ provincenumber是省ID（一级行政区划）ID值参考行政区划接口
├─ citynumber是市ID（二级行政区划）行政区划接口
├─ areanumber是区ID（三级行政区划）行政区划接口
├─ streetnumber是街道ID（四级行政区划）
返回数据
key类型必须备注
codenumber是1：表示成功；其它均为失败。
msgstring否返回简要消息。
resultMap<string,Object>是返回数据
├─ available_sku_idsArrayList<number>是可售列表(逗号分割)
├─ available_sku_freightArrayList<Map<string,Object>>是可售列表(运费信息)
├─├─ freightnumber是总运费
├─├─ baseFreightnumber是基础运费
├─├─ remoteRegionFreightnumber否偏远地区加收运费
├─├─ conFreightnumber否续重运费
├─├─ skuArrayList<number>是该运费适用于哪些商品
├─ ban_sku_idsArrayList<number>是不可售列表（逗号分割）
响应示例
二、提交订单

sequenceDiagram participant C as C端 participant B as B端 participant T as 三方支付(微信、支付宝...) participant SCM as 2844供应链 C ->> T: 拉起微信或支付宝支付 T -->> B: 收到支付成功通知 B ->> +SCM: 创建订单（即此接口），将订单数据推送供应链 SCM-->>-B: 返回供应链端订单编号

2.1、接口名称 ： OrdersCreate（ http method：post）

示例：http://supply.2844go.com:2844/scm/api/OrdersCreate.json2

使用json提交。

json 格式如下：

	{
		"orderNo":"a2cbbdd983ee43a2b4c0cb8d5692c7dd",
		"orderTime":"2022-06-10 15:49:56",
		"skuList":[
			{"sku_id":215724,"num":1,"price":2500}
		],
		"consignee":{
			"name":"竹林春雨",
			"phone":"18032603709",
			"province":105,
			"city":60945,
			"area":62179,
			"street":110519,
			"description":"岩峰大厦1603室",
			"address":"河北省廊坊市三河市燕郊经济开发区神威大街岩峰大厦1603室"
		}
		
	}

C端顾客支付成功，接到支付通路回调时，调用此方法在平台创建订单。

JsonBody (Content-Type:application/json)
key类型必须备注
skuListArrayList<Map<string,number>>是
├─ sku_idnumber是商品唯一规格id（商品详情中sku_id）
├─ numnumber是购买数量
├─ pricenumber否单价（若不传，默认使用供应链当前的协议金额成交，若传，则服务端会校验价格是否同步，未同步会导致下单失败。）
consigneeMap<string,number>是
├─ consigneestring是收件人
├─ phonestring是手机号码
├─ provincestring是省
├─ citystring是市
├─ areastring是区
├─ streetstring是街道
├─ descriptionstring是详细地址
├─ addressstring是完整地址
返回数据
key类型必须备注
codenumber是1：表示成功；其它均为失败。
msgstring否返回简要消息。
rowslist否订单ID，可能有多个：[1,2,3,4]，供应链会根据商品的不同来源渠道自动拆单。
响应示例
三、订单完成
3.1、接口名称 ： OrdersDone（ http method：post）

示例：http://supply.2844go.com:2844/scm/api/OrdersDone?order_id=75

顾客确认收货。

请求参数
参数名称必须示例备注
order_id是订单ID,参考订餐列表返回的数据。
返回数据
key类型必须备注
codenumber是1：表示成功；其它均为失败。
msgstring否返回简要消息。
响应示例
四、订单列表
5.1、接口名称 ： OrdersAllIds（ http method：get）

示例：http://supply.2844go.com:2844/scm/api/OrdersAllIds

返回全部订单的id.

请求参数
参数名称必须示例备注
page否第几页。默认值 1
rows否每次返回多少个商品ID？最多一次200个，默认50。
返回数据
key类型必须备注
codenumber是1：表示成功；0:表示无数据；其它均为失败，失败原因参考msg描述。
msgstring否返回简要消息。
rowslist<number>否订单编号数组。
响应示例
5.2、接口名称 ： OrdersDoneIds（ http method：get）

示例：http://supply.2844go.com:2844/scm/api/OrdersDoneIds

返回全部已经确认订单的id.

请求参数
参数名称必须示例备注
page否第几页。默认值 1
rows否每次返回多少个商品ID？最多一次200个，默认50。
返回数据
key类型必须备注
codenumber是1：表示成功；其它均为失败。
msgstring否返回简要消息。
rowslist<number>否订单编号数组。
响应示例
五、订单详情
6.1、接口名称 ： OrdersDetail（ http method：get）

示例：http://supply.2844go.com:2844/scm/api/OrdersDetail?order_id=75

根据商品id返回订单详情信息。

请求参数
参数名称必须示例备注
id是订单ID。（参考订单列表）
返回数据
key类型必须备注
codenumber是1：表示成功；其它均为失败。
msgstring否返回简要消息。
ordersInfoMap<string,object>是订单信息
├─ order_idnumber是订单ID
├─ total_feenumber是订单合计金额（单位：分）不含运费
├─ freightnumber否运费单位：分）
├─ mainMap<string,object>是主订单信息
├─ ├─ main_order_idnumber是主订单ID
├─ ├─ total_feenumber是主订单总计金额（单位：分）不含运费
├─ ├─ order_timedate是C端下单时间
├─ ├─ create_timedate是服务器端创建时间
├─ consigneeMap<string,object>是收件人信息
├─ ├─ idnumber是收件人信息ID
├─ ├─ phonenumber是收件人手机号
├─ ├─ namenumber是收件人姓名
├─ ├─ provincenumber是一级行政区划ID（省）
├─ ├─ citynumber是二级行政区划ID（市）
├─ ├─ areanumber是三级行政区划ID（区）
├─ ├─ street number是四级行政区划ID（街道）
├─ ├─ address number是收件地址
├─ skuInfoArrayList<Map<string,object>>是订单商品信息
├─ ├─ sku_id number是商品SKU_ID
├─ ├─ icon string是商品缩略图
├─ ├─ title string是商品名称
├─ ├─ num string是下单数量
├─ ├─ unit string是单位
├─ ├─ amount string是金额（单位：分）数量 * 协议价
├─ otherOrdersArrayList<number>否和该订单一同下单的其它订单（不包括此订单）
响应示例

立即接入