Appearance
6.1 立即购买下单
接口说明:
Method | URL | ContentType |
---|---|---|
POST | /api/v1/order/submit | application/json |
请求参数说明:
字段名 | 类型 | 是否必填 | 示例值 | 描述 |
---|---|---|---|---|
orderCode | String | 否 | "ORDER2025080400001" | 订单编号。可为空,如果不为空则根据订单号校验订单是否存在 |
products | Array[Object] | 是 | [{"sku": "..."}] | 下单商品信息列表,不可为空。具体结构见下方 ProductInfo 对象。 |
freight | BigDecimal | 否 | 15.00 | 运费。如果商家承担运费或包邮,此字段可为0或空。 |
totalAmount | BigDecimal | 是 | 259.00 | 订单总金额(单位:元)。该金额通常是商品总价、运费等所有费用之和,再减去各种抵扣后的最终应付金额。 |
receiverName | String | 是 | "张三" | 收货人姓名。 |
receiverTel | String | 是 | "13800138000" | 收货人联系电话。 |
provinceCode | String | 是 | "110000" | 收货人所在省份的行政区划代码。 |
provinceName | String | 否 | "北京市" | 收货人所在省份的名称。 |
cityCode | String | 是 | "110100" | 收货人所在城市的行政区划代码。 |
cityName | String | 否 | "北京市" | 收货人所在城市的名称。 |
districtCode | String | 是 | "110101" | 收货人所在区县的行政区划代码。 |
districtName | String | 否 | "东城区" | 收货人所在区县的名称。 |
address | String | 是 | "王府井大街1号" | 收货人详细地址(不含省市区)。 |
fullAddress | String | 否 | "北京市北京市东城区王府井大街1号" | 收货人完整地址(省市区+详细地址)。此字段通常由后端根据省市区和详细地址自动拼接,前端可传可不传。 |
remark | String | 否 | "请在工作日送货" | 订单备注信息。 |
balanceDeduction | BigDecimal | 否 | 20.00 | 使用余额抵扣的金额(单位:元)。 |
pointsDeduction | BigDecimal | 否 | 10.00 | 使用积分抵扣的金额(单位:元)。 |
couponIdList | Array[String] | 否 | ["COUPON001", "COUPON002"] | 本次下单使用的优惠券ID列表。 |
activityCode | String | 否 | "FLASH_SALE_2025" | 参与的活动编码。注释说明此字段会存入订单扩展字段中。 |
extensions | Array[Object] | 否 | [{"columnKey": "..."}] | 订单扩展字段列表,用于存储一些非核心、动态的订单信息。具体结构见下方 Extension 对象。 |
内部对象说明
1. ProductInfo
对象 (商品信息)
该对象定义了订单中单个商品的详细信息。
字段名 | 类型 | 是否必填 | 示例值 | 描述 |
---|---|---|---|---|
sku | String | 是 | "PROD_SKU_12345" | 商品SKU(Stock Keeping Unit)编码,用于唯一标识一个商品。 |
name | String | 是 | "2024新款 T恤 深蓝色 L码" | 商品名称。 |
price | BigDecimal | 是 | 99.00 | 商品下单时的单价(单位:元)。 |
num | Integer | 是 | 2 | 购买的商品数量。 |
2. Extension
对象 (扩展字段)
该对象用于存储订单的扩展信息,以键值对的形式存在。
字段名 | 类型 | 是否必填 | 示例值 | 描述 |
---|---|---|---|---|
columnKey | String | 否 | source_channel | 扩展字段的键(Key),用于唯一标识一个扩展项。 |
columnName | String | 否 | 来源渠道 | 扩展字段的名称(Name),用于前端展示或后台管理。 |
columnValue | String | 否 | WX | 扩展字段的值(Value),存储具体的信息。 |
返回参数说明:
字段名 | 类型 | 是否必填 | 示例值 | 描述 |
---|---|---|---|---|
orderCode | String | 是 | "ORDER2025080400001" | 订单编号 |
请求示例
/api/v1/order/submit
请求数据示例:
json
{
"orderCode": "ORDER2025080400001",
"products": [
{
"sku": "PROD_SKU_12345",
"name": "2024新款 T恤 深蓝色 L码",
"price": 99.00,
"num": 2
},
{
"sku": "PROD_SKU_67890",
"name": "夏季速干短裤 黑色 M码",
"price": 65.00,
"num": 1
}
],
"freight": 15.00,
"totalAmount": 259.00,
"receiverName": "张三",
"receiverTel": "13800138000",
"provinceCode": "110000",
"provinceName": "北京市",
"cityCode": "110100",
"cityName": "北京市",
"districtCode": "110101",
"districtName": "东城区",
"address": "王府井大街1号",
"fullAddress": "北京市北京市东城区王府井大街1号",
"remark": "请在工作日送货",
"balanceDeduction": 20.00,
"pointsDeduction": 10.00,
"couponIdList": [
"COUPON_OFF_10"
],
"activityCode": "FLASH_SALE_2025",
"extensions": [
{
"columnKey": "gift_packaging",
"columnName": "礼品包装",
"columnValue": "true"
},
{
"columnKey": "source_channel",
"columnName": "来源渠道",
"columnValue": "mini_program"
}
]
}
返回数据示例:
json
{
"data": {
"orderCode": "ORDER2025080400001"
},
"success": true,
"message": "",
"code": "000"
}