客需服务订单

API列表

请求方式	API	描述
GET	/v1.0/cloud/osaas/projects/{project_id}/server-order/page	分页查询服务订单列表
GET	/v1.0/cloud/osaas/projects/{project_id}/server-order/get	查询服务订单详情
POST	/v1.0/cloud/osaas/projects/{project_id}/server-order/producing	接受服务订单
POST	/v1.0/cloud/osaas/projects/{project_id}/server-order/finished	完成服务订单
POST	/v1.0/cloud/osaas/projects/{project_id}/server-order/cancel	取消服务订单

分页查询服务订单列表

接口描述

调用该接口分页查询服务订单列表

接口地址

GET /v1.0/cloud/osaas/projects/{project_id}/server-order/page

请求参数

参数名	类型	参数类型	说明	是否必需
project_id	String	URI	项目唯一标识	是
order_id	String	BODY	订单ID	否
room_no	String	BODY	房间号	否
order_biz_type	String	BODY	订单业务类型（MATERIAL：商品订单，SERVICE：服务订单）	是
order_status	String	BODY	订单状态（created：待处理，canceled：已取消，producing：进行中，finished：已完成）	否
order_source	String	BODY	订单来源（SMART_SPEAKER：智能音箱，APPLET_WX：微信小程序，APPLET_ALIPAY：支付宝小程序，APPLET_H5：H5页面）	否
delivery_type	String	BODY	配送方式（robot：机器人配送，manualDelivery：人工配送）	否
create_order_begin_time	Long	BODY	订单创建开始时间，13位时间戳	否
create_order_end_time	Long	BODY	订单创建结束时间，13位时间戳	否
page_no	Integer	BODY	当前页码（page_no≥1）	是
page_size	Integer	BODY	每页数量（1≤page_size≤100）	是

响应参数

参数名	类型	说明
code	Integer	响应码（详情见错误码章节），成功时为空
success	Boolean	是否成功：（true：成功，false：失败）
msg	String	请求失败的信息，成功时为空
t	Long	返回时间戳，13位
result	Object	返回结果

result参数说明

参数名	类型	说明
total	Long	总条数
page_no	Integer	页码
page_size	Integer	页条数
data	Arrays	订单集合

data参数说明

参数名	类型	说明
space_id	String	房间唯一编码
room_no	String	房间号
project_id	String	项目唯一编码
order_id	String	交易订单唯一编码
order_status	String	交易订单状态（created：待处理，canceled：已取消，producing：进行中，finished：已完成）
order_biz_type	String	订单业务类型（MATERIAL：商品订单，SERVICE：服务订单）
second_order_biz_type	String	二级订单业务类型（ROOM_CLEAN：房间清理服务，ROOM_SUPPLEMENT：房间补充用品，ROOM_MAINTENANCE_SERVICE：维修服务类，FOOD_SERVICE：订餐服务类，LANDRY_SERVICE：客房洗衣类，RENEW：客房续住类，CHECK_OUT：客房退房类，CHANGE_ROOM：客房换房类，CHECK_IN：客房入住类，INVOICE：发票）
commodity_list	Arrays	订单商品集合
checkin_order_group_id	String	订单组ID
quantity	Integer	商品数量
order_amount	BigDecimal	订单金额
currency	String	货币
order_source	String	订单来源（SMART_SPEAKER：智能音箱，APPLET_WX：微信小程序，APPLET_ALIPAY：支付宝小程序，APPLET_H5：H5页面）
create_order_time	Long	下订单时间，13位时间戳
finish_order_time	Long	完成订单时间，13位时间戳
cancel_reason	String	取消原因
delivery_type	String	配送方式（robot：机器人配送，manualDelivery：人工配送）
delivery_no	String	配送单ID

commodity_list参数说明

参数名	类型	说明
id	String	订单商品表主键
commodity_name	String	商品名称
unit_price	BigDecimal	单价成交价
quantity	Integer	商品的数量
order_amount	BigDecimal	成交价
currency	String	货币
icon_url	String	商品图标

请求示例

GET {url}/v1.0/cloud/osaas/projects/1160823965053******/server-order/page

{
  "order_biz_type": "SERVICE",
  "page_no": 1,
  "page_size": 10
}

响应成功示例

