查询模型订单基本信息
接口说明:
- 根据房源 id、模型 id 或订单 id 查询订单的基本信息(状态、名称、创建人、所属人等)
- 只能查询当前鉴权身份所属公司的订单,范围外一律返回
10004
- 已取消、已作废的订单同样可以查到,不做状态过滤
- 一个房源 id 或模型 id 可能对应多个订单,因此
data 恒为列表
请求路径:
{HostName}/api/v2/op/openapi/model_order/info/?hid={hid}&nest_id={nest_id}&order_id={order_id}
请求方式:
{
"Authorization": "gAAAAABhG3g4Fd2NiMHocf8r-PVZCp1Xku3Rn1brr5wMPQNqkpqV8HrvZDfeYtdGdQrN_eTWaRvr1V5lPMda_kLaJvuYOyUruVWZJ6EH84WWu7sK51zxZibSUO4Huhzv9lGeDQg9ITeZ88JXg1ddG-kRdXIY7Qkic6XSXFXpA4lPNUtLB-pkEOM="
}
传入参数字段及含义
可根据 hid 或者 nest_id 或者 order_id 进行查询,三者必传其一
查询优先级: hid > nest_id > order_id
建议只传其中1个查询参数进行查询,3个参数同时传入时,只有1个参数生效
若传入 hid,则根据 hid 进行查询;否则:若传入 nest_id,则根据 nest_id 进行查询;否则:根据 order_id 进行查询
| 字段名 |
类型 |
是否必传 |
含义 |
| hid |
string |
联合必传 |
房源 id |
| nest_id |
string |
联合必传 |
模型 id |
| order_id |
int |
联合必传 |
订单 id,须为整数 |
响应参数示例
{
"msg": "success",
"code": 1,
"data": [
{
"order_id": 123456,
"nest_id": "f945182c_1gdX_b6f9",
"hid": "He2023060901",
"name": "望京西园四区 3室1厅",
"order_status": 3,
"order_code": "DD20230609084325",
"creator": 51714,
"create_user": "中介公司测试A",
"personal": 51714,
"person": "中介公司测试A",
"create_date": "2023-06-09 16:43:25"
}
]
}
响应参数字段及含义:
| 字段名 |
类型 |
是否必传 |
含义 |
| msg |
string |
是 |
响应状态描述 |
| code |
int |
是 |
响应状态码 |
| data |
list |
是 |
订单基本信息列表 |
data列表中的响应参数字段及含义:
| 字段名 |
类型 |
是否必传 |
含义 |
| order_id |
int |
是 |
订单 id |
| nest_id |
string |
是 |
模型 id |
| hid |
string |
是 |
房源 id |
| name |
string |
是 |
房源名称 |
| order_status |
int |
是 |
订单状态【编码对应关系见下方说明】 |
| order_code |
string |
是 |
订单编号 |
| creator |
int/null |
是 |
创建人 id |
| create_user |
string |
是 |
创建人姓名 |
| personal |
int/null |
是 |
订单所属人 id |
| person |
string |
是 |
订单所属人姓名 |
| create_date |
string |
是 |
订单创建时间,格式 YYYY-MM-DD HH:mm:ss |
字段编码对应的具体含义
order_status = {
0: "未知状态(订单处于尚未对外开放的中间态,正常不会出现)",
1: "待拍摄",
2: "拍摄完成,待制作",
3: "制作完成 待编辑",
5: "已下线(模型不再能访问)",
6: "已上线(模型能再次访问)",
7: "订单已取消",
8: "订单已作废"
}
注意:
data 恒为列表。一个 hid 或 nest_id 可能对应多个订单,返回时按订单 id 倒序排列
- 三个查询维度都未命中任何订单时,返回
10004,data 为空列表
- 订单不存在与订单不属于贵方公司,返回完全相同的
10004 与提示文案,不作区分
- 本接口不过滤订单状态,已取消、已作废的订单同样返回;这与
获取模型制作状态按 hid / nest_id 查询时会排除
取消、作废订单的行为不同
- 本接口的
order_status 与获取模型订单列表的
order_status 取值口径完全一致;与获取模型制作状态
的 status 口径不同,同一订单在两个接口可能返回不同的值,请勿混用。
已知差异:本接口返回 1 / 6 / 7 的部分订单,在制作状态接口分别返回 4 / 3 / 8
personal / person 为订单级所属人,为空时回落为订单创建人;
获取模型订单列表的同名字段取的是模型级所属人,
同一订单两个接口可能返回不同的人,请以本接口为准判断订单归属
create_date 为北京时间(UTC+8),与查询账号基本信息
的时间格式一致;与获取模型订单列表的 UTC 格式不同
- 字符串类型字段无值时返回空字符串
"",不返回 null
消息码code取值及说明:
| code值 |
说明 |
| 1 |
成功 |
| 10004 |
订单不存在,或不属于当前鉴权身份所属公司 |
| 31000 |
不支持当前请求的版本 |
| 32000 |
签名校验失败 |
| 33000 |
参数校验失败(order_id 不是整数) |
| 33001 |
缺少必要的参数(hid、nest_id、order_id 三者均未传) |
| 34000 |
接口调用次数超出限制 |