订单推送API
接口地址 | http://host:port/pospal-api2/openapi/v1/orderOpenApi/addOnLineOrder | ||
---|---|---|---|
请求头 |
|
||
请求方式 | POST | ||
请求体 |
|
||
参数名 | 是否必须 | 类型 | 说明 |
appId | 是 | String | Pospal配置的访问凭证 |
payMethod | 是 | String | 支付方式:
Cash:表示现金支付(如果是想在银豹收银,建议选择该方式,收银的时候可以自由选择所有的支付方式) Wxpay:表示微信支付 Alipay:表示支付宝支付 xxxxxxx:自定义支付名称通过销售单据api的 queryMyPayMethod 接口获取到的showName 支付方式为Wxpay或Alipay必须设置payOnLine=1 |
payMethodCode | 否 | String | xxxxxxx:自定义支付code 当为自定义支付时,该字段必填通过销售单据api的 queryMyPayMethod 接口获取到的orignCode |
customerNumber | 否 | String | 会员号,订单是哪个会员下的。 如果payMethod= CustomerBalance,参数customerNumber不能为空 |
shippingFee | 否 | BigDecimal | 运费 |
packageFee | 否 | BigDecimal | 打包费 |
orderRemark | 否 | String | 订单备注 |
orderDateTime | 是 | String | 订单产生的时间,格式为yyyy-MM-dd HH:mm:ss |
contactAddress | 是 | String | 送货地址,联系地址 |
contactName | 是 | String | 联系人姓名 |
contactTel | 是 | String | 联系人电话 |
items | 是 | List | 商品列表 |
productUid | 是 | Long | 商品在银豹系统的唯一标识 |
comment | 否 | String | 针对商品条目的备注 |
quantity | 是 | BigDecimal | 数量 |
manualSellPrice | 否 | BigDecimal | 商品单价 默认以银豹后台设置的价格为准。 只有当orderSource=openApi时,该字段才生效 |
deliveryType | 否 | Integer | 配送类型,默认为0-外卖单。 0外卖单; 1店内单,自助单 |
deliveryTime | 否 | String | 期望送达时间 格式为yyyy-MM-dd HH:mm:ss 当deliveryType=0时有效 |
longitude | 否 | BigDecimal | 收货人经度 高德坐标系 如果想通过达达,蜂鸟 等方式配送,需要传经纬度 |
latitude | 否 | BigDecimal | 收货人纬度 高德坐标系 |
dinnersNumber | 否 | Integer | 就餐人数 |
restaurantAreaName | 否 | String | 餐厅区域名,在银豹后台要先设置好,参数值必须与设置好的对应 |
restaurantTableName | 否 | String | 餐桌名称,桌号,在银豹后台要先设置好,参数值必须与设置好的对应 |
reservationTime | 否 | String | 到店时间,预约时间,格式为yyyy-MM-dd HH:mm:ss |
skipProductStockValidation | 否 | Integer | 是否跳过库存校验 orderSource为空: 0:会校验库存(默认) 1:不检验库存 orderSource不为空:统一不检验库存 |
payOnLine | 否 | Integer | 是否已经完成线上付款。若线上已付款,则设置payOnLine=1 且payMethod 只能为Wxpay或Alipay 或自定义支付方式。否则,该参数不传 |
orderSource | 否 | String | 为openApi时,商品单价按接口的manualSellPrice计算 为空时,按银豹后台设置的销售价计算 |
daySeq | 否 | String | 牌号,取餐号。当orderSource=openApi时,才生效,如果不传,不会默认生成。 当orderSource!=openApi时,后台会默认生成一个 |
totalAmount | 否 | BigDecimal | 总金额,orderSource不为空时,totalAmount必填 |
返回结果 |
|
||
字段名 | 类型 | 说明 | |
status | String | 是否正确处理请求,返回success或error,不区分大小写 | |
messages | String[] | 处理结果的消息 | |
errorCode | int | 业务处理的错误代码,参见错误代码表 | |
data | Json | 实体信息 | |
orderNo | String | 订单序列号 | |
orderCreateDateTime | String | 下单时间 | |
customerNumber | String | 订单会员号 | |
常见错误 |
|
接口地址 | http://host:port/pospal-api2/openapi/v1/orderOpenApi/cancleOrder | ||
---|---|---|---|
请求头 |
|
||
请求方式 | POST | ||
请求体 |
|
||
参数名 | 是否必须 | 类型 | 说明 |
appId | 是 | String | Pospal配置的访问凭证 |
返回结果 |
|
||
字段名 | 类型 | 说明 | |
status | String | 是否正确处理请求,返回success或error,不区分大小写 | |
messages | String[] | 处理结果的消息 | |
errorCode | int | 业务处理的错误代码,参见错误代码表 |
接口地址 | http://host:port/pospal-api2/openapi/v1/orderOpenApi/shipOrder | ||
---|---|---|---|
请求头 |
|
||
请求方式 | POST | ||
请求体 |
|
||
参数名 | 是否必须 | 类型 | 说明 |
appId | 是 | String | Pospal配置的访问凭证 |
返回结果 |
|
||
字段名 | 类型 | 说明 | |
status | String | 是否正确处理请求,返回success或error,不区分大小写 | |
messages | String[] | 处理结果的消息 | |
errorCode | int | 业务处理的错误代码,参见错误代码表 |
接口地址 | http://localhost:8080/pospal-api2/openapi/v1/orderOpenApi/completeOrder | ||
---|---|---|---|
请求头 |
|
||
请求方式 | POST | ||
请求体 |
|
||
参数名 | 是否必须 | 类型 | 说明 |
appId | 是 | String | Pospal配置的访问凭证 |
shouldAddTicket | 否 | Boolean | 是否在银豹收银系统生成流水单据 |
返回结果 |
|
||
字段名 | 类型 | 说明 | |
status | String | 是否正确处理请求,返回success或error,不区分大小写 | |
messages | String[] | 处理结果的消息 | |
errorCode | int | 业务处理的错误代码,参见错误代码表 |
接口地址 | http://host:port/pospal-api2/openapi/v1/orderOpenApi/queryOrderByNo | ||
---|---|---|---|
请求头 |
|
||
请求方式 | POST | ||
请求体 |
|
||
参数名 | 是否必须 | 类型 | 说明 |
appId | 是 | String | Pospal配置的访问凭证 |
orderNo | 否 | String | 订单号 |
返回结果 | |||
字段名 | 类型 | 说明 | |
status | String | 是否正确处理请求,返回success或error,不区分大小写 | |
messages | String[] | 处理结果的消息 | |
errorCode | int | 业务处理的错误代码,参见错误代码表 | |
data | Json | 订单实体数据 | |
payMethod | String | 支付方式: Cash,表示现金支付 CustomerBalance,表示用会员余额支付,接口会根据 customerNumber去扣除对应会员的余额 |
|
customerNumber | String | 会员号,订单是哪个会员下的。 如果payMethod=CustomerBalance,参数customerNumber不能为空 |
|
shippingFee | BigDecimal | 运费 | |
orderRemark | String | 订单备注 | |
orderDateTime | String | 订单产生的时间,格式为yyyy-MM-dd HH:mm:ss | |
contactAddress | String | 送货地址,联系地址 | |
contactName | String | 联系人姓名 | |
contactTel | String | 联系人电话 | |
totalAmount | BigDecimal | 总金额 | |
state | Int | 订单状态 NULL = 0; //定单创建时的状态 SYNCED = 1; //定单已同步到客户端的状态 SHIPPED = 2; //定单已发货状态 CANCELED = 3; //定单取消状态 COMPLETED = 4; //定单结束状态 COMPLETED = 5; //商家确认接收新订单 COMPLETED = 8; //待厨打/下发配送订单 |
|
daySeq | String | 牌号,取餐号 | |
deliveryType | Integer | 0或空为外卖:门店配送,商家自己送货上门
1为自助点餐 2为自提 3为预约单 4为平台配送,如美团配送,百度配送 |
|
orderSource | String | 订单来源
MEITUAN_WAIMAI 美团外卖 ELEME_WAIMAI 饿了么 ELEBE_WAIMAI 饿百 ZIYING_MINIAPP 银豹小程序 ZIYING_MIAOSHA 秒杀单 ZIYING_KANJIA 砍价 openApi 开放平台网单添加接口 |
|
items | List | 商品列表 | |
productUid | Long | 商品在银豹系统的唯一标识 | |
productName | String | 商品名称 | |
productBarcode | String | 商品条码 | |
eshopSellPrice | BigDecimal | 网店网店销售价 | |
productQuantity | BigDecimal | 数量 | |
productBuyPrice | BigDecimal | 商品进货价 | |
productSellPrice | BigDecimal | 商品销售价 | |
isCustomerDiscount | Boolean | 是否开启会员折扣 | |
customerDiscount | BigDecimal | 会员折扣率 | |
customerPrice | BigDecimal | 会员价 | |
comment | String | 针对商品条目的备注 | |
attrs | List | 商品属性(口味) | |
productAttributeUid | Long | 商品属性唯一标识 | |
attributeName | String | 商品属性名称 | |
attributeValue | String | 商品属性价格 |
接口地址 | http://host:port/pospal-api2/openapi/v1/orderOpenApi/queryOrderById | ||
---|---|---|---|
请求头 |
|
||
请求方式 | POST | ||
请求体 |
|
||
参数名 | 是否必须 | 类型 | 说明 |
appId | 是 | String | Pospal配置的访问凭证 |
id | 是 | int | 订单id |
返回结果 |
| ||
字段名 | 类型 | 说明 | |
|
接口地址 | http://host:port/pospal-api2/openapi/v1/orderOpenApi/queryOrderPages | ||
---|---|---|---|
请求头 |
|
||
请求方式 | POST | ||
请求体 |
|
||
参数名 | 是否必须 | 类型 | 说明 |
appId | 是 | String | Pospal配置的访问凭证 |
startTime | 是 | String | 格式为yyyy-MM-dd HH:mm:ss |
endTime | 是 | String | 格式为yyyy-MM-dd HH:mm:ss endTime - startTime <= 1天 |
postBackParameter | 否 | Json | 查询首页时可以不传,之后的内容从返回结果中取出 |
parameterType | 是 | String | 从返回结果中取出 |
parameterValue | 是 | String | 从返回结果中取出 |
返回结果 |
|
||
字段名 | 类型 | 说明 | |
status | String | 是否正确处理请求,返回success或error,不区分大小写 | |
messages | String[] | 处理结果的消息 | |
errorCode | int | 业务处理的错误代码,参见错误代码表 | |
data | list | 订单实体数据列表 | |
实体数据 | Json |