{
  "result": {
    "total": 1,
    "page_no": 1,
    "page_size": 10,
    "data": [
      {
        "space_id": "1341704857710******",
        "room_no": "8801",
        "project_id": "1160823965053******",
        "order_id": "ORDER20260410******",
        "order_status": "created",
        "order_biz_type": "SERVICE",
        "second_order_biz_type": "ROOM_SUPPLEMENT",
        "commodity_list": [
          {
            "id": "100001",
            "commodity_name": "矿泉水",
            "unit_price": 5.00,
            "quantity": 2,
            "order_amount": 10.00,
            "currency": "CNY",
            "icon_url": "https://example.com/water.png"
          }
        ],
        "checkin_order_group_id": "GROUP20260410******",
        "quantity": 2,
        "order_amount": 10.00,
        "currency": "CNY",
        "order_source": "APPLET_WX",
        "create_order_time": 1712736000000,
        "finish_order_time": null,
        "cancel_reason": null,
        "delivery_type": "manualDelivery",
        "delivery_no": null
      }
    ]
  },
  "success": true,
  "t": 1712736000234
}

响应失败示例

{
  "code": 500,
  "msg": "system error,please contact the admin",
  "success": false,
  "t": 1712736000234
}

查询服务订单详情

接口描述

调用该接口查询服务订单详情

接口地址

GET /v1.0/cloud/osaas/projects/{project_id}/server-order/get

请求参数

参数名	类型	参数类型	说明	是否必需
project_id	String	URI	项目唯一标识	是
order_id	String	BODY	订单ID	是

响应参数

参数名	类型	说明
code	Integer	响应码（详情见错误码章节），成功时为空
success	Boolean	是否成功：（true：成功，false：失败）
msg	String	请求失败的信息，成功时为空
t	Long	返回时间戳，13位
result	Object	返回结果

result参数说明

参数名	类型	说明
space_id	String	房间唯一编码
room_no	String	房间号
order_id	String	订单唯一编码
order_status	String	交易订单状态（created：待处理，canceled：已取消，producing：进行中，finished：已完成）
order_biz_type	String	订单业务类型（MATERIAL：商品订单，SERVICE：服务订单）
second_order_biz_type	String	二级订单业务类型（ROOM_CLEAN：房间清理服务，ROOM_SUPPLEMENT：房间补充用品，ROOM_MAINTENANCE_SERVICE：维修服务类，FOOD_SERVICE：订餐服务类，LANDRY_SERVICE：客房洗衣类，RENEW：客房续住类，CHECK_OUT：客房退房类，CHANGE_ROOM：客房换房类，CHECK_IN：客房入住类，INVOICE：发票）
commodity_list	Arrays	订单商品集合
customer_list	Arrays	客人信息集合
checkin_order_group_id	String	订单组ID
checkin_status	Integer	入住状态（0：待入住，1：已入住，2：已退房，3：换房，4：更新入住人，5：移除入住人，6：取消入住，12：应离未离，-1：无入住状态）
quantity	Integer	商品数量
order_amount	BigDecimal	订单金额
currency	String	货币
order_source	String	订单来源（SMART_SPEAKER：智能音箱，APPLET_WX：微信小程序，APPLET_ALIPAY：支付宝小程序，APPLET_H5：H5页面）
create_order_time	Long	下订单时间，13位时间戳
finish_order_time	Long	完成订单时间，13位时间戳
cancel_order_time	Long	取消订单时间，13位时间戳
cancel_reason	String	取消原因
invoice	Object	发票信息
customer_uid	String	客户uid
delivery_type	String	配送方式（robot：机器人配送，manualDelivery：人工配送）
delivery_no	String	配送单ID

commodity_list参数说明

参数名	类型	说明
id	String	订单商品表主键
commodity_name	String	商品名称
unit_price	BigDecimal	单价
quantity	Integer	商品的数量
order_amount	BigDecimal	订单金额
currency	String	货币
icon_url	String	商品图标

customer_list参数说明

参数名	类型	说明
customer_name	String	住户名称
customer_contact	String	联系方式（手机号或邮箱，手机号需拼上国家码）
check_status	Integer	入住状态（0：待入住，1：已入住，2：已退房，3：换房，4：更新入住人，5：移除入住人，6：取消入住，12：应离未离，-1：无入住状态）

invoice参数说明

参数名	类型	说明
invoice_type	Integer	发票类型（0：普通发票，1：增值税发票）
name	String	名称
tax_no	String	税号
to_email	String	邮箱
address	String	地址
telephone	String	电话
bank_account	String	银行账户
bank	String	开户行

请求示例

GET {url}/v1.0/cloud/osaas/projects/1160823965053******/server-order/get

{
  "order_id": "ORDER20260410******"
}

响应成功示例

{
  "result": {
    "space_id": "1341704857710******",
    "room_no": "8801",
    "order_id": "ORDER20260410******",
    "order_status": "created",
    "order_biz_type": "SERVICE",
    "second_order_biz_type": "ROOM_SUPPLEMENT",
    "commodity_list": [
      {
        "id": "100001",
        "commodity_name": "矿泉水",
        "unit_price": 5.00,
        "quantity": 2,
        "order_amount": 10.00,
        "currency": "CNY",
        "icon_url": "https://example.com/water.png"
      }
    ],
    "customer_list": [
      {
        "customer_name": "张三",
        "customer_contact": "+86-138****0001",
        "check_status": 1
      }
    ],
    "checkin_order_group_id": "GROUP20260410******",
    "checkin_status": 1,
    "quantity": 2,
    "order_amount": 10.00,
    "currency": "CNY",
    "order_source": "APPLET_WX",
    "create_order_time": 1712736000000,
    "finish_order_time": null,
    "cancel_order_time": null,
    "cancel_reason": null,
    "invoice": null,
    "customer_uid": "ay1640******",
    "delivery_type": "manualDelivery",
    "delivery_no": null
  },
  "success": true,
  "t": 1712736000234
}

响应失败示例

{
  "code": 500,
  "msg": "system error,please contact the admin",
  "success": false,
  "t": 1712736000234
}

接受服务订单

接口描述

调用该接口接受服务订单

接口地址

POST /v1.0/cloud/osaas/projects/{project_id}/server-order/producing

请求参数

参数名	类型	参数类型	说明	是否必需
project_id	String	URI	项目唯一标识	是
order_id	String	BODY	订单ID	是
delivery_type	String	BODY	配送方式（robot：机器人配送，manualDelivery：人工配送）	是
put_space_id	String	BODY	机器人投物点	否
need_verify_code	Boolean	BODY	是否需要投物验证码	否

响应参数

参数名	类型	说明
code	Integer	响应码（详情见错误码章节），成功时为空
success	Boolean	是否成功：（true：成功，false：失败）
msg	String	请求失败的信息，成功时为空
t	Long	返回时间戳，13位
result	Boolean	返回结果

请求示例

POST {url}/v1.0/cloud/osaas/projects/1160823965053******/server-order/producing

{
  "order_id": "ORDER20260410******",
  "delivery_type": "manualDelivery"
}

响应成功示例

{
  "success": true,
  "result": true,
  "t": 1712736000234
}

响应失败示例

{
  "code": 500,
  "msg": "system error,please contact the admin",
  "success": false,
  "t": 1712736000234
}

完成服务订单

接口描述

调用该接口完成服务订单

接口地址

POST /v1.0/cloud/osaas/projects/{project_id}/server-order/finished

请求参数

参数名	类型	参数类型	说明	是否必需
project_id	String	URI	项目唯一标识	是
order_id	String	BODY	订单ID	是

响应参数

参数名	类型	说明
code	Integer	响应码（详情见错误码章节），成功时为空
success	Boolean	是否成功：（true：成功，false：失败）
msg	String	请求失败的信息，成功时为空
t	Long	返回时间戳，13位
result	Boolean	返回结果

请求示例

POST {url}/v1.0/cloud/osaas/projects/1160823965053******/server-order/finished

{
  "order_id": "ORDER20260410******"
}

响应成功示例

{
  "success": true,
  "result": true,
  "t": 1712736000234
}

响应失败示例

{
  "code": 500,
  "msg": "system error,please contact the admin",
  "success": false,
  "t": 1712736000234
}

取消服务订单

接口描述

调用该接口取消服务订单

接口地址

POST /v1.0/cloud/osaas/projects/{project_id}/server-order/cancel

请求参数

参数名	类型	参数类型	说明	是否必需
project_id	String	URI	项目唯一标识	是
order_id	String	BODY	订单ID	是
reason	String	BODY	取消原因	否

响应参数

参数名	类型	说明
code	Integer	响应码（详情见错误码章节），成功时为空
success	Boolean	是否成功：（true：成功，false：失败）
msg	String	请求失败的信息，成功时为空
t	Long	返回时间戳，13位
result	Boolean	返回结果

请求示例

POST {url}/v1.0/cloud/osaas/projects/1160823965053******/server-order/cancel

{
  "order_id": "ORDER20260410******",
  "reason": "客人取消需求"
}

响应成功示例

{
  "success": true,
  "result": true,
  "t": 1712736000234
}

响应失败示例

{
  "code": 500,
  "msg": "system error,please contact the admin",
  "success": false,
  "t": 1712736000234
}

错误码

以下为该接口常见的业务异常，更多的异常错误，请参见全局错误码。

错误码	说明
500	系统错误