# generated: '2026-09-05'
# method: derived
# source: https://devapi.3vjia.com/document/getNewApiDocument (3vjia Open Platform documentation API)
openapi: 3.1.0
info:
title: 3vjia Open Platform API
version: '2026-09-05'
summary: Home-furnishing 3D cloud design, quotation, order, manufacturing (AIMES/MOS/DMS) and AI operations exposed by the 3vjia (三维家) Open Platform.
description: |-
Machine-readable description of the 3vjia (三维家 / AiHouse) Open Platform, DERIVED — not published by the provider in this form.
Every path, HTTP method, parameter name, type, required flag, description and example in this document was read verbatim from 3vjia's own public documentation API (https://devapi.3vjia.com/document/getNewApiDocument?apiId=..., the JSON service that renders https://dev.3vjia.com/v1/document). Nothing here was invented: no operation, host or field was added that the provider does not document. Operations carry x-source-documentation pointing at the provider page each was read from.
Authentication is OAuth 2.0 client_credentials against https://graph.3vjia.com/oauth/token (grant_type=client_credentials, client_id=appId, client_secret=appKey), returning an access_token valid for 7200 seconds. The legacy gateway (https://open.3vjia.com) takes the token as ?sysCode=external&access_token=; the current gateway is https://open-gateway.3vjia.com. Every documented operation is POST with Content-Type application/json;charset=utf-8 and returns the envelope {success, code, msg, data}.
Source of truth remains the provider documentation at https://dev.3vjia.com/ — file corrections at https://github.com/api-evangelist/3vjia-technology.
contact:
name: 3vjia Open Platform
url: https://dev.3vjia.com/
externalDocs:
description: 3vjia Open Platform documentation (三维家开放平台)
url: https://dev.3vjia.com/v1/document
x-generated-from: https://devapi.3vjia.com/document/getNewApiDocumentCategoryList + /document/getNewApiDocument (first-party documentation API)
x-generated-on: '2026-09-05'
x-generated-by: API Evangelist enrichment pipeline (local-v3) — mechanical transform of provider documentation records; no operation invented
x-operation-count: 429
x-documented-record-count: 430
x-note: 430 documentation records were harvested; two describe the same POST /api/v1/dms/order/createProduceOrder, so 429 unique operations are emitted.
servers:
- url: https://open-gateway.3vjia.com
description: 3vjia Open Platform gateway (current)
- url: https://open.3vjia.com
description: Legacy open gateway — takes ?sysCode=external&access_token=
security:
- oauth2ClientCredentials: []
tags:
- name: Authorization
description: 登录授权
- name: Accounts
description: 账号模块
- name: Products
description: 产品模块
- name: Design Schemes
description: 方案模块
- name: Quotation
description: 报价模块
- name: MOS
description: MOS系统
- name: AIMES
description: AIMES系统
- name: DMS
description: DMS系统
- name: 3vjia AI
description: 三维家AI
- name: Floor Plans
description: 楼盘户型
- name: 3D Show
description: 3D秀
- name: Dreamer
description: 梦想家
- name: Dedicated Services
description: 专属服务
- name: Common Services
description: 通用服务
- name: Xuanchi AI
description: 玄尺AI
- name: Light Design
description: 轻设计
- name: CAD
description: CAD模块
- name: Chuangdian
description: 创点系统
- name: Asset Management
description: 资产管理
components:
securitySchemes:
oauth2ClientCredentials:
type: oauth2
description: OAuth 2.0 client credentials. appId/appKey are issued after developer + application approval at https://dev.3vjia.com/manage/my-app/developer. Token TTL 7200s; re-requesting invalidates the previous token.
flows:
clientCredentials:
tokenUrl: https://graph.3vjia.com/oauth/token
scopes: {}
paths:
/api/AfterOrderOp/getAfterAaleOrderById:
post:
operationId: apiAfterOrderOpGetAfterAaleOrderById
summary: 通过售后子订单ID获取售后单信息
tags:
- AIMES
x-source-documentation: https://dev.3vjia.com/document?apiId=646398030987284576
x-documentation-category: AIMES系统 / 订单数据 / 工厂单
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
id:
type: integer
format: int64
description: 售后子单ID
example:
id: 0
responses:
'200':
description: 成功 / OK
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
description: 请求是否成功 / whether the call succeeded
code:
type: integer
description: 结果码 / result code (0 = success)
msg:
type: string
description: 提示信息 / message
data:
type: object
properties:
addProportion:
type: string
description: 加收比例
aftersaleMainOrderCode:
type: string
description: 售后主单编码
aftersaleMainOrderId:
type: integer
format: int64
description: 售后主单id
aftersaleMainOrderName:
type: string
description: 售后主单名称
aftersaleMainStatusCode:
type: string
description: 售后主单状态编码
aftersaleMainStatusName:
type: string
description: 售后主单状态名称
auditCreatorId:
type: string
description: 审核人
auditCreatorName:
type: string
description: 审核人名称
auditRemark:
type: string
description: 审核备注
auditStatusCode:
type: string
description: 审核订单状态编码
auditStatusName:
type: string
description: 审核订单状态名称
auditTime:
type: string
format: date-time
description: 审核时间
basicMaterial:
type: string
description: 主颜色
companyCost:
type: number
format: bigdecimal
description: 公司分摊费用
createTime:
type: string
format: date-time
description: 创建时间
creatorName:
type: string
description: 创建订单人姓名
creatorPhone:
type: string
description: 创建订单人电话
customOrderNo:
type: string
description: 自定义单号
customerAddress:
type: string
description: 客户地址街道
customerId:
type: string
description: 客户ID
customerName:
type: string
description: 客户姓名
customerPhone:
type: string
description: 客户电话
deliveryDate:
type: string
format: date
description: 预交货时间
deptId:
type: string
description: 创建人部门ID
designerId:
type: string
description: 设计师id
designerName:
type: string
description: 设计师名称
designerPhone:
type: string
description: 设计师手机号码
determineCause:
type: string
description: 判断原因说明
determineDictKey:
type: string
description: 判定原因字典key
determineDictVal:
type: string
description: 判定原因字段val
doorWindowType:
type: integer
format: int32
description: 整木类型
externalContractId:
type: string
description: 外部合同ID
factoryCost:
type: number
format: bigdecimal
description: 工厂分摊费用
factoryOrderCode:
type: string
description: 工厂订单编号
factoryOrderId:
type: integer
format: int64
description: 工厂订单id
id:
type: integer
format: int64
description: 主键id
isOrderMakeup:
type: integer
format: int32
description: 是否原订单补做
isProportion:
type: integer
format: int32
description: 是否按比例
isSelfFunded:
type: integer
format: int32
description: 是否自费
logisticsCost:
type: number
format: bigdecimal
description: 物流分摊费用
mainShopOrderCode:
type: string
description: 主单产生的销售订单编码
mainShopOrderId:
type: integer
format: int64
description: 主单产生的销售订单id
material:
type: string
description: 主材质
modifierName:
type: string
description: 更新人用户名
moduleCode:
type: string
description: 模块代码
moduleName:
type: string
description: 模块名称
orderCode:
type: string
description: 售后订单编号
orderName:
type: string
description: 订单名称
orderTypeDictKey:
type: string
description: 售后订单类型字典Key
orderTypeDictVal:
type: string
description: 售后订单类型字典Value
organDealerName:
type: string
description: 企业经销商名称
organId:
type: string
description: 机构ID
originSchemeContent:
type: string
description: 原始方案
partCount:
type: integer
format: int32
description: 部件数量
priceUrl:
type: string
description: 价格明细url
productionBomXml:
type: string
description: 生产XMLurl
proportion:
type: integer
format: int32
description: 金额比例
reasonDescribe:
type: string
description: 售后原因描述
reasonDictKey:
type: string
description: 售后原因字典Key
reasonDictVal:
type: string
description: 售后原因字典Value
receiverAddress:
type: string
description: 收货人地址街道
receiverName:
type: string
description: 收货人姓名
receiverPhone:
type: string
description: 收货人电话
receiverType:
type: string
description: 收货人类型 customer=业主 shop=门店
relatedOrderCode:
type: string
description: 原工厂单号
relatedOrderId:
type: integer
format: int64
description: 原工厂订单ID
relatedOrderName:
type: string
description: 原工厂订单名称
relatedOrderTypeDictKey:
type: string
description: 关联订单类型
remark:
type: string
description: 订单备注
responsibilityDictKey:
type: string
description: 责任方字典key
responsibilityDictVal:
type: string
description: 责任方字典val
schemeContent:
type: string
description: 方案
schemeId:
type: string
description: 方案Id
shopCost:
type: number
format: bigdecimal
description: 门店分摊费用
shopId:
type: string
description: 经销商ID
shopName:
type: string
description: 经销商名称
shopOrderCode:
type: string
description: 原销售订单编码
shopOrderId:
type: integer
format: int64
description: 源销售订单id
statusCode:
type: string
description: 订单状态编码
statusName:
type: string
description: 订单状态名称
submitName:
type: string
description: 订单提交人用户姓名
submitTime:
type: string
format: date-time
description: 订单提交到工厂的时间
submitUserId:
type: string
description: 订单提交人用户ID
totalAmount:
type: number
format: bigdecimal
description: 订单出货总价
urlParam:
type: string
description: 外部参数
required:
- id
example:
msg: ''
code: 0
data:
shopCost: 0
auditStatusCode: ''
moduleName: ''
productionBomXml: ''
aftersaleMainStatusName: ''
auditCreatorName: ''
logisticsCost: 0
basicMaterial: ''
urlParam: ''
receiverPhone: ''
addProportion: ''
reasonDictKey: ''
aftersaleMainOrderId: 0
id: 0
shopId: ''
auditStatusName: ''
customerAddress: ''
designerId: ''
responsibilityDictVal: ''
designerPhone: ''
mainShopOrderCode: ''
deptId: ''
orderTypeDictVal: ''
determineDictVal: ''
isProportion: 0
aftersaleMainOrderName: ''
customerName: ''
submitUserId: ''
aftersaleMainStatusCode: ''
receiverAddress: ''
relatedOrderName: ''
totalAmount: 0
relatedOrderTypeDictKey: ''
determineCause: ''
submitTime: ''
isOrderMakeup: 0
shopOrderId: 0
auditTime: ''
receiverType: ''
organId: ''
doorWindowType: 0
priceUrl: ''
statusCode: ''
companyCost: 0
externalContractId: ''
factoryOrderId: 0
mainShopOrderId: 0
partCount: 0
proportion: 0
creatorName: ''
auditCreatorId: ''
relatedOrderCode: ''
shopName: ''
remark: ''
schemeId: ''
creatorPhone: ''
relatedOrderId: 0
schemeContent: ''
customOrderNo: ''
aftersaleMainOrderCode: ''
customerPhone: ''
customerId: ''
reasonDictVal: ''
statusName: ''
organDealerName: ''
deliveryDate: ''
orderName: ''
factoryCost: 0
isSelfFunded: 0
shopOrderCode: ''
moduleCode: ''
reasonDescribe: ''
determineDictKey: ''
responsibilityDictKey: ''
receiverName: ''
auditRemark: ''
orderTypeDictKey: ''
designerName: ''
submitName: ''
material: ''
createTime: ''
originSchemeContent: ''
orderCode: ''
modifierName: ''
factoryOrderCode: ''
success: false
'401':
description: access_token 缺失或已过期 / missing or expired access_token
/api/V1/building/getProvinceAndCityList:
post:
operationId: apiV1BuildingGetProvinceAndCityList
summary: 获取全国城市名称和编码列表
tags:
- Floor Plans
x-source-documentation: https://dev.3vjia.com/document?apiId=456509490821398562
x-documentation-category: 楼盘户型
responses:
'200':
description: 成功 / OK
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
description: 请求是否成功 / whether the call succeeded
code:
type: integer
description: 结果码 / result code (0 = success)
msg:
type: string
description: 提示信息 / message
data:
type: object
properties:
cityList:
type: array
items:
type: object
properties:
code:
type: string
description: 城市代码
name:
type: string
description: 省份名称
description: 下属城市列表
code:
type: string
description: 省份代码
name:
type: string
description: 省份名称
example:
msg: ''
code: ''
data:
- code: ''
cityList:
- code: ''
name: ''
name: ''
success: false
'401':
description: access_token 缺失或已过期 / missing or expired access_token
/api/aiDrawImageResult/listByPage:
post:
operationId: apiAiDrawImageResultListByPage
summary: 分页查询AI出图结果
tags:
- Light Design
x-source-documentation: https://dev.3vjia.com/document?apiId=832299125029617719
x-documentation-category: 轻设计
description: 分页查询AI出图结果
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
createDateEnd:
type: string
description: 创建时间结束日期
createDateStart:
type: string
description: 创建时间开始日期
createUser:
type: string
description: 创建人ID
drawImageId:
type: string
description: 绘图任务ID
ids:
type: array
items: {}
description: "This is List Type \nID"
imageResult:
type: string
description: 图片结果url
isDelete:
type: integer
format: int32
description: 删除1是0否
layoutId:
type: string
description: 户型ID
layoutSchemeId:
type: string
description: 方案ID
orderBy:
type: string
description: 排序
pageIndex:
type: integer
format: int32
description: 页码
pageSize:
type: integer
format: int32
description: 页容量
roomId:
type: string
description: 房间ID
roomName:
type: string
description: 房间名称
updateDateEnd:
type: string
description: 更新时间结束日期
updateDateStart:
type: string
description: 更新时间开始日期
updateUser:
type: string
description: 更新人ID
aiModel:
type: integer
format: int32
description: 出图模式0效果图1全景
layoutName:
type: string
description: 方案名称
viewAngleName:
type: string
description: 视角名称
example:
drawImageId: ''
layoutSchemeId: ''
isDelete: 0
orderBy: ''
pageSize: 0
updateUser: ''
layoutId: ''
roomId: ''
roomName: ''
layoutName: ''
createDateStart: ''
pageIndex: 0
updateDateStart: ''
updateDateEnd: ''
ids: []
imageResult: ''
createUser: ''
aiModel: 0
viewAngleName: ''
createDateEnd: ''
responses:
'200':
description: 成功 / OK
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
description: 请求是否成功 / whether the call succeeded
code:
type: integer
description: 结果码 / result code (0 = success)
msg:
type: string
description: 提示信息 / message
data:
type: object
properties:
pageIndex:
type: integer
format: int32
pageSize:
type: integer
format: int32
recordCount:
type: integer
format: int32
result:
type: array
items:
type: object
properties:
aiModel:
type: integer
format: int32
description: 0效果图1全景图
createUser:
type: string
description: 创建人
id:
type: string
description: 图片ID
imageResult:
type: string
description: 图片url
layoutId:
type: string
description: 户型ID
layoutSchemeId:
type: string
description: 布局方案ID
roomId:
type: string
description: 房间ID
roomName:
type: string
description: 房间名称
viewAngleName:
type: string
description: 视角名称
createDate:
type: string
description: 创建时间
layoutName:
type: string
description: 布局方案名称
updateDate:
type: string
description: 更新时间
drawImageId:
type: string
description: 绘图任务ID
description: AI出图结果类
example:
msg: ''
code: 0
data:
recordCount: 0
pageSize: 0
result:
- drawImageId: ''
updateDate: ''
layoutSchemeId: ''
layoutId: ''
roomId: ''
roomName: ''
layoutName: ''
imageResult: ''
createUser: ''
aiModel: 0
id: ''
viewAngleName: ''
createDate: ''
pageIndex: 0
success: false
'401':
description: access_token 缺失或已过期 / missing or expired access_token
/api/building/roommodel/v1/predict:
post:
operationId: apiBuildingRoommodelV1Predict
summary: 识别户型
tags:
- Dedicated Services
x-source-documentation: https://dev.3vjia.com/document?apiId=713058818141077606
x-documentation-category: 专属服务 / C11476529
description: 识别户型
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
base64String:
type: string
description: base64加密串
extendName:
type: string
description: 图片扩展名称
imageMd5:
type: string
description: 图片md5
scale:
type: string
description: 比列尺
type:
type: string
description: AI生成户型的类型,例如:undoor 不要门
required:
- base64String
- extendName
- imageMd5
- scale
example:
imageMd5: ''
extendName: ''
base64String: ''
scale: ''
type: ''
responses:
'200':
description: 成功 / OK
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
description: 请求是否成功 / whether the call succeeded
code:
type: integer
description: 结果码 / result code (0 = success)
msg:
type: string
description: 提示信息 / message
data:
type: object
properties:
content:
type: string
description: xml内容
isSuccess:
type: boolean
description: 成功或失败状态
example:
msg: ''
code: 0
data:
content: ''
isSuccess: false
success: false
'401':
description: access_token 缺失或已过期 / missing or expired access_token
/api/building/roommodel/v1/scale/point:
post:
operationId: apiBuildingRoommodelV1ScalePoint
summary: 获取比例尺坐标信息
tags:
- Dedicated Services
x-source-documentation: https://dev.3vjia.com/document?apiId=713058818141077585
x-documentation-category: 专属服务 / C11476529
description: 获取比例尺坐标信息
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
base64String:
type: string
description: base64加密串
required:
- base64String
example:
base64String: ''
responses:
'200':
description: 成功 / OK
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
description: 请求是否成功 / whether the call succeeded
code:
type: integer
description: 结果码 / result code (0 = success)
msg:
type: string
description: 提示信息 / message
data:
type: object
properties:
content:
type: string
description: json字符串
isSuccess:
type: boolean
description: 成功或失败状态
example:
msg: ''
code: 0
data:
content: ''
isSuccess: false
success: false
'401':
description: access_token 缺失或已过期 / missing or expired access_token
/api/calculation/quote_solution/sync_sale_price:
post:
operationId: apiCalculationQuotesolutionSyncsaleprice
summary: 价格信息同步
tags:
- Dedicated Services
x-source-documentation: https://dev.3vjia.com/document?apiId=791618173400137763
x-documentation-category: 专属服务 / C00005461
description: 价格信息同步
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
salePrice:
type: object
properties:
isSyncSuccess:
type: integer
format: int32
description: 是否同步完成
salePriceId:
type: integer
format: int32
description: 销售方案id
endDate:
type: string
format: date-time
description: 有效期结束时间
remark:
type: string
description: 备注
salePriceName:
type: string
description: 销售方案名称
saleVersion:
type: integer
format: int32
description: 销售版本
startDate:
type: string
format: date-time
description: 有效期起始时间
startSyncDateTime:
type: string
format: date-time
description: 开始同步时间
salePriceDetail:
type: array
items:
type: object
properties:
isSyncSuccess:
type: integer
format: int32
description: 是否同步完成
saleCode:
type: string
description: 品号
saleName:
type: string
description: 品名
salePrice:
type: number
format: bigdecimal
description: 销售单价
salePriceDetailId:
type: integer
format: int32
description: 销售方案明细ID
salePriceId:
type: integer
format: int32
description: 销售方案id
description: 销售方案明细信息
example:
salePrice:
startSyncDateTime: ''
saleVersion: 0
endDate: ''
remark: ''
salePriceId: 0
isSyncSuccess: 0
salePriceName: ''
startDate: ''
salePriceDetail:
- salePrice: 0
salePriceDetailId: 0
saleCode: ''
salePriceId: 0
isSyncSuccess: 0
saleName: ''
responses:
'200':
description: 成功 / OK
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
description: 请求是否成功 / whether the call succeeded
code:
type: integer
description: 结果码 / result code (0 = success)
msg:
type: string
description: 提示信息 / message
data:
type: object
example:
msg: ''
code: 0
data: false
success: false
'401':
description: access_token 缺失或已过期 / missing or expired access_token
/api/casaprodesign/project/add:
post:
operationId: apiCasaprodesignProjectAdd
summary: 添加项目
tags:
- Dedicated Services
x-source-documentation: https://dev.3vjia.com/document?apiId=769625759609405570
x-documentation-category: 专属服务 / C12684110
description: 添加项目
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
address:
type: string
description: 地址
externalUserId:
type: string
description: 外部用户ID
name:
type: string
description: 项目名称
organId:
type: string
description: 组织ID
projectId:
type: string
description: 外部项目ID
userId:
type: integer
format: int64
description: 用户ID
example:
address: ''
userId: 0
externalUserId: ''
name: ''
organId: ''
projectId: ''
responses:
'200':
description: 成功 / OK
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
description: 请求是否成功 / whether the call succeeded
code:
type: integer
description: 结果码 / result code (0 = success)
msg:
type: string
description: 提示信息 / message
data:
type: object
example:
msg: ''
code: 0
data: 0
success: false
'401':
description: access_token 缺失或已过期 / missing or expired access_token
/api/casaprodesign/project/getByProjectId:
post:
operationId: apiCasaprodesignProjectGetByProjectId
summary: 根据主键查询项目信息
tags:
- Dedicated Services
x-source-documentation: https://dev.3vjia.com/document?apiId=769625759609405589
x-documentation-category: 专属服务 / C12684110
description: 根据主键查询项目信息
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
id:
type: string
required:
- id
example:
id: ''
responses:
'200':
description: 成功 / OK
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
description: 请求是否成功 / whether the call succeeded
code:
type: integer
description: 结果码 / result code (0 = success)
msg:
type: string
description: 提示信息 / message
data:
type: object
properties:
address:
type: string
description: 地址
createTime:
type: string
format: date-time
description: 创建时间
creatorId:
type: string
description: 创建人标识
id:
type: integer
format: int64
description: 唯一主键
modifierId:
type: string
description: 修改人标识
modifyTime:
type: string
format: date-time
description: 修改时间
name:
type: string
description: 项目名称
organId:
type: string
description: 组织ID
projectId:
type: string
description: 外部项目ID
schemeCount:
type: integer
format: int32
description: 方案数
schemeList:
type: array
items:
type: object
properties:
budget:
type: number
format: bigdecimal
description: 预算
createTime:
type: string
format: date-time
description: 创建时间
creatorId:
type: string
description: 创建人标识
floor:
type: string
description: 楼层
id:
type: integer
format: int64
description: 唯一主键
json:
type: string
description: 方案JSON数据
jsonEstimate:
type: string
description: 方案报价用量数据
modifierId:
type: string
description: 修改人标识
modifyTime:
type: string
format: date-time
description: 修改时间
previewImgVec2:
type: string
description: 2D预览图
previewImgVec3:
type: string
description: 3D预览图
projectId:
type: integer
format: int64
description: 项目ID
roomList:
type: array
items:
type: object
properties:
createTime:
type: string
format: date-time
description: 创建时间
creatorId:
type: string
description: 创建人标识
id:
type: integer
format: int64
description: 唯一主键
img:
type: string
description: 预览图
modifierId:
type: string
description: 修改人标识
modifyTime:
type: string
format: date-time
description: 修改时间
name:
type: string
description: 空间名称
schemeId:
type: integer
format: int64
description: 方案ID
description: 方案空间查询结果
style:
type: string
description: 风格套系
description: 方案查询结果
userId:
type: integer
format: int64
description: 用户ID
example:
msg: ''
code: 0
data:
schemeCount: 0
address: ''
creatorId: ''
modifierId: ''
userId: 0
modifyTime: ''
schemeList:
- jsonEstimate: ''
creatorId: ''
modifierId: ''
previewImgVec2: ''
previewImgVec3: ''
modifyTime: ''
createTime: ''
json: ''
style: ''
id: 0
floor: ''
projectId: 0
roomList:
- img: ''
creatorId: ''
modifierId: ''
schemeId: 0
modifyTime: ''
createTime: ''
name: ''
id: 0
budget: 0
createTime: ''
name: ''
organId: ''
id: 0
projectId: ''
success: false
'401':
description: access_token 缺失或已过期 / missing or expired access_token
/api/casaprodesign/project/listByExternalUserId:
post:
operationId: apiCasaprodesignProjectListByExternalUserId
summary: 根据外部用户id查询项目
tags:
- Dedicated Services
x-source-documentation: https://dev.3vjia.com/document?apiId=769626514634461221
x-documentation-category: 专属服务 / C12684110
description: 根据外部用户id查询项目
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
address:
type: string
description: 地址
address_lLike:
type: string
description: 地址左模糊
address_like:
type: string
description: 地址全模糊
address_rLike:
type: string
description: 地址右模糊
createTime_ge:
type: string
format: date-time
description: 创建时间开始
createTime_le:
type: string
format: date-time
description: 创建时间结束
externalUserId:
type: string
description: 外部用户ID
id:
type: integer
format: int64
description: 唯一主键
id_in:
type: array
items: {}
description: 唯一主键列表
modifyTime_ge:
type: string
format: date-time
description: 修改时间开始
modifyTime_le:
type: string
format: date-time
description: 修改时间结束
name:
type: string
description: 项目名称
name_lLike:
type: string
description: 项目名称左模糊
name_like:
type: string
description: 项目名称全模糊
name_rLike:
type: string
description: 项目名称右模糊
organId:
type: string
description: 组织ID
organId_in:
type: array
items: {}
description: 组织ID列表
projectId:
type: string
description: 外部项目ID
projectId_in:
type: array
items: {}
description: 外部项目ID列表
userId:
type: integer
format: int64
description: 用户ID
userId_in:
type: array
items: {}
description: 用户ID列表
example:
userId_in: []
address_lLike: ''
createTime_ge: ''
address: ''
modifyTime_ge: ''
name_lLike: ''
name_like: ''
name_rLike: ''
userId: 0
modifyTime_le: ''
address_rLike: ''
projectId_in: []
externalUserId: ''
organId_in: []
name: ''
createTime_le: ''
organId: ''
id: 0
projectId: ''
address_like: ''
id_in: []
responses:
'200':
description: 成功 / OK
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
description: 请求是否成功 / whether the call succeeded
code:
type: integer
description: 结果码 / result code (0 = success)
msg:
type: string
description: 提示信息 / message
data:
type: object
properties:
address:
type: string
description: 地址
createTime:
type: string
format: date-time
description: 创建时间
creatorId:
type: string
description: 创建人标识
id:
type: integer
format: int64
description: 唯一主键
modifierId:
type: string
description: 修改人标识
modifyTime:
type: string
format: date-time
description: 修改时间
name:
type: string
description: 项目名称
organId:
type: string
description: 组织ID
projectId:
type: string
description: 外部项目ID
schemeCount:
type: integer
format: int32
description: 方案数
schemeList:
type: array
items:
type: object
properties:
budget:
type: number
format: bigdecimal
description: 预算
createTime:
type: string
format: date-time
description: 创建时间
creatorId:
type: string
description: 创建人标识
floor:
type: string
description: 楼层
id:
type: integer
format: int64
description: 唯一主键
json:
type: string
description: 方案JSON数据
jsonEstimate:
type: string
description: 方案报价用量数据
modifierId:
type: string
description: 修改人标识
modifyTime:
type: string
format: date-time
description: 修改时间
previewImgVec2:
type: string
description: 2D预览图
previewImgVec3:
type: string
description: 3D预览图
projectId:
type: integer
format: int64
description: 项目ID
roomList:
type: array
items:
type: object
properties:
createTime:
type: string
format: date-time
description: 创建时间
creatorId:
type: string
description: 创建人标识
id:
type: integer
format: int64
description: 唯一主键
img:
type: string
description: 预览图
modifierId:
type: string
description: 修改人标识
modifyTime:
type: string
format: date-time
description: 修改时间
name:
type: string
description: 空间名称
schemeId:
type: integer
format: int64
description: 方案ID
description: 方案空间查询结果
style:
type: string
description: 风格套系
description: 方案查询结果
userId:
type: integer
format: int64
description: 用户ID
example:
msg: ''
code: 0
data:
- schemeCount: 0
address: ''
creatorId: ''
modifierId: ''
userId: 0
modifyTime: ''
schemeList:
- jsonEstimate: ''
creatorId: ''
modifierId: ''
previewImgVec2: ''
previewImgVec3: ''
modifyTime: ''
createTime: ''
json: ''
style: ''
id: 0
floor: ''
projectId: 0
roomList:
- img: ''
creatorId: ''
modifierId: ''
schemeId: 0
modifyTime: ''
createTime: ''
name: ''
id: 0
budget: 0
createTime: ''
name: ''
organId: ''
id: 0
projectId: ''
success: false
'401':
description: access_token 缺失或已过期 / missing or expired access_token
/api/casaprodesign/project/removeByProjectIds:
post:
operationId: apiCasaprodesignProjectRemoveByProjectIds
summary: 删除项目
tags:
- Dedicated Services
x-source-documentation: https://dev.3vjia.com/document?apiId=769626514634461240
x-documentation-category: 专属服务 / C12684110
description: 删除项目
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
ids:
type: array
items: {}
example:
ids: []
responses:
'200':
description: 成功 / OK
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
description: 请求是否成功 / whether the call succeeded
code:
type: integer
description: 结果码 / result code (0 = success)
msg:
type: string
description: 提示信息 / message
data:
type: object
example:
msg: ''
code: 0
success: false
'401':
description: access_token 缺失或已过期 / missing or expired access_token
/api/casaprodesign/project/update:
post:
operationId: apiCasaprodesignProjectUpdate
summary: 修改项目
tags:
- Dedicated Services
x-source-documentation: https://dev.3vjia.com/document?apiId=769626514634461242
x-documentation-category: 专属服务 / C12684110
description: 修改项目
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
address:
type: string
description: 地址
externalUserId:
type: string
description: 外部用户ID
id:
type: integer
format: int64
description: 唯一主键
name:
type: string
description: 项目名称
organId:
type: string
description: 组织ID
projectId:
type: string
description: 外部项目ID
userId:
type: integer
format: int64
description: 用户ID
example:
address: ''
userId: 0
externalUserId: ''
name: ''
organId: ''
id: 0
projectId: ''
responses:
'200':
description: 成功 / OK
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
description: 请求是否成功 / whether the call succeeded
code:
type: integer
description: 结果码 / result code (0 = success)
msg:
type: string
description: 提示信息 / message
data:
type: object
example:
msg: ''
code: 0
success: false
'401':
description: access_token 缺失或已过期 / missing or expired access_token
/api/casaprodesign/user/getToken:
post:
operationId: apiCasaprodesignUserGetToken
summary: 获取token
tags:
- Dedicated Services
x-source-documentation: https://dev.3vjia.com/document?apiId=765885111592964194
x-documentation-category: 专属服务 / C12684110
description: 获取token
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
externalUserId:
type: string
description: 外部用户ID
required:
- externalUserId
example:
externalUserId: ''
responses:
'200':
description: 成功 / OK
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
description: 请求是否成功 / whether the call succeeded
code:
type: integer
description: 结果码 / result code (0 = success)
msg:
type: string
description: 提示信息 / message
data:
type: object
example:
msg: ''
code: 0
data: ''
success: false
'401':
description: access_token 缺失或已过期 / missing or expired access_token
/api/casaprodesign/user/register:
post:
operationId: apiCasaprodesignUserRegister
summary: 注册用户
tags:
- Dedicated Services
x-source-documentation: https://dev.3vjia.com/document?apiId=765885111592964192
x-documentation-category: 专属服务 / C12684110
description: 注册用户
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
channelCode:
type: string
description: 渠道编码
companyId:
type: integer
format: int32
country:
type: string
description: 国家
currentPageUrl:
type: string
description: 当前页面地址
email:
type: string
description: 邮箱
externalUserId:
type: string
description: 外部用户ID
gclid:
type: string
hasResend:
type: string
industry:
type: string
description: 行业
ivtCode:
type: string
description: 注册邀请码
mobile:
type: string
description: 手机
nickName:
type: string
description: 昵称
oauth2LoginCode:
type: string
description: oauth2授权登录code
openId:
type: string
organId:
type: string
description: 组织ID
owner:
type: string
description: 注册用户所有者
ownerCode:
type: string
password:
type: string
description: 密码
prevPageUrl:
type: string
description: 前一个页面地址
profession:
type: boolean
description: 职业
province:
type: string
description: 省份
regionCode:
type: string
description: 地区编码
src:
type: string
required:
- country
- email
- externalUserId
- organId
example:
owner: ''
profession: false
country: ''
oauth2LoginCode: ''
ownerCode: ''
src: ''
nickName: ''
openId: ''
mobile: ''
industry: ''
hasResend: ''
prevPageUrl: ''
currentPageUrl: ''
gclid: ''
companyId: 0
password: ''
regionCode: ''
province: ''
externalUserId: ''
ivtCode: ''
organId: ''
email: ''
channelCode: ''
responses:
'200':
description: 成功 / OK
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
description: 请求是否成功 / whether the call succeeded
code:
type: integer
description: 结果码 / result code (0 = success)
msg:
type: string
description: 提示信息 / message
data:
type: object
example:
msg: ''
code: 0
data: false
success: false
'401':
description: access_token 缺失或已过期 / missing or expired access_token
/api/chat/v1/conversation:
post:
operationId: apiChatV1Conversation
summary: 对话
tags:
- Dreamer
x-source-documentation: https://dev.3vjia.com/document?apiId=752849221425709155
x-documentation-category: 梦想家
description: 对话
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
botId:
type: integer
format: int64
description: 机器人Id
botType:
type: integer
format: int32
description: 机器人类型,0:专家,1:画图师:2:报价师,3:导购助理,5:店长助理,6:经营顾问,7:生产xml检查,8:AI云设计Ask,9:AI云设计Agent,10:轻设计维仔,11:户型识别,12:户型搜索
businessType:
type: integer
format: int32
description: chat来自哪个业务方,0:梦想家,1:3d云设计,99:其他
chatConversationId:
type: integer
format: int64
description: 对话记录id,不传默认创建一个标题为第一次聊天的提示词简介
chatQuestionExt:
type: string
description: 提问扩展信息
conversationId:
type: string
description: 对话id,传id可以保持上下文,否则开启新对话
emptyRoom:
type: integer
format: int32
description: 毛胚图生图 可选参数 是否清除空间杂物,0为否 1为是
imgCount:
type: integer
format: int32
description: 出图数量
lightPrompt:
type: string
description: 家居背景改图plus 可选参数,可增加效果图光照效果,光照语义提示,例如输入 light and shadow
productImgUrl:
type: string
description: 换家具的产品图
prompt:
type: string
description: 提示词,如果闲了图像生成,自动加上 帮我生成图片,风格,空间等都加到提示词中
referenceImgUrl:
type: string
description: 参考图url,旧房改造的期望设计图,家具背景替换背景涂抹图,家具替换的涂抹图,全屋换材质图,线框图生图的风格参考图,换涂料的涂料图片,添加产品的产品图,换砖的瓷砖的图片,换门板的门板图,换台面的台面图
similar:
type: integer
format: int32
description: 指定风格改图的相似度,0:低,1:中,2:高
sourceImgUrl:
type: string
description: 原图url,毛坯全屋设计毛坯房图,旧房全屋改造旧房图,家具背景替换原图,家具替换原场景图,全屋换材质原场景图,线框图生图的线框图,换涂料的场景图,添加产品的场景图,换砖的场景图,换门板的场景图,换台面的场景图
toolType:
type: integer
format: int32
description: 梦想家业务字段 生图工具类型,具体参考 DreamerToolTypeEnum
type:
type: integer
format: int32
description: 对话类型,0:文字(通用的gpt chat聊天);1:文生图,2:毛坯全屋设计; 3:旧房全屋改造,4:家具背景替换,5:房屋换家具,6:全屋换材质,7:图像消除,8:精装房软装添加,9:重绘,10:Gemini改图,11:线框图生图,12:指定风格改图,13:家居背景改图plus,14:换涂料,15:添加产品,16:换砖,17:换门板,18:换台面
required:
- type
example:
similar: 0
productImgUrl: ''
conversationId: ''
imgCount: 0
chatConversationId: 0
sourceImgUrl: ''
type: 0
toolType: 0
referenceImgUrl: ''
emptyRoom: 0
lightPrompt: ''
botType: 0
chatQuestionExt: ''
botId: 0
businessType: 0
prompt: ''
responses:
'200':
description: 成功 / OK
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
description: 请求是否成功 / whether the call succeeded
code:
type: integer
description: 结果码 / result code (0 = success)
msg:
type: string
description: 提示信息 / message
data:
type: object
properties:
chatAnswer:
type: string
description: 对话回答内容
chatConversationId:
type: string
description: 会话id
chatQuestionExt:
type: string
description: 提问扩展信息
conversationId:
type: string
description: 会话id
id:
type: integer
format: int64
description: id
example:
msg: ''
code: 0
data:
conversationId: ''
chatConversationId: ''
chatAnswer: ''
chatQuestionExt: ''
id: 0
success: false
'401':
description: access_token 缺失或已过期 / missing or expired access_token
/api/chat/v1/journal/getById:
post:
operationId: apiChatV1JournalGetById
summary: 通过id查询会话详情记录
tags:
- Dreamer
x-source-documentation: https://dev.3vjia.com/document?apiId=752849221425709153
x-documentation-category: 梦想家
description: 通过id查询会话详情记录
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
id:
type: integer
format: int64
description: ID
required:
- id
example:
id: 0
responses:
'200':
description: 成功 / OK
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
description: 请求是否成功 / whether the call succeeded
code:
type: integer
description: 结果码 / result code (0 = success)
msg:
type: string
description: 提示信息 / message
data:
type: object
properties:
averageTime:
type: integer
format: int32
description: 平均生产时间
chatAnswer:
type: string
description: 回答
chatAnswerUrl:
type: string
description: 图像的相对路径,多个逗号隔开
chatConversationId:
type: integer
format: int64
description: 会话ID
chatQuestion:
type: string
description: 提问
chatQuestionExt:
type: string
description: 提问扩展信息
chatQuestionUrl:
type: string
description: 图像的相对路径,多个逗号隔开
conversationId:
type: string
description: 对话id,传id可以保持上下文,否则开启新对话
id:
type: integer
format: int64
description: 主键id
queue:
type: integer
format: int32
description: 排队序号
referencesContents:
type: array
items:
type: object
properties:
action:
type: string
description: 动作(卡片工具执行的脚本),可以支持json
botId:
type: integer
format: int64
description: 当卡片为工具时,对应的机器人id,当跳转到另外agent的时候(对应的机器人id)
content:
type: string
description: 内容,可以支持json
dialogType:
type: integer
format: int32
description: 生图工具:1:文生图,2:毛坯全屋设计; 3:旧房全屋改造,4:家具背景替换,5:房屋换家具,6:全屋换材质,7:图像消除,8:精装房软装添加,9:重绘
emptyRoom:
type: integer
format: int32
description: 毛胚图生图 可选参数 是否清除空间杂物,0为否 1为是
iconUrl:
type: string
description: 图标
imgCount:
type: integer
format: int32
description: 图片数量
similar:
type: integer
format: int32
description: 指定风格改图的相似度,0:低,1:中,2:高
status:
type: integer
format: int32
description: 生效的状态(轮询组件使用:1、排队中,2、渲染中,3、渲染成功,4、渲染失败;户型搜索卡片:0 正常,1:禁用
title:
type: string
description: 标题
toolType:
type: integer
format: int32
description: 梦想家业务字段 生图工具类型
type:
type: integer
format: int32
description: 告诉前端需要处理的类型:0:文本,1:按钮,2:链接,3:图片,4:跳转工具,5:生图轮询组件,6:前端直接回调一次回调接口,7:加载上传图片组件,8:户型搜索工具,9:户型图识别工具,10:素材检索工具,11:AI布局卡片,12:灵感广场卡片,100:跳转到另一agent
url:
type: string
description: 回调接口
description: 关联结果dto
remark:
type: string
description: 基本描述
taskId:
type: string
description: 任务Id,比如图片生成异步任务id
taskStatus:
type: integer
format: int32
description: 任务渲染状态,1、排队中,2、渲染中,3、渲染成功,4、渲染失败
type:
type: integer
format: int32
description: 对话类型:0:普通文字chat,1:普通文生图,2:空间填充,3:家具背景替换,4:材质替换
required:
- id
example:
msg: ''
code: 0
data:
referencesContents:
- similar: 0
imgCount: 0
title: ''
type: 0
toolType: 0
content: ''
url: ''
dialogType: 0
emptyRoom: 0
action: ''
botId: 0
iconUrl: ''
status: 0
conversationId: ''
chatQuestionUrl: ''
remark: ''
chatConversationId: 0
type: 0
chatQuestion: ''
chatAnswer: ''
chatAnswerUrl: ''
averageTime: 0
chatQuestionExt: ''
id: 0
queue: 0
taskId: ''
taskStatus: 0
success: false
'401':
description: access_token 缺失或已过期 / missing or expired access_token
/api/custCustomerOp/page:
post:
operationId: apiCustCustomerOpPage
summary: 客户分页查询(aimes)
tags:
- AIMES
x-source-documentation: https://dev.3vjia.com/document?apiId=768884626109382683
x-documentation-category: AIMES系统 / 基础信息
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
current:
type: integer
format: int64
description: 当前查询第几页
endCustomerDataTime:
type: string
description: 结束留资时间
liveAreaName:
type: string
description: 小区名称
size:
type: integer
format: int64
description: 当前查询页记录数
startCustomerDataTime:
type: string
description: 开始留资时间
required:
- current
- size
example:
startCustomerDataTime: ''
liveAreaName: ''
current: 0
size: 0
endCustomerDataTime: ''
responses:
'200':
description: 成功 / OK
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
description: 请求是否成功 / whether the call succeeded
code:
type: integer
description: 结果码 / result code (0 = success)
msg:
type: string
description: 提示信息 / message
data:
type: object
properties:
current:
type: integer
format: int64
description: 当前查询第几页
records:
type: array
items:
type: object
properties:
address:
type: string
description: 详细地址
city:
type: string
description: 城市
cityName:
type: string
description: 城市名称
createTime:
type: string
format: date-time
description: 创建时间
creatorUserName:
type: string
description: 修改人名称
customerDataTime:
type: string
format: date
description: 客户留资时间
deptName:
type: string
description: 部门名称
district:
type: string
description: 区域
districtName:
type: string
description: 区域名称
houseAreaCode:
type: string
description: 住宅面积编码
houseAreaName:
type: string
description: 住宅面积名称
houseTypeCode:
type: string
description: 住宅类型编码
houseTypeName:
type: string
description: 住宅类型名称
id:
type: integer
format: int64
description: 主键id
liveAreaId:
type: integer
format: int64
description: 小区id
liveAreaName:
type: string
description: 小区名称
modifierUserName:
type: string
description: 修改人名称
name:
type: string
description: 客户名称
orderCou:
type: integer
format: int32
description: 订单数
orderStatus:
type: integer
format: int32
description: 下单状态,0:未下单,1:已下单,2:部分下单, 3:已保存
orderStatusDesc:
type: string
description: 下单状态,0:未下单,1:已下单,2:部分下单, 3:已保存
otherTel:
type: string
description: 备用电话号码
province:
type: string
description: 省份
provinceName:
type: string
description: 省份名称
relationTimes:
type: integer
format: int32
description: 关联次数
remark:
type: string
description: 备注
remarks:
type: string
description: 备注
sex:
type: integer
format: int32
description: 性别
sexDesc:
type: string
description: 性别描述
shopName:
type: string
description: 门店名称
sourceCode:
type: string
description: 客户来源code
sourceName:
type: string
description: 客户来源名称
status:
type: integer
format: int32
description: 状态:0:有意向;1:无意向
tel:
type: string
description: 电话号码
required:
- id
description: 客户信息
size:
type: integer
format: int64
description: 当前查询页记录数
total:
type: integer
format: int64
description: 总数
required:
- current
- size
- total
example:
msg: ''
code: 0
data:
records:
- houseTypeCode: ''
deptName: ''
creatorUserName: ''
city: ''
orderStatusDesc: ''
orderStatus: 0
shopName: ''
orderCou: 0
remark: ''
sourceCode: ''
customerDataTime: ''
cityName: ''
province: ''
sexDesc: ''
liveAreaId: 0
otherTel: ''
tel: ''
id: 0
houseAreaCode: ''
relationTimes: 0
address: ''
districtName: ''
liveAreaName: ''
sex: 0
houseTypeName: ''
modifierUserName: ''
houseAreaName: ''
createTime: ''
district: ''
name: ''
provinceName: ''
sourceName: ''
remarks: ''
status: 0
current: 0
total: 0
size: 0
success: false
'401':
description: access_token 缺失或已过期 / missing or expired access_token
/api/factoryBatchOp/getBoards:
post:
operationId: apiFactoryBatchOpGetBoards
summary: 全线通--通过批次ID获取批次大板用量
tags:
- AIMES
x-source-documentation: https://dev.3vjia.com/document?apiId=684406247218364448
x-documentation-category: AIMES系统 / 排产优化
description: 全线通-》通过批次ID获取批次大板用量
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
factoryBatchCode:
type: string
description: 批次号
factoryBatchId:
type: integer
format: int64
description: 批次ID
example:
factoryBatchId: 0
factoryBatchCode: ''
responses:
'200':
description: 成功 / OK
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
description: 请求是否成功 / whether the call succeeded
code:
type: integer
description: 结果码 / result code (0 = success)
msg:
type: string
description: 提示信息 / message
data:
type: object
properties:
basicMaterial:
type: string
description: 材质
batchId:
type: integer
format: int64
description: 批次id
batchNo:
type: string
description: 批次号
createTime:
type: string
format: date-time
description: 创建时间
creatorName:
type: string
description: 创建人名字
deptId:
type: string
description: 当前人部门ID
id:
type: integer
format: int64
description: 主键id
length:
type: number
format: bigdecimal
description: 长
materCode:
type: string
description: 物料编码
material:
type: string
description: 颜色
modifierName:
type: string
description: 修改人名字
num:
type: integer
format: int32
description: 大板用量(张)
organId:
type: string
description: 当前人组织ID
thickness:
type: number
format: bigdecimal
description: 厚
usesPercentage:
type: number
format: bigdecimal
description: 利用率
width:
type: number
format: bigdecimal
description: 宽
required:
- createTime
- id
example:
msg: ''
code: 0
data:
- batchNo: ''
thickness: 0
num: 0
creatorName: ''
deptId: ''
length: 0
batchId: 0
basicMaterial: ''
usesPercentage: 0
materCode: ''
material: ''
createTime: ''
width: 0
organId: ''
id: 0
modifierName: ''
success: false
'401':
description: access_token 缺失或已过期 / missing or expired access_token
/api/factoryBatchOp/getFactoryBatchFileList:
post:
operationId: apiFactoryBatchOpGetFactoryBatchFileList
summary: 全线通--通过批次ID或者批次号批次优化附件列表
tags:
- AIMES
x-source-documentation: https://dev.3vjia.com/document?apiId=683004993405603934
x-documentation-category: AIMES系统 / 排产优化
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
factoryBatchCode:
type: string
description: 批次号
factoryBatchId:
type: integer
format: int64
description: 批次ID
example:
factoryBatchId: 0
factoryBatchCode: ''
responses:
'200':
description: 成功 / OK
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
description: 请求是否成功 / whether the call succeeded
code:
type: integer
description: 结果码 / result code (0 = success)
msg:
type: string
description: 提示信息 / message
data:
type: object
properties:
bizId:
type: integer
format: int64
description: 业务ID
bizType:
type: string
description: 业务类型,详见枚举
createTime:
type: string
format: date-time
description: 创建时间
creator:
type: string
description: 创建者
creatorName:
type: string
description: 创建者名称
fileKey:
type: string
fileName:
type: string
description: 文件名称
fileSize:
type: integer
format: int64
description: 文件大小
fileType:
type: string
description: 文件类型
id:
type: integer
format: int64
description: 主键id
modifierName:
type: string
description: 修改者名称
organId:
type: string
description: 机构ID
url:
type: string
description: 附件路径
required:
- createTime
- id
example:
msg: ''
code: 0
data:
- creator: ''
fileName: ''
bizType: ''
creatorName: ''
fileKey: ''
url: ''
createTime: ''
fileSize: 0
bizId: 0
organId: ''
id: 0
modifierName: ''
fileType: ''
success: false
'401':
description: access_token 缺失或已过期 / missing or expired access_token
/api/factoryOrderOp/batchRedistributionOp:
post:
operationId: apiFactoryOrderOpBatchRedistributionOp
summary: 重新指派(接单员、审单员、报价员)
tags:
- AIMES
x-source-documentation: https://dev.3vjia.com/document?apiId=778188431338651703
x-documentation-category: AIMES系统 / 订单管理
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
distributionType:
type: string
description: 分配规则类型 (receiving_order:接单分配,split_order:拆单分配,quote_order:报价员分配
factoryOrderCodes:
type: array
items: {}
description: 订单号集合
factoryOrderIds:
type: array
items: {}
description: 工厂订单IDS
operationRemark:
type: string
description: 操作备注信息
userId:
type: string
description: 用户ID
userName:
type: string
description: 用户姓名
required:
- distributionType
- userName
example:
distributionType: ''
factoryOrderCodes: []
userName: ''
userId: ''
factoryOrderIds: []
operationRemark: ''
responses:
'200':
description: 成功 / OK
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
description: 请求是否成功 / whether the call succeeded
code:
type: integer
description: 结果码 / result code (0 = success)
msg:
type: string
description: 提示信息 / message
data:
type: object
example:
msg: ''
code: 0
data: false
success: false
'401':
description: access_token 缺失或已过期 / missing or expired access_token
/api/factoryOrderOp/batchReturnCompletedFactoryOrderToShop:
post:
operationId: apiFactoryOrderOpBatchReturnCompletedFactoryOrderToShop
summary: 已完成工厂订单批量退回门店
tags:
- Dedicated Services
x-source-documentation: https://dev.3vjia.com/document?apiId=878213521912012905
x-documentation-category: 专属服务 / C13044572
description: 支持已完成的工厂订单执行批量退回到门店的操作,指定退回到门店,不提供选择退回到工厂的功能。
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
factoryOrderIds:
type: array
items: {}
description: 工厂订单ID列表
returnReason:
type: string
description: 退回原因
required:
- factoryOrderIds
- returnReason
example:
factoryOrderIds: []
returnReason: ''
responses:
'200':
description: 成功 / OK
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
description: 请求是否成功 / whether the call succeeded
code:
type: integer
description: 结果码 / result code (0 = success)
msg:
type: string
description: 提示信息 / message
data:
type: object
properties:
returned:
type: integer
format: int32
description: 本次实际退回数量
skipped:
type: integer
format: int32
description: 已退回、按幂等规则跳过的数量
total:
type: integer
format: int32
description: 请求中去重后的工厂订单总数
example:
msg: ''
code: 0
data:
skipped: 0
total: 0
returned: 0
success: false
'401':
description: access_token 缺失或已过期 / missing or expired access_token
/api/factoryOrderOp/batchReturnFactoryOrderByShopOrder:
post:
operationId: apiFactoryOrderOpBatchReturnFactoryOrderByShopOrder
summary: 按销售单批量退回关联工厂订单
tags:
- AIMES
x-source-documentation: https://dev.3vjia.com/document?apiId=853221090548400190
x-documentation-category: AIMES系统 / 订单管理
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
goBackFlowNodeId:
type: integer
format: int64
description: 退回到工厂时的目标流程节点ID
goBackReason:
type: string
description: 退回原因
shopOrderId:
type: integer
format: int64
description: 销售单ID
type:
type: integer
format: int32
description: 退回终端:5-门店,6-工厂;默认门店
required:
- shopOrderId
example:
goBackReason: ''
goBackFlowNodeId: 0
type: 0
shopOrderId: 0
responses:
'200':
description: 成功 / OK
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
description: 请求是否成功 / whether the call succeeded
code:
type: integer
description: 结果码 / result code (0 = success)
msg:
type: string
description: 提示信息 / message
data:
type: object
example:
msg: ''
code: 0
success: false
'401':
description: access_token 缺失或已过期 / missing or expired access_token
/api/factoryOrderOp/batchSplitOrderConfirm:
post:
operationId: apiFactoryOrderOpBatchSplitOrderConfirm
summary: 批量拆单确认
tags:
- AIMES
x-source-documentation: https://dev.3vjia.com/document?apiId=791363623061704705
x-documentation-category: AIMES系统 / 订单管理
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
platformOrderCodes:
type: array
items: {}
description: 工厂单号集合,和工厂单ID二选一
platformOrderIds:
type: array
items: {}
description: 工厂单ID集合,工厂单号二选一。
example:
platformOrderIds: []
platformOrderCodes: []
responses:
'200':
description: 成功 / OK
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
description: 请求是否成功 / whether the call succeeded
code:
type: integer
description: 结果码 / result code (0 = success)
msg:
type: string
description: 提示信息 / message
data:
type: object
example:
msg: ''
code: 0
data: false
success: false
'401':
description: access_token 缺失或已过期 / missing or expired access_token
/api/factoryOrderOp/batchUpFactoryPayStatus:
post:
operationId: apiFactoryOrderOpBatchUpFactoryPayStatus
summary: 修改付款状态(外部企业状态和备注)
tags:
- AIMES
x-source-documentation: https://dev.3vjia.com/document?apiId=798917268808548481
x-documentation-category: AIMES系统 / 订单管理
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
factoryOrderCodes:
type: array
items: {}
description: 订单编号集合或者订单ID集合 必填
orderIds:
type: array
items: {}
description: 订单编号集合或者订单ID集合 必填
payStatus:
type: integer
format: int32
description: 支付状态(0=待付款; 1=已结清; 2=部分付款)
receivingRemarks:
type: string
description: 企业解析备注
receivingStatus:
type: string
description: 企业解析状态(1=已解析; 2=解析失败)
required:
- payStatus
example:
factoryOrderCodes: []
receivingStatus: ''
receivingRemarks: ''
orderIds: []
payStatus: 0
responses:
'200':
description: 成功 / OK
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
description: 请求是否成功 / whether the call succeeded
code:
type: integer
description: 结果码 / result code (0 = success)
msg:
type: string
description: 提示信息 / message
data:
type: object
example:
msg: ''
code: 0
success: false
'401':
description: access_token 缺失或已过期 / missing or expired access_token
/api/factoryOrderOp/batchUpdateCustomOrderNo:
post:
operationId: apiFactoryOrderOpBatchUpdateCustomOrderNo
summary: 批量修改自定义单号(通用)
tags:
- AIMES
x-source-documentation: https://dev.3vjia.com/document?apiId=781484908794232925
x-documentation-category: AIMES系统 / 订单管理
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
customOrderNo:
type: string
description: 自定义单号
platformOrderCode:
type: string
description: 订单号工厂单号,和工厂单ID二选一。
platformOrderId:
type: integer
format: int64
description: 工厂单ID,和工厂单号二选一。
example:
- customOrderNo: ''
platformOrderCode: ''
platformOrderId: 0
responses:
'200':
description: 成功 / OK
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
description: 请求是否成功 / whether the call succeeded
code:
type: integer
description: 结果码 / result code (0 = success)
msg:
type: string
description: 提示信息 / message
data:
type: object
example:
msg: ''
code: 0
data: false
success: false
'401':
description: access_token 缺失或已过期 / missing or expired access_token
/api/factoryOrderOp/batchUpdateQyCustomInformation:
post:
operationId: apiFactoryOrderOpBatchUpdateQyCustomInformation
summary: 批量修改自定义信息
tags:
- Dedicated Services
x-source-documentation: https://dev.3vjia.com/document?apiId=815156020069421127
x-documentation-category: 专属服务 / C11876880
description: 批量修改自定义信息
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
customOrderNo:
type: string
description: 自定义单号
orderCode:
type: string
description: 订单号
orderID:
type: integer
format: int64
description: 订单ID
reviewInformation:
type: string
description: 属性Json
example:
- customOrderNo: ''
orderCode: ''
orderID: 0
reviewInformation: ''
responses:
'200':
description: 成功 / OK
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
description: 请求是否成功 / whether the call succeeded
code:
type: integer
description: 结果码 / result code (0 = success)
msg:
type: string
description: 提示信息 / message
data:
type: object
example:
msg: ''
code: 0
data: false
success: false
'401':
description: access_token 缺失或已过期 / missing or expired access_token
/api/factoryOrderOp/getFactoryOrderBySchemeId:
post:
operationId: apiFactoryOrderOpGetFactoryOrderBySchemeId
summary: 根据方案ID获取工厂单列表
tags:
- AIMES
x-source-documentation: https://dev.3vjia.com/document?apiId=642008607898091577
x-documentation-category: AIMES系统 / 订单数据 / 工厂单
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
schemeId:
type: string
description: 方案ID
example:
schemeId: ''
responses:
'200':
description: 成功 / OK
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
description: 请求是否成功 / whether the call succeeded
code:
type: integer
description: 结果码 / result code (0 = success)
msg:
type: string
description: 提示信息 / message
data:
type: object
properties:
acceptTime:
type: string
format: date-time
description: 接单时间
acceptUserId:
type: string
description: 接单人用户ID
acceptUserRealName:
type: string
description: 接单人
addAmount:
type: number
format: bigdecimal
description: 附加费用金额
amountConfirm:
type: number
format: bigdecimal
description: 已确认金额
amountNotConfirm:
type: number
format: bigdecimal
description: 待确认金额
amountWaitPayment:
type: number
format: bigdecimal
description: 未付金额
appointedBomUserId:
type: string
description: 指定的拆单人用户ID
appointedBomUserRealName:
type: string
description: 指定的拆单人姓名
assignBomTime:
type: string
format: date-time
description: 分配拆单人时间
assignBomUserId:
type: string
description: 分配拆单人用户ID
assignBomUserRealName:
type: string
description: 分配拆单人姓名
autoSplitRemark:
type: string
description: 自动拆单备注
autoSplitStatus:
type: integer
format: int32
description: 自动拆单状态,0-非自动拆单,1-自动拆单中,2-自动拆单结束
autoSplitStatusDesc:
type: string
description: 自动拆单状态
autoSplitTaskStatus:
type: integer
format: int32
description: 自动拆单任务状态
autoSplitTaskStatusDesc:
type: string
description: 自动拆单任务状态
basicMaterial:
type: string
description: 主颜色
batchId:
type: integer
format: int64
description: 批次Id
batchNo:
type: string
description: 批次号
bomTime:
type: string
format: date-time
description: 拆单时间
bomUserId:
type: string
description: 拆单人用户ID
bomUserRealName:
type: string
description: 拆单人
branchStoreId:
type: string
description: 分店ID
calculateDeliveryDate:
type: string
format: date
description: 交货期推算日期
category:
type: string
description: 订单类别
chargebackStatus:
type: integer
format: int32
description: 退单状态:0-正常;1-接单回退;2-拆单回退
color1:
type: string
description: 颜色1
color1Area:
type: number
format: bigdecimal
description: 颜色1面积
color2:
type: string
description: 颜色2
color2Area:
type: number
format: bigdecimal
description: 颜色2面积
color3:
type: string
description: 颜色3
color3Area:
type: number
format: bigdecimal
description: 颜色3面积
color4:
type: string
description: 颜色4
color4Area:
type: number
format: bigdecimal
description: 颜色4面积
color5:
type: string
description: 颜色5
color5Area:
type: number
format: bigdecimal
description: 颜色5面积
contractNo:
type: string
description: 合同编号
createBatchProgress:
type: string
description: 是否全部生成批次:0-未生成;1-部分生成;2-已全部生成
createOrderUserName:
type: string
createTime:
type: string
format: date-time
description: 创建时间
creatorId:
type: string
description: 创建人id
creatorUserName:
type: string
description: 创建人用户名
customMaterial:
type: string
description: 改色颜色
customOrderItemNo:
type: string
description: 外部销售订单行号
customOrderNo:
type: string
description: 自定义单号
customParameters:
type: string
description: 自定义参数
customSaleOrderNo:
type: string
description: 外部销售订单号
customerAddress:
type: string
description: 业主地址街道
customerArea:
type: string
description: 业主地址区
customerAreaCode:
type: string
description: 业主地址区行政编号
customerCity:
type: string
description: 业主地址市
customerCityCode:
type: string
description: 业主地址市行政编号
customerGender:
type: integer
format: int32
description: 业主性别 (0-未填;1-女;2-男)
customerId:
type: string
description: 业主ID
customerName:
type: string
description: 业主名称
customerPhone:
type: string
description: 业主电话
customerPostcode:
type: string
description: 业主地址邮政编号
customerProvince:
type: string
description: 业主地址省
customerProvinceCode:
type: string
description: 业主地址省行政编号
deliveryContact:
type: string
description: 发货人联系方式
deliveryDate:
type: string
format: date
description: 预交货时间
deliveryPeriod:
type: integer
format: int32
description: 交货周期
deliveryPerson:
type: string
description: 发货人
deliveryQuantity:
type: integer
format: int32
description: 发货件数
deliveryStatus:
type: integer
format: int32
description: 发货状态,1-未发货,2-部分发货,3-已发货
deliveryTime:
type: string
format: date-time
description: 发货时间
deptId:
type: string
description: 创建人部门ID
designerName:
type: string
description: 设计师
designerPhone:
type: string
description: 设计师电话
discountBeforePrice:
type: number
format: bigdecimal
description: 折前金额
discountCoefficient:
type: number
format: bigdecimal
description: 折扣系数
doorWindowType:
type: integer
format: int32
description: 整木类型,1-板式 2-实木
expectPositionCode:
type: string
description: 预分配库位
expectPositionId:
type: integer
format: int64
description: 预分配库位id
externalContractCode:
type: string
description: 外部合同号
externalProjectId:
type: string
description: 外部项目ID
factoryAuditOperator:
type: string
description: 工厂审核人
factoryAuditStatus:
type: integer
format: int32
description: 生产审核状态
factoryAuditStatusDesc:
type: string
description: 生产审核状态
factoryAuditTime:
type: string
format: date-time
description: 工厂审核时间
factoryBaseId:
type: integer
format: int64
description: '''工厂基地id'
factoryBaseName:
type: string
description: '''工厂基地名称'
factoryId:
type: string
description: 下发的工厂ID
factoryOrderSchemeFilesResultList:
type: array
items:
type: object
properties:
bizFileType:
type: string
description: 附件类型
createTime:
type: string
format: date-time
description: 创建时间
creatorUserName:
type: string
description: 创建人用户名
factoryOrderSchemeId:
type: integer
format: int64
description: 下单方案ID
fileId:
type: string
description: 文件ID,文件存储的主键ID,可用于删除维护等
fileKey:
type: string
description: 方案文件分类key, cad_xml,quote_xml,cover_image...
fileName:
type: string
description: 文件名称
filePath:
type: string
description: 文件存储路径
fileType:
type: string
description: 文件类型后缀 zip,txt,xml...
id:
type: integer
format: int64
description: 主键id
modifierUserName:
type: string
description: 更新人用户名
organId:
type: string
description: 机构ID
remark:
type: string
description: 备注
schemeId:
type: string
description: 3D方案号
required:
- createTime
- id
description: 工厂订单单方案文件信息
factoryOrderSchemeId:
type: integer
format: int64
description: 工厂订单方案id
financingAuditTime:
type: string
format: date-time
description: 财务审核时间
financingAuditUserId:
type: string
description: 财务审核人用户ID
financingAuditUserRealName:
type: string
description: 财务审核人
flowCode:
type: string
description: 订单流程Code
flowIconName:
type: string
description: 流程图标名称
flowId:
type: integer
format: int64
description: 订单流程ID
flowNodeCode:
type: string
description: 流程节点Code
flowNodeId:
type: integer
format: int64
description: 流程节点ID
flowNodeStatusName:
type: string
description: 流程节点状态名称
flowNodeTodoName:
type: string
description: 流程节点待办名称
fullSet1:
type: integer
format: int32
description: 齐套1:0-显示“-”,1-齐套1完成
fullSet2:
type: integer
format: int32
description: 齐套2:0-显示“-”,1-齐套2完成
globallyUniqueId:
type: string
description: 全局唯一id
id:
type: integer
format: int64
description: 主键id
installPosition:
type: string
description: 安装位置
invalidOperateTime:
type: string
format: date-time
description: 作废操作时间
invalidOperateUserId:
type: string
description: 作废操作人ID
invalidOperateUserRealName:
type: string
description: 作废操作人名字
isAgainSubmit:
type: integer
format: int32
description: 是否重新提交:0-否,1-是
isBomStatus:
type: integer
format: int32
description: 3D拆单状态(0:拆单中,1已拆单)
isCanChange:
type: integer
format: int32
description: 是否可以改单,0-否,1-是
isCanGoBack:
type: integer
format: int32
description: 是否可退回:0-不可退回 1-可退回
isChangeOrder:
type: integer
format: int32
description: 是否改单
isCustomColor:
type: integer
format: int32
description: 是否改色
isDesignDrawing:
type: integer
format: int32
description: 是否设计出图进行分配:1-是;0-否
isDownLoad:
type: boolean
description: 3D审核列表是否有下载附件
isEngineeringOrder:
type: integer
format: int32
description: 是否工程单(0否,1是)
isFactoryAuditBack:
type: integer
format: int32
description: 工厂审核是否退回 0=否 1=是,默认1
isFactoryOrderAll:
type: integer
format: int32
description: 工厂单齐套,0否,1是
isFactoryQuote:
type: integer
format: int32
description: 工厂是否报价,0-否,1-是,用来判断节点是否在报价之后
isHandOperater:
type: integer
format: int32
description: 是否手动操作改变生产/入库/发货状态;0-否;1-是
isHandOperaterDelivery:
type: integer
format: int32
description: 是否手动操作改变发货;0-否;1-是
isHandOperaterWarehouse:
type: integer
format: int32
description: 是否手动操作改变入库;0-否;1-是
isHavedPack:
type: boolean
description: 是否已包装
isOutsourcing:
type: integer
format: int32
description: 是否委外(0:否,1:是)
isSaleOrderAll:
type: integer
format: int32
description: 销售单齐套 0否,1是
isSplitCollaborate:
type: integer
format: int32
description: 是否拆单协作(0:否,1:是)
isSuspend:
type: integer
format: int32
description: 是否暂停,0-否,1-是
isTableBoard:
type: integer
format: int32
description: 是否有台面板(0:否,1:是)
isTempOrder:
type: integer
format: int32
description: 是否临时单(0:否,1:是)
isUrgent:
type: integer
format: int32
description: 是否加急
isValid:
type: integer
format: int32
description: 是否作废:0=否, 1=是
logisticsAddress:
type: string
description: 物流信息地址
material:
type: string
description: 主材
modifierUserName:
type: string
description: 更新人用户名
moduleCode:
type: string
description: 模块代码 cupboard 橱柜,wardrobe 衣柜,systemCabinet 系统柜,furnitureType 成品,ceilingAll 顶墙,doorWindow 门窗,bathRoom 淋浴房,aluminum 铝门窗
moduleName:
type: string
description: 模块名称 橱柜,衣柜,系统柜,成品,顶墙,门窗,淋浴房,铝门窗
natureOfOrder:
type: string
description: 订单性质
nextFlowNodeCode:
type: string
description: 下一个流程节点Code
nextFlowNodeId:
type: integer
format: int64
description: 下一个流程节点ID
orderCategoryDictKey:
type: string
description: 订单品类字典Key
orderCategoryDictVal:
type: string
description: 订单品类字典Value
orderCode:
type: string
description: 订单编号
orderName:
type: string
description: 订单名称
orderRebateAmount:
type: number
format: bigdecimal
description: 分摊返利金额
orderSource:
type: string
description: 订单来源(默认mes,金牌:jinp)
orderSuit:
type: integer
format: int32
description: 订单套数(默认1,最大999)
orderTypeCode:
type: string
description: 订单类型
orderTypeDictKey:
type: string
description: 订单类型字典Key
orderTypeDictVal:
type: string
description: 订单类型字典Value
orderTypeName:
type: string
description: 订单类型名称
organDealerAreaCode:
type: string
description: 企业经销商归属区域编码
organDealerAreaName:
type: string
description: 企业经销商归属区域名称
organDealerCode:
type: string
description: 企业经销商编号
organDealerId:
type: integer
format: int64
description: 企业经销商Id
organDealerName:
type: string
description: 企业经销商名称
organId:
type: string
description: 机构ID
originalAmount:
type: number
format: bigdecimal
description: 产品原价格(JSON赋值)不可修改
outsourcingButtonStatus:
type: integer
format: int32
description: 外购板件是否MPM扫描包装按钮状态,0-不显示,1-可编辑,2-不可编辑
outsourcingPartMpmPacking:
type: integer
format: int32
description: 外购板件是否MPM扫描包装,0-否,1-是'
packageAuditStatus:
type: integer
format: int32
description: 分包审核状态,0-待审核,1-已审核
payStatus:
type: integer
format: int32
description: 支付状态(0=待付款; 1=未结清; 2=已结清)
payTime:
type: string
format: date-time
description: 订单支付时间
payWay:
type: string
description: 支付方式code
payWayName:
type: string
description: 支付方式名称
payableAmount:
type: number
format: bigdecimal
description: 订单报价后应付金额(支付价)
placeTypeDictKey:
type: string
description: 下单类型字典Key
placeTypeDictVal:
type: string
description: 下单类型字典Value
planDeliveryDate:
type: string
format: date
description: 计划工厂交货日期,财务审核后基于规则计算得出
preDistributionQuoterTime:
type: string
format: date
description: 预报价员分配时间
preQuoterName:
type: string
description: 预报价员名称
preQuoterUserId:
type: string
description: 预报价员ID
prevFlowNodeId:
type: integer
format: int64
description: 前一个流程节点ID,主要用于回退
priceAuditAmounts:
type: number
format: bigdecimal
description: 价格审核总金额
priceAuditOperator:
type: string
description: 价格审核人
priceAuditStatus:
type: integer
format: int32
description: 价格审核状态
priceAuditStatusDesc:
type: string
description: 价格审核状态
priceAuditTime:
type: string
format: date-time
description: 价格审核时间
pricingMethod:
type: string
description: 取价方式
productQty:
type: integer
format: int32
productTotalPrice:
type: number
format: bigdecimal
description: 产品总价
productionAmount:
type: number
format: bigdecimal
description: 产品金额
productionDataCreateStatus:
type: integer
format: int32
description: 创建生产订单状态 0-未生成;1-生成中;2-生成成功;3-生成失败
productionLine:
type: string
description: 生产线
productionSize:
type: string
description: 尺寸
productionSystem:
type: string
description: 订单生产的生产系统:oms=oms自带合批排产, aps=使用aps系统排产生产
productionTime:
type: string
format: date-time
description: 生产时间
projectId:
type: string
description: 项目id
projectName:
type: string
description: 项目名称
quoteJsonUrl:
type: string
description: 报价jsonURL
quoteTime:
type: string
format: date-time
description: 报价时间
rebateBillSettlementAmount:
type: number
format: bigdecimal
description: 返利结算金额
rebatePrice:
type: number
format: bigdecimal
description: 返利金额
rebatesSettlementAmount:
type: number
format: bigdecimal
description: 返点结算金额
receiverAddress:
type: string
description: 收货人地址街道
receiverArea:
type: string
description: 收货人地址区
receiverAreaCode:
type: string
description: 收货人地址区行政编号
receiverCity:
type: string
description: 收货人地址市
receiverCityCode:
type: string
description: 收货人地址市行政编号
receiverGender:
type: integer
format: int32
description: 收货人性别 (0-未填;1-女;2-男)
receiverName:
type: string
description: 收货人姓名
receiverPhone:
type: string
description: 收货人电话
receiverPostcode:
type: string
description: 收货人地址邮编
receiverProvince:
type: string
description: 收货人地址省
receiverProvinceCode:
type: string
description: 收货人地址省行政编号
receiverType:
type: string
description: 收货人类型 customer=业主 shop=门店
receivingRemarks:
type: string
description: 企业解析备注
receivingStatus:
type: string
description: 企业解析状态
relateFactoryOrderCode:
type: string
description: 关联工厂单编号
relateFactoryOrderId:
type: integer
format: int64
description: 关联工厂单ID
remarks:
type: string
description: 3D下单备注
roomName:
type: string
description: 空间名称
saleOrderCode:
type: string
description: 售后子订单编号
saleOrderId:
type: integer
format: int64
description: 售后子订单ID
salesName:
type: string
description: 销售
salesPrice:
type: number
format: bigdecimal
description: 销售价
salesQuoteJsonUrl:
type: string
description: 销售价报价json
schemeId:
type: string
description: 3D方案号
schemeName:
type: string
description: 方案名称
schemePreviewImage:
type: string
description: 方案预览图
schemeRemark:
type: string
description: 方案备注
schemeVersion:
type: string
description: 方案版本号
settlementAmount:
type: number
format: bigdecimal
description: 结算金额
shipmentType:
type: string
description: 出货类型
shopAuditOperator:
type: string
description: 门店审核人
shopAuditStatus:
type: integer
format: int32
description: 门店审核状态
shopAuditStatusDesc:
type: string
description: 门店审核状态
shopAuditTime:
type: string
format: date-time
description: 门店审核时间
shopCode:
type: string
description: 门店编码
shopDeptId:
type: string
description: 经销商所在部门id
shopId:
type: string
description: 经销商ID
shopName:
type: string
description: 经销商名称
shopOrderCode:
type: string
description: 门店订单Code
shopOrderId:
type: integer
format: int64
description: 门店订单ID
shopOrderName:
type: string
description: 销售订单名称
shopOrderRemark:
type: string
description: 门店订单备注
shopOrderSubmitTime:
type: string
format: date-time
description: 店铺订单提交时间
splitNum:
type: integer
format: int32
description: 拆单次数
splitOrderImage:
type: string
description: 拆单主图
splitStatus:
type: integer
format: int32
description: 拆单状态:-1-退回;0-未拆单;1-拆单中;2-已拆单
splitXmlUrl:
type: string
description: 拆单方案xml路径
submitUserId:
type: string
description: 店铺订单提交人用户ID
submitUserName:
type: string
description: 店铺订单提交人账号
submitUserPhone:
type: string
description: 店铺订单提交人手机号码
submitUserRealName:
type: string
description: 店铺订单提交人用户姓名
suspendTime:
type: string
format: date-time
description: 订单暂停时间
suspendUserId:
type: string
description: 订单暂停人用户ID
suspendUserRealName:
type: string
description: 订单暂停人姓名
systemEnvironment:
type: string
taxCategory:
type: string
description: 税种
totalArea:
type: number
format: bigdecimal
description: 展开面积(平米)
totalPrice:
type: number
format: bigdecimal
description: 订单总价(原价)
tradePrice:
type: number
format: bigdecimal
description: 交易单价
unitCategoryName:
type: string
description: 商品品类名称
urlParam:
type: string
description: 外部参数
validReason:
type: string
description: 作废原因
warehousingTime:
type: string
format: date-time
description: 入库时间
workOrderNo:
type: string
description: 外部工单号
required:
- createTime
- id
example:
msg: ''
code: 0
data:
- customerPostcode: ''
financingAuditUserRealName: ''
productionDataCreateStatus: 0
customMaterial: ''
salesPrice: 0
color5: ''
basicMaterial: ''
color3: ''
color4: ''
color1: ''
color2: ''
color2Area: 0
rebateBillSettlementAmount: 0
receiverPhone: ''
isFactoryOrderAll: 0
isOutsourcing: 0
customerAreaCode: ''
isEngineeringOrder: 0
rebatesSettlementAmount: 0
deliveryContact: ''
customerProvinceCode: ''
externalContractCode: ''
placeTypeDictKey: ''
isFactoryQuote: 0
orderRebateAmount: 0
customerAddress: ''
financingAuditUserId: ''
designerPhone: ''
relateFactoryOrderId: 0
deptId: ''
orderTypeDictVal: ''
customerArea: ''
customerName: ''
isDownLoad: false
splitStatus: 0
warehousingTime: ''
unitCategoryName: ''
flowNodeTodoName: ''
assignBomTime: ''
invalidOperateTime: ''
deliveryStatus: 0
schemePreviewImage: ''
priceAuditOperator: ''
chargebackStatus: 0
payWayName: ''
deliveryTime: ''
relateFactoryOrderCode: ''
priceAuditAmounts: 0
factoryAuditStatus: 0
saleOrderId: 0
acceptUserRealName: ''
bomUserId: ''
payableAmount: 0
customOrderNo: ''
shipmentType: ''
autoSplitTaskStatusDesc: ''
splitXmlUrl: ''
isHavedPack: false
autoSplitStatusDesc: ''
customerId: ''
receivingRemarks: ''
factoryBaseId: 0
workOrderNo: ''
isSaleOrderAll: 0
orderName: ''
shopOrderCode: ''
autoSplitRemark: ''
moduleCode: ''
priceAuditTime: ''
fullSet2: 0
fullSet1: 0
orderTypeName: ''
organDealerCode: ''
salesQuoteJsonUrl: ''
validReason: ''
createTime: ''
customParameters: ''
organDealerAreaName: ''
totalArea: 0
isHandOperaterDelivery: 0
productionSize: ''
isCanGoBack: 0
isBomStatus: 0
payTime: ''
isHandOperater: 0
suspendUserId: ''
receiverProvince: ''
autoSplitStatus: 0
preDistributionQuoterTime: ''
customOrderItemNo: ''
systemEnvironment: ''
productionLine: ''
shopId: ''
isCustomColor: 0
isDesignDrawing: 0
isTableBoard: 0
batchNo: ''
flowNodeId: 0
shopAuditStatus: 0
color5Area: 0
addAmount: 0
schemeName: ''
flowNodeStatusName: ''
isAgainSubmit: 0
receiverAddress: ''
factoryAuditTime: ''
salesName: ''
projectName: ''
projectId: ''
tradePrice: 0
doorWindowType: 0
isSuspend: 0
preQuoterName: ''
receiverGender: 0
appointedBomUserRealName: ''
isHandOperaterWarehouse: 0
createBatchProgress: ''
shopOrderName: ''
orderCategoryDictVal: ''
flowCode: ''
natureOfOrder: ''
deliveryQuantity: 0
flowId: 0
color1Area: 0
packageAuditStatus: 0
shopAuditOperator: ''
outsourcingPartMpmPacking: 0
suspendTime: ''
orderTypeDictKey: ''
schemeVersion: ''
quoteJsonUrl: ''
quoteTime: ''
material: ''
originalAmount: 0
productionAmount: 0
orderCode: ''
invalidOperateUserId: ''
receiverProvinceCode: ''
schemeRemark: ''
pricingMethod: ''
isFactoryAuditBack: 0
moduleName: ''
receiverCity: ''
urlParam: ''
orderCategoryDictKey: ''
receiverAreaCode: ''
amountConfirm: 0
assignBomUserId: ''
bomTime: ''
isTempOrder: 0
id: 0
autoSplitTaskStatus: 0
shopDeptId: ''
deliveryPerson: ''
factoryId: ''
splitNum: 0
isSplitCollaborate: 0
acceptTime: ''
receiverPostcode: ''
organDealerId: 0
color4Area: 0
factoryBaseName: ''
flowIconName: ''
shopOrderId: 0
receiverType: ''
externalProjectId: ''
organId: ''
nextFlowNodeId: 0
productQty: 0
isUrgent: 0
factoryAuditStatusDesc: ''
totalPrice: 0
contractNo: ''
priceAuditStatusDesc: ''
customerPhone: ''
customerCityCode: ''
amountNotConfirm: 0
invalidOperateUserRealName: ''
deliveryDate: ''
globallyUniqueId: ''
saleOrderCode: ''
shopCode: ''
customerGender: 0
isValid: 0
preQuoterUserId: ''
discountCoefficient: 0
splitOrderImage: ''
installPosition: ''
modifierUserName: ''
assignBomUserRealName: ''
settlementAmount: 0
isChangeOrder: 0
orderTypeCode: ''
color3Area: 0
productTotalPrice: 0
payWay: ''
branchStoreId: ''
submitUserPhone: ''
shopAuditStatusDesc: ''
createOrderUserName: ''
factoryAuditOperator: ''
deliveryPeriod: 0
productionSystem: ''
bomUserRealName: ''
customerProvince: ''
planDeliveryDate: ''
roomName: ''
submitUserId: ''
taxCategory: ''
shopAuditTime: ''
suspendUserRealName: ''
discountBeforePrice: 0
receivingStatus: ''
isCanChange: 0
factoryOrderSchemeFilesResultList:
- bizFileType: ''
fileName: ''
creatorUserName: ''
filePath: ''
factoryOrderSchemeId: 0
fileKey: ''
remark: ''
schemeId: ''
modifierUserName: ''
createTime: ''
organId: ''
id: 0
fileType: ''
fileId: ''
financingAuditTime: ''
logisticsAddress: ''
creatorUserName: ''
creatorId: ''
receiverCityCode: ''
shopName: ''
schemeId: ''
customerCity: ''
expectPositionId: 0
batchId: 0
expectPositionCode: ''
submitUserName: ''
orderSuit: 0
outsourcingButtonStatus: 0
organDealerName: ''
placeTypeDictVal: ''
priceAuditStatus: 0
shopOrderRemark: ''
organDealerAreaCode: ''
orderSource: ''
acceptUserId: ''
customSaleOrderNo: ''
amountWaitPayment: 0
calculateDeliveryDate: ''
receiverName: ''
factoryOrderSchemeId: 0
receiverArea: ''
submitUserRealName: ''
designerName: ''
flowNodeCode: ''
rebatePrice: 0
shopOrderSubmitTime: ''
category: ''
prevFlowNodeId: 0
nextFlowNodeCode: ''
payStatus: 0
productionTime: ''
appointedBomUserId: ''
remarks: ''
success: false
'401':
description: access_token 缺失或已过期 / missing or expired access_token
/api/factoryOrderOp/getFactoryOrderListNew:
post:
operationId: apiFactoryOrderOpGetFactoryOrderListNew
summary: 获取销售单ID工厂订单列表(新)
tags:
- AIMES
x-source-documentation: https://dev.3vjia.com/document?apiId=878283231269658737
x-documentation-category: AIMES系统 / 订单数据 / 工厂单
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
orderID:
type: integer
format: int64
description: 销售订单ID
example:
orderID: 0
responses:
'200':
description: 成功 / OK
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
description: 请求是否成功 / whether the call succeeded
code:
type: integer
description: 结果码 / result code (0 = success)
msg:
type: string
description: 提示信息 / message
data:
type: object
properties:
acceptTime:
type: string
format: date-time
description: 接单时间
acceptUserId:
type: string
description: 接单人用户ID
acceptUserRealName:
type: string
description: 接单人
addAmount:
type: number
format: bigdecimal
description: 附加费用金额
amountConfirm:
type: number
format: bigdecimal
description: 已确认金额
amountNotConfirm:
type: number
format: bigdecimal
description: 待确认金额
amountWaitPayment:
type: number
format: bigdecimal
description: 未付金额
appointedBomUserId:
type: string
description: 指定的拆单人用户ID
appointedBomUserRealName:
type: string
description: 指定的拆单人姓名
areaUsage:
type: number
format: bigdecimal
description: 面积用量
assignBomTime:
type: string
format: date-time
description: 分配拆单人时间
assignBomUserId:
type: string
description: 分配拆单人用户ID
assignBomUserRealName:
type: string
description: 分配拆单人姓名
autoSplitRemark:
type: string
description: 自动拆单备注
autoSplitStatus:
type: integer
format: int32
description: 自动拆单状态,0-非自动拆单,1-自动拆单中,2-自动拆单结束
autoSplitStatusDesc:
type: string
description: 自动拆单状态
autoSplitTaskStatus:
type: integer
format: int32
description: 自动拆单任务状态
autoSplitTaskStatusDesc:
type: string
description: 自动拆单任务状态
basicMaterial:
type: string
description: 主颜色
batchId:
type: integer
format: int64
description: 批次Id
batchNo:
type: string
description: 批次号
bomDetectionResult:
type: string
description: 拆单检测结果url地址
bomTime:
type: string
format: date-time
description: 拆单时间
bomUserId:
type: string
description: 拆单人用户ID
bomUserRealName:
type: string
description: 拆单人
branchStoreId:
type: string
description: 分店ID
cabinetNo:
type: string
description: 樘号
calculateDeliveryDate:
type: string
format: date
description: 交货期推算日期
category:
type: string
description: 订单类别
chargebackName:
type: string
description: 退回人
chargebackReason:
type: string
description: 退回原因
chargebackStatus:
type: integer
format: int32
description: 退单状态:0-正常;1-接单回退;2-拆单回退
chargebackStatusDesc:
type: string
description: 退回状态描述
chargebackTime:
type: string
format: date-time
description: 退回时间
color1:
type: string
description: 颜色1
color1Area:
type: number
format: bigdecimal
description: 颜色1面积
color2:
type: string
description: 颜色2
color2Area:
type: number
format: bigdecimal
description: 颜色2面积
color3:
type: string
description: 颜色3
color3Area:
type: number
format: bigdecimal
description: 颜色3面积
color4:
type: string
description: 颜色4
color4Area:
type: number
format: bigdecimal
description: 颜色4面积
color5:
type: string
description: 颜色5
color5Area:
type: number
format: bigdecimal
description: 颜色5面积
contractNo:
type: string
description: 合同编号
createBatchProgress:
type: string
description: 是否全部生成批次:0-未生成;1-部分生成;2-已全部生成
createOrderUserName:
type: string
createTime:
type: string
format: date-time
description: 创建时间
creatorId:
type: string
description: 创建人id
creatorUserName:
type: string
description: 创建人用户名
customMaterial:
type: string
description: 改色颜色
customOrderItemNo:
type: string
description: 外部销售订单行号
customOrderNo:
type: string
description: 自定义单号
customParameters:
type: string
description: 自定义参数
customSaleOrderNo:
type: string
description: 外部销售订单号
customerAddress:
type: string
description: 业主地址街道
customerArea:
type: string
description: 业主地址区
customerAreaCode:
type: string
description: 业主地址区行政编号
customerCity:
type: string
description: 业主地址市
customerCityCode:
type: string
description: 业主地址市行政编号
customerGender:
type: integer
format: int32
description: 业主性别 (0-未填;1-女;2-男)
customerId:
type: string
description: 业主ID
customerName:
type: string
description: 业主名称
customerPhone:
type: string
description: 业主电话
customerPostcode:
type: string
description: 业主地址邮政编号
customerProvince:
type: string
description: 业主地址省
customerProvinceCode:
type: string
description: 业主地址省行政编号
deliveryContact:
type: string
description: 发货人联系方式
deliveryDate:
type: string
format: date
description: 预交货时间
deliveryPeriod:
type: integer
format: int32
description: 交货周期
deliveryPerson:
type: string
description: 发货人
deliveryQuantity:
type: integer
format: int32
description: 发货件数
deliveryStatus:
type: integer
format: int32
description: 发货状态,1-未发货,2-部分发货,3-已发货
deliveryTime:
type: string
format: date-time
description: 发货时间
deptId:
type: string
description: 创建人部门ID
designerName:
type: string
description: 设计师
designerPhone:
type: string
description: 设计师电话
discountBeforePrice:
type: number
format: bigdecimal
description: 折前金额
discountCoefficient:
type: number
format: bigdecimal
description: 折扣系数
doorWindowType:
type: integer
format: int32
description: 整木类型,1-板式 2-实木
expectPositionCode:
type: string
description: 预分配库位
expectPositionId:
type: integer
format: int64
description: 预分配库位id
externalContractCode:
type: string
description: 外部合同号
externalProjectId:
type: string
description: 外部项目ID
factoryAuditOperator:
type: string
description: 工厂审核人
factoryAuditStatus:
type: integer
format: int32
description: 生产审核状态
factoryAuditStatusDesc:
type: string
description: 生产审核状态
factoryAuditTime:
type: string
format: date-time
description: 工厂审核时间
factoryBaseId:
type: integer
format: int64
description: '''工厂基地id'
factoryBaseName:
type: string
description: '''工厂基地名称'
factoryId:
type: string
description: 下发的工厂ID
factoryOrderSchemeId:
type: integer
format: int64
description: 工厂订单方案id
financingAuditTime:
type: string
format: date-time
description: 财务审核时间
financingAuditUserId:
type: string
description: 财务审核人用户ID
financingAuditUserRealName:
type: string
description: 财务审核人
flowCode:
type: string
description: 订单流程Code
flowIconName:
type: string
description: 流程图标名称
flowId:
type: integer
format: int64
description: 订单流程ID
flowNodeCode:
type: string
description: 流程节点Code
flowNodeId:
type: integer
format: int64
description: 流程节点ID
flowNodeStatusName:
type: string
description: 流程节点状态名称
flowNodeTodoName:
type: string
description: 流程节点待办名称
fullSet1:
type: integer
format: int32
description: 齐套1:0-显示“-”,1-齐套1完成
fullSet2:
type: integer
format: int32
description: 齐套2:0-显示“-”,1-齐套2完成
globallyUniqueId:
type: string
description: 全局唯一id
id:
type: integer
format: int64
description: 主键id
installPosition:
type: string
description: 安装位置
invalidOperateTime:
type: string
format: date-time
description: 作废操作时间
invalidOperateUserId:
type: string
description: 作废操作人ID
invalidOperateUserRealName:
type: string
description: 作废操作人名字
isAgainSubmit:
type: integer
format: int32
description: 是否重新提交:0-否,1-是
isBomStatus:
type: integer
format: int32
description: 3D拆单状态(0:拆单中,1已拆单)
isCanChange:
type: integer
format: int32
description: 是否可以改单,0-否,1-是
isCanGoBack:
type: integer
format: int32
description: 是否可退回:0-不可退回 1-可退回
isChangeOrder:
type: integer
format: int32
description: 是否改单
isCustomColor:
type: integer
format: int32
description: 是否改色
isDesignDrawing:
type: integer
format: int32
description: 是否设计出图进行分配:1-是;0-否
isDownLoad:
type: boolean
description: 3D审核列表是否有下载附件
isEngineeringOrder:
type: integer
format: int32
description: 是否工程单(0否,1是)
isFactoryAuditBack:
type: integer
format: int32
description: 工厂审核是否退回 0=否 1=是,默认1
isFactoryOrderAll:
type: integer
format: int32
description: 工厂单齐套,0否,1是
isFactoryQuote:
type: integer
format: int32
description: 工厂是否报价,0-否,1-是,用来判断节点是否在报价之后
isHandOperater:
type: integer
format: int32
description: 是否手动操作改变生产/入库/发货状态;0-否;1-是
isHandOperaterDelivery:
type: integer
format: int32
description: 是否手动操作改变发货;0-否;1-是
isHandOperaterWarehouse:
type: integer
format: int32
description: 是否手动操作改变入库;0-否;1-是
isHavedPack:
type: boolean
description: 是否已包装
isNoUpdateFactoryOrderProductRemarks:
type: boolean
description: 是否不更新工厂订单产品备注
isOutsourcing:
type: integer
format: int32
description: 是否委外(0:否,1:是)
isSaleOrderAll:
type: integer
format: int32
description: 销售单齐套 0否,1是
isSplitCollaborate:
type: integer
format: int32
description: 是否拆单协作(0:否,1:是)
isSuspend:
type: integer
format: int32
description: 是否暂停,0-否,1-是
isTableBoard:
type: integer
format: int32
description: 是否有台面板(0:否,1:是)
isTempOrder:
type: integer
format: int32
description: 是否临时单(0:否,1:是)
isUrgent:
type: integer
format: int32
description: 是否加急
isValid:
type: integer
format: int32
description: 是否作废:0=否, 1=是
logisticsAddress:
type: string
description: 物流信息地址
material:
type: string
description: 主材
modifierUserName:
type: string
description: 更新人用户名
moduleCode:
type: string
description: 模块代码 cupboard 橱柜,wardrobe 衣柜,systemCabinet 系统柜,furnitureType 成品,ceilingAll 顶墙,doorWindow 门窗,bathRoom 淋浴房,aluminum 铝门窗
moduleName:
type: string
description: 模块名称 橱柜,衣柜,系统柜,成品,顶墙,门窗,淋浴房,铝门窗
natureOfOrder:
type: string
description: 订单性质
nextFlowNodeCode:
type: string
description: 下一个流程节点Code
nextFlowNodeId:
type: integer
format: int64
description: 下一个流程节点ID
orderCategoryDictKey:
type: string
description: 订单品类字典Key
orderCategoryDictVal:
type: string
description: 订单品类字典Value
orderCode:
type: string
description: 订单编号
orderName:
type: string
description: 订单名称
orderRebateAmount:
type: number
format: bigdecimal
description: 分摊返利金额
orderSource:
type: string
description: 订单来源(默认mes,金牌:jinp)
orderSuit:
type: integer
format: int32
description: 订单套数(默认1,最大999)
orderTypeCode:
type: string
description: 订单类型
orderTypeDictKey:
type: string
description: 订单类型字典Key
orderTypeDictVal:
type: string
description: 订单类型字典Value
orderTypeName:
type: string
description: 订单类型名称
organDealerAreaCode:
type: string
description: 企业经销商归属区域编码
organDealerAreaName:
type: string
description: 企业经销商归属区域名称
organDealerCode:
type: string
description: 企业经销商编号
organDealerId:
type: integer
format: int64
description: 企业经销商Id
organDealerName:
type: string
description: 企业经销商名称
organId:
type: string
description: 机构ID
originalAmount:
type: number
format: bigdecimal
description: 产品原价格(JSON赋值)不可修改
outsourcingButtonStatus:
type: integer
format: int32
description: 外购板件是否MPM扫描包装按钮状态,0-不显示,1-可编辑,2-不可编辑
outsourcingPartMpmPacking:
type: integer
format: int32
description: 外购板件是否MPM扫描包装,0-否,1-是'
packageAuditStatus:
type: integer
format: int32
description: 分包审核状态,0-待审核,1-已审核
payStatus:
type: integer
format: int32
description: 支付状态(0=待付款; 1=未结清; 2=已结清)
payTime:
type: string
format: date-time
description: 订单支付时间
payWay:
type: string
description: 支付方式code
payWayName:
type: string
description: 支付方式名称
payableAmount:
type: number
format: bigdecimal
description: 订单报价后应付金额(支付价)
placeTypeDictKey:
type: string
description: 下单类型字典Key
placeTypeDictVal:
type: string
description: 下单类型字典Value
planDeliveryDate:
type: string
format: date
description: 计划工厂交货日期,财务审核后基于规则计算得出
preAuditOperator:
type: string
description: 预订单审核人
preAuditTime:
type: string
format: date-time
description: 预订单审核时间
preDistributionQuoterTime:
type: string
format: date
description: 预报价员分配时间
preOrderAuditRemark:
type: string
description: 预订单审核备注
preOrderAuditStatus:
type: integer
format: int32
description: 预订单审核状态(0:待审核;1:已审核 ,2:审核拒绝)
preQuoterName:
type: string
description: 预报价员名称
preQuoterUserId:
type: string
description: 预报价员ID
prevFlowNodeId:
type: integer
format: int64
description: 前一个流程节点ID,主要用于回退
priceAuditAmounts:
type: number
format: bigdecimal
description: 价格审核总金额
priceAuditOperator:
type: string
description: 价格审核人
priceAuditStatus:
type: integer
format: int32
description: 价格审核状态
priceAuditStatusDesc:
type: string
description: 价格审核状态
priceAuditTime:
type: string
format: date-time
description: 价格审核时间
pricingMethod:
type: string
description: 取价方式
productQty:
type: integer
format: int32
productTotalPrice:
type: number
format: bigdecimal
description: 产品总价
productionAmount:
type: number
format: bigdecimal
description: 产品金额
productionDataCreateStatus:
type: integer
format: int32
description: 创建生产订单状态 0-未生成;1-生成中;2-生成成功;3-生成失败
productionLine:
type: string
description: 生产线
productionSize:
type: string
description: 尺寸
productionSystem:
type: string
description: 订单生产的生产系统:oms=oms自带合批排产, aps=使用aps系统排产生产
productionTime:
type: string
format: date-time
description: 生产时间
projectId:
type: string
description: 项目id
projectName:
type: string
description: 项目名称
quoteJsonUrl:
type: string
description: 报价jsonURL
quoteTime:
type: string
format: date-time
description: 报价时间
rebateBillSettlementAmount:
type: number
format: bigdecimal
description: 返利结算金额
rebatePrice:
type: number
format: bigdecimal
description: 返利金额
rebatesSettlementAmount:
type: number
format: bigdecimal
description: 返点结算金额
receiverAddress:
type: string
description: 收货人地址街道
receiverArea:
type: string
description: 收货人地址区
receiverAreaCode:
type: string
description: 收货人地址区行政编号
receiverCity:
type: string
description: 收货人地址市
receiverCityCode:
type: string
description: 收货人地址市行政编号
receiverGender:
type: integer
format: int32
description: 收货人性别 (0-未填;1-女;2-男)
receiverName:
type: string
description: 收货人姓名
receiverPhone:
type: string
description: 收货人电话
receiverPostcode:
type: string
description: 收货人地址邮编
receiverProvince:
type: string
description: 收货人地址省
receiverProvinceCode:
type: string
description: 收货人地址省行政编号
receiverType:
type: string
description: 收货人类型 customer=业主 shop=门店
receivingRemarks:
type: string
description: 企业解析备注
receivingStatus:
type: string
description: 企业解析状态
relateFactoryOrderCode:
type: string
description: 关联工厂单编号
relateFactoryOrderId:
type: integer
format: int64
description: 关联工厂单ID
remarks:
type: string
description: 3D下单备注
roomName:
type: string
description: 空间名称
saleOrderCode:
type: string
description: 售后子订单编号
saleOrderId:
type: integer
format: int64
description: 售后子订单ID
salesName:
type: string
description: 销售
salesPrice:
type: number
format: bigdecimal
description: 销售价
salesQuoteJsonUrl:
type: string
description: 销售价报价json
schemeId:
type: string
description: 3D方案号
schemeName:
type: string
description: 方案名称
schemePreviewImage:
type: string
description: 方案预览图
schemeRemark:
type: string
description: 方案备注
schemeVersion:
type: string
description: 方案版本号
serialNumber:
type: string
description: 序号01-999
settlementAmount:
type: number
format: bigdecimal
description: 结算金额
shipmentType:
type: string
description: 出货类型
shopAuditOperator:
type: string
description: 门店审核人
shopAuditStatus:
type: integer
format: int32
description: 门店审核状态
shopAuditStatusDesc:
type: string
description: 门店审核状态
shopAuditTime:
type: string
format: date-time
description: 门店审核时间
shopCode:
type: string
description: 门店编码
shopDeptId:
type: string
description: 经销商所在部门id
shopId:
type: string
description: 经销商ID
shopName:
type: string
description: 经销商名称
shopOrderCode:
type: string
description: 门店订单Code
shopOrderId:
type: integer
format: int64
description: 门店订单ID
shopOrderName:
type: string
description: 销售订单名称
shopOrderRemark:
type: string
description: 门店订单备注
shopOrderSubmitTime:
type: string
format: date-time
description: 店铺订单提交时间
shoppingCartId:
type: integer
format: int64
description: 购物车id
splitNum:
type: integer
format: int32
description: 拆单次数
splitOrderImage:
type: string
description: 拆单主图
splitStatus:
type: integer
format: int32
description: 拆单状态:-1-退回;0-未拆单;1-拆单中;2-已拆单
splitXmlUrl:
type: string
description: 拆单方案xml路径
submitUserId:
type: string
description: 店铺订单提交人用户ID
submitUserName:
type: string
description: 店铺订单提交人账号
submitUserPhone:
type: string
description: 店铺订单提交人手机号码
submitUserRealName:
type: string
description: 店铺订单提交人用户姓名
surcharge:
type: number
format: bigdecimal
description: 附加费用
suspendTime:
type: string
format: date-time
description: 订单暂停时间
suspendUserId:
type: string
description: 订单暂停人用户ID
suspendUserRealName:
type: string
description: 订单暂停人姓名
systemEnvironment:
type: string
taxCategory:
type: string
description: 税种
totalArea:
type: number
format: bigdecimal
description: 展开面积(平米)
totalPrice:
type: number
format: bigdecimal
description: 订单总价(原价)
tradePrice:
type: number
format: bigdecimal
description: 交易单价
unitCategoryName:
type: string
description: 商品品类名称
urlParam:
type: string
description: 外部参数
validReason:
type: string
description: 作废原因
warehousingTime:
type: string
format: date-time
description: 入库时间
workOrderNo:
type: string
description: 外部工单号
required:
- createTime
- id
example:
msg: ''
code: 0
data:
- customerPostcode: ''
financingAuditUserRealName: ''
productionDataCreateStatus: 0
customMaterial: ''
salesPrice: 0
color5: ''
basicMaterial: ''
color3: ''
color4: ''
color1: ''
color2: ''
color2Area: 0
rebateBillSettlementAmount: 0
receiverPhone: ''
isFactoryOrderAll: 0
isOutsourcing: 0
chargebackTime: ''
customerAreaCode: ''
isEngineeringOrder: 0
rebatesSettlementAmount: 0
deliveryContact: ''
customerProvinceCode: ''
externalContractCode: ''
placeTypeDictKey: ''
isFactoryQuote: 0
orderRebateAmount: 0
customerAddress: ''
financingAuditUserId: ''
designerPhone: ''
relateFactoryOrderId: 0
deptId: ''
orderTypeDictVal: ''
customerArea: ''
customerName: ''
isDownLoad: false
splitStatus: 0
warehousingTime: ''
unitCategoryName: ''
flowNodeTodoName: ''
assignBomTime: ''
invalidOperateTime: ''
deliveryStatus: 0
schemePreviewImage: ''
priceAuditOperator: ''
chargebackStatus: 0
payWayName: ''
deliveryTime: ''
preAuditOperator: ''
relateFactoryOrderCode: ''
priceAuditAmounts: 0
factoryAuditStatus: 0
saleOrderId: 0
acceptUserRealName: ''
bomUserId: ''
payableAmount: 0
customOrderNo: ''
shipmentType: ''
autoSplitTaskStatusDesc: ''
splitXmlUrl: ''
isHavedPack: false
autoSplitStatusDesc: ''
customerId: ''
receivingRemarks: ''
factoryBaseId: 0
workOrderNo: ''
isSaleOrderAll: 0
orderName: ''
shopOrderCode: ''
autoSplitRemark: ''
moduleCode: ''
areaUsage: 0
priceAuditTime: ''
isNoUpdateFactoryOrderProductRemarks: false
fullSet2: 0
fullSet1: 0
cabinetNo: ''
orderTypeName: ''
organDealerCode: ''
salesQuoteJsonUrl: ''
validReason: ''
createTime: ''
customParameters: ''
organDealerAreaName: ''
totalArea: 0
isHandOperaterDelivery: 0
productionSize: ''
isCanGoBack: 0
isBomStatus: 0
payTime: ''
isHandOperater: 0
suspendUserId: ''
receiverProvince: ''
shoppingCartId: 0
autoSplitStatus: 0
preDistributionQuoterTime: ''
customOrderItemNo: ''
systemEnvironment: ''
productionLine: ''
shopId: ''
isCustomColor: 0
preAuditTime: ''
isDesignDrawing: 0
isTableBoard: 0
batchNo: ''
serialNumber: ''
flowNodeId: 0
shopAuditStatus: 0
color5Area: 0
addAmount: 0
schemeName: ''
flowNodeStatusName: ''
isAgainSubmit: 0
receiverAddress: ''
factoryAuditTime: ''
salesName: ''
preOrderAuditRemark: ''
projectName: ''
projectId: ''
tradePrice: 0
doorWindowType: 0
isSuspend: 0
preQuoterName: ''
receiverGender: 0
appointedBomUserRealName: ''
isHandOperaterWarehouse: 0
createBatchProgress: ''
shopOrderName: ''
orderCategoryDictVal: ''
flowCode: ''
natureOfOrder: ''
deliveryQuantity: 0
flowId: 0
color1Area: 0
packageAuditStatus: 0
shopAuditOperator: ''
outsourcingPartMpmPacking: 0
suspendTime: ''
orderTypeDictKey: ''
schemeVersion: ''
quoteJsonUrl: ''
quoteTime: ''
material: ''
originalAmount: 0
productionAmount: 0
orderCode: ''
invalidOperateUserId: ''
receiverProvinceCode: ''
schemeRemark: ''
surcharge: 0
pricingMethod: ''
isFactoryAuditBack: 0
moduleName: ''
receiverCity: ''
urlParam: ''
orderCategoryDictKey: ''
receiverAreaCode: ''
amountConfirm: 0
chargebackReason: ''
assignBomUserId: ''
bomTime: ''
isTempOrder: 0
id: 0
autoSplitTaskStatus: 0
shopDeptId: ''
deliveryPerson: ''
factoryId: ''
splitNum: 0
isSplitCollaborate: 0
acceptTime: ''
receiverPostcode: ''
organDealerId: 0
color4Area: 0
factoryBaseName: ''
flowIconName: ''
shopOrderId: 0
receiverType: ''
externalProjectId: ''
organId: ''
nextFlowNodeId: 0
productQty: 0
isUrgent: 0
factoryAuditStatusDesc: ''
totalPrice: 0
contractNo: ''
priceAuditStatusDesc: ''
customerPhone: ''
customerCityCode: ''
amountNotConfirm: 0
invalidOperateUserRealName: ''
deliveryDate: ''
globallyUniqueId: ''
saleOrderCode: ''
shopCode: ''
customerGender: 0
isValid: 0
preQuoterUserId: ''
discountCoefficient: 0
splitOrderImage: ''
installPosition: ''
modifierUserName: ''
assignBomUserRealName: ''
settlementAmount: 0
isChangeOrder: 0
orderTypeCode: ''
color3Area: 0
productTotalPrice: 0
payWay: ''
branchStoreId: ''
submitUserPhone: ''
shopAuditStatusDesc: ''
createOrderUserName: ''
factoryAuditOperator: ''
deliveryPeriod: 0
productionSystem: ''
bomUserRealName: ''
customerProvince: ''
planDeliveryDate: ''
roomName: ''
preOrderAuditStatus: 0
submitUserId: ''
taxCategory: ''
shopAuditTime: ''
suspendUserRealName: ''
discountBeforePrice: 0
receivingStatus: ''
isCanChange: 0
financingAuditTime: ''
logisticsAddress: ''
creatorUserName: ''
bomDetectionResult: ''
creatorId: ''
receiverCityCode: ''
shopName: ''
schemeId: ''
customerCity: ''
expectPositionId: 0
batchId: 0
expectPositionCode: ''
submitUserName: ''
orderSuit: 0
outsourcingButtonStatus: 0
organDealerName: ''
placeTypeDictVal: ''
priceAuditStatus: 0
shopOrderRemark: ''
organDealerAreaCode: ''
chargebackName: ''
orderSource: ''
acceptUserId: ''
customSaleOrderNo: ''
amountWaitPayment: 0
calculateDeliveryDate: ''
receiverName: ''
factoryOrderSchemeId: 0
receiverArea: ''
submitUserRealName: ''
designerName: ''
flowNodeCode: ''
rebatePrice: 0
shopOrderSubmitTime: ''
category: ''
prevFlowNodeId: 0
chargebackStatusDesc: ''
nextFlowNodeCode: ''
payStatus: 0
productionTime: ''
appointedBomUserId: ''
remarks: ''
success: false
'401':
description: access_token 缺失或已过期 / missing or expired access_token
/api/factoryOrderOp/getShopOrderByContractNo:
post:
operationId: apiFactoryOrderOpGetShopOrderByContractNo
summary: 根据合同号获取销售单信息
tags:
- AIMES
x-source-documentation: https://dev.3vjia.com/document?apiId=694502000112586852
x-documentation-category: AIMES系统 / 订单数据 / 销售单
description: |-
根据合同号获取销售单信息
销售合同为必填数据
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
contractNo:
type: string
description: 合同号
example:
contractNo: ''
responses:
'200':
description: 成功 / OK
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
description: 请求是否成功 / whether the call succeeded
code:
type: integer
description: 结果码 / result code (0 = success)
msg:
type: string
description: 提示信息 / message
data:
type: object
properties:
acceptTime:
type: string
format: date-time
description: 接单时间
acceptUserId:
type: string
description: 接单人用户ID
acceptUserRealName:
type: string
description: 接单人
batchDeliveryStatusCode:
type: string
description: 批发货状态编码
batchDeliveryStatusName:
type: string
description: 批发货状态名称
batchDeliveryTime:
type: string
format: date-time
description: 批发货审批时间
billId:
type: string
description: 账单ID
billNumber:
type: string
description: 账单编号
branchStoreId:
type: string
description: 分店ID
brandCode:
type: string
description: 品牌编号
brandName:
type: string
description: 品牌名称
contractNo:
type: string
description: 合同编号
createTime:
type: string
format: date-time
description: 创建时间
creatorId:
type: string
description: 创建人id
creatorUserName:
type: string
description: 创建人用户名
creatorUserRealName:
type: string
description: 创建人姓名
customOrderNo:
type: string
description: 自定义单号
customerAddress:
type: string
description: 业主地址街道
customerArea:
type: string
description: 业主地址区
customerAreaCode:
type: string
description: 业主地址区行政编号
customerCity:
type: string
description: 业主地址市
customerCityCode:
type: string
description: 业主地址市行政编号
customerGender:
type: integer
format: int32
description: 业主性别 (0-未填;1-女;2-男)
customerId:
type: string
description: 业主ID
customerName:
type: string
description: 业主姓名
customerPhone:
type: string
description: 业主电话
customerPostcode:
type: string
description: 业主地址邮政编号
customerProvince:
type: string
description: 业主地址省
customerProvinceCode:
type: string
description: 业主地址省行政编号
dealerTypeCode:
type: string
description: 企业经销商类型编码
dealerTypeName:
type: string
description: 企业经销商类型名称
deliveryDate:
type: string
format: date
description: 预交货时间
deliveryPeriod:
type: integer
format: int32
description: 交货周期
deptId:
type: string
description: 创建人部门ID
designUserId:
type: string
description: 设计师用户ID
externalProjectId:
type: string
description: 外部项目ID
factoryAuditTime:
type: string
format: date-time
description: 生产审核时间
factoryBaseId:
type: integer
format: int64
description: '''工厂基地id'
factoryBaseName:
type: string
description: '''工厂基地名称'
financingAuditTime:
type: string
format: date-time
description: 财务审核时间
hasReturnScheme:
type: string
description: 方案是否退回
id:
type: integer
format: int64
description: 主键id
installerTaskId:
type: string
description: 安装任务id
isBack:
type: integer
format: int32
description: 销售单退回 是否退回,0:否;1:是
isPush:
type: integer
format: int32
description: 是否推送成功(0:否,1:是)
isSettlement:
type: integer
format: int32
description: 是否结清(0:未结清,1已结清)
isValid:
type: integer
format: int32
description: 是否作废(0:否,1:是)
logisticsAddress:
type: string
description: 物流信息地址
modifierUserName:
type: string
description: 更新人用户名
natureOfOrder:
type: string
description: 订单性质
orderCategoryDictKey:
type: string
description: 订单品类字典Key
orderCategoryDictVal:
type: string
description: 订单品类字典Value
orderCode:
type: string
description: 订单编号
orderName:
type: string
description: 订单名称
orderSource:
type: string
description: 订单来源(默认mes,金牌:jinp)
orderSuit:
type: integer
format: int32
description: 订单套数(默认1,最大999)
orderTypeDictKey:
type: string
description: 订单类型字典Key
orderTypeDictVal:
type: string
description: 订单类型字典Value
organDealerAreaCode:
type: string
description: 企业经销商归属区域编码
organDealerCode:
type: string
description: 企业经销商编号
organDealerId:
type: integer
format: int64
description: 企业经销商Id
organDealerName:
type: string
description: 企业经销商名称
organId:
type: string
description: 机构ID
placeTypeDictKey:
type: string
description: 下单类型字典Key
placeTypeDictVal:
type: string
description: 下单类型字典Value
pricingMethod:
type: string
description: 取价方式
pricingRemarks:
type: string
description: 核价备注
productionLine:
type: string
description: 生产线
projectId:
type: string
description: 项目ID
pushDateTime:
type: string
format: date-time
description: 推送时间
pushOperatorId:
type: string
description: 推送人
pushStatus:
type: string
description: 推送状态
receiverAddress:
type: string
description: 收货人地址街道
receiverArea:
type: string
description: 收货人地址区
receiverAreaCode:
type: string
description: 收货人地址区行政编号
receiverCity:
type: string
description: 收货人地址市
receiverCityCode:
type: string
description: 收货人地址市行政编号
receiverGender:
type: integer
format: int32
description: 收货人性别 (0-未填;1-女;2-男)
receiverName:
type: string
description: 收货人姓名
receiverPhone:
type: string
description: 收货人电话
receiverPostcode:
type: string
description: 收货人地址邮政编号
receiverProvince:
type: string
description: 收货人地址省
receiverProvinceCode:
type: string
description: 收货人地址省行政编号
receiverType:
type: string
description: 收货人类型 customer=业主 shop=门店
relatedOrderCode:
type: string
description: 关联订单号
relatedOrderId:
type: integer
format: int64
description: 关联订单ID
relatedOrderName:
type: string
description: 关联订单名称
remark:
type: string
description: 订单备注
salesName:
type: string
description: 销售
schemeId:
type: string
description: 3D方案号
schemeName:
type: string
description: 方案名称
shipmentType:
type: string
description: 出货类型
shopDeptId:
type: string
description: 门店ID也是经销商ID
shopId:
type: string
description: 经销商ID
shopName:
type: string
description: 经销商名称
signedName:
type: string
description: 签收人姓名
signedUserId:
type: string
description: 签收人ID
statusCode:
type: string
description: 订单状态编码
statusName:
type: string
description: 订单状态名称
statusTodoName:
type: string
description: 订单状态待办名称
submitTime:
type: string
format: date-time
description: 订单提交到工厂的时间(下单时间)
submitUserId:
type: string
description: 店铺订单提交人用户ID(下单人ID)
submitUserRealName:
type: string
description: 店铺订单提交人用户姓名(下单人)
taxCategory:
type: string
description: 税种
totalArea:
type: number
format: bigdecimal
description: 展开面积
totalPrice:
type: number
format: bigdecimal
description: 订单预估价格
required:
- createTime
- id
example:
msg: ''
code: 0
data:
customerPostcode: ''
dealerTypeName: ''
pricingMethod: ''
receiverCity: ''
orderCategoryDictKey: ''
receiverAreaCode: ''
batchDeliveryTime: ''
receiverPhone: ''
customerAreaCode: ''
customerProvinceCode: ''
placeTypeDictKey: ''
id: 0
brandCode: ''
customerAddress: ''
isSettlement: 0
shopDeptId: ''
acceptTime: ''
batchDeliveryStatusCode: ''
deptId: ''
orderTypeDictVal: ''
customerArea: ''
receiverPostcode: ''
pushOperatorId: ''
customerName: ''
relatedOrderName: ''
organDealerId: 0
submitTime: ''
factoryBaseName: ''
receiverType: ''
externalProjectId: ''
organId: ''
billNumber: ''
statusCode: ''
batchDeliveryStatusName: ''
installerTaskId: ''
totalPrice: 0
contractNo: ''
relatedOrderCode: ''
acceptUserRealName: ''
customOrderNo: ''
shipmentType: ''
creatorUserRealName: ''
customerPhone: ''
signedName: ''
customerCityCode: ''
customerId: ''
pricingRemarks: ''
statusName: ''
factoryBaseId: 0
deliveryDate: ''
orderName: ''
designUserId: ''
signedUserId: ''
customerGender: 0
isValid: 0
pushDateTime: ''
organDealerCode: ''
modifierUserName: ''
createTime: ''
totalArea: 0
receiverProvince: ''
branchStoreId: ''
isBack: 0
dealerTypeCode: ''
productionLine: ''
deliveryPeriod: 0
shopId: ''
hasReturnScheme: ''
brandName: ''
customerProvince: ''
schemeName: ''
submitUserId: ''
taxCategory: ''
receiverAddress: ''
factoryAuditTime: ''
salesName: ''
billId: ''
projectId: ''
financingAuditTime: ''
isPush: 0
logisticsAddress: ''
creatorUserName: ''
receiverGender: 0
creatorId: ''
receiverCityCode: ''
shopName: ''
remark: ''
schemeId: ''
customerCity: ''
relatedOrderId: 0
orderCategoryDictVal: ''
orderSuit: 0
natureOfOrder: ''
statusTodoName: ''
organDealerName: ''
placeTypeDictVal: ''
organDealerAreaCode: ''
orderSource: ''
acceptUserId: ''
pushStatus: ''
receiverName: ''
receiverArea: ''
orderTypeDictKey: ''
submitUserRealName: ''
orderCode: ''
receiverProvinceCode: ''
success: false
'401':
description: access_token 缺失或已过期 / missing or expired access_token
/api/factoryOrderOp/invalidateFactoryOrdersBySaleOrder:
post:
operationId: apiFactoryOrderOpInvalidateFactoryOrdersBySaleOrder
summary: 按销售单作废全部关联工厂单
tags:
- Dedicated Services
x-source-documentation: https://dev.3vjia.com/document?apiId=878215050547052614
x-documentation-category: 专属服务 / C13044572
description: 该接口允许作废销售单下已完成的工厂单,但若工厂单中已有已退回订单,则作废失败。
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
reason:
type: string
description: 作废原因,最大255个字符
saleOrderId:
type: integer
format: int64
description: 销售单ID
required:
- reason
- saleOrderId
example:
reason: ''
saleOrderId: 0
responses:
'200':
description: 成功 / OK
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
description: 请求是否成功 / whether the call succeeded
code:
type: integer
description: 结果码 / result code (0 = success)
msg:
type: string
description: 提示信息 / message
data:
type: object
properties:
invalidated:
type: integer
format: int32
description: 本次作废数量
skipped:
type: integer
format: int32
description: 已作废跳过数量
total:
type: integer
format: int32
description: 关联工厂单总数
example:
msg: ''
code: 0
data:
skipped: 0
total: 0
invalidated: 0
success: false
'401':
description: access_token 缺失或已过期 / missing or expired access_token
/api/factoryOrderOp/listShoppingCartBySchemeId:
post:
operationId: apiFactoryOrderOpListShoppingCartBySchemeId
summary: 通过方案ID查询购物车订单列表(全友)
tags:
- Dedicated Services
x-source-documentation: https://dev.3vjia.com/document?apiId=790979449532338237
x-documentation-category: 专属服务 / C11876880
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
schemeId:
type: string
description: 方案ID
example:
schemeId: ''
responses:
'200':
description: 成功 / OK
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
description: 请求是否成功 / whether the call succeeded
code:
type: integer
description: 结果码 / result code (0 = success)
msg:
type: string
description: 提示信息 / message
data:
type: object
properties:
bomXmlUrl:
type: string
description: 工厂订单BOM XML文件URL
buildingId:
type: string
description: 楼栋ID
buildingName:
type: string
description: 楼栋名称
channelId:
type: string
description: 渠道ID
channelName:
type: string
description: 渠道名称
communityId:
type: string
description: 小区ID
communityName:
type: string
description: 小区名称
confirmRemark:
type: string
description: 确认备注
createTime:
type: string
format: date-time
description: 创建时间
discountBeforePrice:
type: number
format: bigdecimal
description: 折前金额
doorWindowType:
type: integer
format: int32
description: 整木类型,1-板式,2-实木
floorId:
type: string
description: 楼层ID
floorName:
type: string
description: 楼层名称
id:
type: integer
format: int64
description: 主键id
imagepath:
type: string
description: 3D方案图片路径
installPosition:
type: string
description: 安装位置
isConfirm:
type: integer
format: int32
description: 是否确认
isDesignDrawing:
type: integer
format: int32
description: 是否设计出图进行分配:1-是;0-否
isEngineeringOrder:
type: integer
format: int32
description: 是否工程单(0否,1是)
isTempOrder:
type: integer
format: int32
description: 是否临时订单
material:
type: string
description: 主材
moduleCode:
type: string
description: 模块代码 cupboard 橱柜,wardrobe 衣柜,systemCabinet 系统柜,furnitureType 成品,ceilingAll 顶墙,doorWindow 门窗,bathRoom 淋浴房,aluminum 铝门窗
orderCategoryDictKey:
type: string
description: 订单品类Code
orderCategoryDictVal:
type: string
description: 订单品类
orderName:
type: string
description: 订单名称
orderSuit:
type: integer
format: int32
description: 订单套数(默认1,最大999)
productionSize:
type: string
description: 尺寸
projectId:
type: string
description: 项目id
remarks:
type: string
description: 备注
salesPrice:
type: number
format: bigdecimal
description: 销售价
schemeId:
type: string
description: 3D方案号
schemeName:
type: string
description: 3D方案名称
summaryRemarks:
type: string
description: 备注汇总
totalPrice:
type: number
format: bigdecimal
description: 订单总价(原价)
classificationList:
type: array
items:
type: object
properties:
classificationCode:
type: integer
format: int32
description: 库id
classificationName:
type: string
description: 库名称
qyChannel:
type: string
description: 渠道
description: 从属库
fdocumentStatus:
type: string
description: 购物车状态
flowNodeStatusName:
type: string
description: 当前订单状态节点名称
orderCode:
type: string
description: 订单编号
shoppingCartId:
type: integer
format: int64
description: 购物车id
reviewOrderName:
type: string
description: 审核单名称
required:
- id
example:
msg: ''
code: 0
data:
- bomXmlUrl: ''
productionSize: ''
totalPrice: 0
salesPrice: 0
schemeId: ''
shoppingCartId: 0
floorId: ''
orderCategoryDictKey: ''
orderCategoryDictVal: ''
orderSuit: 0
isConfirm: 0
isEngineeringOrder: 0
communityName: ''
isTempOrder: 0
floorName: ''
id: 0
communityId: ''
channelId: ''
isDesignDrawing: 0
orderName: ''
classificationList:
- classificationCode: 0
classificationName: ''
qyChannel: ''
moduleCode: ''
summaryRemarks: ''
confirmRemark: ''
schemeName: ''
flowNodeStatusName: ''
buildingId: ''
reviewOrderName: ''
fdocumentStatus: ''
buildingName: ''
installPosition: ''
discountBeforePrice: 0
imagepath: ''
material: ''
createTime: ''
channelName: ''
orderCode: ''
projectId: ''
remarks: ''
doorWindowType: 0
success: false
'401':
description: access_token 缺失或已过期 / missing or expired access_token
/api/factoryOrderOp/setAutoSplitOrderPriority:
post:
operationId: apiFactoryOrderOpSetAutoSplitOrderPriority
summary: 设置自动拆单优先级
tags:
- Dedicated Services
x-source-documentation: https://dev.3vjia.com/document?apiId=815251902123102324
x-documentation-category: 专属服务 / C11876880
description: 设置自动拆单优先级
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
extend1:
type: string
description: 扩展字段1
extend2:
type: string
description: 扩展字段2
extend3:
type: string
description: 扩展字段3
extend4:
type: string
description: 扩展字段4
extend5:
type: string
description: 扩展字段5
orderType:
type: string
description: 产品类型
productNo:
type: string
description: 产品编码(全友的订单号)
splitLevel:
type: string
description: 拆单优先级
splitType:
type: string
description: 拆单类别
example:
orderType: ''
splitLevel: ''
splitType: ''
extend3: ''
extend2: ''
extend5: ''
extend4: ''
extend1: ''
productNo: ''
responses:
'200':
description: 成功 / OK
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
description: 请求是否成功 / whether the call succeeded
code:
type: integer
description: 结果码 / result code (0 = success)
msg:
type: string
description: 提示信息 / message
data:
type: object
example:
msg: ''
code: 0
data: false
success: false
'401':
description: access_token 缺失或已过期 / missing or expired access_token
/api/factoryOrderOp/submitShopOrder:
post:
operationId: apiFactoryOrderOpSubmitShopOrder
summary: 订单状态变更
tags:
- Dedicated Services
x-source-documentation: https://dev.3vjia.com/document?apiId=790978206617456735
x-documentation-category: 专属服务 / C11876880
description: 下销售单
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
ids:
type: array
items: {}
description: 工厂订单IDS
example:
ids: []
responses:
'200':
description: 成功 / OK
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
description: 请求是否成功 / whether the call succeeded
code:
type: integer
description: 结果码 / result code (0 = success)
msg:
type: string
description: 提示信息 / message
data:
type: object
example:
msg: ''
code: 0
data: false
success: false
'401':
description: access_token 缺失或已过期 / missing or expired access_token
/api/factoryOrderOp/updateGlassWarehousingTime:
post:
operationId: apiFactoryOrderOpUpdateGlassWarehousingTime
summary: 更新工厂订单玻璃入库时间(铝门窗)
tags:
- AIMES
x-source-documentation: https://dev.3vjia.com/document?apiId=768143492676472917
x-documentation-category: AIMES系统 / 订单管理
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
glassWarehousingTime:
type: string
format: date-time
description: 玻璃入库时间(yyyy-mm-dd HH:MM:SS)
factoryOrderId:
type: integer
format: int64
description: 工厂单ID
required:
- glassWarehousingTime
- factoryOrderId
example:
factoryOrderId: 0
glassWarehousingTime: ''
responses:
'200':
description: 成功 / OK
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
description: 请求是否成功 / whether the call succeeded
code:
type: integer
description: 结果码 / result code (0 = success)
msg:
type: string
description: 提示信息 / message
data:
type: object
example:
msg: ''
code: 0
data: false
success: false
'401':
description: access_token 缺失或已过期 / missing or expired access_token
/api/factoryOrderXHXNew/getFactoryOrderDataOss:
post:
operationId: apiFactoryOrderXHXNewGetFactoryOrderDataOss
summary: 获取工厂订单数据
tags:
- Dedicated Services
x-source-documentation: https://dev.3vjia.com/document?apiId=857625361431810135
x-documentation-category: 专属服务 / C10506333
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
id:
type: integer
format: int64
description: 工厂订单id
required:
- id
example:
id: 0
responses:
'200':
description: 成功 / OK
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
description: 请求是否成功 / whether the call succeeded
code:
type: integer
description: 结果码 / result code (0 = success)
msg:
type: string
description: 提示信息 / message
data:
type: object
example:
msg: ''
code: 0
data: ''
success: false
'401':
description: access_token 缺失或已过期 / missing or expired access_token
/api/factoryOrderXHXNew/getFactoryOrderList:
post:
operationId: apiFactoryOrderXHXNewGetFactoryOrderList
summary: 获取销售单ID工厂订单列表
tags:
- Dedicated Services
x-source-documentation: https://dev.3vjia.com/document?apiId=857624103111250046
x-documentation-category: 专属服务 / C10506333
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
id:
type: integer
format: int64
description: 销售单ID
required:
- id
example:
id: 0
responses:
'200':
description: 成功 / OK
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
description: 请求是否成功 / whether the call succeeded
code:
type: integer
description: 结果码 / result code (0 = success)
msg:
type: string
description: 提示信息 / message
data:
type: object
properties:
createOrderUserName:
type: string
createTime:
type: string
format: date-time
description: 创建时间
id:
type: integer
format: int64
description: 主键id
orderCode:
type: string
description: 订单编号
orderName:
type: string
description: 订单名称
schemeId:
type: string
description: 3D方案号
schemeName:
type: string
description: 方案名称
shopDeptId:
type: string
description: 经销商所在部门id
shopId:
type: string
description: 经销商ID
shopName:
type: string
description: 经销商名称
shopOrderCode:
type: string
description: 门店订单Code
shopOrderId:
type: integer
format: int64
description: 门店订单ID
shopOrderName:
type: string
description: 销售订单名称
totalPrice:
type: number
format: bigdecimal
description: 订单总价(原价)
urlParam:
type: string
description: 外部参数
required:
- createTime
- id
example:
msg: ''
code: 0
data:
- shopOrderCode: ''
shopDeptId: ''
totalPrice: 0
schemeName: ''
shopName: ''
shopOrderName: ''
schemeId: ''
urlParam: ''
createOrderUserName: ''
shopOrderId: 0
createTime: ''
orderCode: ''
id: 0
shopId: ''
orderName: ''
success: false
'401':
description: access_token 缺失或已过期 / missing or expired access_token
/api/kgmaterial/pageKgMagerial:
post:
operationId: apiKgmaterialPageKgMagerial
summary: 分页获取规则或系列关联的图谱素材
tags:
- Light Design
x-source-documentation: https://dev.3vjia.com/document?apiId=844215383568322627
x-documentation-category: 轻设计
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
applySpace:
type: string
description: 空间名称
isPlatform:
type: integer
format: int32
description: 是否查询平台套系对应模型位数据1是0否默认0
keyword:
type: string
description: 素材ID或素材名称搜索关键字
lengthMax:
type: integer
format: int32
description: 素材长度最大值
lengthMin:
type: integer
format: int32
description: 素材长度最小值
materialId:
type: string
description: 素材id
materialName:
type: string
description: 素材名称
modelLoc:
type: string
description: 模型位(新版图谱中文名)
orderBy:
type: string
description: 排序
pageIndex:
type: integer
format: int32
description: 页码
pageSize:
type: integer
format: int32
description: 页容量
ruleId:
type: string
description: 规则ID
seriesId:
type: string
description: 规则/系列ID
status:
type: integer
format: int32
description: 素材状态-1入库失败1入库中2入库成功
example:
lengthMax: 0
isPlatform: 0
orderBy: ''
pageSize: 0
materialId: ''
modelLoc: ''
seriesId: ''
applySpace: ''
materialName: ''
lengthMin: 0
pageIndex: 0
keyword: ''
ruleId: ''
status: 0
responses:
'200':
description: 成功 / OK
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
description: 请求是否成功 / whether the call succeeded
code:
type: integer
description: 结果码 / result code (0 = success)
msg:
type: string
description: 提示信息 / message
data:
type: object
properties:
pageIndex:
type: integer
format: int32
pageSize:
type: integer
format: int32
recordCount:
type: integer
format: int32
result:
type: array
items:
type: object
properties:
applySpace:
type: array
items: {}
description: "This is List Type \n应用空间"
brushStyleList:
type: array
items:
type: object
properties:
styleCode:
type: string
description: 风格刷唯一标识(固定传值)code全屋风格刷:styleBrushId厨房风格刷:kitchenBrushId背景墙风格刷:wallBrushId
styleId:
type: string
description: 风格刷ID
styleImage:
type: string
description: 封面图
styleName:
type: string
description: 风格名称
styleType:
type: string
description: 风格类别
xmlDataUrl:
type: string
description: 风格刷对应数据URL
description: '*风格刷参数'
category:
type: string
description: 素材分类
circleShare:
type: integer
format: int32
description: 设计圈共享0否1是默认0
color:
type: string
description: 素材颜色
createTime:
type: string
description: 创建时间
customStyleIds:
type: array
items: {}
description: "This is List Type \n所属规则/系列Ids"
groupName:
type: string
description: 素材组名称
groupType:
type: integer
format: int32
description: 素材组类型:1地板瓷砖、2墙体涂料、3模型、4墙体瓷砖、、6模型组合
height:
type: number
format: double
description: 高
id:
type: integer
format: int32
description: 主键id
imagePath:
type: string
description: 素材图片路径
is3d:
type: integer
format: int32
description: 3D启用1是0否默认0
isDirect:
type: integer
format: int32
description: 是否直接归属系列
isValid:
type: integer
format: int32
description: 禁用标识[0禁用1启用]默认1
kgId:
type: string
description: 图谱入库id
kgMaterialType:
type: string
description: 图谱模型分类名称
kgStatus:
type: integer
format: int32
description: 图谱入库状态:-1入库失败0未提交入库1入库中2入库成功
length:
type: number
format: double
description: 长
lengthMax:
type: integer
format: int32
description: 素材长度最大值
lengthMin:
type: integer
format: int32
description: 素材长度最小值
materialGroupId:
type: string
description: 素材组id
materialId:
type: string
description: 素材id
materialName:
type: string
description: 素材名称
materialSource:
type: string
description: 素材来源本机构/素材广场
materialStyle:
type: string
description: 素材风格
materialType:
type: integer
format: int32
description: 素材类型(1硬装、2软装、3定制)
modelFlag:
type: string
description: 模型类型标记
modelLoc:
type: string
description: 模型位(新版图谱中文名)
modellocId:
type: string
description: 模型位置id
modellocName:
type: string
description: 模型位置名称
msg:
type: string
description: msg
recommended:
type: boolean
description: 是否推荐素材
ruleId:
type: integer
format: int32
description: 设计规则id/系列ID
schemeType:
type: string
description: 方案种类cupboard:橱柜wardrobe:衣柜systemCabinet:系统柜
score:
type: number
format: float
description: 多模态分数
seedSchemeIds:
type: string
description: 种子方案ids
seriesKgId:
type: string
description: 系列kgId
spaceId:
type: string
description: 空间id
spaceName:
type: string
description: 空间名称
status:
type: string
description: 素材状态-1入库失败1入库中2入库成功
texture:
type: string
description: 素材材质
topViewImage:
type: string
description: 素材顶视图
traceId:
type: string
description: traceId
typeOnRelation:
type: string
description: 素材边上的type
width:
type: number
format: double
description: 宽
wireframeImage:
type: string
description: 线框图
description: This is List Type
example:
msg: ''
code: 0
data:
recordCount: 0
pageSize: 0
result:
- msg: ''
groupType: 0
color: ''
schemeType: ''
imagePath: ''
is3d: 0
modelLoc: ''
spaceName: ''
applySpace: []
spaceId: ''
materialStyle: ''
seedSchemeIds: ''
modelFlag: ''
typeOnRelation: ''
materialGroupId: ''
customStyleIds: []
brushStyleList:
- xmlDataUrl: ''
styleImage: ''
styleName: ''
styleCode: ''
styleType: ''
styleId: ''
id: 0
kgStatus: 0
ruleId: 0
materialSource: ''
modellocId: ''
traceId: ''
wireframeImage: ''
kgMaterialType: ''
topViewImage: ''
kgId: ''
texture: ''
isValid: 0
lengthMax: 0
materialType: 0
materialId: ''
seriesKgId: ''
recommended: false
materialName: ''
groupName: ''
circleShare: 0
createTime: ''
lengthMin: 0
category: ''
modellocName: ''
isDirect: 0
status: ''
pageIndex: 0
success: false
'401':
description: access_token 缺失或已过期 / missing or expired access_token
/api/layoutCabinetCustomMaterial/listByPage:
post:
operationId: apiLayoutCabinetCustomMaterialListByPage
summary: 分页查询套系素材自定义替换关联
tags:
- Light Design
x-source-documentation: https://dev.3vjia.com/document?apiId=843157642473017444
x-documentation-category: 轻设计
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
categoryCode:
type: string
description: 分类编码
categoryId:
type: string
description: 关联分类目录ID(按照分类关联)
categoryName:
type: string
description: 分类名称
createDateEnd:
type: string
description: 创建时间结束日期
createDateStart:
type: string
description: 创建时间开始日期
createUser:
type: string
description: 创建人
height:
type: number
format: double
description: 替换素材高
ids:
type: array
items: {}
description: "This is List Type \nID"
imagePath:
type: string
description: 替换素材主图
isDelete:
type: integer
format: int32
description: 删除标识
length:
type: number
format: double
description: 替换素材长
materialId:
type: string
description: 原素材ID(套系中录入的素材)
materialName:
type: string
description: 替换素材名称
materialNameLike:
type: string
description: 替换素材名称模糊匹配
modelFlag:
type: integer
format: int32
description: 替换素材分类
orderBy:
type: string
description: 排序
pageIndex:
type: integer
format: int32
description: 页码
pageSize:
type: integer
format: int32
description: 页容量
replaceMaterialId:
type: string
description: 替换素材ID
replaceModel:
type: string
description: 素材替换类型category|material
replaceType:
type: string
description: 替换类别doorBoard门板|chartlet贴图|electric电器|category分类(则根据categoryId获取分类树)
tenantId:
type: string
description: 租户
updateDateEnd:
type: string
description: 更新时间结束日期
updateDateStart:
type: string
description: 更新时间开始日期
updateUser:
type: string
description: 更新人
width:
type: number
format: double
description: 替换素材宽
example:
replaceMaterialId: ''
imagePath: ''
isDelete: 0
orderBy: ''
pageSize: 0
updateUser: ''
replaceType: ''
categoryCode: ''
materialId: ''
categoryName: ''
replaceModel: ''
materialName: ''
modelFlag: 0
createDateStart: ''
pageIndex: 0
updateDateStart: ''
tenantId: ''
updateDateEnd: ''
ids: []
createUser: ''
createDateEnd: ''
categoryId: ''
materialNameLike: ''
responses:
'200':
description: 成功 / OK
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
description: 请求是否成功 / whether the call succeeded
code:
type: integer
description: 结果码 / result code (0 = success)
msg:
type: string
description: 提示信息 / message
data:
type: object
properties:
pageIndex:
type: integer
format: int32
pageSize:
type: integer
format: int32
recordCount:
type: integer
format: int32
result:
type: array
items:
type: object
properties:
categoryCode:
type: string
description: 分类编码
categoryId:
type: string
description: 关联分类目录ID(按照分类关联)
categoryName:
type: string
description: 分类名称
createDate:
type: string
description: 创建时间
createUser:
type: string
description: 创建人
glbList:
type: array
items: {}
description: "This is List Type \n替换素材glb列表"
height:
type: number
format: double
description: 替换素材高
id:
type: string
description: ID
imagePath:
type: string
description: 替换素材主图
isDelete:
type: integer
format: int32
description: 删除标识
leftValue:
type: integer
format: int32
description: 是否有子分类1是0否
length:
type: number
format: double
description: 替换素材长
materialId:
type: string
description: 原素材ID
materialName:
type: string
description: 替换素材素材名称
modelFlag:
type: integer
format: int32
description: 替换素材素材分类
replaceMaterialId:
type: string
description: 替换素材ID
replaceModel:
type: string
description: 素材替换类型category|material
replaceType:
type: string
description: 替换类别doorBoard门板|chartlet贴图|electric电器
tenantId:
type: string
description: 租户
updateDate:
type: string
description: 更新时间
updateUser:
type: string
description: 更新人
width:
type: number
format: double
description: 替换素材宽
description: AI搭柜自定素材配置结果类
example:
msg: ''
code: 0
data:
recordCount: 0
pageSize: 0
result:
- replaceMaterialId: ''
updateDate: ''
imagePath: ''
isDelete: 0
leftValue: 0
updateUser: ''
replaceType: ''
categoryCode: ''
materialId: ''
categoryName: ''
glbList: []
replaceModel: ''
materialName: ''
modelFlag: 0
tenantId: ''
createUser: ''
id: ''
categoryId: ''
createDate: ''
pageIndex: 0
success: false
'401':
description: access_token 缺失或已过期 / missing or expired access_token
/api/layoutCabinetCustomMaterial/listCategoryByMaterialIds:
post:
operationId: apiLayoutCabinetCustomMaterialListCategoryByMaterialIds
summary: 根据素材ID和替换素材ID列表查询去重后的分类
tags:
- Light Design
x-source-documentation: https://dev.3vjia.com/document?apiId=850694997635403859
x-documentation-category: 轻设计
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
materialIdList:
type: array
items: {}
description: "This is List Type \n原素材ID列表"
replaceMaterialIdList:
type: array
items: {}
description: "This is List Type \n替换素材ID列表"
tenantId:
type: string
description: 租户ID
example:
tenantId: ''
replaceMaterialIdList: []
materialIdList: []
responses:
'200':
description: 成功 / OK
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
description: 请求是否成功 / whether the call succeeded
code:
type: integer
description: 结果码 / result code (0 = success)
msg:
type: string
description: 提示信息 / message
data:
type: object
properties:
categoryId:
type: string
description: 分类ID
categoryName:
type: string
description: 分类名称
example:
msg: ''
code: 0
data:
- categoryName: ''
categoryId: ''
success: false
'401':
description: access_token 缺失或已过期 / missing or expired access_token
/api/layoutScheme/adminListByPage:
post:
operationId: apiLayoutSchemeAdminListByPage
summary: 管理员分页查询企业下布局方案
tags:
- Light Design
x-source-documentation: https://dev.3vjia.com/document?apiId=873248254035398683
x-documentation-category: 轻设计
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
area:
type: number
format: float
description: 方案面积
areaMax:
type: number
format: float
description: 面积范围
areaMin:
type: number
format: float
description: 面积范围
belongType:
type: integer
format: int32
description: 归属1企业2门店3特定样板数据4个库
budget:
type: string
description: 装修预算
city:
type: string
description: 市代码
cntactMan:
type: string
description: 客户名称
createDateEnd:
type: string
description: 创建时间结束日期
createDateStart:
type: string
description: 创建时间开始日期
createTimeRange:
type: integer
format: int32
description: 创建时间范围最近1个月
createTimeRange3:
type: integer
format: int32
description: 创建时间范围最近3个月
createTimeRange6:
type: integer
format: int32
description: 创建时间范围最近6个月
createUser:
type: string
description: 创建人ID
createUserList:
type: array
items: {}
description: "This is List Type \n创建人IDs"
designerAccount:
type: string
description: 设计师账号
designerId:
type: string
description: 从业者(分享人)账号ID
designerName:
type: string
description: 设计师名称
designerOpenId:
type: string
description: 从业者(分享人)openId
district:
type: string
description: 区代码
folderId:
type: string
description: 文件夹id
funcRequire:
type: string
description: 功能需求
houseMold:
type: string
description: 房屋类型
houseType:
type: string
description: 户型
id:
type: string
description: 主键ID
idLike:
type: string
description: 主键id模糊查詢
ids:
type: array
items: {}
description: "This is List Type \n主键IDs"
industId:
type: string
description: 行业应用id
installType:
type: string
description: 安装类型前装/后装/通用
isDelete:
type: integer
format: int32
description: 删除0否1是
isSample:
type: integer
format: int32
description: 样板间1是0否
keyWord:
type: string
description: 搜索关键词
layoutSchemeName:
type: string
description: 方案名称
layoutSchemeNameLike:
type: string
description: 方案名称模糊匹配
manager:
type: integer
format: int32
description: 管理页标识1是默认否
mobile:
type: string
description: 联想电话
notInFolder:
type: integer
format: int32
description: 是否查询不在文件夹内的方案1是0否
orderBy:
type: string
description: 排序
orientation:
type: string
description: 户型朝向正东/正西/正南/正北/东南/西南/西北/东北
outerSchemeId:
type: string
description: 外部方案ID
pageIndex:
type: integer
format: int32
description: 页码
pageSize:
type: integer
format: int32
description: 页容量
populate:
type: string
description: 居住人口
projectAddr:
type: string
description: 项目地址
projectId:
type: string
description: 项目id
projectType:
type: string
description: 项目类型2c_new、b_to_c_repeat、2c_repeat、2b_project、null
province:
type: string
description: 省代码
recover:
type: string
description: 恢复版本
roomName:
type: string
description: 空间名
roomNameList:
type: array
items: {}
description: "This is List Type \n空间名称列表"
ruleId:
type: string
description: 套系ID
schemeType:
type: string
description: 方案类型seller|designer
scoreData:
type: string
description: 评分数据链接
share2me:
type: integer
format: int32
description: 共享给我的1是0否
shared:
type: integer
format: int32
description: 仅显示我分享的1是0否
shelveStatus:
type: integer
format: int32
description: 上架状态0否1是
showPersonal:
type: integer
format: int32
description: 是否在AI轻设计小程序个人主页显示
source:
type: string
description: 数据来源
sourceList:
type: array
items: {}
description: "This is List Type \n数据来源列表"
svjSchemeId:
type: string
description: 3D方案ID
templateId:
type: string
description: 布局模板ID
tenantId:
type: string
description: 租户ID
updateDateEnd:
type: string
description: 更新时间结束日期
updateDateStart:
type: string
description: 更新时间开始日期
updateTimeRange:
type: integer
format: int32
description: 更新时间范围最近1个月
updateTimeRange3:
type: integer
format: int32
description: 更新时间范围最近3个月
updateTimeRange6:
type: integer
format: int32
description: 更新时间范围最近6个月
updateUser:
type: string
description: 更新人ID
userId:
type: string
description: 当前用户ID
example:
idLike: ''
isSample: 0
layoutSchemeNameLike: ''
scoreData: ''
schemeType: ''
projectType: ''
roomNameList: []
pageSize: 0
createTimeRange3: 0
source: ''
templateId: ''
designerAccount: ''
province: ''
createDateStart: ''
svjSchemeId: ''
updateDateEnd: ''
id: ''
ruleId: ''
budget: ''
designerId: ''
share2me: 0
cntactMan: ''
folderId: ''
roomName: ''
createUserList: []
funcRequire: ''
installType: ''
createTimeRange6: 0
district: ''
designerOpenId: ''
ids: []
projectId: ''
shared: 0
houseMold: ''
city: ''
industId: ''
orderBy: ''
createTimeRange: 0
updateDateStart: ''
projectAddr: ''
createDateEnd: ''
shelveStatus: 0
belongType: 0
notInFolder: 0
orientation: ''
outerSchemeId: ''
recover: ''
manager: 0
sourceList: []
isDelete: 0
houseType: ''
mobile: ''
updateUser: ''
updateTimeRange: 0
updateTimeRange6: 0
userId: ''
updateTimeRange3: 0
designerName: ''
keyWord: ''
populate: ''
pageIndex: 0
layoutSchemeName: ''
tenantId: ''
createUser: ''
showPersonal: 0
responses:
'200':
description: 成功 / OK
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
description: 请求是否成功 / whether the call succeeded
code:
type: integer
description: 结果码 / result code (0 = success)
msg:
type: string
description: 提示信息 / message
data:
type: object
properties:
pageIndex:
type: integer
format: int32
pageSize:
type: integer
format: int32
recordCount:
type: integer
format: int32
result:
type: array
items:
type: object
properties:
address:
type: string
description: 地址
area:
type: number
format: float
description: 方案面积(户型面积)
belongType:
type: integer
format: int32
description: 归属1企业2门店
budget:
type: string
description: 装修预算
city:
type: string
description: 市代码
cityName:
type: string
description: 市名称
cntactMan:
type: string
description: 客户名称
contentUrl:
type: string
description: 方案内容URL
coverImage:
type: string
description: 布局方案封面图
cpqRespId:
type: string
description: CPQ下单返回ID
createDate:
type: string
description: 创建时间
createUser:
type: string
description: 创建人ID
createUserName:
type: string
description: 创建人名称
createUserNickName:
type: string
description: 创建人昵称
custInfoId:
type: string
description: 客户信息关联ID
customerInfo:
type: object
properties:
address:
type: string
description: 地址详情
areaCode:
type: string
description: 区代码
buildingName:
type: string
description: 楼盘名称
city:
type: string
description: 市名称
cityCode:
type: string
description: 市代码
clientId:
type: string
description: 客户端ID
cntactMan:
type: string
description: 联系人
district:
type: string
description: 区名称
email:
type: string
description: email
hwCustomerId:
type: string
description: 华为潜客ID
industId:
type: string
description: 行业应用id
mobile:
type: string
description: 联系电话
note:
type: string
description: 备注
projectType:
type: string
description: 项目类型2c_new
province:
type: string
description: 省名称
provinceCode:
type: string
description: 省
qq:
type: string
description: QQ
sex:
type: string
description: 性别
webSiteSource:
type: string
description: 来源
description: "布局方案客户信息入参 \n客户信息"
designerId:
type: string
description: 从业者(分享人)ID
designerNickName:
type: string
description: 从业者昵称
designerOpenId:
type: string
description: 从业者(分享人)openId
designerThumbnail:
type: string
description: 从业者头像
deviceAmount:
type: number
format: double
description: 设备数
district:
type: string
description: 区代码
districtName:
type: string
description: 区名称
expireDate:
type: string
description: 过期时间
explanatoryImage:
type: string
description: 企业样板间说明图
floors:
type: string
description: 层数
folderId:
type: string
description: 文件夹ID
folderName:
type: string
description: 文件夹名称
funcRequire:
type: string
description: 功能需求
houseMold:
type: string
description: 房屋类型
houseType:
type: string
description: 户型例:三室两厅
houseTypeId:
type: string
description: 户型ID
houseTypeInfo:
type: object
properties:
area:
type: number
format: double
description: 面积
bathroom:
type: string
description: 卫
buildingName:
type: string
description: 小区名称
city:
type: string
description: 市代码
createDate:
type: string
description: 创建时间
createUser:
type: string
description: 创建人
dataUrl:
type: string
description: 户型数据
district:
type: string
description: 区代码
dwgUrl:
type: string
description: '*dwg文件'
hall:
type: string
description: 厅
houseSchemeId:
type: string
description: 户型方案ID
houseTypeName:
type: string
description: 名称
id:
type: string
description: 主键ID
imageUrl:
type: string
description: 户型图url
industId:
type: string
description: 行业应用ID
isDelete:
type: integer
format: int32
description: 删除1是0否
kitchen:
type: string
description: 厨
platHouseTypeId:
type: string
description: 平台库户型ID
platLayoutId:
type: string
description: 平台库户型ID
province:
type: string
description: 省代码
room:
type: string
description: 房
roomTypeId:
type: string
description: roomtypeid
roomTypeName:
type: string
description: roomtypename
source:
type: string
description: 来源1户型库2上传
status:
type: integer
format: int32
description: 状态1启用0禁用默认1
tenantId:
type: string
description: 租户ID
towards:
type: string
description: 朝向
updateDate:
type: string
description: 更新时间
updateUser:
type: string
description: 更新人
description: "户型详情结果 \n户型详细信息"
hwCustomerId:
type: string
description: hw潜客ID
id:
type: string
description: 主键ID
industId:
type: string
description: 行业应用id
installType:
type: string
description: 安装类型前装/后装/通用
isDelete:
type: integer
format: int32
description: 删除0否1是
isSample:
type: integer
format: int32
description: 样板间1是0否
layoutSchemeName:
type: string
description: 方案名称
layoutSketchImage:
type: string
description: 布局示意图
mobile:
type: string
description: 客户电话
orientation:
type: string
description: 户型朝向正东/正西/正南/正北/东南/西南/西北/东北
outerSchemeId:
type: string
description: 外部方案ID
outerUserId:
type: string
description: 外部用户ID
panoLink:
type: string
description: 全景链接
platLayoutId:
type: string
description: 平台库户型ID
populate:
type: string
description: 居住人口
praised:
type: integer
format: int32
description: 是否被AI轻设计点赞1是0否默认0
projectAddr:
type: string
description: 项目地址
projectCode:
type: string
description: 项目编码
projectId:
type: string
description: 项目ID(对应多方案originSchemeId)
projectType:
type: string
description: 项目类型2c_new、b_to_c_repeat、2c_repeat、2b_project、null
province:
type: string
description: 省代码
provinceName:
type: string
description: 省名称
quoteXmlUrl:
type: string
description: 3D报价URL
ruleId:
type: string
description: 套系ID
schemeType:
type: string
description: 方案类型seller|designer
schemeVersion:
type: string
description: CPQ方案版本
scoreData:
type: string
description: 评分数据链接
shared:
type: integer
format: int32
description: 仅显示我分享1是0否
shelveStatus:
type: integer
format: int32
description: 上架状态0否1是2待上架[默认]
showPersonal:
type: integer
format: int32
description: AI轻设计小程序个人主页显示1是0否
sort:
type: integer
format: int32
description: 排序
source:
type: string
description: 数据来源
succeeded:
type: boolean
description: 易维推送成功标识
svjSchemeId:
type: string
description: 3D方案ID
templateId:
type: string
description: 布局模板ID
tenantId:
type: string
description: 租户ID
totalPrice:
type: number
format: double
description: 方案价格(总价)
updateDate:
type: string
description: 更新时间
updateUser:
type: string
description: 更新人ID
ywCode:
type: string
description: 易维项目编码(推送易维时用户自填,记录上一次的填写)
description: "布局模板方案表结果类 \n布局方案详情"
example:
msg: ''
code: 0
data:
recordCount: 0
pageSize: 0
result:
- isSample: 0
cpqRespId: ''
houseTypeInfo:
updateDate: ''
city: ''
industId: ''
hall: ''
source: ''
roomTypeId: ''
platHouseTypeId: ''
province: ''
imageUrl: ''
platLayoutId: ''
id: ''
kitchen: ''
bathroom: ''
createDate: ''
dataUrl: ''
isDelete: 0
roomTypeName: ''
houseSchemeId: ''
houseTypeName: ''
updateUser: ''
towards: ''
room: ''
buildingName: ''
district: ''
tenantId: ''
createUser: ''
dwgUrl: ''
status: 0
scoreData: ''
schemeType: ''
hwCustomerId: ''
designerNickName: ''
createUserNickName: ''
outerUserId: ''
projectType: ''
customerInfo:
qq: ''
note: ''
address: ''
clientId: ''
city: ''
hwCustomerId: ''
cityCode: ''
industId: ''
provinceCode: ''
sex: ''
mobile: ''
projectType: ''
webSiteSource: ''
cntactMan: ''
buildingName: ''
areaCode: ''
province: ''
district: ''
email: ''
createUserName: ''
source: ''
templateId: ''
ywCode: ''
houseTypeId: ''
province: ''
svjSchemeId: ''
coverImage: ''
id: ''
ruleId: ''
quoteXmlUrl: ''
budget: ''
designerId: ''
praised: 0
cntactMan: ''
sort: 0
folderId: ''
funcRequire: ''
installType: ''
district: ''
designerOpenId: ''
panoLink: ''
folderName: ''
provinceName: ''
projectId: ''
succeeded: false
shared: 0
updateDate: ''
houseMold: ''
city: ''
industId: ''
layoutSketchImage: ''
floors: ''
cityName: ''
projectCode: ''
projectAddr: ''
platLayoutId: ''
expireDate: ''
shelveStatus: 0
createDate: ''
belongType: 0
orientation: ''
outerSchemeId: ''
address: ''
districtName: ''
isDelete: 0
houseType: ''
mobile: ''
updateUser: ''
designerThumbnail: ''
custInfoId: ''
schemeVersion: ''
explanatoryImage: ''
contentUrl: ''
populate: ''
layoutSchemeName: ''
tenantId: ''
createUser: ''
showPersonal: 0
pageIndex: 0
success: false
'401':
description: access_token 缺失或已过期 / missing or expired access_token
/api/metaTenantMaterial/listByPage:
post:
operationId: apiMetaTenantMaterialListByPage
summary: 分页查询企业自定义图元素材
tags:
- Light Design
x-source-documentation: https://dev.3vjia.com/document?apiId=843157642473017440
x-documentation-category: 轻设计
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
createDateEnd:
type: string
description: 创建时间结束日期
createDateStart:
type: string
description: 创建时间开始日期
createUser:
type: string
description: 创建人ID
height:
type: number
format: double
description: 高
ids:
type: array
items: {}
description: "This is List Type \nID"
imagePath:
type: string
description: 素材图片
isDelete:
type: integer
format: int32
description: 删除1是0否
length:
type: number
format: double
description: 长
materialId:
type: string
description: 素材ID
materialName:
type: string
description: 素材名称
materialNameLike:
type: string
description: 素材名称模糊匹配
metaCode:
type: string
description: 图元/模型位编码
metaName:
type: string
description: 图元/模型位名称
metaNameLike:
type: string
description: 图元/模型位名称模糊匹配
metaNameList:
type: array
items: {}
description: "This is List Type \n图元模型位名称集合"
modelFlag:
type: integer
format: int32
description: 模型标志
orderBy:
type: string
description: 排序
pageIndex:
type: integer
format: int32
description: 页码
pageSize:
type: integer
format: int32
description: 页容量
tenantId:
type: string
description: 租户ID
updateDateEnd:
type: string
description: 更新时间结束日期
updateDateStart:
type: string
description: 更新时间开始日期
updateUser:
type: string
description: 更新人ID
width:
type: number
format: double
description: 宽
example:
imagePath: ''
isDelete: 0
orderBy: ''
pageSize: 0
updateUser: ''
materialId: ''
metaCode: ''
materialName: ''
metaNameList: []
metaName: ''
modelFlag: 0
createDateStart: ''
pageIndex: 0
updateDateStart: ''
metaNameLike: ''
tenantId: ''
updateDateEnd: ''
ids: []
createUser: ''
createDateEnd: ''
materialNameLike: ''
responses:
'200':
description: 成功 / OK
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
description: 请求是否成功 / whether the call succeeded
code:
type: integer
description: 结果码 / result code (0 = success)
msg:
type: string
description: 提示信息 / message
data:
type: object
properties:
pageIndex:
type: integer
format: int32
pageSize:
type: integer
format: int32
recordCount:
type: integer
format: int32
result:
type: array
items:
type: object
properties:
createDate:
type: string
description: 创建时间
createUser:
type: string
description: 创建人ID
height:
type: number
format: double
description: 高
id:
type: string
description: ID
imagePath:
type: string
description: 素材图片
isDelete:
type: integer
format: int32
description: 删除1是0否
length:
type: number
format: double
description: 长
materialId:
type: string
description: 素材ID
materialName:
type: string
description: 素材名称
metaCode:
type: string
description: 图元/模型位编码
metaName:
type: string
description: 图元/模型位名称
modelFlag:
type: integer
format: int32
description: 模型标志
tenantId:
type: string
description: 租户ID
updateDate:
type: string
description: 更新时间
updateUser:
type: string
description: 更新人ID
width:
type: number
format: double
description: 宽
description: 企业自定义图元素材结果类
example:
msg: ''
code: 0
data:
recordCount: 0
pageSize: 0
result:
- updateDate: ''
imagePath: ''
isDelete: 0
updateUser: ''
materialId: ''
metaCode: ''
materialName: ''
metaName: ''
modelFlag: 0
tenantId: ''
createUser: ''
id: ''
createDate: ''
pageIndex: 0
success: false
'401':
description: access_token 缺失或已过期 / missing or expired access_token
/api/modelocMaterialCategory/listByPage:
post:
operationId: apiModelocMaterialCategoryListByPage
summary: 分页查询模型位素材分类目录配置
tags:
- Light Design
x-source-documentation: https://dev.3vjia.com/document?apiId=843157642473017442
x-documentation-category: 轻设计
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
categoryCode:
type: string
description: 分类代码
categoryId:
type: string
description: 分类ID
categoryName:
type: string
description: 分类名称
categoryType:
type: string
description: 目录类型
createDateEnd:
type: string
description: 创建时间结束日期
createDateStart:
type: string
description: 创建时间开始日期
createUser:
type: string
description: 创建人ID
ids:
type: array
items: {}
description: "This is List Type \n主键ID"
isDelete:
type: integer
format: int32
description: 删除1是0否
leftValue:
type: integer
format: int32
description: 子级1是0否
modelFlag:
type: string
description: 素材标识
modelloc:
type: string
description: AI模型位
moduleName:
type: string
description: 分类模块
orderBy:
type: string
description: 排序
organType:
type: integer
format: int32
description: 归属0企业1部门2个人
pageIndex:
type: integer
format: int32
description: 页码
pageSize:
type: integer
format: int32
description: 页容量
tenantId:
type: string
description: 租户ID
updateDateEnd:
type: string
description: 更新时间结束日期
updateDateStart:
type: string
description: 更新时间开始日期
updateUser:
type: string
description: 更新人ID
example:
isDelete: 0
leftValue: 0
moduleName: ''
orderBy: ''
pageSize: 0
updateUser: ''
categoryCode: ''
categoryName: ''
modelloc: ''
categoryType: ''
modelFlag: ''
createDateStart: ''
pageIndex: 0
updateDateStart: ''
tenantId: ''
updateDateEnd: ''
ids: []
createUser: ''
organType: 0
createDateEnd: ''
categoryId: ''
responses:
'200':
description: 成功 / OK
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
description: 请求是否成功 / whether the call succeeded
code:
type: integer
description: 结果码 / result code (0 = success)
msg:
type: string
description: 提示信息 / message
data:
type: object
properties:
pageIndex:
type: integer
format: int32
pageSize:
type: integer
format: int32
recordCount:
type: integer
format: int32
result:
type: array
items:
type: object
properties:
categoryCode:
type: string
description: 分类代码
categoryId:
type: string
description: 分类ID
categoryName:
type: string
description: 分类名称
categoryType:
type: string
description: 目录类型
createDate:
type: string
description: 创建时间
createUser:
type: string
description: 创建人ID
id:
type: string
description: 主键ID
isDelete:
type: integer
format: int32
description: 删除1是0否
leftValue:
type: integer
format: int32
description: 子级1是0否
modelFlag:
type: string
description: 素材标识
modelloc:
type: string
description: AI模型位
moduleName:
type: string
description: 分类模块
organType:
type: integer
format: int32
description: 归属0企业1部门2个人
tenantId:
type: string
description: 租户ID
updateDate:
type: string
description: 更新时间
updateUser:
type: string
description: 更新人ID
description: 模型位素材分类目录配置结果类
example:
msg: ''
code: 0
data:
recordCount: 0
pageSize: 0
result:
- updateDate: ''
isDelete: 0
leftValue: 0
moduleName: ''
updateUser: ''
categoryCode: ''
categoryName: ''
modelloc: ''
categoryType: ''
modelFlag: ''
tenantId: ''
createUser: ''
id: ''
organType: 0
categoryId: ''
createDate: ''
pageIndex: 0
success: false
'401':
description: access_token 缺失或已过期 / missing or expired access_token
/api/musi/upSaleOrderFlow:
post:
operationId: apiMusiUpSaleOrderFlow
summary: 修改售后订单流程到下单节点
tags:
- Dedicated Services
x-source-documentation: https://dev.3vjia.com/document?apiId=663065859396358172
x-documentation-category: 专属服务 / C10495030
description: 修改售后订单流程到下单节点
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
orderCode:
type: string
description: 订单号
orderID:
type: integer
format: int64
description: 订单ID
example:
orderID: 0
orderCode: ''
responses:
'200':
description: 成功 / OK
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
description: 请求是否成功 / whether the call succeeded
code:
type: integer
description: 结果码 / result code (0 = success)
msg:
type: string
description: 提示信息 / message
data:
type: object
example:
msg: ''
code: 0
success: false
'401':
description: access_token 缺失或已过期 / missing or expired access_token
/api/omni/material/deleteBySerialNumbers:
post:
operationId: apiOmniMaterialDeleteBySerialNumbers
summary: 根据序列号删除数据
tags:
- Dedicated Services
x-source-documentation: https://dev.3vjia.com/document?apiId=776899277749370951
x-documentation-category: 专属服务 / C00063204
description: 根据序列号删除数据
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
dataType:
type: integer
format: int32
description: 数据类型, 1:门板, 2:柜体板, 3:防水板
serialNumbers:
type: array
items: {}
description: 序列号列表
example:
dataType: 0
serialNumbers: []
responses:
'200':
description: 成功 / OK
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
description: 请求是否成功 / whether the call succeeded
code:
type: integer
description: 结果码 / result code (0 = success)
msg:
type: string
description: 提示信息 / message
data:
type: object
properties:
msg:
type: string
description: 失败原因
notFoundSerialNumbers:
type: array
items: {}
description: 未找到序列号
result:
type: boolean
description: 删除结果
example:
msg: ''
code: 0
data:
msg: ''
notFoundSerialNumbers: []
result: false
success: false
'401':
description: access_token 缺失或已过期 / missing or expired access_token
/api/omni/material/materialCabinetBoard/getBySerialNumbers:
post:
operationId: apiOmniMaterialMaterialCabinetBoardGetBySerialNumbers
summary: 根据序列号获取柜体板数据
tags:
- Dedicated Services
x-source-documentation: https://dev.3vjia.com/document?apiId=772116924552335464
x-documentation-category: 专属服务 / C00063204
description: 根据序列号获取柜体板数据
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
serialNumbers:
type: array
items: {}
description: 列号列表
required:
- serialNumbers
example:
serialNumbers: []
responses:
'200':
description: 成功 / OK
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
description: 请求是否成功 / whether the call succeeded
code:
type: integer
description: 结果码 / result code (0 = success)
msg:
type: string
description: 提示信息 / message
data:
type: object
properties:
activated:
type: integer
format: int32
description: 启用状态, 0-禁用, 1-启用
baseMaterialCode:
type: string
description: 基材物料编码
baseMaterialName:
type: string
description: 基材名称
edge:
type: string
description: 封边
edgeCode:
type: string
description: 封边编码
edgeThickness:
type: number
format: bigdecimal
description: 封边厚度
height:
type: number
format: bigdecimal
description: 高度
materialCode:
type: string
description: 材质编码
materialName:
type: string
description: 材质名称
serialNumber:
type: string
description: 序列号
specialEdge:
type: string
description: 封边(特殊)
specialEdgeCode:
type: string
description: 封边编码(特殊)
specialEdgeThickness:
type: number
format: bigdecimal
description: 特殊封边厚度
thickness:
type: number
format: bigdecimal
description: 板厚
example:
msg: ''
code: 0
data:
- edgeThickness: 0
specialEdgeThickness: 0
serialNumber: ''
thickness: 0
materialCode: ''
specialEdge: ''
materialName: ''
baseMaterialCode: ''
edge: ''
edgeCode: ''
specialEdgeCode: ''
activated: 0
baseMaterialName: ''
height: 0
success: false
'401':
description: access_token 缺失或已过期 / missing or expired access_token
/api/omni/material/materialCabinetBoard/update:
post:
operationId: apiOmniMaterialMaterialCabinetBoardUpdate
summary: 更新柜体板数据
tags:
- Dedicated Services
x-source-documentation: https://dev.3vjia.com/document?apiId=772117176231546988
x-documentation-category: 专属服务 / C00063204
description: 更新柜体板数据
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
activated:
type: integer
format: int32
description: 启用状态, 0-禁用, 1-启用
baseMaterialCode:
type: string
description: 基材物料编码
baseMaterialName:
type: string
description: 基材名称
edge:
type: string
description: 封边
edgeCode:
type: string
description: 封边编码
edgeThickness:
type: number
format: bigdecimal
description: 封边厚度
height:
type: number
format: bigdecimal
description: 高度
materialCode:
type: string
description: 材质编码
materialName:
type: string
description: 材质名称
serialNumber:
type: string
description: 序列号
specialEdge:
type: string
description: 封边(特殊)
specialEdgeCode:
type: string
description: 封边编码(特殊)
specialEdgeThickness:
type: number
format: bigdecimal
description: 特殊封边厚度
thickness:
type: number
format: bigdecimal
description: 板厚
required:
- serialNumber
example:
- activated: 0
baseMaterialCode: ''
baseMaterialName: ''
edge: ''
edgeCode: ''
edgeThickness: 0
height: 0
materialCode: ''
materialName: ''
serialNumber: ''
specialEdge: ''
specialEdgeCode: ''
specialEdgeThickness: 0
thickness: 0
responses:
'200':
description: 成功 / OK
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
description: 请求是否成功 / whether the call succeeded
code:
type: integer
description: 结果码 / result code (0 = success)
msg:
type: string
description: 提示信息 / message
data:
type: object
properties:
addDatas:
type: array
items:
type: object
properties:
activated:
type: integer
format: int32
description: 启用状态, 0-禁用, 1-启用
baseMaterialCode:
type: string
description: 基材物料编码
baseMaterialName:
type: string
description: 基材名称
edge:
type: string
description: 封边
edgeCode:
type: string
description: 封边编码
edgeThickness:
type: number
format: bigdecimal
description: 封边厚度
height:
type: number
format: bigdecimal
description: 高度
materialCode:
type: string
description: 材质编码
materialName:
type: string
description: 材质名称
serialNumber:
type: string
description: 序列号
specialEdge:
type: string
description: 封边(特殊)
specialEdgeCode:
type: string
description: 封边编码(特殊)
specialEdgeThickness:
type: number
format: bigdecimal
description: 特殊封边厚度
thickness:
type: number
format: bigdecimal
description: 板厚
description: 新增的数据
result:
type: boolean
description: 是否更新成功
updateDatas:
type: array
items:
type: object
properties:
activated:
type: integer
format: int32
description: 启用状态, 0-禁用, 1-启用
baseMaterialCode:
type: string
description: 基材物料编码
baseMaterialName:
type: string
description: 基材名称
edge:
type: string
description: 封边
edgeCode:
type: string
description: 封边编码
edgeThickness:
type: number
format: bigdecimal
description: 封边厚度
height:
type: number
format: bigdecimal
description: 高度
materialCode:
type: string
description: 材质编码
materialName:
type: string
description: 材质名称
serialNumber:
type: string
description: 序列号
specialEdge:
type: string
description: 封边(特殊)
specialEdgeCode:
type: string
description: 封边编码(特殊)
specialEdgeThickness:
type: number
format: bigdecimal
description: 特殊封边厚度
thickness:
type: number
format: bigdecimal
description: 板厚
description: 更新的数据
example:
msg: ''
code: 0
data:
updateDatas:
- edgeThickness: 0
specialEdgeThickness: 0
serialNumber: ''
thickness: 0
materialCode: ''
specialEdge: ''
materialName: ''
baseMaterialCode: ''
edge: ''
edgeCode: ''
specialEdgeCode: ''
activated: 0
baseMaterialName: ''
height: 0
result: false
addDatas:
- edgeThickness: 0
specialEdgeThickness: 0
serialNumber: ''
thickness: 0
materialCode: ''
specialEdge: ''
materialName: ''
baseMaterialCode: ''
edge: ''
edgeCode: ''
specialEdgeCode: ''
activated: 0
baseMaterialName: ''
height: 0
success: false
'401':
description: access_token 缺失或已过期 / missing or expired access_token
/api/omni/material/materialDoorPanel/getBySerialNumbers:
post:
operationId: apiOmniMaterialMaterialDoorPanelGetBySerialNumbers
summary: 根据序列号获取门板数据
tags:
- Dedicated Services
x-source-documentation: https://dev.3vjia.com/document?apiId=772118182889672777
x-documentation-category: 专属服务 / C00063204
description: 根据序列号获取门板数据
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
serialNumbers:
type: array
items: {}
description: 列号列表
required:
- serialNumbers
example:
serialNumbers: []
responses:
'200':
description: 成功 / OK
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
description: 请求是否成功 / whether the call succeeded
code:
type: integer
description: 结果码 / result code (0 = success)
msg:
type: string
description: 提示信息 / message
data:
type: object
properties:
activated:
type: integer
format: int32
description: 启用状态, 0-禁用, 1-启用
doorModelCode:
type: string
description: 门型编码
doorModelName:
type: string
description: 门型名称
edge1Code:
type: string
description: 封边1编码
edge1Name:
type: string
description: 封边1名称(厚)
edge1Thickness:
type: number
format: bigdecimal
description: 封边1厚度
edge2Code:
type: string
description: 封边2编码
edge2Name:
type: string
description: 封边2名称(特殊)
edge2Thickness:
type: number
format: bigdecimal
description: 封边2厚度
environmentalGrade:
type: string
description: 环保等级
height:
type: number
format: bigdecimal
description: 高度
materialCode:
type: string
description: 材质编码
materialName:
type: string
description: 材质名称
regularBaseMaterialCode:
type: string
description: 常规基材物料编码
regularBaseMaterialName:
type: string
description: 常规基材名称
serialNumber:
type: string
description: 序列号
surfaceMaterialCode:
type: string
description: 面材编码
surfaceMaterialName:
type: string
description: 面材名称
thickness:
type: number
format: bigdecimal
description: 板厚
typeCode:
type: string
description: 类型编码
typeName:
type: string
description: 类型名称
example:
msg: ''
code: 0
data:
- edge2Thickness: 0
edge1Code: ''
regularBaseMaterialCode: ''
serialNumber: ''
thickness: 0
environmentalGrade: ''
typeName: ''
materialCode: ''
doorModelName: ''
doorModelCode: ''
typeCode: ''
materialName: ''
edge2Code: ''
edge1Thickness: 0
edge2Name: ''
edge1Name: ''
regularBaseMaterialName: ''
surfaceMaterialCode: ''
surfaceMaterialName: ''
activated: 0
height: 0
success: false
'401':
description: access_token 缺失或已过期 / missing or expired access_token
/api/omni/material/materialDoorPanel/update:
post:
operationId: apiOmniMaterialMaterialDoorPanelUpdate
summary: 更新门板数据
tags:
- Dedicated Services
x-source-documentation: https://dev.3vjia.com/document?apiId=772118182889672757
x-documentation-category: 专属服务 / C00063204
description: 更新门板数据
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
activated:
type: integer
format: int32
description: 启用状态, 0-禁用, 1-启用
doorModelCode:
type: string
description: 门型编码
doorModelName:
type: string
description: 门型名称
edge1Code:
type: string
description: 封边1编码
edge1Name:
type: string
description: 封边1名称(厚)
edge1Thickness:
type: number
format: bigdecimal
description: 封边1厚度
edge2Code:
type: string
description: 封边2编码
edge2Name:
type: string
description: 封边2名称(特殊)
edge2Thickness:
type: number
format: bigdecimal
description: 封边2厚度
environmentalGrade:
type: string
description: 环保等级
height:
type: number
format: bigdecimal
description: 高度
materialCode:
type: string
description: 材质编码
materialName:
type: string
description: 材质名称
regularBaseMaterialCode:
type: string
description: 常规基材物料编码
regularBaseMaterialName:
type: string
description: 常规基材名称
serialNumber:
type: string
description: 序列号
surfaceMaterialCode:
type: string
description: 面材编码
surfaceMaterialName:
type: string
description: 面材名称
thickness:
type: number
format: bigdecimal
description: 板厚
typeCode:
type: string
description: 类型编码
typeName:
type: string
description: 类型名称
required:
- serialNumber
example:
- activated: 0
doorModelCode: ''
doorModelName: ''
edge1Code: ''
edge1Name: ''
edge1Thickness: 0
edge2Code: ''
edge2Name: ''
edge2Thickness: 0
environmentalGrade: ''
height: 0
materialCode: ''
materialName: ''
regularBaseMaterialCode: ''
regularBaseMaterialName: ''
serialNumber: ''
surfaceMaterialCode: ''
surfaceMaterialName: ''
thickness: 0
typeCode: ''
typeName: ''
responses:
'200':
description: 成功 / OK
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
description: 请求是否成功 / whether the call succeeded
code:
type: integer
description: 结果码 / result code (0 = success)
msg:
type: string
description: 提示信息 / message
data:
type: object
properties:
addDatas:
type: array
items:
type: object
properties:
activated:
type: integer
format: int32
description: 启用状态, 0-禁用, 1-启用
doorModelCode:
type: string
description: 门型编码
doorModelName:
type: string
description: 门型名称
edge1Code:
type: string
description: 封边1编码
edge1Name:
type: string
description: 封边1名称(厚)
edge1Thickness:
type: number
format: bigdecimal
description: 封边1厚度
edge2Code:
type: string
description: 封边2编码
edge2Name:
type: string
description: 封边2名称(特殊)
edge2Thickness:
type: number
format: bigdecimal
description: 封边2厚度
environmentalGrade:
type: string
description: 环保等级
height:
type: number
format: bigdecimal
description: 高度
materialCode:
type: string
description: 材质编码
materialName:
type: string
description: 材质名称
regularBaseMaterialCode:
type: string
description: 常规基材物料编码
regularBaseMaterialName:
type: string
description: 常规基材名称
serialNumber:
type: string
description: 序列号
surfaceMaterialCode:
type: string
description: 面材编码
surfaceMaterialName:
type: string
description: 面材名称
thickness:
type: number
format: bigdecimal
description: 板厚
typeCode:
type: string
description: 类型编码
typeName:
type: string
description: 类型名称
description: 新增的数据
result:
type: boolean
description: 是否更新成功
updateDatas:
type: array
items:
type: object
properties:
activated:
type: integer
format: int32
description: 启用状态, 0-禁用, 1-启用
doorModelCode:
type: string
description: 门型编码
doorModelName:
type: string
description: 门型名称
edge1Code:
type: string
description: 封边1编码
edge1Name:
type: string
description: 封边1名称(厚)
edge1Thickness:
type: number
format: bigdecimal
description: 封边1厚度
edge2Code:
type: string
description: 封边2编码
edge2Name:
type: string
description: 封边2名称(特殊)
edge2Thickness:
type: number
format: bigdecimal
description: 封边2厚度
environmentalGrade:
type: string
description: 环保等级
height:
type: number
format: bigdecimal
description: 高度
materialCode:
type: string
description: 材质编码
materialName:
type: string
description: 材质名称
regularBaseMaterialCode:
type: string
description: 常规基材物料编码
regularBaseMaterialName:
type: string
description: 常规基材名称
serialNumber:
type: string
description: 序列号
surfaceMaterialCode:
type: string
description: 面材编码
surfaceMaterialName:
type: string
description: 面材名称
thickness:
type: number
format: bigdecimal
description: 板厚
typeCode:
type: string
description: 类型编码
typeName:
type: string
description: 类型名称
description: 修改的数据
example:
msg: ''
code: 0
data:
updateDatas:
- edge2Thickness: 0
edge1Code: ''
regularBaseMaterialCode: ''
serialNumber: ''
thickness: 0
environmentalGrade: ''
typeName: ''
materialCode: ''
doorModelName: ''
doorModelCode: ''
typeCode: ''
materialName: ''
edge2Code: ''
edge1Thickness: 0
edge2Name: ''
edge1Name: ''
regularBaseMaterialName: ''
surfaceMaterialCode: ''
surfaceMaterialName: ''
activated: 0
height: 0
result: false
addDatas:
- edge2Thickness: 0
edge1Code: ''
regularBaseMaterialCode: ''
serialNumber: ''
thickness: 0
environmentalGrade: ''
typeName: ''
materialCode: ''
doorModelName: ''
doorModelCode: ''
typeCode: ''
materialName: ''
edge2Code: ''
edge1Thickness: 0
edge2Name: ''
edge1Name: ''
regularBaseMaterialName: ''
surfaceMaterialCode: ''
surfaceMaterialName: ''
activated: 0
height: 0
success: false
'401':
description: access_token 缺失或已过期 / missing or expired access_token
/api/omni/material/materialWaterproofBoard/getBySerialNumbers:
post:
operationId: apiOmniMaterialMaterialWaterproofBoardGetBySerialNumbers
summary: 根据序列号获取防水板数据
tags:
- Dedicated Services
x-source-documentation: https://dev.3vjia.com/document?apiId=772125320928182344
x-documentation-category: 专属服务 / C00063204
description: 根据序列号获取防水板数据
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
serialNumbers:
type: array
items: {}
description: 列号列表
required:
- serialNumbers
example:
serialNumbers: []
responses:
'200':
description: 成功 / OK
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
description: 请求是否成功 / whether the call succeeded
code:
type: integer
description: 结果码 / result code (0 = success)
msg:
type: string
description: 提示信息 / message
data:
type: object
properties:
activated:
type: integer
format: int32
description: 是否停用,
baseMaterialCode:
type: string
description: 基材物料编码
baseMaterialName:
type: string
description: 基材名称
category:
type: string
description: 品类
categoryCode:
type: string
description: 品类编码
edge:
type: string
description: 封边
edgeCode:
type: string
description: 封边编码
edgeThickness:
type: number
format: bigdecimal
description: 封边厚度
serialNumber:
type: string
description: 序列号
thickness:
type: number
format: bigdecimal
description: 板厚
example:
msg: ''
code: 0
data:
- edgeThickness: 0
serialNumber: ''
thickness: 0
categoryCode: ''
baseMaterialCode: ''
edge: ''
edgeCode: ''
category: ''
activated: 0
baseMaterialName: ''
success: false
'401':
description: access_token 缺失或已过期 / missing or expired access_token
/api/omni/material/materialWaterproofBoard/update:
post:
operationId: apiOmniMaterialMaterialWaterproofBoardUpdate
summary: 更新防水板数据
tags:
- Dedicated Services
x-source-documentation: https://dev.3vjia.com/document?apiId=772124725957771355
x-documentation-category: 专属服务 / C00063204
description: 更新防水板数据
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
activated:
type: integer
format: int32
description: 是否停用,
baseMaterialCode:
type: string
description: 基材物料编码
baseMaterialName:
type: string
description: 基材名称
category:
type: string
description: 品类
categoryCode:
type: string
description: 品类编码
edge:
type: string
description: 封边
edgeCode:
type: string
description: 封边编码
edgeThickness:
type: number
format: bigdecimal
description: 封边厚度
serialNumber:
type: string
description: 序列号
thickness:
type: number
format: bigdecimal
description: 板厚
required:
- serialNumber
example:
- activated: 0
baseMaterialCode: ''
baseMaterialName: ''
category: ''
categoryCode: ''
edge: ''
edgeCode: ''
edgeThickness: 0
serialNumber: ''
thickness: 0
responses:
'200':
description: 成功 / OK
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
description: 请求是否成功 / whether the call succeeded
code:
type: integer
description: 结果码 / result code (0 = success)
msg:
type: string
description: 提示信息 / message
data:
type: object
properties:
addDatas:
type: array
items:
type: object
properties:
activated:
type: integer
format: int32
description: 是否停用,
baseMaterialCode:
type: string
description: 基材物料编码
baseMaterialName:
type: string
description: 基材名称
category:
type: string
description: 品类
categoryCode:
type: string
description: 品类编码
edge:
type: string
description: 封边
edgeCode:
type: string
description: 封边编码
edgeThickness:
type: number
format: bigdecimal
description: 封边厚度
serialNumber:
type: string
description: 序列号
thickness:
type: number
format: bigdecimal
description: 板厚
description: 新增的数据
result:
type: boolean
description: 是否更新成功
updateDatas:
type: array
items:
type: object
properties:
activated:
type: integer
format: int32
description: 是否停用,
baseMaterialCode:
type: string
description: 基材物料编码
baseMaterialName:
type: string
description: 基材名称
category:
type: string
description: 品类
categoryCode:
type: string
description: 品类编码
edge:
type: string
description: 封边
edgeCode:
type: string
description: 封边编码
edgeThickness:
type: number
format: bigdecimal
description: 封边厚度
serialNumber:
type: string
description: 序列号
thickness:
type: number
format: bigdecimal
description: 板厚
description: 更新的数据
example:
msg: ''
code: 0
data:
updateDatas:
- edgeThickness: 0
serialNumber: ''
thickness: 0
categoryCode: ''
baseMaterialCode: ''
edge: ''
edgeCode: ''
category: ''
activated: 0
baseMaterialName: ''
result: false
addDatas:
- edgeThickness: 0
serialNumber: ''
thickness: 0
categoryCode: ''
baseMaterialCode: ''
edge: ''
edgeCode: ''
category: ''
activated: 0
baseMaterialName: ''
success: false
'401':
description: access_token 缺失或已过期 / missing or expired access_token
/api/oude/deleteFactoryOrder:
post:
operationId: apiOudeDeleteFactoryOrder
summary: 删除工厂订单
tags:
- Dedicated Services
x-source-documentation: https://dev.3vjia.com/document?apiId=736604675360575587
x-documentation-category: 专属服务 / C00005461
description: 删除工厂订单
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
orderID:
type: integer
format: int64
description: 订单ID
required:
- orderID
example:
orderID: 0
responses:
'200':
description: 成功 / OK
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
description: 请求是否成功 / whether the call succeeded
code:
type: integer
description: 结果码 / result code (0 = success)
msg:
type: string
description: 提示信息 / message
data:
type: object
example:
msg: ''
code: 0
data: false
success: false
'401':
description: access_token 缺失或已过期 / missing or expired access_token
/api/platformKnowledge/feedback:
post:
operationId: apiPlatformKnowledgeFeedback
summary: 反馈对话内容
tags:
- Dedicated Services
x-source-documentation: https://dev.3vjia.com/document?apiId=622792100353826910
x-documentation-category: 专属服务 / C00000022
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
cid:
type: string
description: 对话id
commentFlag:
type: integer
format: int32
description: 反馈,1:点赞;2:踩
required:
- cid
- commentFlag
example:
commentFlag: 0
cid: ''
responses:
'200':
description: 成功 / OK
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
description: 请求是否成功 / whether the call succeeded
code:
type: integer
description: 结果码 / result code (0 = success)
msg:
type: string
description: 提示信息 / message
data:
type: object
example:
msg: ''
code: 0
success: false
'401':
description: access_token 缺失或已过期 / missing or expired access_token
/api/platformKnowledge/feedbackSession:
post:
operationId: apiPlatformKnowledgeFeedbackSession
summary: 反馈会话内容
tags:
- Dedicated Services
x-source-documentation: https://dev.3vjia.com/document?apiId=622793637171978256
x-documentation-category: 专属服务 / C00000022
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
comment:
type: string
description: 反馈内容
commentFlag:
type: integer
format: int32
description: 是否解决问题,1:已解决;2:未解决
feedbacks:
type: array
items: {}
description: 评分非满分时,前端展示可选反馈项,软件问题多、功能不完善、业务不熟、回复速度慢、服务态度差、其它
score:
type: integer
format: int32
description: 评分
sessionId:
type: string
description: 会话id
zan:
type: integer
format: int32
description: '评分满分时,前端展示可选点赞内容,1: 点赞服务;2:点赞三维家软件;3:all'
required:
- commentFlag
- score
- sessionId
example:
zan: 0
feedbacks: []
sessionId: ''
commentFlag: 0
score: 0
comment: ''
responses:
'200':
description: 成功 / OK
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
description: 请求是否成功 / whether the call succeeded
code:
type: integer
description: 结果码 / result code (0 = success)
msg:
type: string
description: 提示信息 / message
data:
type: object
example:
msg: ''
code: 0
success: false
'401':
description: access_token 缺失或已过期 / missing or expired access_token
/api/platformKnowledge/queryFaq:
post:
operationId: apiPlatformKnowledgeQueryFaq
summary: 获取渠道常用问题
tags:
- Dedicated Services
x-source-documentation: https://dev.3vjia.com/document?apiId=622793637171978258
x-documentation-category: 专属服务 / C00000022
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
channel:
type: string
description: 来源渠道
kid:
type: string
description: 知识库id
nickname:
type: string
description: 用户昵称
sessionId:
type: string
description: 会话id, 用户打开新的聊天窗口时,创建一个会话,同时获取常用问题。
vid:
type: string
description: 用户id
required:
- channel
- kid
- nickname
- sessionId
- vid
example:
kid: ''
channel: ''
sessionId: ''
vid: ''
nickname: ''
responses:
'200':
description: 成功 / OK
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
description: 请求是否成功 / whether the call succeeded
code:
type: integer
description: 结果码 / result code (0 = success)
msg:
type: string
description: 提示信息 / message
data:
type: object
properties:
cid:
type: string
description: 对话id
faq:
type: object
properties:
prefix:
type: string
description: 引导语
questions:
type: array
items:
type: object
properties:
question:
type: string
description: 问题
questionId:
type: string
description: 标问id
required:
- question
- questionId
description: 问题
required:
- prefix
- questions
description: 关联问题
required:
- cid
- faq
example:
msg: ''
code: 0
data:
faq:
prefix: ''
questions:
- questionId: ''
question: ''
cid: ''
success: false
'401':
description: access_token 缺失或已过期 / missing or expired access_token
/api/platformKnowledge/userQuery:
post:
operationId: apiPlatformKnowledgeUserQuery
summary: 根据问题查询答案
tags:
- Dedicated Services
x-source-documentation: https://dev.3vjia.com/document?apiId=622793637171978260
x-documentation-category: 专属服务 / C00000022
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
channel:
type: string
description: 来源渠道
kid:
type: string
description: 知识库id
nickname:
type: string
description: 用户昵称
question:
type: string
description: 问题
sessionId:
type: string
description: 会话id
vid:
type: string
description: 用户id
required:
- channel
- kid
- nickname
- question
- sessionId
- vid
example:
question: ''
kid: ''
channel: ''
sessionId: ''
vid: ''
nickname: ''
responses:
'200':
description: 成功 / OK
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
description: 请求是否成功 / whether the call succeeded
code:
type: integer
description: 结果码 / result code (0 = success)
msg:
type: string
description: 提示信息 / message
data:
type: object
properties:
answer:
type: string
description: 答案,命中问题的时候有值
cid:
type: string
description: 对话id,后续用于对答案的反馈
groups:
type: string
description: 技能组,当需要转人工时有值
recommendQuestion:
type: object
properties:
prefix:
type: string
description: 引导语
questions:
type: array
items:
type: object
properties:
question:
type: string
description: 问题
questionId:
type: string
description: 标问id
required:
- question
- questionId
description: 问题
required:
- prefix
- questions
description: 关联问题
relatedQuestion:
type: object
properties:
prefix:
type: string
description: 引导语
questions:
type: array
items:
type: object
properties:
question:
type: string
description: 问题
questionId:
type: string
description: 标问id
required:
- question
- questionId
description: 问题
required:
- prefix
- questions
description: 关联问题
transferFlag:
type: integer
format: int32
description: 转人工类型,1:直接转人工;2:转到特定技能组;3:引导用户选择技能组
transferPrefix:
type: string
description: 转人工引导语
required:
- cid
- recommendQuestion
- relatedQuestion
- transferFlag
example:
msg: ''
code: 0
data:
transferFlag: 0
recommendQuestion:
prefix: ''
questions:
- questionId: ''
question: ''
groups: ''
relatedQuestion:
prefix: ''
questions:
- questionId: ''
question: ''
answer: ''
transferPrefix: ''
cid: ''
success: false
'401':
description: access_token 缺失或已过期 / missing or expired access_token
/api/platformKnowledge/userQueryById:
post:
operationId: apiPlatformKnowledgeUserQueryById
summary: 根据问题id查询答案
tags:
- Dedicated Services
x-source-documentation: https://dev.3vjia.com/document?apiId=622793637171978262
x-documentation-category: 专属服务 / C00000022
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
channel:
type: string
description: 来源渠道
kid:
type: string
description: 知识库id
nickname:
type: string
description: 用户昵称
questionId:
type: string
description: 问题id
sessionId:
type: string
description: 会话id
vid:
type: string
description: 用户id
required:
- channel
- kid
- nickname
- questionId
- sessionId
- vid
example:
questionId: ''
kid: ''
channel: ''
sessionId: ''
vid: ''
nickname: ''
responses:
'200':
description: 成功 / OK
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
description: 请求是否成功 / whether the call succeeded
code:
type: integer
description: 结果码 / result code (0 = success)
msg:
type: string
description: 提示信息 / message
data:
type: object
properties:
answer:
type: string
description: 答案,命中问题的时候有值
cid:
type: string
description: 对话id,后续用于对答案的反馈
groups:
type: string
description: 技能组,当需要转人工时有值
recommendQuestion:
type: object
properties:
prefix:
type: string
description: 引导语
questions:
type: array
items:
type: object
properties:
question:
type: string
description: 问题
questionId:
type: string
description: 标问id
required:
- question
- questionId
description: 问题
required:
- prefix
- questions
description: 关联问题
relatedQuestion:
type: object
properties:
prefix:
type: string
description: 引导语
questions:
type: array
items:
type: object
properties:
question:
type: string
description: 问题
questionId:
type: string
description: 标问id
required:
- question
- questionId
description: 问题
required:
- prefix
- questions
description: 关联问题
transferFlag:
type: integer
format: int32
description: 转人工类型,1:直接转人工;2:转到特定技能组;3:引导用户选择技能组
transferPrefix:
type: string
description: 转人工引导语
required:
- cid
- recommendQuestion
- relatedQuestion
- transferFlag
example:
msg: ''
code: 0
data:
transferFlag: 0
recommendQuestion:
prefix: ''
questions:
- questionId: ''
question: ''
groups: ''
relatedQuestion:
prefix: ''
questions:
- questionId: ''
question: ''
answer: ''
transferPrefix: ''
cid: ''
success: false
'401':
description: access_token 缺失或已过期 / missing or expired access_token
/api/project/schemeRead:
post:
operationId: apiProjectSchemeRead
summary: 方案已读
tags:
- Dedicated Services
x-source-documentation: https://dev.3vjia.com/document?apiId=822072091900792892
x-documentation-category: 专属服务 / C12684110
description: 方案已读
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
ids:
type: array
items: {}
description: ID列表
projectId:
type: string
description: 外部项目ID
example:
ids: []
projectId: ''
responses:
'200':
description: 成功 / OK
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
description: 请求是否成功 / whether the call succeeded
code:
type: integer
description: 结果码 / result code (0 = success)
msg:
type: string
description: 提示信息 / message
data:
type: object
example:
msg: ''
code: 0
success: false
'401':
description: access_token 缺失或已过期 / missing or expired access_token
/api/qy/factoryOrderOp/getFactoryOrderInfo:
post:
operationId: apiQyFactoryOrderOpGetFactoryOrderInfo
summary: 根据工厂单号或者工厂单ID 获取工厂单详情
tags:
- Dedicated Services
x-source-documentation: https://dev.3vjia.com/document?apiId=803705066879078488
x-documentation-category: 专属服务 / C11876880
description: 根据工厂单号或者工厂单ID 获取工厂单详情
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
orderCode:
type: string
description: 订单号
orderID:
type: integer
format: int64
description: 订单ID
orderIds:
type: array
items: {}
description: 工厂订单IDS
example:
orderID: 0
orderCode: ''
orderIds: []
responses:
'200':
description: 成功 / OK
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
description: 请求是否成功 / whether the call succeeded
code:
type: integer
description: 结果码 / result code (0 = success)
msg:
type: string
description: 提示信息 / message
data:
type: object
properties:
acceptTime:
type: string
format: date-time
description: 接单时间
acceptUserId:
type: string
description: 接单人用户ID
acceptUserRealName:
type: string
description: 接单人
addAmount:
type: number
format: bigdecimal
description: 附加费用金额
amountConfirm:
type: number
format: bigdecimal
description: 已确认金额
amountNotConfirm:
type: number
format: bigdecimal
description: 待确认金额
amountWaitPayment:
type: number
format: bigdecimal
description: 未付金额
appointedBomUserId:
type: string
description: 指定的拆单人用户ID
appointedBomUserRealName:
type: string
description: 指定的拆单人姓名
areaUsage:
type: number
format: bigdecimal
description: 面积用量
assignBomTime:
type: string
format: date-time
description: 分配拆单人时间
assignBomUserId:
type: string
description: 分配拆单人用户ID
assignBomUserRealName:
type: string
description: 分配拆单人姓名
autoSplitRemark:
type: string
description: 自动拆单备注
autoSplitStatus:
type: integer
format: int32
description: 自动拆单状态,0-非自动拆单,1-自动拆单中,2-自动拆单结束
autoSplitStatusDesc:
type: string
description: 自动拆单状态
autoSplitTaskStatus:
type: integer
format: int32
description: 自动拆单任务状态
autoSplitTaskStatusDesc:
type: string
description: 自动拆单任务状态
basicMaterial:
type: string
description: 主颜色
batchId:
type: integer
format: int64
description: 批次Id
batchNo:
type: string
description: 批次号
bomTime:
type: string
format: date-time
description: 拆单时间
bomUserId:
type: string
description: 拆单人用户ID
bomUserRealName:
type: string
description: 拆单人
branchStoreId:
type: string
description: 分店ID
cabinetNo:
type: string
description: 樘号
calculateDeliveryDate:
type: string
format: date
description: 交货期推算日期
category:
type: string
description: 订单类别
chargebackStatus:
type: integer
format: int32
description: 退单状态:0-正常;1-接单回退;2-拆单回退
classificationList:
type: array
items:
type: object
properties:
classificationCode:
type: integer
format: int32
description: 库id
classificationName:
type: string
description: 库名称
qyChannel:
type: string
description: 渠道
description: 从属库
color1:
type: string
description: 颜色1
color1Area:
type: number
format: bigdecimal
description: 颜色1面积
color2:
type: string
description: 颜色2
color2Area:
type: number
format: bigdecimal
description: 颜色2面积
color3:
type: string
description: 颜色3
color3Area:
type: number
format: bigdecimal
description: 颜色3面积
color4:
type: string
description: 颜色4
color4Area:
type: number
format: bigdecimal
description: 颜色4面积
color5:
type: string
description: 颜色5
color5Area:
type: number
format: bigdecimal
description: 颜色5面积
contractNo:
type: string
description: 合同编号
createBatchProgress:
type: string
description: 是否全部生成批次:0-未生成;1-部分生成;2-已全部生成
createOrderUserName:
type: string
createTime:
type: string
format: date-time
description: 创建时间
creatorId:
type: string
description: 创建人id
creatorUserName:
type: string
description: 创建人用户名
customMaterial:
type: string
description: 改色颜色
customOrderItemNo:
type: string
description: 外部销售订单行号
customOrderNo:
type: string
description: 自定义单号
customParameters:
type: string
description: 自定义参数
customSaleOrderNo:
type: string
description: 外部销售订单号
customerAddress:
type: string
description: 业主地址街道
customerArea:
type: string
description: 业主地址区
customerAreaCode:
type: string
description: 业主地址区行政编号
customerCity:
type: string
description: 业主地址市
customerCityCode:
type: string
description: 业主地址市行政编号
customerGender:
type: integer
format: int32
description: 业主性别 (0-未填;1-女;2-男)
customerId:
type: string
description: 业主ID
customerName:
type: string
description: 业主名称
customerPhone:
type: string
description: 业主电话
customerPostcode:
type: string
description: 业主地址邮政编号
customerProvince:
type: string
description: 业主地址省
customerProvinceCode:
type: string
description: 业主地址省行政编号
deliveryContact:
type: string
description: 发货人联系方式
deliveryDate:
type: string
format: date
description: 预交货时间
deliveryPeriod:
type: integer
format: int32
description: 交货周期
deliveryPerson:
type: string
description: 发货人
deliveryQuantity:
type: integer
format: int32
description: 发货件数
deliveryStatus:
type: integer
format: int32
description: 发货状态,1-未发货,2-部分发货,3-已发货
deliveryTime:
type: string
format: date-time
description: 发货时间
deptId:
type: string
description: 创建人部门ID
designerName:
type: string
description: 设计师
designerPhone:
type: string
description: 设计师电话
discountBeforePrice:
type: number
format: bigdecimal
description: 折前金额
discountCoefficient:
type: number
format: bigdecimal
description: 折扣系数
doorWindowType:
type: integer
format: int32
description: 整木类型,1-板式 2-实木
expectPositionCode:
type: string
description: 预分配库位
expectPositionId:
type: integer
format: int64
description: 预分配库位id
externalContractCode:
type: string
description: 外部合同号
externalProjectId:
type: string
description: 外部项目ID
factoryAuditOperator:
type: string
description: 工厂审核人
factoryAuditStatus:
type: integer
format: int32
description: 生产审核状态
factoryAuditStatusDesc:
type: string
description: 生产审核状态
factoryAuditTime:
type: string
format: date-time
description: 工厂审核时间
factoryBaseId:
type: integer
format: int64
description: '''工厂基地id'
factoryBaseName:
type: string
description: '''工厂基地名称'
factoryId:
type: string
description: 下发的工厂ID
factoryOrderSchemeId:
type: integer
format: int64
description: 工厂订单方案id
fdocumentStatus:
type: string
description: 购物车状态
financingAuditTime:
type: string
format: date-time
description: 财务审核时间
financingAuditUserId:
type: string
description: 财务审核人用户ID
financingAuditUserRealName:
type: string
description: 财务审核人
flowCode:
type: string
description: 订单流程Code
flowIconName:
type: string
description: 流程图标名称
flowId:
type: integer
format: int64
description: 订单流程ID
flowNodeCode:
type: string
description: 流程节点Code
flowNodeId:
type: integer
format: int64
description: 流程节点ID
flowNodeStatusName:
type: string
description: 流程节点状态名称
flowNodeTodoName:
type: string
description: 流程节点待办名称
fullSet1:
type: integer
format: int32
description: 齐套1:0-显示“-”,1-齐套1完成
fullSet2:
type: integer
format: int32
description: 齐套2:0-显示“-”,1-齐套2完成
globallyUniqueId:
type: string
description: 全局唯一id
id:
type: integer
format: int64
description: 主键id
installPosition:
type: string
description: 安装位置
invalidOperateTime:
type: string
format: date-time
description: 作废操作时间
invalidOperateUserId:
type: string
description: 作废操作人ID
invalidOperateUserRealName:
type: string
description: 作废操作人名字
isAgainSubmit:
type: integer
format: int32
description: 是否重新提交:0-否,1-是
isBomStatus:
type: integer
format: int32
description: 3D拆单状态(0:拆单中,1已拆单)
isCanChange:
type: integer
format: int32
description: 是否可以改单,0-否,1-是
isCanGoBack:
type: integer
format: int32
description: 是否可退回:0-不可退回 1-可退回
isChangeOrder:
type: integer
format: int32
description: 是否改单
isCustomColor:
type: integer
format: int32
description: 是否改色
isDesignDrawing:
type: integer
format: int32
description: 是否设计出图进行分配:1-是;0-否
isDownLoad:
type: boolean
description: 3D审核列表是否有下载附件
isEngineeringOrder:
type: integer
format: int32
description: 是否工程单(0否,1是)
isFactoryAuditBack:
type: integer
format: int32
description: 工厂审核是否退回 0=否 1=是,默认1
isFactoryOrderAll:
type: integer
format: int32
description: 工厂单齐套,0否,1是
isFactoryQuote:
type: integer
format: int32
description: 工厂是否报价,0-否,1-是,用来判断节点是否在报价之后
isHandOperater:
type: integer
format: int32
description: 是否手动操作改变生产/入库/发货状态;0-否;1-是
isHandOperaterDelivery:
type: integer
format: int32
description: 是否手动操作改变发货;0-否;1-是
isHandOperaterWarehouse:
type: integer
format: int32
description: 是否手动操作改变入库;0-否;1-是
isHavedPack:
type: boolean
description: 是否已包装
isNoUpdateFactoryOrderProductRemarks:
type: boolean
description: 是否不更新工厂订单产品备注
isOutsourcing:
type: integer
format: int32
description: 是否委外(0:否,1:是)
isSaleOrderAll:
type: integer
format: int32
description: 销售单齐套 0否,1是
isSplitCollaborate:
type: integer
format: int32
description: 是否拆单协作(0:否,1:是)
isSuspend:
type: integer
format: int32
description: 是否暂停,0-否,1-是
isTableBoard:
type: integer
format: int32
description: 是否有台面板(0:否,1:是)
isTempOrder:
type: integer
format: int32
description: 是否临时单(0:否,1:是)
isUrgent:
type: integer
format: int32
description: 是否加急
isValid:
type: integer
format: int32
description: 是否作废:0=否, 1=是
logisticsAddress:
type: string
description: 物流信息地址
material:
type: string
description: 主材
modifierUserName:
type: string
description: 更新人用户名
moduleCode:
type: string
description: 模块代码 cupboard 橱柜,wardrobe 衣柜,systemCabinet 系统柜,furnitureType 成品,ceilingAll 顶墙,doorWindow 门窗,bathRoom 淋浴房,aluminum 铝门窗
moduleName:
type: string
description: 模块名称 橱柜,衣柜,系统柜,成品,顶墙,门窗,淋浴房,铝门窗
natureOfOrder:
type: string
description: 订单性质
nextFlowNodeCode:
type: string
description: 下一个流程节点Code
nextFlowNodeId:
type: integer
format: int64
description: 下一个流程节点ID
orderCategoryDictKey:
type: string
description: 订单品类字典Key
orderCategoryDictVal:
type: string
description: 订单品类字典Value
orderCode:
type: string
description: 订单编号
orderName:
type: string
description: 订单名称
orderRebateAmount:
type: number
format: bigdecimal
description: 分摊返利金额
orderSource:
type: string
description: 订单来源(默认mes,金牌:jinp)
orderSuit:
type: integer
format: int32
description: 订单套数(默认1,最大999)
orderTypeCode:
type: string
description: 订单类型
orderTypeDictKey:
type: string
description: 订单类型字典Key
orderTypeDictVal:
type: string
description: 订单类型字典Value
orderTypeName:
type: string
description: 订单类型名称
organDealerAreaCode:
type: string
description: 企业经销商归属区域编码
organDealerAreaName:
type: string
description: 企业经销商归属区域名称
organDealerCode:
type: string
description: 企业经销商编号
organDealerId:
type: integer
format: int64
description: 企业经销商Id
organDealerName:
type: string
description: 企业经销商名称
organId:
type: string
description: 机构ID
originalAmount:
type: number
format: bigdecimal
description: 产品原价格(JSON赋值)不可修改
outsourcingButtonStatus:
type: integer
format: int32
description: 外购板件是否MPM扫描包装按钮状态,0-不显示,1-可编辑,2-不可编辑
outsourcingPartMpmPacking:
type: integer
format: int32
description: 外购板件是否MPM扫描包装,0-否,1-是'
packageAuditStatus:
type: integer
format: int32
description: 分包审核状态,0-待审核,1-已审核
payStatus:
type: integer
format: int32
description: 支付状态(0=待付款; 1=未结清; 2=已结清)
payTime:
type: string
format: date-time
description: 订单支付时间
payWay:
type: string
description: 支付方式code
payWayName:
type: string
description: 支付方式名称
payableAmount:
type: number
format: bigdecimal
description: 订单报价后应付金额(支付价)
placeTypeDictKey:
type: string
description: 下单类型字典Key
placeTypeDictVal:
type: string
description: 下单类型字典Value
planDeliveryDate:
type: string
format: date
description: 计划工厂交货日期,财务审核后基于规则计算得出
preAuditOperator:
type: string
description: 预订单审核人
preAuditTime:
type: string
format: date-time
description: 预订单审核时间
preDistributionQuoterTime:
type: string
format: date
description: 预报价员分配时间
preOrderAuditRemark:
type: string
description: 预订单审核备注
preOrderAuditStatus:
type: integer
format: int32
description: 预订单审核状态(0:待审核;1:已审核 ,2:审核拒绝)
preQuoterName:
type: string
description: 预报价员名称
preQuoterUserId:
type: string
description: 预报价员ID
prevFlowNodeId:
type: integer
format: int64
description: 前一个流程节点ID,主要用于回退
priceAuditAmounts:
type: number
format: bigdecimal
description: 价格审核总金额
priceAuditOperator:
type: string
description: 价格审核人
priceAuditStatus:
type: integer
format: int32
description: 价格审核状态
priceAuditStatusDesc:
type: string
description: 价格审核状态
priceAuditTime:
type: string
format: date-time
description: 价格审核时间
pricingMethod:
type: string
description: 取价方式
productQty:
type: integer
format: int32
productTotalPrice:
type: number
format: bigdecimal
description: 产品总价
productionAmount:
type: number
format: bigdecimal
description: 产品金额
productionDataCreateStatus:
type: integer
format: int32
description: 创建生产订单状态 0-未生成;1-生成中;2-生成成功;3-生成失败
productionLine:
type: string
description: 生产线
productionSize:
type: string
description: 尺寸
productionSystem:
type: string
description: 订单生产的生产系统:oms=oms自带合批排产, aps=使用aps系统排产生产
productionTime:
type: string
format: date-time
description: 生产时间
projectId:
type: string
description: 项目id
projectName:
type: string
description: 项目名称
quoteJsonUrl:
type: string
description: 报价jsonURL
quoteTime:
type: string
format: date-time
description: 报价时间
qyUserId:
type: string
description: 全友审核人ID
rebateBillSettlementAmount:
type: number
format: bigdecimal
description: 返利结算金额
rebatePrice:
type: number
format: bigdecimal
description: 返利金额
rebatesSettlementAmount:
type: number
format: bigdecimal
description: 返点结算金额
receiverAddress:
type: string
description: 收货人地址街道
receiverArea:
type: string
description: 收货人地址区
receiverAreaCode:
type: string
description: 收货人地址区行政编号
receiverCity:
type: string
description: 收货人地址市
receiverCityCode:
type: string
description: 收货人地址市行政编号
receiverGender:
type: integer
format: int32
description: 收货人性别 (0-未填;1-女;2-男)
receiverName:
type: string
description: 收货人姓名
receiverPhone:
type: string
description: 收货人电话
receiverPostcode:
type: string
description: 收货人地址邮编
receiverProvince:
type: string
description: 收货人地址省
receiverProvinceCode:
type: string
description: 收货人地址省行政编号
receiverType:
type: string
description: 收货人类型 customer=业主 shop=门店
receivingRemarks:
type: string
description: 企业解析备注
receivingStatus:
type: string
description: 企业解析状态
relateFactoryOrderCode:
type: string
description: 关联工厂单编号
relateFactoryOrderId:
type: integer
format: int64
description: 关联工厂单ID
remarks:
type: string
description: 3D下单备注
roomName:
type: string
description: 空间名称
saleOrderCode:
type: string
description: 售后子订单编号
saleOrderId:
type: integer
format: int64
description: 售后子订单ID
salesName:
type: string
description: 销售
salesPrice:
type: number
format: bigdecimal
description: 销售价
salesQuoteJsonUrl:
type: string
description: 销售价报价json
schemeId:
type: string
description: 3D方案号
schemeName:
type: string
description: 方案名称
schemePreviewImage:
type: string
description: 方案预览图
schemeRemark:
type: string
description: 方案备注
schemeVersion:
type: string
description: 方案版本号
serialNumber:
type: string
description: 序号01-999
settlementAmount:
type: number
format: bigdecimal
description: 结算金额
shipmentType:
type: string
description: 出货类型
shopAuditOperator:
type: string
description: 门店审核人
shopAuditStatus:
type: integer
format: int32
description: 门店审核状态
shopAuditStatusDesc:
type: string
description: 门店审核状态
shopAuditTime:
type: string
format: date-time
description: 门店审核时间
shopCode:
type: string
description: 门店编码
shopDeptId:
type: string
description: 经销商所在部门id
shopId:
type: string
description: 经销商ID
shopName:
type: string
description: 经销商名称
shopOrderCode:
type: string
description: 门店订单Code
shopOrderId:
type: integer
format: int64
description: 门店订单ID
shopOrderName:
type: string
description: 销售订单名称
shopOrderRemark:
type: string
description: 门店订单备注
shopOrderSubmitTime:
type: string
format: date-time
description: 店铺订单提交时间
shoppingCartId:
type: integer
format: int64
description: 购物车id
splitNum:
type: integer
format: int32
description: 拆单次数
splitOrderImage:
type: string
description: 拆单主图
splitStatus:
type: integer
format: int32
description: 拆单状态:-1-退回;0-未拆单;1-拆单中;2-已拆单
splitXmlUrl:
type: string
description: 拆单方案xml路径
submitUserId:
type: string
description: 店铺订单提交人用户ID
submitUserName:
type: string
description: 店铺订单提交人账号
submitUserPhone:
type: string
description: 店铺订单提交人手机号码
submitUserRealName:
type: string
description: 店铺订单提交人用户姓名
surcharge:
type: number
format: bigdecimal
description: 附加费用
suspendTime:
type: string
format: date-time
description: 订单暂停时间
suspendUserId:
type: string
description: 订单暂停人用户ID
suspendUserRealName:
type: string
description: 订单暂停人姓名
systemEnvironment:
type: string
taxCategory:
type: string
description: 税种
totalArea:
type: number
format: bigdecimal
description: 展开面积(平米)
totalPrice:
type: number
format: bigdecimal
description: 订单总价(原价)
tradePrice:
type: number
format: bigdecimal
description: 交易单价
unitCategoryName:
type: string
description: 商品品类名称
urlParam:
type: string
description: 外部参数
validReason:
type: string
description: 作废原因
warehousingTime:
type: string
format: date-time
description: 入库时间
workOrderNo:
type: string
description: 外部工单号
reviewOrderName:
type: string
description: 审核单名称
required:
- createTime
- id
example:
msg: ''
code: 0
data:
customerPostcode: ''
financingAuditUserRealName: ''
productionDataCreateStatus: 0
customMaterial: ''
salesPrice: 0
color5: ''
basicMaterial: ''
color3: ''
color4: ''
color1: ''
color2: ''
color2Area: 0
rebateBillSettlementAmount: 0
receiverPhone: ''
isFactoryOrderAll: 0
isOutsourcing: 0
customerAreaCode: ''
isEngineeringOrder: 0
rebatesSettlementAmount: 0
deliveryContact: ''
customerProvinceCode: ''
externalContractCode: ''
placeTypeDictKey: ''
isFactoryQuote: 0
orderRebateAmount: 0
customerAddress: ''
financingAuditUserId: ''
designerPhone: ''
relateFactoryOrderId: 0
deptId: ''
orderTypeDictVal: ''
customerArea: ''
customerName: ''
isDownLoad: false
splitStatus: 0
warehousingTime: ''
unitCategoryName: ''
flowNodeTodoName: ''
assignBomTime: ''
invalidOperateTime: ''
deliveryStatus: 0
schemePreviewImage: ''
priceAuditOperator: ''
chargebackStatus: 0
payWayName: ''
deliveryTime: ''
preAuditOperator: ''
relateFactoryOrderCode: ''
priceAuditAmounts: 0
factoryAuditStatus: 0
qyUserId: ''
saleOrderId: 0
acceptUserRealName: ''
bomUserId: ''
payableAmount: 0
customOrderNo: ''
shipmentType: ''
autoSplitTaskStatusDesc: ''
splitXmlUrl: ''
isHavedPack: false
autoSplitStatusDesc: ''
customerId: ''
receivingRemarks: ''
factoryBaseId: 0
workOrderNo: ''
isSaleOrderAll: 0
orderName: ''
shopOrderCode: ''
autoSplitRemark: ''
moduleCode: ''
areaUsage: 0
priceAuditTime: ''
isNoUpdateFactoryOrderProductRemarks: false
fullSet2: 0
fullSet1: 0
cabinetNo: ''
orderTypeName: ''
reviewOrderName: ''
fdocumentStatus: ''
organDealerCode: ''
salesQuoteJsonUrl: ''
validReason: ''
createTime: ''
customParameters: ''
organDealerAreaName: ''
totalArea: 0
isHandOperaterDelivery: 0
productionSize: ''
isCanGoBack: 0
isBomStatus: 0
payTime: ''
isHandOperater: 0
suspendUserId: ''
receiverProvince: ''
shoppingCartId: 0
autoSplitStatus: 0
preDistributionQuoterTime: ''
customOrderItemNo: ''
systemEnvironment: ''
productionLine: ''
shopId: ''
isCustomColor: 0
preAuditTime: ''
isDesignDrawing: 0
isTableBoard: 0
batchNo: ''
serialNumber: ''
flowNodeId: 0
shopAuditStatus: 0
color5Area: 0
addAmount: 0
schemeName: ''
flowNodeStatusName: ''
isAgainSubmit: 0
receiverAddress: ''
factoryAuditTime: ''
salesName: ''
preOrderAuditRemark: ''
projectName: ''
projectId: ''
tradePrice: 0
doorWindowType: 0
isSuspend: 0
preQuoterName: ''
receiverGender: 0
appointedBomUserRealName: ''
isHandOperaterWarehouse: 0
createBatchProgress: ''
shopOrderName: ''
orderCategoryDictVal: ''
flowCode: ''
natureOfOrder: ''
deliveryQuantity: 0
flowId: 0
classificationList:
- classificationCode: 0
classificationName: ''
qyChannel: ''
color1Area: 0
packageAuditStatus: 0
shopAuditOperator: ''
outsourcingPartMpmPacking: 0
suspendTime: ''
orderTypeDictKey: ''
schemeVersion: ''
quoteJsonUrl: ''
quoteTime: ''
material: ''
originalAmount: 0
productionAmount: 0
orderCode: ''
invalidOperateUserId: ''
receiverProvinceCode: ''
schemeRemark: ''
surcharge: 0
pricingMethod: ''
isFactoryAuditBack: 0
moduleName: ''
receiverCity: ''
urlParam: ''
orderCategoryDictKey: ''
receiverAreaCode: ''
amountConfirm: 0
assignBomUserId: ''
bomTime: ''
isTempOrder: 0
id: 0
autoSplitTaskStatus: 0
shopDeptId: ''
deliveryPerson: ''
factoryId: ''
splitNum: 0
isSplitCollaborate: 0
acceptTime: ''
receiverPostcode: ''
organDealerId: 0
color4Area: 0
factoryBaseName: ''
flowIconName: ''
shopOrderId: 0
receiverType: ''
externalProjectId: ''
organId: ''
nextFlowNodeId: 0
productQty: 0
isUrgent: 0
factoryAuditStatusDesc: ''
totalPrice: 0
contractNo: ''
priceAuditStatusDesc: ''
customerPhone: ''
customerCityCode: ''
amountNotConfirm: 0
invalidOperateUserRealName: ''
deliveryDate: ''
globallyUniqueId: ''
saleOrderCode: ''
shopCode: ''
customerGender: 0
isValid: 0
preQuoterUserId: ''
discountCoefficient: 0
splitOrderImage: ''
installPosition: ''
modifierUserName: ''
assignBomUserRealName: ''
settlementAmount: 0
isChangeOrder: 0
orderTypeCode: ''
color3Area: 0
productTotalPrice: 0
payWay: ''
branchStoreId: ''
submitUserPhone: ''
shopAuditStatusDesc: ''
createOrderUserName: ''
factoryAuditOperator: ''
deliveryPeriod: 0
productionSystem: ''
bomUserRealName: ''
customerProvince: ''
planDeliveryDate: ''
roomName: ''
preOrderAuditStatus: 0
submitUserId: ''
taxCategory: ''
shopAuditTime: ''
suspendUserRealName: ''
discountBeforePrice: 0
receivingStatus: ''
isCanChange: 0
financingAuditTime: ''
logisticsAddress: ''
creatorUserName: ''
creatorId: ''
receiverCityCode: ''
shopName: ''
schemeId: ''
customerCity: ''
expectPositionId: 0
batchId: 0
expectPositionCode: ''
submitUserName: ''
orderSuit: 0
outsourcingButtonStatus: 0
organDealerName: ''
placeTypeDictVal: ''
priceAuditStatus: 0
shopOrderRemark: ''
organDealerAreaCode: ''
orderSource: ''
acceptUserId: ''
customSaleOrderNo: ''
amountWaitPayment: 0
calculateDeliveryDate: ''
receiverName: ''
factoryOrderSchemeId: 0
receiverArea: ''
submitUserRealName: ''
designerName: ''
flowNodeCode: ''
rebatePrice: 0
shopOrderSubmitTime: ''
category: ''
prevFlowNodeId: 0
nextFlowNodeCode: ''
payStatus: 0
productionTime: ''
appointedBomUserId: ''
remarks: ''
success: false
'401':
description: access_token 缺失或已过期 / missing or expired access_token
/api/qy/factoryOrderOp/getRejectRenark:
post:
operationId: apiQyFactoryOrderOpGetRejectRenark
summary: 根据工厂单号或者工厂单ID 获取驳回备注
tags:
- Dedicated Services
x-source-documentation: https://dev.3vjia.com/document?apiId=803706723012591644
x-documentation-category: 专属服务 / C11876880
description: 根据工厂单号或者工厂单ID 获取驳回备注
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
orderCode:
type: string
description: 订单号
orderID:
type: integer
format: int64
description: 订单ID
reviewInformation:
type: string
description: 属性Json
example:
orderID: 0
reviewInformation: ''
orderCode: ''
responses:
'200':
description: 成功 / OK
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
description: 请求是否成功 / whether the call succeeded
code:
type: integer
description: 结果码 / result code (0 = success)
msg:
type: string
description: 提示信息 / message
data:
type: object
example:
msg: ''
code: 0
data: ''
success: false
'401':
description: access_token 缺失或已过期 / missing or expired access_token
/api/qy/factoryOrderOp/getReviewInformation:
post:
operationId: apiQyFactoryOrderOpGetReviewInformation
summary: 根据工厂单号或者工厂单ID 获取提审信息
tags:
- Dedicated Services
x-source-documentation: https://dev.3vjia.com/document?apiId=803706723012591626
x-documentation-category: 专属服务 / C11876880
description: 根据工厂单号或者工厂单ID 获取提审信息
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
orderCode:
type: string
description: 订单号
orderID:
type: integer
format: int64
description: 订单ID
example:
orderID: 0
orderCode: ''
responses:
'200':
description: 成功 / OK
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
description: 请求是否成功 / whether the call succeeded
code:
type: integer
description: 结果码 / result code (0 = success)
msg:
type: string
description: 提示信息 / message
data:
type: object
example:
msg: ''
code: 0
data: ''
success: false
'401':
description: access_token 缺失或已过期 / missing or expired access_token
/api/qy/factoryOrderOp/reviewShoppingCart:
post:
operationId: apiQyFactoryOrderOpReviewShoppingCart
summary: 审核通过驳回
tags:
- Dedicated Services
x-source-documentation: https://dev.3vjia.com/document?apiId=803705318545703009
x-documentation-category: 专属服务 / C11876880
description: 审核通过驳回
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
flag:
type: integer
format: int32
description: 通过/驳回(0驳回,1通过)
orderCode:
type: string
description: 订单号
orderID:
type: integer
format: int64
description: 订单ID
remark:
type: string
description: 备注:驳回:必填,通过:非必填
required:
- flag
example:
flag: 0
orderID: 0
remark: ''
orderCode: ''
responses:
'200':
description: 成功 / OK
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
description: 请求是否成功 / whether the call succeeded
code:
type: integer
description: 结果码 / result code (0 = success)
msg:
type: string
description: 提示信息 / message
data:
type: object
example:
msg: ''
code: 0
success: false
'401':
description: access_token 缺失或已过期 / missing or expired access_token
/api/qy/factoryOrderOp/updateReviewInformation:
post:
operationId: apiQyFactoryOrderOpUpdateReviewInformation
summary: 修改提审信息
tags:
- Dedicated Services
x-source-documentation: https://dev.3vjia.com/document?apiId=803706576753016895
x-documentation-category: 专属服务 / C11876880
description: 修改提审信息
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
orderCode:
type: string
description: 订单号
orderID:
type: integer
format: int64
description: 订单ID
reviewInformation:
type: string
description: 属性Json
example:
orderID: 0
reviewInformation: ''
orderCode: ''
responses:
'200':
description: 成功 / OK
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
description: 请求是否成功 / whether the call succeeded
code:
type: integer
description: 结果码 / result code (0 = success)
msg:
type: string
description: 提示信息 / message
data:
type: object
example:
msg: ''
code: 0
success: false
'401':
description: access_token 缺失或已过期 / missing or expired access_token
/api/render/aiCreationFeeCalculation:
post:
operationId: apiRenderAiCreationFeeCalculation
summary: 消耗创点数量计算
tags:
- Xuanchi AI
x-source-documentation: https://dev.3vjia.com/document?apiId=723926385059577893
x-documentation-category: 玄尺AI / AI设计
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
singleCount:
type: integer
format: int32
description: 单次作品数量(如:张、秒、次), 默认1
examples:
- '5'
modelVersion:
type: string
description: 模型版本
bizType:
type: integer
format: int32
description: 业务类型:文生图-9;图片裂变-10;图生视频-13;线稿出图-20;毛坯设计2-30;旧房改造2-31;
examples:
- '13'
required:
- singleCount
- bizType
example:
bizType: 13
modelVersion: ''
singleCount: 5
responses:
'200':
description: 成功 / OK
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
description: 请求是否成功 / whether the call succeeded
code:
type: integer
description: 结果码 / result code (0 = success)
msg:
type: string
description: 提示信息 / message
data:
type: object
properties:
consumeQuantity:
type: number
description: 消费点数
examples:
- '30'
rightsType:
type: string
description: 权益类型
examples:
- InspirationCreativePoint
canUse:
type: boolean
description: 是否可以使用
examples:
- 'true'
unusableReason:
type: string
description: 不可用原因
examples:
- ' '
example:
msg: 成功
code: 0
data:
rightsType: InspirationCreativePoint
consumeQuantity: 30
canUse: true
unusableReason: ' '
success: true
'401':
description: access_token 缺失或已过期 / missing or expired access_token
/api/render/aiRoomDesign:
post:
operationId: apiRenderAiRoomDesign
summary: AI空间设计
tags:
- Xuanchi AI
x-source-documentation: https://dev.3vjia.com/document?apiId=853284256691142751
x-documentation-category: 玄尺AI / AI设计
description: AI 空间设计
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
images:
type: array
items: {}
description: 空间设计图片列表,原始图放第一张,产品图放后面
required:
- images
example:
images: []
responses:
'200':
description: 成功 / OK
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
description: 请求是否成功 / whether the call succeeded
code:
type: integer
description: 结果码 / result code (0 = success)
msg:
type: string
description: 提示信息 / message
data:
type: object
properties:
info:
type: string
description: 生成信息
taskId:
type: string
description: 任务ID
example:
msg: ''
code: 0
data:
taskId: ''
info: ''
success: false
'401':
description: access_token 缺失或已过期 / missing or expired access_token
/api/render/backgroundPaint:
post:
operationId: apiRenderBackgroundPaint
summary: 背景图重绘
tags:
- Xuanchi AI
x-source-documentation: https://dev.3vjia.com/document?apiId=726032261073490012
x-documentation-category: 玄尺AI / AI设计
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
prompt:
type: string
description: 提示词
examples:
- 现代风格
initImage:
type: string
description: 原图
examples:
- https://xxx.com/xxx.jpg
maskImage:
type: string
description: 遮罩图
examples:
- https://xxx.com/xxx.jpg
batchCount:
type: integer
format: int32
description: 出图张数,默认1
examples:
- '1'
required:
- initImage
- maskImage
example:
initImage: https://xxx.com/xxx.jpg
batchCount: 1
prompt: 现代风格
maskImage: https://xxx.com/xxx.jpg
responses:
'200':
description: 成功 / OK
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
description: 请求是否成功 / whether the call succeeded
code:
type: integer
description: 结果码 / result code (0 = success)
msg:
type: string
description: 提示信息 / message
data:
type: object
properties:
info:
type: string
description: 生成信息
examples:
- 任务已发送至队列中
taskId:
type: string
description: 任务ID
examples:
- 0bc2b9b6-3b4e-4c5b-a490-4aaaf4e81416
example:
msg: 成功
code: 0
data:
taskId: 0bc2b9b6-3b4e-4c5b-a490-4aaaf4e81416
info: 任务已发送至队列中
success: true
'401':
description: access_token 缺失或已过期 / missing or expired access_token
/api/render/bricksChange:
post:
operationId: apiRenderBricksChange
summary: 产品替换-换砖
tags:
- Xuanchi AI
x-source-documentation: https://dev.3vjia.com/document?apiId=725393727069241376
x-documentation-category: 玄尺AI / AI设计
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
templateId:
type: integer
format: int64
description: 渲染模板配置ID。见文档:https://help.3vjia.com/doc/open_doc/456823276459593731/723925629921284207
examples:
- '649971879238631495'
extraParams:
type: object
description: '扩展信息。分辨率:aspectRatio。示例:{"aspectRatio": "1536x1024"}'
sourceImageUrl:
type: string
description: 原图片
replaceTarget:
type: string
description: 区域
examples:
- 地板
default: 地板
products:
type: array
items:
type: object
properties:
imageUrl:
type: string
description: 产品图片
required:
- imageUrl
description: 产品信息列表
prompt:
type: string
description: 提示语
modelVersion:
type: string
default: i_o_2
required:
- extraParams
- sourceImageUrl
- products
example:
modelVersion: ''
extraParams: ''
templateId: 649971879238631495
products:
- imageUrl: ''
replaceTarget: 地板
sourceImageUrl: ''
prompt: ''
responses:
'200':
description: 成功 / OK
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
description: 请求是否成功 / whether the call succeeded
code:
type: integer
description: 结果码 / result code (0 = success)
msg:
type: string
description: 提示信息 / message
data:
type: object
properties:
info:
type: string
description: 生成信息
examples:
- 任务已发送至队列中
taskId:
type: string
description: 任务ID
examples:
- 0bc2b9b6-3b4e-4c5b-a490-4aaaf4e81416
example:
msg: 成功
code: 0
data:
taskId: 0bc2b9b6-3b4e-4c5b-a490-4aaaf4e81416
info: 任务已发送至队列中
success: true
'401':
description: access_token 缺失或已过期 / missing or expired access_token
/api/render/changeMaterial:
post:
operationId: apiRenderChangeMaterial
summary: 产品替换-换材质
tags:
- Xuanchi AI
x-source-documentation: https://dev.3vjia.com/document?apiId=725378201261588550
x-documentation-category: 玄尺AI / AI设计
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
extraParams:
type: object
description: '扩展信息,分辨率:aspectRatio。示例:{ "aspectRatio": "1536x1024" }'
examples:
- '{ "aspectRatio": "1536x1024" }'
sourceImageUrl:
type: string
description: 原图片
products:
type: array
items:
type: object
properties:
imageUrl:
type: string
description: 材质图片
examples:
- https://xxx.com/xxx.jpg
selectedLabels:
type: array
items: {}
description: 替换的目标标签。如:地砖
examples:
- 地砖
required:
- imageUrl
- selectedLabels
prompt:
type: string
description: 提示词
default: ' '
required:
- extraParams
- sourceImageUrl
example:
extraParams: ''
products:
- imageUrl: https://xxx.com/xxx.jpg
selectedLabels: []
sourceImageUrl: ''
prompt: ''
responses:
'200':
description: 成功 / OK
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
description: 请求是否成功 / whether the call succeeded
code:
type: integer
description: 结果码 / result code (0 = success)
msg:
type: string
description: 提示信息 / message
data:
type: object
properties:
info:
type: string
description: 生成信息
examples:
- 任务已发送至队列中
taskId:
type: string
description: 任务ID
examples:
- 0bc2b9b6-3b4e-4c5b-a490-4aaaf4e81416
example:
msg: 成功
code: 0
data:
taskId: 0bc2b9b6-3b4e-4c5b-a490-4aaaf4e81416
info: 任务已发送至队列中
success: true
'401':
description: access_token 缺失或已过期 / missing or expired access_token
/api/render/checkProductWhiteBg:
post:
operationId: apiRenderCheckProductWhiteBg
summary: 商品白底图合格检测
tags:
- Xuanchi AI
x-source-documentation: https://dev.3vjia.com/document?apiId=827234429176025105
x-documentation-category: 玄尺AI / AI设计
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
imageUrl:
type: string
description: 商品白底图URL
required:
- imageUrl
example:
imageUrl: ''
responses:
'200':
description: 成功 / OK
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
description: 请求是否成功 / whether the call succeeded
code:
type: integer
description: 结果码 / result code (0 = success)
msg:
type: string
description: 提示信息 / message
data:
type: object
properties:
result:
type: string
description: 检测结果
reason:
type: array
items: {}
description: 原因列表
example:
msg: ''
code: 0
data:
reason: []
result: ''
success: false
'401':
description: access_token 缺失或已过期 / missing or expired access_token
/api/render/comfyCommon:
post:
operationId: apiRenderComfyCommon
summary: 空间填充3.0
tags:
- Xuanchi AI
x-source-documentation: https://dev.3vjia.com/document?apiId=791370289819828290
x-documentation-category: 玄尺AI / AI设计
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
batchCount:
type: integer
format: int32
description: 出图数量,默认是1张
default: '1'
initImage:
type: string
description: 初始图片
prompt:
type: string
description: 提示词
extImageUrls:
type: array
items: {}
description: 扩展图片,当前任务支持传递1张风格参考图
required:
- initImage
example:
initImage: ''
batchCount: 0
extImageUrls: []
prompt: ''
responses:
'200':
description: 成功 / OK
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
description: 请求是否成功 / whether the call succeeded
code:
type: integer
description: 结果码 / result code (0 = success)
msg:
type: string
description: 提示信息 / message
data:
type: object
properties:
info:
type: string
description: 生成信息
taskId:
type: string
description: 任务ID
example:
msg: ''
code: 0
data:
taskId: ''
info: ''
success: false
'401':
description: access_token 缺失或已过期 / missing or expired access_token
/api/render/comfyTextureChangeV2:
post:
operationId: apiRenderComfyTextureChangeV2
summary: 产品替换-换墙涂料2.0
tags:
- Xuanchi AI
x-source-documentation: https://dev.3vjia.com/document?apiId=725383989417889891
x-documentation-category: 玄尺AI / AI设计
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
extraParams:
type: object
description: '扩展信息。分辨率:aspectRatio。示例:{ "aspectRatio": "1536x1024" }'
sourceImageUrl:
type: string
description: 原图片
examples:
- https://xxx.com/xxx.jpg
products:
type: array
items:
type: object
properties:
imageUrl:
type: string
prompt:
type: string
description: 提示词
required:
- extraParams
example:
extraParams: ''
products:
- imageUrl: ''
sourceImageUrl: https://xxx.com/xxx.jpg
prompt: ''
responses:
'200':
description: 成功 / OK
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
description: 请求是否成功 / whether the call succeeded
code:
type: integer
description: 结果码 / result code (0 = success)
msg:
type: string
description: 提示信息 / message
data:
type: object
properties:
info:
type: string
description: 生成信息
examples:
- 任务已发送至队列中
taskId:
type: string
description: 任务ID
examples:
- 0bc2b9b6-3b4e-4c5b-a490-4aaaf4e81416
example:
msg: 成功
code: 0
data:
taskId: 0bc2b9b6-3b4e-4c5b-a490-4aaaf4e81416
info: 任务已发送至队列中
success: true
'401':
description: access_token 缺失或已过期 / missing or expired access_token
/api/render/comfyTextureChangeV3:
post:
operationId: apiRenderComfyTextureChangeV3
summary: 换墙涂料3.0
tags:
- Xuanchi AI
x-source-documentation: https://dev.3vjia.com/document?apiId=791009915224346764
x-documentation-category: 玄尺AI / AI设计
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
initImage:
type: string
description: 初始图片
examples:
- https://3vj-innovation.3vjia.com/demo/tree31_2.png
styleImage:
type: string
description: 涂料图
examples:
- https://3vj-innovation.3vjia.com/demo/tree_p.png
reduce:
type: integer
format: int32
description: 值:0/1,是否缩小纹理,适用于粗糙纹理和无缝纹理,默认是0,即不缩小纹理;
examples:
- '0'
example:
reduce: 0
initImage: https://3vj-innovation.3vjia.com/demo/tree31_2.png
styleImage: https://3vj-innovation.3vjia.com/demo/tree_p.png
responses:
'200':
description: 成功 / OK
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
description: 请求是否成功 / whether the call succeeded
code:
type: integer
description: 结果码 / result code (0 = success)
msg:
type: string
description: 提示信息 / message
data:
type: object
properties:
info:
type: string
description: 生成信息
taskId:
type: string
description: 任务ID
example:
msg: ''
code: 0
data:
taskId: ''
info: ''
success: false
'401':
description: access_token 缺失或已过期 / missing or expired access_token
/api/render/comfyTextureChangeV4:
post:
operationId: apiRenderComfyTextureChangeV4
summary: 换墙涂料4.0
tags:
- Xuanchi AI
x-source-documentation: https://dev.3vjia.com/document?apiId=801812575007424611
x-documentation-category: 玄尺AI / AI设计
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
initImage:
type: string
description: 初始图片
examples:
- https://3vj-innovation.3vjia.com/demo/tree31_2.png
styleImage:
type: string
description: 场景图
examples:
- https://3vj-innovation.3vjia.com/demo/tree_p.png
expand:
type: integer
format: int32
description: 值:0/1,是否扩大纹理,(细腻纹理和非无缝纹理选择expand=1),默认是0,即不扩大纹理
examples:
- '0'
light:
type: integer
format: int32
description: 值:0/1,是否提亮环境,(需要提升图片亮度选择light=1),默认是0,即不提亮
examples:
- '0'
clean:
type: integer
format: int32
description: 值:0/1,是否去除漆病污点,(不处理墙面选择clean=0),默认是1,即处理墙面漆病
examples:
- '0'
example:
initImage: https://3vj-innovation.3vjia.com/demo/tree31_2.png
styleImage: https://3vj-innovation.3vjia.com/demo/tree_p.png
clean: 0
expand: 0
light: 0
responses:
'200':
description: 成功 / OK
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
description: 请求是否成功 / whether the call succeeded
code:
type: integer
description: 结果码 / result code (0 = success)
msg:
type: string
description: 提示信息 / message
data:
type: object
properties:
info:
type: string
description: 生成信息
taskId:
type: string
description: 任务ID
example:
msg: ''
code: 0
data:
taskId: ''
info: ''
success: false
'401':
description: access_token 缺失或已过期 / missing or expired access_token
/api/render/countertopChange:
post:
operationId: apiRenderCountertopChange
summary: 产品替换-换台面
tags:
- Xuanchi AI
x-source-documentation: https://dev.3vjia.com/document?apiId=725397578988011578
x-documentation-category: 玄尺AI / AI设计
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
extraParams:
type: object
description: '扩展信息。分辨率:aspectRatio。示例:{"aspectRatio": "1536x1024"}'
sourceImageUrl:
type: string
description: 原图片
examples:
- https://xxx.com/xxx.jpg
products:
type: array
items:
type: object
properties:
imageUrl:
type: string
description: 产品图片
examples:
- https://xxx.com/xxx.jpg
required:
- imageUrl
description: 产品列表信息
prompt:
type: string
description: 提示词
required:
- extraParams
- sourceImageUrl
- products
example:
extraParams: ''
products:
- imageUrl: https://xxx.com/xxx.jpg
sourceImageUrl: https://xxx.com/xxx.jpg
prompt: ''
responses:
'200':
description: 成功 / OK
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
description: 请求是否成功 / whether the call succeeded
code:
type: integer
description: 结果码 / result code (0 = success)
msg:
type: string
description: 提示信息 / message
data:
type: object
properties:
info:
type: string
description: 生成信息
examples:
- 任务已发送至队列中
taskId:
type: string
description: 任务ID
examples:
- 0bc2b9b6-3b4e-4c5b-a490-4aaaf4e81416
example:
msg: 成功
code: 0
data:
taskId: 0bc2b9b6-3b4e-4c5b-a490-4aaaf4e81416
info: 任务已发送至队列中
success: true
'401':
description: access_token 缺失或已过期 / missing or expired access_token
/api/render/doorChange:
post:
operationId: apiRenderDoorChange
summary: 产品替换-换门
tags:
- Xuanchi AI
x-source-documentation: https://dev.3vjia.com/document?apiId=725396320654868527
x-documentation-category: 玄尺AI / AI设计
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
changeType:
type: string
description: 替换类型:change_door_material 替换材质;change_door 替换造型和材质;默认:change_door
examples:
- change_door
default: change_door
extraParams:
type: object
description: '扩展信息。分辨率:aspectRatio。示例:{"aspectRatio": "1536x1024"}'
sourceImageUrl:
type: string
description: 原图
examples:
- https://xxx.com/xxx.jpg
replaceTarget:
type: string
description: 替换目标
examples:
- 衣柜
products:
type: array
items:
type: object
properties:
imageUrl:
type: string
description: 产品图片
examples:
- https://xxx.com/xxx.jpg
required:
- imageUrl
description: 产品信息列表
prompt:
type: string
description: 提示语
required:
- extraParams
- sourceImageUrl
- replaceTarget
- products
example:
changeType: change_door
extraParams: ''
products:
- imageUrl: https://xxx.com/xxx.jpg
replaceTarget: 衣柜
sourceImageUrl: https://xxx.com/xxx.jpg
prompt: ''
responses:
'200':
description: 成功 / OK
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
description: 请求是否成功 / whether the call succeeded
code:
type: integer
description: 结果码 / result code (0 = success)
msg:
type: string
description: 提示信息 / message
data:
type: object
properties:
info:
type: string
description: 生成信息
examples:
- 任务已发送至队列中
taskId:
type: string
description: 任务ID
examples:
- 0bc2b9b6-3b4e-4c5b-a490-4aaaf4e81416
example:
msg: 成功
code: 0
data:
taskId: 0bc2b9b6-3b4e-4c5b-a490-4aaaf4e81416
info: 任务已发送至队列中
success: true
'401':
description: access_token 缺失或已过期 / missing or expired access_token
/api/render/entitySegment:
post:
operationId: apiRenderEntitySegment
summary: 物体切割
tags:
- Xuanchi AI
x-source-documentation: https://dev.3vjia.com/document?apiId=725398837321154658
x-documentation-category: 玄尺AI / AI设计
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
imageUrls:
type: array
items: {}
description: 图片URL列表
examples:
- '["https://xxx.com/xxx.jpg"]'
maxEntity:
type: integer
format: int32
description: 最大实体数量,默认100
examples:
- '100'
required:
- imageUrls
example:
maxEntity: 100
imageUrls: []
responses:
'200':
description: 成功 / OK
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
description: 请求是否成功 / whether the call succeeded
code:
type: integer
description: 结果码 / result code (0 = success)
msg:
type: string
description: 提示信息 / message
data:
type: object
properties:
taskStatus:
type: integer
format: int32
description: 任务状态:1标识正在排队,2表示正在渲染,3表示出图成功正常返回了,4表示出图失败了
examples:
- '3'
resultImages:
type: array
items: {}
description: 结果图片地址
examples:
- '["https://xxx.com/xxx.jpg"]'
taskInfo:
type: string
description: 任务返回信息
example:
msg: 成功
code: 0
data:
taskInfo: ''
taskStatus: 3
resultImages: []
success: true
'401':
description: access_token 缺失或已过期 / missing or expired access_token
/api/render/entitySegmentCoordinate:
post:
operationId: apiRenderEntitySegmentCoordinate
summary: 图像分割(坐标)
tags:
- Xuanchi AI
x-source-documentation: https://dev.3vjia.com/document?apiId=727580911910146204
x-documentation-category: 玄尺AI / AI设计
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
conf:
type: number
format: double
description: 置信度阈值(0-1)
imgUrl:
type: string
description: 图片的完整地址
iou:
type: number
format: double
description: IoU阈值(0-1)
modelSize:
type: string
description: model_size,可以选:large,small,sam2
points:
type: string
description: '点坐标列表 JSON字符串, 例如: [[150,150]]'
prompt:
type: string
description: 提示词
example:
conf: 0
modelSize: ''
iou: 0
points: ''
imgUrl: ''
prompt: ''
responses:
'200':
description: 成功 / OK
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
description: 请求是否成功 / whether the call succeeded
code:
type: integer
description: 结果码 / result code (0 = success)
msg:
type: string
description: 提示信息 / message
data:
type: object
example:
msg: ''
code: 0
data: ''
success: false
'401':
description: access_token 缺失或已过期 / missing or expired access_token
/api/render/floorplan3DView:
post:
operationId: apiRenderFloorplan3DView
summary: 户型3D视角出图
tags:
- Xuanchi AI
x-source-documentation: https://dev.3vjia.com/document?apiId=791410051880468575
x-documentation-category: 玄尺AI / AI设计
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
batchCount:
type: integer
format: int32
description: 出图数量,默认为1
default: '1'
initImage:
type: string
description: 初始图片
styleImage:
type: string
description: 风格图或场景图
prompt:
type: string
description: 提示词
example:
initImage: ''
styleImage: ''
batchCount: 0
prompt: ''
responses:
'200':
description: 成功 / OK
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
description: 请求是否成功 / whether the call succeeded
code:
type: integer
description: 结果码 / result code (0 = success)
msg:
type: string
description: 提示信息 / message
data:
type: object
properties:
info:
type: string
description: 生成信息
taskId:
type: string
description: 任务ID
example:
msg: ''
code: 0
data:
taskId: ''
info: ''
success: false
'401':
description: access_token 缺失或已过期 / missing or expired access_token
/api/render/getRenderTaskById:
post:
operationId: apiRenderGetRenderTaskById
summary: AI任务状态查询
tags:
- Xuanchi AI
x-source-documentation: https://dev.3vjia.com/document?apiId=723926385059577870
x-documentation-category: 玄尺AI / AI设计
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
taskId:
type: string
description: 任务ID
examples:
- 0bc2b9b6-3b4e-4c5b-a490-4aaaf4e81416
required:
- taskId
example:
taskId: 0bc2b9b6-3b4e-4c5b-a490-4aaaf4e81416
responses:
'200':
description: 成功 / OK
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
description: 请求是否成功 / whether the call succeeded
code:
type: integer
description: 结果码 / result code (0 = success)
msg:
type: string
description: 提示信息 / message
data:
type: object
properties:
taskStatus:
type: integer
format: int32
description: 任务状态:1标识正在排队,2表示正在渲染,3表示出图成功正常返回了,4表示出图失败了
examples:
- '3'
resultImages:
type: array
items: {}
description: 结果图片地址
examples:
- '["https://3vj-innovation.3vjia.com/aigc/20250620/f942fc9e-b7d3-47fe-a877-79552a4d5371.png"]'
taskInfo:
type: string
description: 任务返回信息
examples:
- ' '
example:
msg: 成功
code: 0
data:
taskInfo: ' '
taskStatus: 3
resultImages: []
success: true
'401':
description: access_token 缺失或已过期 / missing or expired access_token
/api/render/imageEdit:
post:
operationId: apiRenderImageEdit
summary: 图片编辑
tags:
- Xuanchi AI
x-source-documentation: https://dev.3vjia.com/document?apiId=822430704813097065
x-documentation-category: 玄尺AI / AI设计
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
prompt:
type: string
description: 用于生成图像的提示词 ,中英文均可输入
images:
type: array
items: {}
description: 待编辑图片列表
aspectRatio:
type: string
description: 长宽比例。"1:1","1:4","1:8","2:3","3:2","3:4","4:1","4:3","4:5","5:4","8:1","9:16","16:9","21:9"
required:
- prompt
example:
images: []
aspectRatio: ''
prompt: ''
responses:
'200':
description: 成功 / OK
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
description: 请求是否成功 / whether the call succeeded
code:
type: integer
description: 结果码 / result code (0 = success)
msg:
type: string
description: 提示信息 / message
data:
type: object
properties:
info:
type: string
description: 生成信息
taskId:
type: string
description: 任务ID
example:
msg: ''
code: 0
data:
taskId: ''
info: ''
success: false
'401':
description: access_token 缺失或已过期 / missing or expired access_token
/api/render/imageFragment:
post:
operationId: apiRenderImageFragment
summary: 图片裂变
tags:
- Xuanchi AI
x-source-documentation: https://dev.3vjia.com/document?apiId=723925629921284232
x-documentation-category: 玄尺AI / AI设计
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
initImage:
type: string
description: 初始图片
examples:
- https://xxx.com/xxx.jpg
prompt:
type: string
description: 提示词
examples:
- 现代风格
batchCount:
type: integer
format: int32
description: 出图张数, 默认1
examples:
- '4'
similarStr:
type: number
format: float
description: 相似度
examples:
- '0.5'
required:
- initImage
example:
initImage: https://xxx.com/xxx.jpg
batchCount: 4
similarStr: 0.5
prompt: 现代风格
responses:
'200':
description: 成功 / OK
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
description: 请求是否成功 / whether the call succeeded
code:
type: integer
description: 结果码 / result code (0 = success)
msg:
type: string
description: 提示信息 / message
data:
type: object
properties:
info:
type: string
description: 生成信息
examples:
- 任务已发送至队列中
taskId:
type: string
description: 任务ID
examples:
- 0bc2b9b6-3b4e-4c5b-a490-4aaaf4e81416
example:
msg: 成功
code: 0
data:
taskId: 0bc2b9b6-3b4e-4c5b-a490-4aaaf4e81416
info: 任务已发送至队列中
success: true
'401':
description: access_token 缺失或已过期 / missing or expired access_token
/api/render/imageToVideo:
post:
operationId: apiRenderImageToVideo
summary: 图生视频
tags:
- Xuanchi AI
x-source-documentation: https://dev.3vjia.com/document?apiId=723925629921284209
x-documentation-category: 玄尺AI / AI设计
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
firstFrameImageUrl:
type: string
description: 首帧图片地址
examples:
- https://xxx.com/xxx.jpg
lastFrameImageUrl:
type: string
description: 尾帧图片地址
examples:
- https://xxx.com/xxx.jpg
prompt:
type: string
description: 用于生成视频的提示词 ,中英文均可输入
examples:
- 现代风格
width:
type: integer
format: int32
description: 分辨率宽,仅支持 1280:768/768。默认:1280
examples:
- '1280'
height:
type: integer
format: int32
description: 分辨率高,仅支持 1280:768/768。默认:768
examples:
- '768'
videoLength:
type: integer
format: int32
description: 视频长度(秒),默认5秒
examples:
- '5'
seed:
type: integer
format: int64
description: 种子
examples:
- '10'
templateId:
type: integer
format: int64
description: 渲染模板配置ID。见文档:https://help.3vjia.com/doc/open_doc/456823276459593731/723925629921284207
examples:
- '123456'
example:
videoLength: 5
seed: 10
templateId: 123456
lastFrameImageUrl: https://xxx.com/xxx.jpg
width: 1280
firstFrameImageUrl: https://xxx.com/xxx.jpg
prompt: 现代风格
height: 768
responses:
'200':
description: 成功 / OK
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
description: 请求是否成功 / whether the call succeeded
code:
type: integer
description: 结果码 / result code (0 = success)
msg:
type: string
description: 提示信息 / message
data:
type: object
properties:
info:
type: string
description: 生成信息
examples:
- 任务已发送至队列中
taskId:
type: string
description: 任务ID
examples:
- 0bc2b9b6-3b4e-4c5b-a490-4aaaf4e81416
example:
msg: 成功
code: 0
data:
taskId: 0bc2b9b6-3b4e-4c5b-a490-4aaaf4e81416
info: 任务已发送至队列中
success: true
'401':
description: access_token 缺失或已过期 / missing or expired access_token
/api/render/imageWhiteBackground:
post:
operationId: apiRenderImageWhiteBackground
summary: 图片白底图
tags:
- Xuanchi AI
x-source-documentation: https://dev.3vjia.com/document?apiId=862395040079695934
x-documentation-category: 玄尺AI / AI设计
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
images:
type: array
items: {}
description: 待编辑图片列表
example:
images: []
responses:
'200':
description: 成功 / OK
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
description: 请求是否成功 / whether the call succeeded
code:
type: integer
description: 结果码 / result code (0 = success)
msg:
type: string
description: 提示信息 / message
data:
type: object
properties:
info:
type: string
description: 生成信息
taskId:
type: string
description: 任务ID
example:
msg: ''
code: 0
data:
taskId: ''
info: ''
success: false
'401':
description: access_token 缺失或已过期 / missing or expired access_token
/api/render/imgExtractObjects:
post:
operationId: apiRenderImgExtractObjects
summary: 物体识别
tags:
- Xuanchi AI
x-source-documentation: https://dev.3vjia.com/document?apiId=725398334004674627
x-documentation-category: 玄尺AI / AI设计
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
imgUrl:
type: string
description: 图片URL
examples:
- https://xxx.com/xxx.jpg
required:
- imgUrl
example:
imgUrl: https://xxx.com/xxx.jpg
responses:
'200':
description: 成功 / OK
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
description: 请求是否成功 / whether the call succeeded
code:
type: integer
description: 结果码 / result code (0 = success)
msg:
type: string
description: 提示信息 / message
data:
type: object
properties:
objectList:
type: array
items: {}
description: 识别后标签列表
examples:
- '["沙发"]'
example:
msg: 成功
code: 0
data:
objectList: []
success: true
'401':
description: access_token 缺失或已过期 / missing or expired access_token
/api/render/imgPromptToImgsV2:
post:
operationId: apiRenderImgPromptToImgsV2
summary: 电商套图生成
tags:
- Xuanchi AI
x-source-documentation: https://dev.3vjia.com/document?apiId=827236275026300931
x-documentation-category: 玄尺AI / AI设计
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
url:
type: string
description: 图片URL
userPrompt:
type: string
description: 用户补充提示词
count:
type: integer
format: int32
description: 出图数量
groupId:
type: integer
format: int64
required:
- url
example:
userPrompt: ''
groupId: 0
count: 0
url: ''
responses:
'200':
description: 成功 / OK
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
description: 请求是否成功 / whether the call succeeded
code:
type: integer
description: 结果码 / result code (0 = success)
msg:
type: string
description: 提示信息 / message
data:
type: object
properties:
url:
type: string
description: 输入图片url
images:
type: array
items:
type: object
properties:
info:
type: string
description: 生成信息
taskId:
type: string
description: 任务ID
seed:
type: integer
format: int64
description: 随机种子
description: 电商套图生成图片项
example:
msg: ''
code: 0
data:
images:
- seed: 0
taskId: ''
info: ''
url: ''
success: false
'401':
description: access_token 缺失或已过期 / missing or expired access_token
/api/render/listRenderTemplate:
post:
operationId: apiRenderListRenderTemplate
summary: 模板配置列表
tags:
- Xuanchi AI
x-source-documentation: https://dev.3vjia.com/document?apiId=723925629921284207
x-documentation-category: 玄尺AI / AI设计
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
bizType:
type: integer
format: int32
description: 业务类型:13-视频;25-铺砖;
examples:
- '13'
templateOwner:
type: integer
format: int32
description: 模板归属:1-系统模板,2-用户模板。默认:1
required:
- bizType
example:
bizType: 13
templateOwner: 0
responses:
'200':
description: 成功 / OK
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
description: 请求是否成功 / whether the call succeeded
code:
type: integer
description: 结果码 / result code (0 = success)
msg:
type: string
description: 提示信息 / message
data:
type: object
properties:
title:
type: string
description: 模板标题
examples:
- 拉升效果
bizType:
type: integer
format: int32
description: 业务类型:图生视频-13;
examples:
- '13'
imageUrl:
type: string
description: 模板预览图片URL
examples:
- https://xxx.com/xxx.jpg
videoUrl:
type: string
description: 模板预览视频URL
examples:
- https://xxx.com/xxx.mp4
id:
type: integer
format: int64
description: ID
examples:
- '23232444'
example:
msg: 成功
code: 0
data:
- bizType: 13
title: 拉升效果
videoUrl: https://xxx.com/xxx.mp4
imageUrl: https://xxx.com/xxx.jpg
id: 23232444
success: true
'401':
description: access_token 缺失或已过期 / missing or expired access_token
/api/render/oldBuildingReconstructionV2:
post:
operationId: apiRenderOldBuildingReconstructionV2
summary: 旧房改造2.0
tags:
- Xuanchi AI
x-source-documentation: https://dev.3vjia.com/document?apiId=723925629921284205
x-documentation-category: 玄尺AI / AI设计
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
initImage:
type: string
description: 毛坯图片
examples:
- https://xxx.com/xxx.jpg
prompt:
type: string
description: 提示词,如:“客厅,现代风格,大面积窗户,城市景观,高楼背景,木质地板,浅色家具”
examples:
- 现代风格
referenceImage:
type: string
description: 参考图
examples:
- https://xxx.com/xxx.jpg
height:
type: integer
format: int32
description: 分辨率-高
examples:
- '1024'
width:
type: integer
format: int32
description: 分辨率-宽
examples:
- '1024'
batchCount:
type: integer
format: int32
description: 生成的图片数,默认1张
examples:
- '2'
required:
- initImage
- prompt
example:
initImage: https://xxx.com/xxx.jpg
batchCount: 2
referenceImage: https://xxx.com/xxx.jpg
width: 1024
prompt: 现代风格
height: 1024
responses:
'200':
description: 成功 / OK
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
description: 请求是否成功 / whether the call succeeded
code:
type: integer
description: 结果码 / result code (0 = success)
msg:
type: string
description: 提示信息 / message
data:
type: object
properties:
info:
type: string
description: 生成信息
examples:
- 任务已发送至队列中
taskId:
type: string
description: 任务ID
examples:
- 0bc2b9b6-3b4e-4c5b-a490-4aaaf4e81416
example:
msg: 成功
code: 0
data:
taskId: 0bc2b9b6-3b4e-4c5b-a490-4aaaf4e81416
info: 任务已发送至队列中
success: true
'401':
description: access_token 缺失或已过期 / missing or expired access_token
/api/render/oldBuildingReconstructionV2.1:
post:
operationId: apiRenderOldBuildingReconstructionV21
summary: 旧房改造2.1
tags:
- Xuanchi AI
x-source-documentation: https://dev.3vjia.com/document?apiId=791408793547329638
x-documentation-category: 玄尺AI / AI设计
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
batchCount:
type: integer
format: int32
description: 出图数量,默认为1
default: '1'
initImage:
type: string
description: 初始图片
styleImage:
type: string
description: 风格图
prompt:
type: string
description: 提示词
example:
initImage: ''
styleImage: ''
batchCount: 0
prompt: ''
responses:
'200':
description: 成功 / OK
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
description: 请求是否成功 / whether the call succeeded
code:
type: integer
description: 结果码 / result code (0 = success)
msg:
type: string
description: 提示信息 / message
data:
type: object
properties:
info:
type: string
description: 生成信息
taskId:
type: string
description: 任务ID
example:
msg: ''
code: 0
data:
taskId: ''
info: ''
success: false
'401':
description: access_token 缺失或已过期 / missing or expired access_token
/api/render/paintDefectDetection:
post:
operationId: apiRenderPaintDefectDetection
summary: 油漆缺陷检测
tags:
- Xuanchi AI
x-source-documentation: https://dev.3vjia.com/document?apiId=817074914153611313
x-documentation-category: 玄尺AI / AI设计
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
imageUrl:
type: string
description: 图片地址
area:
type: string
description: 空间区域
required:
- imageUrl
example:
area: ''
imageUrl: ''
responses:
'200':
description: 成功 / OK
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
description: 请求是否成功 / whether the call succeeded
code:
type: integer
description: 结果码 / result code (0 = success)
msg:
type: string
description: 提示信息 / message
data:
type: object
properties:
success:
type: boolean
description: 请求是否成功
requestId:
type: string
description: 请求ID
primaryDefect:
type: string
description: 主漆病。如果无漆病,则该字段值为:正常
secondaryDefects:
type: array
items: {}
description: 伴随漆病。伴随漆病不一定存在
causeAnalysis:
type: string
description: 成因分析
solution:
type: string
description: 解决方案
errorMsg:
type: string
description: 异常信息,success=false时返回
recommendedPlan:
type: string
description: 推荐方案
example:
msg: ''
code: 0
data:
causeAnalysis: ''
secondaryDefects: []
errorMsg: ''
solution: ''
success: false
requestId: ''
recommendedPlan: ''
primaryDefect: ''
success: false
'401':
description: access_token 缺失或已过期 / missing or expired access_token
/api/render/picToText:
post:
operationId: apiRenderPicToText
summary: 图转文
tags:
- Xuanchi AI
x-source-documentation: https://dev.3vjia.com/document?apiId=816692897092091966
x-documentation-category: 玄尺AI / AI设计
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
imgUrls:
type: array
items: {}
description: 图片地址列表
required:
- imgUrls
example:
imgUrls: []
responses:
'200':
description: 成功 / OK
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
description: 请求是否成功 / whether the call succeeded
code:
type: integer
description: 结果码 / result code (0 = success)
msg:
type: string
description: 提示信息 / message
data:
type: object
properties:
taskId:
type: string
description: 任务ID
text:
type: string
description: 生成的文本内容
example:
msg: ''
code: 0
data:
text: ''
taskId: ''
success: false
'401':
description: access_token 缺失或已过期 / missing or expired access_token
/api/render/productAdd:
post:
operationId: apiRenderProductAdd
summary: 添加产品
tags:
- Xuanchi AI
x-source-documentation: https://dev.3vjia.com/document?apiId=725385247734255743
x-documentation-category: 玄尺AI / AI设计
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
extraParams:
type: object
description: '扩展信息。分辨率:aspectRatio。示例:{ "aspectRatio": "1536x1024" }'
sourceImageUrl:
type: string
description: 原图片
examples:
- https://xxx.com/xxx.jpg
replaceTarget:
type: string
description: 替换目标
products:
type: array
items:
type: object
properties:
imageUrl:
type: string
description: 产品图片
examples:
- https://xxx.com/xxx.jpg
extractLabels:
type: array
items: {}
description: 扩展标签
examples:
- 沙发
selectedLabels:
type: array
items: {}
description: 选择标签
examples:
- 沙发
required:
- imageUrl
- selectedLabels
description: 产品信息列表
prompt:
type: string
description: 提示词
required:
- sourceImageUrl
- products
example:
extraParams: ''
products:
- imageUrl: https://xxx.com/xxx.jpg
extractLabels: []
selectedLabels: []
replaceTarget: ''
sourceImageUrl: https://xxx.com/xxx.jpg
prompt: ''
responses:
'200':
description: 成功 / OK
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
description: 请求是否成功 / whether the call succeeded
code:
type: integer
description: 结果码 / result code (0 = success)
msg:
type: string
description: 提示信息 / message
data:
type: object
properties:
info:
type: string
description: 生成信息
examples:
- 任务已发送至队列中
taskId:
type: string
description: 任务ID
examples:
- 0bc2b9b6-3b4e-4c5b-a490-4aaaf4e81416
example:
msg: 成功
code: 0
data:
taskId: 0bc2b9b6-3b4e-4c5b-a490-4aaaf4e81416
info: 任务已发送至队列中
success: true
'401':
description: access_token 缺失或已过期 / missing or expired access_token
/api/render/productReplaceV1:
post:
operationId: apiRenderProductReplaceV1
summary: 产品替换1.0
tags:
- Xuanchi AI
x-source-documentation: https://dev.3vjia.com/document?apiId=725361255010943019
x-documentation-category: 玄尺AI / AI设计
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
initImage:
type: string
description: 初始图片URL
examples:
- https://xxx.com/xxx.jpg
productImageUrl:
type: string
description: 产品图片URL
examples:
- https://xxx.com/xxx.jpg
maskImageUrl:
type: string
description: 遮罩图片URL
examples:
- https://xxx.com/xxx.jpg
prompt:
type: string
description: 提示词
required:
- initImage
- productImageUrl
- maskImageUrl
example:
productImageUrl: https://xxx.com/xxx.jpg
initImage: https://xxx.com/xxx.jpg
maskImageUrl: https://xxx.com/xxx.jpg
prompt: ''
responses:
'200':
description: 成功 / OK
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
description: 请求是否成功 / whether the call succeeded
code:
type: integer
description: 结果码 / result code (0 = success)
msg:
type: string
description: 提示信息 / message
data:
type: object
properties:
info:
type: string
description: 生成信息
examples:
- 任务已发送至队列中
taskId:
type: string
description: 任务ID
examples:
- 0bc2b9b6-3b4e-4c5b-a490-4aaaf4e81416
example:
msg: 成功
code: 0
data:
taskId: 0bc2b9b6-3b4e-4c5b-a490-4aaaf4e81416
info: 任务已发送至队列中
success: true
'401':
description: access_token 缺失或已过期 / missing or expired access_token
/api/render/productReplaceV2:
post:
operationId: apiRenderProductReplaceV2
summary: 产品替换2.0
tags:
- Xuanchi AI
x-source-documentation: https://dev.3vjia.com/document?apiId=725363605071089720
x-documentation-category: 玄尺AI / AI设计
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
extraParams:
type: object
description: 扩展信息
examples:
- '{ "aspectRatio": "1536x1024" }'
sourceImageUrl:
type: string
description: 原图片
examples:
- https://xxx.com/xxx.jpg
products:
type: array
items:
type: object
properties:
imageUrl:
type: string
description: 产品图片
examples:
- https://xxx.com/xxx.jpg
extractLabels:
type: array
items: {}
description: 扩展标签列表
examples:
- '["沙发"]'
selectedLabels:
type: array
items: {}
description: 选择标签列表
examples:
- '["沙发"]'
required:
- selectedLabels
description: 产品信息列表
prompt:
type: string
description: 提示词
required:
- extraParams
- sourceImageUrl
- products
example:
extraParams: ''
products:
- imageUrl: https://xxx.com/xxx.jpg
extractLabels: []
selectedLabels: []
sourceImageUrl: https://xxx.com/xxx.jpg
prompt: ''
responses:
'200':
description: 成功 / OK
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
description: 请求是否成功 / whether the call succeeded
code:
type: integer
description: 结果码 / result code (0 = success)
msg:
type: string
description: 提示信息 / message
data:
type: object
properties:
info:
type: string
description: 生成信息
examples:
- 任务已发送至队列中
taskId:
type: string
description: 任务ID
examples:
- 0bc2b9b6-3b4e-4c5b-a490-4aaaf4e81416
example:
msg: 成功
code: 0
data:
taskId: 0bc2b9b6-3b4e-4c5b-a490-4aaaf4e81416
info: 任务已发送至队列中
success: true
'401':
description: access_token 缺失或已过期 / missing or expired access_token
/api/render/roughDesignV2:
post:
operationId: apiRenderRoughDesignV2
summary: 毛坯出图2.0
tags:
- Xuanchi AI
x-source-documentation: https://dev.3vjia.com/document?apiId=723925629921284202
x-documentation-category: 玄尺AI / AI设计
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
initImage:
type: string
description: 毛坯图片
examples:
- https://xxx.com/xxx.jpg
prompt:
type: string
description: 提示词,如:“客厅,现代风格,大面积窗户,城市景观,高楼背景,木质地板,浅色家具”
examples:
- 现代风格
referenceImage:
type: string
description: 参考图
examples:
- https://xxx.com/xxx.jpg
height:
type: integer
format: int32
description: 分辨率-高
examples:
- '1024'
width:
type: integer
format: int32
description: 分辨率-宽
examples:
- '1024'
batchCount:
type: integer
format: int32
description: 生成的图片数,默认1张
examples:
- '1'
required:
- initImage
- prompt
example:
initImage: https://xxx.com/xxx.jpg
batchCount: 1
referenceImage: https://xxx.com/xxx.jpg
width: 1024
prompt: 现代风格
height: 1024
responses:
'200':
description: 成功 / OK
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
description: 请求是否成功 / whether the call succeeded
code:
type: integer
description: 结果码 / result code (0 = success)
msg:
type: string
description: 提示信息 / message
data:
type: object
properties:
info:
type: string
description: 生成信息
examples:
- 任务已发送至队列中
taskId:
type: string
description: 任务ID
examples:
- 0bc2b9b6-3b4e-4c5b-a490-4aaaf4e81416
example:
msg: 成功
code: 0
data:
taskId: 0bc2b9b6-3b4e-4c5b-a490-4aaaf4e81416
info: 任务已发送至队列中
success: true
'401':
description: access_token 缺失或已过期 / missing or expired access_token
/api/render/roughDesignV2.1:
post:
operationId: apiRenderRoughDesignV21
summary: 毛坯出图2.1
tags:
- Xuanchi AI
x-source-documentation: https://dev.3vjia.com/document?apiId=791407283727913071
x-documentation-category: 玄尺AI / AI设计
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
batchCount:
type: integer
format: int32
description: 出图数量,默认为1
default: '1'
initImage:
type: string
description: 初始图片
styleImage:
type: string
description: 风格图
prompt:
type: string
description: 提示词
example:
initImage: ''
styleImage: ''
batchCount: 0
prompt: ''
responses:
'200':
description: 成功 / OK
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
description: 请求是否成功 / whether the call succeeded
code:
type: integer
description: 结果码 / result code (0 = success)
msg:
type: string
description: 提示信息 / message
data:
type: object
properties:
info:
type: string
description: 生成信息
taskId:
type: string
description: 任务ID
example:
msg: ''
code: 0
data:
taskId: ''
info: ''
success: false
'401':
description: access_token 缺失或已过期 / missing or expired access_token
/api/render/sketchToImage:
post:
operationId: apiRenderSketchToImage
summary: 线稿出图
tags:
- Xuanchi AI
x-source-documentation: https://dev.3vjia.com/document?apiId=723925629921284200
x-documentation-category: 玄尺AI / AI设计
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
initImage:
type: string
description: 原始图片URL
examples:
- https://xxx.com/xxx.jpg
referenceImage:
type: string
description: 参考图片URL
examples:
- https://xxx.com/xxx.jpg
prompt:
type: string
description: 风格描述
examples:
- 现代风格
batchCount:
type: integer
format: int32
description: 出图数量
examples:
- '2'
required:
- initImage
- referenceImage
example:
initImage: https://xxx.com/xxx.jpg
batchCount: 2
referenceImage: https://xxx.com/xxx.jpg
prompt: 现代风格
responses:
'200':
description: 成功 / OK
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
description: 请求是否成功 / whether the call succeeded
code:
type: integer
description: 结果码 / result code (0 = success)
msg:
type: string
description: 提示信息 / message
data:
type: object
properties:
info:
type: string
description: 生成信息
examples:
- 任务已发送至队列中
taskId:
type: string
description: 任务ID
examples:
- 0bc2b9b6-3b4e-4c5b-a490-47e6f4331416
example:
msg: 成功
code: 0
data:
taskId: 0bc2b9b6-3b4e-4c5b-a490-47e6f4331416
info: 任务已发送至队列中
success: true
'401':
description: access_token 缺失或已过期 / missing or expired access_token
/api/render/softDecorationLayoutV2.1:
post:
operationId: apiRenderSoftDecorationLayoutV21
summary: 新房软装2.1
tags:
- Xuanchi AI
x-source-documentation: https://dev.3vjia.com/document?apiId=791409548547211368
x-documentation-category: 玄尺AI / AI设计
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
batchCount:
type: integer
format: int32
description: 出图数量,默认为1
default: '1'
initImage:
type: string
description: 初始图片
styleImage:
type: string
description: 风格图
prompt:
type: string
description: 提示词
example:
initImage: ''
styleImage: ''
batchCount: 0
prompt: ''
responses:
'200':
description: 成功 / OK
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
description: 请求是否成功 / whether the call succeeded
code:
type: integer
description: 结果码 / result code (0 = success)
msg:
type: string
description: 提示信息 / message
data:
type: object
properties:
info:
type: string
description: 生成信息
taskId:
type: string
description: 任务ID
example:
msg: ''
code: 0
data:
taskId: ''
info: ''
success: false
'401':
description: access_token 缺失或已过期 / missing or expired access_token
/api/render/textToImage:
post:
operationId: apiRenderTextToImage
summary: 文生图
tags:
- Xuanchi AI
x-source-documentation: https://dev.3vjia.com/document?apiId=723925629921284198
x-documentation-category: 玄尺AI / AI设计
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
prompt:
type: string
description: 用于生成图像的提示词 ,中英文均可输入
examples:
- 敞亮,现代风格的客厅
width:
type: integer
format: int32
description: 分辨率宽,默认:1024
examples:
- '1024'
height:
type: integer
format: int32
description: 分辨率高,默认:1024
examples:
- '1024'
batchCount:
type: integer
format: int32
description: 出图张数, 默认1
examples:
- '2'
aspectRatio:
type: string
description: 长宽比例,如:1:1
examples:
- '1:1'
modelVersion:
type: string
description: 模型版本(1.1-模型1;1.4-模型2)
examples:
- '1.1'
required:
- prompt
- modelVersion
example:
modelVersion: '1.1'
aspectRatio: '1:1'
batchCount: 2
width: 1024
prompt: 敞亮,现代风格的客厅
height: 1024
responses:
'200':
description: 成功 / OK
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
description: 请求是否成功 / whether the call succeeded
code:
type: integer
description: 结果码 / result code (0 = success)
msg:
type: string
description: 提示信息 / message
data:
type: object
properties:
info:
type: string
description: 生成信息
examples:
- 任务已发送至队列中
taskId:
type: string
description: 任务ID
examples:
- 0bc2b9b6-3b4e-4c5b-a490-57e6f4e41216
example:
msg: 成功
code: 0
data:
taskId: 0bc2b9b6-3b4e-4c5b-a490-57e6f4e41216
info: 任务已发送至队列中
success: true
'401':
description: access_token 缺失或已过期 / missing or expired access_token
/api/render/textureChange:
post:
operationId: apiRenderTextureChange
summary: 换墙涂料1.0
tags:
- Xuanchi AI
x-source-documentation: https://dev.3vjia.com/document?apiId=725381567941328900
x-documentation-category: 玄尺AI / AI设计
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
initImage:
type: string
description: 初始图片
examples:
- https://xxx.com/xxx.jpg
styleImage:
type: string
description: 场景图
examples:
- https://xxx.com/xxx.jpg
maskImage:
type: string
description: 遮罩图
examples:
- https://xxx.com/xxx.jpg
light:
type: integer
format: int32
description: 是否光照保留,0-否,1-是。默认:1
examples:
- '1'
required:
- initImage
- styleImage
- maskImage
example:
initImage: https://xxx.com/xxx.jpg
styleImage: https://xxx.com/xxx.jpg
light: 1
maskImage: https://xxx.com/xxx.jpg
responses:
'200':
description: 成功 / OK
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
description: 请求是否成功 / whether the call succeeded
code:
type: integer
description: 结果码 / result code (0 = success)
msg:
type: string
description: 提示信息 / message
data:
type: object
properties:
info:
type: string
description: 生成信息
examples:
- 任务已发送至队列中
taskId:
type: string
description: 任务ID
examples:
- 0bc2b9b6-3b4e-4c5b-a490-4aaaf4e81416
example:
msg: 成功
code: 0
data:
taskId: 0bc2b9b6-3b4e-4c5b-a490-4aaaf4e81416
info: 任务已发送至队列中
success: true
'401':
description: access_token 缺失或已过期 / missing or expired access_token
/api/ruleseedscheme/pageRelatedScheme:
post:
operationId: apiRuleseedschemePageRelatedScheme
summary: 获取规则关联的种子方案 默认查询已发布
tags:
- Light Design
x-source-documentation: https://dev.3vjia.com/document?apiId=868070585434017833
x-documentation-category: 轻设计
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
createDateEnd:
type: string
description: 创建结束时间
createDateStart:
type: string
description: 创建开始时间
createUser:
type: string
description: 创建人
id:
type: integer
format: int32
description: 主键id
industId:
type: string
description: 行业应用ID
isDelete:
type: integer
format: int32
description: 是否删除默认0未删除
isTenantPublic:
type: integer
format: int32
description: 是否租户共享0否1是
kgId:
type: string
description: 图谱入库id
kgStatuses:
type: array
items: {}
description: "This is List Type \n规则入图谱状态@seecom.swj.api.njvr.enums.VrRule2KgStatusEnum"
orderBy:
type: string
description: 排序
pageIndex:
type: integer
format: int32
description: 页码
pageSize:
type: integer
format: int32
description: 页容量
queryType:
type: integer
format: int32
description: 查询类型1样板间(方案)2风格系列(规则)默认1
ruleId:
type: integer
format: int32
description: 设计规则id
ruleIdList:
type: array
items: {}
description: "This is List Type \n设计规则id列表"
ruleKeyWord:
type: string
description: 系列(规则)关键词查询(规则id/规则名称)
rulePublishState:
type: integer
format: int32
description: 设计规则发布状态0未发布1已发布默认1
ruleStyleId:
type: string
description: 系列/规则/风格id
ruleType:
type: integer
format: int32
description: 规则/系列类型1平台、2企业默认2
schemeKeyWord:
type: string
description: 方案关键词(种子方案ID/名称)
schemeName:
type: string
description: 种子方案名称模糊全匹配
schemeStyleId:
type: string
description: 方案风格id
seedSchemeId:
type: string
description: 种子方案id
spaceName:
type: string
description: 空间名称
status:
type: integer
format: int32
description: 种子方案关联状态2已入库3已发布@seecom.swj.api.njvr.enums.SeedSchemeStatusEnum
statusList:
type: array
items: {}
description: "This is List Type \n种子方案关联状态列表2已入库3已发布"
tenantId:
type: string
description: 租户ID
tenantIdList:
type: array
items: {}
description: "This is List Type \n租户ID列表"
updateDateEnd:
type: string
description: 更新结束时间
updateDateStart:
type: string
description: 更新开始时间
updateUser:
type: string
description: 更新人
example:
ruleStyleId: ''
industId: ''
orderBy: ''
pageSize: 0
spaceName: ''
ruleKeyWord: ''
rulePublishState: 0
createDateStart: ''
ruleType: 0
updateDateStart: ''
updateDateEnd: ''
schemeStyleId: ''
id: 0
createDateEnd: ''
ruleId: 0
tenantIdList: []
kgId: ''
isDelete: 0
schemeName: ''
updateUser: ''
schemeKeyWord: ''
queryType: 0
seedSchemeId: ''
kgStatuses: []
ruleIdList: []
statusList: []
pageIndex: 0
isTenantPublic: 0
tenantId: ''
createUser: ''
status: 0
responses:
'200':
description: 成功 / OK
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
description: 请求是否成功 / whether the call succeeded
code:
type: integer
description: 结果码 / result code (0 = success)
msg:
type: string
description: 提示信息 / message
data:
type: object
properties:
pageIndex:
type: integer
format: int32
pageSize:
type: integer
format: int32
recordCount:
type: integer
format: int32
result:
type: array
items:
type: object
properties:
brushStyleReqs:
type: array
items:
type: object
properties:
styleCode:
type: string
description: 风格刷唯一标识(固定传值)code全屋风格刷:styleBrushId厨房风格刷:kitchenBrushId背景墙风格刷:wallBrushId
styleId:
type: string
description: 风格刷ID
styleImage:
type: string
description: 封面图
styleName:
type: string
description: 风格名称
styleType:
type: string
description: 风格类别
xmlDataUrl:
type: string
description: 风格刷对应数据URL
description: '*风格刷参数'
createDate:
type: string
description: 创建时间
createUser:
type: string
description: 创建人
id:
type: integer
format: int32
description: 主键id
isDelete:
type: integer
format: int32
description: 是否删除
kgId:
type: string
description: 图谱入库id
layoutTemplates:
type: array
items:
type: object
properties:
id:
type: string
description: ID
layoutData:
type: string
description: 布局详情oss
roomId:
type: string
description: 空间ID
roomName:
type: string
description: 空间名称
schemeId:
type: string
description: 方案ID
uId:
type: string
description: 空间UID
description: 布局模板信息
lightTemplateDataUrl:
type: string
description: 灯光模板数据URL
lightTemplateId:
type: string
description: 布局灯光模板
roomCovers:
type: array
items:
type: object
properties:
coverImage:
type: string
description: 空间封面图
createDate:
type: string
description: 创建时间
createUser:
type: string
description: 创建人ID
id:
type: string
description: 主键ID
industId:
type: string
description: 应用ID,对应layout_meta_room_type.indust_id
isDelete:
type: integer
format: int32
description: 删除标识:0否1是
roomTypeId:
type: string
description: 空间类型ID,对应layout_meta_room_type.id
roomTypeName:
type: string
description: 空间类型名称快照
ruleId:
type: integer
format: int32
description: 套系ID,对应vr_rule.rule_id
tenantId:
type: string
description: 租户ID
updateDate:
type: string
description: 更新时间
updateUser:
type: string
description: 更新人ID
description: 套系空间封面结果
roomList:
type: array
items:
type: object
properties:
area:
type: number
format: double
description: 空间面积
imgPath:
type: string
description: 空间封面图
imgPath720:
type: string
description: 空间全景图
name:
type: string
description: 空间名称
style:
type: string
description: 空间风格
description: '*种子方案空间类'
ruleComment:
type: string
description: 规则详情
ruleId:
type: integer
format: int32
description: 设计规则id
ruleImageList:
type: array
items: {}
description: "This is List Type \n规则/系列封面列表"
ruleName:
type: string
description: 规则/系列名称
schemeArea:
type: number
format: double
description: 方案面积
schemeName:
type: string
description: 种子方案名称冗余名称等同seedSchemeName
seedId:
type: string
description: 种子方案主ID
seedSchemeId:
type: string
description: 种子方案id
seedSchemeName:
type: string
description: 种子方案名称
seriesStyle:
type: string
description: 系列风格
status:
type: integer
format: int32
description: 种子方案关联状态@seecom.swj.api.njvr.enums.SeedSchemeStatusEnum
styleId:
type: string
description: 全屋默认风格刷ID
thumbnail:
type: string
description: 种子方案封面/系列封面图
updateDate:
type: string
description: 修改时间
updateUser:
type: string
description: 修改人
description: This is List Type
example:
msg: ''
code: 0
data:
recordCount: 0
pageSize: 0
result:
- brushStyleReqs:
- xmlDataUrl: ''
styleImage: ''
styleName: ''
styleCode: ''
styleType: ''
styleId: ''
updateDate: ''
layoutTemplates:
- layoutData: ''
schemeId: ''
roomId: ''
roomName: ''
uId: ''
id: ''
lightTemplateDataUrl: ''
styleId: ''
seedId: ''
ruleName: ''
id: 0
ruleId: 0
createDate: ''
seriesStyle: ''
thumbnail: ''
kgId: ''
roomCovers:
- updateDate: ''
industId: ''
isDelete: 0
roomTypeName: ''
updateUser: ''
roomTypeId: ''
coverImage: ''
tenantId: ''
createUser: ''
id: ''
ruleId: 0
createDate: ''
isDelete: 0
ruleImageList: []
schemeName: ''
seedSchemeName: ''
updateUser: ''
seedSchemeId: ''
createUser: ''
lightTemplateId: ''
roomList:
- imgPath720: ''
imgPath: ''
name: ''
style: ''
ruleComment: ''
status: 0
pageIndex: 0
success: false
'401':
description: access_token 缺失或已过期 / missing or expired access_token
/api/schemeLock/addLockModule:
post:
operationId: apiSchemeLockAddLockModule
summary: 添加方案锁定模块
tags:
- Dedicated Services
x-source-documentation: https://dev.3vjia.com/document?apiId=837280079435436120
x-documentation-category: 专属服务 / C11876880
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
moduleCode:
type: string
description: 模块别名
outUserId:
type: string
description: 企业用户Id
schemeId:
type: string
description: 方案Id
required:
- moduleCode
- schemeId
example:
moduleCode: ''
schemeId: ''
outUserId: ''
responses:
'200':
description: 成功 / OK
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
description: 请求是否成功 / whether the call succeeded
code:
type: integer
description: 结果码 / result code (0 = success)
msg:
type: string
description: 提示信息 / message
data:
type: object
example:
msg: ''
code: 0
success: false
'401':
description: access_token 缺失或已过期 / missing or expired access_token
/api/schemeLock/getBySchemeId:
post:
operationId: apiSchemeLockGetBySchemeId
summary: 根据方案Id查询方案锁定表信息
tags:
- Dedicated Services
x-source-documentation: https://dev.3vjia.com/document?apiId=837281820998537313
x-documentation-category: 专属服务 / C11876880
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
schemeId:
type: string
description: 方案Id
required:
- schemeId
example:
schemeId: ''
responses:
'200':
description: 成功 / OK
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
description: 请求是否成功 / whether the call succeeded
code:
type: integer
description: 结果码 / result code (0 = success)
msg:
type: string
description: 提示信息 / message
data:
type: object
properties:
id:
type: integer
format: int64
description: 主键id
moduleCode:
type: string
description: 模块别名
outUserId:
type: string
description: 企业用户Id
schemeId:
type: string
description: 方案Id
required:
- id
example:
msg: ''
code: 0
data:
moduleCode: ''
schemeId: ''
outUserId: ''
id: 0
success: false
'401':
description: access_token 缺失或已过期 / missing or expired access_token
/api/schemeLock/removeLockModule:
post:
operationId: apiSchemeLockRemoveLockModule
summary: 移除方案锁定模块
tags:
- Dedicated Services
x-source-documentation: https://dev.3vjia.com/document?apiId=837280079435436122
x-documentation-category: 专属服务 / C11876880
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
moduleCode:
type: string
description: 模块别名
outUserId:
type: string
description: 企业用户Id
schemeId:
type: string
description: 方案Id
required:
- moduleCode
- schemeId
example:
moduleCode: ''
schemeId: ''
outUserId: ''
responses:
'200':
description: 成功 / OK
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
description: 请求是否成功 / whether the call succeeded
code:
type: integer
description: 结果码 / result code (0 = success)
msg:
type: string
description: 提示信息 / message
data:
type: object
example:
msg: ''
code: 0
success: false
'401':
description: access_token 缺失或已过期 / missing or expired access_token
/api/schemecategory/updateSchemeCategory:
post:
operationId: apiSchemecategoryUpdateSchemeCategory
summary: 编辑方案分类接口
tags:
- Design Schemes
x-source-documentation: https://dev.3vjia.com/document?apiId=475026463813349465
x-documentation-category: 方案模块 / 方案分类
description: 编辑方案分类
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
categoryCode:
type: string
description: 分类代码,可自定义的代码,不超过32个字符
categoryId:
type: string
description: 要修改的分类的ID
categoryName:
type: string
description: 分类名称,不能超过512个字符
hasChildren:
type: integer
format: int32
description: 是否有子分类,1=有,0=无,默认0
parentId:
type: string
description: 分类所属的上级ID
sortCode:
type: integer
format: int32
description: 分类排序码,会影响显示顺序,默认为0
example:
hasChildren: 0
categoryCode: ''
categoryName: ''
sortCode: 0
parentId: ''
categoryId: ''
responses:
'200':
description: 成功 / OK
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
description: 请求是否成功 / whether the call succeeded
code:
type: integer
description: 结果码 / result code (0 = success)
msg:
type: string
description: 提示信息 / message
data:
type: object
example:
msg: ''
code: 0
data: true
success: true
'401':
description: access_token 缺失或已过期 / missing or expired access_token
/api/shop/deleteDeptAndShopRelation:
post:
operationId: apiShopDeleteDeptAndShopRelation
summary: 批量解除门店绑定部门接口
tags:
- Accounts
x-source-documentation: https://dev.3vjia.com/document?apiId=475005267981971499
x-documentation-category: 账号模块 / 门店管理
description: 批量解除门店绑定部门
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
deptId:
type: string
description: 三维家部门ID,deptId和outDeptId两个至少传一个,用于查找部门,传入deptId后将忽略outDeptId
examples:
- '20171234'
outDeptId:
type: string
description: 部门对应的企业系统部门ID,deptId和outDeptId两个至少传一个,用于查找部门,不传deptId时outDeptId有效
examples:
- '456789'
outShopIdList:
type: array
items: {}
description: 门店对应的企业系统门店ID列表,shopIdList和outShopIdList两个至少传一个,用于查找门店,不传shopIdList时outShopIdList有效
examples:
- '["20171234","20171235"]'
shopIdList:
type: array
items: {}
description: 三维家门店ID列表,shopIdList和outShopIdList两个至少传一个,用于查找门店,传入shopIdList后将忽略outShopIdList
examples:
- '["456789","456780"]'
example:
deptId: '20171234'
outShopIdList: []
shopIdList: []
outDeptId: '456789'
responses:
'200':
description: 成功 / OK
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
description: 请求是否成功 / whether the call succeeded
code:
type: integer
description: 结果码 / result code (0 = success)
msg:
type: string
description: 提示信息 / message
data:
type: object
example:
msg: ''
code: 0
data: true
success: true
'401':
description: access_token 缺失或已过期 / missing or expired access_token
/api/shopOrderOp/getFactorySplitFinishShopOrderList:
post:
operationId: apiShopOrderOpGetFactorySplitFinishShopOrderList
summary: 获取关联工厂单均已拆单完成的销售单列表
tags:
- AIMES
x-source-documentation: https://dev.3vjia.com/document?apiId=853222852147695642
x-documentation-category: AIMES系统 / 订单数据 / 销售单
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
acceptUserId:
type: string
description: 接单员用户ID
current:
type: integer
format: int64
description: 当前查询第几页
customerName:
type: string
description: 客户姓名
customerPhone:
type: string
description: 客户手机号
orderCode:
type: string
description: 销售单号
orderTypeDictKey:
type: string
description: 订单类型字典Key(定制单:custom-order,售后单:aftersales-order)
schemeId:
type: string
description: 方案号
size:
type: integer
format: int64
description: 当前查询页记录数
sort:
type: array
items:
type: object
properties:
ascending:
type: boolean
description: 字段排序规则
normalized:
type: boolean
description: 是否已经规范化,即字段名与数据库字段已经一致,false的时候会将驼峰转下划线
property:
type: string
description: 根据哪个字段进行排序
description: 排序定义
userId:
type: string
description: 用户ID,用于查找该用户所属部门(总部管理人员不要配门店)或门店创建的销售单
originalSaleOrderCode:
type: string
description: 原销售订单编号
required:
- current
- size
example:
acceptUserId: ''
schemeId: ''
orderTypeDictKey: ''
sort:
- normalized: false
ascending: false
property: ''
userId: ''
customerName: ''
current: 0
customerPhone: ''
size: 0
orderCode: ''
originalSaleOrderCode: ''
responses:
'200':
description: 成功 / OK
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
description: 请求是否成功 / whether the call succeeded
code:
type: integer
description: 结果码 / result code (0 = success)
msg:
type: string
description: 提示信息 / message
data:
type: object
properties:
current:
type: integer
format: int64
description: 当前查询第几页
records:
type: array
items:
type: object
properties:
attachDrawings:
type: array
items:
type: object
properties:
bizId:
type: integer
format: int64
description: 业务ID
bizType:
type: string
description: 业务类型,详见枚举
fileName:
type: string
description: 文件名称
fileSize:
type: integer
format: int32
description: 文件大小
fileType:
type: string
description: 文件类型
id:
type: integer
format: int64
description: 主键id
url:
type: string
description: 附件路径
required:
- id
description: 订单详情附件 Result
batchDeliveryStatusCode:
type: string
description: 批发货状态编码
batchDeliveryStatusName:
type: string
description: 批发货状态名称
batchDeliveryTime:
type: string
format: date-time
description: 批发货审批时间
billId:
type: integer
format: int64
description: 账单ID
billNumber:
type: string
description: 账单编号
branchStoreId:
type: string
description: 分店ID
branchStoreList:
type: array
items:
type: object
properties:
factoryDealerId:
type: integer
format: int64
description: 工厂经销商id
id:
type: integer
format: int64
description: 分店ID
shopName:
type: string
description: 分店名称
description: 经销商分店Select
brandCode:
type: string
description: 品牌编号
brandName:
type: string
description: 品牌名称
canCancelFactoryAuditStatus:
type: integer
format: int32
description: 能否反生产审核:0-否;1-是
canFactoryAuditStatus:
type: integer
format: int32
description: 能否生产审核:0-否;1-是
canShopAudit:
type: integer
format: int32
description: 能否门店审核:0-否;1-是
canUpdatePlanDeliveryDate:
type: integer
format: int32
description: 能否修改工厂交货期:0-否;1-是
contractNo:
type: string
description: 合同编号
createTime:
type: string
format: date-time
description: 创建时间
creatorId:
type: string
description: 创建人
creatorUserRealName:
type: string
description: 创建人姓名
customOrderNo:
type: string
description: 自定义单号
customerAddress:
type: string
description: 业主地址街道
customerArea:
type: string
description: 业主地址区
customerAreaCode:
type: string
description: 业主地址区行政编号
customerCity:
type: string
description: 业主地址市
customerCityCode:
type: string
description: 业主地址市行政编号
customerGender:
type: integer
format: int32
description: 业主性别 (0-未填;1-女;2-男)
customerId:
type: string
description: 业主ID
customerName:
type: string
description: 业主姓名
customerPhone:
type: string
description: 业主电话
customerPostcode:
type: string
description: 业主地址邮政编号
customerProvince:
type: string
description: 业主地址省
customerProvinceCode:
type: string
description: 业主地址省行政编号
dealerTypeCode:
type: string
description: 企业经销商类型编码
dealerTypeName:
type: string
description: 企业经销商类型名称
deliveryDate:
type: string
format: date
description: 预交货时间
deliveryPeriod:
type: integer
format: int32
description: 交货周期
designerId:
type: string
description: 设计师id
designerName:
type: string
description: 设计师
designerPhone:
type: string
description: 设计师电话
discountAmount:
type: number
format: bigdecimal
description: 优惠金额
discountBeforePrice:
type: number
format: bigdecimal
description: 折前金额
factoryAuditStatusDesc:
type: string
description: 生产审核状态
factoryAuditTime:
type: string
format: date-time
description: 生产审核时间
factoryBaseId:
type: integer
format: int64
description: 工厂基地id
factoryBaseName:
type: string
description: 工厂基地名称
id:
type: integer
format: int64
description: 订单id
isBack:
type: integer
format: int32
description: 销售单退回 是否退回,0:否;1:是
isDistribution:
type: integer
format: int32
description: 是否可分配:0=否, 1=是
isHaveShop:
type: integer
format: int32
description: 有无分店(0:无;1:有)
isOrderBack:
type: integer
format: int32
description: 是否工厂有退单:0=否, 1=是
isPush:
type: integer
format: int32
description: 是否推送成功(0:否,1:是)
isSuspend:
type: integer
format: int32
description: 是否有暂停:0=否, 1=是
isUpdateFactoryBase:
type: integer
format: int32
description: 是否可以修改基地:0-否;1-是
isUrgent:
type: integer
format: int32
description: 是否加急:0=否, 1=是
isValid:
type: integer
format: int32
description: 是否作废(0:否,1:是)
logisticsAddress:
type: string
description: 物流信息地址
natureOfOrder:
type: string
description: 订单性质
orderCategoryDictKey:
type: string
description: 订单品类字典Key
orderCategoryDictVal:
type: string
description: 订单品类字典Value
orderCode:
type: string
description: 订单编号
orderName:
type: string
description: 订单名称
orderSuit:
type: integer
format: int32
description: 订单套数
orderTypeCode:
type: string
description: 订单类型
orderTypeDictKey:
type: string
description: 订单类型字典Key
orderTypeDictVal:
type: string
description: 订单类型字典Value
orderTypeName:
type: string
description: 订单类型名称
organDealerCode:
type: string
description: 经销商编码
organDealerName:
type: string
description: 经销商名称
organId:
type: string
description: 企业ID
payStatus:
type: integer
format: int32
description: 支付状态(0=待付款; 1=未结清; 2=已结清)
payStatusDesc:
type: string
description: 支付状态(0=待付款; 1=未结清; 2=已结清)
placeTypeDictKey:
type: string
description: 下单类型字典Key
placeTypeDictVal:
type: string
description: 下单类型字典Value
planDeliveryDate:
type: string
format: date
description: 工厂交货日期
pricingMethod:
type: string
description: 取价方式
productionLine:
type: string
description: 生产线
projectId:
type: string
description: 项目ID
pushDateTime:
type: string
format: date-time
description: 推送时间
pushOperatorId:
type: string
description: 推送人
pushStatus:
type: string
description: 推送状态
rebatesRate:
type: number
format: bigdecimal
description: 返点率
rebatesSettlementAmount:
type: number
format: bigdecimal
description: 返点结算金额
receiverAddress:
type: string
description: 收货人地址街道
receiverArea:
type: string
description: 收货人地址区
receiverAreaCode:
type: string
description: 收货人地址区行政编号
receiverCity:
type: string
description: 收货人地址市
receiverCityCode:
type: string
description: 收货人地址市行政编号
receiverGender:
type: integer
format: int32
description: 收货人性别 (0-未填;1-女;2-男)
receiverName:
type: string
description: 收货人姓名
receiverPhone:
type: string
description: 收货人电话
receiverPostcode:
type: string
description: 收货人地址邮政编号
receiverProvince:
type: string
description: 收货人地址省
receiverProvinceCode:
type: string
description: 收货人地址省行政编号
receiverType:
type: string
description: 收货人类型 customer=业主 shop=门店
relatedOrderCode:
type: string
description: 关联订单号
relatedOrderId:
type: integer
format: int64
description: 关联订单ID
relatedOrderName:
type: string
description: 关联订单名称
salesName:
type: string
description: 销售
settlementAmount:
type: number
format: bigdecimal
description: 已结金额
shipmentType:
type: string
description: 出货类型
shopId:
type: string
description: 经销商ID
shopName:
type: string
description: 经销商名称
shopOrderAttachFiles:
type: array
items:
type: object
properties:
bizId:
type: integer
format: int64
description: 业务ID
bizType:
type: string
description: 业务类型,详见枚举
fileName:
type: string
description: 文件名称
fileSize:
type: integer
format: int32
description: 文件大小
fileType:
type: string
description: 文件类型
id:
type: integer
format: int64
description: 主键id
url:
type: string
description: 附件路径
required:
- id
description: 订单详情附件 Result
shopRemark:
type: string
description: 订单备注
signedName:
type: string
description: 签收人姓名
signedUserId:
type: string
description: 签收人ID
statusCode:
type: string
description: 订单状态编码
statusName:
type: string
description: 订单状态名称
statusTodoName:
type: string
description: 订单状态待办名称
submitTime:
type: string
format: date-time
description: 订单提交到工厂的时间
submitUserId:
type: string
description: 店铺订单提交人用户ID
submitUserRealName:
type: string
description: 店铺订单提交人用户姓名
taxCategory:
type: string
description: 税种
totalAmount:
type: number
format: bigdecimal
description: 工厂结算价
totalArea:
type: number
format: bigdecimal
description: 展开面积
totalSaleAmount:
type: number
format: bigdecimal
description: 销售价
tradePrice:
type: number
format: bigdecimal
description: 交易单价
unSettlementAmount:
type: number
format: bigdecimal
description: 未结金额
zzbStatusDesc:
type: string
description: 至装宝状态
required:
- id
description: 门店订单详情出参
size:
type: integer
format: int64
description: 当前查询页记录数
total:
type: integer
format: int64
description: 总数
required:
- current
- size
- total
example:
msg: ''
code: 0
data:
records:
- customerPostcode: ''
dealerTypeName: ''
pricingMethod: ''
discountAmount: 0
receiverCity: ''
orderCategoryDictKey: ''
receiverAreaCode: ''
batchDeliveryTime: ''
receiverPhone: ''
customerAreaCode: ''
rebatesSettlementAmount: 0
customerProvinceCode: ''
placeTypeDictKey: ''
id: 0
brandCode: ''
customerAddress: ''
designerId: ''
designerPhone: ''
payStatusDesc: ''
attachDrawings:
- fileName: ''
bizType: ''
url: ''
fileSize: 0
bizId: 0
id: 0
fileType: ''
batchDeliveryStatusCode: ''
orderTypeDictVal: ''
customerArea: ''
receiverPostcode: ''
pushOperatorId: ''
customerName: ''
relatedOrderName: ''
submitTime: ''
factoryBaseName: ''
receiverType: ''
organId: ''
billNumber: ''
statusCode: ''
batchDeliveryStatusName: ''
isUrgent: 0
factoryAuditStatusDesc: ''
contractNo: ''
isHaveShop: 0
relatedOrderCode: ''
rebatesRate: 0
canFactoryAuditStatus: 0
customOrderNo: ''
shipmentType: ''
creatorUserRealName: ''
customerPhone: ''
signedName: ''
customerCityCode: ''
customerId: ''
statusName: ''
factoryBaseId: 0
deliveryDate: ''
zzbStatusDesc: ''
orderName: ''
signedUserId: ''
customerGender: 0
isValid: 0
pushDateTime: ''
orderTypeName: ''
organDealerCode: ''
createTime: ''
settlementAmount: 0
totalArea: 0
canCancelFactoryAuditStatus: 0
orderTypeCode: ''
receiverProvince: ''
branchStoreId: ''
isBack: 0
totalSaleAmount: 0
unSettlementAmount: 0
dealerTypeCode: ''
productionLine: ''
isOrderBack: 0
deliveryPeriod: 0
shopId: ''
brandName: ''
customerProvince: ''
isDistribution: 0
planDeliveryDate: ''
submitUserId: ''
taxCategory: ''
receiverAddress: ''
totalAmount: 0
discountBeforePrice: 0
factoryAuditTime: ''
salesName: ''
billId: 0
projectId: ''
tradePrice: 0
isSuspend: 0
isUpdateFactoryBase: 0
shopRemark: ''
isPush: 0
logisticsAddress: ''
canShopAudit: 0
receiverGender: 0
shopOrderAttachFiles:
- fileName: ''
bizType: ''
url: ''
fileSize: 0
bizId: 0
id: 0
fileType: ''
creatorId: ''
receiverCityCode: ''
shopName: ''
customerCity: ''
relatedOrderId: 0
orderCategoryDictVal: ''
orderSuit: 0
branchStoreList:
- shopName: ''
id: 0
factoryDealerId: 0
canUpdatePlanDeliveryDate: 0
natureOfOrder: ''
statusTodoName: ''
organDealerName: ''
placeTypeDictVal: ''
pushStatus: ''
receiverName: ''
receiverArea: ''
orderTypeDictKey: ''
submitUserRealName: ''
designerName: ''
orderCode: ''
receiverProvinceCode: ''
payStatus: 0
current: 0
total: 0
size: 0
success: false
'401':
description: access_token 缺失或已过期 / missing or expired access_token
/api/submissionConfig/designSearch:
post:
operationId: apiSubmissionConfigDesignSearch
summary: 查询提审选项列表
tags:
- Dedicated Services
x-source-documentation: https://dev.3vjia.com/document?apiId=786899025579364392
x-documentation-category: 专属服务 / C11876880
description: 获取提审信息的具体选项数据。支持三种模式:1. 级联查询:传入父选项ID,获取其下一级子选项;2.查询一级选项;3. 模糊搜索:传入选项名称,检索匹配的选项列表。常用于构建多级联动选择器
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
isAllQuery:
type: boolean
description: 是否查询所有级联关系
isRootQuery:
type: boolean
description: 是否查询一级节点
optionName:
type: string
description: 搜索关键词
parentId:
type: integer
format: int64
description: 父选项ID,查询非一级选项时必填
required:
- isAllQuery
- isRootQuery
example:
parentId: 0
isAllQuery: false
isRootQuery: false
optionName: ''
responses:
'200':
description: 成功 / OK
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
description: 请求是否成功 / whether the call succeeded
code:
type: integer
description: 结果码 / result code (0 = success)
msg:
type: string
description: 提示信息 / message
data:
type: object
properties:
children:
type: array
items: {}
description: 子选项列表
configId:
type: integer
format: int64
description: 配置ID
configName:
type: string
description: 信息配置名称
id:
type: integer
format: int64
description: 选项ID
isFixed:
type: boolean
description: 是否固定选项
optionLabel:
type: string
description: 选项标签
parentId:
type: integer
format: int64
description: 父选项ID
sortOrder:
type: integer
format: int32
description: 排序顺序
example:
msg: ''
code: 0
data:
- configName: ''
parentId: 0
optionLabel: ''
children: []
configId: 0
sortOrder: 0
id: 0
isFixed: false
success: false
'401':
description: access_token 缺失或已过期 / missing or expired access_token
/api/submissionConfig/pageQueryConfig:
post:
operationId: apiSubmissionConfigPageQueryConfig
summary: '查询提审配置定义 '
tags:
- Dedicated Services
x-source-documentation: https://dev.3vjia.com/document?apiId=786899025579364394
x-documentation-category: 专属服务 / C11876880
description: 分页获取提审信息的配置项元数据。配置项定义了提审所需的字段结构(如:材质、房间名等),返回结果包含配置项的基础属性及关联的一级选项。该接口用于获取字段定义,以便动态渲染表单
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
configId:
type: integer
format: int64
description: 信息配置id, 用于查询指定配置详情模糊搜索配置下的选项
current:
type: integer
format: int64
description: 当前查询第几页
optionName:
type: string
description: 选项名称,用于查询指定配置详情模糊搜索配置下的选项
size:
type: integer
format: int64
description: 当前查询页记录数
sort:
type: array
items:
type: object
properties:
ascending:
type: boolean
description: 字段排序规则
normalized:
type: boolean
description: 是否已经规范化,即字段名与数据库字段已经一致,false的时候会将驼峰转下划线
property:
type: string
description: 根据哪个字段进行排序
description: 排序定义
required:
- current
- size
example:
sort:
- normalized: false
ascending: false
property: ''
current: 0
size: 0
configId: 0
optionName: ''
responses:
'200':
description: 成功 / OK
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
description: 请求是否成功 / whether the call succeeded
code:
type: integer
description: 结果码 / result code (0 = success)
msg:
type: string
description: 提示信息 / message
data:
type: object
properties:
current:
type: integer
format: int64
description: 当前查询第几页
records:
type: array
items:
type: object
properties:
configName:
type: string
description: 信息名称
configType:
type: integer
format: int32
description: 信息类型
id:
type: integer
format: int64
description: 配置ID
isEditable:
type: boolean
description: 是否可编辑
isRelated:
type: boolean
description: 该信息下的选项是否有级联关系
isRequired:
type: boolean
description: 是否必填
options:
type: array
items:
type: object
properties:
children:
type: array
items: {}
description: 子选项列表
configId:
type: integer
format: int64
description: 配置ID
configName:
type: string
description: 信息配置名称
id:
type: integer
format: int64
description: 选项ID
isFixed:
type: boolean
description: 是否固定选项
optionLabel:
type: string
description: 选项标签
parentId:
type: integer
format: int64
description: 父选项ID
sortOrder:
type: integer
format: int32
description: 排序顺序
description: 选项列表
showInOrder:
type: boolean
description: 是否显示在顺序中
description: 分页记录
size:
type: integer
format: int64
description: 当前查询页记录数
total:
type: integer
format: int64
description: 总数
required:
- current
- size
- total
example:
msg: ''
code: 0
data:
records:
- configName: ''
isRequired: false
configType: 0
isRelated: false
isEditable: false
options:
- configName: ''
parentId: 0
optionLabel: ''
children: []
configId: 0
sortOrder: 0
id: 0
isFixed: false
showInOrder: false
id: 0
current: 0
total: 0
size: 0
success: false
'401':
description: access_token 缺失或已过期 / missing or expired access_token
/api/taggroup/page:
post:
operationId: apiTaggroupPage
summary: 分页查询标签组和标签信息
tags:
- Design Schemes
x-source-documentation: https://dev.3vjia.com/document?apiId=744248039480377472
x-documentation-category: 方案模块 / 方案岛
description: 分页查询标签组信息
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
pageIndex:
type: integer
format: int32
pageSize:
type: integer
format: int32
sorts:
type: array
items:
type: object
properties:
sortField:
type: string
description: 排序字段
sortType:
type: string
description: 排序类型,asc或者desc
description: "This is List Type \n查询排序集合"
where:
type: object
properties:
groupStatus:
type: string
description: 分组状态:enable-启用,disable-禁用
groupType:
type: integer
format: int32
description: 标签组类型:0-全屋空间案例库,1-营销活动套餐库,2-卫浴空间案例库,3-阳台空间案例库,4-全场景高端定制方案,5-卫浴个性空间案例库,6-淋浴房空间案例库
isShowDisabledTags:
type: integer
format: int32
description: 是否显示禁用标签项,0-不显示,1-显示
description: 分页查询标签分组
example:
pageSize: 0
pageIndex: 0
where:
groupType: 0
groupStatus: ''
isShowDisabledTags: 0
sorts:
- sortType: ''
sortField: ''
responses:
'200':
description: 成功 / OK
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
description: 请求是否成功 / whether the call succeeded
code:
type: integer
description: 结果码 / result code (0 = success)
msg:
type: string
description: 提示信息 / message
data:
type: object
properties:
pageIndex:
type: integer
format: int32
pageSize:
type: integer
format: int32
recordCount:
type: integer
format: int32
result:
type: array
items:
type: object
properties:
createDate:
type: string
description: 创建时间
creator:
type: string
description: 创建人
groupName:
type: string
description: 分组名称
groupStatus:
type: string
description: 是否启用:enable-启用,disable-禁用
groupType:
type: integer
format: int32
description: 标签组类型:0-全屋空间案例库,1-营销活动套餐库,2-卫浴空间案例库,3-阳台空间案例库,4-全场景高端定制方案,5-卫浴个性空间案例库,6-淋浴房空间案例库
id:
type: string
description: 主键ID
imagePath:
type: string
description: “不限”选项的封面图
isDelete:
type: integer
format: int32
description: 是否删除
modify:
type: string
description: 修改人
modifyDate:
type: string
description: 修改时间
organId:
type: string
description: 机构ID
sortNo:
type: integer
format: int32
description: 排序
tags:
type: array
items:
type: object
properties:
createDate:
type: string
description: 创建时间
creator:
type: string
description: 创建人
id:
type: string
description: 标签ID
imagePath:
type: string
description: 标签图片
modify:
type: string
description: 修改人
modifyDate:
type: string
description: 修改时间
organId:
type: string
description: 机构ID
sortNo:
type: integer
format: int32
description: 排序
tagName:
type: string
description: 标签名称
tagStatus:
type: string
description: 标签状态
tenantId:
type: string
description: tenantId租户id(兼容)
description: 标签表OutputDto
description: 标签分组结果
example:
msg: ''
code: 0
data:
recordCount: 0
pageSize: 0
result:
- creator: ''
groupType: 0
modifyDate: ''
imagePath: ''
isDelete: 0
groupStatus: ''
tags:
- creator: ''
modifyDate: ''
tagStatus: ''
imagePath: ''
tagName: ''
sortNo: 0
modify: ''
tenantId: ''
organId: ''
id: ''
createDate: ''
sortNo: 0
modify: ''
groupName: ''
organId: ''
id: ''
createDate: ''
pageIndex: 0
success: false
'401':
description: access_token 缺失或已过期 / missing or expired access_token
/api/userInfo/roleList:
post:
operationId: apiUserInfoRoleList
summary: 慧引流角色列表
tags:
- Xuanchi AI
x-source-documentation: https://dev.3vjia.com/document?apiId=704254008587599945
x-documentation-category: 玄尺AI / 基础管理
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
hylTenantId:
type: integer
format: int64
description: 慧引流租户ID
name:
type: string
description: 角色名称
example:
hylTenantId: 0
name: ''
responses:
'200':
description: 成功 / OK
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
description: 请求是否成功 / whether the call succeeded
code:
type: integer
description: 结果码 / result code (0 = success)
msg:
type: string
description: 提示信息 / message
data:
type: object
properties:
roleId:
type: integer
format: int64
description: 角色id
name:
type: string
description: 角色名称
admin:
type: boolean
description: 是否超管
createTime:
type: string
format: date-time
description: 创建时间
example:
msg: ''
code: 0
data:
- roleId: 0
admin: false
createTime: ''
name: ''
success: false
'401':
description: access_token 缺失或已过期 / missing or expired access_token
/api/userInfo/teamCreate:
post:
operationId: apiUserInfoTeamCreate
summary: 慧引流团队创建
tags:
- Xuanchi AI
x-source-documentation: https://dev.3vjia.com/document?apiId=704398208725565567
x-documentation-category: 玄尺AI / 基础管理
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
hylTenantId:
type: integer
format: int64
description: 慧引流租户ID
name:
type: string
description: 名称
remark:
type: string
description: 备注
required:
- name
example:
remark: ''
hylTenantId: 0
name: ''
responses:
'200':
description: 成功 / OK
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
description: 请求是否成功 / whether the call succeeded
code:
type: integer
description: 结果码 / result code (0 = success)
msg:
type: string
description: 提示信息 / message
data:
type: object
properties:
teamId:
type: integer
format: int64
description: 团队id
example:
msg: ''
code: 0
data:
teamId: 0
success: false
'401':
description: access_token 缺失或已过期 / missing or expired access_token
/api/userInfo/teamGet:
post:
operationId: apiUserInfoTeamGet
summary: 慧引流团队获取
tags:
- Xuanchi AI
x-source-documentation: https://dev.3vjia.com/document?apiId=704398605234094126
x-documentation-category: 玄尺AI / 基础管理
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
hylTenantId:
type: integer
format: int64
description: 慧引流租户ID
teamId:
type: integer
format: int64
description: 团队ID
required:
- teamId
example:
hylTenantId: 0
teamId: 0
responses:
'200':
description: 成功 / OK
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
description: 请求是否成功 / whether the call succeeded
code:
type: integer
description: 结果码 / result code (0 = success)
msg:
type: string
description: 提示信息 / message
data:
type: object
properties:
teamId:
type: integer
format: int64
description: 团队id
name:
type: string
description: 团队名称
remark:
type: string
description: 团队备注
createTime:
type: string
format: date-time
description: 创建时间
example:
msg: ''
code: 0
data:
remark: ''
createTime: ''
teamId: 0
name: ''
success: false
'401':
description: access_token 缺失或已过期 / missing or expired access_token
/api/userInfo/teamList:
post:
operationId: apiUserInfoTeamList
summary: 慧引流团队列表
tags:
- Xuanchi AI
x-source-documentation: https://dev.3vjia.com/document?apiId=704254008587599943
x-documentation-category: 玄尺AI / 基础管理
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
hylTenantId:
type: integer
format: int64
description: 慧引流租户ID
name:
type: string
description: 团队名称
example:
hylTenantId: 0
name: ''
responses:
'200':
description: 成功 / OK
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
description: 请求是否成功 / whether the call succeeded
code:
type: integer
description: 结果码 / result code (0 = success)
msg:
type: string
description: 提示信息 / message
data:
type: object
properties:
teamId:
type: integer
format: int64
description: 团队id
name:
type: string
description: 团队名称
createTime:
type: string
format: date-time
description: 创建时间
remark:
type: string
description: 团队备注
example:
msg: ''
code: 0
data:
- remark: ''
createTime: ''
teamId: 0
name: ''
success: false
'401':
description: access_token 缺失或已过期 / missing or expired access_token
/api/userInfo/teamRemove:
post:
operationId: apiUserInfoTeamRemove
summary: 慧引流团队删除
tags:
- Xuanchi AI
x-source-documentation: https://dev.3vjia.com/document?apiId=704399970379386905
x-documentation-category: 玄尺AI / 基础管理
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
hylTenantId:
type: integer
format: int64
description: 慧引流租户ID
teamId:
type: integer
format: int64
description: 团队ID
required:
- teamId
example:
hylTenantId: 0
teamId: 0
responses:
'200':
description: 成功 / OK
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
description: 请求是否成功 / whether the call succeeded
code:
type: integer
description: 结果码 / result code (0 = success)
msg:
type: string
description: 提示信息 / message
data:
type: object
example:
msg: ''
code: 0
data: ''
success: false
'401':
description: access_token 缺失或已过期 / missing or expired access_token
/api/userInfo/teamUpdate:
post:
operationId: apiUserInfoTeamUpdate
summary: 慧引流团队修改
tags:
- Xuanchi AI
x-source-documentation: https://dev.3vjia.com/document?apiId=704399970379386903
x-documentation-category: 玄尺AI / 基础管理
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
hylTenantId:
type: integer
format: int64
description: 慧引流租户ID
teamId:
type: integer
format: int64
description: 团队ID
name:
type: string
description: 名称
remark:
type: string
description: 备注
required:
- teamId
example:
remark: ''
hylTenantId: 0
teamId: 0
name: ''
responses:
'200':
description: 成功 / OK
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
description: 请求是否成功 / whether the call succeeded
code:
type: integer
description: 结果码 / result code (0 = success)
msg:
type: string
description: 提示信息 / message
data:
type: object
example:
msg: ''
code: 0
data: ''
success: false
'401':
description: access_token 缺失或已过期 / missing or expired access_token
/api/userInfo/userCreate:
post:
operationId: apiUserInfoUserCreate
summary: 慧引流用户创建
tags:
- Xuanchi AI
x-source-documentation: https://dev.3vjia.com/document?apiId=704254008587599941
x-documentation-category: 玄尺AI / 基础管理
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
hylTenantId:
type: integer
format: int64
description: 慧引流租户ID
userId:
type: string
description: 用户ID
userNickname:
type: string
description: 用户昵称
name:
type: string
description: 姓名
remark:
type: string
description: 备注
roleIds:
type: array
items: {}
teamIds:
type: array
items: {}
required:
- userId
- userNickname
- roleIds
- teamIds
example:
userNickname: ''
remark: ''
userId: ''
teamIds: []
roleIds: []
hylTenantId: 0
name: ''
responses:
'200':
description: 成功 / OK
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
description: 请求是否成功 / whether the call succeeded
code:
type: integer
description: 结果码 / result code (0 = success)
msg:
type: string
description: 提示信息 / message
data:
type: object
properties:
userId:
type: integer
format: int64
description: 慧引流用户id
example:
msg: ''
code: 0
data:
userId: 0
success: false
'401':
description: access_token 缺失或已过期 / missing or expired access_token
/api/userInfo/userGet:
post:
operationId: apiUserInfoUserGet
summary: 慧引流用户获取
tags:
- Xuanchi AI
x-source-documentation: https://dev.3vjia.com/document?apiId=704253756946137109
x-documentation-category: 玄尺AI / 基础管理
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
hylTenantId:
type: integer
format: int64
description: 慧引流租户ID
userId:
type: string
description: 用户ID
hylUserId:
type: integer
format: int64
description: 慧引流用户ID
example:
userId: ''
hylUserId: 0
hylTenantId: 0
responses:
'200':
description: 成功 / OK
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
description: 请求是否成功 / whether the call succeeded
code:
type: integer
description: 结果码 / result code (0 = success)
msg:
type: string
description: 提示信息 / message
data:
type: object
properties:
userId:
type: integer
format: int64
description: 用户id
mobile:
type: string
description: 手机号
nickname:
type: string
description: 昵称
name:
type: string
description: 姓名
remark:
type: string
description: 备注
state:
type: integer
format: int32
description: 状态:0-禁用,1-启用
roleList:
type: array
items:
type: object
properties:
roleId:
type: integer
format: int64
description: 角色id
name:
type: string
description: 角色名称
admin:
type: boolean
description: 是否超管
createTime:
type: string
format: date-time
description: 创建时间
description: RoleListResultVo对象
teamList:
type: array
items:
type: object
properties:
teamId:
type: integer
format: int64
description: 团队id
name:
type: string
description: 团队名称
createTime:
type: string
format: date-time
description: 创建时间
description: TeamListResultVo对象
createTime:
type: string
format: date-time
description: 创建时间
example:
msg: ''
code: 0
data:
mobile: ''
remark: ''
roleList:
- roleId: 0
admin: false
createTime: ''
name: ''
userId: 0
createTime: ''
nickname: ''
name: ''
state: 0
teamList:
- createTime: ''
teamId: 0
name: ''
success: false
'401':
description: access_token 缺失或已过期 / missing or expired access_token
/api/userInfo/userPage:
post:
operationId: apiUserInfoUserPage
summary: 慧引流用户分页查询
tags:
- Xuanchi AI
x-source-documentation: https://dev.3vjia.com/document?apiId=704253756946137107
x-documentation-category: 玄尺AI / 基础管理
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
sort:
type: array
items:
type: object
properties:
property:
type: string
description: 根据哪个字段进行排序
ascending:
type: boolean
description: 字段排序规则
normalized:
type: boolean
description: 是否已经规范化,即字段名与数据库字段已经一致,false的时候会将驼峰转下划线
required:
- property
- ascending
- normalized
description: 排序定义
current:
type: integer
format: int64
description: 当前查询第几页
size:
type: integer
format: int64
description: 当前查询页记录数
hylTenantId:
type: integer
format: int64
description: 慧引流租户ID
userId:
type: string
description: 用户id
state:
type: integer
format: int32
description: 状态:0-禁用,1-启用
mobile:
type: string
description: 手机号
nickname:
type: string
description: 昵称
name:
type: string
description: 姓名
remark:
type: string
description: 备注
roleId:
type: integer
format: int64
description: 角色id
teamId:
type: integer
format: int64
description: 团队id
hylUserId:
type: integer
format: int64
description: 慧引流用户id
required:
- current
- size
example:
roleId: 0
mobile: ''
remark: ''
sort:
- normalized: false
ascending: false
property: ''
userId: ''
hylUserId: 0
current: 0
size: 0
hylTenantId: 0
teamId: 0
nickname: ''
name: ''
state: 0
responses:
'200':
description: 成功 / OK
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
description: 请求是否成功 / whether the call succeeded
code:
type: integer
description: 结果码 / result code (0 = success)
msg:
type: string
description: 提示信息 / message
data:
type: object
properties:
total:
type: integer
format: int64
description: 总数
current:
type: integer
format: int64
description: 当前查询第几页
size:
type: integer
format: int64
description: 当前查询页记录数
records:
type: array
items:
type: object
properties:
userId:
type: integer
format: int64
description: 用户id
mobile:
type: string
description: 手机号
nickname:
type: string
description: 昵称
name:
type: string
description: 姓名
remark:
type: string
description: 备注
state:
type: integer
format: int32
description: 状态:0-禁用,1-启用
roleList:
type: array
items:
type: object
properties:
roleId:
type: integer
format: int64
description: 角色id
name:
type: string
description: 角色名称
admin:
type: boolean
description: 是否超管
createTime:
type: string
format: date-time
description: 创建时间
description: RoleListResultVo对象
teamList:
type: array
items:
type: object
properties:
teamId:
type: integer
format: int64
description: 团队id
name:
type: string
description: 团队名称
createTime:
type: string
format: date-time
description: 创建时间
description: TeamListResultVo对象
createTime:
type: string
format: date-time
description: 创建时间
description: UserTenantListResultVo对象
required:
- total
- current
- size
example:
msg: ''
code: 0
data:
records:
- mobile: ''
remark: ''
roleList:
- roleId: 0
admin: false
createTime: ''
name: ''
userId: 0
createTime: ''
nickname: ''
name: ''
state: 0
teamList:
- createTime: ''
teamId: 0
name: ''
total: 0
current: 0
size: 0
success: false
'401':
description: access_token 缺失或已过期 / missing or expired access_token
/api/userInfo/userRemove:
post:
operationId: apiUserInfoUserRemove
summary: 慧引流用户移除
tags:
- Xuanchi AI
x-source-documentation: https://dev.3vjia.com/document?apiId=704254008587599939
x-documentation-category: 玄尺AI / 基础管理
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
hylTenantId:
type: integer
format: int64
description: 慧引流租户ID
hylUserId:
type: integer
format: int64
description: 慧引流用户ID
required:
- hylUserId
example:
hylUserId: 0
hylTenantId: 0
responses:
'200':
description: 成功 / OK
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
description: 请求是否成功 / whether the call succeeded
code:
type: integer
description: 结果码 / result code (0 = success)
msg:
type: string
description: 提示信息 / message
data:
type: object
example:
msg: ''
code: 0
data: ''
success: false
'401':
description: access_token 缺失或已过期 / missing or expired access_token
/api/userInfo/userUpdate:
post:
operationId: apiUserInfoUserUpdate
summary: 慧引流用户修改
tags:
- Xuanchi AI
x-source-documentation: https://dev.3vjia.com/document?apiId=704253756946137105
x-documentation-category: 玄尺AI / 基础管理
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
hylTenantId:
type: integer
format: int64
description: 慧引流租户ID
hylUserId:
type: integer
format: int64
description: 慧引流用户ID
state:
type: integer
format: int32
description: 状态:0-禁用,1-启用
name:
type: string
description: 姓名
remark:
type: string
description: 备注
roleIds:
type: array
items: {}
teamIds:
type: array
items: {}
required:
- hylUserId
example:
remark: ''
hylUserId: 0
teamIds: []
roleIds: []
hylTenantId: 0
name: ''
state: 0
responses:
'200':
description: 成功 / OK
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
description: 请求是否成功 / whether the call succeeded
code:
type: integer
description: 结果码 / result code (0 = success)
msg:
type: string
description: 提示信息 / message
data:
type: object
example:
msg: ''
code: 0
data: ''
success: false
'401':
description: access_token 缺失或已过期 / missing or expired access_token
/api/userLogin/login:
post:
operationId: apiUserLoginLogin
summary: 慧引流登录
tags:
- Xuanchi AI
x-source-documentation: https://dev.3vjia.com/document?apiId=699544979588137071
x-documentation-category: 玄尺AI / 登录
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
hylUserId:
type: integer
format: int64
description: 慧引流用户ID
pageType:
type: integer
format: int32
description: 进入的页面类型,0-AI慧引流,默认值是0
required:
- hylUserId
example:
hylUserId: 0
pageType: 0
responses:
'200':
description: 成功 / OK
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
description: 请求是否成功 / whether the call succeeded
code:
type: integer
description: 结果码 / result code (0 = success)
msg:
type: string
description: 提示信息 / message
data:
type: object
properties:
url:
type: string
description: 跳转url
example:
msg: ''
code: 0
data:
url: ''
success: false
'401':
description: access_token 缺失或已过期 / missing or expired access_token
/api/v1/Goods/browseWithUser:
post:
operationId: apiV1GoodsBrowseWithUser
summary: 预览方案并做每日预览任务
tags:
- Dedicated Services
x-source-documentation: https://dev.3vjia.com/document?apiId=765940224684609642
x-documentation-category: 专属服务 / C00003518
description: 预览方案并做每日预览任务
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
id:
type: string
description: 商品ID
userId:
type: string
description: 用户id
userName:
type: string
description: userName
example:
userName: ''
userId: ''
id: ''
responses:
'200':
description: 成功 / OK
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
description: 请求是否成功 / whether the call succeeded
code:
type: integer
description: 结果码 / result code (0 = success)
msg:
type: string
description: 提示信息 / message
data:
type: object
properties:
EMPTY:
type: object
properties:
EMPTY:
type: object
description: |-
$ref:com.swj.api.designisland.dto.Task.UserTaskExecuteResult
空对象
currentProgress:
type: integer
format: int32
description: 当前用户任务进度(例如已经审核通过8个方案)
empty:
type: object
description: |-
$ref:com.swj.api.designisland.dto.Task.UserTaskExecuteResult
空对象
endDate:
type: string
description: 活动结束时间
id:
type: string
description: 主键
linkUrl:
type: string
description: 活动点击跳转的URL地址
maxReach:
type: integer
format: int32
description: 最大达成次数(任务可获得积分奖励的最大次数)
progressGoal:
type: integer
format: int32
description: 达成任务完成目标的活动数量(如通过审核10个方案,一般默认是1,例如一次签到,浏览一次方案)
reachCount:
type: integer
format: int32
description: 当前用户已经达成任务次数
resetCycle:
type: string
description: 任务重置周期(DAY,WEEK,MONTH,YEAR,LONGTIME)
resultMessage:
type: string
description: 前端控制:任务执行后消息提示语(如:点赞成功,获得1积分)
score:
type: integer
format: int32
description: 任务获得的永久积分
sortIndex:
type: integer
format: int32
description: 排序序号(号码越大,越排前面)
startDate:
type: string
description: 活动开始时间
state:
type: string
description: 状态codenotStart=未开始,started=去完成,over=已结束,finish=已完成
stateName:
type: string
description: 状态名称notStart=未开始,started=去完成,over=已结束,finish=已完成
taskIcon:
type: string
description: 活动图标,样式名或者图标URL
taskIntro:
type: string
description: 活动简介
taskKey:
type: string
description: 活动KEY
taskName:
type: string
description: 活动名称
taskType:
type: integer
format: int32
description: 任务类型(1=日常任务,2=基本任务)
tempScore:
type: integer
format: int32
description: 任务获得的临时积分
totalScore:
type: integer
format: int32
description: 本次任务获得的总积分,大于0本次任务已达成,等于0任务未达成
description: |-
用户任务执行结果返回DTO
积分任务结果
currentProgress:
type: integer
format: int32
description: 当前用户任务进度(例如已经审核通过8个方案)
empty:
type: object
properties:
EMPTY:
type: object
description: |-
$ref:com.swj.api.designisland.dto.Task.UserTaskExecuteResult
空对象
currentProgress:
type: integer
format: int32
description: 当前用户任务进度(例如已经审核通过8个方案)
empty:
type: object
description: |-
$ref:com.swj.api.designisland.dto.Task.UserTaskExecuteResult
空对象
endDate:
type: string
description: 活动结束时间
id:
type: string
description: 主键
linkUrl:
type: string
description: 活动点击跳转的URL地址
maxReach:
type: integer
format: int32
description: 最大达成次数(任务可获得积分奖励的最大次数)
progressGoal:
type: integer
format: int32
description: 达成任务完成目标的活动数量(如通过审核10个方案,一般默认是1,例如一次签到,浏览一次方案)
reachCount:
type: integer
format: int32
description: 当前用户已经达成任务次数
resetCycle:
type: string
description: 任务重置周期(DAY,WEEK,MONTH,YEAR,LONGTIME)
resultMessage:
type: string
description: 前端控制:任务执行后消息提示语(如:点赞成功,获得1积分)
score:
type: integer
format: int32
description: 任务获得的永久积分
sortIndex:
type: integer
format: int32
description: 排序序号(号码越大,越排前面)
startDate:
type: string
description: 活动开始时间
state:
type: string
description: 状态codenotStart=未开始,started=去完成,over=已结束,finish=已完成
stateName:
type: string
description: 状态名称notStart=未开始,started=去完成,over=已结束,finish=已完成
taskIcon:
type: string
description: 活动图标,样式名或者图标URL
taskIntro:
type: string
description: 活动简介
taskKey:
type: string
description: 活动KEY
taskName:
type: string
description: 活动名称
taskType:
type: integer
format: int32
description: 任务类型(1=日常任务,2=基本任务)
tempScore:
type: integer
format: int32
description: 任务获得的临时积分
totalScore:
type: integer
format: int32
description: 本次任务获得的总积分,大于0本次任务已达成,等于0任务未达成
description: |-
用户任务执行结果返回DTO
积分任务结果
endDate:
type: string
description: 活动结束时间
id:
type: string
description: 主键
linkUrl:
type: string
description: 活动点击跳转的URL地址
lookNums:
type: integer
format: int32
description: 方案的总浏览数量
maxReach:
type: integer
format: int32
description: 最大达成次数(任务可获得积分奖励的最大次数)
progressGoal:
type: integer
format: int32
description: 达成任务完成目标的活动数量(如通过审核10个方案,一般默认是1,例如一次签到,浏览一次方案)
reachCount:
type: integer
format: int32
description: 当前用户已经达成任务次数
resetCycle:
type: string
description: 任务重置周期(DAY,WEEK,MONTH,YEAR,LONGTIME)
resultMessage:
type: string
description: 前端控制:任务执行后消息提示语(如:点赞成功,获得1积分)
score:
type: integer
format: int32
description: 任务获得的永久积分
sortIndex:
type: integer
format: int32
description: 排序序号(号码越大,越排前面)
startDate:
type: string
description: 活动开始时间
state:
type: string
description: 状态codenotStart=未开始,started=去完成,over=已结束,finish=已完成
stateName:
type: string
description: 状态名称notStart=未开始,started=去完成,over=已结束,finish=已完成
success:
type: boolean
description: 处理结果true成功false失败
taskIcon:
type: string
description: 活动图标,样式名或者图标URL
taskIntro:
type: string
description: 活动简介
taskKey:
type: string
description: 活动KEY
taskName:
type: string
description: 活动名称
taskType:
type: integer
format: int32
description: 任务类型(1=日常任务,2=基本任务)
tempScore:
type: integer
format: int32
description: 任务获得的临时积分
totalScore:
type: integer
format: int32
description: 本次任务获得的总积分,大于0本次任务已达成,等于0任务未达成
example:
msg: ''
code: 0
data:
endDate: ''
sortIndex: 0
taskKey: ''
empty:
currentProgress: 0
tempScore: 0
endDate: ''
sortIndex: 0
taskKey: ''
taskIntro: ''
resultMessage: ''
totalScore: 0
empty: ''
score: 0
taskType: 0
stateName: ''
taskIcon: ''
reachCount: 0
linkUrl: ''
maxReach: 0
taskName: ''
id: ''
state: ''
resetCycle: ''
EMPTY: ''
startDate: ''
progressGoal: 0
score: 0
taskType: 0
stateName: ''
taskIcon: ''
linkUrl: ''
id: ''
state: ''
resetCycle: ''
EMPTY:
currentProgress: 0
tempScore: 0
endDate: ''
sortIndex: 0
taskKey: ''
taskIntro: ''
resultMessage: ''
totalScore: 0
empty: ''
score: 0
taskType: 0
stateName: ''
taskIcon: ''
reachCount: 0
linkUrl: ''
maxReach: 0
taskName: ''
id: ''
state: ''
resetCycle: ''
EMPTY: ''
startDate: ''
progressGoal: 0
progressGoal: 0
currentProgress: 0
tempScore: 0
taskIntro: ''
lookNums: 0
resultMessage: ''
totalScore: 0
success: false
reachCount: 0
maxReach: 0
taskName: ''
startDate: ''
success: false
'401':
description: access_token 缺失或已过期 / missing or expired access_token
/api/v1/Goods/getAllPage:
post:
operationId: apiV1GoodsGetAllPage
summary: 获取方案岛所有商品方案数据接口
tags:
- Design Schemes
x-source-documentation: https://dev.3vjia.com/document?apiId=505401177635147811
x-documentation-category: 方案模块 / 方案岛
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
pageIndex:
type: integer
format: int32
pageSize:
type: integer
format: int32
sorts:
type: array
items:
type: object
properties:
sortField:
type: string
sortType:
type: string
description: |-
ThisisListType
查询排序集合
where:
type: object
properties:
activitiesName:
type: string
description: 相关活动关键字
atlasStatus:
type: integer
format: int32
description: 图谱状态,-1为删除,0为入库,1为上架或者发布,2为下架,不传则查询全部
begCreateDate:
type: string
description: 创建时间开始
begDelDate:
type: string
description: 删除时间开始
begSchemeSized:
type: number
format: double
description: 面积开始
begStatusDate:
type: string
description: 状态时间开始
categorys:
type: object
description: 类目数组
endCreateDate:
type: string
description: 创建时间结束
endDelDate:
type: string
description: 删除时间结束
endSchemeSized:
type: number
format: double
description: 面积结束
endStatusDate:
type: string
description: 状态时间结束
goodsName:
type: string
description: 名称
goodsStatus:
type: string
description: 商品状态empty:草稿checking:上架审核reject:上架驳回upShelves:上架offShelves:下架
goodsType:
type: string
description: 商品类型,scheme=全景方案,excellent=优秀方案
isActivities:
type: integer
format: int32
description: 是否查询企业活动投稿方案0:查看非投稿1:查看投稿null:查看全部
isHotSell:
type: integer
format: int32
description: 是否热销方案
isUpShelves:
type: integer
format: int32
description: 是否查询已上架方案0:查询未上架方案(包含上架、参与活动的方案)1:查询已上架方案(未上架、未参与活动的方案)null:查询全部
keyword:
type: string
description: 方案名称或者产品型号模糊搜索
organId:
type: string
description: 机构id,前端有需求免登陆指定机构id获取方案列表
price:
type: integer
format: int32
description: 售价,0:免费,1:付费
productNo:
type: string
description: 产品型号
schemeId:
type: string
description: 3D方案id
schemeRoom:
type: string
description: 空间
schemeStyle:
type: string
description: 风格
schemeType:
type: string
description: 户型
tagId:
type: string
description: 标签ID
tagIdList:
type: array
items: {}
description: |-
ThisisListType
标签id集合
tenantId:
type: string
description: tenantId租户id(兼容)
userId:
type: string
description: 用户id
userName:
type: string
description: 设计师帐号,精确查询
description: |-
商品方案表SearchInputDto
分页查询条件
example:
pageSize: 0
pageIndex: 0
where:
schemeType: ''
tagId: ''
endCreateDate: ''
begCreateDate: ''
schemeId: ''
endDelDate: ''
endStatusDate: ''
price: 0
isHotSell: 0
schemeRoom: ''
keyword: ''
goodsName: ''
productNo: ''
categorys: ''
atlasStatus: 0
schemeStyle: ''
isUpShelves: 0
userName: ''
userId: ''
activitiesName: ''
goodsType: ''
begStatusDate: ''
isActivities: 0
goodsStatus: ''
tenantId: ''
organId: ''
begDelDate: ''
tagIdList: []
sorts:
- sortType: ''
sortField: ''
responses:
'200':
description: 成功 / OK
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
description: 请求是否成功 / whether the call succeeded
code:
type: integer
description: 结果码 / result code (0 = success)
msg:
type: string
description: 提示信息 / message
data:
type: object
properties:
pageIndex:
type: integer
format: int32
pageSize:
type: integer
format: int32
recordCount:
type: integer
format: int32
result:
type: array
items:
type: object
properties:
atlasId:
type: string
description: 图谱ID
atlasStatus:
type: integer
format: int32
description: 图谱状态,-1为删除,0为入库,1为上架或者发布,2为下架,不传则查询全部
buyNums:
type: integer
format: int32
description: 购买数量
buyScores:
type: integer
format: int32
description: 购买分数
checkDate:
type: string
description: 方案审核时间
checkUserId:
type: string
description: 方案审核人用户id
checkUserNickName:
type: string
description: 方案审核人用户id
commentNums:
type: integer
format: int32
description: 评论数量
content:
type: string
description: 商品介绍
coverPageFileId:
type: string
description: 封面文件ID
coverPageUrl:
type: string
description: 封面地址
createDate:
type: string
description: 创建时间
creator:
type: string
description: 创建人
favoriteNums:
type: integer
format: int32
description: 收藏数量
goodsName:
type: string
description: 名称
goodsStatus:
type: string
description: 商品状态
goodsStatusDesc:
type: string
description: 商品状态显示文本
goodsType:
type: string
description: 商品类型
goodsTypeDesc:
type: string
description: 商品类型
hasSmartRoom:
type: integer
format: int32
description: 是否有智能样板间
id:
type: string
description: 商品ID
isBuy:
type: boolean
description: 是否购买(使用权)
isBuySource:
type: boolean
description: 是否已购买了源文件
isFavorite:
type: boolean
description: 是否已收藏:true=是false=否
isHotSell:
type: integer
format: int32
description: 是否热销方案1=热销(优秀方案)
isPraise:
type: boolean
description: 是否已点赞:true=是false=否
lookNums:
type: integer
format: int32
description: 浏览数量
modifyDate:
type: string
description: 最后修改时间(删除时间)
orderNum:
type: integer
format: int32
description: 九牧定制:下单量
organId:
type: string
description: 机构ID
praiseNums:
type: integer
format: int32
description: 点赞数量
price:
type: integer
format: int32
description: 售价
relGoodIds:
type: array
items: {}
description: |-
ThisisListType
关联商品Id列表
schemeDepthImageUrl:
type: string
description: 深度图地址
schemeId:
type: string
description: 方案ID
schemeSized:
type: number
format: double
description: 面积
schemeSizedStr:
type: string
description: 面积
schemeStyle:
type: string
description: 风格
schemeStyleDesc:
type: string
description: 风格显示文本
schemeType:
type: string
description: 户型
schemeTypeDesc:
type: string
description: 户型显示文本
schemeVerion:
type: string
description: 方案版本号
schemeVrUrl:
type: string
description: 全景图链接地址
sourcePrice:
type: integer
format: int32
description: 源文件售价:0=免费,-1=不销售
statusDate:
type: string
description: 状态时间
statusReason:
type: string
description: 状态原因
tenantId:
type: string
description: tenantId租户id(兼容)
topSortCode:
type: integer
format: int64
description: 置顶排序序号(序号越大,越前)
userId:
type: string
description: 归属用户ID
userImageUrl:
type: string
description: 归属用户头像图片地址
userName:
type: string
description: 归属用户帐号
userNickName:
type: string
description: 归属用户名称
description: 商品方案表列表OutputDto
example:
msg: ''
code: 0
data:
recordCount: 0
pageSize: 0
result:
- isBuy: false
statusDate: ''
userImageUrl: ''
praiseNums: 0
schemeType: ''
statusReason: ''
price: 0
isBuySource: false
checkUserNickName: ''
id: ''
userNickName: ''
goodsName: ''
relGoodIds: []
modifyDate: ''
schemeSizedStr: ''
coverPageFileId: ''
lookNums: 0
goodsType: ''
goodsTypeDesc: ''
schemeStyleDesc: ''
favoriteNums: 0
organId: ''
isFavorite: false
schemeVerion: ''
schemeDepthImageUrl: ''
atlasId: ''
checkUserId: ''
orderNum: 0
schemeId: ''
schemeTypeDesc: ''
buyNums: 0
content: ''
sourcePrice: 0
isHotSell: 0
createDate: ''
atlasStatus: 0
creator: ''
schemeStyle: ''
hasSmartRoom: 0
coverPageUrl: ''
topSortCode: 0
checkDate: ''
goodsStatusDesc: ''
userName: ''
userId: ''
buyScores: 0
commentNums: 0
goodsStatus: ''
schemeVrUrl: ''
tenantId: ''
isPraise: false
pageIndex: 0
success: false
'401':
description: access_token 缺失或已过期 / missing or expired access_token
/api/v1/Goods/getHomePage:
post:
operationId: apiV1GoodsGetHomePage
summary: 获取商品方案
tags:
- Design Schemes
x-source-documentation: https://dev.3vjia.com/document?apiId=744249709870334034
x-documentation-category: 方案模块 / 方案岛
description: 获取商品方案
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
filterDesign:
type: boolean
description: 是否过滤design方案
pageIndex:
type: integer
format: int32
pageSize:
type: integer
format: int32
sorts:
type: array
items:
type: object
properties:
sortField:
type: string
description: 排序字段
sortType:
type: string
description: 排序类型
description: "This is List Type \n查询排序集合"
where:
type: object
properties:
activitiesName:
type: string
description: 相关活动关键字
atlasStatus:
type: integer
format: int32
description: 图谱状态,-1为删除,0为入库,1为上架或者发布,2为下架,不传则查询全部
begCreateDate:
type: string
description: 创建时间开始
begDelDate:
type: string
description: 删除时间开始
begSchemeSized:
type: number
format: double
description: 面积开始
begStatusDate:
type: string
description: 状态时间开始
categorys:
type: object
description: 类目数组
endCreateDate:
type: string
description: 创建时间结束
endDelDate:
type: string
description: 删除时间结束
endSchemeSized:
type: number
format: double
description: 面积结束
endStatusDate:
type: string
description: 状态时间结束
goodsMarketingType:
type: integer
format: int32
description: 方案类型:0-全屋空间案例库,1-营销活动套餐库,2-卫浴空间案例库,3-阳台空间案例库,4-全场景高端定制方案,5-卫浴个性空间案例库,6-淋浴房空间案例库
goodsName:
type: string
description: 名称
goodsStatus:
type: string
description: 商品状态empty:草稿checking:上架审核reject:上架驳回upShelves:上架offShelves:下架
goodsType:
type: string
description: 商品类型,scheme=全景方案,excellent=优秀方案
isActivities:
type: integer
format: int32
description: 是否查询企业活动投稿方案0:查看非投稿1:查看投稿null:查看全部
isHotSell:
type: integer
format: int32
description: 是否热销方案
isUpShelves:
type: integer
format: int32
description: 是否查询已上架方案0:查询未上架方案(包含上架、参与活动的方案)1:查询已上架方案(未上架、未参与活动的方案)null:查询全部
keyword:
type: string
description: 方案名称或者产品型号模糊搜索
marketTagIds:
type: array
items: {}
description: "This is List Type \n标签ID列表,用于总部空间库和门店自营库"
price:
type: integer
format: int32
description: 售价,0:免费,1:付费
productNo:
type: string
description: 产品型号
schemeId:
type: string
description: 3D方案id
schemeRoom:
type: string
description: 空间
schemeStyle:
type: string
description: 风格
schemeType:
type: string
description: 户型
tagId:
type: string
description: 标签ID
tagIdList:
type: array
items: {}
description: "This is List Type \n标签id集合"
userId:
type: string
description: 用户id
userName:
type: string
description: 设计师帐号,精确查询
description: "商品方案表SearchInputDto \n分页查询条件"
example:
filterDesign: false
pageSize: 0
pageIndex: 0
where:
schemeType: ''
tagId: ''
endCreateDate: ''
begCreateDate: ''
schemeId: ''
endDelDate: ''
endStatusDate: ''
price: 0
isHotSell: 0
schemeRoom: ''
keyword: ''
goodsName: ''
productNo: ''
categorys: ''
atlasStatus: 0
schemeStyle: ''
isUpShelves: 0
userName: ''
userId: ''
activitiesName: ''
goodsType: ''
begStatusDate: ''
isActivities: 0
goodsStatus: ''
goodsMarketingType: 0
marketTagIds: []
begDelDate: ''
tagIdList: []
sorts:
- sortType: ''
sortField: ''
responses:
'200':
description: 成功 / OK
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
description: 请求是否成功 / whether the call succeeded
code:
type: integer
description: 结果码 / result code (0 = success)
msg:
type: string
description: 提示信息 / message
data:
type: object
properties:
pageIndex:
type: integer
format: int32
pageSize:
type: integer
format: int32
recordCount:
type: integer
format: int32
result:
type: array
items:
type: object
properties:
associatedGoodId:
type: string
description: 关联的方案ID
atlasId:
type: string
description: 图谱ID
atlasStatus:
type: integer
format: int32
description: 图谱状态,-1为删除,0为入库,1为上架或者发布,2为下架,不传则查询全部
buyNums:
type: integer
format: int32
description: 购买数量
buyScores:
type: integer
format: int32
description: 购买分数
checkDate:
type: string
description: 方案审核时间
checkUserId:
type: string
description: 方案审核人用户id
checkUserNickName:
type: string
description: 方案审核人用户id
commentNums:
type: integer
format: int32
description: 评论数量
content:
type: string
description: 商品介绍
coverPageFileId:
type: string
description: 封面文件ID
coverPageUrl:
type: string
description: 封面地址
createDate:
type: string
description: 创建时间
creator:
type: string
description: 创建人
favoriteNums:
type: integer
format: int32
description: 收藏数量
goodsMarketingType:
type: integer
format: int32
description: 方案类型:0-全屋空间案例库,1-营销活动套餐库,2-卫浴空间案例库,3-阳台空间案例库,4-全场景高端定制方案,5-卫浴个性空间案例库,6-淋浴房空间案例库
goodsName:
type: string
description: 名称
goodsStatus:
type: string
description: 商品状态
goodsStatusDesc:
type: string
description: 商品状态显示文本
goodsType:
type: string
description: 商品类型
goodsTypeDesc:
type: string
description: 商品类型
hasSmartRoom:
type: integer
format: int32
description: 是否有智能样板间
id:
type: string
description: 商品ID
isBuy:
type: boolean
description: 是否购买(使用权)
isBuySource:
type: boolean
description: 是否已购买了源文件
isFavorite:
type: boolean
description: 是否已收藏:true=是false=否
isHotSell:
type: integer
format: int32
description: 是否热销方案1=热销(优秀方案)
isPraise:
type: boolean
description: 是否已点赞:true=是false=否
lookNums:
type: integer
format: int32
description: 浏览数量
modifyDate:
type: string
description: 最后修改时间(删除时间)
orderNum:
type: integer
format: int32
description: 九牧定制:下单量
organId:
type: string
description: 机构ID
praiseNums:
type: integer
format: int32
description: 点赞数量
price:
type: integer
format: int32
description: 售价
relGoodIds:
type: array
items: {}
description: "This is List Type \n关联商品Id列表"
schemeDepthImageUrl:
type: string
description: 深度图地址
schemeId:
type: string
description: 方案ID
schemeSized:
type: number
format: double
description: 面积
schemeSizedStr:
type: string
description: 面积
schemeStyle:
type: string
description: 风格
schemeStyleDesc:
type: string
description: 风格显示文本
schemeType:
type: string
description: 户型
schemeTypeDesc:
type: string
description: 户型显示文本
schemeVerion:
type: string
description: 方案版本号
schemeVrUrl:
type: string
description: 全景图链接地址
sourcePrice:
type: integer
format: int32
description: 源文件售价:0=免费,-1=不销售
statusDate:
type: string
description: 状态时间
statusReason:
type: string
description: 状态原因
tenantId:
type: string
description: tenantId租户id(兼容)
topSortCode:
type: integer
format: int64
description: 置顶排序序号(序号越大,越前)
userId:
type: string
description: 归属用户ID
userImageUrl:
type: string
description: 归属用户头像图片地址
userName:
type: string
description: 归属用户帐号
userNickName:
type: string
description: 归属用户名称
description: 商品方案表列表OutputDto
example:
msg: ''
code: 0
data:
recordCount: 0
pageSize: 0
result:
- isBuy: false
statusDate: ''
userImageUrl: ''
praiseNums: 0
schemeType: ''
associatedGoodId: ''
statusReason: ''
price: 0
isBuySource: false
checkUserNickName: ''
id: ''
userNickName: ''
goodsName: ''
relGoodIds: []
modifyDate: ''
schemeSizedStr: ''
coverPageFileId: ''
lookNums: 0
goodsType: ''
goodsTypeDesc: ''
schemeStyleDesc: ''
favoriteNums: 0
organId: ''
isFavorite: false
schemeVerion: ''
schemeDepthImageUrl: ''
atlasId: ''
checkUserId: ''
orderNum: 0
schemeId: ''
schemeTypeDesc: ''
buyNums: 0
content: ''
sourcePrice: 0
isHotSell: 0
createDate: ''
atlasStatus: 0
creator: ''
schemeStyle: ''
hasSmartRoom: 0
coverPageUrl: ''
topSortCode: 0
checkDate: ''
goodsStatusDesc: ''
userName: ''
userId: ''
buyScores: 0
commentNums: 0
goodsStatus: ''
schemeVrUrl: ''
tenantId: ''
isPraise: false
goodsMarketingType: 0
pageIndex: 0
success: false
'401':
description: access_token 缺失或已过期 / missing or expired access_token
/api/v1/Task/signInWithUserId:
post:
operationId: apiV1TaskSignInWithUserId
summary: 用户每日签到
tags:
- Dedicated Services
x-source-documentation: https://dev.3vjia.com/document?apiId=765944157884792858
x-documentation-category: 专属服务 / C00003518
description: 用户每日签到
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
userId:
type: string
description: 用户id
userName:
type: string
description: userName
example:
userName: ''
userId: ''
responses:
'200':
description: 成功 / OK
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
description: 请求是否成功 / whether the call succeeded
code:
type: integer
description: 结果码 / result code (0 = success)
msg:
type: string
description: 提示信息 / message
data:
type: object
properties:
EMPTY:
type: object
description: |-
$ref:com.swj.api.designisland.dto.Task.UserTaskExecuteResult
空对象
currentProgress:
type: integer
format: int32
description: 当前用户任务进度(例如已经审核通过8个方案)
empty:
type: object
description: |-
$ref:com.swj.api.designisland.dto.Task.UserTaskExecuteResult
空对象
endDate:
type: string
description: 活动结束时间
id:
type: string
description: 主键
linkUrl:
type: string
description: 活动点击跳转的URL地址
maxReach:
type: integer
format: int32
description: 最大达成次数(任务可获得积分奖励的最大次数)
progressGoal:
type: integer
format: int32
description: 达成任务完成目标的活动数量(如通过审核10个方案,一般默认是1,例如一次签到,浏览一次方案)
reachCount:
type: integer
format: int32
description: 当前用户已经达成任务次数
resetCycle:
type: string
description: 任务重置周期(DAY,WEEK,MONTH,YEAR,LONGTIME)
resultMessage:
type: string
description: 前端控制:任务执行后消息提示语(如:点赞成功,获得1积分)
score:
type: integer
format: int32
description: 任务获得的永久积分
sortIndex:
type: integer
format: int32
description: 排序序号(号码越大,越排前面)
startDate:
type: string
description: 活动开始时间
state:
type: string
description: 状态codenotStart=未开始,started=去完成,over=已结束,finish=已完成
stateName:
type: string
description: 状态名称notStart=未开始,started=去完成,over=已结束,finish=已完成
taskIcon:
type: string
description: 活动图标,样式名或者图标URL
taskIntro:
type: string
description: 活动简介
taskKey:
type: string
description: 活动KEY
taskName:
type: string
description: 活动名称
taskType:
type: integer
format: int32
description: 任务类型(1=日常任务,2=基本任务)
tempScore:
type: integer
format: int32
description: 任务获得的临时积分
totalScore:
type: integer
format: int32
description: 本次任务获得的总积分,大于0本次任务已达成,等于0任务未达成
example:
msg: ''
code: 0
data:
currentProgress: 0
tempScore: 0
endDate: ''
sortIndex: 0
taskKey: ''
taskIntro: ''
resultMessage: ''
totalScore: 0
empty: ''
score: 0
taskType: 0
stateName: ''
taskIcon: ''
reachCount: 0
linkUrl: ''
maxReach: 0
taskName: ''
id: ''
state: ''
resetCycle: ''
EMPTY: ''
startDate: ''
progressGoal: 0
success: false
'401':
description: access_token 缺失或已过期 / missing or expired access_token
/api/v1/accountbinding/bindAccount:
post:
operationId: apiV1AccountbindingBindAccount
summary: 账号绑定接口
tags:
- Accounts
x-source-documentation: https://dev.3vjia.com/document?apiId=454653867632689213
x-documentation-category: 账号模块 / 单点登录
description: 企业系统账号绑定三维家账号,回收站内的三维家账号无法绑定
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
outUserId:
type: string
description: 企业系统的用户ID,用于绑定或解绑三维家账号
examples:
- '123456'
userName:
type: string
description: 要绑定或解绑的三维家账号
examples:
- 3vj13800000000
required:
- outUserId
- userName
example:
outUserId: '123456'
userName: 3vj13800000000
responses:
'200':
description: 成功 / OK
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
description: 请求是否成功 / whether the call succeeded
code:
type: integer
description: 结果码 / result code (0 = success)
msg:
type: string
description: 提示信息 / message
data:
type: object
properties:
outUserId:
type: string
description: 企业系统的用户ID,与入参一致
examples:
- '123456'
userId:
type: string
description: 绑定的三维家用户ID
examples:
- '1000123456'
userName:
type: string
description: 绑定的三维家账号,与入参一致
examples:
- 3vj13800000000
example:
msg: ''
code: 0
data:
outUserId: '123456'
userName: 3vj13800000000
userId: '1000123456'
success: false
'401':
description: access_token 缺失或已过期 / missing or expired access_token
/api/v1/accountbinding/getAccountBindingRelation:
post:
operationId: apiV1AccountbindingGetAccountBindingRelation
summary: 获取账号绑定关系接口
tags:
- Accounts
x-source-documentation: https://dev.3vjia.com/document?apiId=454749021953654841
x-documentation-category: 账号模块 / 单点登录
description: 获取企业账号和三维家账号账号之间的绑定关系,当不需要过滤条件时,入参请传一个空字典,而非不传
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
outUserId:
type: string
description: 企业系统中绑定过三维家账号的用户ID
userName:
type: string
description: 三维家用户账号
example:
outUserId: ''
userName: ''
responses:
'200':
description: 成功 / OK
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
description: 请求是否成功 / whether the call succeeded
code:
type: integer
description: 结果码 / result code (0 = success)
msg:
type: string
description: 提示信息 / message
data:
type: object
properties:
createTime:
type: string
description: 绑定时间,格式yyyy-MM-ddHH:mm:ss
outUserId:
type: string
description: 企业系统的用户ID
userId:
type: string
description: 三维家用户ID
userName:
type: string
description: 三维家账号
example:
msg: ''
code: 0
data:
- outUserId: ''
userName: ''
userId: ''
createTime: ''
success: false
'401':
description: access_token 缺失或已过期 / missing or expired access_token
/api/v1/accountbinding/getCurrentAppBindingRelationPage:
post:
operationId: apiV1AccountbindingGetCurrentAppBindingRelationPage
summary: 分页获取账号绑定关系列表接口
tags:
- Accounts
x-source-documentation: https://dev.3vjia.com/document?apiId=617418915324252243
x-documentation-category: 账号模块 / 单点登录
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
pageIndex:
type: integer
format: int32
description: 页码
examples:
- '1'
default: '1'
pageSize:
type: integer
format: int32
description: 每页条数,最大支持500条
examples:
- '10'
default: '50'
example:
pageSize: 10
pageIndex: 1
responses:
'200':
description: 成功 / OK
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
description: 请求是否成功 / whether the call succeeded
code:
type: integer
description: 结果码 / result code (0 = success)
msg:
type: string
description: 提示信息 / message
data:
type: object
properties:
pageIndex:
type: integer
format: int32
description: 页码
pageSize:
type: integer
format: int32
description: 每页条数
recordCount:
type: integer
format: int32
description: 记录总数
result:
type: array
items:
type: object
properties:
appId:
type: string
createTime:
type: string
description: 绑定时间,格式yyyy-MM-ddHH:mm:ss
outUserId:
type: string
description: 企业系统的用户ID
userId:
type: string
description: 三维家用户ID
userName:
type: string
description: 三维家账号
description: 结果列表
example:
msg: ''
code: 0
data:
recordCount: 0
pageSize: 0
result:
- outUserId: ''
userName: ''
userId: ''
createTime: ''
appId: ''
pageIndex: 0
success: false
'401':
description: access_token 缺失或已过期 / missing or expired access_token
/api/v1/accountbinding/unBindAccount:
post:
operationId: apiV1AccountbindingUnBindAccount
summary: 账号解绑接口
tags:
- Accounts
x-source-documentation: https://dev.3vjia.com/document?apiId=454656043478220888
x-documentation-category: 账号模块 / 单点登录
description: 企业系统账号解绑三维家账号
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
outUserId:
type: string
description: 企业系统的用户ID,用于绑定或解绑三维家账号
examples:
- '123456'
userName:
type: string
description: 要绑定或解绑的三维家账号
examples:
- FC68EF65199AD915B91433373FD64BF0
example:
outUserId: '123456'
userName: FC68EF65199AD915B91433373FD64BF0
responses:
'200':
description: 成功 / OK
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
description: 请求是否成功 / whether the call succeeded
code:
type: integer
description: 结果码 / result code (0 = success)
msg:
type: string
description: 提示信息 / message
data:
type: object
example:
msg: ''
code: 0
data: ''
success: false
'401':
description: access_token 缺失或已过期 / missing or expired access_token
/api/v1/admin/schemeDelete:
post:
operationId: apiV1AdminSchemeDelete
summary: 批量删除方案接口
tags:
- Design Schemes
x-source-documentation: https://dev.3vjia.com/document?apiId=652912755690598420
x-documentation-category: 方案模块 / 方案管理
description: 注意:删除方案后,可通过【三维家工作台】-【方案管理】-【回收站】还原,删除超过3个月的方案数据将不可恢复,请谨慎操作!
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
schemeIds:
type: array
items: {}
description: 方案ID集合
required:
- schemeIds
example:
schemeIds: []
responses:
'200':
description: 成功 / OK
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
description: 请求是否成功 / whether the call succeeded
code:
type: integer
description: 结果码 / result code (0 = success)
msg:
type: string
description: 提示信息 / message
data:
type: object
example:
msg: ''
code: 0
data: false
success: false
'401':
description: access_token 缺失或已过期 / missing or expired access_token
/api/v1/ai/scheme/project/listByPage:
post:
operationId: apiV1AiSchemeProjectListByPage
summary: 查询方案秀方案列表接口
tags:
- Design Schemes
x-source-documentation: https://dev.3vjia.com/document?apiId=600736973753311288
x-documentation-category: 方案模块 / 方案秀
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
createUser:
type: string
description: 创建人ID(三维家用户)
pageIndex:
type: integer
format: int32
description: 当前页
pageSize:
type: integer
format: int32
description: 页大小
projectName:
type: string
description: 项目名称或ID
styleId:
type: string
description: 风格ID
enterpriseUserIds:
type: array
items: {}
description: 企业用户ID集合
example:
enterpriseUserIds: []
pageSize: 0
pageIndex: 0
styleId: ''
createUser: ''
projectName: ''
responses:
'200':
description: 成功 / OK
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
description: 请求是否成功 / whether the call succeeded
code:
type: integer
description: 结果码 / result code (0 = success)
msg:
type: string
description: 提示信息 / message
data:
type: object
properties:
recordCount:
type: integer
format: int32
description: 总记录数
result:
type: array
items:
type: object
properties:
auditStatus:
type: integer
format: int32
description: 审核状态
cityAndDistrict:
type: string
description: 市区
coverImage:
type: string
description: 主方案封面图
createDate:
type: string
format: date-time
description: 创建时间
createType:
type: integer
format: int32
description: 创建方式
createUser:
type: string
description: 创建人
errorId:
type: integer
format: int32
description: 错误信息ID
errorMsg:
type: string
description: 错误信息
isDelete:
type: integer
format: int32
description: 是否删除
isTenantPublic:
type: integer
format: int32
description: 是否全租户共享
layOutImage:
type: string
description: 户型图
layoutId:
type: integer
format: int32
description: 户型ID
layoutOrganType:
type: integer
format: int32
description: 设计规则户型分类
layoutRenderVersion:
type: integer
format: int32
description: 项目版本
lightDesignVersion:
type: integer
format: int32
description: 轻设计版本号
mobile:
type: string
description: 手机号
nickName:
type: string
description: 昵称
planId:
type: string
description: 方案ID
projectId:
type: integer
format: int32
description: 项目ID
projectName:
type: string
description: 项目名称
projectType:
type: integer
format: int32
description: 项目类型
publishState:
type: integer
format: int32
description: 发布状态
publishVersion:
type: integer
format: int32
description: 当前使用的发布版本
publishVersionId:
type: integer
format: int32
description: 当前使用的发布版本ID
ruleId:
type: integer
format: int32
description: 设计规则ID
schemeId:
type: string
description: 3D方案ID
status:
type: integer
format: int32
description: 项目状态
styleId:
type: string
description: 风格ID
styleName:
type: string
description: 风格名称
tenantId:
type: string
description: 租户ID
thumbnail:
type: string
description: 项目封面图
updateDate:
type: string
format: date-time
description: 更新时间
updateUser:
type: string
description: 更新人
vrExpMode:
type: string
description: 项目结果类型
vrStagePercentage:
type: string
description: 制作进度
zipCode:
type: string
description: 实拍码
example:
msg: ''
code: 0
data:
recordCount: 0
result:
- publishState: 0
vrStagePercentage: ''
zipCode: ''
updateDate: ''
lightDesignVersion: 0
projectType: 0
createType: 0
schemeId: ''
styleName: ''
cityAndDistrict: ''
publishVersionId: 0
styleId: ''
coverImage: ''
planId: ''
errorId: 0
ruleId: 0
createDate: ''
thumbnail: ''
publishVersion: 0
isDelete: 0
nickName: ''
mobile: ''
updateUser: ''
layoutId: 0
errorMsg: ''
isTenantPublic: 0
layOutImage: ''
layoutRenderVersion: 0
vrExpMode: ''
tenantId: ''
auditStatus: 0
createUser: ''
projectName: ''
projectId: 0
layoutOrganType: 0
status: 0
success: false
'401':
description: access_token 缺失或已过期 / missing or expired access_token
/api/v1/aiImage/createImage:
post:
operationId: apiV1AiImageCreateImage
summary: AI生图接口
tags:
- 3vjia AI
x-source-documentation: https://dev.3vjia.com/document?apiId=844311885481394218
x-documentation-category: 三维家AI / 图片生成
description: |-
该接口为异步接口,调用成功后会先返回任务信息,图片生成完成后可再通过异步任务查询接口获取最终结果。
当前支持以下模型:
- `ai_image_3_0`:(三维家)AI改图3.0
- `i_g_2_pro`:gemini-2.5-flash-image
- `i_g_3_pre`:gemini-3-pro-image-preview
- `i_g_31_pre`:gemini-3.1-flash-image-preview
- `i_o_1`:gpt-image-1
- `i_o_1_pro`:gpt-image-1.5
- `i_o_2`:gpt-image-2
- `i_d_4`:seedream-v4
- `i_d_4_pro`:seedream-v4.5
- `i_d_5_lite`:seedream-v5-lite
- `i_d_5_lite`:seedream-v5-lite
- `seedream-v5`:doubao-seedream-5-0-pro-260628
- `i_j_4`:jimeng-v4
- `i_b_1`:baidu
接口的详细对接说明查看:https://help.3vjia.com/doc/aigc-open/832612605813211232/844307490291204140
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
extImageUrls:
type: array
items: {}
description: 其他参考图片链接列表,支持普通图片 URL,也支持标准 data URL
extraParam:
type: object
description: 额外参数。size 支持:512、1K、2K、4K;aspectRatio 支持:1:1、1:4、1:8、2:3、3:2、3:4、4:1、4:3、4:5、5:4、8:1、9:16、16:9、21:9
imageNumber:
type: integer
format: int32
description: 出图张数,默认 1
imageUrl:
type: string
description: 初始图片链接,支持普通图片 URL,也支持标准 data URL
model:
type: string
description: 模型英文编码,支持:ai_image_3_0(AI改图3.0)、i_g_2_pro、i_g_3_pre、i_g_31_pre、i_o_1、i_o_1_pro、i_o_2、i_d_4、i_d_4_pro、i_d_5_lite、seedream-v5、i_j_4、i_b_1
prompt:
type: string
description: 用于生成图像的提示词,中英文均可输入
seed:
type: integer
format: int64
description: 相同的 seed 能让结果更稳定
required:
- model
- prompt
example:
seed: 0
imageNumber: 0
extraParam: ''
extImageUrls: []
imageUrl: ''
model: ''
prompt: ''
responses:
'200':
description: 成功 / OK
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
description: 请求是否成功 / whether the call succeeded
code:
type: integer
description: 结果码 / result code (0 = success)
msg:
type: string
description: 提示信息 / message
data:
type: object
properties:
consumeQuantity:
type: number
format: bigdecimal
description: 消耗创点数量
failure:
type: string
description: 失败原因
failureCode:
type: string
description: 错误码
imageUrl:
type: string
description: 图片地址
msg:
type: string
description: 任务状态描述
progress:
type: number
format: float
description: 进度, 当状态为RUNNING时有值, 取值范围[0, 1]之间
remainingPersonQuantity:
type: number
format: bigdecimal
description: 个人剩余数量
remainingShopQuantity:
type: number
format: bigdecimal
description: 门店剩余数量(共享情况下会返回)
remainingTenantQuantity:
type: number
format: bigdecimal
description: 租户剩余数量(共享情况下会返回)
status:
type: string
description: 任务状态. -1:未知或者任务不存在, 1:排队中, 2:生成中, 3:生成成功, 4:生成失败, 5:已取消
taskId:
type: string
description: 任务ID
recordTransactionId:
type: string
description: 创点消费流水号
example:
msg: ''
code: 0
data:
msg: ''
failureCode: ''
recordTransactionId: ''
remainingShopQuantity: 0
consumeQuantity: 0
remainingTenantQuantity: 0
remainingPersonQuantity: 0
failure: ''
imageUrl: ''
progress: 0
taskId: ''
status: ''
success: false
'401':
description: access_token 缺失或已过期 / missing or expired access_token
/api/v1/aiImage/render/createImage:
post:
operationId: apiV1AiImageRenderCreateImage
summary: AI渲染生图接口
tags:
- 3vjia AI
x-source-documentation: https://dev.3vjia.com/document?apiId=853284784322023452
x-documentation-category: 三维家AI / 图片生成
description: 该接口为异步接口,提交成功后返回任务信息,图片生成完成后可通过异步任务查询接口获取最终结果。
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
extra:
type: object
description: 额外参数,按任务类型透传给下游
examples:
- '{}'
initImage:
type: string
description: 漫反图 URL
prompt:
type: string
description: 出图语义
taskType:
type: string
description: 任务类型
required:
- initImage
- taskType
example:
initImage: ''
taskType: ''
extra: ''
prompt: ''
responses:
'200':
description: 成功 / OK
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
description: 请求是否成功 / whether the call succeeded
code:
type: integer
description: 结果码 / result code (0 = success)
msg:
type: string
description: 提示信息 / message
data:
type: object
properties:
consumeQuantity:
type: number
format: bigdecimal
description: 消耗创点数量
failure:
type: string
description: 失败原因
failureCode:
type: string
description: 错误码
imageUrl:
type: string
description: 图片地址
msg:
type: string
description: 任务状态描述
progress:
type: number
format: float
description: 进度, 当状态为RUNNING时有值, 取值范围[0, 1]之间
remainingPersonQuantity:
type: number
format: bigdecimal
description: 个人剩余数量
remainingShopQuantity:
type: number
format: bigdecimal
description: 门店剩余数量(共享情况下会返回)
remainingTenantQuantity:
type: number
format: bigdecimal
description: 租户剩余数量(共享情况下会返回)
status:
type: string
description: 任务状态. -1:未知或者任务不存在, 1:排队中, 2:生成中, 3:生成成功, 4:生成失败, 5:已取消
taskId:
type: string
description: 任务ID
recordTransactionId:
type: string
description: 创点消费流水号
example:
msg: ''
code: 0
data:
msg: ''
failureCode: ''
recordTransactionId: ''
remainingShopQuantity: 0
consumeQuantity: 0
remainingTenantQuantity: 0
remainingPersonQuantity: 0
failure: ''
imageUrl: ''
progress: 0
taskId: ''
status: ''
success: false
'401':
description: access_token 缺失或已过期 / missing or expired access_token
/api/v1/aiModel/create:
post:
operationId: apiV1AiModelCreate
summary: 提交AI生模任务
tags:
- 3vjia AI
x-source-documentation: https://dev.3vjia.com/document?apiId=882346505367887926
x-documentation-category: 三维家AI / 图生模
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
genModelMainImg:
type: boolean
description: 是否生成模型主图
genTopDownViewImage:
type: boolean
description: 是否生成正交俯视图
imageUrl:
type: string
description: 主图片地址;imageUrl和prompt至少传一个,同时传时优先使用imageUrl
intoDesign:
type: boolean
description: 是否入库;为true时materialConf必填
materialConf:
type: object
properties:
belongSource:
type: integer
format: int32
description: 素材来源。0-个人,1-门店,2-企业
categoryId:
type: integer
format: int64
description: 分类ID
materialName:
type: string
description: 入库素材名称
picHeight:
type: number
format: double
description: 入库素材高度,单位毫米
picLength:
type: number
format: double
description: 入库素材长度,单位毫米
picWidth:
type: number
format: double
description: 入库素材宽度,单位毫米
resetImagePath:
type: boolean
description: 是否将素材主图设置为白底图。默认为True
description: 入库素材参数,字段同3D云设计素材表
modelConf:
type: object
properties:
faceNum:
type: integer
format: int32
description: 模型面数。不填则走系统默认配置
rmbg:
type: boolean
description: 是否去除背景,默认是
seed:
type: integer
format: int32
description: 模型种子。不同种子生成的效果会不同。默认42
segment:
type: boolean
description: 是否在生模完成后进行部件拆分。目前由ModelSegmentScheduler处理,支持TRIPO_31、自研SWJ拆分
segmentModel:
type: string
description: 部件拆分模型。可选值:SWJ、TRIPO。不填且segment为true时,使用系统配置默认值
description: 模型参数
modelEnum:
type: string
description: 生模模型,modelEnum:生模模型枚举,当前支持以下取值: TRELLIS_2:对应创点中心模型 Trellis2,用于根据图片或文本生成 3D 模型。 TRIPO_31:对应创点中心模型 Tripo3D-3.1,modelConf.segment 不传或传 false 时使用。 TRIPO_31:当 modelConf.segment=true 时,对应创点中心模型 Tripo3D-3.1-seg,用于生成模型并进行部件拆分。 注意:Tripo3D-3.1 和 Tripo3D-3.1-seg 使用相同的 modelEnum=TRIPO_31,通过 modelConf.segment 参数区分
modelPriority:
type: integer
format: int32
description: 模型生成优先级,0到10,默认5
multiView:
type: array
items:
type: object
properties:
viewImageUrl:
type: string
description: 视角图片Url地址。支持jpg或png。单边分辨率小于5000且大于128。编码后大小不可超过8M
【如果是oss地址,建议对url加上resize参数再传】
viewType:
type: string
description: 视角类型
| 枚举值 | 说明 |
|---|---|
| LEFT | 左视图 |
| RIGHT | 右视图 |
| BACK | 后视图 |
| TOP | 顶视图(仅混元3.1版本支持) |
| BOTTOM | 底视图(仅混元3.1版本支持) |
| LEFT_FRONT | 左前45°视图(仅混元3.1版本支持) |
| RIGHT_FRONT | 右前45°视图(仅混元3.1版本支持) |
一室一厅两室一厅两室两厅三室一厅三室两厅四室两厅大平层多层别墅定制户型 houseTypeParam: type: object properties: area: type: number format: double description: 面积 bathroom: type: string description: 卫 buildingName: type: string description: 小区名称 city: type: string description: 市代码 dataUrl: type: string description: 户型数据 district: type: string description: 区代码 dwgUrl: type: string description: dwg文件路径 hall: type: string description: 厅 houseSchemeId: type: string description: 户型对应布局方案ID houseTypeName: type: string description: 名称 imageUrl: type: string description: 户型图url kitchen: type: string description: 厨 platLayoutId: type: string description: 平台库户型ID province: type: string description: 省代码 room: type: string description: 房 source: type: string description: 来源1户型库2上传CAD3上传临摹图 towards: type: string description: 朝向 description: "AI个人工作台户型创建类 \n户型信息" id: type: string description: 主键ID(若有则为编辑) installType: type: string description: 安装类型前装/后装/通用 isSample: type: integer format: int32 description: 样板间1是0否 layoutSchemeName: type: string description: 方案名称 orientation: type: string description: 户型朝向正东/正西/正南/正北/东南/西南/西北/东北 panoLink: type: string description: 全景链接 projectAddr: type: string description: 项目地址 projectId: type: string description: 布局项目ID(多方案originSchemeId) province: type: string description: 省代码 roomList: type: array items: type: object properties: area: type: number format: float description: 面积 layoutSchemeId: type: string description: 布局方案ID roomAlias: type: string description: 空间别名 roomName: type: string description: 空间名称 ruleId: type: string description: 套系ID seriesKgId: type: string description: 套系图谱ID templateId: type: string description: 布局模板ID uid: type: string description: 空间uid description: 布局方案空间表创建类 schemeType: type: string description: 方案类型seller|designer scoreData: type: string description: 评分数据链接 source: type: string description: 数据来源 svjSchemeId: type: string description: 3D方案ID totalPrice: type: number format: double description: 方案总价 example: isSample: 0 cpqRespId: '' scoreData: '' schemeType: '' city: '' coverImageUrl: '' customerInfo: qq: '' note: '' address: '' clientId: '' city: '' hwCustomerId: '' cityCode: '' provinceCode: '' sex: '' mobile: '' webSiteSource: '' cntactMan: '' buildingName: '' areaCode: '' province: '' district: '' email: '' source: '' content: '' floors: '' province: '' svjSchemeId: '' coverImage: '' projectAddr: '' id: '' designerId: '' orientation: '' houseType: '' houseTypeParam: dataUrl: '' city: '' hall: '' houseSchemeId: '' houseTypeName: '' source: '' towards: '' room: '' buildingName: '' province: '' district: '' imageUrl: '' platLayoutId: '' dwgUrl: '' kitchen: '' bathroom: '' contentUrl: '' installType: '' district: '' layoutSchemeName: '' designerOpenId: '' panoLink: '' projectId: '' roomList: - roomAlias: '' layoutSchemeId: '' templateId: '' seriesKgId: '' roomName: '' uid: '' ruleId: '' responses: '200': description: 成功 / OK content: application/json: schema: type: object properties: success: type: boolean description: 请求是否成功 / whether the call succeeded code: type: integer description: 结果码 / result code (0 = success) msg: type: string description: 提示信息 / message data: type: object example: msg: '' code: 0 data: '' success: false '401': description: access_token 缺失或已过期 / missing or expired access_token /api/v1/layoutSchemeFiles/listByPage: post: operationId: apiV1LayoutSchemeFilesListByPage summary: 分页查询布局方案附件信息 tags: - Light Design x-source-documentation: https://dev.3vjia.com/document?apiId=736154710528114759 x-documentation-category: 轻设计 description: 分页查询布局方案附件信息 requestBody: required: false content: application/json: schema: type: object properties: createDateEnd: type: string description: 创建时间结束日期 createDateStart: type: string description: 创建时间开始日期 createUser: type: string description: 创建人ID fileName: type: string description: '*附件名称' fileType: type: string description: 附件类型布局图:layoutImage彩屏图:colorScreen动线图:moveLine效果图:effectImage鸟瞰图:birdEyeImage全景图:panoramaImage fileUrl: type: string description: 附件链接 ids: type: array items: {} description: "This is List Type \nID" isDelete: type: integer format: int32 description: 删除1是0否 layoutSchemeId: type: string description: 布局方案ID orderBy: type: string description: 排序 pageIndex: type: integer format: int32 description: 页码 pageSize: type: integer format: int32 description: 页容量 updateDateEnd: type: string description: 更新时间结束日期 updateDateStart: type: string description: 更新时间开始日期 updateUser: type: string description: 更新人ID example: fileName: '' layoutSchemeId: '' isDelete: 0 orderBy: '' pageSize: 0 updateUser: '' createDateStart: '' pageIndex: 0 updateDateStart: '' updateDateEnd: '' ids: [] createUser: '' fileUrl: '' createDateEnd: '' fileType: '' responses: '200': description: 成功 / OK content: application/json: schema: type: object properties: success: type: boolean description: 请求是否成功 / whether the call succeeded code: type: integer description: 结果码 / result code (0 = success) msg: type: string description: 提示信息 / message data: type: object properties: pageIndex: type: integer format: int32 pageSize: type: integer format: int32 recordCount: type: integer format: int32 result: type: array items: type: object properties: createDate: type: string description: 创建时间 createUser: type: string description: 创建人ID fileDesc: type: string fileName: type: string description: '*附件名称' fileType: type: string description: 附件类型 fileUrl: type: string description: 附件链接 id: type: string description: ID isDelete: type: integer format: int32 description: 删除1是0否 layoutSchemeId: type: string description: 布局方案ID updateDate: type: string description: 更新时间 updateUser: type: string description: 更新人ID description: 布局方案附件信息表结果类 example: msg: '' code: 0 data: recordCount: 0 pageSize: 0 result: - fileName: '' updateDate: '' layoutSchemeId: '' isDelete: 0 updateUser: '' fileDesc: '' createUser: '' fileUrl: '' id: '' fileType: '' createDate: '' pageIndex: 0 success: false '401': description: access_token 缺失或已过期 / missing or expired access_token /api/v1/layoutSchemeViewEffects/listSchemeEffects: post: operationId: apiV1LayoutSchemeViewEffectsListSchemeEffects summary: |- 查询布局方案效果图 单次最多返回500条数据 默认更新时间正序(最先完成的排前) [用于海尔定期查询同步效果图] tags: - Dedicated Services x-source-documentation: https://dev.3vjia.com/document?apiId=776395114619748377 x-documentation-category: 专属服务 / C12635714 description: 查询布局方案效果图 单次最多返回500条数据 默认更新时间正序(最先完成的排前)[用于海尔定期查询同步效果图] requestBody: required: false content: application/json: schema: type: object properties: createDateEnd: type: string description: 结束时间 createDateStart: type: string description: 开始时间 layoutSchemeIdList: type: array items: {} description: "This is List Type \n布局方案ID列表(默认最大10个)" orderBy: type: string description: 排序 pageIndex: type: integer format: int32 description: 页码 pageSize: type: integer format: int32 description: 页容量 example: orderBy: '' pageSize: 0 layoutSchemeIdList: [] createDateStart: '' pageIndex: 0 createDateEnd: '' responses: '200': description: 成功 / OK content: application/json: schema: type: object properties: success: type: boolean description: 请求是否成功 / whether the call succeeded code: type: integer description: 结果码 / result code (0 = success) msg: type: string description: 提示信息 / message data: type: object properties: createDate: type: string description: 创建时间 imageUrl: type: string description: 效果图链接 isDelete: type: integer format: int32 description: 删除1是0否 layoutSchemeId: type: string description: 布局方案ID panoUrl: type: string description: 全景图链接 queueFlag: type: integer format: int32 description: 效果图类型0效果图1全景 queueId: type: string description: 效果图ID roomId: type: string description: 空间标识 roomName: type: string description: 空间名称 updateDate: type: string description: 更新时间 example: msg: '' code: 0 data: - queueId: '' updateDate: '' layoutSchemeId: '' isDelete: 0 roomId: '' roomName: '' queueFlag: 0 imageUrl: '' panoUrl: '' createDate: '' success: false '401': description: access_token 缺失或已过期 / missing or expired access_token /api/v1/layoutSchemeViewEffects/pageViewImage: post: operationId: apiV1LayoutSchemeViewEffectsPageViewImage summary: 分页查询布局视角效果图 tags: - Light Design x-source-documentation: https://dev.3vjia.com/document?apiId=744141336357261412 x-documentation-category: 轻设计 description: 分页查询布局视角效果图 requestBody: required: false content: application/json: schema: type: object properties: createDateEnd: type: string description: 创建时间结束日期 createDateStart: type: string description: 创建时间开始日期 createUser: type: string description: 创建人ID ids: type: array items: {} description: "This is List Type \n主键ID" isDelete: type: integer format: int32 description: 删除1是0否 layoutSchemeId: type: string description: 布局方案ID orderBy: type: string description: 排序 pageIndex: type: integer format: int32 description: 页码 pageSize: type: integer format: int32 description: 页容量 queueFlag: type: integer format: int32 description: 效果图类型0效果图1全景 queueId: type: string description: 效果图ID roomId: type: string description: 空间标识 roomName: type: string description: 空间名称 updateDateEnd: type: string description: 更新时间结束日期 updateDateStart: type: string description: 更新时间开始日期 updateUser: type: string description: 更新人ID viewAngleData: type: string description: 视角数据 viewAngleId: type: string description: 视角ID viewAngleIdList: type: array items: {} description: "This is List Type \n视角ID列表" viewAngleName: type: string description: 视角名称 example: queueId: '' layoutSchemeId: '' isDelete: 0 viewAngleData: '' orderBy: '' pageSize: 0 updateUser: '' roomId: '' roomName: '' viewAngleIdList: [] viewAngleId: '' createDateStart: '' pageIndex: 0 queueFlag: 0 updateDateStart: '' updateDateEnd: '' ids: [] createUser: '' viewAngleName: '' createDateEnd: '' responses: '200': description: 成功 / OK content: application/json: schema: type: object properties: success: type: boolean description: 请求是否成功 / whether the call succeeded code: type: integer description: 结果码 / result code (0 = success) msg: type: string description: 提示信息 / message data: type: object properties: pageIndex: type: integer format: int32 description: 页码 pageSize: type: integer format: int32 description: 页容量 recordCount: type: integer format: int32 description: 记录数 result: type: array items: type: object properties: createDate: type: string description: 创建时间 createUser: type: string description: 创建人ID id: type: string description: 主键ID imageUrl: type: string description: 效果图链接 isDelete: type: integer format: int32 description: 删除1是0否 layoutSchemeId: type: string description: 布局方案ID queueFlag: type: integer format: int32 description: 效果图类型0效果图1全景 queueId: type: string description: 效果图ID roomId: type: string description: 空间标识 roomName: type: string description: 空间名称 tenantId: type: string description: 租户ID updateDate: type: string description: 更新时间 updateUser: type: string description: 更新人ID viewAngleId: type: string description: 视角ID viewAngleName: type: string description: 视角名称 description: 布局视角与效果图结果 example: msg: '' code: 0 data: recordCount: 0 pageSize: 0 result: - queueId: '' updateDate: '' layoutSchemeId: '' isDelete: 0 updateUser: '' roomId: '' roomName: '' viewAngleId: '' queueFlag: 0 imageUrl: '' tenantId: '' createUser: '' id: '' viewAngleName: '' createDate: '' pageIndex: 0 success: false '401': description: access_token 缺失或已过期 / missing or expired access_token /api/v1/line/oss/getUploadToken: post: operationId: apiV1LineOssGetUploadToken summary: 获取线条上传签名接口 tags: - Products x-source-documentation: https://dev.3vjia.com/document?apiId=644937818719805452 x-documentation-category: 产品模块 / 线条上传 description: 注意:上传CAD文件不超过1M,支持格式 dwg、dxf requestBody: required: false content: application/json: schema: type: object properties: context: type: object description: 文件名变量 examples: - '{"fileName":"d2xidz2jifsotegzzrvnahhaxck5y6aw"}' fileSuffix: type: string description: 上传的文件后缀,不带'.',支持格式 dwg、dxf example: fileSuffix: '' context: '' responses: '200': description: 成功 / OK content: application/json: schema: type: object properties: success: type: boolean description: 请求是否成功 / whether the call succeeded code: type: integer description: 结果码 / result code (0 = success) msg: type: string description: 提示信息 / message data: type: object properties: accessKeyId: type: string description: 访问密钥标识 contentType: type: string description: 华为云和腾讯云都要把 Content-Type 作为表单字段返回(非空的时候带过去,或者指定 prefix 的时候要自己生成并带过去) contentTypePrefix: type: string description: 内容类型前缀 expireAt: type: integer format: int64 description: 签名过期10位秒级时间戳 expireTime: type: string format: date-time description: 签名过期时间 formFields: type: object description: 表单字段,用于前端直传时的表单字段填充(这里只考虑用户元数据相关的认证信息) key: type: string description: 约束上传的key ossHost: type: string description: 需要上传到哪个OSS上,值为OSS地址或者CDN域名 policy: type: string description: 签名上传的约束策略,比如大小、前缀等 readDomain: type: string description: 对于公共读bucket,该值用于拼接完整域名 securityToken: type: string description: 安全令牌(当基于STS或者IAM生成签名时前端的表单必须同时携带该参数) signature: type: string description: 签名 vendor: type: string description: 本次生成签名对应的厂商 required: - expireTime - vendor example: msg: '' code: 0 data: accessKeyId: '' signature: '' contentTypePrefix: '' expireAt: 0 ossHost: '' securityToken: '' expireTime: '' readDomain: '' vendor: '' formFields: '' contentType: '' key: '' policy: '' success: false '401': description: access_token 缺失或已过期 / missing or expired access_token /api/v1/manufacturing/confirmDisOrder: post: operationId: apiV1ManufacturingConfirmDisOrder summary: 订单拆单确认接口 tags: - MOS x-source-documentation: https://dev.3vjia.com/document?apiId=474669617277665340 x-documentation-category: MOS系统 / 订单管理 requestBody: required: false content: application/json: schema: type: object properties: orderNo: type: string description: 订单号,订单ID、订单号至少传1项,当orderRecordId为空时,orderNo有效 examples: - 63CG19120402 orderRecordId: type: string description: 订单ID,店铺订单、工厂订单通用,同一订单的店铺订单、工厂订单的ID一致,订单ID、订单号至少传1项,当orderRecordId不为空时,将忽略orderNo examples: - F053521B72F34613BEAD2CC8B6279E75 outUserId: type: string description: 操作人-企业账号绑定时使用的企业用户ID,userId、userName、outUserId三个中,outUserId优先级第三 examples: - '123456' userId: type: string description: 操作人-三维家用户ID,userId、userName、outUserId三个中,userId优先级最高 examples: - '1000122456' userName: type: string description: 操作人-三维家账号,userId、userName、outUserId三个中,userName优先级第二 examples: - 3vj123456 example: orderNo: 63CG19120402 outUserId: '123456' userName: 3vj123456 userId: '1000122456' orderRecordId: F053521B72F34613BEAD2CC8B6279E75 responses: '200': description: 成功 / OK content: application/json: schema: type: object properties: success: type: boolean description: 请求是否成功 / whether the call succeeded code: type: integer description: 结果码 / result code (0 = success) msg: type: string description: 提示信息 / message data: type: object example: msg: 成功 code: 0 data: true success: true '401': description: access_token 缺失或已过期 / missing or expired access_token /api/v1/manufacturing/createOrderBatch: post: operationId: apiV1ManufacturingCreateOrderBatch summary: 生成批次接口 tags: - MOS x-source-documentation: https://dev.3vjia.com/document?apiId=474672016889319474 x-documentation-category: MOS系统 / 生产批次 description: 指定订单进行生成批次 requestBody: required: false content: application/json: schema: type: object properties: operatorOutUserId: type: string description: 操作生成批次的企业系统用户ID(需绑定过三维家账号),operatorUserId、operatorUserName、operatorOutUserId三项至少传一项,当operatorUserId、operatorUserName为空时,operatorOutUserId有效 operatorUserId: type: string description: 操作生成批次的三维家用户ID,operatorUserId、operatorUserName、operatorOutUserId三项至少传一项,若传了operatorUserId,当忽略operatorUserName、operatorOutUserId字段 operatorUserName: type: string description: 操作生成批次的三维家账号,operatorUserId、operatorUserName、operatorOutUserId三项至少传一项,当operatorUserId为空时,operatorUserName有效,传了operatorUserName将忽略operatorOutUserId字段 orderNoList: type: array items: {} description: 要生成批次的订单号列表,外协订单无法使用此字段,orderRecordIdList和orderNoList至少传一项,当orderRecordIdList为空时,此字段有效 orderRecordIdList: type: array items: {} description: 要生成批次的订单ID列表,orderRecordIdList和orderNoList至少传一项,当orderRecordIdList有值时会忽略orderNoList example: operatorOutUserId: '' operatorUserId: '' orderRecordIdList: [] operatorUserName: '' orderNoList: [] responses: '200': description: 成功 / OK content: application/json: schema: type: object properties: success: type: boolean description: 请求是否成功 / whether the call succeeded code: type: integer description: 结果码 / result code (0 = success) msg: type: string description: 提示信息 / message data: type: object example: msg: 成功 code: 0 data: xxx success: true '401': description: access_token 缺失或已过期 / missing or expired access_token /api/v1/manufacturing/getBatchOrderList: post: operationId: apiV1ManufacturingGetBatchOrderList summary: 获取已生成批次订单列表接口 tags: - MOS x-source-documentation: https://dev.3vjia.com/document?apiId=475027993060782088 x-documentation-category: MOS系统 / 生产批次 requestBody: required: false content: application/json: schema: type: object properties: batchNo: type: string description: 批次号,batchNo和createBatchBeginTime不能同时为空 examples: - 63-191210-235 createBatchBeginTime: type: string description: 创建批次开始时间,格式yyyy-MM-ddHH:mm:ss,createBatchBeginTime和batchNo不能同时为空,createBatchBeginTime和createBatchEndTime时间差不能超过7天 examples: - '2020-05-01 00:00:00' createBatchEndTime: type: string description: 创建批次结束时间,格式yyyy-MM-ddHH:mm:ss,当createBatchBeginTime有值时,有默认值为当前时间 examples: - '2020-05-07 00:00:00' example: batchNo: 63-191210-235 createBatchEndTime: '2020-05-07 00:00:00' createBatchBeginTime: '2020-05-01 00:00:00' responses: '200': description: 成功 / OK content: application/json: schema: type: object properties: success: type: boolean description: 请求是否成功 / whether the call succeeded code: type: integer description: 结果码 / result code (0 = success) msg: type: string description: 提示信息 / message data: type: object properties: batchDate: type: string description: 生成批次的时间,格式yyyy-MM-ddHH:mm:ss batchNo: type: string description: 批次号 consigneeAddress: type: string description: 收货地址 contactName: type: string description: 联系人 contactWay: type: string description: 联系方式 createBatchUser: type: object properties: avatar: type: string description: 设计师头像 mobile: type: string description: 手机号码 name: type: string description: 姓名 nickName: type: string description: 昵称 outUserId: type: string description: 账号绑定的企业系统用户ID userId: type: string description: 三维家用户ID userName: type: string description: 三维家账号 description: 操作用户 customer: type: object properties: customerAddress: type: string description: 客户地址 customerCode: type: string description: 客户编码 customerId: type: string description: 客户ID customerMobile: type: string description: 客户手机 customerName: type: string description: 客户名称 description: 客户信息 deliveryDate: type: string description: 发货日期,格式yyyy-MM-dd diyOrderNo: type: string description: 自定义订单号 factoryOrgan: type: object properties: organId: type: string description: 企业ID organName: type: string description: 企业名称 description: 部门所属机构信息 mainColor: type: string description: 主材颜色 orderName: type: string description: 订单名称 orderNo: type: string description: 订单号 orderRecordId: type: string description: 订单ID orderType: type: string description: 订单类型(衣柜、橱柜、系统柜...) orderVersion: type: string description: 订单版本号 partVersion: type: string description: 拆单版本号 remark: type: string description: 备注 shopDept: type: object properties: customerCode: type: string description: 部门对应客户部门编码 deptId: type: string description: 部门ID deptName: type: string description: 部门名称 outDeptId: type: string description: 部门所绑定企业系统部门ID,绑定过才有值 storeType: type: integer format: int32 description: 类型0=门店,1=部门 description: 上级部门信息 shopOrgan: type: object properties: organId: type: string description: 企业ID organName: type: string description: 企业名称 description: 部门所属机构信息 example: msg: '' code: 0 data: - orderType: '' batchNo: '' shopOrgan: organName: '' organId: '' orderNo: '' contactName: '' batchDate: '' remark: '' orderVersion: '' factoryOrgan: organName: '' organId: '' diyOrderNo: '' orderRecordId: '' partVersion: '' mainColor: '' shopDept: deptName: '' storeType: 0 deptId: '' customerCode: '' outDeptId: '' contactWay: '' deliveryDate: '' createBatchUser: nickName: '' mobile: '' avatar: '' outUserId: '' userName: '' userId: '' name: '' consigneeAddress: '' customer: customerAddress: '' customerCode: '' customerName: '' customerId: '' customerMobile: '' orderName: '' success: false '401': description: access_token 缺失或已过期 / missing or expired access_token /api/v1/manufacturing/getBatchProductionXml: post: operationId: apiV1ManufacturingGetBatchProductionXml summary: 获取批次拆单XML接口 tags: - MOS x-source-documentation: https://dev.3vjia.com/document?apiId=475021823252181021 x-documentation-category: MOS系统 / 生产批次 description: 获取批次拆单XML requestBody: required: false content: application/json: schema: type: object properties: batchNo: type: string description: 批次号 examples: - 22-161013-01 example: batchNo: 22-161013-01 responses: '200': description: 成功 / OK content: application/json: schema: type: object properties: success: type: boolean description: 请求是否成功 / whether the call succeeded code: type: integer description: 结果码 / result code (0 = success) msg: type: string description: 提示信息 / message data: type: object properties: batchNo: type: string description: 批次号 batchXmlContent: type: string description: 批次拆单xml的Base64字符串 createTime: type: string description: 创建批次时间,格式yyyy-MM-ddHH:mm:ss createUser: type: object properties: avatar: type: string description: 设计师头像 mobile: type: string description: 手机号码 name: type: string description: 姓名 nickName: type: string description: 昵称 outUserId: type: string description: 账号绑定的企业系统用户ID userId: type: string description: 三维家用户ID userName: type: string description: 三维家账号 description: 操作用户 orderList: type: array items: type: object properties: diyOrderNo: type: string description: 自定义订单号 orderName: type: string description: 订单名称 orderNo: type: string description: 订单编号 orderRecordId: type: string description: 订单的通用ID,同一订单下店铺订单、工厂订单此值是相同的 description: 通用的生产订单结构 recordId: type: string description: 批次ID example: msg: '' code: 0 data: batchNo: '' orderList: - orderNo: '' diyOrderNo: '' orderRecordId: '' orderName: '' batchXmlContent: '' recordId: '' createTime: '' createUser: nickName: '' mobile: '' avatar: '' outUserId: '' userName: '' userId: '' name: '' success: false '401': description: access_token 缺失或已过期 / missing or expired access_token /api/v1/manufacturing/getFactorySupplementOrderListByPage: post: operationId: apiV1ManufacturingGetFactorySupplementOrderListByPage summary: 获取工厂补单列表接口 tags: - MOS x-source-documentation: https://dev.3vjia.com/document?apiId=475006971230105648 x-documentation-category: MOS系统 / 订单数据 description: 分页获取门店补单列表 requestBody: required: false content: application/json: schema: type: object properties: createBeginTime: type: string description: 订单创建开始时间,格式yyyy-MM-ddHH:mm:ss createEndTime: type: string description: 订单创建结束时间,格式yyyy-MM-ddHH:mm:ss,当createBeginTime有值时,此值有默认值为当前时间 customerInfo: type: string description: 客户信息 orderNo: type: string description: 补单号 pageIndex: type: integer format: int32 description: 页码,最小值为1,默认值为1 pageSize: type: integer format: int32 description: 分页大小,最小值1,最大值500,默认值50 example: createBeginTime: '' orderNo: '' customerInfo: '' pageSize: 0 pageIndex: 0 createEndTime: '' responses: '200': description: 成功 / OK content: application/json: schema: type: object properties: success: type: boolean description: 请求是否成功 / whether the call succeeded code: type: integer description: 结果码 / result code (0 = success) msg: type: string description: 提示信息 / message data: type: object properties: pageIndex: type: integer format: int32 pageSize: type: integer format: int32 recordCount: type: integer format: int32 result: type: array items: type: object properties: createTime: type: string description: 订单创建开始时间,格式yyyy-MM-ddHH:mm:ss createUser: type: string description: 创建订单用户 factoryStateName: type: string description: 工厂订单状态名称 factoryStatus: type: string description: 工厂订单状态值 orderName: type: string description: 补单名称 orderNo: type: string description: 补单编号 recordId: type: string description: 补单ID shopStateName: type: string description: 门店订单状态名称 shopStatus: type: string description: 门店订单状态值 description: 获取补单信息返参 example: msg: '' code: 0 data: recordCount: 0 pageSize: 0 result: - orderNo: '' factoryStateName: '' shopStateName: '' factoryStatus: '' recordId: '' shopStatus: '' createTime: '' createUser: '' orderName: '' pageIndex: 0 success: false '401': description: access_token 缺失或已过期 / missing or expired access_token /api/v1/manufacturing/getManufacturingOrderPartList: post: operationId: apiV1ManufacturingGetManufacturingOrderPartList summary: 获取订单部件列表接口 tags: - MOS x-source-documentation: https://dev.3vjia.com/document?apiId=474672016889319472 x-documentation-category: MOS系统 / 订单数据 description: 获取订单部件列表,可以按照订单ID、订单号 requestBody: required: false content: application/json: schema: type: object properties: orderNo: type: string description: 订单号,订单ID、订单号至少传1项,当orderRecordId为空时,orderNo有效,外协订单无法使用orderNo查询 examples: - 63CG19120402 orderRecordId: type: string description: 订单ID,店铺订单、工厂订单通用,同一订单的店铺订单、工厂订单的ID一致,订单ID、订单号至少传1项,当orderRecordId不为空时,将忽略orderNo examples: - F053521B72F34613BEAD2CC8B6279E75 example: orderNo: 63CG19120402 orderRecordId: F053521B72F34613BEAD2CC8B6279E75 responses: '200': description: 成功 / OK content: application/json: schema: type: object properties: success: type: boolean description: 请求是否成功 / whether the call succeeded code: type: integer description: 结果码 / result code (0 = success) msg: type: string description: 提示信息 / message data: type: object properties: createUser: type: object properties: avatar: type: string description: 设计师头像 mobile: type: string description: 手机号码 name: type: string description: 姓名 nickName: type: string description: 昵称 outUserId: type: string description: 账号绑定的企业系统用户ID userId: type: string description: 三维家用户ID userName: type: string description: 三维家账号 description: 操作用户 diyOrderNo: type: string description: 自定义订单号 orderName: type: string description: 订单名称 orderNo: type: string description: 订单编号 orderPartList: type: array items: type: object properties: actualLength: type: object actualWidth: type: object barcode: type: string description: 条码,板件或门板才有值 basicMaterial: type: string description: 板件基材 cabinetName: type: string description: 所属柜子名称 cabinetNo: type: string description: 柜体编号 cabinetPanelNo: type: string description: 部件在柜子内的编号,板件、门板才有值 category: type: string description: 部件类型,Board=板件,Door=门板,Metal=五金 craftMark: type: string description: 工艺备注 doorDirection: type: string description: 门板的开门方向 hasHorizontalHole: type: string description: 是否打孔0=不打孔1=打孔 isAccurate: type: string description: 是否异形,1=异形0=常规 length: type: object material: type: string description: 板件材质 num: type: integer format: int32 description: 数量,五金才有值 partId: type: string description: 部件ID,此字段每次请求时值都可能产生变化,建议每次调接口前先清除订单的历史数据 partName: type: string description: 部件名称 partNumber: type: string description: 部件编码 pkgNo: type: string description: 包号 roomName: type: string description: 所属空间名称 series: type: string description: 系列 spec: type: string description: 规格,五金才有值 standardCategory: type: string description: 板件标准生成类型(判别五金安装用) thickness: type: object unit: type: string description: 单位,五金才有值 width: type: object description: 部件结构 orderRecordId: type: string description: 订单的通用ID,同一订单下店铺订单、工厂订单此值是相同的 example: msg: '' code: 0 data: orderPartList: - craftMark: '' partId: '' thickness: '' num: 0 basicMaterial: '' partName: '' spec: '' doorDirection: '' isAccurate: '' barcode: '' actualLength: '' cabinetName: '' actualWidth: '' length: '' cabinetPanelNo: '' roomName: '' cabinetNo: '' pkgNo: '' hasHorizontalHole: '' unit: '' material: '' series: '' width: '' standardCategory: '' partNumber: '' category: '' orderNo: '' diyOrderNo: '' orderRecordId: '' createUser: nickName: '' mobile: '' avatar: '' outUserId: '' userName: '' userId: '' name: '' orderName: '' success: false '401': description: access_token 缺失或已过期 / missing or expired access_token /api/v1/manufacturing/getOrder: post: operationId: apiV1ManufacturingGetOrder summary: 获取订单信息接口 tags: - MOS x-source-documentation: https://dev.3vjia.com/document?apiId=474639795637813299 x-documentation-category: MOS系统 / 订单数据 description: 根据订单ID或订单号获取订单信息,使用订单号时不支持外协订单 requestBody: required: false content: application/json: schema: type: object properties: orderNo: type: string description: 订单编号,orderRecordId和orderNo至少传一个,orderRecordId为空时orderNo有效,外协订单不支持使用订单号查询 examples: - EMS-63CG19120402 orderRecordId: type: string description: 订单的通用ID,同一订单下店铺订单、工厂订单此值是相同的,orderRecordId和orderNo至少传一个,传了orderRecordId将忽略orderNo examples: - F053521B72F34613BEAD2CC8B6279E75 example: orderNo: EMS-63CG19120402 orderRecordId: F053521B72F34613BEAD2CC8B6279E75 responses: '200': description: 成功 / OK content: application/json: schema: type: object properties: success: type: boolean description: 请求是否成功 / whether the call succeeded code: type: integer description: 结果码 / result code (0 = success) msg: type: string description: 提示信息 / message data: type: object properties: batchNo: type: string description: 批次号 cause: type: string description: 补单/售后原因 city: type: string description: 市 color: type: string description: 主材颜色(橡木、白枫....) colorRecordId: type: string description: 主材颜色(橡木、白枫....)的Id colorSeries: type: string description: 颜色系列 consigneeAddress: type: string description: 收货地址 contactRealName: type: string description: 联系人 contactWay: type: string description: 联系方式 contractCategory: type: string description: 丽博-合同类别 contractCategoryName: type: string description: 丽博-合同类别名称 createTime: type: string description: 创建订单时间,格式yyyy-MM-ddHH:mm:ss createUser: type: object properties: avatar: type: string description: 设计师头像 mobile: type: string description: 手机号码 name: type: string description: 姓名 nickName: type: string description: 昵称 outUserId: type: string description: 账号绑定的企业系统用户ID userId: type: string description: 三维家用户ID userName: type: string description: 三维家账号 description: 操作用户 customer: type: object properties: customerAddress: type: string description: 客户地址 customerCode: type: string description: 客户编码 customerId: type: string description: 客户ID customerMobile: type: string description: 客户手机 customerName: type: string description: 客户名称 description: 客户信息 deliveryTime: type: string description: 生产发货时间,格式yyyy-MM-ddHH:mm:ss disOrderId: type: string description: 订单方案主键ID district: type: string description: 区 diyOrderNo: type: string description: 自定义订单号 expand1: type: string expand2: type: string expand3Name: type: string description: 拓展字段4 expand4Name: type: string description: 拓展字段4 houseType: type: string description: 楼盘户型 isOnlyFile: type: string description: 只有附件的订单0-否1-是,只有附件的订单没有3D文件 isWaiXie: type: string description: 是否外协订单标识,1=是,0=否,空=未设置,仅个别企业可以使用. itemNo: type: string description: 项目号 orderCateCode: type: string description: 订单类别(常规单、样品单、材料单....)的代码 orderCateName: type: string description: 订单类别(常规单、样品单、材料单....) orderCategory: type: string description: 丽博-订单类别 orderCategoryName: type: string description: 丽博-订单类别名称 orderCount: type: string description: 工程单数量 orderCoverImage: type: string description: 订单主图URL orderName: type: string description: 订单名称 orderNature: type: string description: 丽博-订单性质 orderNatureName: type: string description: 丽博-订单性质名称 orderNo: type: string description: 订单编号 orderRecordId: type: string description: 订单的通用ID,同一订单下店铺订单、工厂订单此值是相同的 orderSeries: type: string description: 产品系列 orderSeriesName: type: string description: 丽博-订单系列名称 orderSquare: type: string description: 订单用量 orderTypeCode: type: string description: 订单类型code(YG,CG,XTG....) orderTypeId: type: string description: 订单类型(衣柜,橱柜,系统柜....)的ID orderTypeName: type: string description: 订单类型(衣柜,橱柜,系统柜....) packNum: type: string description: 订单包数 planDeliveryDate: type: string description: 计划交货日期,格式yyyy-MM-ddHH:mm:ss planSetupTime: type: string description: 预约安装时间,格式yyyy-MM-ddHH:mm:ss platformOrderId: type: string description: 工厂订单的ID,如果需要单点登录到三维家订单系统工厂订单详情页时,使用此字段 platformOrderStateCode: type: string description: 工厂订单状态的代码 platformOrderStateName: type: string description: 工厂订单状态 productNature: type: string description: 丽博-产品性质 productNatureName: type: string description: 丽博-产品性质名称 productTypeCode: type: string description: 产品类型代码(Board=板式,Wood=实木,MoveDoor=移门,CloseDoor掩门) productTypeName: type: string description: 产品类型(板式,实木,移门,掩门) promotionCode: type: string description: 丽博-促销方案编码 province: type: string description: 省 remark: type: string description: 备注 saleMoney: type: object examples: - '2000.00' scheme: type: object properties: createTime: type: string description: 方案创建时间,格式yyyy-MM-ddHH:mm:ss imagePath: type: string description: 方案主图路径 modifyTime: type: string description: 方案最后修改时间,格式yyyy-MM-ddHH:mm:ss schemeId: type: string description: 方案ID schemeName: type: string description: 方案名称 totalArea: type: number format: double description: 方案总面积 description: 订单所关联的方案,从3D创建的订单此字段有值 shopDept: type: object properties: customerCode: type: string description: 部门对应客户部门编码 deptId: type: string description: 部门ID deptName: type: string description: 部门名称 outDeptId: type: string description: 部门所绑定企业系统部门ID,绑定过才有值 storeType: type: integer format: int32 description: 类型0=门店,1=部门 description: 上级部门信息 shopOrderId: type: string description: 店铺订单的ID,如果需要单点登录到三维家订单系统店铺订单详情页时,使用此字段 shopOrderStateCode: type: string description: 店铺订单状态的代码 shopOrderStateName: type: string description: 店铺订单状态 shopOrgan: type: object properties: organId: type: string description: 企业ID organName: type: string description: 企业名称 description: 部门所属机构信息 signOrgan: type: object properties: organId: type: string description: 企业ID organName: type: string description: 企业名称 description: 部门所属机构信息 signTime: type: string description: 签收时间,格式yyyy-MM-ddHH:mm:ss signUser: type: object properties: avatar: type: string description: 设计师头像 mobile: type: string description: 手机号码 name: type: string description: 姓名 nickName: type: string description: 昵称 outUserId: type: string description: 账号绑定的企业系统用户ID userId: type: string description: 三维家用户ID userName: type: string description: 三维家账号 description: 操作用户 spart: type: string description: 新岩素定制-产品组分类id spartName: type: string description: 新岩素定制-产品组分类名称 spatialName: type: string description: 空间信息 submitTime: type: string description: 提交订单时间,格式yyyy-MM-ddHH:mm:ss submitUser: type: object properties: avatar: type: string description: 设计师头像 mobile: type: string description: 手机号码 name: type: string description: 姓名 nickName: type: string description: 昵称 outUserId: type: string description: 账号绑定的企业系统用户ID userId: type: string description: 三维家用户ID userName: type: string description: 三维家账号 description: 操作用户 thirdOrderInfo: type: string description: 第三方下单数据 urgent: type: string description: 加急等级 urgentRecordId: type: string description: 加急等级代码,0=普通,1=加急 urlParameter: type: string description: 3D下单带过来的业务参数 vkbur: type: string description: 新岩素定制-销售办事处分类id vkburName: type: string description: 新岩素定制-销售办事处分类名称 vkgrp: type: string description: 新岩素定制-销售组分类id vkgrpName: type: string description: 新岩素定制-销售组分类名称 vkorg: type: string description: 新岩素定制-销售组织分类id vkorgName: type: string description: 新岩素定制-销售组织分类名称 vtweg: type: string description: 新岩素定制-分销渠道分类id vtwegName: type: string description: 新岩素定制-分销渠道分类名称 vuart: type: string description: 新岩素定制-SAP订单类型分类id vuartName: type: string description: 新岩素定制-SAP订单类型分类名称 example: msg: 用户不存在 code: 500001 data: orderTypeCode: '' shopOrgan: organName: '' organId: '' orderNature: '' itemNo: '' vkburName: '' orderSquare: '' planSetupTime: '' colorSeries: '' diyOrderNo: '' urlParameter: '' orderNatureName: '' platformOrderStateName: '' province: '' productTypeName: '' vkgrpName: '' orderCoverImage: '' vkbur: '' spartName: '' consigneeAddress: '' urgentRecordId: '' vkgrp: '' batchNo: '' orderNo: '' signTime: '' expand1: '' shopOrderStateName: '' signUser: nickName: '' mobile: '' avatar: '' outUserId: '' userName: '' userId: '' name: '' promotionCode: '' expand2: '' planDeliveryDate: '' signOrgan: organName: '' organId: '' vuartName: '' platformOrderStateCode: '' productNatureName: '' submitTime: '' shopOrderId: '' disOrderId: '' submitUser: nickName: '' mobile: '' avatar: '' outUserId: '' userName: '' userId: '' name: '' district: '' orderSeries: '' shopDept: deptName: '' storeType: 0 deptId: '' customerCode: '' outDeptId: '' isWaiXie: '' productTypeCode: '' vkorg: '' thirdOrderInfo: '' saleMoney: '' color: '' deliveryTime: '' scheme: imagePath: '' schemeName: '' schemeId: '' modifyTime: '' createTime: '' vtwegName: '' city: '' cause: '' orderSeriesName: '' orderTypeId: '' packNum: '' remark: '' orderCateCode: '' orderCategoryName: '' isOnlyFile: '' contractCategoryName: '' orderRecordId: '' platformOrderId: '' urgent: '' orderName: '' houseType: '' orderCount: '' expand3Name: '' productNature: '' orderCateName: '' spart: '' vtweg: '' orderTypeName: '' vkorgName: '' spatialName: '' contractCategory: '' vuart: '' createTime: '' expand4Name: '' colorRecordId: '' contactWay: '' contactRealName: '' createUser: nickName: '' mobile: '' avatar: '' outUserId: '' userName: '' userId: '' name: '' shopOrderStateCode: '' orderCategory: '' customer: customerAddress: '' customerCode: '' customerName: '' customerId: '' customerMobile: '' success: true '401': description: access_token 缺失或已过期 / missing or expired access_token /api/v1/manufacturing/getOrder3dFileUrl: post: operationId: apiV1ManufacturingGetOrder3dFileUrl summary: 获取订单3D文件地址接口 tags: - MOS x-source-documentation: https://dev.3vjia.com/document?apiId=474662783372329035 x-documentation-category: MOS系统 / 订单数据 description: 获取三维家生产订单的3D设计文件地址,3D审核文件地址,用于单点登录直接打开对应文件。 requestBody: required: false content: application/json: schema: type: object properties: orderNo: type: string description: 订单编号,orderRecordId和orderNo至少传一个,orderRecordId为空时orderNo有效 examples: - EMS-63CG19120402 orderRecordId: type: string description: 订单的通用ID,同一订单下店铺订单、工厂订单此值是相同的,orderRecordId和orderNo至少传一个,传了orderRecordId将忽略orderNo examples: - F053521B72F34613BEAD2CC8B6279E75 example: orderNo: EMS-63CG19120402 orderRecordId: F053521B72F34613BEAD2CC8B6279E75 responses: '200': description: 成功 / OK content: application/json: schema: type: object properties: success: type: boolean description: 请求是否成功 / whether the call succeeded code: type: integer description: 结果码 / result code (0 = success) msg: type: string description: 提示信息 / message data: type: object properties: orderCheckFileReadOnlyRedirectUrl: type: string description: 订单审核文件只读模式单点登录重定向地址 examples: - https://admin.3vjia.com/3DLoading?IsRemoveFurniture=1&OpenModel=1&SaveModel=readOnly&SchemeId=50011044&DisOrderId=63210a45bae6406596e0f67743b02865&SubOrderId=70ab1ce72a9e4b809be4b4f43c504dd7 orderCheckFileRedirectUrl: type: string description: 订单审核文件单点登录重定向地址 examples: - https://admin.3vjia.com/3DLoading?IsRemoveFurniture=1&OpenModel=2&SaveModel=Modify&SchemeId=50011044&DisOrderId=63210a45bae6406596e0f67743b02865&SubOrderId=70ab1ce72a9e4b809be4b4f43c504dd7 orderDesignFileRedirectUrl: type: string description: 订单设计文件单点登录重定向地址 examples: - https://admin.3vjia.com/3DLoading?IsRemoveFurniture=1&OpenModel=1&SaveModel=readOnly&SchemeId=50011044&DisOrderId=63210a45bae6406596e0f67743b02865&SubOrderId=70ab1ce72a9e4b809be4b4f43c504dd7 orderName: type: string description: 订单名称 examples: - 测试订单 orderNo: type: string description: 订单号 examples: - EMS-3838YG2005051312 orderRecordId: type: string description: 订单ID examples: - 70ab1ce72a9e4b809be4b4f43c504dd7 example: msg: 成功 code: 0 data: orderNo: EMS-3838YG2005051312 orderCheckFileReadOnlyRedirectUrl: https://admin.3vjia.com/3DLoading?IsRemoveFurniture=1&OpenModel=1&SaveModel=readOnly&SchemeId=50011044&DisOrderId=63210a45bae6406596e0f67743b02865&SubOrderId=70ab1ce72a9e4b809be4b4f43c504dd7 orderCheckFileRedirectUrl: https://admin.3vjia.com/3DLoading?IsRemoveFurniture=1&OpenModel=2&SaveModel=Modify&SchemeId=50011044&DisOrderId=63210a45bae6406596e0f67743b02865&SubOrderId=70ab1ce72a9e4b809be4b4f43c504dd7 orderDesignFileRedirectUrl: https://admin.3vjia.com/3DLoading?IsRemoveFurniture=1&OpenModel=1&SaveModel=readOnly&SchemeId=50011044&DisOrderId=63210a45bae6406596e0f67743b02865&SubOrderId=70ab1ce72a9e4b809be4b4f43c504dd7 orderRecordId: 70ab1ce72a9e4b809be4b4f43c504dd7 orderName: 测试订单 success: true '401': description: access_token 缺失或已过期 / missing or expired access_token /api/v1/manufacturing/getOrderAttachment: post: operationId: apiV1ManufacturingGetOrderAttachment summary: 获取订单附件接口 tags: - MOS x-source-documentation: https://dev.3vjia.com/document?apiId=474666800987082758 x-documentation-category: MOS系统 / 订单数据 description: 获取三维家生产订单的附件 requestBody: required: false content: application/json: schema: type: object properties: orderNo: type: string description: 订单编号,orderRecordId和orderNo至少传一个,orderRecordId为空时orderNo有效 examples: - EMS-63CG19120402 orderRecordId: type: string description: 订单的通用ID,同一订单下店铺订单、工厂订单此值是相同的,orderRecordId和orderNo至少传一个,传了orderRecordId将忽略orderNo examples: - F053521B72F34613BEAD2CC8B6279E75 example: orderNo: EMS-63CG19120402 orderRecordId: F053521B72F34613BEAD2CC8B6279E75 responses: '200': description: 成功 / OK content: application/json: schema: type: object properties: success: type: boolean description: 请求是否成功 / whether the call succeeded code: type: integer description: 结果码 / result code (0 = success) msg: type: string description: 提示信息 / message data: type: object properties: orderAttachmentList: type: array items: type: object properties: createTime: type: string description: 附件创建时间,格式yyyy-MM-ddHH:mm:ss examples: - '2020-05-05 12:59:00' createUser: type: object properties: avatar: type: string description: 设计师头像 mobile: type: string description: 手机号码 name: type: string description: 姓名 nickName: type: string description: 昵称 outUserId: type: string description: 账号绑定的企业系统用户ID userId: type: string description: 三维家用户ID userName: type: string description: 三维家账号 description: 操作用户 fileAddress: type: string description: 附件的Url地址 examples: - https://3vj-mos.oss-cn-shenzhen.aliyuncs.com/cpxml/20200408/2004135/测试-运营管理部-练习3838YG20040803_1.zip fileName: type: string description: 附件名称 examples: - 测试-运营管理部-练习3838YG20040803_1.zip fileSource: type: string description: 附件的类型,常见的有CustomDesignAttachment=设计附件,CustomAuditAttachment=审核附件,CustomProduceAttachment=生产附件,未具体枚举 examples: - CustomProduceAttachment id: type: string description: 附件ID examples: - d4d3a66dc5f6412882d7f29b63372ead remark: type: string description: 备注 examples: - 备注 description: 订单附件实体,V2 orderName: type: string description: 订单名称 examples: - 测试订单 orderNo: type: string description: 订单号 examples: - EMS-3838YG2005051312 orderRecordId: type: string description: 订单ID examples: - 70ab1ce72a9e4b809be4b4f43c504dd7 example: msg: 成功 code: 0 data: orderAttachmentList: - fileName: 测试-运营管理部-练习3838YG20040803_1.zip fileSource: CustomProduceAttachment remark: 备注 createTime: '2020-05-05 12:59:00' createUser: nickName: '' mobile: '' avatar: '' outUserId: '' userName: '' userId: '' name: '' id: d4d3a66dc5f6412882d7f29b63372ead fileAddress: https://3vj-mos.oss-cn-shenzhen.aliyuncs.com/cpxml/20200408/2004135/测试-运营管理部-练习3838YG20040803_1.zip orderNo: EMS-3838YG2005051312 orderRecordId: 70ab1ce72a9e4b809be4b4f43c504dd7 orderName: 测试订单 success: true '401': description: access_token 缺失或已过期 / missing or expired access_token /api/v1/manufacturing/getOrderCadFile: post: operationId: apiV1ManufacturingGetOrderCadFile summary: 获取订单CAD文件接口 tags: - MOS x-source-documentation: https://dev.3vjia.com/document?apiId=474672236729569282 x-documentation-category: MOS系统 / 订单数据 description: 获取订单CAD文件,需要开通保存订单CAD xml的功能才可使用。 requestBody: required: false content: application/json: schema: type: object properties: contentType: type: integer format: int32 description: 文件类型,0=设计文件,1=审核文件 examples: - '0' orderNo: type: string description: 订单号,订单ID、订单号至少传1项,当orderRecordId为空时,orderNo有效 examples: - 63CG19120402 orderRecordId: type: string description: 订单ID,店铺订单、工厂订单通用,同一订单的店铺订单、工厂订单的ID一致,订单ID、订单号至少传1项,当orderRecordId不为空时,将忽略orderNo examples: - F053521B72F34613BEAD2CC8B6279E75 outUserId: type: string description: 操作人-企业账号绑定时使用的企业用户ID,userId、userName、outUserId三个中,outUserId优先级第三 examples: - '123456' userId: type: string description: 操作人-三维家用户ID,userId、userName、outUserId三个中,userId优先级最高 examples: - '1000122456' userName: type: string description: 操作人-三维家账号,userId、userName、outUserId三个中,userName优先级第二 examples: - 3vj123456 example: orderNo: 63CG19120402 outUserId: '123456' userName: 3vj123456 userId: '1000122456' orderRecordId: F053521B72F34613BEAD2CC8B6279E75 contentType: 0 responses: '200': description: 成功 / OK content: application/json: schema: type: object properties: success: type: boolean description: 请求是否成功 / whether the call succeeded code: type: integer description: 结果码 / result code (0 = success) msg: type: string description: 提示信息 / message data: type: object properties: fileUrl: type: string description: CAD文件路径,非永久保存,请及时下载 examples: - https://3vj-outerapi.3vjia.com/OrderCad/EMS-4768YG20120920.dwg orderName: type: string description: 订单名称 examples: - 测试订单 orderNo: type: string description: 订单号 examples: - EMS-3838YG2005051312 orderRecordId: type: string description: 订单ID examples: - 70ab1ce72a9e4b809be4b4f43c504dd7 example: msg: 成功 code: 0 data: orderNo: EMS-3838YG2005051312 orderRecordId: 70ab1ce72a9e4b809be4b4f43c504dd7 fileUrl: https://3vj-outerapi.3vjia.com/OrderCad/EMS-4768YG20120920.dwg orderName: 测试订单 success: true '401': description: access_token 缺失或已过期 / missing or expired access_token /api/v1/manufacturing/getOrderCadFileList: post: operationId: apiV1ManufacturingGetOrderCadFileList summary: 获取订单CAD文件列表接口 tags: - MOS x-source-documentation: https://dev.3vjia.com/document?apiId=474669617277665344 x-documentation-category: MOS系统 / 订单数据 description: 获取订单CAD文件列表,需要开通相关功能才可使用,这里会返回一个文件列表。 requestBody: required: false content: application/json: schema: type: object properties: contentType: type: integer format: int32 description: 文件类型,0=设计文件,1=审核文件 examples: - '0' exportType: type: string description: 导出类型,cad|threeView,cad:表示cad图,threeView:表示三视图,默认是cad examples: - cad extType: type: integer format: int32 description: 文件扩展类型,默认为1,1:dwg;2:pdf;3:dwg+pdf;8:svg examples: - '1' orderNo: type: string description: 订单号,订单ID、订单号至少传1项,当orderRecordId为空时,orderNo有效 examples: - 63CG19120402 orderRecordId: type: string description: 订单ID,店铺订单、工厂订单通用,同一订单的店铺订单、工厂订单的ID一致,订单ID、订单号至少传1项,当orderRecordId不为空时,将忽略orderNo examples: - F053521B72F34613BEAD2CC8B6279E75 outUserId: type: string description: 操作人-企业账号绑定时使用的企业用户ID,userId、userName、outUserId三个中,outUserId优先级第三 examples: - '123456' userId: type: string description: 操作人-三维家用户ID,userId、userName、outUserId三个中,userId优先级最高 examples: - '1000122456' userName: type: string description: 操作人-三维家账号,userId、userName、outUserId三个中,userName优先级第二 examples: - 3vj123456 example: orderNo: 63CG19120402 outUserId: '123456' userName: 3vj123456 userId: '1000122456' orderRecordId: F053521B72F34613BEAD2CC8B6279E75 exportType: cad contentType: 0 extType: 1 responses: '200': description: 成功 / OK content: application/json: schema: type: object properties: success: type: boolean description: 请求是否成功 / whether the call succeeded code: type: integer description: 结果码 / result code (0 = success) msg: type: string description: 提示信息 / message data: type: object properties: fileList: type: array items: type: object properties: content: type: string description: 文件Url examples: - http://3vj-outerapi.3vjia.com/OrderCad/df153bf4df5d463fa997a801ce051a7b/1625716617457/0b7ce89e1f7249ed96a7fbfab53fba47.dwg extension: type: string description: 文件类型如dwg examples: - dwg type: type: string description: 柜体类型 examples: - 衣柜 description: '{*\"Extension\":\"文件类型如dwg\",*\"Type\":\"柜体类型\",*\"Content\":\"文件内容zlib压缩后base64加密后的字符串\"*}' orderName: type: string description: 订单名称 examples: - 测试订单 orderNo: type: string description: 订单号 examples: - EMS-3838YG2005051312 orderRecordId: type: string description: 订单ID examples: - 70ab1ce72a9e4b809be4b4f43c504dd7 example: msg: 成功 code: 0 data: orderNo: EMS-3838YG2005051312 orderRecordId: 70ab1ce72a9e4b809be4b4f43c504dd7 fileList: - extension: dwg type: 衣柜 content: http://3vj-outerapi.3vjia.com/OrderCad/df153bf4df5d463fa997a801ce051a7b/1625716617457/0b7ce89e1f7249ed96a7fbfab53fba47.dwg orderName: 测试订单 success: true '401': description: access_token 缺失或已过期 / missing or expired access_token /api/v1/manufacturing/getOrderCommunicationRecord: post: operationId: apiV1ManufacturingGetOrderCommunicationRecord summary: 获取订单交流记录接口 tags: - MOS x-source-documentation: https://dev.3vjia.com/document?apiId=474670883894562904 x-documentation-category: MOS系统 / 订单数据 description: 根据订单ID或订单号获取订单交流记录,使用订单号时不支持外协订单 requestBody: required: false content: application/json: schema: type: object properties: orderNo: type: string description: 订单号,订单ID、订单号至少传1项,当orderRecordId为空时,orderNo有效,外协订单无法使用orderNo查询 examples: - 63CG19120402 orderRecordId: type: string description: 订单ID,店铺订单、工厂订单通用,同一订单的店铺订单、工厂订单的ID一致,订单ID、订单号至少传1项,当orderRecordId不为空时,将忽略orderNo examples: - F053521B72F34613BEAD2CC8B6279E75 example: orderNo: 63CG19120402 orderRecordId: F053521B72F34613BEAD2CC8B6279E75 responses: '200': description: 成功 / OK content: application/json: schema: type: object properties: success: type: boolean description: 请求是否成功 / whether the call succeeded code: type: integer description: 结果码 / result code (0 = success) msg: type: string description: 提示信息 / message data: type: object properties: orderCommunicationRecordList: type: array items: type: object properties: content: type: string description: 操作内容 createTime: type: string description: 创建时间,格式yyyy-MM-ddHH:mm:ss createUser: type: object properties: avatar: type: string description: 设计师头像 mobile: type: string description: 手机号码 name: type: string description: 姓名 nickName: type: string description: 昵称 outUserId: type: string description: 账号绑定的企业系统用户ID userId: type: string description: 三维家用户ID userName: type: string description: 三维家账号 description: 操作用户 dept: type: object properties: customerCode: type: string description: 部门对应客户部门编码 deptId: type: string description: 部门ID deptName: type: string description: 部门名称 outDeptId: type: string description: 部门所绑定企业系统部门ID,绑定过才有值 storeType: type: integer format: int32 description: 类型0=门店,1=部门 description: 上级部门信息 organ: type: object properties: organId: type: string description: 企业ID organName: type: string description: 企业名称 description: 部门所属机构信息 recordId: type: string description: 记录ID description: 订单交流记录结构 orderName: type: string description: 订单名称 orderNo: type: string description: 订单号 orderRecordId: type: string description: 订单ID example: msg: 成功 code: 0 data: orderNo: '' orderRecordId: '' orderCommunicationRecordList: - organ: organName: '' organId: '' dept: deptName: '' storeType: 0 deptId: '' customerCode: '' outDeptId: '' content: '' recordId: '' createTime: '' createUser: nickName: '' mobile: '' avatar: '' outUserId: '' userName: '' userId: '' name: '' orderName: '' success: true '401': description: access_token 缺失或已过期 / missing or expired access_token /api/v1/manufacturing/getOrderOperationTrace: post: operationId: apiV1ManufacturingGetOrderOperationTrace summary: 获取订单跟进记录接口 tags: - MOS x-source-documentation: https://dev.3vjia.com/document?apiId=474669617277665346 x-documentation-category: MOS系统 / 订单数据 description: 根据订单ID或订单号获取订单跟进记录,使用订单号时不支持外协订单 requestBody: required: false content: application/json: schema: type: object properties: orderNo: type: string description: 订单号,订单ID、订单号至少传1项,当orderRecordId为空时,orderNo有效,外协订单无法使用orderNo查询 examples: - 63CG19120402 orderRecordId: type: string description: 订单ID,店铺订单、工厂订单通用,同一订单的店铺订单、工厂订单的ID一致,订单ID、订单号至少传1项,当orderRecordId不为空时,将忽略orderNo examples: - F053521B72F34613BEAD2CC8B6279E75 example: orderNo: 63CG19120402 orderRecordId: F053521B72F34613BEAD2CC8B6279E75 responses: '200': description: 成功 / OK content: application/json: schema: type: object properties: success: type: boolean description: 请求是否成功 / whether the call succeeded code: type: integer description: 结果码 / result code (0 = success) msg: type: string description: 提示信息 / message data: type: object properties: orderFollowUpRecordList: type: array items: type: object properties: content: type: string description: 操作内容 examples: - xxx createTime: type: string description: 创建时间,格式yyyy-MM-ddHH:mm:ss examples: - '2020-05-06 11:11:36' createUser: type: object properties: avatar: type: string description: 设计师头像 mobile: type: string description: 手机号码 name: type: string description: 姓名 nickName: type: string description: 昵称 outUserId: type: string description: 账号绑定的企业系统用户ID userId: type: string description: 三维家用户ID userName: type: string description: 三维家账号 description: 操作用户 dept: type: object properties: customerCode: type: string description: 部门对应客户部门编码 deptId: type: string description: 部门ID deptName: type: string description: 部门名称 outDeptId: type: string description: 部门所绑定企业系统部门ID,绑定过才有值 storeType: type: integer format: int32 description: 类型0=门店,1=部门 description: 上级部门信息 operationName: type: string description: 操作名称 examples: - 收款确认 organ: type: object properties: organId: type: string description: 企业ID organName: type: string description: 企业名称 description: 部门所属机构信息 recordId: type: string description: 记录ID examples: - F053521B72F34613BEAD2CC8B6279E75 description: 跟进记录结构,V2 orderName: type: string description: 订单名称 examples: - 测试订单 orderNo: type: string description: 订单号 examples: - EMS-3838YG2005051312 orderRecordId: type: string description: 订单ID examples: - 70ab1ce72a9e4b809be4b4f43c504dd7 example: msg: 成功 code: 0 data: orderNo: EMS-3838YG2005051312 orderFollowUpRecordList: - organ: organName: '' organId: '' operationName: 收款确认 dept: deptName: '' storeType: 0 deptId: '' customerCode: '' outDeptId: '' content: xxx recordId: F053521B72F34613BEAD2CC8B6279E75 createTime: '2020-05-06 11:11:36' createUser: nickName: '' mobile: '' avatar: '' outUserId: '' userName: '' userId: '' name: '' orderRecordId: 70ab1ce72a9e4b809be4b4f43c504dd7 orderName: 测试订单 success: true '401': description: access_token 缺失或已过期 / missing or expired access_token /api/v1/manufacturing/getOrderPayRecord: post: operationId: apiV1ManufacturingGetOrderPayRecord summary: 获取订单付款记录接口 tags: - MOS x-source-documentation: https://dev.3vjia.com/document?apiId=474672016889319476 x-documentation-category: MOS系统 / 订单数据 description: 根据订单ID或订单号获取订单付款记录,使用订单号时不支持外协订单 requestBody: required: false content: application/json: schema: type: object properties: orderNo: type: string description: 订单号,订单ID、订单号至少传1项,当orderRecordId为空时,orderNo有效,外协订单无法使用orderNo查询 examples: - 63CG19120402 orderRecordId: type: string description: 订单ID,店铺订单、工厂订单通用,同一订单的店铺订单、工厂订单的ID一致,订单ID、订单号至少传1项,当orderRecordId不为空时,将忽略orderNo examples: - F053521B72F34613BEAD2CC8B6279E75 example: orderNo: 63CG19120402 orderRecordId: F053521B72F34613BEAD2CC8B6279E75 responses: '200': description: 成功 / OK content: application/json: schema: type: object properties: success: type: boolean description: 请求是否成功 / whether the call succeeded code: type: integer description: 结果码 / result code (0 = success) msg: type: string description: 提示信息 / message data: type: object properties: orderName: type: string description: 订单名称 orderNo: type: string description: 订单号 orderPayRecordList: type: array items: type: object properties: createTime: type: string description: 创建时间,格式yyyy-MM-ddHH:mm:ss createUser: type: object properties: avatar: type: string description: 设计师头像 mobile: type: string description: 手机号码 name: type: string description: 姓名 nickName: type: string description: 昵称 outUserId: type: string description: 账号绑定的企业系统用户ID userId: type: string description: 三维家用户ID userName: type: string description: 三维家账号 description: 操作用户 dept: type: object properties: customerCode: type: string description: 部门对应客户部门编码 deptId: type: string description: 部门ID deptName: type: string description: 部门名称 outDeptId: type: string description: 部门所绑定企业系统部门ID,绑定过才有值 storeType: type: integer format: int32 description: 类型0=门店,1=部门 description: 上级部门信息 fileUrl: type: string description: 附件地址 organ: type: object properties: organId: type: string description: 企业ID organName: type: string description: 企业名称 description: 部门所属机构信息 payAmount: type: object recordId: type: string description: 记录ID remark: type: string description: 备注 sumPayable: type: object description: 订单付款记录结构,V2 orderRecordId: type: string description: 订单ID example: msg: '' code: 0 data: orderPayRecordList: - organ: organName: '' organId: '' sumPayable: '' remark: '' dept: deptName: '' storeType: 0 deptId: '' customerCode: '' outDeptId: '' recordId: '' payAmount: '' createTime: '' createUser: nickName: '' mobile: '' avatar: '' outUserId: '' userName: '' userId: '' name: '' fileUrl: '' orderNo: '' orderRecordId: '' orderName: '' success: false '401': description: access_token 缺失或已过期 / missing or expired access_token /api/v1/manufacturing/getOrderQuoteXml: post: operationId: apiV1ManufacturingGetOrderQuoteXml summary: 获取订单报价XML接口 tags: - MOS x-source-documentation: https://dev.3vjia.com/document?apiId=474664926561013852 x-documentation-category: MOS系统 / 订单数据 description: 获取订单报价XML,可以按照订单ID、订单号 requestBody: required: false content: application/json: schema: type: object properties: contentType: type: integer format: int32 description: 文件类型,0=设计文件报价xml,1=审核文件报价xml examples: - '0' orderNo: type: string description: 订单号,订单ID、订单号至少传1项,当orderRecordId为空时,orderNo有效,外协订单无法使用orderNo查询 examples: - 63CG19120402 orderRecordId: type: string description: 订单ID,店铺订单、工厂订单通用,同一订单的店铺订单、工厂订单的ID一致,订单ID、订单号至少传1项,当orderRecordId不为空时,将忽略orderNo examples: - F053521B72F34613BEAD2CC8B6279E75 example: orderNo: 63CG19120402 orderRecordId: F053521B72F34613BEAD2CC8B6279E75 contentType: 0 responses: '200': description: 成功 / OK content: application/json: schema: type: object properties: success: type: boolean description: 请求是否成功 / whether the call succeeded code: type: integer description: 结果码 / result code (0 = success) msg: type: string description: 提示信息 / message data: type: object properties: createUser: type: object properties: avatar: type: string description: 设计师头像 examples: - https://img3.admin.3vjia.com/UpFile/C00005842/ADMIN/UserSetting/202005/1001266879/89faef49527140eb883d7a5190c0048a.jpg mobile: type: string description: 手机号码 examples: - '13800000000' name: type: string description: 姓名 examples: - cc nickName: type: string description: 昵称 examples: - cc outUserId: type: string description: 账号绑定的企业系统用户ID examples: - '123456' userId: type: string description: 三维家用户ID examples: - '1000123456' userName: type: string description: 三维家账号 examples: - 3vj13800000000 description: 操作用户 diyOrderNo: type: string description: 自定义订单号 examples: - A123456 orderName: type: string description: 订单名称 examples: - 测试订单20200519 orderNo: type: string description: 订单编号 examples: - EMS-63CG19120402 orderRecordId: type: string description: 订单的通用ID,同一订单下店铺订单、工厂订单此值是相同的 examples: - F053521B72F34613BEAD2CC8B6279E75 xmlContent: type: string description: 设计文件或审核文件deflate算法压缩之后的Base64字符串,解压参考Demo:https://3vj-outerapi.3vjia.com/CodeDemo/OrderXmlDecodeDemo.java examples: - eNqllFuL00AUgN8F/8Mw7yGXya3QFpqkEWEpuOvio0ybbDtr2qnJROmboCusKLpP4lJZFldYBWXVB6XdxT/Tpt1/4SRpt+1enszD5ORcJ9+cM0Ub10nHZ2u4R2N2L6bMB09wEPslmHz5MT38lBz0k1efR8Pfk1/DyfAAgnXsEVqCsHz7FuBP0Y67FsWhl8c+TtcHuFeCMgTNgDZw4OIGo2GmiFgv8Gu47S/ieYZ1Stsg5EtuSfpfx3tn43dvYKa862WhqbhJuGxWKm7VlGVBNi1JQK6DBFVSkYAcu2DqSK0qElok5+nvhDTuLim4arNDGGC9Lq8WcxGCTlZ5/Pb1+PTZ+fvjcf+E/7eAIIjTkpahm7qlVgVLUR2hoiuO4GqaJSBTq5i2YugOsiFoY+aHBAfZhmVJ1k2kmhB0cchqcbvucwT6hiTbkrourkFAooxYCbIw9jm..... example: msg: 成功 code: 0 data: orderNo: EMS-63CG19120402 diyOrderNo: A123456 orderRecordId: F053521B72F34613BEAD2CC8B6279E75 createUser: nickName: cc mobile: '13800000000' avatar: https://img3.admin.3vjia.com/UpFile/C00005842/ADMIN/UserSetting/202005/1001266879/89faef49527140eb883d7a5190c0048a.jpg outUserId: '123456' userName: 3vj13800000000 userId: '1000123456' name: cc xmlContent: eNqllFuL00AUgN8F/8Mw7yGXya3QFpqkEWEpuOvio0ybbDtr2qnJROmboCusKLpP4lJZFldYBWXVB6XdxT/Tpt1/4SRpt+1enszD5ORcJ9+cM0Ub10nHZ2u4R2N2L6bMB09wEPslmHz5MT38lBz0k1efR8Pfk1/DyfAAgnXsEVqCsHz7FuBP0Y67FsWhl8c+TtcHuFeCMgTNgDZw4OIGo2GmiFgv8Gu47S/ieYZ1Stsg5EtuSfpfx3tn43dvYKa862WhqbhJuGxWKm7VlGVBNi1JQK6DBFVSkYAcu2DqSK0qElok5+nvhDTuLim4arNDGGC9Lq8WcxGCTlZ5/Pb1+PTZ+fvjcf+E/7eAIIjTkpahm7qlVgVLUR2hoiuO4GqaJSBTq5i2YugOsiFoY+aHBAfZhmVJ1k2kmhB0cchqcbvucwT6hiTbkrourkFAooxYCbIw9jm..... orderName: 测试订单20200519 success: true '401': description: access_token 缺失或已过期 / missing or expired access_token /api/v1/manufacturing/getOrderSchemeHistory: post: operationId: apiV1ManufacturingGetOrderSchemeHistory summary: 获取订单历史方案记录接口 tags: - MOS x-source-documentation: https://dev.3vjia.com/document?apiId=475025003306364931 x-documentation-category: MOS系统 / 订单数据 description: 根据订单ID或订单号获取订单历史方案记录,使用订单号时不支持外协订单 requestBody: required: false content: application/json: schema: type: object properties: orderNo: type: string description: 订单号,订单ID、订单号至少传1项,当orderRecordId为空时,orderNo有效,外协订单无法使用orderNo查询 examples: - 63CG19120402 orderRecordId: type: string description: 订单ID,店铺订单、工厂订单通用,同一订单的店铺订单、工厂订单的ID一致,订单ID、订单号至少传1项,当orderRecordId不为空时,将忽略orderNo examples: - F053521B72F34613BEAD2CC8B6279E75 example: orderNo: 63CG19120402 orderRecordId: F053521B72F34613BEAD2CC8B6279E75 responses: '200': description: 成功 / OK content: application/json: schema: type: object properties: success: type: boolean description: 请求是否成功 / whether the call succeeded code: type: integer description: 结果码 / result code (0 = success) msg: type: string description: 提示信息 / message data: type: object properties: orderName: type: string description: 订单名称 orderNo: type: string description: 订单号 orderRecordId: type: string description: 订单ID orderSchemeHistoryList: type: array items: type: object properties: createTime: type: string description: 创建时间,格式yyyy-MM-ddHH:mm:ss createUser: type: object properties: avatar: type: string description: 设计师头像 mobile: type: string description: 手机号码 name: type: string description: 姓名 nickName: type: string description: 昵称 outUserId: type: string description: 账号绑定的企业系统用户ID userId: type: string description: 三维家用户ID userName: type: string description: 三维家账号 description: 操作用户 dept: type: object properties: customerCode: type: string description: 部门对应客户部门编码 deptId: type: string description: 部门ID deptName: type: string description: 部门名称 outDeptId: type: string description: 部门所绑定企业系统部门ID,绑定过才有值 storeType: type: integer format: int32 description: 类型0=门店,1=部门 description: 上级部门信息 historyFileRedirectUrl: type: string description: 历史方案3D文件单点登录重定向地址 organ: type: object properties: organId: type: string description: 企业ID organName: type: string description: 企业名称 description: 部门所属机构信息 recordId: type: string description: 记录ID description: 获取订单历史方案记录结构 example: msg: '' code: 0 data: orderNo: '' orderRecordId: '' orderSchemeHistoryList: - organ: organName: '' organId: '' dept: deptName: '' storeType: 0 deptId: '' customerCode: '' outDeptId: '' recordId: '' createTime: '' createUser: nickName: '' mobile: '' avatar: '' outUserId: '' userName: '' userId: '' name: '' historyFileRedirectUrl: '' orderName: '' success: false '401': description: access_token 缺失或已过期 / missing or expired access_token /api/v1/manufacturing/getOrderStateDictionary: post: operationId: apiV1ManufacturingGetOrderStateDictionary summary: 获取订单状态字典接口 tags: - MOS x-source-documentation: https://dev.3vjia.com/document?apiId=475026463813349471 x-documentation-category: MOS系统 / 订单管理 responses: '200': description: 成功 / OK content: application/json: schema: type: object properties: success: type: boolean description: 请求是否成功 / whether the call succeeded code: type: integer description: 结果码 / result code (0 = success) msg: type: string description: 提示信息 / message data: type: object properties: code: type: string description: 状态编码,在其他接口如获取订单列表接口中会使用 examples: - C2_SHOP_ORDER_COMPLETE name: type: string description: 状态名称 examples: - 已完成 remark: type: string description: 状态说明与备注 examples: - 已完成 type: type: string description: 状态类型,店铺订单和工厂订单使用的状态码是不同的,此处1=店铺订单状态,3=工厂订单状态 examples: - '1' example: msg: '' code: 0 data: - code: C2_SHOP_ORDER_COMPLETE remark: 已完成 type: '1' name: 已完成 success: true '401': description: access_token 缺失或已过期 / missing or expired access_token /api/v1/manufacturing/getOrderThreeViewDrawingFile: post: operationId: apiV1ManufacturingGetOrderThreeViewDrawingFile summary: 获取订单三视图文件接口 tags: - MOS x-source-documentation: https://dev.3vjia.com/document?apiId=474669185604096010 x-documentation-category: MOS系统 / 订单数据 description: 获取订单三视图文件,需要开通保存订单三视图XML的功能才可使用。 requestBody: required: true content: application/json: schema: type: object properties: contentType: type: integer format: int32 description: 文件类型,0=设计文件,1=审核文件 examples: - '0' orderNo: type: string description: 订单号,订单ID、订单号至少传1项,当orderRecordId为空时,orderNo有效 examples: - 63CG19120402 orderRecordId: type: string description: 订单ID,店铺订单、工厂订单通用,同一订单的店铺订单、工厂订单的ID一致,订单ID、订单号至少传1项,当orderRecordId不为空时,将忽略orderNo examples: - F053521B72F34613BEAD2CC8B6279E75 outUserId: type: string description: 操作人-企业账号绑定时使用的企业用户ID,userId、userName、outUserId三个中,outUserId优先级第三 examples: - '123456' userId: type: string description: 操作人-三维家用户ID,userId、userName、outUserId三个中,userId优先级最高 examples: - '1000122456' userName: type: string description: 操作人-三维家账号,userId、userName、outUserId三个中,userName优先级第二 examples: - 3vj123456 required: - contentType example: orderNo: 63CG19120402 outUserId: '123456' userName: 3vj123456 userId: '1000122456' orderRecordId: F053521B72F34613BEAD2CC8B6279E75 contentType: 0 responses: '200': description: 成功 / OK content: application/json: schema: type: object properties: success: type: boolean description: 请求是否成功 / whether the call succeeded code: type: integer description: 结果码 / result code (0 = success) msg: type: string description: 提示信息 / message data: type: object properties: fileUrl: type: string description: 三视图文件路径,非永久保存,请及时下载 examples: - https://3vj-outerapi.3vjia.com/ThreeViewDrawing/EMS-4768YG20120920.dwg orderName: type: string description: 订单名称 examples: - 测试订单 orderNo: type: string description: 订单号 examples: - EMS-3838YG2005051312 orderRecordId: type: string description: 订单ID examples: - 70ab1ce72a9e4b809be4b4f43c504dd7 example: msg: 成功 code: 0 data: orderNo: EMS-3838YG2005051312 orderRecordId: 70ab1ce72a9e4b809be4b4f43c504dd7 fileUrl: https://3vj-outerapi.3vjia.com/ThreeViewDrawing/EMS-4768YG20120920.dwg orderName: 测试订单 success: true '401': description: access_token 缺失或已过期 / missing or expired access_token /api/v1/manufacturing/getOuterProductionXml: post: operationId: apiV1ManufacturingGetOuterProductionXml summary: 获取第三方生产软件XML接口 tags: - MOS x-source-documentation: https://dev.3vjia.com/document?apiId=474670751249698877 x-documentation-category: MOS系统 / 订单数据 description: 获取第三方生产软件XML,可以按照订单ID、订单号 requestBody: required: false content: application/json: schema: type: object properties: contentType: type: integer format: int32 description: 文件类型,0=设计文件报价xml,1=审核文件报价xml examples: - '0' fileKey: type: string description: 枚举值:wccInfo、imosInfo examples: - wccInfo fileKeyEnum: type: array items: {} description: This is Array Type orderNo: type: string description: 订单号,订单ID、订单号至少传1项,当orderRecordId为空时,orderNo有效,外协订单无法使用orderNo查询 examples: - 63CG19120402 orderRecordId: type: string description: 订单ID,店铺订单、工厂订单通用,同一订单的店铺订单、工厂订单的ID一致,订单ID、订单号至少传1项,当orderRecordId不为空时,将忽略orderNo examples: - F053521B72F34613BEAD2CC8B6279E75 example: orderNo: 63CG19120402 fileKey: wccInfo fileKeyEnum: [] orderRecordId: F053521B72F34613BEAD2CC8B6279E75 contentType: 0 responses: '200': description: 成功 / OK content: application/json: schema: type: object properties: success: type: boolean description: 请求是否成功 / whether the call succeeded code: type: integer description: 结果码 / result code (0 = success) msg: type: string description: 提示信息 / message data: type: object properties: createUser: type: object properties: avatar: type: string description: 设计师头像 mobile: type: string description: 手机号码 name: type: string description: 姓名 nickName: type: string description: 昵称 outUserId: type: string description: 账号绑定的企业系统用户ID userId: type: string description: 三维家用户ID userName: type: string description: 三维家账号 description: 操作用户 diyOrderNo: type: string description: 自定义订单号 orderName: type: string description: 订单名称 orderNo: type: string description: 订单编号 orderRecordId: type: string description: 订单的通用ID,同一订单下店铺订单、工厂订单此值是相同的 xmlContent: type: string description: 第三方生产软件XML的Base64字符串 example: msg: '' code: 0 data: orderNo: '' diyOrderNo: '' orderRecordId: '' createUser: nickName: '' mobile: '' avatar: '' outUserId: '' userName: '' userId: '' name: '' xmlContent: '' orderName: '' success: false '401': description: access_token 缺失或已过期 / missing or expired access_token /api/v1/manufacturing/getPlatformOrderListByPage: post: operationId: apiV1ManufacturingGetPlatformOrderListByPage summary: 获取工厂订单列表接口 tags: - MOS x-source-documentation: https://dev.3vjia.com/document?apiId=474670883894562910 x-documentation-category: MOS系统 / 订单数据 requestBody: required: false content: application/json: schema: type: object properties: batchNo: type: string description: 订单关联的批次号 likeOrderName: type: string description: 订单名称,模糊搜索 orderBy: type: string description: 排序方式,具体取值请咨询技术支持 orderNo: type: string description: 订单号 orderRecordId: type: string description: 订单ID,店铺订单、工厂订单通用,同一订单的店铺订单、工厂订单的ID一致 orderStatus: type: string description: 工厂订单的状态编码,通过调用获取订单状态字典接口可以获得所有状态编码,注意此处不能使用店铺状态编码 pageIndex: type: integer format: int32 description: 页码,最小值为1,默认值为1 pageSize: type: integer format: int32 description: 分页大小,最小值1,最大值500,默认值50 platformOrderId: type: string description: 工厂订单的唯一ID schemeId: type: string description: 订单关联的方案ID signBeginTime: type: string description: 工厂签收开始时间,格式yyyy-MM-ddHH:mm:ss,当shopOrderId、orderRecordId、orderNo、schemeId、batchNo、submitBeginTime为空时,此字段必传,否则可不传,与signEndTime相差不能超过90天 signEndTime: type: string description: 工厂签收结束时间,格式yyyy-MM-ddHH:mm:ss,当signBeginTime有值时,此值有默认值为当前时间 signUserId: type: string description: 签收订单账号ID(三维家账号ID) signUserName: type: string description: 签收订单账号名(三维家账号名) submitBeginTime: type: string description: 店铺订单提交工厂开始时间,格式yyyy-MM-ddHH:mm:ss,当shopOrderId、orderRecordId、orderNo、schemeId、batchNo、signBeginTime,此字段必传,否则可不传,与submitEndTime相差不能超过90天 submitEndTime: type: string description: 店铺订单提交工厂结束时间,格式yyyy-MM-ddHH:mm:ss,当submitBeginTime有值时,此值有默认值为当前时间 example: batchNo: '' orderNo: '' signUserId: '' orderBy: '' orderStatus: '' pageSize: 0 schemeId: '' likeOrderName: '' submitBeginTime: '' orderRecordId: '' signBeginTime: '' submitEndTime: '' pageIndex: 0 signUserName: '' signEndTime: '' platformOrderId: '' responses: '200': description: 成功 / OK content: application/json: schema: type: object properties: success: type: boolean description: 请求是否成功 / whether the call succeeded code: type: integer description: 结果码 / result code (0 = success) msg: type: string description: 提示信息 / message data: type: object properties: pageIndex: type: integer format: int32 pageSize: type: integer format: int32 recordCount: type: integer format: int32 result: type: array items: type: object properties: batchNo: type: string description: 批次号 cause: type: string description: 补单/售后原因 city: type: string description: 市 color: type: string description: 主材颜色(橡木、白枫....) colorRecordId: type: string description: 主材颜色(橡木、白枫....)的Id colorSeries: type: string description: 颜色系列 consigneeAddress: type: string description: 收货地址 contactRealName: type: string description: 联系人 contactWay: type: string description: 联系方式 createTime: type: string description: 创建订单时间,格式yyyy-MM-ddHH:mm:ss createUser: type: object properties: avatar: type: string description: 设计师头像 mobile: type: string description: 手机号码 name: type: string description: 姓名 nickName: type: string description: 昵称 outUserId: type: string description: 账号绑定的企业系统用户ID userId: type: string description: 三维家用户ID userName: type: string description: 三维家账号 description: 操作用户 customer: type: object properties: customerAddress: type: string description: 客户地址 customerCode: type: string description: 客户编码 customerId: type: string description: 客户ID customerMobile: type: string description: 客户手机 customerName: type: string description: 客户名称 description: 客户信息 deliveryTime: type: string description: 生产发货时间,格式yyyy-MM-ddHH:mm:ss district: type: string description: 区 diyOrderNo: type: string description: 自定义订单号 houseType: type: string description: 楼盘户型 id: type: string description: 工厂订单的ID,如果需要单点登录到三维家订单系统订单详情页时,使用此字段 isOnlyFile: type: string description: 只有附件的订单0-否1-是,只有附件的订单没有3D文件 itemNo: type: string description: 项目号 orderCateCode: type: string description: 订单类别(常规单、样品单、材料单....)的代码 orderCateName: type: string description: 订单类别(常规单、样品单、材料单....) orderCount: type: string description: 工程单数量 orderName: type: string description: 订单名称 orderNo: type: string description: 订单编号 orderRecordId: type: string description: 订单的通用ID,同一订单下店铺订单、工厂订单此值是相同的 orderSquare: type: string description: 订单用量 orderTypeId: type: string description: 订单类型(衣柜,橱柜,系统柜....)的ID orderTypeName: type: string description: 订单类型(衣柜,橱柜,系统柜....) packNum: type: string description: 订单包数 planDeliveryDate: type: string description: 计划交货日期,格式yyyy-MM-ddHH:mm:ss planSetupTime: type: string description: 预约安装时间,格式yyyy-MM-ddHH:mm:ss productTypeCode: type: string description: 产品类型代码(Board=板式,Wood=实木,MoveDoor=移门,CloseDoor掩门) productTypeName: type: string description: 产品类型(板式,实木,移门,掩门) province: type: string description: 省 remark: type: string description: 备注 saleMoney: type: object scheme: type: object properties: createTime: type: string description: 方案创建时间,格式yyyy-MM-ddHH:mm:ss imagePath: type: string description: 方案主图路径 modifyTime: type: string description: 方案最后修改时间,格式yyyy-MM-ddHH:mm:ss schemeId: type: string description: 方案ID schemeName: type: string description: 方案名称 totalArea: type: number format: double description: 方案总面积 description: 订单所关联的方案,从3D创建的订单此字段有值 shopDept: type: object properties: customerCode: type: string description: 部门对应客户部门编码 deptId: type: string description: 部门ID deptName: type: string description: 部门名称 outDeptId: type: string description: 部门所绑定企业系统部门ID,绑定过才有值 storeType: type: integer format: int32 description: 类型0=门店,1=部门 description: 上级部门信息 shopOrgan: type: object properties: organId: type: string description: 企业ID organName: type: string description: 企业名称 description: 部门所属机构信息 signOrgan: type: object properties: organId: type: string description: 企业ID organName: type: string description: 企业名称 description: 部门所属机构信息 signTime: type: string description: 签收时间,格式yyyy-MM-ddHH:mm:ss signUser: type: object properties: avatar: type: string description: 设计师头像 mobile: type: string description: 手机号码 name: type: string description: 姓名 nickName: type: string description: 昵称 outUserId: type: string description: 账号绑定的企业系统用户ID userId: type: string description: 三维家用户ID userName: type: string description: 三维家账号 description: 操作用户 spatialName: type: string description: 空间信息 stateCode: type: string description: 订单状态的代码 stateName: type: string description: 订单状态 submitTime: type: string description: 提交订单时间,格式yyyy-MM-ddHH:mm:ss submitUser: type: object properties: avatar: type: string description: 设计师头像 mobile: type: string description: 手机号码 name: type: string description: 姓名 nickName: type: string description: 昵称 outUserId: type: string description: 账号绑定的企业系统用户ID userId: type: string description: 三维家用户ID userName: type: string description: 三维家账号 description: 操作用户 urgent: type: string description: 加急等级 urgentRecordId: type: string description: 加急等级代码,0=普通,1=加急 description: 获取工厂订单列表结果 example: msg: '' code: 0 data: recordCount: 0 pageSize: 0 result: - shopOrgan: organName: '' organId: '' itemNo: '' orderSquare: '' planSetupTime: '' colorSeries: '' diyOrderNo: '' province: '' stateName: '' productTypeName: '' id: '' consigneeAddress: '' urgentRecordId: '' batchNo: '' orderNo: '' signTime: '' signUser: nickName: '' mobile: '' avatar: '' outUserId: '' userName: '' userId: '' name: '' planDeliveryDate: '' signOrgan: organName: '' organId: '' submitTime: '' submitUser: nickName: '' mobile: '' avatar: '' outUserId: '' userName: '' userId: '' name: '' district: '' shopDept: deptName: '' storeType: 0 deptId: '' customerCode: '' outDeptId: '' stateCode: '' productTypeCode: '' saleMoney: '' color: '' deliveryTime: '' scheme: imagePath: '' schemeName: '' schemeId: '' modifyTime: '' createTime: '' city: '' cause: '' orderTypeId: '' packNum: '' remark: '' orderCateCode: '' isOnlyFile: '' orderRecordId: '' urgent: '' orderName: '' houseType: '' orderCount: '' orderCateName: '' orderTypeName: '' spatialName: '' createTime: '' colorRecordId: '' contactWay: '' contactRealName: '' createUser: nickName: '' mobile: '' avatar: '' outUserId: '' userName: '' userId: '' name: '' customer: customerAddress: '' customerCode: '' customerName: '' customerId: '' customerMobile: '' pageIndex: 0 success: false '401': description: access_token 缺失或已过期 / missing or expired access_token /api/v1/manufacturing/getShopOrderListByPage: post: operationId: apiV1ManufacturingGetShopOrderListByPage summary: 获取门店订单列表接口 tags: - MOS x-source-documentation: https://dev.3vjia.com/document?apiId=474669617277665342 x-documentation-category: MOS系统 / 订单数据 requestBody: required: false content: application/json: schema: type: object properties: batchNo: type: string description: 订单关联的批次号 createBeginTime: type: string description: 店铺订单创建开始时间,格式yyyy-MM-ddHH:mm:ss,当shopOrderId、orderRecordId、orderNo、schemeId、batchNo、submitBeginTime均为空时,此字段必传,否则可不传,与createEndTime相差不能超过90天 createEndTime: type: string description: 店铺订单创建结束时间,格式yyyy-MM-ddHH:mm:ss,当createBeginTime有值时,此值有默认值为当前时间 createUserId: type: string description: 下单员账号ID(三维家账号ID) createUserName: type: string description: 下单员账号名称(三维家账号名) likeOrderName: type: string description: 订单名称,模糊搜索 orderBy: type: string description: 排序方式,具体取值请咨询技术支持 orderNo: type: string description: 订单号 orderRecordId: type: string description: 订单ID,店铺订单、工厂订单通用,同一订单的店铺订单、工厂订单的ID一致 orderStatus: type: string description: 店铺订单的状态编码,通过调用获取订单状态字典接口可以获得所有状态编码,注意此处不能使用工厂状态编码 pageIndex: type: integer format: int32 description: 页码,最小值为1,默认值为1 pageSize: type: integer format: int32 description: 分页大小,最小值1,最大值500,默认值50 schemeId: type: string description: 订单关联的方案ID shopOrderId: type: string description: 店铺订单的唯一ID submitBeginTime: type: string description: 店铺订单提交工厂开始时间,格式yyyy-MM-ddHH:mm:ss,当shopOrderId、orderRecordId、orderNo、schemeId、batchNo、createBeginTime均为空时,此字段必传,否则可不传,与submitEndTime相差不能超过90天 submitEndTime: type: string description: 店铺订单提交工厂结束时间,格式yyyy-MM-ddHH:mm:ss,当submitBeginTime有值时,此值有默认值为当前时间 submitUserId: type: string description: 提交订单人员账号ID(三维家账号ID) submitUserName: type: string description: 提交订单人员账号名称(三维家账号名) example: batchNo: '' createUserId: '' createBeginTime: '' orderNo: '' orderBy: '' orderStatus: '' pageSize: 0 createUserName: '' schemeId: '' likeOrderName: '' submitUserId: '' submitBeginTime: '' orderRecordId: '' submitUserName: '' submitEndTime: '' shopOrderId: '' pageIndex: 0 createEndTime: '' responses: '200': description: 成功 / OK content: application/json: schema: type: object properties: success: type: boolean description: 请求是否成功 / whether the call succeeded code: type: integer description: 结果码 / result code (0 = success) msg: type: string description: 提示信息 / message data: type: object properties: pageIndex: type: integer format: int32 pageSize: type: integer format: int32 recordCount: type: integer format: int32 result: type: array items: type: object properties: batchNo: type: string description: 批次号 cause: type: string description: 补单/售后原因 city: type: string description: 市 color: type: string description: 主材颜色(橡木、白枫....) colorRecordId: type: string description: 主材颜色(橡木、白枫....)的Id colorSeries: type: string description: 颜色系列 consigneeAddress: type: string description: 收货地址 contactRealName: type: string description: 联系人 contactWay: type: string description: 联系方式 createTime: type: string description: 创建订单时间,格式yyyy-MM-ddHH:mm:ss createUser: type: object properties: avatar: type: string description: 设计师头像 mobile: type: string description: 手机号码 name: type: string description: 姓名 nickName: type: string description: 昵称 outUserId: type: string description: 账号绑定的企业系统用户ID userId: type: string description: 三维家用户ID userName: type: string description: 三维家账号 description: 操作用户 customer: type: object properties: customerAddress: type: string description: 客户地址 customerCode: type: string description: 客户编码 customerId: type: string description: 客户ID customerMobile: type: string description: 客户手机 customerName: type: string description: 客户名称 description: 客户信息 deliveryTime: type: string description: 生产发货时间,格式yyyy-MM-ddHH:mm:ss district: type: string description: 区 diyOrderNo: type: string description: 自定义订单号 houseType: type: string description: 楼盘户型 id: type: string description: 店铺订单的ID,如果需要单点登录到三维家订单系统订单详情页时,使用此字段 isOnlyFile: type: string description: 只有附件的订单0-否1-是,只有附件的订单没有3D文件 itemNo: type: string description: 项目号 orderCateCode: type: string description: 订单类别(常规单、样品单、材料单....)的代码 orderCateName: type: string description: 订单类别(常规单、样品单、材料单....) orderCount: type: string description: 工程单数量 orderName: type: string description: 订单名称 orderNo: type: string description: 订单编号 orderRecordId: type: string description: 订单的通用ID,同一订单下店铺订单、工厂订单此值是相同的 orderSquare: type: string description: 订单用量 orderTypeId: type: string description: 订单类型(衣柜,橱柜,系统柜....)的ID orderTypeName: type: string description: 订单类型(衣柜,橱柜,系统柜....) packNum: type: string description: 订单包数 planDeliveryDate: type: string description: 计划交货日期,格式yyyy-MM-ddHH:mm:ss planSetupTime: type: string description: 预约安装时间,格式yyyy-MM-ddHH:mm:ss productTypeCode: type: string description: 产品类型代码(Board=板式,Wood=实木,MoveDoor=移门,CloseDoor掩门) productTypeName: type: string description: 产品类型(板式,实木,移门,掩门) province: type: string description: 省 remark: type: string description: 备注 saleMoney: type: object scheme: type: object properties: createTime: type: string description: 方案创建时间,格式yyyy-MM-ddHH:mm:ss imagePath: type: string description: 方案主图路径 modifyTime: type: string description: 方案最后修改时间,格式yyyy-MM-ddHH:mm:ss schemeId: type: string description: 方案ID schemeName: type: string description: 方案名称 totalArea: type: number format: double description: 方案总面积 description: 订单所关联的方案,从3D创建的订单此字段有值 shopDept: type: object properties: customerCode: type: string description: 部门对应客户部门编码 deptId: type: string description: 部门ID deptName: type: string description: 部门名称 outDeptId: type: string description: 部门所绑定企业系统部门ID,绑定过才有值 storeType: type: integer format: int32 description: 类型0=门店,1=部门 description: 上级部门信息 shopOrgan: type: object properties: organId: type: string description: 企业ID organName: type: string description: 企业名称 description: 部门所属机构信息 signOrgan: type: object properties: organId: type: string description: 企业ID organName: type: string description: 企业名称 description: 部门所属机构信息 signTime: type: string description: 签收时间,格式yyyy-MM-ddHH:mm:ss signUser: type: object properties: avatar: type: string description: 设计师头像 mobile: type: string description: 手机号码 name: type: string description: 姓名 nickName: type: string description: 昵称 outUserId: type: string description: 账号绑定的企业系统用户ID userId: type: string description: 三维家用户ID userName: type: string description: 三维家账号 description: 操作用户 spatialName: type: string description: 空间信息 stateCode: type: string description: 订单状态的代码 stateName: type: string description: 订单状态 submitTime: type: string description: 提交订单时间,格式yyyy-MM-ddHH:mm:ss submitUser: type: object properties: avatar: type: string description: 设计师头像 mobile: type: string description: 手机号码 name: type: string description: 姓名 nickName: type: string description: 昵称 outUserId: type: string description: 账号绑定的企业系统用户ID userId: type: string description: 三维家用户ID userName: type: string description: 三维家账号 description: 操作用户 urgent: type: string description: 加急等级 urgentRecordId: type: string description: 加急等级代码,0=普通,1=加急 description: 获取店铺订单列表结果 example: msg: '' code: 0 data: recordCount: 0 pageSize: 0 result: - shopOrgan: organName: '' organId: '' itemNo: '' orderSquare: '' planSetupTime: '' colorSeries: '' diyOrderNo: '' province: '' stateName: '' productTypeName: '' id: '' consigneeAddress: '' urgentRecordId: '' batchNo: '' orderNo: '' signTime: '' signUser: nickName: '' mobile: '' avatar: '' outUserId: '' userName: '' userId: '' name: '' planDeliveryDate: '' signOrgan: organName: '' organId: '' submitTime: '' submitUser: nickName: '' mobile: '' avatar: '' outUserId: '' userName: '' userId: '' name: '' district: '' shopDept: deptName: '' storeType: 0 deptId: '' customerCode: '' outDeptId: '' stateCode: '' productTypeCode: '' saleMoney: '' color: '' deliveryTime: '' scheme: imagePath: '' schemeName: '' schemeId: '' modifyTime: '' createTime: '' city: '' cause: '' orderTypeId: '' packNum: '' remark: '' orderCateCode: '' isOnlyFile: '' orderRecordId: '' urgent: '' orderName: '' houseType: '' orderCount: '' orderCateName: '' orderTypeName: '' spatialName: '' createTime: '' colorRecordId: '' contactWay: '' contactRealName: '' createUser: nickName: '' mobile: '' avatar: '' outUserId: '' userName: '' userId: '' name: '' customer: customerAddress: '' customerCode: '' customerName: '' customerId: '' customerMobile: '' pageIndex: 0 success: false '401': description: access_token 缺失或已过期 / missing or expired access_token /api/v1/manufacturing/getSupplementOrder: post: operationId: apiV1ManufacturingGetSupplementOrder summary: 获取补单详情接口 tags: - MOS x-source-documentation: https://dev.3vjia.com/document?apiId=475023500105560134 x-documentation-category: MOS系统 / 订单数据 requestBody: required: false content: application/json: schema: type: object properties: recordId: type: string description: 补单ID examples: - 0ce1c4e8fb684548a3aa425a6780rd2b example: recordId: 0ce1c4e8fb684548a3aa425a6780rd2b responses: '200': description: 成功 / OK content: application/json: schema: type: object properties: success: type: boolean description: 请求是否成功 / whether the call succeeded code: type: integer description: 结果码 / result code (0 = success) msg: type: string description: 提示信息 / message data: type: object properties: cause: type: string description: 补单/售后单原因ID causeName: type: string description: 补单/售后单原因 createTime: type: string description: 创建订单时间,格式yyyy-MM-ddHH:mm:ss createUser: type: object properties: avatar: type: string description: 设计师头像 mobile: type: string description: 手机号码 name: type: string description: 姓名 nickName: type: string description: 昵称 outUserId: type: string description: 账号绑定的企业系统用户ID userId: type: string description: 三维家用户ID userName: type: string description: 三维家账号 description: 操作用户 customer: type: object properties: customerAddress: type: string description: 客户地址 customerCode: type: string description: 客户编码 customerId: type: string description: 客户ID customerMobile: type: string description: 客户手机 customerName: type: string description: 客户名称 description: 客户信息 factoryStateName: type: string description: 工厂订单状态名称 factoryStatus: type: string description: 工厂订单状态值 modifyTime: type: string description: 订单最后修改时间,格式yyyy-MM-ddHH:mm:ss orderAttachmentList: type: array items: type: object properties: author: type: string description: 上传人 createTime: type: string description: 上传时间 extendName: type: string description: 附件文件格式 fileGroup: type: string description: 附件的类型 fileId: type: string description: 附件ID fileName: type: string description: 附件名称 filePath: type: string description: 附件的Url地址 fileSize: type: integer format: int32 description: 附件文件大小 description: 补单详情设计附件 orderName: type: string description: 补单名称 orderNo: type: string description: 补单编号 recordId: type: string description: 补单ID remark: type: string description: 备注 shopOrderRecordId: type: string description: 原订单ID shopStateName: type: string description: 门店订单状态名称 shopStatus: type: string description: 门店订单状态值 sourceOrderNo: type: string description: 原订单编号 stateName: type: string description: 订单状态名称 status: type: string description: 订单状态值 example: msg: '' code: 0 data: orderAttachmentList: - fileName: '' extendName: '' author: '' filePath: '' createTime: '' fileSize: 0 fileGroup: '' fileId: '' shopOrderRecordId: '' orderNo: '' causeName: '' factoryStateName: '' cause: '' remark: '' shopStateName: '' factoryStatus: '' recordId: '' shopStatus: '' modifyTime: '' createTime: '' stateName: '' createUser: nickName: '' mobile: '' avatar: '' outUserId: '' userName: '' userId: '' name: '' sourceOrderNo: '' customer: customerAddress: '' customerCode: '' customerName: '' customerId: '' customerMobile: '' orderName: '' status: '' success: false '401': description: access_token 缺失或已过期 / missing or expired access_token /api/v1/manufacturing/queryCreateOrderBatchResult: post: operationId: apiV1ManufacturingQueryCreateOrderBatchResult summary: 获取批次生成结果接口 tags: - MOS x-source-documentation: https://dev.3vjia.com/document?apiId=474670883894562908 x-documentation-category: MOS系统 / 生产批次 requestBody: required: false content: application/json: schema: type: object properties: key: type: string description: 查询令牌,生成批次接口返回的值 examples: - xxx example: key: xxx responses: '200': description: 成功 / OK content: application/json: schema: type: object properties: success: type: boolean description: 请求是否成功 / whether the call succeeded code: type: integer description: 结果码 / result code (0 = success) msg: type: string description: 提示信息 / message data: type: object properties: batchNo: type: string description: 批次号 batchXmlContent: type: string description: 批次拆单xml的Base64字符串 createTime: type: string description: 创建批次时间,格式yyyy-MM-ddHH:mm:ss createUser: type: object properties: avatar: type: string description: 设计师头像 mobile: type: string description: 手机号码 name: type: string description: 姓名 nickName: type: string description: 昵称 outUserId: type: string description: 账号绑定的企业系统用户ID userId: type: string description: 三维家用户ID userName: type: string description: 三维家账号 description: 操作用户 orderList: type: array items: type: object properties: diyOrderNo: type: string description: 自定义订单号 orderName: type: string description: 订单名称 orderNo: type: string description: 订单编号 orderRecordId: type: string description: 订单的通用ID,同一订单下店铺订单、工厂订单此值是相同的 description: 通用的生产订单结构 recordId: type: string description: 批次ID example: msg: '' code: 0 data: batchNo: '' orderList: - orderNo: '' diyOrderNo: '' orderRecordId: '' orderName: '' batchXmlContent: '' recordId: '' createTime: '' createUser: nickName: '' mobile: '' avatar: '' outUserId: '' userName: '' userId: '' name: '' success: false '401': description: access_token 缺失或已过期 / missing or expired access_token /api/v1/manufacturing/signOrder: post: operationId: apiV1ManufacturingSignOrder summary: 工厂签收订单接口 tags: - MOS x-source-documentation: https://dev.3vjia.com/document?apiId=474669617277665338 x-documentation-category: MOS系统 / 订单管理 description: 工厂签收订单接口,适用于接收三维家提交订单推送的情况 requestBody: required: false content: application/json: schema: type: object properties: orderNo: type: string description: 订单号,订单ID、订单号至少传1项,当orderRecordId为空时,orderNo有效 examples: - 63CG19120402 orderRecordId: type: string description: 订单ID,店铺订单、工厂订单通用,同一订单的店铺订单、工厂订单的ID一致,订单ID、订单号至少传1项,当orderRecordId不为空时,将忽略orderNo examples: - F053521B72F34613BEAD2CC8B6279E75 outUserId: type: string description: 操作人-企业账号绑定时使用的企业用户ID,userId、userName、outUserId三个中,outUserId优先级第三 examples: - '123456' userId: type: string description: 操作人-三维家用户ID,userId、userName、outUserId三个中,userId优先级最高 examples: - '1000122456' userName: type: string description: 操作人-三维家账号,userId、userName、outUserId三个中,userName优先级第二 examples: - 3vj123456 example: orderNo: 63CG19120402 outUserId: '123456' userName: 3vj123456 userId: '1000122456' orderRecordId: F053521B72F34613BEAD2CC8B6279E75 responses: '200': description: 成功 / OK content: application/json: schema: type: object properties: success: type: boolean description: 请求是否成功 / whether the call succeeded code: type: integer description: 结果码 / result code (0 = success) msg: type: string description: 提示信息 / message data: type: object properties: createUser: type: object properties: avatar: type: string description: 设计师头像 mobile: type: string description: 手机号码 name: type: string description: 姓名 nickName: type: string description: 昵称 outUserId: type: string description: 账号绑定的企业系统用户ID userId: type: string description: 三维家用户ID userName: type: string description: 三维家账号 description: 操作用户 diyOrderNo: type: string description: 自定义订单号 examples: - A123456 orderCheckFileReadOnlyRedirectUrl: type: string description: 订单审核文件只读模式单点登录重定向地址 examples: - https://admin.3vjia.com/3DLoading?IsRemoveFurniture=1&OpenModel=1&SaveModel=readOnly&SchemeId=50011044&DisOrderId=63210a45bae6406596e0f67743b02865&SubOrderId=70ab1ce72a9e4b809be4b4f43c504dd7 orderCheckFileRedirectUrl: type: string description: 订单审核文件单点登录重定向地址 examples: - https://admin.3vjia.com/3DLoading?IsRemoveFurniture=1&OpenModel=2&SaveModel=Modify&SchemeId=50011044&DisOrderId=63210a45bae6406596e0f67743b02865&SubOrderId=70ab1ce72a9e4b809be4b4f43c504dd7 orderName: type: string description: 订单名称 examples: - 测试订单20200519 orderNo: type: string description: 订单编号 examples: - EMS-63CG19120402 orderRecordId: type: string description: 订单的通用ID,同一订单下店铺订单、工厂订单此值是相同的 examples: - F053521B72F34613BEAD2CC8B6279E75 example: msg: 成功 code: 0 data: orderNo: EMS-63CG19120402 orderCheckFileReadOnlyRedirectUrl: https://admin.3vjia.com/3DLoading?IsRemoveFurniture=1&OpenModel=1&SaveModel=readOnly&SchemeId=50011044&DisOrderId=63210a45bae6406596e0f67743b02865&SubOrderId=70ab1ce72a9e4b809be4b4f43c504dd7 orderCheckFileRedirectUrl: https://admin.3vjia.com/3DLoading?IsRemoveFurniture=1&OpenModel=2&SaveModel=Modify&SchemeId=50011044&DisOrderId=63210a45bae6406596e0f67743b02865&SubOrderId=70ab1ce72a9e4b809be4b4f43c504dd7 diyOrderNo: A123456 orderRecordId: F053521B72F34613BEAD2CC8B6279E75 createUser: nickName: '' mobile: '' avatar: '' outUserId: '' userName: '' userId: '' name: '' orderName: 测试订单20200519 success: true '401': description: access_token 缺失或已过期 / missing or expired access_token /api/v1/manufacturing/submitAndSignOrder: post: operationId: apiV1ManufacturingSubmitAndSignOrder summary: 门店提交订单工厂自动签收接口 tags: - MOS x-source-documentation: https://dev.3vjia.com/document?apiId=474666800987082760 x-documentation-category: MOS系统 / 订单管理 description: 门店提交订单工厂自动签收接口,适用于接收三维家下单推送的情况 requestBody: required: false content: application/json: schema: type: object properties: orderNo: type: string description: 订单号,订单ID、订单号至少传1项,当orderRecordId为空时,orderNo有效 examples: - 63CG19120402 orderRecordId: type: string description: 订单ID,店铺订单、工厂订单通用,同一订单的店铺订单、工厂订单的ID一致,订单ID、订单号至少传1项,当orderRecordId不为空时,将忽略orderNo examples: - F053521B72F34613BEAD2CC8B6279E75 outUserId: type: string description: 操作人-企业账号绑定时使用的企业用户ID,userId、userName、outUserId三个中,outUserId优先级第三 examples: - '123456' userId: type: string description: 操作人-三维家用户ID,userId、userName、outUserId三个中,userId优先级最高 examples: - '1000122456' userName: type: string description: 操作人-三维家账号,userId、userName、outUserId三个中,userName优先级第二 examples: - 3vj123456 example: orderNo: 63CG19120402 outUserId: '123456' userName: 3vj123456 userId: '1000122456' orderRecordId: F053521B72F34613BEAD2CC8B6279E75 responses: '200': description: 成功 / OK content: application/json: schema: type: object properties: success: type: boolean description: 请求是否成功 / whether the call succeeded code: type: integer description: 结果码 / result code (0 = success) msg: type: string description: 提示信息 / message data: type: object properties: createUser: type: object properties: avatar: type: string description: 设计师头像 mobile: type: string description: 手机号码 name: type: string description: 姓名 nickName: type: string description: 昵称 outUserId: type: string description: 账号绑定的企业系统用户ID userId: type: string description: 三维家用户ID userName: type: string description: 三维家账号 description: 操作用户 diyOrderNo: type: string description: 自定义订单号 examples: - A123456 orderCheckFileReadOnlyRedirectUrl: type: string description: 订单审核文件只读模式单点登录重定向地址 examples: - https://admin.3vjia.com/3DLoading?IsRemoveFurniture=1&OpenModel=1&SaveModel=readOnly&SchemeId=50011044&DisOrderId=63210a45bae6406596e0f67743b02865&SubOrderId=70ab1ce72a9e4b809be4b4f43c504dd7 orderCheckFileRedirectUrl: type: string description: 订单审核文件单点登录重定向地址 examples: - https://admin.3vjia.com/3DLoading?IsRemoveFurniture=1&OpenModel=2&SaveModel=Modify&SchemeId=50011044&DisOrderId=63210a45bae6406596e0f67743b02865&SubOrderId=70ab1ce72a9e4b809be4b4f43c504dd7 orderDesignFileRedirectUrl: type: string description: 订单设计文件单点登录重定向地址 examples: - https://admin.3vjia.com/3DLoading?IsRemoveFurniture=1&OpenModel=1&SaveModel=Modify&SchemeId=50011044&DisOrderId=63210a45bae6406596e0f67743b02865&SubOrderId=70ab1ce72a9e4b809be4b4f43c504dd7 orderName: type: string description: 订单名称 examples: - 测试订单20200519 orderNo: type: string description: 订单编号 examples: - EMS-63CG19120402 orderRecordId: type: string description: 订单的通用ID,同一订单下店铺订单、工厂订单此值是相同的 examples: - F053521B72F34613BEAD2CC8B6279E75 example: msg: 'true' code: 0 data: orderNo: EMS-63CG19120402 orderCheckFileReadOnlyRedirectUrl: https://admin.3vjia.com/3DLoading?IsRemoveFurniture=1&OpenModel=1&SaveModel=readOnly&SchemeId=50011044&DisOrderId=63210a45bae6406596e0f67743b02865&SubOrderId=70ab1ce72a9e4b809be4b4f43c504dd7 orderCheckFileRedirectUrl: https://admin.3vjia.com/3DLoading?IsRemoveFurniture=1&OpenModel=2&SaveModel=Modify&SchemeId=50011044&DisOrderId=63210a45bae6406596e0f67743b02865&SubOrderId=70ab1ce72a9e4b809be4b4f43c504dd7 orderDesignFileRedirectUrl: https://admin.3vjia.com/3DLoading?IsRemoveFurniture=1&OpenModel=1&SaveModel=Modify&SchemeId=50011044&DisOrderId=63210a45bae6406596e0f67743b02865&SubOrderId=70ab1ce72a9e4b809be4b4f43c504dd7 diyOrderNo: A123456 orderRecordId: F053521B72F34613BEAD2CC8B6279E75 createUser: nickName: '' mobile: '' avatar: '' outUserId: '' userName: '' userId: '' name: '' orderName: 测试订单20200519 success: true '401': description: access_token 缺失或已过期 / missing or expired access_token /api/v1/manufacturing/submitOrder: post: operationId: apiV1ManufacturingSubmitOrder summary: 门店提交订单接口 tags: - MOS x-source-documentation: https://dev.3vjia.com/document?apiId=474670751249698879 x-documentation-category: MOS系统 / 订单管理 description: 门店提交订单接口,适用于接收三维家下单推送的情况 requestBody: required: false content: application/json: schema: type: object properties: orderNo: type: string description: 订单号,订单ID、订单号至少传1项,当orderRecordId为空时,orderNo有效 examples: - 63CG19120402 orderRecordId: type: string description: 订单ID,店铺订单、工厂订单通用,同一订单的店铺订单、工厂订单的ID一致,订单ID、订单号至少传1项,当orderRecordId不为空时,将忽略orderNo examples: - F053521B72F34613BEAD2CC8B6279E75 outUserId: type: string description: 操作人-企业账号绑定时使用的企业用户ID,userId、userName、outUserId三个中,outUserId优先级第三 examples: - '123456' userId: type: string description: 操作人-三维家用户ID,userId、userName、outUserId三个中,userId优先级最高 examples: - '1000122456' userName: type: string description: 操作人-三维家账号,userId、userName、outUserId三个中,userName优先级第二 examples: - 3vj123456 example: orderNo: 63CG19120402 outUserId: '123456' userName: 3vj123456 userId: '1000122456' orderRecordId: F053521B72F34613BEAD2CC8B6279E75 responses: '200': description: 成功 / OK content: application/json: schema: type: object properties: success: type: boolean description: 请求是否成功 / whether the call succeeded code: type: integer description: 结果码 / result code (0 = success) msg: type: string description: 提示信息 / message data: type: object properties: createUser: type: object properties: avatar: type: string description: 设计师头像 mobile: type: string description: 手机号码 name: type: string description: 姓名 nickName: type: string description: 昵称 outUserId: type: string description: 账号绑定的企业系统用户ID userId: type: string description: 三维家用户ID userName: type: string description: 三维家账号 description: 操作用户 diyOrderNo: type: string description: 自定义订单号 orderDesignFileRedirectUrl: type: string description: 订单设计文件单点登录重定向地址 orderName: type: string description: 订单名称 orderNo: type: string description: 订单编号 orderRecordId: type: string description: 订单的通用ID,同一订单下店铺订单、工厂订单此值是相同的 example: msg: '' code: 0 data: orderNo: '' orderDesignFileRedirectUrl: '' diyOrderNo: '' orderRecordId: '' createUser: nickName: '' mobile: '' avatar: '' outUserId: '' userName: '' userId: '' name: '' orderName: '' success: false '401': description: access_token 缺失或已过期 / missing or expired access_token /api/v1/manufacturing/updateDiyOrderNo: post: operationId: apiV1ManufacturingUpdateDiyOrderNo summary: 修改自定义订单号接口 tags: - MOS x-source-documentation: https://dev.3vjia.com/document?apiId=474667385207488559 x-documentation-category: MOS系统 / 订单管理 requestBody: required: false content: application/json: schema: type: object properties: dealerName: type: string description: 供应商名称 examples: - 白河店 diyOrderNo: type: string description: 自定义订单号,diyOrderNo,itemNo,orderType至少传一个 examples: - A2020120901 itemNo: type: string description: 项目号(合同号),diyOrderNo,itemNo,orderType至少传一个 examples: - HT10289-11G orderNo: type: string description: 订单号,订单ID、订单号至少传1项,当orderRecordId为空时,orderNo有效,外协订单无法使用orderNo查询 examples: - 63CG19120402 orderRecordId: type: string description: 订单ID,店铺订单、工厂订单通用,同一订单的店铺订单、工厂订单的ID一致,订单ID、订单号至少传1项,当orderRecordId不为空时,将忽略orderNo examples: - F053521B72F34613BEAD2CC8B6279E75 orderType: type: string description: 订单类型),diyOrderNo,itemNo,orderType至少传一个 examples: - CG orderTypeName: type: string description: 订单类型名称 examples: - 常规单 thirdOrderInfo: type: string description: 第三方订单信息内容 example: orderType: CG thirdOrderInfo: '' dealerName: 白河店 orderNo: 63CG19120402 itemNo: HT10289-11G diyOrderNo: A2020120901 orderTypeName: 常规单 orderRecordId: F053521B72F34613BEAD2CC8B6279E75 responses: '200': description: 成功 / OK content: application/json: schema: type: object properties: success: type: boolean description: 请求是否成功 / whether the call succeeded code: type: integer description: 结果码 / result code (0 = success) msg: type: string description: 提示信息 / message data: type: object example: msg: 成功 code: 0 data: true success: true '401': description: access_token 缺失或已过期 / missing or expired access_token /api/v1/manufacturing/updateOfferTime: post: operationId: apiV1ManufacturingUpdateOfferTime summary: 修改生产交货时间接口 tags: - MOS x-source-documentation: https://dev.3vjia.com/document?apiId=474642568848707662 x-documentation-category: MOS系统 / 订单管理 description: 修改生产交货时间 requestBody: required: true content: application/json: schema: type: object properties: offerTime: type: string description: 生产交货时间,格式yyyy-MM-dd examples: - '2020-10-10' orderRecordId: type: string description: 订单ID,店铺订单、工厂订单通用,同一订单的店铺订单、工厂订单的ID一致,订单ID、订单号至少传1项,当orderRecordId不为空时,将忽略orderNo examples: - F053521B72F34613BEAD2CC8B6279E75 required: - offerTime - orderRecordId example: offerTime: '2020-10-10' orderRecordId: F053521B72F34613BEAD2CC8B6279E75 responses: '200': description: 成功 / OK content: application/json: schema: type: object properties: success: type: boolean description: 请求是否成功 / whether the call succeeded code: type: integer description: 结果码 / result code (0 = success) msg: type: string description: 提示信息 / message data: type: object example: msg: success code: 0 data: true success: true '401': description: access_token 缺失或已过期 / missing or expired access_token /api/v1/manufacturing/updateOrderState: post: operationId: apiV1ManufacturingUpdateOrderState summary: 变更订单状态接口 tags: - MOS x-source-documentation: https://dev.3vjia.com/document?apiId=474667385207488561 x-documentation-category: MOS系统 / 订单管理 description: 变更订单状态,只允许变更为几种指定的状态,此接口只变更状态,不做状态流程上的校验 requestBody: required: false content: application/json: schema: type: object properties: deptName: type: string description: 操作人所属门店/工厂/部门名称,记录用 examples: - 橱柜工厂A operatorUserId: type: string description: 操作用户ID,记录用,传企业系统的即可 examples: - '123456' operatorUserName: type: string description: 操作用户名称,记录用,传企业系统的即可 examples: - xx orderRecordId: type: string description: 三维家订单ID examples: - F053521B72F34613BEAD2CC8B6279E75 orderState: type: integer format: int32 description: 订单状态1已付款2已生成批次、3已开料、4已封边、5已开孔、6已试装、7已修色、8已入库、9已发货、10已完成11已取消12已退回13回退上一个节点 examples: - '1' remark: type: string description: 备注 examples: - 测试备注 example: deptName: 橱柜工厂A remark: 测试备注 orderState: 1 operatorUserId: '123456' orderRecordId: F053521B72F34613BEAD2CC8B6279E75 operatorUserName: xx responses: '200': description: 成功 / OK content: application/json: schema: type: object properties: success: type: boolean description: 请求是否成功 / whether the call succeeded code: type: integer description: 结果码 / result code (0 = success) msg: type: string description: 提示信息 / message data: type: object example: msg: 成功 code: 0 data: true success: true '401': description: access_token 缺失或已过期 / missing or expired access_token /api/v1/manufacturingOrder/getProductionXml: post: operationId: apiV1ManufacturingOrderGetProductionXml summary: 获取订单拆单XML接口 tags: - MOS x-source-documentation: https://dev.3vjia.com/document?apiId=453652651356258342 x-documentation-category: MOS系统 / 订单数据 requestBody: required: false content: application/json: schema: type: object properties: isDesignXml: type: boolean description: 是否设计XML:false-工厂接单拆单XML;true-下单设计XML;不传默认为false examples: - 'false' orderNo: type: string description: 订单号,订单ID、订单号至少传1项,当orderRecordId为空时,orderNo有效,外协订单无法使用orderNo查询 examples: - 63CG19120402 orderRecordId: type: string description: 订单ID,店铺订单、工厂订单通用,同一订单的店铺订单、工厂订单的ID一致,订单ID、订单号至少传1项,当orderRecordId不为空时,将忽略orderNo examples: - F053521B72F34613BEAD2CC8B6279E75 example: orderNo: 63CG19120402 isDesignXml: false orderRecordId: F053521B72F34613BEAD2CC8B6279E75 responses: '200': description: 成功 / OK content: application/json: schema: type: object properties: success: type: boolean description: 请求是否成功 / whether the call succeeded code: type: integer description: 结果码 / result code (0 = success) msg: type: string description: 提示信息 / message data: type: object properties: createUser: type: object properties: avatar: type: string description: 设计师头像 examples: - https://img3.admin.3vjia.com/UpFile/C00005842/ADMIN/UserSetting/202005/1001266879/89faef49527140eb883d7a5190c0048a.jpg mobile: type: string description: 手机号码 examples: - '13800000000' name: type: string description: 姓名 examples: - 小蔡 nickName: type: string description: 昵称 examples: - 小蔡 outUserId: type: string description: 账号绑定的企业系统用户ID examples: - '123456' userId: type: string description: 三维家用户ID examples: - '1000123456' userName: type: string description: 三维家账号 examples: - 3vj13800000000 description: 操作用户 diyOrderNo: type: string description: 自定义订单号 examples: - A123456 orderName: type: string description: 订单名称 examples: - 测试订单20200519 orderNo: type: string description: 订单编号 examples: - EMS-63CG19120402 orderRecordId: type: string description: 订单的通用ID,同一订单下店铺订单、工厂订单此值是相同的 examples: - F053521B72F34613BEAD2CC8B6279E75 xmlContent: type: string description: 拆单xml的Base64字符串 examples: - Jmx0O1Jvb3QgQXBwbGljYXRpb249Ildvb2RNYWNoaW5lIiBBcHBsaWNhdGlvblZlcnNpb249IjMuMCIgdmVyc2lvbj0iMy4wLjExLjMzNzUiJmd0Ow0KJmx0Oy9Sb290Jmd0Ow== example: msg: '' code: 0 data: orderNo: EMS-63CG19120402 diyOrderNo: A123456 orderRecordId: F053521B72F34613BEAD2CC8B6279E75 createUser: nickName: 小蔡 mobile: '13800000000' avatar: https://img3.admin.3vjia.com/UpFile/C00005842/ADMIN/UserSetting/202005/1001266879/89faef49527140eb883d7a5190c0048a.jpg outUserId: '123456' userName: 3vj13800000000 userId: '1000123456' name: 小蔡 xmlContent: Jmx0O1Jvb3QgQXBwbGljYXRpb249Ildvb2RNYWNoaW5lIiBBcHBsaWNhdGlvblZlcnNpb249IjMuMCIgdmVyc2lvbj0iMy4wLjExLjMzNzUiJmd0Ow0KJmx0Oy9Sb290Jmd0Ow== orderName: 测试订单20200519 success: false '401': description: access_token 缺失或已过期 / missing or expired access_token /api/v1/material/deleteMaterial: post: operationId: apiV1MaterialDeleteMaterial summary: 删除素材接口 tags: - Products x-source-documentation: https://dev.3vjia.com/document?apiId=474672016889319484 x-documentation-category: 产品模块 / 素材管理 description: 删除素材 requestBody: required: false content: application/json: schema: type: object properties: materialId: type: string description: 要编辑的素材ID examples: - '57978944' example: materialId: '57978944' responses: '200': description: 成功 / OK content: application/json: schema: type: object properties: success: type: boolean description: 请求是否成功 / whether the call succeeded code: type: integer description: 结果码 / result code (0 = success) msg: type: string description: 提示信息 / message data: type: object example: msg: 成功 code: 0 data: true success: true '401': description: access_token 缺失或已过期 / missing or expired access_token /api/v1/material/listByPage: post: operationId: apiV1MaterialListByPage summary: 分页查询素材数据接口 tags: - Products x-source-documentation: https://dev.3vjia.com/document?apiId=591308101605548077 x-documentation-category: 产品模块 / 素材数据 description: "## 素材类型(modelFlag)传值说明\n| 成品类 | 全屋定制 | 硬装定制 |\n| --- | --- |--- | \n| 1 = 模型 | 10 = 衣柜 | 14 = 铺砖 |\n| 2 = 贴图 |11 = 橱柜 | 18 = 顶墙 |\n| 3 = 门窗 |12 = 系统柜 | 25 = 水电 |\n| 4 = 替换材质 |23 = 浴室柜 | 36 = 涂料 |\n| 15 = 模型组合 |24 = 淋浴房 | |\n| 37 = 自由建模 |13 = 卫浴 | |\n| |17 = 整木 | |\n| |28 = 铝门窗 | |\n| |22 = 定制通用 | |" requestBody: required: true content: application/json: schema: type: object properties: brandId: type: integer format: int32 description: 品牌ID categoryId: type: integer format: int32 description: 分类ID categoryIds: type: array items: {} description: 分类ID列表 current: type: integer format: int64 description: 当前查询第几页 endPostTime: type: string format: date-time description: 上传结束时间 is3d: type: integer format: int32 description: 3D启用状态:0=未启用,1=已启用 isDelete: type: integer format: int32 description: 是否删除:0=否,1=是 materialId: type: string description: 素材编号 materialName: type: string description: 素材名称 materialType: type: integer format: int32 description: 模型类别:0=模型,1=贴图,2=线条,3=方案,4=水刀,其中成品类素材无需传值 modelFlag: type: integer format: int32 description: 素材类型,参考上面的说明 modelFlags: type: array items: {} description: 素材类型集合,参考上面的说明 name: type: string description: 用户姓名 organType: type: integer format: int32 description: 归属:0=企业素材,1=门店素材,2=个人素材 size: type: integer format: int64 description: 当前查询页记录数 sort: type: array items: type: object properties: ascending: type: boolean description: 字段排序规则 normalized: type: boolean description: 是否已经规范化,即字段名与数据库字段已经一致,false的时候会将驼峰转下划线 property: type: string description: 根据哪个字段进行排序 description: 排序定义 startPostTime: type: string format: date-time description: 上传开始时间 username: type: string description: 账号名称 required: - current - organType - size example: isDelete: 0 materialType: 0 is3d: 0 modelFlags: [] sort: - normalized: false ascending: false property: '' materialId: '' materialName: '' categoryIds: [] current: 0 modelFlag: 0 size: 0 endPostTime: '' brandId: 0 name: '' organType: 0 startPostTime: '' categoryId: 0 username: '' responses: '200': description: 成功 / OK content: application/json: schema: type: object properties: success: type: boolean description: 请求是否成功 / whether the call succeeded code: type: integer description: 结果码 / result code (0 = success) msg: type: string description: 提示信息 / message data: type: object properties: current: type: integer format: int64 description: 当前查询第几页 records: type: array items: type: object properties: atlasId: type: string description: AI图谱id auditComments: type: string description: 审核意见 author: type: string description: 上传用户ID authorName: type: string description: 上传用户真实名称 authorUserName: type: string description: 上传用户账号名称 brandId: type: integer format: int32 description: 品牌ID brandName: type: string description: 品牌名称 categoryTree: type: object properties: categoryId: type: integer format: int32 description: 分类ID categoryName: type: string description: 分类名称 child: type: object description: 素材分类路径 isShow: type: integer format: int32 description: 是否显示 description: 素材分类路径 classification: type: integer format: int32 contributeStatus: type: integer format: int32 description: 投稿状态:1-待审核,2-已通过,3-不通过 designCode: type: string imagePath: type: string description: 主图 is3d: type: integer format: int32 description: 3D启用状态 is3dDesc: type: string description: 3D启用状态描述 isCopied: type: integer format: int32 description: 复制状态(-1:未复制,0:待复制,1:已复制,2:可更新,3:复制中) isCustomMaterialBall: type: integer format: int32 description: 是否企业材质球:0-否,1-是 isLock: type: integer format: int32 description: 是否锁定:0-否,1-是 materialAttribute: type: string description: 素材属性 materialAttributeTree: type: object properties: child: type: object description: 素材属性关联对象 materialAttribute: type: string description: 素材属性名称 materialAttributeId: type: string description: 素材属性id description: 素材属性关联对象 materialBallType: type: integer format: int32 description: 是否新版材质:1-旧材质,2-新材质 materialCategory: type: string description: 材料分类 materialCategoryList: type: array items: type: object properties: categoryId: type: integer format: int32 description: 分类id categoryName: type: string description: 分类名称 childNodes: type: array items: {} description: 分类标签出参 isShow: type: integer format: int32 description: 是否显示 1显示 0隐藏 description: 分类标签出参 materialCategoryName: type: string description: 材料分类名称 materialId: type: string description: 素材ID materialName: type: string description: 素材名称 modifyTime: type: string format: date-time description: 修改时间 modifyUserId: type: string description: 修改用户ID modifyUserName: type: string description: 修改用户账号名 modifyUserRealName: type: string description: 修改用户真实名称 placeRule: type: string description: 放置规则 placeRuleName: type: string description: 放置规则名称 postTime: type: string format: date-time description: 上传时间 property: type: string description: 材质属性 propertyName: type: string description: 材质属性名称 seriesId: type: string description: 系列ID seriesName: type: string description: 系列名称 sortNumber: type: integer format: int32 description: 序号 tags: type: array items: type: object properties: id: type: integer format: int32 description: 关联ID tagId: type: integer format: int32 description: 标签ID tagName: type: string description: 标签名称 description: 标签 description: 素材 size: type: integer format: int64 description: 当前查询页记录数 total: type: integer format: int64 description: 总数 required: - current - size - total example: msg: '' code: 0 data: records: - imagePath: '' modifyUserRealName: '' sortNumber: 0 atlasId: '' modifyUserId: '' is3d: 0 materialCategoryList: - childNodes: [] categoryName: '' isShow: 0 categoryId: 0 seriesId: '' auditComments: '' isLock: 0 materialAttributeTree: materialAttribute: '' materialAttributeId: '' child: '' modifyUserName: '' postTime: '' modifyTime: '' property: '' materialBallType: 0 categoryTree: categoryName: '' isShow: 0 categoryId: 0 child: '' is3dDesc: '' brandName: '' isCopied: 0 placeRuleName: '' author: '' seriesName: '' isCustomMaterialBall: 0 contributeStatus: 0 classification: 0 materialId: '' materialAttribute: '' materialCategory: '' tags: - tagId: 0 tagName: '' id: 0 materialName: '' placeRule: '' propertyName: '' authorName: '' brandId: 0 authorUserName: '' materialCategoryName: '' designCode: '' current: 0 total: 0 size: 0 success: false '401': description: access_token 缺失或已过期 / missing or expired access_token /api/v1/material/receiveOuterMaterialContent: post: operationId: apiV1MaterialReceiveOuterMaterialContent summary: 接收外网模型文件接口 tags: - Products x-source-documentation: https://dev.3vjia.com/document?apiId=513050275490115608 x-documentation-category: 产品模块 / 素材管理 requestBody: required: true content: application/json: schema: type: object properties: materialFilePath: type: string description: 素材文件路径 outerMaterialId: type: string description: 第三方素材id outerMaterialSource: type: string description: 第三方素材来源,欧模:om required: - materialFilePath - outerMaterialId - outerMaterialSource example: materialFilePath: '' outerMaterialId: '' outerMaterialSource: '' responses: '200': description: 成功 / OK content: application/json: schema: type: object properties: success: type: boolean description: 请求是否成功 / whether the call succeeded code: type: integer description: 结果码 / result code (0 = success) msg: type: string description: 提示信息 / message data: type: object example: msg: '' code: 0 success: false '401': description: access_token 缺失或已过期 / missing or expired access_token /api/v1/material/updateMaterialAndProduct: post: operationId: apiV1MaterialUpdateMaterialAndProduct summary: 编辑素材和商品接口 tags: - Products x-source-documentation: https://dev.3vjia.com/document?apiId=475005267981971501 x-documentation-category: 产品模块 / 素材管理 description: 编辑素材和商品,只传入需要变更的值 requestBody: required: false content: application/json: schema: type: object properties: categoryId: type: string description: 自定义分类,必填,素材必须有所属分类 color: type: string description: 颜色,102019=银色,18935=白色,19654=米色,19649=黄色,19651=橘色,19648=红色,19646=粉色,18936=绿色,19653=蓝色,19656=紫色,19658=彩色,19647=黑色,19652=咖啡色,19650=灰色 detail: type: string description: 详细 is3d: type: integer format: int32 description: 3D是否可见0=不可见,1=可见 isHasProduct: type: integer format: int32 description: 是否有商品,0=没有,1=有 lightProperty: type: string description: 灯光属性(太阳光类、射灯类、台灯吊灯类的设置,非必须),BallLight=球灯灯光属性,TableLamp=台灯灯光属性,CeilingLight=吊灯灯光属性,Vertical_NoDecayLight=不衰减面光属性 materialId: type: string description: 素材ID materialName: type: string description: 素材名称 materialType: type: string description: 素材类别,SingleDoor=单开门,DoubleDoor=双开门,CommonWindow=普通窗,BayWindow=飘窗,LBayWindow=L型飘窗,SlidingDoor=移门,SafetyDoor=防盗门,DoorHole=门洞,Pillar=柱子,Platform=地台,Beam=横梁,SprungRoof=吊顶,Furniture=家具类,SprungRoofPave=吊顶铺贴类,Balcony=阳台类,SunLight=太阳光类,SpotLight=射灯类,FlushToilet=异形开洞类,PlaneWaterJet=平面水刀,ChanDelier=台灯吊灯类,WaterElectric=水电 model: type: string description: 型号 placeRule: type: string description: 放置规则,吊顶、家具类、射灯类、异形开洞类、平面水刀、台灯吊灯类、水电需要传,free=自由放置,stickFloor=落地自由移动,floor=落地中央移动,onFloorAdsorb=落地贴墙移动,desktop=叠加放置,top=吸顶,wall=墙上,ceiling=天花 productName: type: string description: 商品名称 property: type: string description: 材质属性,枚举值较多,请联系技术支持获取枚举值 specifications: type: string description: 规格 status: type: integer format: int32 description: 0下架1上架 style: type: string description: 风格,873421=北欧,15878=现代,15880=中式,7269938=轻奢,15881=欧式,15913=美式,5615919=日式,15879=田园,873422=工业,7269937=新中式,18909=地中海,873425=东南亚,18418=新古典 unit: type: string description: 计价单位,bag=袋,bucket=桶,dab=盏,doorframe=樘,fan=扇,fu=幅,group=组,juan=卷,kg=公斤,lump=块,meter=米,piece=片,pin=瓶,rise=升,root=根,set=套,single=个,sqm=平米,stage=台,zhang=张 retailPrice: type: number format: double description: 零售价 salePrice: type: integer format: int32 description: 本网特价 shopPrice: type: integer format: int32 description: 本网最低价 skuList: type: array items: type: object properties: costPrice: type: object description: 出厂价 isDefault: type: integer format: int32 description: 是否默认sku price: type: object description: 售价 productLevel: type: string description: 产品等级 retailPrice: type: object description: 市场价 sku: type: string description: sku编码 description: 商品sku的结构 example: isHasProduct: 0 lightProperty: '' skuList: - costPrice: '' isDefault: 0 productLevel: '' price: '' sku: '' retailPrice: '' color: '' salePrice: 0 materialType: '' is3d: 0 materialId: '' specifications: '' productName: '' materialName: '' placeRule: '' unit: '' shopPrice: 0 property: '' model: '' style: '' detail: '' categoryId: '' status: 0 responses: '200': description: 成功 / OK content: application/json: schema: type: object properties: success: type: boolean description: 请求是否成功 / whether the call succeeded code: type: integer description: 结果码 / result code (0 = success) msg: type: string description: 提示信息 / message data: type: object example: msg: '' code: 0 data: true success: true '401': description: access_token 缺失或已过期 / missing or expired access_token /api/v1/material/updateMaterialImage: post: operationId: apiV1MaterialUpdateMaterialImage summary: 编辑素材主图接口 tags: - Products x-source-documentation: https://dev.3vjia.com/document?apiId=475025003306364933 x-documentation-category: 产品模块 / 素材管理 description: 编辑素材主图 requestBody: required: false content: application/json: schema: type: object properties: fileContent: type: string description: 图片Base64字符;建议图片比例1:1,大小不超过1M;贴图主图:大小不超过5M examples: - iVBORw0KGgoAAAANSUhEUgAAAMgAAADICAYAAACtWKJggg== fileName: type: string description: 文件名 examples: - 贴图主图 materialFlag: type: integer format: int32 description: 素材类型,1=模型,2=贴图; examples: - '1' materialId: type: string description: 素材ID examples: - '123456' suffix: type: string description: 图片格式(JPG,JPEG,PNG) examples: - JPG example: fileName: 贴图主图 materialFlag: 1 materialId: '123456' suffix: JPG fileContent: iVBORw0KGgoAAAANSUhEUgAAAMgAAADICAYAAACtWKJggg== responses: '200': description: 成功 / OK content: application/json: schema: type: object properties: success: type: boolean description: 请求是否成功 / whether the call succeeded code: type: integer description: 结果码 / result code (0 = success) msg: type: string description: 提示信息 / message data: type: object example: msg: '' code: 0 data: true success: true '401': description: access_token 缺失或已过期 / missing or expired access_token /api/v1/material/updateMaterialStatus: post: operationId: apiV1MaterialUpdateMaterialStatus summary: 编辑素材状态接口 tags: - Products x-source-documentation: https://dev.3vjia.com/document?apiId=475005267981971497 x-documentation-category: 产品模块 / 素材管理 description: 编辑成品素材3D是否可见状态,仅限于成品素材 requestBody: required: false content: application/json: schema: type: object properties: is3d: type: integer format: int32 description: 3D是否可见(仅限于成品素材),0=不可见,1=可见 examples: - '1' materialId: type: string description: 要编辑的素材ID examples: - '57978944' example: is3d: 1 materialId: '57978944' responses: '200': description: 成功 / OK content: application/json: schema: type: object properties: success: type: boolean description: 请求是否成功 / whether the call succeeded code: type: integer description: 结果码 / result code (0 = success) msg: type: string description: 提示信息 / message data: type: object example: msg: 成功 code: 0 data: true success: true '401': description: access_token 缺失或已过期 / missing or expired access_token /api/v1/material/updateProductStatus: post: operationId: apiV1MaterialUpdateProductStatus summary: 编辑商品状态接口 tags: - Products x-source-documentation: https://dev.3vjia.com/document?apiId=475023500105560130 x-documentation-category: 产品模块 / 素材管理 description: 编辑商品上下架状态接口,会影响商品外链 requestBody: required: false content: application/json: schema: type: object properties: materialId: type: string description: 商品关联的素材ID,materialId和productSku至少传1个,传了materialId将忽略productSku examples: - '57978944' productSku: type: string description: 商品Sku,materialId和productSku至少传1个,materialId为空时productSku有效 examples: - A123456 productStatus: type: integer format: int32 description: 商品是否上架3D(仅限于成品素材),0=下架,1=上架 examples: - '1' example: productStatus: 1 materialId: '57978944' productSku: A123456 responses: '200': description: 成功 / OK content: application/json: schema: type: object properties: success: type: boolean description: 请求是否成功 / whether the call succeeded code: type: integer description: 结果码 / result code (0 = success) msg: type: string description: 提示信息 / message data: type: object example: msg: 成功 code: 0 data: true success: true '401': description: access_token 缺失或已过期 / missing or expired access_token /api/v1/materialBatchSetting/setIs3d: post: operationId: apiV1MaterialBatchSettingSetIs3d summary: 批量设置素材3D启用状态 tags: - Products x-source-documentation: https://dev.3vjia.com/document?apiId=825312689340452911 x-documentation-category: 产品模块 / 素材管理 description: 素材设为启用后,可以在3D云设计中使用该素材。 requestBody: required: true content: application/json: schema: type: object properties: is3d: type: integer format: int32 description: 3D启用状态:0=禁用,1=启用 materialIds: type: array items: {} description: 素材ID列表 moduleName: type: string description: 模块名称,当前操作的模块,如全屋定制衣柜模型、全屋定制衣柜贴图等 required: - is3d - materialIds example: moduleName: '' is3d: 0 materialIds: [] responses: '200': description: 成功 / OK content: application/json: schema: type: object properties: success: type: boolean description: 请求是否成功 / whether the call succeeded code: type: integer description: 结果码 / result code (0 = success) msg: type: string description: 提示信息 / message data: type: object example: msg: '' code: 0 data: false success: false '401': description: access_token 缺失或已过期 / missing or expired access_token /api/v1/materialCategory/addMaterialCategory: post: operationId: apiV1MaterialCategoryAddMaterialCategory summary: 添加素材分类接口 tags: - Products x-source-documentation: https://dev.3vjia.com/document?apiId=474673567347347500 x-documentation-category: 产品模块 / 素材分类 description: 添加素材分类 requestBody: required: false content: application/json: schema: type: object properties: activated: type: integer format: int32 description: 启用状态1启用,0未启用 categoryCode: type: string description: 分类代码 examples: - wardrobeFront categoryName: type: string description: 分类名称 examples: - 前台 categoryType: type: string description: 分类类型,wardrobeAll=衣柜,cupboardAll=橱柜,systemCabinetAll=系统柜,UniversalAll=通用后台库,UniversalMaterial=通用材质库,bathCabinetAll=浴室柜,bathRoomAll=淋浴房,doorWindowAll=整木,aluminumAll=铝门窗,showerRoomAll=卫浴,brickSystemAll=铺砖,ceilingAll=顶墙,waterElectricAll=水电,brushingAll=涂料,Furniture=成品 examples: - wardrobeAll parentId: type: string description: 父级ID examples: - '100386075' sortCode: type: integer format: int32 description: 排序号 examples: - '0' example: categoryCode: wardrobeFront categoryName: 前台 sortCode: 0 parentId: '100386075' categoryType: wardrobeAll activated: 0 responses: '200': description: 成功 / OK content: application/json: schema: type: object properties: success: type: boolean description: 请求是否成功 / whether the call succeeded code: type: integer description: 结果码 / result code (0 = success) msg: type: string description: 提示信息 / message data: type: object properties: categoryCode: type: string description: 分类代码 categoryId: type: string description: 分类ID categoryName: type: string description: 分类名称 categoryType: type: string description: 分类类型,wardrobeAll=衣柜,cupboardAll=橱柜,systemCabinetAll=系统柜,UniversalAll=通用后台库,UniversalMaterial=通用材质库,bathCabinetAll=浴室柜,bathRoomAll=淋浴房,doorWindowAll=整木,aluminumAll=铝门窗,showerRoomAll=卫浴,brickSystemAll=铺砖,ceilingAll=顶墙,waterElectricAll=水电,brushingAll=涂料,Furniture=成品 categoryTypeName: type: string description: 分类类型名称 children: type: array items: {} description: 素材分类结果,V2 module: type: string description: 分类模块类型 parentId: type: string description: 父级ID shopId: type: string description: 三维家门店ID sortCode: type: integer format: int32 description: 排序号 example: msg: 成功 code: 0 data: module: '' categoryCode: '' categoryName: '' sortCode: 0 parentId: '' categoryType: '' children: [] categoryTypeName: '' shopId: '' categoryId: '' success: true '401': description: access_token 缺失或已过期 / missing or expired access_token /api/v1/materialCategory/getMaterialCategory: post: operationId: apiV1MaterialCategoryGetMaterialCategory summary: 获取素材分类信息接口 tags: - Products x-source-documentation: https://dev.3vjia.com/document?apiId=474672236729569286 x-documentation-category: 产品模块 / 素材分类 description: 获取素材分类信息 requestBody: required: false content: application/json: schema: type: object properties: categoryId: type: string description: 分类ID examples: - '100381008' example: categoryId: '100381008' responses: '200': description: 成功 / OK content: application/json: schema: type: object properties: success: type: boolean description: 请求是否成功 / whether the call succeeded code: type: integer description: 结果码 / result code (0 = success) msg: type: string description: 提示信息 / message data: type: object properties: categoryCode: type: string description: 分类代码 categoryId: type: string description: 分类ID categoryName: type: string description: 分类名称 categoryType: type: string description: 分类类型,wardrobeAll=衣柜,cupboardAll=橱柜,systemCabinetAll=系统柜,UniversalAll=通用后台库,UniversalMaterial=通用材质库,bathCabinetAll=浴室柜,bathRoomAll=淋浴房,doorWindowAll=整木,aluminumAll=铝门窗,showerRoomAll=卫浴,brickSystemAll=铺砖,ceilingAll=顶墙,waterElectricAll=水电,brushingAll=涂料,Furniture=成品 categoryTypeName: type: string description: 分类类型名称 children: type: array items: {} description: 素材分类结果,V2 module: type: string description: 分类模块类型 parentId: type: string description: 父级ID shopId: type: string description: 三维家门店ID sortCode: type: integer format: int32 description: 排序号 example: msg: '' code: 0 data: module: '' categoryCode: '' categoryName: '' sortCode: 0 parentId: '' categoryType: '' children: [] categoryTypeName: '' shopId: '' categoryId: '' success: false '401': description: access_token 缺失或已过期 / missing or expired access_token /api/v1/materialCategory/getShopMaterialCategoryList: post: operationId: apiV1MaterialCategoryGetShopMaterialCategoryList summary: 获取门店素材分类列表接口 tags: - Products x-source-documentation: https://dev.3vjia.com/document?apiId=474672016889319482 x-documentation-category: 产品模块 / 素材分类 description: 获取门店素材分类列表 requestBody: required: false content: application/json: schema: type: object properties: module: type: string description: 分类模块类型:CategorySort(门店成品模型分类)/ShpoChartlet(门店成品贴图分类) examples: - CategorySort pageIndex: type: integer format: int32 description: 页码,最小值为1,默认值为1 examples: - '1' pageSize: type: integer format: int32 description: 分页大小,最小值1,最大值500,默认值50 examples: - '50' shopId: type: string description: 三维家门店ID examples: - '0123456' example: module: CategorySort pageSize: 50 pageIndex: 1 shopId: '0123456' responses: '200': description: 成功 / OK content: application/json: schema: type: object properties: success: type: boolean description: 请求是否成功 / whether the call succeeded code: type: integer description: 结果码 / result code (0 = success) msg: type: string description: 提示信息 / message data: type: object properties: categoryCode: type: string description: 分类代码 categoryId: type: string description: 分类ID categoryName: type: string description: 分类名称 children: type: array items: {} description: 门店素材分类结果,V2 module: type: string description: 分类模块类型 parentId: type: string description: 父级ID shopId: type: string description: 三维家门店ID sortCode: type: integer format: int32 description: 排序号 example: msg: '' code: 0 data: - module: '' categoryCode: '' categoryName: '' sortCode: 0 parentId: '' children: [] shopId: '' categoryId: '' success: false '401': description: access_token 缺失或已过期 / missing or expired access_token /api/v1/materialDict/brandSeries: post: operationId: apiV1MaterialDictBrandSeries summary: 根据品牌id获取系列列表 tags: - Products x-source-documentation: https://dev.3vjia.com/document?apiId=842345786061766684 x-documentation-category: 产品模块 / 素材数据 description: 根据品牌id获取系列列表 requestBody: required: true content: application/json: schema: type: object properties: brandId: type: integer format: int64 description: 品牌ID required: - brandId example: brandId: 0 responses: '200': description: 成功 / OK content: application/json: schema: type: object properties: success: type: boolean description: 请求是否成功 / whether the call succeeded code: type: integer description: 结果码 / result code (0 = success) msg: type: string description: 提示信息 / message data: type: object properties: key: type: string description: 键 value: type: string description: 值 example: msg: '' code: 0 data: - value: '' key: '' success: false '401': description: access_token 缺失或已过期 / missing or expired access_token /api/v1/materialDict/brands: post: operationId: apiV1MaterialDictBrands summary: 获取素材品牌列表 tags: - Products x-source-documentation: https://dev.3vjia.com/document?apiId=842343918094925841 x-documentation-category: 产品模块 / 素材数据 description: 获取企业素材品牌列表 responses: '200': description: 成功 / OK content: application/json: schema: type: object properties: success: type: boolean description: 请求是否成功 / whether the call succeeded code: type: integer description: 结果码 / result code (0 = success) msg: type: string description: 提示信息 / message data: type: object properties: brandId: type: integer format: int64 description: 品牌ID brandName: type: string description: 品牌名称 categoryId: type: string description: 分类ID example: msg: '' code: 0 data: - brandName: '' brandId: 0 categoryId: '' success: false '401': description: access_token 缺失或已过期 / missing or expired access_token /api/v1/materialDict/commonCategories: post: operationId: apiV1MaterialDictCommonCategories summary: 通用分类(部件属性等) tags: - Products x-source-documentation: https://dev.3vjia.com/document?apiId=846785686068678805 x-documentation-category: 产品模块 / 素材分类 description: "通用分类,(部件属性等);先根据categoryCode查询第一级分类,然后再指定parentId来查询下一级的分类;\n其中,每个模块的categoryCode不一样,下面列举了各个模块部件属性的部件categoryCode\n照明部件属性:illuminationParts\n通用部件属性:currencyParts\n衣柜部件属性:wardrobeParts\n橱柜部件属性:cupboardParts\n系统柜部件属性\t:systemCabinetParts\n卫浴部件属性:showerRoomParts\n浴室柜部件属性\t:bathCabinetParts\n淋浴房部件属性:bathRoomParts\n整木部件属性:doorWindowParts\n整木部件类型属性:doorWindowUnitType\n铝门窗部件属性:aluminumParts" requestBody: required: false content: application/json: schema: type: object properties: categoryCode: type: string description: 分类代码 parentId: type: integer format: int32 description: 父分类ID example: categoryCode: '' parentId: 0 responses: '200': description: 成功 / OK content: application/json: schema: type: object properties: success: type: boolean description: 请求是否成功 / whether the call succeeded code: type: integer description: 结果码 / result code (0 = success) msg: type: string description: 提示信息 / message data: type: object properties: code: type: string description: 分类代码 key: type: string description: 分类ID value: type: string description: 分类名称 example: msg: '' code: 0 data: - code: '' value: '' key: '' success: false '401': description: access_token 缺失或已过期 / missing or expired access_token /api/v1/materialDict/customNewMaterialCategories: post: operationId: apiV1MaterialDictCustomNewMaterialCategories summary: 获取企业自定义材质分类接口 tags: - Products x-source-documentation: https://dev.3vjia.com/document?apiId=783733865595420737 x-documentation-category: 产品模块 / 素材数据 requestBody: required: false content: application/json: schema: type: object properties: parentId: type: string description: 父类ID default: '0' example: parentId: '' responses: '200': description: 成功 / OK content: application/json: schema: type: object properties: success: type: boolean description: 请求是否成功 / whether the call succeeded code: type: integer description: 结果码 / result code (0 = success) msg: type: string description: 提示信息 / message data: type: object properties: children: type: array items: {} description: 材质球分类 id: type: string isDelete: type: integer format: int32 level: type: integer format: int32 name: type: string organId: type: string parentId: type: string sortCode: type: integer format: int32 type: type: integer format: int32 userId: type: string example: msg: '' code: 0 data: - level: 0 isDelete: 0 type: 0 sortCode: 0 userId: '' parentId: '' children: [] name: '' organId: '' id: '' success: false '401': description: access_token 缺失或已过期 / missing or expired access_token /api/v1/materialDict/customNewMaterials: post: operationId: apiV1MaterialDictCustomNewMaterials summary: 获取企业自定义材质属性接口 tags: - Products x-source-documentation: https://dev.3vjia.com/document?apiId=783735159575957586 x-documentation-category: 产品模块 / 素材数据 requestBody: required: true content: application/json: schema: type: object properties: categoryId: type: string description: 材质分类ID required: - categoryId example: categoryId: '' responses: '200': description: 成功 / OK content: application/json: schema: type: object properties: success: type: boolean description: 请求是否成功 / whether the call succeeded code: type: integer description: 结果码 / result code (0 = success) msg: type: string description: 提示信息 / message data: type: object properties: auditDate: type: string format: date-time auditStatus: type: integer format: int32 auditUserId: type: string categoryIds: type: array items: {} createDate: type: string format: date-time creator: type: string customCategoryId: type: integer format: int32 description: type: string enable3D: type: boolean id: type: string imageUrl: type: string isDelete: type: integer format: int32 name: type: string organId: type: string parentId: type: string renderTime: type: number format: float templateUrl: type: string tenantId: type: string type: type: integer format: int32 updateDate: type: string format: date-time updateUserId: type: string usageState: type: integer format: int32 userId: type: string example: msg: '' code: 0 data: - creator: '' updateDate: '' updateUserId: '' isDelete: 0 description: '' type: 0 userId: '' parentId: '' renderTime: 0 templateUrl: '' categoryIds: [] auditUserId: '' usageState: 0 enable3D: false imageUrl: '' name: '' tenantId: '' auditStatus: 0 organId: '' customCategoryId: 0 id: '' auditDate: '' createDate: '' success: false '401': description: access_token 缺失或已过期 / missing or expired access_token /api/v1/materialDict/dictTree: post: operationId: apiV1MaterialDictDictTree summary: 字典树(属性类别等) tags: - Products x-source-documentation: https://dev.3vjia.com/document?apiId=845728973219577927 x-documentation-category: 产品模块 / 素材分类 description: 字典树(属性类别等),成品类属性类别dictId传:ddlMaterialAttribute requestBody: required: true content: application/json: schema: type: object properties: dictId: type: string description: 字典ID,成品类模型传:ddlMaterialAttribute required: - dictId example: dictId: '' responses: '200': description: 成功 / OK content: application/json: schema: type: object properties: success: type: boolean description: 请求是否成功 / whether the call succeeded code: type: integer description: 结果码 / result code (0 = success) msg: type: string description: 提示信息 / message data: type: object properties: childrenList: type: array items: type: object properties: attribute: type: integer format: int32 description: 字典属性 childrenList: type: array items: {} description: 字典树节点 dictId: type: string description: 字典id dictName: type: string description: 字典名称 parentId: type: string description: 父级id description: 字典树节点 key: type: string description: 键 value: type: string description: 值 example: msg: '' code: 0 data: childrenList: - dictId: '' parentId: '' dictName: '' attribute: 0 childrenList: [] value: '' key: '' success: false '401': description: access_token 缺失或已过期 / missing or expired access_token /api/v1/materialDict/listByModelFlag: post: operationId: apiV1MaterialDictListByModelFlag summary: 获取素材类别字典接口 tags: - Products x-source-documentation: https://dev.3vjia.com/document?apiId=780835453040496697 x-documentation-category: 产品模块 / 素材数据 requestBody: required: true content: application/json: schema: type: object properties: modelFlag: type: integer format: int32 description: 素材类型 required: - modelFlag example: modelFlag: 0 responses: '200': description: 成功 / OK content: application/json: schema: type: object properties: success: type: boolean description: 请求是否成功 / whether the call succeeded code: type: integer description: 结果码 / result code (0 = success) msg: type: string description: 提示信息 / message data: type: object properties: id: type: integer format: int64 description: 主键 itemCode: type: string description: 属性项编码 itemGroup: type: string description: 分组 itemName: type: string description: 属性项名称 modelFlag: type: string description: 应用的素材模块(逗号相隔) parentId: type: integer format: int64 description: 父节点id propertyCode: type: string description: 属性编码 relateItems: type: array items: {} description: 关联属性项 sortCode: type: integer format: int32 description: 排序序号 example: msg: '' code: 0 data: - itemGroup: '' itemCode: '' sortCode: 0 parentId: 0 relateItems: [] itemName: '' propertyCode: '' modelFlag: '' id: 0 success: false '401': description: access_token 缺失或已过期 / missing or expired access_token /api/v1/materialDict/svjNewMaterialCategories: post: operationId: apiV1MaterialDictSvjNewMaterialCategories summary: 获取新版材质分类接口 tags: - Products x-source-documentation: https://dev.3vjia.com/document?apiId=780840118524219467 x-documentation-category: 产品模块 / 素材数据 responses: '200': description: 成功 / OK content: application/json: schema: type: object properties: success: type: boolean description: 请求是否成功 / whether the call succeeded code: type: integer description: 结果码 / result code (0 = success) msg: type: string description: 提示信息 / message data: type: object properties: children: type: array items: {} description: 材质球分类 id: type: string isDelete: type: integer format: int32 level: type: integer format: int32 name: type: string parentId: type: string sortCode: type: integer format: int32 type: type: integer format: int32 example: msg: '' code: 0 data: - level: 0 isDelete: 0 type: 0 sortCode: 0 parentId: '' children: [] name: '' id: '' success: false '401': description: access_token 缺失或已过期 / missing or expired access_token /api/v1/materialDict/svjNewMaterials: post: operationId: apiV1MaterialDictSvjNewMaterials summary: 获取新版材质属性接口 tags: - Products x-source-documentation: https://dev.3vjia.com/document?apiId=789804220864938025 x-documentation-category: 产品模块 / 素材数据 requestBody: required: true content: application/json: schema: type: object properties: categoryId: type: string description: 材质球分类ID required: - categoryId example: categoryId: '' responses: '200': description: 成功 / OK content: application/json: schema: type: object properties: success: type: boolean description: 请求是否成功 / whether the call succeeded code: type: integer description: 结果码 / result code (0 = success) msg: type: string description: 提示信息 / message data: type: object properties: auditDate: type: string format: date-time auditStatus: type: integer format: int32 auditUserId: type: string categoryIds: type: array items: {} createDate: type: string format: date-time creator: type: string customCategoryId: type: integer format: int32 description: type: string enable3D: type: boolean id: type: string imageUrl: type: string isDelete: type: integer format: int32 name: type: string organId: type: string parentId: type: string renderTime: type: number format: float templateUrl: type: string tenantId: type: string type: type: integer format: int32 updateDate: type: string format: date-time updateUserId: type: string usageState: type: integer format: int32 userId: type: string example: msg: '' code: 0 data: - creator: '' updateDate: '' updateUserId: '' isDelete: 0 description: '' type: 0 userId: '' parentId: '' renderTime: 0 templateUrl: '' categoryIds: [] auditUserId: '' usageState: 0 enable3D: false imageUrl: '' name: '' tenantId: '' auditStatus: 0 organId: '' customCategoryId: 0 id: '' auditDate: '' createDate: '' success: false '401': description: access_token 缺失或已过期 / missing or expired access_token /api/v1/materialOp/addOrUpdateMaterialBatch: post: operationId: apiV1MaterialOpAddOrUpdateMaterialBatch summary: 批量添加或修改物料数据接口 tags: - AIMES x-source-documentation: https://dev.3vjia.com/document?apiId=474578235468910660 x-documentation-category: AIMES系统 / 物料管理 requestBody: required: true content: application/json: schema: type: object properties: color: type: string description: 颜色 matterCode: type: string description: 物料编号 matterName: type: string description: 物料名称 matterSize: type: string description: 尺寸 outMatterId: type: string description: 外部ID outMatterTypeCode: type: string description: 外部物料类型 outMatterTypeId: type: string description: 外部物料类型 remark: type: string description: 备注 spec: type: string description: 型号规格 status: type: integer format: int32 description: 物料状态,1-正常、2-下架中、3-已过时 stockUnit: type: string description: 库存单位 positionName: type: string description: 仓位 warehouseName: type: string description: 仓库 matchCode: type: string description: 物料匹配,大板-材质颜色厚度,其它-物料编码 materialIssuanceCode: type: string description: 发料方式编号 materialIssuanceName: type: string description: 发料方式名称 unitWeight: type: number format: bigdecimal description: 单位重量 required: - matterCode - matterName - outMatterId - outMatterTypeId example: - color: '' matterCode: '' matterName: '' matterSize: '' outMatterId: '' outMatterTypeCode: '' outMatterTypeId: '' remark: '' spec: '' status: 0 stockUnit: '' positionName: '' warehouseName: '' matchCode: '' materialIssuanceCode: '' materialIssuanceName: '' unitWeight: 0 responses: '200': description: 成功 / OK content: application/json: schema: type: object properties: success: type: boolean description: 请求是否成功 / whether the call succeeded code: type: integer description: 结果码 / result code (0 = success) msg: type: string description: 提示信息 / message data: type: object example: msg: '' code: 0 data: '' success: false '401': description: access_token 缺失或已过期 / missing or expired access_token /api/v1/materialcategory/deleteMaterialCategory: post: operationId: apiV1MaterialcategoryDeleteMaterialCategory summary: 删除素材分类接口 tags: - Products x-source-documentation: https://dev.3vjia.com/document?apiId=475026463813349469 x-documentation-category: 产品模块 / 素材分类 description: 删除素材分类 requestBody: required: false content: application/json: schema: type: object properties: categoryId: type: string description: 分类ID examples: - '100381008' example: categoryId: '100381008' responses: '200': description: 成功 / OK content: application/json: schema: type: object properties: success: type: boolean description: 请求是否成功 / whether the call succeeded code: type: integer description: 结果码 / result code (0 = success) msg: type: string description: 提示信息 / message data: type: object example: msg: '' code: 0 data: true success: true '401': description: access_token 缺失或已过期 / missing or expired access_token /api/v1/materialcategory/getMaterialCategoryList: post: operationId: apiV1MaterialcategoryGetMaterialCategoryList summary: 获取素材分类列表接口 tags: - Products x-source-documentation: https://dev.3vjia.com/document?apiId=475021823252181023 x-documentation-category: 产品模块 / 素材分类 description: 获取素材分类列表 requestBody: required: false content: application/json: schema: type: object properties: categoryType: type: string description: 分类类型,wardrobeAll=衣柜,cupboardAll=橱柜,systemCabinetAll=系统柜,UniversalAll=通用后台库,UniversalMaterial=通用材质库,bathCabinetAll=浴室柜,bathRoomAll=淋浴房,doorWindowAll=整木,aluminumAll=铝门窗,showerRoomAll=卫浴,brickSystemAll=铺砖,ceilingAll=顶墙,waterElectricAll=水电,brushingAll=涂料,Furniture=成品 examples: - wardrobeAll example: categoryType: wardrobeAll responses: '200': description: 成功 / OK content: application/json: schema: type: object properties: success: type: boolean description: 请求是否成功 / whether the call succeeded code: type: integer description: 结果码 / result code (0 = success) msg: type: string description: 提示信息 / message data: type: object properties: categoryCode: type: string description: 分类代码 categoryId: type: string description: 分类ID categoryName: type: string description: 分类名称 categoryType: type: string description: 分类类型,wardrobeAll=衣柜,cupboardAll=橱柜,systemCabinetAll=系统柜,UniversalAll=通用后台库,UniversalMaterial=通用材质库,bathCabinetAll=浴室柜,bathRoomAll=淋浴房,doorWindowAll=整木,aluminumAll=铝门窗,showerRoomAll=卫浴,brickSystemAll=铺砖,ceilingAll=顶墙,waterElectricAll=水电,brushingAll=涂料,Furniture=成品 categoryTypeName: type: string description: 分类类型名称 children: type: array items: {} description: 素材分类结果,V2 module: type: string description: 分类模块类型 parentId: type: string description: 父级ID shopId: type: string description: 三维家门店ID sortCode: type: integer format: int32 description: 排序号 example: msg: '' code: 0 data: - module: '' categoryCode: '' categoryName: '' sortCode: 0 parentId: '' categoryType: '' children: [] categoryTypeName: '' shopId: '' categoryId: '' success: false '401': description: access_token 缺失或已过期 / missing or expired access_token /api/v1/materialcategory/updateMaterialCategory: post: operationId: apiV1MaterialcategoryUpdateMaterialCategory summary: 编辑素材分类接口 tags: - Products x-source-documentation: https://dev.3vjia.com/document?apiId=475023500105560132 x-documentation-category: 产品模块 / 素材分类 description: 编辑素材分类 requestBody: required: false content: application/json: schema: type: object properties: activated: type: integer format: int32 description: 启用状态1启用,0未启用 examples: - '1' categoryCode: type: string description: 分类代码,成品不能使用categoryCode examples: - wardrobeFront categoryId: type: string description: 分类ID examples: - '100381008' categoryName: type: string description: 分类名称 examples: - 前台 sortCode: type: integer format: int32 description: 排序号 examples: - '0' example: categoryCode: wardrobeFront categoryName: 前台 sortCode: 0 categoryId: '100381008' activated: 1 responses: '200': description: 成功 / OK content: application/json: schema: type: object properties: success: type: boolean description: 请求是否成功 / whether the call succeeded code: type: integer description: 结果码 / result code (0 = success) msg: type: string description: 提示信息 / message data: type: object example: msg: '' code: 0 data: true success: true '401': description: access_token 缺失或已过期 / missing or expired access_token /api/v1/model/designmaterialmaxfile/list: post: operationId: apiV1ModelDesignmaterialmaxfileList summary: 获取模型处理进度接口 tags: - Products x-source-documentation: https://dev.3vjia.com/document?apiId=595562880909336648 x-documentation-category: 产品模块 / 模型上传 requestBody: required: false content: application/json: schema: type: object properties: beginTime: type: string description: 提交开始时间 belongSource: type: integer format: int32 description: 归属:0=个人素材,1=门店素材,2=企业素材 examples: - '2' endTime: type: string description: 结束提交时间 id: type: string description: 任务ID ids: type: array items: {} description: 任务ID集合 isBuild: type: integer format: int32 description: 处理状态:0=未处理、3=处理完未发布、1=已处理、2=处理中、9=处理失败 isBuilds: type: array items: {} description: 处理状态集合 isRelease: type: integer format: int32 description: 是否已发布 examples: - '0' modelFlag: type: integer format: int32 description: 素材模块 postUserId: type: string description: 上传用户ID example: isBuild: 0 belongSource: 2 isBuilds: [] isRelease: 0 postUserId: '' modelFlag: 0 ids: [] beginTime: '' endTime: '' id: '' responses: '200': description: 成功 / OK content: application/json: schema: type: object properties: success: type: boolean description: 请求是否成功 / whether the call succeeded code: type: integer description: 结果码 / result code (0 = success) msg: type: string description: 提示信息 / message data: type: object properties: a3dSource: type: string description: 3D模型文件路径 attribute: type: string description: 模型属性信息json belongSource: type: integer format: int32 description: 数据归属 classification: type: integer format: int32 description: 素材分类 errorCode: type: string description: 错误编号 errorMsg: type: string description: 错误消息 fileName: type: string description: 附件记录ID fileType: type: integer format: int32 description: 文件类型 id: type: string description: 任务ID imagePath: type: string description: 素材主图路径 isBuild: type: integer format: int32 description: 处理状态 isDelete: type: integer format: int32 description: 是否删除 isRelease: type: integer format: int32 description: 是否已发布 isSvj: type: integer format: int32 description: 是否生成SVJ isVrscene: type: integer format: int32 description: 是否生成VR文件 jsonFilePath: type: string description: 模型文件列表的json存放路径 mainImgDuration: type: integer format: int32 description: 主图渲染时长(ms) materialId: type: string description: 素材ID modelFlag: type: integer format: int32 description: 素材模块 modelName: type: string description: 模型名称 opti: type: number format: double description: 减面百分比 placeRule: type: string description: 放置规则,1:地上;2:墙上;4:顶上;8:定制 postTime: type: string description: 创建时间 postUserId: type: string description: 上传用户 progress: type: integer format: int32 description: 解析进度 tenantId: type: string description: 租户Id upDateTime: type: string description: 最后修改时间 updateUserId: type: string description: 最后修改的用户 example: msg: '' code: 0 data: - fileName: '' jsonFilePath: '' a3dSource: '' belongSource: 0 imagePath: '' errorCode: '' isRelease: 0 postUserId: '' postTime: '' modelFlag: 0 mainImgDuration: 0 isVrscene: 0 attribute: '' id: '' isBuild: 0 isSvj: 0 upDateTime: '' updateUserId: '' isDelete: 0 classification: 0 materialId: '' errorMsg: '' modelName: '' placeRule: '' tenantId: '' progress: 0 fileType: 0 success: false '401': description: access_token 缺失或已过期 / missing or expired access_token /api/v1/model/modelfile/create: post: operationId: apiV1ModelModelfileCreate summary: 保存模型文件记录接口 tags: - Products x-source-documentation: https://dev.3vjia.com/document?apiId=595559340975480913 x-documentation-category: 产品模块 / 模型上传 requestBody: required: true content: application/json: schema: type: object properties: belongSource: type: integer format: int32 description: 归属:0=个人素材,1=门店素材,2=企业素材 examples: - '2' modelFlag: type: integer format: int32 description: 素材模块 examples: - '10' modelName: type: string description: 模型名称 examples: - 北欧室外休闲椅 ossKey: type: string description: 模型文件路径,对应“获取模型上传签名接口”返回值的key字段值 examples: - modelfile/20240628/n5er3o9bx8z858xwkgdg454ap3ajtfao.zip required: - belongSource - modelFlag - modelName - ossKey example: ossKey: modelfile/20240628/n5er3o9bx8z858xwkgdg454ap3ajtfao.zip belongSource: 2 modelName: 北欧室外休闲椅 modelFlag: 10 responses: '200': description: 成功 / OK content: application/json: schema: type: object properties: success: type: boolean description: 请求是否成功 / whether the call succeeded code: type: integer description: 结果码 / result code (0 = success) msg: type: string description: 提示信息 / message data: type: object example: msg: '' code: 0 data: '3448709' success: false '401': description: access_token 缺失或已过期 / missing or expired access_token /api/v1/model/oss/getUploadToken: post: operationId: apiV1ModelOssGetUploadToken summary: 获取模型上传签名接口 tags: - Products x-source-documentation: https://dev.3vjia.com/document?apiId=595553824777854980 x-documentation-category: 产品模块 / 模型上传 description: 注意:支持上传的压缩包容量不大于600M requestBody: required: true content: application/json: schema: type: object properties: fileSuffix: type: string description: 上传文件后缀,注意不带'.',支持:zip、rar examples: - zip required: - fileSuffix example: fileSuffix: zip responses: '200': description: 成功 / OK content: application/json: schema: type: object properties: success: type: boolean description: 请求是否成功 / whether the call succeeded code: type: integer description: 结果码 / result code (0 = success) msg: type: string description: 提示信息 / message data: type: object properties: accessKeyId: type: string description: 访问密钥标识 examples: - STS.NUXbrKhhZ3VhU54iEfDYXFwBh contentType: type: string description: 华为云和腾讯云都要把 Content-Type 作为表单字段返回(非空的时候带过去,或者指定 prefix 的时候要自己生成并带过去) contentTypePrefix: type: string description: 内容类型前缀 expireAt: type: integer format: int64 description: 签名过期10位秒级时间戳 examples: - '1719801893' expireTime: type: string format: date-time description: 签名过期时间 examples: - '2024-07-01 10:44:53' formFields: type: object description: 表单字段,用于前端直传时的表单字段填充 key: type: string description: 约束上传的key examples: - modelfile/20240701/a17865bfcc7c45ca9da009de871a0081.rar ossHost: type: string description: 需要上传到哪个OSS上,值为OSS地址或者CDN域名 examples: - https://3vj-maxzip-w.3vjia.com policy: type: string description: 签名上传的约束策略,比如大小、前缀等 examples: - eyJleHBpcm*********ZTg3MWEwMDgxLnJhciJdXX0= readDomain: type: string description: 不支持公共读 securityToken: type: string description: 安全令牌(当基于STS或者IAM生成签名时前端的表单必须同时携带该参数) examples: - CAIS8wJ1q6Ft5*********PxEa2QRA+BRZWCd3FcjinYfLzW4toIAA= signature: type: string description: 签名 examples: - EFntYAYO74/+9Z1MGqeJ7/bD0mQ= vendor: type: string description: 本次生成签名对应的厂商 examples: - ali required: - expireTime - vendor example: msg: '' code: 0 data: accessKeyId: STS.NUXbrKhhZ3VhU54iEfDYXFwBh signature: EFntYAYO74/+9Z1MGqeJ7/bD0mQ= contentTypePrefix: '' expireAt: 1719801893 ossHost: https://3vj-maxzip-w.3vjia.com securityToken: CAIS8wJ1q6Ft5*********PxEa2QRA+BRZWCd3FcjinYfLzW4toIAA= expireTime: '2024-07-01 10:44:53' readDomain: '' vendor: ali formFields: '' contentType: '' key: modelfile/20240701/a17865bfcc7c45ca9da009de871a0081.rar policy: eyJleHBpcm*********ZTg3MWEwMDgxLnJhciJdXX0= success: false '401': description: access_token 缺失或已过期 / missing or expired access_token /api/v1/model/uploadmaterial/addModels: post: operationId: apiV1ModelUploadmaterialAddModels summary: 保存模型数据接口 tags: - Products x-source-documentation: https://dev.3vjia.com/document?apiId=595562880909336650 x-documentation-category: 产品模块 / 模型上传 requestBody: required: true content: application/json: schema: type: object properties: brandId: type: integer format: int32 description: 品牌ID categoryId: type: integer format: int32 description: 素材分类ID materialName: type: string description: 素材名字 materialType: type: string description: 素材类别 modelFlag: type: integer format: int32 description: 素材模块 orientation: type: string description: 开门方向 placeRule: type: string description: 放置规则 seriesId: type: integer format: int32 description: 系列ID taskId: type: string description: 任务ID required: - categoryId - materialName - materialType - modelFlag - taskId example: - materialType: '' seriesId: 0 materialName: '' modelFlag: 0 brandId: 0 categoryId: 0 taskId: '' responses: '200': description: 成功 / OK content: application/json: schema: type: object properties: success: type: boolean description: 请求是否成功 / whether the call succeeded code: type: integer description: 结果码 / result code (0 = success) msg: type: string description: 提示信息 / message data: type: object example: msg: '' code: 0 data: false success: false '401': description: access_token 缺失或已过期 / missing or expired access_token /api/v1/mxjComputingExternal/allocateComputingPower: post: operationId: apiV1MxjComputingExternalAllocateComputingPower summary: 分配算力 tags: - Dedicated Services x-source-documentation: https://dev.3vjia.com/document?apiId=834375616219484258 x-documentation-category: 专属服务 / C00002170 requestBody: required: true content: application/json: schema: type: object properties: allocatingAccountInfoList: type: array items: type: object properties: allocationPackageNum: type: integer format: int32 description: 分配算力包数量 userId: type: string description: 用户id userName: type: string description: userName required: - allocationPackageNum - userId - userName description: 用户分配算力参数 请求体 orderPackageId: type: integer format: int64 description: 订单算力包id required: - allocatingAccountInfoList - orderPackageId example: orderPackageId: 0 allocatingAccountInfoList: - allocationPackageNum: 0 userName: '' userId: '' responses: '200': description: 成功 / OK content: application/json: schema: type: object properties: success: type: boolean description: 请求是否成功 / whether the call succeeded code: type: integer description: 结果码 / result code (0 = success) msg: type: string description: 提示信息 / message data: type: object example: msg: '' code: 0 data: false success: false '401': description: access_token 缺失或已过期 / missing or expired access_token /api/v1/njvr/sts/getSign: post: operationId: apiV1NjvrStsGetSign summary: 获取OSS上传签名接口 tags: - 3D Show x-source-documentation: https://dev.3vjia.com/document?apiId=506846884346802186 x-documentation-category: 3D秀 requestBody: required: false content: application/json: schema: type: object properties: fileName: type: string description: 文件名 key: type: string description: 约束本次签名上传的key,本次签名只能使用对应的全路径 keyPrefix: type: string description: 约束本次签名上传的key前缀,以/结尾。如果没有指定,则使用AliOssTemplate指定的前缀 type: type: string description: 类型默认0 example: fileName: '' type: '' keyPrefix: '' key: '' responses: '200': description: 成功 / OK content: application/json: schema: type: object properties: success: type: boolean description: 请求是否成功 / whether the call succeeded code: type: integer description: 结果码 / result code (0 = success) msg: type: string description: 提示信息 / message data: type: object properties: accessKeyId: type: string description: accessKeyId callback: type: string description: callback expireAt: type: integer format: int64 description: expireAt keyPrefix: type: string description: keyPrefix ossHost: type: string description: ossHost path: type: string description: path policy: type: string description: policy signature: type: string description: signature example: msg: '' code: 0 data: accessKeyId: '' signature: '' expireAt: 0 keyPrefix: '' ossHost: '' path: '' callback: '' policy: '' success: false '401': description: access_token 缺失或已过期 / missing or expired access_token /api/v1/nobilia/copyFile: post: operationId: apiV1NobiliaCopyFile summary: 复制文件 tags: - Dedicated Services x-source-documentation: https://dev.3vjia.com/document?apiId=712983026602229819 x-documentation-category: 专属服务 / C00002275 description: 柏丽文件复制接口,目前只能复制子方案的内容,格式为txt的文件 requestBody: required: true content: application/json: schema: type: object properties: fileUrl: type: string description: 文件Url,目前只允许txt文件 examples: - https://3vj-outerapi.3vjia.com/137243088/321F6896DF3F409484DF3332127D0F74/06eca6aca33941d7a474da3b220c1d73_20250521105615.txt id: type: string description: 文件id examples: - '712970233790480408' required: - fileUrl - id example: - fileUrl: https://3vj-outerapi.3vjia.com/137243088/321F6896DF3F409484DF3332127D0F74/06eca6aca33941d7a474da3b220c1d73_20250521105615.txt id: '712970233790480408' responses: '200': description: 成功 / OK content: application/json: schema: type: object properties: success: type: boolean description: 请求是否成功 / whether the call succeeded code: type: integer description: 结果码 / result code (0 = success) msg: type: string description: 提示信息 / message data: type: object properties: fileUrl: type: string description: 文件Url id: type: string description: 文件id example: msg: '' code: 0 data: - fileUrl: '' id: '' success: false '401': description: access_token 缺失或已过期 / missing or expired access_token /api/v1/open/common/getBySharedKey: post: operationId: apiV1OpenCommonGetBySharedKey summary: 通过Key获取全景图数据接口 tags: - Common Services x-source-documentation: https://dev.3vjia.com/document?apiId=479031281410191408 x-documentation-category: 通用服务 description: 其中,key是3D云设计的图册功能,通过请求 /sunvega-open-biz/scheme/panorama/sharePanorama 接口获取。 requestBody: required: false content: application/json: schema: type: object properties: key: type: string description: key example: key: '' responses: '200': description: 成功 / OK content: application/json: schema: type: object properties: success: type: boolean description: 请求是否成功 / whether the call succeeded code: type: integer description: 结果码 / result code (0 = success) msg: type: string description: 提示信息 / message data: type: object properties: contentData: type: object description: 分享内容 example: msg: '' code: 0 data: contentData: '' success: false '401': description: access_token 缺失或已过期 / missing or expired access_token /api/v1/openInterface/getCustomReportTemplate: post: operationId: apiV1OpenInterfaceGetCustomReportTemplate summary: 获取报价模板接口 tags: - Quotation x-source-documentation: https://dev.3vjia.com/document?apiId=457250328803344465 x-documentation-category: 报价模块 requestBody: required: true content: application/json: schema: type: object properties: organId: type: string description: 机构id overseasType: type: string description: 海外标识 reportCode: type: string description: 报价模板reportCode solutionCode: type: string description: 报价方案solutionCode userId: type: string description: 用户id(用户Id和用户名称不能同时为空) userName: type: string description: 用户名称(用户Id和用户名称不能同时为空) required: - organId - userId - userName example: userName: '' userId: '' solutionCode: '' overseasType: '' reportCode: '' organId: '' responses: '200': description: 成功 / OK content: application/json: schema: type: object properties: success: type: boolean description: 请求是否成功 / whether the call succeeded code: type: integer description: 结果码 / result code (0 = success) msg: type: string description: 提示信息 / message data: type: object properties: moduleTemplateViewResultList: type: array items: type: object properties: moduleName: type: string description: 模块名 moduleSort: type: integer format: int32 description: 模块排序字段 templates: type: array items: type: object properties: authUserIdList: type: string description: 授权的用户ID authUserIds: type: array items: {} description: 授权的用户ID bimReport: type: boolean description: 是否是BIM模板 completeReport: type: boolean description: completeReport createTime: type: string format: date-time description: 创建时间 creatorId: type: string description: 创建用户 cusState: type: string description: 自定义状态 cusType: type: string description: 自定义类型 fileType: type: string description: 导出文件格式 id: type: string description: 唯一ID isApplyDefault: type: boolean description: 是否默认显示模版 isAuthUser: type: boolean description: isAuthUser isDelete: type: integer format: int32 description: 伪删除标识码 isShowAllNode: type: boolean description: isShowAllNode modifierId: type: string description: 修改人员 modifyTime: type: string format: date-time description: 修改时间 organId: type: string description: OrganId remark: type: string description: 备注 reportCode: type: string description: 报表编号 reportName: type: string description: 报价模版名称 solutionId: type: string description: 方案ID sysState: type: string description: 系统状态 sysType: type: string description: 系统类型 required: - authUserIdList - authUserIds - bimReport - completeReport - createTime - creatorId - cusState - cusType - fileType - id - isApplyDefault - isAuthUser - isDelete - isShowAllNode - modifierId - modifyTime - organId - remark - reportCode - reportName - solutionId - sysState - sysType description: 报价模板返回结果1 required: - moduleName - moduleSort - templates description: 报价模板返回结果2 quoteSolutionReportResultList: type: array items: type: object properties: authUserIdList: type: string description: 授权的用户ID authUserIds: type: array items: {} description: 授权的用户ID bimReport: type: boolean description: 是否是BIM模板 completeReport: type: boolean description: completeReport createTime: type: string format: date-time description: 创建时间 creatorId: type: string description: 创建用户 cusState: type: string description: 自定义状态 cusType: type: string description: 自定义类型 fileType: type: string description: 导出文件格式 id: type: string description: 唯一ID isApplyDefault: type: boolean description: 是否默认显示模版 isAuthUser: type: boolean description: isAuthUser isDelete: type: integer format: int32 description: 伪删除标识码 isShowAllNode: type: boolean description: isShowAllNode modifierId: type: string description: 修改人员 modifyTime: type: string format: date-time description: 修改时间 organId: type: string description: OrganId remark: type: string description: 备注 reportCode: type: string description: 报表编号 reportName: type: string description: 报价模版名称 solutionId: type: string description: 方案ID sysState: type: string description: 系统状态 sysType: type: string description: 系统类型 required: - authUserIdList - authUserIds - bimReport - completeReport - createTime - creatorId - cusState - cusType - fileType - id - isApplyDefault - isAuthUser - isDelete - isShowAllNode - modifierId - modifyTime - organId - remark - reportCode - reportName - solutionId - sysState - sysType description: 报价模板返回结果1 required: - moduleTemplateViewResultList - quoteSolutionReportResultList example: msg: '' code: 0 data: moduleTemplateViewResultList: - templates: - cusState: '' reportName: '' sysType: '' isDelete: 0 creatorId: '' modifierId: '' isApplyDefault: false isShowAllNode: false remark: '' authUserIdList: '' isAuthUser: false authUserIds: [] modifyTime: '' createTime: '' cusType: '' reportCode: '' organId: '' sysState: '' id: '' solutionId: '' bimReport: false completeReport: false fileType: '' moduleName: '' moduleSort: 0 quoteSolutionReportResultList: - cusState: '' reportName: '' sysType: '' isDelete: 0 creatorId: '' modifierId: '' isApplyDefault: false isShowAllNode: false remark: '' authUserIdList: '' isAuthUser: false authUserIds: [] modifyTime: '' createTime: '' cusType: '' reportCode: '' organId: '' sysState: '' id: '' solutionId: '' bimReport: false completeReport: false fileType: '' success: false '401': description: access_token 缺失或已过期 / missing or expired access_token /api/v1/oppein/grantDreamerPermission: post: operationId: apiV1OppeinGrantDreamerPermission summary: 分配梦想家权限 tags: - Dedicated Services x-source-documentation: https://dev.3vjia.com/document?apiId=737712566758948937 x-documentation-category: 专属服务 / C00000868 description: 分配梦想家权限 requestBody: required: true content: application/json: schema: type: object properties: outUserId: type: string description: 外部用户ID required: - outUserId example: outUserId: '' responses: '200': description: 成功 / OK content: application/json: schema: type: object properties: success: type: boolean description: 请求是否成功 / whether the call succeeded code: type: integer description: 结果码 / result code (0 = success) msg: type: string description: 提示信息 / message data: type: object properties: bindSwjAccount: type: boolean description: 是否绑定三维家账号 grantResult: type: boolean description: 授权结果 msg: type: string description: 说明 example: msg: '' code: 0 data: msg: '' bindSwjAccount: false grantResult: false success: false '401': description: access_token 缺失或已过期 / missing or expired access_token /api/v1/oppein/hasDreamerPermission: post: operationId: apiV1OppeinHasDreamerPermission summary: 查询用户是否拥有梦想家权限 tags: - Dedicated Services x-source-documentation: https://dev.3vjia.com/document?apiId=737712566758948993 x-documentation-category: 专属服务 / C00000868 description: 查询用户是否拥有梦想家权限 requestBody: required: true content: application/json: schema: type: object properties: outUserId: type: string description: 外部用户ID required: - outUserId example: outUserId: '' responses: '200': description: 成功 / OK content: application/json: schema: type: object properties: success: type: boolean description: 请求是否成功 / whether the call succeeded code: type: integer description: 结果码 / result code (0 = success) msg: type: string description: 提示信息 / message data: type: object properties: bindSwjAccount: type: boolean description: 是否绑定三维家账号 expireTime: type: object description: 有效期 hasPermission: type: boolean description: 是否有权限 example: msg: '' code: 0 data: bindSwjAccount: false expireTime: '' hasPermission: false success: false '401': description: access_token 缺失或已过期 / missing or expired access_token /api/v1/organFactoryDealer/saveOrUpdate: post: operationId: apiV1OrganFactoryDealerSaveOrUpdate summary: 新增或修改企业经销商 tags: - AIMES x-source-documentation: https://dev.3vjia.com/document?apiId=487334183702741048 x-documentation-category: AIMES系统 / 基础信息 requestBody: required: true content: application/json: schema: type: object properties: addressCityCode: type: string description: 地址—市编码 addressCityName: type: string description: 地址—市名称 addressDistrictCode: type: string description: 地址—区编码 addressDistrictName: type: string description: 地址—区名称 addressProvinceCode: type: string description: 地址—省编码 addressProvinceName: type: string description: 地址—省名称 attributionAreaCode: type: string description: 归属区域编码,对应数据字典“经销商区域”配置的类型编号。 dealerAddress: type: string description: 经销商地址 dealerCode: type: string description: 经销商编号 dealerContact: type: string description: 联系人 dealerEmail: type: string description: 邮箱 dealerLevelCode: type: string description: 经销商等级编码 dealerLevelName: type: string description: '经销商等级名称(0: 无, 1: 一级, 1: 二级, 依此...)' dealerName: type: string description: 经销商名称 dealerPhone: type: string description: 联系电话 dealerShopIds: type: array items: {} description: 关联经销商门店id,factory_dealer#id,批量保存不处理门店 dealerStatus: type: integer format: int32 description: '经销商状态( 1: 正常,2:禁用)' dealerTypeCode: type: string description: 经销商类型编码 dealerTypeName: type: string description: 经销商类型名称 organFactoryDealerExpandAddOrUpReq: type: object properties: businessName: type: string description: 经营主体名称 businessType: type: string description: 经营主体类型 businessTypeCode: type: string description: 经营主体类型编号 consignee: type: string description: 收货人 consigneePhone: type: string description: 收货人电话 discountRate: type: string description: 折率 freightCompanyAddress: type: string description: 货运公司地址 freightCompanyName: type: string description: 货运公司名称 freightCompanyPhone: type: string description: 货运公司电话 freightContactName: type: string description: 货运联络人 freightContactNumber: type: string description: 货运联络电话 freightRoutes: type: string description: 货运路线 headName: type: string description: 负责人 headPhone: type: string description: 负责人电话 legalRepresentative: type: string description: 法人代表 lineName: type: string description: 线路名称 lineNameCode: type: string description: 线路名称编号 marketPosition: type: string description: 市场地位,对应数据字典“市场地位”配置值。 marketPositionCode: type: string description: 市场地位编号,对应数据字典“市场地位”配置值。 operator: type: string description: 经营者 orderPlacementMethod: type: string description: 下单方式 orderPlacementMethodCode: type: string description: 下单方式编号 phone: type: string description: 公司电话 salesman: type: string description: 业务员 socialCreditCode: type: string description: 统一社会信用代码 description: 保存企业经销商附件信息类 parentDeptId: type: string description: 上级部门id remark: type: string description: 备注 required: - dealerCode - dealerName example: addressDistrictCode: '' dealerName: '' dealerTypeName: '' dealerAddress: '' dealerCode: '' dealerLevelName: '' dealerPhone: '' addressCityName: '' dealerStatus: 0 remark: '' addressCityCode: '' dealerShopIds: [] attributionAreaCode: '' dealerTypeCode: '' dealerLevelCode: '' dealerContact: '' dealerEmail: '' addressProvinceName: '' organFactoryDealerExpandAddOrUpReq: discountRate: '' orderPlacementMethod: '' freightCompanyAddress: '' businessName: '' lineName: '' socialCreditCode: '' operator: '' orderPlacementMethodCode: '' legalRepresentative: '' freightContactName: '' consigneePhone: '' marketPositionCode: '' freightContactNumber: '' consignee: '' marketPosition: '' businessTypeCode: '' freightRoutes: '' headName: '' headPhone: '' phone: '' freightCompanyPhone: '' lineNameCode: '' freightCompanyName: '' salesman: '' businessType: '' addressProvinceCode: '' addressDistrictName: '' parentDeptId: '' responses: '200': description: 成功 / OK content: application/json: schema: type: object properties: success: type: boolean description: 请求是否成功 / whether the call succeeded code: type: integer description: 结果码 / result code (0 = success) msg: type: string description: 提示信息 / message data: type: object example: msg: '' code: 0 data: false success: false '401': description: access_token 缺失或已过期 / missing or expired access_token /api/v1/parseXml2Json: post: operationId: apiV1ParseXml2Json summary: 将3D方案xml格式转换为JSON数据结构 tags: - Dedicated Services x-source-documentation: https://dev.3vjia.com/document?apiId=713062802021044297 x-documentation-category: 专属服务 / C11476529 description: 将3D方案xml格式转换为JSON数据结构 requestBody: required: false content: application/json: schema: type: object properties: sysCode: type: string traceId: type: string xmlBase64: type: string example: traceId: '' sysCode: '' xmlBase64: '' responses: '200': description: 成功 / OK content: application/json: schema: type: object properties: success: type: boolean description: 请求是否成功 / whether the call succeeded code: type: integer description: 结果码 / result code (0 = success) msg: type: string description: 提示信息 / message data: type: object example: msg: '' code: 0 data: '' success: false '401': description: access_token 缺失或已过期 / missing or expired access_token /api/v1/platformorders/assignCheckerForOpen: post: operationId: apiV1PlatformordersAssignCheckerForOpen summary: 批量分配审单员 tags: - MOS x-source-documentation: https://dev.3vjia.com/document?apiId=461136204788727850 x-documentation-category: MOS系统 / 订单管理 requestBody: required: true content: application/json: schema: type: object properties: checkUserId: type: string description: 审单用户id operationUserId: type: string description: 操作用户id orderRecordIds: type: array items: {} description: |- ThisisListType 订单记录ID required: - orderRecordIds example: checkUserId: '' operationUserId: '' orderRecordIds: [] responses: '200': description: 成功 / OK content: application/json: schema: type: object properties: success: type: boolean description: 请求是否成功 / whether the call succeeded code: type: integer description: 结果码 / result code (0 = success) msg: type: string description: 提示信息 / message data: type: object example: msg: '' code: 0 data: false success: false '401': description: access_token 缺失或已过期 / missing or expired access_token /api/v1/platformorders/batchExecuteOperationForOpen: post: operationId: apiV1PlatformordersBatchExecuteOperationForOpen summary: 批量执行订单操作 tags: - MOS x-source-documentation: https://dev.3vjia.com/document?apiId=474589622802944018 x-documentation-category: MOS系统 / 订单管理 description: |- |操作|操作码|备注| |:----|:---------------------------|:---------------| |签收|C2\_PLATFORM\_SIGN|| |审核通过|C2\_PLATFORM\_PASS\_P| C00002150定制,拆单确认| |开料登记|C2\_PLATFORM\_CUT|| |封边登记|C2\_PLATFORM\_EDGE|| |开孔登记|C2\_PLATFORM\_HOLE|| |试装登记|C2\_PLATFORM\_FIT|| |修色登记|C2\_PLATFORM\_COLOR|| |入库登记|C2\_PLATFORM\_STORAGE|| |发货登记|C2\_PLATFORM\_SEND|| |完成订单|C2\_PLATFORM\_COMPLETE|| |拆单确认|C2\_PLATFORM\_BREAK|| |退回上一步|C2\_PLATFORM\_ORDER\_FORWARD|企业定制| requestBody: required: true content: application/json: schema: type: object properties: operationCode: type: string description: 具体参考上述操作码说明 examples: - C2_PLATFORM_PASS_P orderRecordIds: type: array items: {} description: 订单ID集合 examples: - '"D123456","D345678"' remark: type: string description: 备注信息 examples: - 备注信息 operationUserId: type: string description: 操作用户ID,和操作用户名二选一必传。 operationUserName: type: string description: 操作用户名 required: - operationCode - orderRecordIds example: operationCode: C2_PLATFORM_PASS_P remark: 备注信息 operationUserName: '' operationUserId: '' orderRecordIds: [] responses: '200': description: 成功 / OK content: application/json: schema: type: object properties: success: type: boolean description: 请求是否成功 / whether the call succeeded code: type: integer description: 结果码 / result code (0 = success) msg: type: string description: 提示信息 / message data: type: object properties: failCount: type: integer format: int32 description: 失败条数 examples: - '0' failOrder: type: array items: type: object properties: diyOrderNo: type: string description: 自定义订单编号 examples: - D12345678 errorMessage: type: string description: 错误消息 orderNo: type: string description: 订单编号 examples: - O12345678 description: 批量更新订单,失败订单 successCount: type: integer format: int32 description: 成功条数 examples: - '10' totalCount: type: integer format: int32 description: 总条数 examples: - '10' example: msg: '' code: 0 data: failCount: 0 totalCount: 10 failOrder: - orderNo: O12345678 errorMessage: '' diyOrderNo: D12345678 successCount: 10 success: false '401': description: access_token 缺失或已过期 / missing or expired access_token /api/v1/productMaterial/editModel: post: operationId: apiV1ProductMaterialEditModel summary: 编辑成品模型数据接口 tags: - Products x-source-documentation: https://dev.3vjia.com/document?apiId=841678314283372576 x-documentation-category: 产品模块 / 素材管理 description: |- 本接口采用字段覆盖保存模式,而非部分更新。表中标注"如果不传或传 null,将用 null 覆盖"或"用 0 覆盖"的字段,会被清空为 null 或重置为 0。调用时若不希望某字段被清空或重置,请将该字段的原值一并传回。 最简单的方式就是, `先调/api/v1/productMaterial/getModel接口(文档地址:https://help.3vjia.com/doc/open_doc/456823276459593731/841686263705800714)把数据拿回来,直接把 designMaterial和product对象(字段)copy过去,然后再针对自己需要改的字段进行修改` **素材主表** | 字段 | 中文含义 | 落库位置 | 传空结果 | |---|---|---|---| | `designMaterial.categoryId` | 素材分类ID | 素材主表 | 会更新为 `0` | | `designMaterial.brickId` | 异型砖ID | 素材主表 | 会更新为 `null` | | `designMaterial.lightProperty` | 灯光属性 | 素材主表 | 会更新为 `null` | | `designMaterial.orientation` | 开门方向 | 素材主表 | 会更新为 `null` | | `designMaterial.materialAttribute` | 属性类别 | 素材主表 | 会更新为 `null` | | `designMaterial.placeRule` | 放置规则 | 素材主表 | 会更新为 `null` | | `designMaterial.picHeight` | 高 | 素材主表 | 会更新为 `null` | | `designMaterial.picLength` | 长 | 素材主表 | 会更新为 `null` | | `designMaterial.picWidth` | 宽 | 素材主表 | 会更新为 `null` | | `designMaterial.placeHeight` | 放置高度 | 素材主表 | 会更新为 `null` | | `designMaterial.retailPrice` | 零售价 | 素材主表 | 会更新为 `null` | | `designMaterial.holeLength` | 开孔尺寸-长 | 素材主表 | 会更新为 `null` | | `designMaterial.holeWidth` | 开孔尺寸-宽 | 素材主表 | 会更新为 `null` | | `designMaterial.designCode` | 素材编号 | 素材主表 | 会更新为 `null` | | `designMaterial.modelDepth` | 模型深度 | 素材主表 | 会更新为 `null` | | `designMaterial.parts` | 部件属性 | 素材主表 | 会更新为 `null` | | `designMaterial.materialType` | 素材类别 | 素材主表 | 会更新为 `null` | **商品相关** | 字段 | 中文含义 | 落库位置 | 传空结果 | |---|---|---|---| | `product.brandId` | 品牌ID | 品牌/系列绑定关系 | 会更新为 `0` | | `product.seriesId` | 系列ID | 品牌/系列绑定关系 | 会更新为 `0` | | `product.model` | 型号 | 商品表 | 会更新为空值 | | `product.unit` | 计价单位/报价单位 | 商品表 | 会更新为空值 | | `product.specifications` | 规格/功率 | 商品表 | 会更新为空值 | | `product.productType` | 产品类型 | 商品表 | 会更新为空值 | | `product.maker` | 制造商/生产厂家 | 商品表 | 会更新为空值 | | `product.productCode` | 设备编号/产品编号 | 商品表 | 会更新为空值 | | `product.relatedMaterialId` | 关联驱动器素材ID | 商品表 | 会更新为空值 | | `product.hole` | 开孔尺寸 | 商品表 | 会更新为空值 | | `product.installHeight` | 安装高度 | 商品表 | 会更新为空值 | | `product.lightsTapeLength` | 灯带长度 | 商品表 | 会更新为空值 | | `product.lengthPerReel` | 每卷灯带长度 | 商品表 | 会更新为空值 | | `product.costPrice` | 出厂价 | 商品表 | 会更新为空值 | | `product.wholeSalePrice` | 售价 | 商品表 | 会更新为空值 | | `product.retailPrice` | 市场价 | 商品表 | 会更新为空值 | | `product.detail` | 商品描述 | 商品表 `detail` | 会更新为空值 | | `externalUrl` | 商品外链URL | 外链商品表 `url` | 会更新为空值 | requestBody: required: true content: application/json: schema: type: object properties: designMaterial: type: object properties: attachmentPath: type: string description: attachmentPath bizLogDesc: type: string brickId: type: string description: 异型砖 categoryId: type: integer format: int32 description: 素材分类ID,注意:如果不传或传 null,将用 null chartletFeatureCode: type: string description: 贴图特征码 color: type: string description: 色号 colorCode: type: string description: 色号编码 contentUrl: type: string description: XML文件路径 costPrice: type: number format: double description: 成本价 designCode: type: string description: 素材编号,注意:如果不传或传 null,将用 null 覆盖 enableMaterialBall: type: integer format: int32 description: 是否启用材质属性 holeDepth: type: integer format: int32 description: (圆孔)深/(方孔)高 holeLength: type: integer format: int32 description: 开孔尺寸-长 holeRadius: type: integer format: int32 description: (圆孔)半径 holeSite: type: integer format: int32 description: 孔位:1-方孔,2-圆孔 holeWidth: type: integer format: int32 description: 开孔尺寸-宽 imagePath: type: string description: 主图 interfaceDesc: type: string description: 接口描述 is3d: type: integer format: int32 description: 启用3D状态 isA3d: type: string description: 是否模型 isBumpMap: type: integer format: int32 description: 是否凹凸贴图 isHasProduct: type: integer format: int32 description: 是否参与报价 isOut: type: integer format: int32 description: “淘汰”状态 0 正常 1 淘汰 isPublic: type: integer format: int32 description: 是否公用 isRender: type: integer format: int32 description: 是否可渲染,0不可渲染,1可渲染 lightProperty: type: string description: 灯光属性 materialAttribute: type: string description: 属性类别,注意:如果不传或传 null,将用 null materialBallType: type: integer format: int32 description: 材质类型,1=旧材质,2=新材质 materialCategory: type: string description: 材料分类 materialId: type: string description: 素材ID materialName: type: string description: 素材名称 materialType: type: string description: 素材类别,注意:如果不传或传 null,将用 null modelDepth: type: integer format: int32 description: 模型深度 moduleName: type: string description: 模块名称,由前端传入;即当前操作的模块,比如:全屋定制衣柜模型、全屋定制衣柜贴图 orientation: type: integer format: int32 description: 开门方向:1-左开,2-右开 parts: type: string description: 部件属性 picHeight: type: number format: double description: 高 picLength: type: number format: double description: 长 picWidth: type: number format: double description: 宽 placeHeight: type: string description: 放置高度 placeRule: type: string description: 放置规则 productId: type: string description: 产品ID property: type: string description: 材质属性 publicCategoryId: type: integer format: int32 description: 公共库分类ID,注意:如果不传或传 null,将用 null quoteCode: type: string description: 报价编号 remark: type: string description: 备注 replaceImg: type: string description: 替换贴图 retailPrice: type: number format: double description: 零售价 sortNumber: type: integer format: int32 description: 序号 subParts: type: string description: 子部件属性 textureId: type: string description: 关联材质id thumbFileSize: type: integer format: int32 description: 截面库缩略图文件大小 thumbPath: type: string description: 截面库-解析xmlContent对应的图片路径-缩略图 wccId: type: string description: 欧派产品编号 weight: type: number format: double description: 重量 wholeSalePrice: type: number format: double description: 批发价 required: - materialId description: 素材信息 product: type: object properties: addSkus: type: array items: type: object properties: code: type: string description: 产品编号 costPrice: type: number format: double description: 出厂价 isDefault: type: boolean description: 是否默认报价 price: type: number format: double description: 售价 productLevel: type: string description: 产品等级 recordId: type: string description: skuid retailPrice: type: number format: double description: 市场价 required: - code - costPrice - isDefault - price - retailPrice description: 商品sku实体DTO brandId: type: integer format: int32 description: 品牌ID color: type: string description: 颜色 costPrice: type: number format: double description: 出厂价 deleteSkus: type: array items: {} description: 要删除的skuId detail: type: string description: 商品描述 hole: type: integer format: int32 description: 开孔尺寸。单位:mm installHeight: type: integer format: int32 description: 安装高度。单位:mm isShowPrice: type: boolean description: 3D素材页卡是否显示销售价格 lengthPerReel: type: integer format: int32 description: 灯带的每卷长度。单位:mm lightsTapeLength: type: integer format: int32 description: 灯带长度。单位:mm maker: type: string description: 制造商-生产厂家 model: type: string description: 型号 productCode: type: string description: 设备编号-产品编号 productName: type: string description: 商品名称 productType: type: string description: 产品类型 relatedMaterialId: type: string description: 产品相关联的素材ID-关联驱动器 retailPrice: type: number format: double description: 市场价 seriesId: type: integer format: int32 description: 系列ID unit: type: string description: 计价单位-报价单位 description: 产品信息 required: - designMaterial example: product: installHeight: 0 color: '' costPrice: 0 lightsTapeLength: 0 maker: '' deleteSkus: [] productName: '' seriesId: 0 hole: 0 unit: '' productCode: '' isShowPrice: false lengthPerReel: 0 brandId: 0 model: '' relatedMaterialId: '' detail: '' retailPrice: 0 addSkus: - code: '' costPrice: 0 recordId: '' isDefault: false productLevel: '' price: 0 retailPrice: 0 productType: '' designMaterial: picWidth: 0 holeWidth: 0 imagePath: '' sortNumber: 0 moduleName: '' is3d: 0 holeLength: 0 isRender: 0 property: '' thumbFileSize: 0 materialBallType: 0 quoteCode: '' brickId: '' isHasProduct: 0 lightProperty: '' picHeight: 0 wholeSalePrice: 0 productId: '' wccId: '' weight: 0 materialId: '' materialAttribute: '' materialCategory: '' publicCategoryId: 0 subParts: '' materialName: '' holeDepth: 0 parts: '' isOut: 0 holeRadius: 0 color: '' remark: '' textureId: '' interfaceDesc: '' enableMaterialBall: 0 isBumpMap: 0 isA3d: '' chartletFeatureCode: '' picLength: 0 isPublic: 0 thumbPath: '' attachmentPath: '' orientation: 0 materialType: '' costPrice: 0 holeSite: 0 replaceImg: '' bizLogDesc: '' modelDepth: 0 placeHeight: '' placeRule: '' contentUrl: '' colorCode: '' designCode: '' retailPrice: 0 categoryId: 0 responses: '200': description: 成功 / OK content: application/json: schema: type: object properties: success: type: boolean description: 请求是否成功 / whether the call succeeded code: type: integer description: 结果码 / result code (0 = success) msg: type: string description: 提示信息 / message data: type: object example: msg: '' code: 0 data: false success: false '401': description: access_token 缺失或已过期 / missing or expired access_token /api/v1/productMaterial/getModel: post: operationId: apiV1ProductMaterialGetModel summary: 根据素材ID获取成品类素材数据接口 tags: - Products x-source-documentation: https://dev.3vjia.com/document?apiId=841686263705800714 x-documentation-category: 产品模块 / 素材数据 requestBody: required: true content: application/json: schema: type: object properties: materialId: type: string description: 素材ID required: - materialId example: materialId: '' responses: '200': description: 成功 / OK content: application/json: schema: type: object properties: success: type: boolean description: 请求是否成功 / whether the call succeeded code: type: integer description: 结果码 / result code (0 = success) msg: type: string description: 提示信息 / message data: type: object properties: categoryPaths: type: array items: type: object properties: categoryId: type: integer format: int32 description: 分类ID categoryName: type: string description: 分类名称 child: type: object properties: categoryId: type: integer format: int32 description: 分类ID categoryName: type: string description: 分类名称 child: type: object description: 素材分类路径 isShow: type: integer format: int32 description: 是否显示 description: 素材分类路径 isShow: type: integer format: int32 description: 是否显示 skuId: type: integer format: int64 description: SKU ID description: 带有 SKU ID 的素材分类路径 chartlets: type: array items: type: object properties: fileId: type: string description: 上传文件记录ID fileName: type: string description: 文件名称 filePath: type: string description: 文件路径 isMainImage: type: string description: 是否主图 subjectId: type: string description: 关联ID description: 关联贴图VO continuousPattern: type: object properties: col: type: integer format: int32 description: 列数 isActive: type: integer format: int32 description: 是否激活 row: type: integer format: int32 description: 行数 sequencePaveIdList: type: array items: {} description: 连纹排序,元素是上传记录的subjectId sequencePaveIdMatrix: type: array items: {} description: 连纹排序二维数组,元素是上传记录的subjectId required: - col - isActive - row - sequencePaveIdList - sequencePaveIdMatrix description: 连纹排序 designMaterial: type: object properties: attachmentPath: type: string description: attachmentPath belongType: type: integer format: int32 description: 素材归属 brickId: type: string description: 异型砖 brickImagePath: type: string description: 异型砖图片 categoryId: type: integer format: int32 description: 素材分类ID categoryName: type: string description: 素材分类名称 chartletFeatureCode: type: string description: 贴图特征码 classification: type: integer format: int32 description: 素材类别,1-模型,2-贴图,3-线条 color: type: string description: 色号 colorCode: type: string description: 色号编码 contentUrl: type: string description: XML文件路径 costPrice: type: number format: double description: 成本价 designCode: type: string description: 素材编号 enableMaterialBall: type: integer format: int32 description: 是否启用材质球 holeDepth: type: integer format: int32 description: (圆孔)深/(方孔)高 holeLength: type: number format: double description: 开孔尺寸-长 holeRadius: type: integer format: int32 description: (圆孔)半径 holeSite: type: integer format: int32 description: 孔位:1-方孔,2-圆孔 holeWidth: type: number format: double description: 开孔尺寸-宽 imagePath: type: string description: 主图 is3d: type: integer format: int32 description: 启用3D状态 isA3d: type: string description: 是否模型 isBumpMap: type: integer format: int32 description: 是否凹凸贴图 isCustomMaterialBall: type: integer format: int32 description: 是否企业材质球:0-否,1-是 isHasProduct: type: integer format: int32 description: 是否参与报价 isOut: type: integer format: int32 description: “淘汰”状态 0 正常 1 淘汰 isPublic: type: integer format: int32 description: 是否公用 isRender: type: integer format: int32 description: 是否可渲染,0不可渲染,1可渲染 lightProperty: type: string description: 灯光属性 materialAttribute: type: string description: 属性类别 materialBallCategoryId: type: string description: 新版材质球分类 materialBallType: type: integer format: int32 description: 材质类型,1=旧材质,2=新材质 materialCategory: type: string description: 材料分类 materialId: type: string description: 素材ID materialName: type: string description: 素材名称 materialType: type: string description: 素材类别 modelDepth: type: number format: double description: 放置高度 modelFlag: type: integer format: int32 description: 模型标志 orientation: type: integer format: int32 description: 开门方向 parts: type: string description: 部件属性 picHeight: type: number format: double description: 高 picLength: type: number format: double description: 长 picWidth: type: number format: double description: 宽 placeHeight: type: string description: 模型深度 placeRule: type: string description: 放置规则 productId: type: string description: 产品ID property: type: string description: 材质属性 publicCategoryId: type: integer format: int32 description: 公共库分类ID publicCategoryName: type: string description: 公共库分类名称 quoteCode: type: string description: 报价编号 remark: type: string description: 备注 replaceImg: type: string description: 替换贴图 retailPrice: type: number format: double description: 零售价 subParts: type: string description: 子部件属性 textureId: type: string description: 关联材质id textureImagePath: type: string description: 关联材质主图 thumbPath: type: string description: 3D缩略图 wccId: type: string description: 欧派产品编号 weight: type: number format: double description: 重量 wholeSalePrice: type: number format: double description: 批发价 description: 素材信息 externalUrl: type: string description: 商品外链URL lightingMaterialExtendVO: type: object properties: beamAngle: type: integer format: int32 description: 光束角,单位:度。-999:未知 beamShape: type: object properties: beamShapeType: type: integer format: int32 description: 光束形状。0-未知;1-圆形;2-矩形 diameter: type: integer format: int32 description: 圆形-直径。单位:mm length: type: integer format: int32 description: 矩形-长。单位:mm width: type: integer format: int32 description: 矩形-宽。单位:mm color: type: object properties: colorType: type: integer format: int32 description: 颜色/色温类型。0-无极型;1-范围型;2-档位型 currentGear: type: integer format: int32 description: 档位型-当前所选档位 gears: type: array items: {} description: 档位型-档位列表 maxColorTemperature: type: integer format: int32 description: 范围型-最大色温。单位:K minColorTemperature: type: integer format: int32 description: 范围型-最小色温。单位:K cri: type: integer format: int32 description: 显色指数。-1:未知 graphImage: type: string description: 曲线图URL lightingTagId: type: integer format: int64 description: 照明标签 luminousFlux: type: number format: bigdecimal description: 光通量,单位:lm。-1:未知 power: type: number format: bigdecimal description: 功率,单位:W。-1:未知 previewImage: type: string description: 预览图URL mainPicSubjectId: type: string description: 主图关联ID materialCategoryList: type: array items: type: object properties: categoryId: type: integer format: int32 description: 分类id categoryName: type: string description: 分类名称 childNodes: type: array items: {} description: 分类标签出参 isShow: type: integer format: int32 description: 是否显示 1显示 0隐藏 description: 分类标签出参 materialScheduleDTO: type: object properties: beginTime: type: string format: date-time description: 上架时间 channelId: type: string description: 渠道id endTime: type: string format: date-time description: 下架时间 materialId: type: string description: 素材id description: 素材上下架 materialVersionControllDTO: type: object properties: adminVersion: type: integer format: int32 description: 入库人员素材版本,0=随最新版本 checkVersion: type: integer format: int32 description: 3D检测版本号, 0 = 无版本号, designPreVersion: type: integer format: int32 description: 设计师上一个素材版本 designVersion: type: integer format: int32 description: 设计师素材版本 enableCheckVersion: type: integer format: int32 description: 启用3D版本检测, 1 = 启用, 0 = 禁用 version: type: integer format: int32 description: 最新素材版本 versionRecordList: type: array items: type: object properties: author: type: string contentUrl: type: string createTime: type: string format: date-time designCode: type: string expirationTime: type: string format: date-time imagePath: type: string isRelate: type: integer format: int32 isUnit: type: integer format: int32 limitSize: type: integer format: int32 materialId: type: string materialIds: type: string materialType: type: string nickName: type: string orderBy: type: string parts: type: string placeHeight: type: string placeRule: type: string postTime: type: string format: date-time recordId: type: string subParts: type: string userId: type: string userName: type: string version: type: integer format: int32 versionRemark: type: string xmlContentUrl: type: string description: 素材历史版本列表,详情接口才有该数据 description: 素材信息 mixPaveImgs: type: array items: type: object properties: concaveConvexImgs: type: array items: type: object properties: fileId: type: string description: 上传文件记录ID fileName: type: string description: 文件名称 filePath: type: string description: 文件路径 isMainImage: type: string description: 是否主图 subjectId: type: string description: 关联ID description: 关联贴图VO fileId: type: string description: 文件ID fileName: type: string description: 文件名称 filePath: type: string description: 混铺图片路径 materialId: type: string description: 混铺图片素材ID reflexGlossinessImgs: type: array items: type: object properties: fileId: type: string description: 上传文件记录ID fileName: type: string description: 文件名称 filePath: type: string description: 文件路径 isMainImage: type: string description: 是否主图 subjectId: type: string description: 关联ID description: 关联贴图VO subjectId: type: string description: 关联ID description: 混铺图片视图 mixPaveSetting: type: string description: 混铺设置 oldMaterialCategory: type: object properties: categoryId: type: integer format: int32 categoryName: type: string product: type: object properties: brandId: type: integer format: int32 description: 品牌ID color: type: string description: 颜色 costPrice: type: number format: double description: 出厂价 detail: type: object description: 商品描述 hole: type: integer format: int32 description: 开孔尺寸。单位:mm installHeight: type: integer format: int32 description: 安装高度。单位:mm isShowPrice: type: boolean description: 3D素材页卡是否显示销售价格 lengthPerReel: type: integer format: int32 description: 灯带的每卷长度。单位:mm lightsTapeLength: type: integer format: int32 description: 灯带长度。单位:mm maker: type: string description: 制造商-生产厂家 model: type: string description: 型号 productCode: type: string description: 设备编号-产品编号 productImgs: type: array items: type: object properties: fileId: type: string description: 文件ID fileName: type: string description: 文件名 filePath: type: string description: 文件路径 subjectId: type: string description: 关联ID description: 上传文件返回结果 productName: type: string description: 商品名称 productType: type: string description: 产品类型 relatedMaterialId: type: string description: 产品相关联的素材ID-关联驱动器ID relatedMaterialName: type: string description: 产品相关联的素材名称-关联驱动器名称 retailPrice: type: number format: double description: 售价 seriesId: type: string description: 系列ID skus: type: array items: type: object properties: code: type: string description: 产品编号 costPrice: type: number format: double description: 出厂价 price: type: number format: double description: 售价 productLevel: type: string description: 产品等级 recordId: type: string description: skuid retailPrice: type: number format: double description: 市场价 description: 商品sku实体VO specifications: type: string description: 规格-功率 unit: type: string description: 计价单位-报价单位 wholeSalePrice: type: number format: double description: 市场价 description: 产品信息 realityImgs: type: array items: type: object properties: fileId: type: string description: 上传文件记录ID fileName: type: string description: 文件名称 filePath: type: string description: 文件路径 isMainImage: type: string description: 是否主图 subjectId: type: string description: 关联ID description: 关联贴图VO shareRelations: type: array items: type: object properties: fileId: type: string description: 模型文件ID fileName: type: string description: 文件名称 filePath: type: string description: 模型图 productCodeId: type: string description: sku产品编号 shareMaterials: type: array items: type: object properties: fileId: type: string description: 上传文件记录ID imagePath: type: string description: 素材贴图路径 materialId: type: string description: 素材ID relationId: type: string description: 关联ID description: 关联贴图VO description: 模型文件关联材质VO specialTexture: type: string description: 特殊纹理 tags: type: array items: type: object properties: id: type: integer format: int32 description: 关联ID tagId: type: integer format: int32 description: 标签ID tagName: type: string description: 标签名称 description: 标签列表 vrsceneImgs: type: array items: type: object properties: fileId: type: string description: 上传文件记录ID fileName: type: string description: 文件名称 filePath: type: string description: 文件路径 isMainImage: type: string description: 是否主图 subjectId: type: string description: 关联ID description: 关联贴图VO xmlContentUrl: type: string description: xml内容url required: - continuousPattern example: msg: '' code: 0 data: mainPicSubjectId: '' externalUrl: '' materialScheduleDTO: materialId: '' beginTime: '' endTime: '' channelId: '' product: installHeight: 0 skus: - code: '' costPrice: 0 recordId: '' productLevel: '' price: 0 retailPrice: 0 wholeSalePrice: 0 color: '' costPrice: 0 lightsTapeLength: 0 maker: '' productImgs: - fileName: '' filePath: '' subjectId: '' fileId: '' specifications: '' productName: '' seriesId: '' hole: 0 unit: '' productCode: '' isShowPrice: false lengthPerReel: 0 brandId: 0 model: '' relatedMaterialId: '' detail: '' relatedMaterialName: '' retailPrice: 0 productType: '' shareRelations: - fileName: '' productCodeId: '' shareMaterials: - imagePath: '' relationId: '' materialId: '' fileId: '' filePath: '' fileId: '' mixPaveSetting: '' categoryPaths: - categoryName: '' isShow: 0 categoryId: 0 skuId: 0 child: categoryName: '' isShow: 0 categoryId: 0 child: '' continuousPattern: col: 0 sequencePaveIdMatrix: [] isActive: 0 sequencePaveIdList: [] row: 0 materialVersionControllDTO: adminVersion: 0 designVersion: 0 checkVersion: 0 enableCheckVersion: 0 designPreVersion: 0 version: 0 versionRecordList: - imagePath: '' orderBy: '' xmlContentUrl: '' recordId: '' postTime: '' isRelate: 0 materialIds: '' versionRemark: '' limitSize: 0 author: '' nickName: '' isUnit: 0 materialType: '' materialId: '' userName: '' userId: '' version: 0 subParts: '' placeHeight: '' placeRule: '' contentUrl: '' createTime: '' expirationTime: '' parts: '' designCode: '' materialCategoryList: - childNodes: [] categoryName: '' isShow: 0 categoryId: 0 realityImgs: - fileName: '' filePath: '' subjectId: '' isMainImage: '' fileId: '' vrsceneImgs: - fileName: '' filePath: '' subjectId: '' isMainImage: '' fileId: '' xmlContentUrl: '' tags: - tagId: 0 tagName: '' id: 0 lightingMaterialExtendVO: color: maxColorTemperature: 0 minColorTemperature: 0 colorType: 0 currentGear: 0 gears: [] beamAngle: 0 graphImage: '' luminousFlux: 0 lightingTagId: 0 beamShape: beamShapeType: 0 length: 0 diameter: 0 width: 0 cri: 0 power: 0 previewImage: '' designMaterial: picWidth: 0 publicCategoryName: '' holeWidth: 0 imagePath: '' brickImagePath: '' is3d: 0 holeLength: 0 modelFlag: 0 isRender: 0 property: '' materialBallType: 0 quoteCode: '' brickId: '' isHasProduct: 0 lightProperty: '' picHeight: 0 wholeSalePrice: 0 productId: '' wccId: '' weight: 0 classification: 0 materialId: '' materialAttribute: '' materialCategory: '' publicCategoryId: 0 subParts: '' materialName: '' holeDepth: 0 parts: '' isOut: 0 holeRadius: 0 color: '' remark: '' textureId: '' categoryName: '' enableMaterialBall: 0 isBumpMap: 0 isA3d: '' chartletFeatureCode: '' picLength: 0 isPublic: 0 materialBallCategoryId: '' thumbPath: '' textureImagePath: '' attachmentPath: '' belongType: 0 orientation: 0 materialType: '' costPrice: 0 holeSite: 0 isCustomMaterialBall: 0 replaceImg: '' modelDepth: 0 placeHeight: '' placeRule: '' contentUrl: '' colorCode: '' designCode: '' retailPrice: 0 categoryId: 0 mixPaveImgs: - fileName: '' filePath: '' materialId: '' subjectId: '' reflexGlossinessImgs: - fileName: '' filePath: '' subjectId: '' isMainImage: '' fileId: '' concaveConvexImgs: - fileName: '' filePath: '' subjectId: '' isMainImage: '' fileId: '' fileId: '' specialTexture: '' chartlets: - fileName: '' filePath: '' subjectId: '' isMainImage: '' fileId: '' oldMaterialCategory: categoryName: '' categoryId: 0 success: false '401': description: access_token 缺失或已过期 / missing or expired access_token /api/v1/publicServiceApi/getAssetAppDetailByPage: post: operationId: apiV1PublicServiceApiGetAssetAppDetailByPage summary: 分页查询资产应用详情接口 tags: - Dreamer x-source-documentation: https://dev.3vjia.com/document?apiId=619599213860380741 x-documentation-category: 梦想家 requestBody: required: true content: application/json: schema: type: object properties: categoryId: type: integer format: int64 description: 目录id categoryLibId: type: integer format: int64 description: 目录库id current: type: integer format: int64 description: 当前查询第几页 size: type: integer format: int64 description: 当前查询页记录数 sort: type: array items: type: object properties: ascending: type: boolean description: 字段排序规则 normalized: type: boolean description: 是否已经规范化,即字段名与数据库字段已经一致,false的时候会将驼峰转下划线 property: type: string description: 根据哪个字段进行排序 description: 排序定义 required: - categoryLibId - current - size example: categoryLibId: 0 sort: - normalized: false ascending: false property: '' current: 0 size: 0 categoryId: 0 responses: '200': description: 成功 / OK content: application/json: schema: type: object properties: success: type: boolean description: 请求是否成功 / whether the call succeeded code: type: integer description: 结果码 / result code (0 = success) msg: type: string description: 提示信息 / message data: type: object properties: current: type: integer format: int64 description: 当前查询第几页 records: type: array items: type: object properties: assetItemIdList: type: array items: {} description: 单资产id列表 assetProjectId: type: integer format: int64 description: 资产集合id assetProjectName: type: string description: 资产集合名称 assetProjectObjectId: type: string description: 资产集合类型id:方案id,展厅id categoryAndTagInfoList: type: array items: type: object properties: id: type: integer format: int64 description: id name: type: string description: 名称 type: type: integer format: int32 description: 类型:1 为目录 2 为标签 description: 对外接口返回数据 categoryLibName: type: string description: 目录库名 createTime: type: string format: date-time description: 创建时间 creatorId: type: string description: 创建人 id: type: integer format: int64 description: 主键id imagePath: type: string description: 封面 modifierId: type: string description: 更新人 modifyTime: type: string format: date-time description: 更新时间 projectType: type: integer format: int32 description: 项目类型:方案1,展厅2 quoteXml: type: string description: 方案所对应的报价xml sortNum: type: integer format: int32 description: 排序值 status: type: integer format: int32 description: 状态,1上架,0未上架 tenantId: type: string description: 租户 uploadUsername: type: string description: 上传者 required: - createTime - creatorId - modifierId - modifyTime description: 对外接口返回数据 size: type: integer format: int64 description: 当前查询页记录数 total: type: integer format: int64 description: 总数 required: - current - size - total example: msg: '' code: 0 data: records: - quoteXml: '' imagePath: '' creatorId: '' modifierId: '' projectType: 0 uploadUsername: '' modifyTime: '' assetProjectId: 0 assetProjectObjectId: '' createTime: '' tenantId: '' categoryAndTagInfoList: - type: 0 name: '' id: 0 sortNum: 0 id: 0 assetItemIdList: [] assetProjectName: '' categoryLibName: '' status: 0 current: 0 total: 0 size: 0 success: false '401': description: access_token 缺失或已过期 / missing or expired access_token /api/v1/publicServiceApi/getOwnerClue: post: operationId: apiV1PublicServiceApiGetOwnerClue summary: 业主线索获取接口 tags: - Dedicated Services x-source-documentation: https://dev.3vjia.com/document?apiId=794222094744457314 x-documentation-category: 专属服务 / C00002170 requestBody: required: true content: application/json: schema: type: object properties: clueType: type: integer format: int32 description: 线索类型 0页面访问、1生图、2留资、3查看大图、4查看视频 current: type: integer format: int64 description: 当前查询第几页 guideIds: type: array items: {} description: 导购ids size: type: integer format: int64 description: 当前查询页记录数 sort: type: array items: type: object properties: ascending: type: boolean description: 字段排序规则 normalized: type: boolean description: 是否已经规范化,即字段名与数据库字段已经一致,false的时候会将驼峰转下划线 property: type: string description: 根据哪个字段进行排序 description: 排序定义 beginTime: type: string format: date-time description: 开始时间, 2026-01-04 09:01:01 endTime: type: string format: date-time description: 结束时间, 2026-01-04 09:01:01 required: - current - size example: clueType: 0 sort: - normalized: false ascending: false property: '' current: 0 guideIds: [] size: 0 beginTime: '' endTime: '' responses: '200': description: 成功 / OK content: application/json: schema: type: object properties: success: type: boolean description: 请求是否成功 / whether the call succeeded code: type: integer description: 结果码 / result code (0 = success) msg: type: string description: 提示信息 / message data: type: object properties: current: type: integer format: int64 description: 当前查询第几页 records: type: array items: type: object properties: clueTime: type: string format: date-time description: 访问时间 clueType: type: integer format: int32 description: 线索类型 0页面访问、1生图、2留资、3查看大图、4查看视频 guideId: type: string description: 导购id(三维家的用户id) imageList: type: array items: {} description: 查看图片类型,图片url集合 inputImageList: type: array items: {} description: 生图类型,输入图像集合 openId: type: string description: 微信ID(OpenID) outputImageList: type: array items: {} description: 生图类型,输出图像集合 toolName: type: string description: 工具名称:户型/布局生图,线框图生图,柜子棚拍,改门板,改柜体材质,改台面,换柜子,加柜子,改风格,高清放大,毛坯图生图,精装房生图,旧房图生图,改地面,改墙面,家具棚拍,换家具,加家具,改家具材质,加窗帘,换窗帘,改窗帘材质,换外墙,换地坪,换内墙,换壁纸,AI视频,换墙板,换门,换整门材质,换窗,换窗户材质,以文生图,以文改图,AI抠图,颜色校正,换花色,改墙板材质,全屋清空,物品清除 url: type: string description: 访问链接 videoList: type: array items: {} description: 查看视频类型,视频url集合 description: 业主线索对外接口返回数据 size: type: integer format: int64 description: 当前查询页记录数 total: type: integer format: int64 description: 总数 required: - current - size - total example: msg: '' code: 0 data: records: - clueType: 0 outputImageList: [] openId: '' guideId: '' url: '' inputImageList: [] clueTime: '' videoList: [] imageList: [] toolName: '' current: 0 total: 0 size: 0 success: false '401': description: access_token 缺失或已过期 / missing or expired access_token /api/v1/publicServiceApi/zbBoardHardwareSave: post: operationId: apiV1PublicServiceApiZbBoardHardwareSave summary: 保存板材五金资产接口 tags: - Dedicated Services x-source-documentation: https://dev.3vjia.com/document?apiId=642744763220647996 x-documentation-category: 专属服务 / C00002170 requestBody: required: true content: application/json: schema: type: object properties: assetName: type: string description: 资产名称 assetType: type: integer format: int32 description: 类型,工艺:25;五金配件:26;功能收纳:27;材质:28; id: type: string description: 志邦板材五金对象id imagePath: type: string description: 封面图 pictureList: type: array items: type: object properties: id: type: string description: 志邦图片对象id,废弃 imagePath: type: string description: 志邦图片路径 required: - imagePath description: 公共服务 志邦U客资产关联图片 tagIdList: type: array items: {} description: 关联的志邦标签id列表 newCode: type: string description: 新编码 oldCode: type: string description: 旧编码 simpleIntroduce: type: string description: 说明简略 required: - assetName - assetType - id example: imagePath: '' simpleIntroduce: '' assetType: 0 oldCode: '' assetName: '' id: '' pictureList: - imagePath: '' id: '' tagIdList: [] newCode: '' responses: '200': description: 成功 / OK content: application/json: schema: type: object properties: success: type: boolean description: 请求是否成功 / whether the call succeeded code: type: integer description: 结果码 / result code (0 = success) msg: type: string description: 提示信息 / message data: type: object example: msg: '' code: 0 data: false success: false '401': description: access_token 缺失或已过期 / missing or expired access_token /api/v1/publicServiceApi/zbUnionAssetCreate: post: operationId: apiV1PublicServiceApiZbUnionAssetCreate summary: U客资产创建接口 tags: - Dedicated Services x-source-documentation: https://dev.3vjia.com/document?apiId=636988951487471623 x-documentation-category: 专属服务 / C00002170 requestBody: required: true content: application/json: schema: type: object properties: assetName: type: string description: 资产名称 customAddress: type: string description: 自定义地址 id: type: string description: 志邦U客对象id imagePath: type: string description: 资产图片路径 panoramaPath: type: string description: 全景图路径 pictureList: type: array items: type: object properties: id: type: string description: 志邦图片对象id imagePath: type: string description: 志邦图片路径 required: - id - imagePath description: 公共服务 志邦U客资产关联图片 simpleIntroduce: type: string description: 说明简略 tagIdList: type: array items: {} description: 关联的志邦标签id列表 houseTypePath: type: string description: 图片路径-户型图 layoutPath: type: string description: 图片路径-布局图 city: type: string description: 城市 province: type: string description: 省份 required: - assetName - id example: panoramaPath: '' city: '' imagePath: '' simpleIntroduce: '' houseTypePath: '' layoutPath: '' province: '' assetName: '' id: '' pictureList: - imagePath: '' id: '' tagIdList: [] customAddress: '' responses: '200': description: 成功 / OK content: application/json: schema: type: object properties: success: type: boolean description: 请求是否成功 / whether the call succeeded code: type: integer description: 结果码 / result code (0 = success) msg: type: string description: 提示信息 / message data: type: object example: msg: '' code: 0 data: false success: false '401': description: access_token 缺失或已过期 / missing or expired access_token /api/v1/publicServiceApi/zbUnionAssetUpdate: post: operationId: apiV1PublicServiceApiZbUnionAssetUpdate summary: U客资产修改接口 tags: - Dedicated Services x-source-documentation: https://dev.3vjia.com/document?apiId=636988951487471625 x-documentation-category: 专属服务 / C00002170 requestBody: required: true content: application/json: schema: type: object properties: assetName: type: string description: 资产名称 customAddress: type: string description: 自定义地址 id: type: string description: 志邦U客对象id imagePath: type: string description: 资产图片路径 panoramaPath: type: string description: 全景图路径 pictureList: type: array items: type: object properties: id: type: string description: 志邦图片对象id imagePath: type: string description: 志邦图片路径 required: - id - imagePath description: 公共服务 志邦U客资产关联图片 simpleIntroduce: type: string description: 说明简略 tagIdList: type: array items: {} description: 关联的标签id列表 updatePictureList: type: boolean description: true:更新pictureList updateTagIdList: type: boolean description: true:更新tagIdList houseTypePath: type: string description: 图片路径-户型图 layoutPath: type: string description: 图片路径-布局图 city: type: string description: 城市 province: type: string description: 省份 required: - id example: panoramaPath: '' updatePictureList: false city: '' imagePath: '' simpleIntroduce: '' updateTagIdList: false houseTypePath: '' layoutPath: '' province: '' assetName: '' id: '' pictureList: - imagePath: '' id: '' tagIdList: [] customAddress: '' responses: '200': description: 成功 / OK content: application/json: schema: type: object properties: success: type: boolean description: 请求是否成功 / whether the call succeeded code: type: integer description: 结果码 / result code (0 = success) msg: type: string description: 提示信息 / message data: type: object example: msg: '' code: 0 data: false success: false '401': description: access_token 缺失或已过期 / missing or expired access_token /api/v1/quanyou/getOrderQuoteInfo: post: operationId: apiV1QuanyouGetOrderQuoteInfo summary: 获取订单报价信息 tags: - Dedicated Services x-source-documentation: https://dev.3vjia.com/document?apiId=789576721564319829 x-documentation-category: 专属服务 / C11876880 requestBody: required: true content: application/json: schema: type: object properties: orderCode: type: string description: 工厂单号,和工厂单ID二选一。 orderId: type: string description: 工厂单id,和工厂单号二选一。 solutionId: type: string description: 报价方案ID required: - solutionId example: orderId: '' orderCode: '' solutionId: '' responses: '200': description: 成功 / OK content: application/json: schema: type: object properties: success: type: boolean description: 请求是否成功 / whether the call succeeded code: type: integer description: 结果码 / result code (0 = success) msg: type: string description: 提示信息 / message data: type: object properties: accountInfo: type: object properties: accountLogo: type: string accountLogoImage: type: string accountName: type: string description: 机构信息 amountMoney: type: string description: 总金额 distriamountMoney: type: string description: 分销金额 facamountMoney: type: string description: 面值金额 obsTagId: type: string description: obs标签id obsTagKeyId: type: string description: obs标签keyId orderInfo: type: object properties: acceptTime: type: object description: 确认优化时间 bomTime: type: object description: 确认优化时间 consigneeAddress: type: string description: 收货地址 contactRealName: type: string description: 联系人 contactWay: type: string description: 联系方式 createTime: type: object description: 确认优化时间 customOrderNo: type: string description: 关联销售单的自定义单号 customerAddress: type: string description: 业主地址街道 customerArea: type: string description: 业主地址区 customerCity: type: string description: 业主地址市 customerId: type: string description: 业主ID customerName: type: string description: 业主姓名 customerPhone: type: string description: 业主电话 customerProvince: type: string description: 业主地址省 deliveryDate: type: object description: 期望交付日期 externalProjectId: type: string description: 外部项目ID factoryAuditTime: type: object description: 确认优化时间 factoryPrice: type: object isTableBoard: type: integer format: int32 description: 是否有台面板,0:否,1:是 isValid: type: integer format: int32 description: 订单是否作废0=否1=是 material: type: string description: 主材质 moduleCode: type: string description: 下单模块编码 moduleName: type: string description: 下单模块名称 orderCode: type: string description: 订单编号(工厂订单号) orderType: type: string description: 订单类型编码 orderTypeDictKey: type: string description: 订单类型字典Key orderTypeDictVal: type: string description: 订单类型字典Value orderTypeName: type: string description: 订单类型 organDealerCode: type: string description: 经销商编码 organDealerId: type: integer format: int64 description: 企业经销商ID organDealerName: type: string description: 企业经销商名称 placeType: type: string description: 下单类型编码 placeTypeName: type: string description: 订单状态的代码 platformOrderCode: type: string description: 工厂订单号,三维家订单系统的CRM模块使用 platformOrderId: type: string description: 工厂订单Id platformOrderName: type: string description: 工厂订单名称 platformOrderschemeId: type: string description: 工厂订单关联的方案id platformStatus: type: string description: 工厂订单状态 platformStatusName: type: string description: 工厂订单状态名称 productTotalPrice: type: object productionAmount: type: object quoteTime: type: object description: 确认优化时间 receiverType: type: string description: 收货人类型customer=业主shop=门店 remarks: type: string description: 3D设计页面下单备注 salesPrice: type: object shopCode: type: string description: 门店编码 shopId: type: string description: 门店id shopName: type: string description: 门店名称 shopOrderCode: type: string description: 销售订单号 shopOrderId: type: integer format: int64 description: 销售订单ID shopOrderSubmitTime: type: object description: 确认优化时间 shopRemark: type: string description: 门店订单备注 splitStatus: type: integer format: int32 description: 拆单状态0未拆单-1退回,1拆单中 submitUserName: type: string description: 店铺订单提交人账号 submitUserPhone: type: string description: 店铺订单提交人手机号码 submitUserRealName: type: string description: 店铺订单提交人用户姓名 totalArea: type: object totalPrice: type: object urlParam: type: string description: 外部参数 validReason: type: string description: 作废原因 workOrderNo: type: string description: 企业工单号 description: 获取工厂订单信息 quotationItems: type: object rooms: type: array items: type: object properties: roomId: type: string roomName: type: string description: 房间信息 tagName: type: string description: obs标签名称 tags: type: array items: {} description: 标签信息 example: msg: '' code: 0 data: accountInfo: accountLogo: '' accountLogoImage: '' accountName: '' rooms: - roomId: '' roomName: '' facamountMoney: '' distriamountMoney: '' tagName: '' tags: [] quotationItems: '' obsTagKeyId: '' orderInfo: orderType: '' productTotalPrice: '' salesPrice: '' moduleName: '' urlParam: '' submitUserPhone: '' platformOrderschemeId: '' bomTime: '' shopId: '' consigneeAddress: '' platformStatusName: '' customerAddress: '' isTableBoard: 0 customerProvince: '' acceptTime: '' orderTypeDictVal: '' customerArea: '' platformOrderName: '' customerName: '' splitStatus: 0 organDealerId: 0 placeType: '' factoryAuditTime: '' shopOrderId: 0 receiverType: '' externalProjectId: '' platformOrderCode: '' shopRemark: '' totalPrice: '' factoryPrice: '' shopName: '' customerCity: '' customOrderNo: '' customerPhone: '' submitUserName: '' placeTypeName: '' customerId: '' organDealerName: '' deliveryDate: '' platformOrderId: '' workOrderNo: '' shopCode: '' shopOrderCode: '' moduleCode: '' isValid: 0 orderTypeDictKey: '' platformStatus: '' submitUserRealName: '' orderTypeName: '' organDealerCode: '' quoteTime: '' validReason: '' material: '' createTime: '' contactWay: '' productionAmount: '' shopOrderSubmitTime: '' contactRealName: '' orderCode: '' remarks: '' totalArea: '' obsTagId: '' amountMoney: '' success: false '401': description: access_token 缺失或已过期 / missing or expired access_token /api/v1/queueok/get: post: operationId: apiV1QueueokGet summary: 根据id获取全景图 tags: - Common Services x-source-documentation: https://dev.3vjia.com/document?apiId=726736904120324142 x-documentation-category: 通用服务 description: 根据id获取全景图 requestBody: required: false content: application/json: schema: type: object properties: id: type: string description: 主键id example: id: '' responses: '200': description: 成功 / OK content: application/json: schema: type: object properties: success: type: boolean description: 请求是否成功 / whether the call succeeded code: type: integer description: 结果码 / result code (0 = success) msg: type: string description: 提示信息 / message data: type: object properties: fileFullPath: type: string description: 全景图路径,此路径为相对路径,需要拼上域名,域名为:https://3vj-render.3vjia.com fileName: type: string description: 名称 example: msg: '' code: 0 data: fileName: '' fileFullPath: '' success: false '401': description: access_token 缺失或已过期 / missing or expired access_token /api/v1/queueok/listEffectsByPage: post: operationId: apiV1QueueokListEffectsByPage summary: 获取效果图分页列表 tags: - Light Design x-source-documentation: https://dev.3vjia.com/document?apiId=736154292423118899 x-documentation-category: 轻设计 description: 获取布局方案效果图 requestBody: required: false content: application/json: schema: type: object properties: beginDate: type: string description: 开始时间 belongType: type: string description: 归属类型10:设计岛 definition: type: string description: 清晰度,标清:normal_standard、高清:normal_high、超清:normal_hyper4k:normal_4K definitionFlag: type: string description: 支持查8k(兼容旧definition字段)清晰度,标清:normal_standard、高清:normal_high、超清:normal_hyper4k:normal_4K,8k:normal_8K deptId: type: array items: {} description: "This is List Type \n部门ID" endDate: type: string description: 结束时间 extraId: type: string description: 扩展id extraIds: type: array items: {} description: "This is List Type \n扩展id集合" flag: type: array items: {} description: "This is List Type \n效果图类型0:普通渲染图,1:全景,2,鸟瞰图" includeMain: type: boolean description: 是否包含主图true包含false不包含默认false isDelete: type: integer format: int32 description: 是否删除 materialId: type: string description: 素材ID modifyDateBegin: type: string description: 更新时间开始 modifyDateEnd: type: string description: 更新时间结束 orderBy: type: string description: 排序默认:orderbycreateDatedesc organId: type: string description: 机构ID pageIndex: type: integer format: int32 description: 页码 pageSize: type: integer format: int32 description: 页大小 queueIds: type: array items: {} description: "This is List Type \n队列Ids" queueType: type: integer format: int32 description: 渲染类型queueType roomId: type: array items: {} description: "This is List Type \n空间ID" roomIdNull: type: integer format: int32 description: 空间Id为空筛选1查询空间ID为空的;0不查询;2查询空间不存在及空间id为空的,仅限传递userId以及方案id的情况 schemeId: type: string description: 方案编号ID schemeIds: type: array items: {} description: "This is List Type \n方案编号IDs" shopId: type: array items: {} description: "This is List Type \n门店id集合" templateVersion: type: string description: 任务类型标识 templateVersionList: type: array items: {} description: "This is List Type \n任务类型标识集合" example: flag: [] modifyDateEnd: '' endDate: '' definitionFlag: '' orderBy: '' pageSize: 0 schemeId: '' roomId: [] templateVersionList: [] definition: '' shopId: [] extraIds: [] belongType: '' includeMain: false isDelete: 0 deptId: [] materialId: '' queueIds: [] beginDate: '' schemeIds: [] modifyDateBegin: '' pageIndex: 0 extraId: '' organId: '' queueType: 0 templateVersion: '' roomIdNull: 0 responses: '200': description: 成功 / OK content: application/json: schema: type: object properties: success: type: boolean description: 请求是否成功 / whether the call succeeded code: type: integer description: 结果码 / result code (0 = success) msg: type: string description: 提示信息 / message data: type: object properties: pageIndex: type: integer format: int32 pageSize: type: integer format: int32 recordCount: type: integer format: int32 result: type: array items: type: object properties: buildingId: type: integer format: int64 description: 楼栋ID createDate: type: string description: 创建时间 definition: type: string description: 分辨率 deptId: type: string description: 部门ID depthImageUrl: type: string description: 深度图路径 extraId: type: string description: 扩展id fileFullPath: type: string description: 效果图路径 fileIdOutPut2: type: string description: 附件Id fileName: type: string description: 文件名 flag: type: integer format: int32 description: 效果图类型0:普通渲染图,1:全景,2,鸟瞰图 height: type: integer format: int32 description: 高 isDelete: type: integer format: int32 description: 是否删除 isHide: type: integer format: int32 description: 显示/隐藏 materialid: type: string description: 素材ID modifyDate: type: string description: 更新时间 movieId: type: string description: 神笔影片ID movieName: type: string description: 神笔影片名称 projectId: type: integer format: int64 description: 项目ID queueId: type: string description: 队列ID queueType: type: integer format: int32 description: 渲染类型queueType resolution: type: string description: 分辨率中文字符 roomId: type: string description: 空间ID schemeId: type: string description: 方案ID shopId: type: string description: 商家id showPath: type: string description: 全景封面图 source: type: integer format: int32 description: 来源0queueok表1renderuploadFile表 storeyId: type: integer format: int64 description: 楼层ID templateVersion: type: string description: 前端版本信息2.0-02.0增强品质-13.0-2容器化-100 userId: type: string description: 用户ID width: type: integer format: int32 description: 宽 description: 效果图,全景图请求参数 example: msg: '' code: 0 data: recordCount: 0 pageSize: 0 result: - fileIdOutPut2: '' queueId: '' fileName: '' flag: 0 showPath: '' movieId: '' schemeId: '' source: 0 materialid: '' resolution: '' roomId: '' fileFullPath: '' definition: '' shopId: '' movieName: '' createDate: '' height: 0 modifyDate: '' isDelete: 0 deptId: '' storeyId: 0 userId: '' buildingId: 0 isHide: 0 depthImageUrl: '' width: 0 extraId: '' queueType: 0 templateVersion: '' projectId: 0 pageIndex: 0 success: false '401': description: access_token 缺失或已过期 / missing or expired access_token /api/v1/quotation/getSchemeProductPrice: post: operationId: apiV1QuotationGetSchemeProductPrice summary: 获取方案成品清单接口 tags: - Design Schemes x-source-documentation: https://dev.3vjia.com/document?apiId=453646779758477328 x-documentation-category: 方案模块 / 方案数据 description: 获取方案成品清单,带单价、数量和金额信息,且只包含企业自己的素材 requestBody: required: true content: application/json: schema: type: object properties: schemeId: type: string description: 方案ID examples: - '51024567' required: - schemeId example: schemeId: '51024567' responses: '200': description: 成功 / OK content: application/json: schema: type: object properties: success: type: boolean description: 请求是否成功 / whether the call succeeded code: type: integer description: 结果码 / result code (0 = success) msg: type: string description: 提示信息 / message data: type: object properties: author: type: object properties: avatar: type: string description: 设计师头像 examples: - https://img3.admin.3vjia.com/UpFile/C00005842/ADMIN/UserSetting/202005/1001266879/89faef49527140eb883d7a5190c0048a.jpg mobile: type: string description: 手机号码 examples: - '13800000000' name: type: string description: 姓名 examples: - 小蔡 nickName: type: string description: 昵称 examples: - 小蔡 outUserId: type: string description: 账号绑定的企业系统用户ID examples: - '123456' userId: type: string description: 三维家用户ID examples: - '1000123456' userName: type: string description: 三维家账号 examples: - 3vj13800000000 description: 操作用户 dept: type: object properties: customerCode: type: string description: 部门对应客户部门编码 examples: - '12332' deptId: type: string description: 部门ID examples: - 00013678 deptName: type: string description: 部门名称 examples: - 运营管理部 outDeptId: type: string description: 部门所绑定企业系统部门ID,绑定过才有值 examples: - '123456' storeType: type: integer format: int32 description: 类型0=门店,1=部门 examples: - '1' description: 上级部门信息 organ: type: object properties: organId: type: string description: 企业ID examples: - C00000000 organName: type: string description: 企业名称 examples: - XXX信息科技 description: 部门所属机构信息 productList: type: array items: type: object properties: amount: type: object examples: - '1' materialId: type: string description: 素材id examples: - '12233' materialName: type: string description: 素材名称 examples: - 毛巾 num: type: object examples: - '12' price: type: object examples: - '160.3233' productCode: type: string description: 产品编码,取商品的默认SKU examples: - 3vjiawx-zh24-6 productName: type: string description: 商品名称 examples: - 3vjiawx-zh24-6 room: type: object properties: roomId: type: string description: 空间ID examples: - 2C8FF05E-60AF-DCE8-0FD1-DEE87A74FB86 roomName: type: string description: 空间名称 examples: - 主卧 description: 产品关联的空间信息 description: 方案成品报价结构,V2 schemeId: type: string description: 方案Id examples: - '50053081' schemeName: type: string description: 方案名称 examples: - 广州碧桂园·樾时光—毁梦3vj example: msg: '' code: 0 data: organ: organName: XXX信息科技 organId: C00000000 author: nickName: 小蔡 mobile: '13800000000' avatar: https://img3.admin.3vjia.com/UpFile/C00005842/ADMIN/UserSetting/202005/1001266879/89faef49527140eb883d7a5190c0048a.jpg outUserId: '123456' userName: 3vj13800000000 userId: '1000123456' name: 小蔡 schemeName: 广州碧桂园·樾时光—毁梦3vj schemeId: '50053081' dept: deptName: 运营管理部 storeType: 1 deptId: 00013678 customerCode: '12332' outDeptId: '123456' productList: - amount: '' num: '' materialId: '12233' productName: 3vjiawx-zh24-6 room: roomId: 2C8FF05E-60AF-DCE8-0FD1-DEE87A74FB86 roomName: 主卧 materialName: 毛巾 productCode: 3vjiawx-zh24-6 price: '' success: false '401': description: access_token 缺失或已过期 / missing or expired access_token /api/v1/quotation/getSchemeQuotationXml: post: operationId: apiV1QuotationGetSchemeQuotationXml summary: 获取方案定制模块报价XML数据接口 tags: - Quotation x-source-documentation: https://dev.3vjia.com/document?apiId=474665760673857559 x-documentation-category: 报价模块 description: 获取方案定制模块报价XML,只包含定制模块 requestBody: required: false content: application/json: schema: type: object properties: schemeId: type: string description: 方案ID examples: - '51024567' example: schemeId: '51024567' responses: '200': description: 成功 / OK content: application/json: schema: type: object properties: success: type: boolean description: 请求是否成功 / whether the call succeeded code: type: integer description: 结果码 / result code (0 = success) msg: type: string description: 提示信息 / message data: type: object properties: author: type: object properties: avatar: type: string description: 设计师头像 mobile: type: string description: 手机号码 name: type: string description: 姓名 nickName: type: string description: 昵称 outUserId: type: string description: 账号绑定的企业系统用户ID userId: type: string description: 三维家用户ID userName: type: string description: 三维家账号 description: 操作用户 dept: type: object properties: customerCode: type: string description: 部门对应客户部门编码 deptId: type: string description: 部门ID deptName: type: string description: 部门名称 outDeptId: type: string description: 部门所绑定企业系统部门ID,绑定过才有值 storeType: type: integer format: int32 description: 类型0=门店,1=部门 description: 上级部门信息 hasXmlDetail: type: boolean description: 此份xml里是否有明细的数据(存在方案内原本有柜子数据,后删除柜子保存,则最后的xml里是没有数据的可能) examples: - 'true' organ: type: object properties: organId: type: string description: 企业ID organName: type: string description: 企业名称 description: 部门所属机构信息 schemeId: type: string description: 方案Id examples: - '50053081' schemeName: type: string description: 方案名称 examples: - 广州碧桂园·樾时光—毁梦3vj xmlContent: type: string description: 报价xml的Base64字符串 examples: - Jmx0O1Jvb3QgQXBwbGljYXRpb249Ildvb2RNYWNoaW5lIiBBcHBsaWNhdGlvblZlcnNpb249IjMuMCIgdmVyc2lvbj0iMy4wLjExLjMzNzUiJmd0Ow0KJmx0Oy9Sb290Jmd0Ow== xmlSaveTime: type: string description: xml的保存时间,格式yyyy-MM-ddHH:mm:ss examples: - 2020-06-16 18::57:57 example: msg: 成功 code: 0 data: organ: organName: '' organId: '' author: nickName: '' mobile: '' avatar: '' outUserId: '' userName: '' userId: '' name: '' schemeName: 广州碧桂园·樾时光—毁梦3vj hasXmlDetail: true xmlSaveTime: 2020-06-16 18::57:57 schemeId: '50053081' dept: deptName: '' storeType: 0 deptId: '' customerCode: '' outDeptId: '' xmlContent: Jmx0O1Jvb3QgQXBwbGljYXRpb249Ildvb2RNYWNoaW5lIiBBcHBsaWNhdGlvblZlcnNpb249IjMuMCIgdmVyc2lvbj0iMy4wLjExLjMzNzUiJmd0Ow0KJmx0Oy9Sb290Jmd0Ow== success: true '401': description: access_token 缺失或已过期 / missing or expired access_token /api/v1/quotation/queryQuoteOrderResult: post: operationId: apiV1QuotationQueryQuoteOrderResult summary: 获取订单报价计算结果接口 tags: - MOS x-source-documentation: https://dev.3vjia.com/document?apiId=474661135744860172 x-documentation-category: MOS系统 / 订单报价 description: 获取订单报价计算结果,用发起订单报价计算接口返回的令牌查询 requestBody: required: true content: application/json: schema: type: object properties: key: type: string description: 查询令牌,发起订单报价计算接口返回的值 examples: - xxx required: - key example: key: xxx responses: '200': description: 成功 / OK content: application/json: schema: type: object properties: success: type: boolean description: 请求是否成功 / whether the call succeeded code: type: integer description: 结果码 / result code (0 = success) msg: type: string description: 提示信息 / message data: type: object properties: createUser: type: object properties: avatar: type: string description: 设计师头像 mobile: type: string description: 手机号码 name: type: string description: 姓名 nickName: type: string description: 昵称 outUserId: type: string description: 账号绑定的企业系统用户ID userId: type: string description: 三维家用户ID userName: type: string description: 三维家账号 description: 操作用户 customer: type: object properties: customerAddress: type: string description: 客户地址 customerCode: type: string description: 客户编码 customerId: type: string description: 客户ID customerMobile: type: string description: 客户手机 customerName: type: string description: 客户名称 description: 客户信息 diyOrderNo: type: string description: 自定义订单号 orderName: type: string description: 订单名称 orderNo: type: string description: 订单编号 orderRecordId: type: string description: 订单的通用ID,同一订单下店铺订单、工厂订单此值是相同的 orderTypeCode: type: string description: 订单类型code(YG,CG,XTG....) orderTypeId: type: string description: 订单类型(衣柜,橱柜,系统柜....)的ID orderTypeName: type: string description: 订单类型(衣柜,橱柜,系统柜....) quoteInfo: type: object description: 报价信息,此字段为可配置字段,结果动态 scheme: type: object properties: createTime: type: string description: 方案创建时间,格式yyyy-MM-ddHH:mm:ss imagePath: type: string description: 方案主图路径 modifyTime: type: string description: 方案最后修改时间,格式yyyy-MM-ddHH:mm:ss schemeId: type: string description: 方案ID schemeName: type: string description: 方案名称 totalArea: type: number format: double description: 方案总面积 description: 订单所关联的方案,从3D创建的订单此字段有值 shopDept: type: object properties: customerCode: type: string description: 部门对应客户部门编码 deptId: type: string description: 部门ID deptName: type: string description: 部门名称 outDeptId: type: string description: 部门所绑定企业系统部门ID,绑定过才有值 storeType: type: integer format: int32 description: 类型0=门店,1=部门 description: 上级部门信息 shopOrgan: type: object properties: organId: type: string description: 企业ID organName: type: string description: 企业名称 description: 部门所属机构信息 example: msg: '' code: 0 data: orderTypeCode: '' shopOrgan: organName: '' organId: '' orderNo: '' scheme: imagePath: '' schemeName: '' schemeId: '' modifyTime: '' createTime: '' orderTypeId: '' diyOrderNo: '' orderTypeName: '' orderRecordId: '' shopDept: deptName: '' storeType: 0 deptId: '' customerCode: '' outDeptId: '' createUser: nickName: '' mobile: '' avatar: '' outUserId: '' userName: '' userId: '' name: '' quoteInfo: '' customer: customerAddress: '' customerCode: '' customerName: '' customerId: '' customerMobile: '' orderName: '' success: false '401': description: access_token 缺失或已过期 / missing or expired access_token /api/v1/quotation/queryQuoteSchemeResult: post: operationId: apiV1QuotationQueryQuoteSchemeResult summary: 获取方案报价计算结果接口 tags: - Quotation x-source-documentation: https://dev.3vjia.com/document?apiId=474644013685772384 x-documentation-category: 报价模块 description: 获取报价计算结果,用提交报价计算任务接口返回的令牌查询 requestBody: required: true content: application/json: schema: type: object properties: key: type: string description: 查询令牌,发起报价计算接口返回的值 examples: - xxx required: - key example: key: xxx responses: '200': description: 成功 / OK content: application/json: schema: type: object properties: success: type: boolean description: 请求是否成功 / whether the call succeeded code: type: integer description: 结果码 / result code (0 = success) msg: type: string description: 提示信息 / message data: type: object properties: author: type: object properties: avatar: type: string description: 设计师头像 mobile: type: string description: 手机号码 name: type: string description: 姓名 nickName: type: string description: 昵称 outUserId: type: string description: 账号绑定的企业系统用户ID userId: type: string description: 三维家用户ID userName: type: string description: 三维家账号 description: 操作用户 dept: type: object properties: customerCode: type: string description: 部门对应客户部门编码 deptId: type: string description: 部门ID deptName: type: string description: 部门名称 outDeptId: type: string description: 部门所绑定企业系统部门ID,绑定过才有值 storeType: type: integer format: int32 description: 类型0=门店,1=部门 description: 上级部门信息 organ: type: object properties: organId: type: string description: 企业ID organName: type: string description: 企业名称 description: 部门所属机构信息 quoteInfo: type: object description: 报价信息,此字段为可配置字段,结果动态 schemeId: type: string description: 方案Id schemeName: type: string description: 方案名称 example: msg: success code: 0 data: organ: organName: '' organId: '' author: nickName: '' mobile: '' avatar: '' outUserId: '' userName: '' userId: '' name: '' schemeName: '' schemeId: '' dept: deptName: '' storeType: 0 deptId: '' customerCode: '' outDeptId: '' quoteInfo: '' success: true '401': description: access_token 缺失或已过期 / missing or expired access_token /api/v1/quotation/quoteOrder: post: operationId: apiV1QuotationQuoteOrder summary: 提交订单报价计算任务接口 tags: - MOS x-source-documentation: https://dev.3vjia.com/document?apiId=474664222039572484 x-documentation-category: MOS系统 / 订单报价 description: 发起订单报价计算,需要开通保存订单报价XML功能才可调用 requestBody: required: true content: application/json: schema: type: object properties: contentType: type: integer format: int32 description: 文件类型,0=设计文件,1=审核文件 examples: - '0' orderNo: type: string description: 订单号,订单ID、订单号至少传1项,当orderRecordId为空时,orderNo有效 examples: - 63CG19120402 orderRecordId: type: string description: 订单ID,店铺订单、工厂订单通用,同一订单的店铺订单、工厂订单的ID一致,订单ID、订单号至少传1项,当orderRecordId不为空时,将忽略orderNo examples: - F053521B72F34613BEAD2CC8B6279E75 outUserId: type: string description: 操作人-企业账号绑定时使用的企业用户ID,userId、userName、outUserId三个中,outUserId优先级第三 examples: - '123456' quoteSolutionCode: type: string description: 报价方案的编码,请在报价管理页面获取 examples: - CupboardSolution userId: type: string description: 操作人-三维家用户ID,userId、userName、outUserId三个中,userId优先级最高 examples: - '1000122456' userName: type: string description: 操作人-三维家账号,userId、userName、outUserId三个中,userName优先级第二 examples: - 3vj123456 required: - contentType - quoteSolutionCode example: orderNo: 63CG19120402 outUserId: '123456' userName: 3vj123456 userId: '1000122456' quoteSolutionCode: CupboardSolution orderRecordId: F053521B72F34613BEAD2CC8B6279E75 contentType: 0 responses: '200': description: 成功 / OK content: application/json: schema: type: object properties: success: type: boolean description: 请求是否成功 / whether the call succeeded code: type: integer description: 结果码 / result code (0 = success) msg: type: string description: 提示信息 / message data: type: object example: msg: 成功 code: 0 data: xxx success: true '401': description: access_token 缺失或已过期 / missing or expired access_token /api/v1/quotation/quoteScheme: post: operationId: apiV1QuotationQuoteScheme summary: 提交方案报价计算任务接口 tags: - Quotation x-source-documentation: https://dev.3vjia.com/document?apiId=474660108194910283 x-documentation-category: 报价模块 description: 只能计算方案报价,无法计算订单报价 requestBody: required: false content: application/json: schema: type: object properties: outUserId: type: string description: 操作人的绑定过三维家账号的企业系统的用户ID,当userId、userName为空时,outUserId有效 examples: - '123456' quoteSolutionCode: type: string description: 报价方案的编码,请在报价管理页面获取 examples: - CupboardSolution schemeId: type: string description: 方案ID examples: - '51024567' userId: type: string description: 操作人的三维家用户ID,若传了userId,当忽略userName、outUserId字段 examples: - '1000123456' userName: type: string description: 操作人的三维家账号,当userId为空时,userName有效,传了userName将忽略outUserId字段 examples: - 3vj13800000000 example: schemeId: '51024567' outUserId: '123456' userName: 3vj13800000000 userId: '1000123456' quoteSolutionCode: CupboardSolution responses: '200': description: 成功 / OK content: application/json: schema: type: object properties: success: type: boolean description: 请求是否成功 / whether the call succeeded code: type: integer description: 结果码 / result code (0 = success) msg: type: string description: 提示信息 / message data: type: object example: msg: success code: 0 data: 'true' success: true '401': description: access_token 缺失或已过期 / missing or expired access_token /api/v1/quote/calculation/quoteFileResult: post: operationId: apiV1QuoteCalculationQuoteFileResult summary: 获取报价文件URL接口 tags: - Quotation x-source-documentation: https://dev.3vjia.com/document?apiId=515955644919001090 x-documentation-category: 报价模块 requestBody: required: true content: application/json: schema: type: object properties: dataUrl: type: string description: 报价XML链接,schemeId、xmlContent、dataUrl有且只有1个不为空。 schemeId: type: string description: 方案ID,schemeId、xmlContent、dataUrl有且只有1个不为空。 templateId: type: string description: 报价模板ID xmlContent: type: string description: 报价XML内容,schemeId、xmlContent、dataUrl有且只有1个不为空。 orderCreateTime: type: string description: 下单时间,格式:yyyy-MM-dd HH:mm:ss,定制业务专用。 placeType: type: string description: 下单类型,定制业务专用。 userId: type: string description: 三维家用户ID,定制业务专用。 required: - templateId example: dataUrl: '' orderCreateTime: '' schemeId: '' templateId: '' userId: '' placeType: '' xmlContent: '' responses: '200': description: 成功 / OK content: application/json: schema: type: object properties: success: type: boolean description: 请求是否成功 / whether the call succeeded code: type: integer description: 结果码 / result code (0 = success) msg: type: string description: 提示信息 / message data: type: object example: msg: '' code: 0 data: '' success: false '401': description: access_token 缺失或已过期 / missing or expired access_token /api/v1/quote/calculation/quoteJsonResult: post: operationId: apiV1QuoteCalculationQuoteJsonResult summary: 获取报价JSON数据接口 tags: - Quotation x-source-documentation: https://dev.3vjia.com/document?apiId=515552877465382984 x-documentation-category: 报价模块 description: 报价JSON数据结构详情,请到【三维家工作台】-【报价管理】-【配置管理】-【接口配置】页面,按需配置结构和字段。 requestBody: required: false content: application/json: schema: type: object properties: dataUrl: type: string description: 报价XML链接,schemeId、xmlContent、dataUrl有且只有1个不为空。 schemeId: type: string description: 方案ID,schemeId、xmlContent、dataUrl有且只有1个不为空。 solutionCode: type: string description: 报价方案Code,solutionId、solutionCode有且只有1个不为空。 solutionId: type: string description: 报价方案ID,solutionId、solutionCode有且只有1个不为空。 xmlContent: type: string description: 报价XML内容,schemeId、xmlContent、dataUrl有且只有1个不为空。 orderCreateTime: type: string description: 下单时间,格式:yyyy-MM-dd HH:mm:ss,定制业务专用。 placeType: type: string description: 下单类型,定制业务专用。 userId: type: string description: 三维家用户ID,定制业务专用。 example: dataUrl: '' orderCreateTime: '' schemeId: '' userId: '' solutionCode: '' placeType: '' solutionId: '' xmlContent: '' responses: '200': description: 成功 / OK content: application/json: schema: type: object properties: success: type: boolean description: 请求是否成功 / whether the call succeeded code: type: integer description: 结果码 / result code (0 = success) msg: type: string description: 提示信息 / message data: type: object example: msg: '' code: 0 data: '' success: false '401': description: access_token 缺失或已过期 / missing or expired access_token /api/v1/quote/quoteXmlBiz/customQuoteExcelUrl: post: operationId: apiV1QuoteQuoteXmlBizCustomQuoteExcelUrl summary: 【已过时】获取报价文件URL接口 tags: - Quotation x-source-documentation: https://dev.3vjia.com/document?apiId=457112906782277719 x-documentation-category: 报价模块 requestBody: required: true content: application/json: schema: type: object properties: deptId: type: string description: 部门id module: type: string description: 至爱特殊module organId: type: string description: 机构Id quoteInfo: type: string description: quoteInfo schemeId: type: string description: schemeId solutionId: type: string description: 报价方案id userId: type: string description: userId userLevel: type: string description: 至爱特殊userLevel required: - organId example: module: '' deptId: '' schemeId: '' userId: '' userLevel: '' organId: '' solutionId: '' quoteInfo: '' responses: '200': description: 成功 / OK content: application/json: schema: type: object properties: success: type: boolean description: 请求是否成功 / whether the call succeeded code: type: integer description: 结果码 / result code (0 = success) msg: type: string description: 提示信息 / message data: type: object example: msg: '' code: 0 data: '' success: false '401': description: access_token 缺失或已过期 / missing or expired access_token /api/v1/roomMaterial/editChartlet: post: operationId: apiV1RoomMaterialEditChartlet summary: 编辑全屋定制贴图数据接口 tags: - Products x-source-documentation: https://dev.3vjia.com/document?apiId=605759206494199810 x-documentation-category: 产品模块 / 素材管理 requestBody: required: true content: application/json: schema: type: object properties: addMaterialCategoryIds: type: array items: {} description: 要新增的基材ID列表 designMaterial: type: object properties: categoryId: type: integer format: int32 description: 素材分类ID chartletFeatureCode: type: string description: 贴图特征码 color: type: string description: 色号 colorCode: type: string description: 色号编码 designCode: type: string description: 部件编号 enableMaterialBall: type: integer format: int32 description: 是否启用材质属性 is3d: type: integer format: int32 description: 启用3D状态 isOut: type: integer format: int32 description: 是否淘汰:0=正常、1=淘汰 isPublic: type: integer format: int32 description: 是否公用 materialAttribute: type: string description: 属性类别 materialId: type: string description: 素材ID materialName: type: string description: 素材名称 parts: type: string description: 部件属性 picHeight: type: number format: double description: 贴图大小-高 picWidth: type: number format: double description: 贴图大小-宽 property: type: string description: 材质属性 remark: type: string description: 备注 required: - categoryId - materialId - picHeight - picWidth description: 素材信息 moduleName: type: string description: 模块名称,即当前操作的模块,比如:全屋定制衣柜模型、全屋定制衣柜贴图 needUpdateXmlContent: type: boolean description: 是否要更新XML内容 xmlContent: type: string description: XML内容 required: - addMaterialCategoryIds - designMaterial example: moduleName: '' needUpdateXmlContent: false designMaterial: picWidth: 0 picHeight: 0 color: '' is3d: 0 remark: '' materialId: '' materialAttribute: '' materialName: '' enableMaterialBall: 0 chartletFeatureCode: '' parts: '' property: '' isOut: 0 isPublic: 0 colorCode: '' designCode: '' categoryId: 0 addMaterialCategoryIds: [] xmlContent: '' responses: '200': description: 成功 / OK content: application/json: schema: type: object properties: success: type: boolean description: 请求是否成功 / whether the call succeeded code: type: integer description: 结果码 / result code (0 = success) msg: type: string description: 提示信息 / message data: type: object example: msg: '' code: 0 data: false success: false '401': description: access_token 缺失或已过期 / missing or expired access_token /api/v1/roomMaterial/editModel: post: operationId: apiV1RoomMaterialEditModel summary: 编辑全屋定制模型数据接口 tags: - Products x-source-documentation: https://dev.3vjia.com/document?apiId=605731045719040097 x-documentation-category: 产品模块 / 素材管理 description: |- 本接口采用字段覆盖保存模式,而非部分更新。表中标注"如果不传或传 null,将用 null 覆盖"或"用 0 覆盖"的字段,会被清空为 null 或重置为 0。调用时若不希望某字段被清空或重置,请将该字段的原值一并传回。 最简单的方式就是, `先调/api/v1/productMaterial/getModel接口(文档地址:https://help.3vjia.com/doc/open_doc/456823276459593731/841686263705800714)把数据拿回来,直接把 designMaterial和product对象(字段)copy过去,然后再针对自己需要改的字段进行修改` **素材主表** | 字段 | 中文含义 | 落库位置 | 传空结果 | |---|---|---|---| | `designMaterial.categoryId` | 素材分类ID | 素材主表 | 会更新为 `0` | | `designMaterial.brickId` | 异型砖ID | 素材主表 | 会更新为 `null` | | `designMaterial.lightProperty` | 灯光属性 | 素材主表 | 会更新为 `null` | | `designMaterial.orientation` | 开门方向 | 素材主表 | 会更新为 `null` | | `designMaterial.materialAttribute` | 属性类别 | 素材主表 | 会更新为 `null` | | `designMaterial.placeRule` | 放置规则 | 素材主表 | 会更新为 `null` | | `designMaterial.picHeight` | 高 | 素材主表 | 会更新为 `null` | | `designMaterial.picLength` | 长 | 素材主表 | 会更新为 `null` | | `designMaterial.picWidth` | 宽 | 素材主表 | 会更新为 `null` | | `designMaterial.placeHeight` | 放置高度 | 素材主表 | 会更新为 `null` | | `designMaterial.retailPrice` | 零售价 | 素材主表 | 会更新为 `null` | | `designMaterial.holeLength` | 开孔尺寸-长 | 素材主表 | 会更新为 `null` | | `designMaterial.holeWidth` | 开孔尺寸-宽 | 素材主表 | 会更新为 `null` | | `designMaterial.designCode` | 素材编号 | 素材主表 | 会更新为 `null` | | `designMaterial.modelDepth` | 模型深度 | 素材主表 | 会更新为 `null` | | `designMaterial.parts` | 部件属性 | 素材主表 | 会更新为 `null` | | `designMaterial.materialType` | 素材类别 | 素材主表 | 会更新为 `null` | **商品相关** | 字段 | 中文含义 | 落库位置 | 传空结果 | |---|---|---|---| | `product.brandId` | 品牌ID | 品牌/系列绑定关系 | 会更新为 `0` | | `product.seriesId` | 系列ID | 品牌/系列绑定关系 | 会更新为 `0` | | `product.model` | 型号 | 商品表 | 会更新为空值 | | `product.unit` | 计价单位/报价单位 | 商品表 | 会更新为空值 | requestBody: required: true content: application/json: schema: type: object properties: designMaterial: type: object properties: categoryId: type: integer format: int32 description: 素材分类ID,如果不传或传 null,将用 0 覆盖该字段,原值会被清掉 designCode: type: string description: 素材编码(部件编号),如果不传或传 null,将用 null 覆盖该字段,原值会被清掉 holeLength: type: integer format: int32 description: 开孔尺寸-长,如果不传或传 null,将用 null 覆盖该字段,原值会被清掉 holeWidth: type: integer format: int32 description: 开孔尺寸-宽,如果不传或传 null,将用 null 覆盖该字段,原值会被清掉 is3d: type: integer format: int32 description: 启用3D状态 lightProperty: type: string description: 灯光属性,如果不传或传 null,将用 null 覆盖该字段,原值会被清掉 materialAttribute: type: string description: 属性类别,如果不传或传 null,将用 null 覆盖该字段,原值会被清掉 materialId: type: string description: 素材ID materialName: type: string description: 素材名称 materialType: type: string description: 素材类别,如果不传或传 null,将用 null 覆盖该字段,原值会被清掉 orientation: type: integer format: int32 description: 开门方向:1=左开、2=右开,如果不传或传 null,将用 null 覆盖该字段,原值会被清掉 parts: type: string description: 部件属性,如果不传或传 null,将用 null 覆盖该字段,原值会被清掉 picHeight: type: number format: double description: 模型-高,如果不传或传 null,将用 null 覆盖该字段,原值会被清掉 picLength: type: number format: double description: 模型-长,如果不传或传 null,将用 null 覆盖该字段,原值会被清掉 picWidth: type: number format: double description: 模型-宽,如果不传或传 null,将用 null 覆盖该字段,原值会被清掉 placeHeight: type: string description: 放置高度,如果不传或传 null,将用 null 覆盖该字段,原值会被清掉 placeRule: type: string description: 放置规则,如果不传或传 null,将用 null 覆盖该字段,原值会被清掉 productId: type: string description: 产品ID property: type: string description: 材质属性 remark: type: string description: 备注 subParts: type: string description: 子部件属性 required: - categoryId - materialId - materialType description: 素材信息 moduleName: type: string description: 模块名称,即当前操作的模块,比如:全屋定制衣柜模型、全屋定制衣柜贴图 examples: - 全屋定制衣柜贴图 needUpdateXmlContent: type: boolean description: 是否要更新XML内容 examples: - 'false' product: type: object properties: brandId: type: integer format: int32 model: type: string description: 型号,如果不传或传 null,将用 null 覆盖该字段,原值会被清掉 seriesId: type: integer format: int32 unit: type: string description: 计价单位,如果不传或传 null,将用 null 覆盖该字段,原值会被清掉 description: 产品信息 xmlContent: type: string description: XML内容 required: - designMaterial example: product: seriesId: 0 unit: '' brandId: 0 model: '' moduleName: 全屋定制衣柜贴图 needUpdateXmlContent: false designMaterial: picWidth: 0 orientation: 0 holeWidth: 0 lightProperty: '' picHeight: 0 productId: '' materialType: '' is3d: 0 remark: '' materialId: '' materialAttribute: '' holeLength: 0 subParts: '' materialName: '' placeHeight: '' placeRule: '' parts: '' picLength: 0 property: '' designCode: '' categoryId: 0 xmlContent: '' responses: '200': description: 成功 / OK content: application/json: schema: type: object properties: success: type: boolean description: 请求是否成功 / whether the call succeeded code: type: integer description: 结果码 / result code (0 = success) msg: type: string description: 提示信息 / message data: type: object example: msg: '' code: 0 data: false success: false '401': description: access_token 缺失或已过期 / missing or expired access_token /api/v1/scheme/getScheme: post: operationId: apiV1SchemeGetScheme summary: 获取方案详细数据接口 tags: - Design Schemes x-source-documentation: https://dev.3vjia.com/document?apiId=453640446674010117 x-documentation-category: 方案模块 / 方案数据 requestBody: required: true content: application/json: schema: type: object properties: schemeId: type: string description: 方案ID examples: - '51024567' required: - schemeId example: schemeId: '51024567' responses: '200': description: 成功 / OK content: application/json: schema: type: object properties: success: type: boolean description: 请求是否成功 / whether the call succeeded code: type: integer description: 结果码 / result code (0 = success) msg: type: string description: 提示信息 / message data: type: object properties: areaId: type: string description: 面积范围(31-40㎡、41-50㎡....)分类的ID examples: - '15416' areaName: type: string description: 面积范围(31-40㎡、41-50㎡....)分类的名称 examples: - 31-40㎡ author: type: object properties: avatar: type: string description: 设计师头像 examples: - "\thttps://img3.admin.3vjia.com/UpFile/C00005842/ADMIN/UserSetting/202005/1001266879/89faef49527140eb883d7a5190c0048a.jpg" mobile: type: string description: 手机号码 examples: - '13800000000' name: type: string description: 姓名 examples: - 小蔡 nickName: type: string description: 昵称 examples: - 小蔡 outUserId: type: string description: 账号绑定的企业系统用户ID examples: - '123456' userId: type: string description: 三维家用户ID examples: - '1000123456' userName: type: string description: 三维家账号 examples: - 3vj13800000000 description: 操作用户 budgetId: type: string description: 预算(小于1w、大于1w....)分类的ID examples: - '2029176' budgetName: type: string description: 预算(小于1w、大于1w....)分类的名称 examples: - 小于1w building: type: object properties: buildingId: type: string description: 三维家楼盘ID examples: - 00005689 buildingName: type: string description: 楼盘名称 examples: - 天健上城 city: type: string description: 城市 examples: - 广州市 cityId: type: string description: 城市ID examples: - '440100' modelArea: type: object examples: - '13.40' modelId: type: string description: 三维家楼号户型ID examples: - '00041555' modelImagePath: type: string description: 户型图地址 examples: - "\thttps://img3.admin.3vjia.com/UpFile_Building/C00005842/3D/BuildingRoomModel/202009/440100/01914439/105753835/96feb749155e4b71a9fce3bd162c063b.jpg" modelName: type: string description: 楼号户型名称 examples: - A1栋1203号 modelType: type: string description: 户型类型 examples: - 3室2厅1卫1厨 province: type: string description: 省份 examples: - 广东省 provinceId: type: string description: 省份ID examples: - '440000' description: 方案户型信息 createTime: type: string description: 方案创建时间,格式yyyy-MM-ddHH:mm:ss examples: - '2020-05-02 20:11:00' customer: type: object properties: customerAddress: type: string description: 客户地址 examples: - 天河区软件路15号 customerCode: type: string description: 客户编码 examples: - '1000123456' customerId: type: string description: 客户ID examples: - '1000123456' customerMobile: type: string description: 客户手机 examples: - '13800000000' customerName: type: string description: 客户名称 examples: - 朱女士 description: 客户信息 dept: type: object properties: customerCode: type: string description: 客户编码 examples: - '1000123456' deptId: type: string description: 部门ID examples: - 00013678 deptName: type: string description: 部门名称 examples: - 运营管理部 outDeptId: type: string description: 部门所绑定企业系统部门ID,绑定过才有值 examples: - '123456' storeType: type: integer format: int32 description: 类型0=门店,1=部门 examples: - '1' description: 上级部门信息 houseTypeId: type: string description: 户型(一居室、两居室....)分类的ID examples: - '7026' houseTypeName: type: string description: 户型(一居室、两居室....)分类的名称 examples: - 一居室 imagePath: type: string description: 方案主图路径 examples: - http://3vj-scheme.3vjia.com/UpFile_Scheme/C00004768/20200504/1b41/1b41e2d1-8156-45f4-a364-4d917dec4089.jpg info: type: string description: 方案介绍 examples: - 测试方案 isEnable: type: integer format: int32 description: 查询账号有使用权限的方案(0=无使用权,1=有使用权) examples: - "\t0" kindsId: type: string description: 品类(生活创意类、家具类....)分类的ID examples: - '7069' kindsName: type: string description: 品类(生活创意类、家具类....)分类的名称 examples: - 家具类 mainPhotoDesc: type: string description: 方案主图描述 examples: - 测试方案主图 modifyTime: type: string description: 方案最后修改时间,格式yyyy-MM-ddHH:mm:ss examples: - '2020-05-02 20:11:00' productList: type: array items: type: object properties: materialId: type: string description: 素材id examples: - '22107004' materialName: type: string description: 素材名称 examples: - 毛巾 num: type: string description: 数量,可能为小数字符串(贴图类)、也可能为整数字符串(模型类) examples: - '1' organ: type: object description: 部门所属机构信息 productCode: type: string description: 产品编码,取商品的默认SKU examples: - 3vjiawx-zh24-6 productId: type: string description: 商品ID examples: - '123456' productName: type: string description: 商品名称 examples: - 3vjiawx-zh24-6 productStatus: type: integer format: int32 description: 商品上下架状态,0=下架,1=上架 examples: - '1' room: type: object properties: roomId: type: string description: 空间ID examples: - 2C8FF05E-60AF-DCE8-0FD1-DEE87A74FB86 roomName: type: string description: 空间名称 examples: - 主卧 description: 产品关联的空间信息 description: 方案成品结构,V2 render720Url: type: string description: 720全景图地址(单空间),类型为全景图时有值 examples: - https://720.3vjia.com/Q123456 renderImageList: type: array items: type: object properties: createDate: type: string description: 渲染时间,格式yyyy-MM-ddHH:mm:ss examples: - '2020-05-02 14:50:54' height: type: integer format: int32 description: 图片高度 examples: - '600' imageId: type: string description: 渲染图ID examples: - 2ddb3ec39c8d4b1d8c75bd73c43edc17 imageName: type: string description: 自动生成的渲染图名称 examples: - 测试方案202005041843-20200504 imageSpecification: type: string description: 渲染图的规格,标清/高清/超清/4K examples: - 标清 imageTypeCode: type: integer format: int32 description: 渲染图类型代码,0=效果图,1=全景图,2=俯视图 examples: - '2' imageTypeName: type: string description: 渲染图类型名称,效果图/全景图/俯视图 examples: - 俯视图 imageUrl: type: string description: 渲染图地址 examples: - "\thttps://3vj-render.3vjia.com/UpFile_Render/C00004768/DesignSchemeRenderFile/55473563/QO202005040000000000000025726676/QO202005040000000000000025726676.jpg" render720Url: type: string description: 720全景图地址(单空间),类型为全景图时有值 room: type: object properties: roomId: type: string description: 空间ID examples: - 2C8FF05E-60AF-DCE8-0FD1-DEE87A74FB86 roomName: type: string description: 空间名称 examples: - 主卧 description: 产品关联的空间信息 width: type: integer format: int32 description: 图片宽度 examples: - '800' description: 渲染图结构,V2 roomList: type: array items: type: object properties: area: type: number format: double description: 空间面积大小 examples: - '13.45' categoryId: type: string description: 空间类型分类ID examples: - '10742' categoryName: type: string description: 空间类型分类名称 examples: - 主卧 roomId: type: string description: 空间ID examples: - 2C8FF05E-60AF-DCE8-0FD1-DEE87A74FB86 roomName: type: string description: 空间名称 examples: - 主卧 roomShapeId: type: string description: 房间形状(矩型、L型....)的分类的ID examples: - '7064' roomShapeName: type: string description: 房间形状(矩型、L型....)的分类的名称 examples: - 矩型 styleId: type: string description: 风格(现代、简约、欧式....)分类的ID examples: - '7045' styleName: type: string description: 风格(现代、简约、欧式....)分类的名称 examples: - 现代 description: 方案空间结构,V2 roomShapeId: type: string description: 房间形状(矩型、L型....)的分类的ID examples: - '7064' roomShapeName: type: string description: 房间形状(矩型、L型....)的分类的名称 examples: - 矩型 roomTypeId: type: string description: 空间类型(主卧、客厅....)的分类的ID examples: - '10742' roomTypeName: type: string description: 空间类型(主卧、客厅....)的分类的名称 examples: - 主卧 schemeId: type: string description: 方案Id examples: - '50053081' schemeIdEncryption: type: string description: 加密方案ID examples: - 1IDDIGDL schemeName: type: string description: 方案名称 examples: - 广州碧桂园·樾时光—毁梦3vj sort: type: integer format: int32 description: 方案排序号,主要用于一些列表页的显示顺序,如新品推荐 examples: - '0' styleId: type: string description: 风格(现代、简约、欧式....)分类的ID examples: - '7045' styleName: type: string description: 风格(现代、简约、欧式....)分类的名称 examples: - 现代 totalArea: type: number format: double description: 方案总面积 examples: - '64.44' totalFavorite: type: integer format: int32 description: 被收藏数 examples: - '10' totalPraise: type: integer format: int32 description: 被点赞数 examples: - '10' totalViews: type: integer format: int32 description: 被点击(观看)数 examples: - '10' uploadImageList: type: array items: type: object properties: createDate: type: string description: 渲染时间,格式yyyy-MM-ddHH:mm:ss examples: - '2020-05-02 14:50:54' height: type: integer format: int32 description: 图片高度 examples: - '600' imageId: type: string description: 渲染图ID examples: - 2ddb3ec39c8d4b1d8c75bd73c43edc17 imageName: type: string description: 自动生成的渲染图名称 examples: - 测试方案202005041843-20200504 imageSpecification: type: string description: 渲染图的规格,标清/高清/超清/4K examples: - 标清 imageUrl: type: string description: 渲染图地址 examples: - "\thttps://3vj-render.3vjia.com/UpFile_Render/C00004768/DesignSchemeRenderFile/55473563/QO202005040000000000000025726676/QO202005040000000000000025726676.jpg" width: type: integer format: int32 description: 图片宽度 examples: - '800' description: 方案上传的图片结构,V2 example: msg: '' code: 0 data: imagePath: http://3vj-scheme.3vjia.com/UpFile_Scheme/C00004768/20200504/1b41/1b41e2d1-8156-45f4-a364-4d917dec4089.jpg totalPraise: 10 schemeId: '50053081' kindsName: 家具类 styleName: 现代 houseTypeId: '7026' building: city: 广州市 modelId: '00041555' modelImagePath: "\thttps://img3.admin.3vjia.com/UpFile_Building/C00005842/3D/BuildingRoomModel/202009/440100/01914439/105753835/96feb749155e4b71a9fce3bd162c063b.jpg" modelArea: '' cityId: '440100' modelType: 3室2厅1卫1厨 provinceId: '440000' buildingId: 00005689 buildingName: 天健上城 modelName: A1栋1203号 province: 广东省 roomTypeId: '10742' isEnable: 0 renderImageList: - imageId: 2ddb3ec39c8d4b1d8c75bd73c43edc17 imageName: 测试方案202005041843-20200504 imageSpecification: 标清 room: roomId: 2C8FF05E-60AF-DCE8-0FD1-DEE87A74FB86 roomName: 主卧 imageUrl: "\thttps://3vj-render.3vjia.com/UpFile_Render/C00004768/DesignSchemeRenderFile/55473563/QO202005040000000000000025726676/QO202005040000000000000025726676.jpg" width: 800 imageTypeCode: 2 imageTypeName: 俯视图 createDate: '2020-05-02 14:50:54' height: 600 render720Url: '' schemeIdEncryption: 1IDDIGDL modifyTime: '2020-05-02 20:11:00' uploadImageList: - imageId: 2ddb3ec39c8d4b1d8c75bd73c43edc17 imageName: 测试方案202005041843-20200504 imageSpecification: 标清 imageUrl: "\thttps://3vj-render.3vjia.com/UpFile_Render/C00004768/DesignSchemeRenderFile/55473563/QO202005040000000000000025726676/QO202005040000000000000025726676.jpg" width: 800 createDate: '2020-05-02 14:50:54' height: 600 areaName: 31-40㎡ styleId: '7045' info: 测试方案 roomShapeId: '7064' author: nickName: 小蔡 mobile: '13800000000' avatar: "\thttps://img3.admin.3vjia.com/UpFile/C00005842/ADMIN/UserSetting/202005/1001266879/89faef49527140eb883d7a5190c0048a.jpg" outUserId: '123456' userName: 3vj13800000000 userId: '1000123456' name: 小蔡 roomTypeName: 主卧 schemeName: 广州碧桂园·樾时光—毁梦3vj houseTypeName: 一居室 budgetId: '2029176' dept: deptName: 运营管理部 storeType: 1 deptId: 00013678 customerCode: '1000123456' outDeptId: '123456' sort: 0 budgetName: 小于1w areaId: '15416' createTime: '2020-05-02 20:11:00' totalFavorite: 10 roomShapeName: 矩型 totalViews: 10 kindsId: '7069' mainPhotoDesc: 测试方案主图 productList: - organ: {} productId: '123456' num: '1' productStatus: 1 materialId: '22107004' productName: 3vjiawx-zh24-6 room: roomId: 2C8FF05E-60AF-DCE8-0FD1-DEE87A74FB86 roomName: 主卧 materialName: 毛巾 productCode: 3vjiawx-zh24-6 roomList: - roomShapeId: '7064' styleName: 现代 categoryName: 主卧 roomId: 2C8FF05E-60AF-DCE8-0FD1-DEE87A74FB86 roomName: 主卧 roomShapeName: 矩型 styleId: '7045' categoryId: '10742' customer: customerAddress: 天河区软件路15号 customerCode: '1000123456' customerName: 朱女士 customerId: '1000123456' customerMobile: '13800000000' render720Url: https://720.3vjia.com/Q123456 success: true '401': description: access_token 缺失或已过期 / missing or expired access_token /api/v1/scheme/getSchemeListByPage: post: operationId: apiV1SchemeGetSchemeListByPage summary: 获取方案列表v1接口 tags: - Design Schemes x-source-documentation: https://dev.3vjia.com/document?apiId=474664222039572486 x-documentation-category: 方案模块 / 方案数据 description: 分页获取方案列表,当不需要过滤时,入参请传空字典,而非不传。 requestBody: required: false content: application/json: schema: type: object properties: area: type: string description: 面积范围(31-40㎡、41-50㎡....)的分类ID createBeginTime: type: string description: 方案创建开始时间,格式yyyy-MM-ddHH:mm:ss,默认值10天前,createBeginTime和createEndTime的时间差不能超过90天 createEndTime: type: string description: 方案创建结束时间,格式yyyy-MM-ddHH:mm:ss,默认当前时间,createBeginTime和createEndTime的时间差不能超过90天 deptId: type: string description: 部门id houseType: type: string description: 户型(一居室、两居室....)的分类ID isEnable: type: integer format: int32 description: 查询账号有使用权限的方案(0=无使用权,1=有使用权) keyword: type: string description: 关键字,模糊搜索方案名称和方案ID kinds: type: string description: 品类(生活创意类、家具类....)的分类ID modifyBeginTime: type: string description: 方案修改开始时间,格式yyyy-MM-ddHH:mm:ss,modifyBeginTime和modifyEndTime之间的时间差不能超过90天 modifyEndTime: type: string description: 方案修改结束时间,格式yyyy-MM-ddHH:mm:ss,modifyBeginTime和modifyEndTime之间的时间差不能超过90天 orderBy: type: string description: "排序方式:MODIFY_TIME_DESC 按更新时间倒序,MODIFY_TIME_ASC 按更新时间正序,CREATE_TIME_DESC 创建时间倒序,CREATE_TIME_ASC 按创建时间正序\tCREATE_TIME_DESC" outUserId: type: string description: 绑定过三维家账号的企业系统的用户ID,当userId、userName为空时,outUserId有效 pageIndex: type: integer format: int32 description: 页码,最小值为1,默认值为1 pageSize: type: integer format: int32 description: 分页大小,最小值1,最大值500,默认值50 publishState: type: integer format: int32 description: 发布状态(0=未发布,1=已发布,不传查全部) roomShape: type: string description: 房间形状(矩型、L型....)的分类ID roomType: type: string description: 空间类型(主卧、客厅....)的分类ID style: type: string description: 风格(现代、简约、欧式....)的分类ID userId: type: string description: 三维家用户ID,若传了userId,当忽略userName、outUserId字段 userName: type: string description: 三维家账号,当userId为空时,userName有效,传了userName将忽略outUserId字段 example: area: '' publishState: 0 createBeginTime: '' houseType: '' deptId: '' orderBy: '' pageSize: 0 kinds: '' modifyEndTime: '' modifyBeginTime: '' outUserId: '' userName: '' userId: '' isEnable: 0 roomShape: '' pageIndex: 0 createEndTime: '' style: '' keyword: '' roomType: '' responses: '200': description: 成功 / OK content: application/json: schema: type: object properties: success: type: boolean description: 请求是否成功 / whether the call succeeded code: type: integer description: 结果码 / result code (0 = success) msg: type: string description: 提示信息 / message data: type: object properties: pageIndex: type: integer format: int32 pageSize: type: integer format: int32 recordCount: type: integer format: int32 result: type: array items: type: object properties: areaId: type: string description: 面积范围(31-40㎡、41-50㎡....)分类的ID areaName: type: string description: 面积范围(31-40㎡、41-50㎡....)分类的名称 author: type: object properties: avatar: type: string description: 设计师头像 mobile: type: string description: 手机号码 name: type: string description: 姓名 nickName: type: string description: 昵称 outUserId: type: string description: 账号绑定的企业系统用户ID userId: type: string description: 三维家用户ID userName: type: string description: 三维家账号 description: 操作用户 budgetId: type: string description: 预算(小于1w、大于1w....)分类的ID budgetName: type: string description: 预算(小于1w、大于1w....)分类的名称 createTime: type: string description: 方案创建时间,格式yyyy-MM-ddHH:mm:ss customer: type: object properties: customerAddress: type: string description: 客户地址 customerCode: type: string description: 客户编码 customerId: type: string description: 客户ID customerMobile: type: string description: 客户手机 customerName: type: string description: 客户名称 description: 客户信息 dept: type: object properties: customerCode: type: string description: 部门对应客户部门编码 deptId: type: string description: 部门ID deptName: type: string description: 部门名称 outDeptId: type: string description: 部门所绑定企业系统部门ID,绑定过才有值 storeType: type: integer format: int32 description: 类型0=门店,1=部门 description: 上级部门信息 houseTypeId: type: string description: 户型(一居室、两居室....)分类的ID houseTypeName: type: string description: 户型(一居室、两居室....)分类的名称 imagePath: type: string description: 方案主图路径 info: type: string description: 方案介绍 isEnable: type: integer format: int32 description: 查询账号有使用权限的方案(0=无使用权,1=有使用权) kindsId: type: string description: 品类(生活创意类、家具类....)分类的ID kindsName: type: string description: 品类(生活创意类、家具类....)分类的名称 mainPhotoDesc: type: string description: 方案主图描述 modifyTime: type: string description: 方案最后修改时间,格式yyyy-MM-ddHH:mm:ss organ: type: object properties: organId: type: string description: 企业ID organName: type: string description: 企业名称 description: 部门所属机构信息 publishState: type: integer format: int32 description: 发布状态(0=未发布,1=已发布,不传查全部) render720Url: type: string description: 720全景Url roomShapeId: type: string description: 房间形状(矩型、L型....)的分类的ID roomShapeName: type: string description: 房间形状(矩型、L型....)的分类的名称 roomTypeId: type: string description: 空间类型(主卧、客厅....)的分类的ID roomTypeName: type: string description: 空间类型(主卧、客厅....)的分类的名称 schemeId: type: string description: 方案Id schemeIdEncryption: type: string description: 加密方案ID schemeName: type: string description: 方案名称 sort: type: integer format: int32 description: 方案排序号,主要用于一些列表页的显示顺序,如新品推荐 styleId: type: string description: 风格(现代、简约、欧式....)分类的ID styleName: type: string description: 风格(现代、简约、欧式....)分类的名称 totalArea: type: number format: double description: 方案总面积 totalFavorite: type: integer format: int32 description: 被收藏数 totalPraise: type: integer format: int32 description: 被点赞数 totalViews: type: integer format: int32 description: 被点击(观看)数 description: 方案列表实体,出参,V2 example: msg: '' code: 0 data: recordCount: 0 pageSize: 0 result: - organ: organName: '' organId: '' publishState: 0 imagePath: '' totalPraise: 0 schemeId: '' kindsName: '' styleName: '' houseTypeId: '' roomTypeId: '' isEnable: 0 schemeIdEncryption: '' modifyTime: '' areaName: '' styleId: '' info: '' roomShapeId: '' author: nickName: '' mobile: '' avatar: '' outUserId: '' userName: '' userId: '' name: '' roomTypeName: '' schemeName: '' houseTypeName: '' budgetId: '' dept: deptName: '' storeType: 0 deptId: '' customerCode: '' outDeptId: '' sort: 0 budgetName: '' areaId: '' createTime: '' totalFavorite: 0 roomShapeName: '' totalViews: 0 kindsId: '' mainPhotoDesc: '' customer: customerAddress: '' customerCode: '' customerName: '' customerId: '' customerMobile: '' render720Url: '' pageIndex: 0 success: false '401': description: access_token 缺失或已过期 / missing or expired access_token /api/v1/scheme/getSchemeProduct: post: operationId: apiV1SchemeGetSchemeProduct summary: 获取方案产品清单接口 tags: - Design Schemes x-source-documentation: https://dev.3vjia.com/document?apiId=453646779758477330 x-documentation-category: 方案模块 / 方案数据 requestBody: required: true content: application/json: schema: type: object properties: schemeId: type: string description: 方案ID examples: - '50053081' required: - schemeId example: schemeId: '50053081' responses: '200': description: 成功 / OK content: application/json: schema: type: object properties: success: type: boolean description: 请求是否成功 / whether the call succeeded code: type: integer description: 结果码 / result code (0 = success) msg: type: string description: 提示信息 / message data: type: object properties: author: type: object properties: avatar: type: string description: 设计师头像 examples: - https://img3.admin.3vjia.com/UpFile/C00005842/ADMIN/UserSetting/202005/1001266879/89faef49527140eb883d7a5190c0048a.jpg mobile: type: string description: 手机号码 examples: - '13800000000' name: type: string description: 姓名 examples: - 小蔡 nickName: type: string description: 昵称 examples: - 小蔡 outUserId: type: string description: 账号绑定的企业系统用户ID examples: - '122323' userId: type: string description: 三维家用户ID examples: - '1000123456' userName: type: string description: 三维家账号 examples: - 3vj13800000000 description: 操作用户 dept: type: object properties: customerCode: type: string description: 部门对应客户部门编码 examples: - '122323' deptId: type: string description: 部门ID examples: - 00013678 deptName: type: string description: 部门名称 examples: - 运营管理部 outDeptId: type: string description: 部门所绑定企业系统部门ID,绑定过才有值 examples: - '121232' storeType: type: integer format: int32 description: 类型0=门店,1=部门 examples: - '1' description: 上级部门信息 organ: type: object properties: organId: type: string description: 企业ID examples: - C00000022 organName: type: string description: 企业名称 examples: - XXX信息科技 description: 部门所属机构信息 productList: type: array items: type: object properties: materialId: type: string description: 素材id examples: - '22107004' materialName: type: string description: 素材名称 examples: - 毛巾 num: type: string description: 数量,可能为小数字符串(贴图类)、也可能为整数字符串(模型类) examples: - '12' organ: type: object properties: organId: type: string description: 企业ID examples: - C00000022 organName: type: string description: 企业名称 examples: - XXX信息科技 description: 部门所属机构信息 productCode: type: string description: 产品编码,取商品的默认SKU examples: - 3vjiawx-zh24-6 productId: type: string description: 商品ID examples: - '123456' productName: type: string description: 商品名称 examples: - 毛巾 productStatus: type: integer format: int32 description: 商品上下架状态,0=下架,1=上架 examples: - '1' room: type: object properties: roomId: type: string description: 空间ID examples: - 2C8FF05E-60AF-DCE8-0FD1-DEE87A74FB86 roomName: type: string description: 空间名称 examples: - 主卧 description: 产品关联的空间信息 description: 方案成品结构,V2 schemeId: type: string description: 方案Id examples: - '50053081' schemeName: type: string description: 方案名称 examples: - 广州碧桂园·樾时光—毁梦3vj example: msg: '' code: 0 data: organ: organName: XXX信息科技 organId: C00000022 author: nickName: 小蔡 mobile: '13800000000' avatar: https://img3.admin.3vjia.com/UpFile/C00005842/ADMIN/UserSetting/202005/1001266879/89faef49527140eb883d7a5190c0048a.jpg outUserId: '122323' userName: 3vj13800000000 userId: '1000123456' name: 小蔡 schemeName: 广州碧桂园·樾时光—毁梦3vj schemeId: '50053081' dept: deptName: 运营管理部 storeType: 1 deptId: 00013678 customerCode: '122323' outDeptId: '121232' productList: - organ: organName: XXX信息科技 organId: C00000022 productId: '123456' num: '12' productStatus: 1 materialId: '22107004' productName: 毛巾 room: roomId: 2C8FF05E-60AF-DCE8-0FD1-DEE87A74FB86 roomName: 主卧 materialName: 毛巾 productCode: 3vjiawx-zh24-6 success: false '401': description: access_token 缺失或已过期 / missing or expired access_token /api/v1/scheme/getSchemeRender: post: operationId: apiV1SchemeGetSchemeRender summary: 获取方案效果图列表接口 tags: - Design Schemes x-source-documentation: https://dev.3vjia.com/document?apiId=453644780388286500 x-documentation-category: 方案模块 / 方案数据 requestBody: required: true content: application/json: schema: type: object properties: schemeId: type: string description: 方案ID examples: - '50053081' required: - schemeId example: schemeId: '50053081' responses: '200': description: 成功 / OK content: application/json: schema: type: object properties: success: type: boolean description: 请求是否成功 / whether the call succeeded code: type: integer description: 结果码 / result code (0 = success) msg: type: string description: 提示信息 / message data: type: object properties: author: type: object properties: avatar: type: string description: 设计师头像 examples: - https://img3.admin.3vjia.com/UpFile/C00005842/ADMIN/UserSetting/202005/1001266879/89faef49527140eb883d7a5190c0048a.jpg mobile: type: string description: 手机号码 examples: - '13800000000' name: type: string description: 姓名 examples: - 小蔡 nickName: type: string description: 昵称 examples: - 小蔡 outUserId: type: string description: 账号绑定的企业系统用户ID examples: - '123456' userId: type: string description: 三维家用户ID examples: - '1000123456' userName: type: string description: 三维家账号 examples: - 3vj13800000000 description: 操作用户 dept: type: object properties: customerCode: type: string description: 部门对应客户部门编码 examples: - '123456' deptId: type: string description: 部门ID examples: - 00013678 deptName: type: string description: 部门名称 examples: - 运营管理部 outDeptId: type: string description: 部门所绑定企业系统部门ID,绑定过才有值 examples: - '123456' storeType: type: integer format: int32 description: 类型0=门店,1=部门 examples: - '1' description: 上级部门信息 organ: type: object properties: organId: type: string description: 企业ID examples: - C00000000 organName: type: string description: 企业名称 examples: - XXX信息科技 description: 部门所属机构信息 render720Url: type: string description: 720全景图地址(单空间),类型为全景图时有值 examples: - https://720.3vjia.com/Q123456 renderImageList: type: array items: type: object properties: createDate: type: string description: 渲染时间,格式yyyy-MM-ddHH:mm:ss examples: - '2020-05-02 14:50:54' height: type: integer format: int32 description: 图片高度 examples: - '600' imageId: type: string description: 渲染图ID examples: - 2ddb3ec39c8d4b1d8c75bd73c43edc17 imageName: type: string description: 自动生成的渲染图名称 examples: - 测试方案202005041843-20200504 imageSpecification: type: string description: 渲染图的规格,标清/高清/超清/4K examples: - 标清 imageTypeCode: type: integer format: int32 description: 渲染图类型代码,0=效果图,1=全景图,2=俯视图 examples: - '2' imageTypeName: type: string description: 渲染图类型名称,效果图/全景图/俯视图 examples: - 俯视图 imageUrl: type: string description: 渲染图地址 examples: - https://3vj-render.3vjia.com/UpFile_Render/C00004768/DesignSchemeRenderFile/55473563/QO202005040000000000000025726676/QO202005040000000000000025726676.jpg render720Url: type: string description: 720全景图地址(单空间),类型为全景图时有值 room: type: object properties: roomId: type: string description: 空间ID examples: - 2C8FF05E-60AF-DCE8-0FD1-DEE87A74FB86 roomName: type: string description: 空间名称 examples: - 主卧 description: 产品关联的空间信息 width: type: integer format: int32 description: 图片宽度 examples: - '800' description: 渲染图结构,V2 schemeId: type: string description: 方案Id examples: - '50053081' schemeName: type: string description: 方案名称 examples: - 广州碧桂园·樾时光—毁梦3vj example: msg: '' code: 0 data: organ: organName: XXX信息科技 organId: C00000000 author: nickName: 小蔡 mobile: '13800000000' avatar: https://img3.admin.3vjia.com/UpFile/C00005842/ADMIN/UserSetting/202005/1001266879/89faef49527140eb883d7a5190c0048a.jpg outUserId: '123456' userName: 3vj13800000000 userId: '1000123456' name: 小蔡 schemeName: 广州碧桂园·樾时光—毁梦3vj schemeId: '50053081' dept: deptName: 运营管理部 storeType: 1 deptId: 00013678 customerCode: '123456' outDeptId: '123456' renderImageList: - imageId: 2ddb3ec39c8d4b1d8c75bd73c43edc17 imageName: 测试方案202005041843-20200504 imageSpecification: 标清 room: roomId: 2C8FF05E-60AF-DCE8-0FD1-DEE87A74FB86 roomName: 主卧 imageUrl: https://3vj-render.3vjia.com/UpFile_Render/C00004768/DesignSchemeRenderFile/55473563/QO202005040000000000000025726676/QO202005040000000000000025726676.jpg width: 800 imageTypeCode: 2 imageTypeName: 俯视图 createDate: '2020-05-02 14:50:54' height: 600 render720Url: '' render720Url: https://720.3vjia.com/Q123456 success: false '401': description: access_token 缺失或已过期 / missing or expired access_token /api/v1/scheme/panorama/listPanoramaPageByOpenId: post: operationId: apiV1SchemePanoramaListPanoramaPageByOpenId summary: 根据openId分页获取全景图 tags: - Common Services x-source-documentation: https://dev.3vjia.com/document?apiId=576064334350905392 x-documentation-category: 通用服务 description: 根据openId分页获取全景图,openId通过请求头传递,请求头参数使用:Open-Id requestBody: required: true content: application/json: schema: type: object properties: current: type: integer format: int64 description: 当前查询第几页 default: '1' size: type: integer format: int64 description: 当前查询页记录数 default: '10' flag: type: integer format: int32 description: 方案图类型:0=效果图,1=全景图,2=鸟瞰图,11=AI绘图,12=美化图,不传默认为1 required: - current - size example: flag: 0 current: 0 size: 0 responses: '200': description: 成功 / OK content: application/json: schema: type: object properties: success: type: boolean description: 请求是否成功 / whether the call succeeded code: type: integer description: 结果码 / result code (0 = success) msg: type: string description: 提示信息 / message data: type: object properties: current: type: integer format: int64 description: 当前查询第几页 records: type: array items: type: object properties: imgUrl: type: string description: 全景图地址 panoramaName: type: string description: 全景图名称 showPath: type: string description: 全景封面图 description: 分页记录 size: type: integer format: int64 description: 当前查询页记录数 total: type: integer format: int64 description: 总数 required: - current - size - total example: msg: '' code: 0 data: records: - showPath: '' imgUrl: '' panoramaName: '' current: 0 total: 0 size: 0 success: false '401': description: access_token 缺失或已过期 / missing or expired access_token /api/v1/schemeCategory/getSchemeCategoryList: post: operationId: apiV1SchemeCategoryGetSchemeCategoryList summary: 获取方案分类列表接口 tags: - Design Schemes x-source-documentation: https://dev.3vjia.com/document?apiId=474670751249698881 x-documentation-category: 方案模块 / 方案数据 description: 获取方案分类,可以选择只返回企业自己的分类或企业分类+三维家系统分类。 requestBody: required: false content: application/json: schema: type: object properties: containSystemCategory: type: integer format: int32 description: 是否包含三维家的系统方案分类,0=不包含,1=包含 examples: - '1' example: containSystemCategory: 1 responses: '200': description: 成功 / OK content: application/json: schema: type: object properties: success: type: boolean description: 请求是否成功 / whether the call succeeded code: type: integer description: 结果码 / result code (0 = success) msg: type: string description: 提示信息 / message data: type: object properties: categoryId: type: string description: 分类ID examples: - '8414625' categoryName: type: string description: 分类名称 examples: - 风格 children: type: array items: {} description: 方案分类结构,V2 example: msg: 成功 code: 0 data: - categoryName: 风格 children: [] categoryId: '8414625' success: true '401': description: access_token 缺失或已过期 / missing or expired access_token /api/v1/schemecategory/createSchemeCategory: post: operationId: apiV1SchemecategoryCreateSchemeCategory summary: 添加方案分类接口 tags: - Design Schemes x-source-documentation: https://dev.3vjia.com/document?apiId=475026463813349467 x-documentation-category: 方案模块 / 方案分类 description: 新建方案分类 requestBody: required: false content: application/json: schema: type: object properties: categoryCode: type: string description: 分类代码,可自定义的代码,不超过32个字符 categoryName: type: string description: 分类名称 hasChildren: type: integer format: int32 description: 是否有子分类,1=有,0=无,默认0 parentId: type: string description: 分类所属的上级ID sortCode: type: integer format: int32 description: 分类排序码,会影响显示顺序,默认为0 example: hasChildren: 0 categoryCode: '' categoryName: '' sortCode: 0 parentId: '' responses: '200': description: 成功 / OK content: application/json: schema: type: object properties: success: type: boolean description: 请求是否成功 / whether the call succeeded code: type: integer description: 结果码 / result code (0 = success) msg: type: string description: 提示信息 / message data: type: object properties: categoryId: type: string description: 创建成功生成的分类ID example: msg: '' code: 0 data: categoryId: '' success: false '401': description: access_token 缺失或已过期 / missing or expired access_token /api/v1/schemecategory/deleteSchemeCategory: post: operationId: apiV1SchemecategoryDeleteSchemeCategory summary: 删除方案分类接口 tags: - Design Schemes x-source-documentation: https://dev.3vjia.com/document?apiId=475003581611716682 x-documentation-category: 方案模块 / 方案分类 description: 删除方案分类 requestBody: required: false content: application/json: schema: type: object properties: categoryIdList: type: array items: {} description: 要删除的分类ID列表 examples: - '"7041","7042"' example: categoryIdList: [] responses: '200': description: 成功 / OK content: application/json: schema: type: object properties: success: type: boolean description: 请求是否成功 / whether the call succeeded code: type: integer description: 结果码 / result code (0 = success) msg: type: string description: 提示信息 / message data: type: object example: msg: 成功 code: 0 data: true success: true '401': description: access_token 缺失或已过期 / missing or expired access_token /api/v1/schemesLand/getGoodsDetail: post: operationId: apiV1SchemesLandGetGoodsDetail summary: 获取方案岛商品方案详细信息接口 tags: - Design Schemes x-source-documentation: https://dev.3vjia.com/document?apiId=474669185604096008 x-documentation-category: 方案模块 / 方案岛 description: 获取方案岛商品(案例)详情信息 requestBody: required: false content: application/json: schema: type: object properties: id: type: string description: 商品ID examples: - 417d1a5a80bb4039b0c969e67dac0024 example: id: 417d1a5a80bb4039b0c969e67dac0024 responses: '200': description: 成功 / OK content: application/json: schema: type: object properties: success: type: boolean description: 请求是否成功 / whether the call succeeded code: type: integer description: 结果码 / result code (0 = success) msg: type: string description: 提示信息 / message data: type: object properties: activitiesName: type: string description: 企业活动名称 author: type: object properties: avatar: type: string description: 设计师头像 mobile: type: string description: 手机号码 name: type: string description: 姓名 nickName: type: string description: 昵称 outUserId: type: string description: 账号绑定的企业系统用户ID userId: type: string description: 三维家用户ID userName: type: string description: 三维家账号 description: 操作用户 buyNums: type: integer format: int32 description: 购买数量 checkDate: type: string description: 方案审核时间,格式yyyy-MM-ddHH:mm:ss checkUser: type: object properties: avatar: type: string description: 设计师头像 mobile: type: string description: 手机号码 name: type: string description: 姓名 nickName: type: string description: 昵称 outUserId: type: string description: 账号绑定的企业系统用户ID userId: type: string description: 三维家用户ID userName: type: string description: 三维家账号 description: 操作用户 content: type: string description: 商品介绍 coverPageUrl: type: string description: 封面地址 createDate: type: string description: 创建时间,格式yyyy-MM-ddHH:mm:ss favoriteNums: type: integer format: int32 description: 收藏数 goodsDetails: type: array items: type: object properties: categoryList: type: array items: type: object properties: selectedList: type: array items: {} description: 商品详情-通用下拉结构 text: type: string description: 显示值 value: type: string description: 值 description: 商品详情-通用下拉结构 categoryNames: type: array items: {} description: 分类,矩阵结构 content: type: string description: 介绍 coverImage: type: array items: type: object properties: fileFullPath: type: string description: 文件路径 fileName: type: string description: 文件名 description: 商品详情图片结构 coverPageUrl: type: string description: 详情封面地址 depthImageUrl: type: string description: 深度图地址 id: type: string description: 商品详情ID imageFileList: type: array items: type: object properties: fileFullPath: type: string description: 文件路径 fileName: type: string description: 文件名 description: 商品详情图片结构 imageList: type: array items: type: object properties: fileFullPath: type: string description: 文件路径 fileName: type: string description: 文件名 description: 商品详情图片结构 roomId: type: string description: 3D方案空间ID sortNo: type: integer format: int32 description: 排序码 title: type: string description: 标题 vrImageUrl: type: string description: 全景图地址 description: 商品详情 goodsExt: type: object properties: areaCode: type: string description: 区县代码 areaName: type: string description: 区县名称 buildingNo: type: string description: 楼栋号 cityCode: type: string description: 城市代码 cityName: type: string description: 城市名称 provinceCode: type: string description: 省份代码 provinceName: type: string description: 省份名称 residential: type: string description: 小区/楼盘 roomNo: type: string description: 房号 unitNo: type: string description: 单元号 description: 商品扩展信息,包含地址内容等扩展资料 goodsName: type: string description: 商品名称 goodsProductStr: type: string description: 商品产品型号字符串,多个用英文逗号分隔 goodsProducts: type: array items: type: object properties: productNo: type: string description: 产品型号 sortNo: type: integer format: int32 description: 排序 description: 商品产品结构 goodsStatus: type: string description: 商品状态代码,empty=草稿,checking=审核,reject=上架驳回,upShelves=上架,offShelves=下架 goodsStatusDesc: type: string description: 商品状态 goodsTags: type: array items: type: object properties: tagId: type: string description: 标签ID tagName: type: string description: 标签名称 description: 商品标签信息 goodsType: type: string description: 商品类型 id: type: string description: 商品ID lookNums: type: integer format: int32 description: 查看数 orderNum: type: integer format: int32 description: 下单数 planMapUrl: type: string description: 平面布置图 praiseNums: type: integer format: int32 description: 点赞数 price: type: integer format: int32 description: 售价 relGoodIds: type: array items: {} description: 关联设计师案例ID schemeDepthImageUrl: type: string description: 深度图地址 schemeId: type: string description: 3D方案ID schemeSized: type: number format: double description: 面积 schemeSizedStr: type: string description: 面积区间 schemeStyle: type: string description: 风格ID schemeStyleDesc: type: string description: 风格 schemeTop: type: integer format: int32 description: 是否加精,0=没有加精;1=加精 schemeType: type: string description: 户型ID schemeTypeDesc: type: string description: 户型 schemeUrl: type: string description: 3D方案地址 schemeVrImageUrl: type: string description: 全景图地址 schemeVrPreImageUrl: type: string description: 全景图预览地址 schemeVrUrl: type: string description: 全景图链接地址 sourcePrice: type: integer format: int32 description: 源文件售价:0=免费,-1=不销售,其他值表示价格 statusDate: type: string description: 审核时间(通过/不通过),格式yyyy-MM-ddHH:mm:ss statusReason: type: string description: 审核通过/不通过原因 topSortCode: type: integer format: int64 description: 置顶排序序号(序号越大,越前) goodsMarketingType: type: integer format: int32 description: 商品营销类型:0=全屋空间案例库,1=营销活动套餐库,2=卫浴空间案例库,3=阳台空间案例库,4=全场景高端定制方案,5=卫浴个性空间案例库,6=淋浴房空间案例库 example: msg: '' code: 0 data: statusDate: '' praiseNums: 0 schemeType: '' goodsProducts: - sortNo: 0 productNo: '' schemeDepthImageUrl: '' goodsProductStr: '' orderNum: 0 schemeId: '' schemeTypeDesc: '' buyNums: 0 planMapUrl: '' content: '' sourcePrice: 0 schemeVrPreImageUrl: '' goodsTags: - tagId: '' tagName: '' schemeTop: 0 statusReason: '' price: 0 id: '' goodsName: '' createDate: '' relGoodIds: [] goodsDetails: - imageFileList: - fileName: '' fileFullPath: '' vrImageUrl: '' coverPageUrl: '' title: '' content: '' roomId: '' categoryNames: [] sortNo: 0 depthImageUrl: '' coverImage: - fileName: '' fileFullPath: '' categoryList: - selectedList: [] text: '' value: '' id: '' imageList: - fileName: '' fileFullPath: '' schemeStyle: '' author: nickName: '' mobile: '' avatar: '' outUserId: '' userName: '' userId: '' name: '' coverPageUrl: '' goodsExt: unitNo: '' roomNo: '' cityCode: '' provinceCode: '' areaCode: '' residential: '' cityName: '' areaName: '' buildingNo: '' provinceName: '' schemeSizedStr: '' schemeUrl: '' lookNums: 0 topSortCode: 0 checkDate: '' goodsStatusDesc: '' activitiesName: '' goodsType: '' checkUser: nickName: '' mobile: '' avatar: '' outUserId: '' userName: '' userId: '' name: '' goodsStatus: '' schemeVrUrl: '' schemeStyleDesc: '' schemeVrImageUrl: '' favoriteNums: 0 goodsMarketingType: 0 success: false '401': description: access_token 缺失或已过期 / missing or expired access_token /api/v1/shaderupload/getShaderEdiAttribute: post: operationId: apiV1ShaderuploadGetShaderEdiAttribute summary: 获取材质模板编辑JSON接口 tags: - Products x-source-documentation: https://dev.3vjia.com/document?apiId=783763939858223113 x-documentation-category: 产品模块 / 贴图上传 requestBody: required: true content: application/json: schema: type: object properties: shaderId: type: string description: 材质属性ID required: - shaderId example: shaderId: '' responses: '200': description: 成功 / OK content: application/json: schema: type: object properties: success: type: boolean description: 请求是否成功 / whether the call succeeded code: type: integer description: 结果码 / result code (0 = success) msg: type: string description: 提示信息 / message data: type: object properties: categoryids: type: array items: {} description: 材质球分类列表 desc: type: string description: 主图 imageUrl: type: string description: 渲染图路径 name: type: string description: 材质球名字 ossPath: type: string description: 材质球jsonossPath shaderUploadId: type: string description: 材质球id templateJsonStr: type: string description: 模板json example: msg: '' code: 0 data: shaderUploadId: '' categoryids: [] imageUrl: '' name: '' desc: '' ossPath: '' templateJsonStr: '' success: false '401': description: access_token 缺失或已过期 / missing or expired access_token /api/v1/shop/createDeptAndShopRelation: post: operationId: apiV1ShopCreateDeptAndShopRelation summary: 批量设置门店绑定部门接口 tags: - Accounts x-source-documentation: https://dev.3vjia.com/document?apiId=475027993060782090 x-documentation-category: 账号模块 / 门店管理 description: 批量设置门店绑定部门 requestBody: required: false content: application/json: schema: type: object properties: deptId: type: string description: 三维家部门ID,deptId和outDeptId两个至少传一个,用于查找部门,传入deptId后将忽略outDeptId outDeptId: type: string description: 部门对应的企业系统部门ID,deptId和outDeptId两个至少传一个,用于查找部门,不传deptId时outDeptId有效 outShopIdList: type: array items: {} description: 门店对应的企业系统门店ID列表,shopIdList和outShopIdList两个至少传一个,用于查找门店,不传shopIdList时outShopIdList有效 shopIdList: type: array items: {} description: 三维家门店ID列表,shopIdList和outShopIdList两个至少传一个,用于查找门店,传入shopIdList后将忽略outShopIdList example: deptId: '' outShopIdList: [] shopIdList: [] outDeptId: '' responses: '200': description: 成功 / OK content: application/json: schema: type: object properties: success: type: boolean description: 请求是否成功 / whether the call succeeded code: type: integer description: 结果码 / result code (0 = success) msg: type: string description: 提示信息 / message data: type: object example: msg: '' code: 0 data: false success: false '401': description: access_token 缺失或已过期 / missing or expired access_token /api/v1/shop/createShop: post: operationId: apiV1ShopCreateShop summary: 添加门店接口 tags: - Accounts x-source-documentation: https://dev.3vjia.com/document?apiId=474672016889319480 x-documentation-category: 账号模块 / 门店管理 description: 添加门店 requestBody: required: false content: application/json: schema: type: object properties: address: type: string description: 门店地址 city: type: string description: 市,province有值时此字段才有效,注意这里不要传【市】字,如广州应该传【广州】而非【广州市】 contactMan: type: string description: 门店联系人 customerCode: type: string description: 门店编码 district: type: string description: 县/区,province、city有值时此字段才有效,注意这里不要传【区】【县】字,如天河应该传【天河】而非【天河区】 outShopId: type: string description: 门店应的企业系统门店ID,用于做绑定 province: type: string description: 省,注意这里不要传【省】字,如广东应该传【广东】而非【广东省】 relateDeptIdList: type: array items: {} description: 此门店所关联的三维家部门ID,relateDeptIdList和relateOutDeptIdList至少传一个,传入relateDeptIdList时将忽略relateOutDeptIdList relateOutDeptIdList: type: array items: {} description: 此门店所关联的企业系统部门ID(需要已做绑定),relateDeptIdList和relateOutDeptIdList至少传一个,relateDeptIdList为空时relateOutDeptIdList有效 shopName: type: string description: 门店名称 storeType: type: integer format: int32 description: 门店类型:0=直营店,1=加盟店 tel: type: string description: 门店联系方式 example: storeType: 0 address: '' city: '' outShopId: '' customerCode: '' shopName: '' relateOutDeptIdList: [] contactMan: '' relateDeptIdList: [] province: '' district: '' tel: '' responses: '200': description: 成功 / OK content: application/json: schema: type: object properties: success: type: boolean description: 请求是否成功 / whether the call succeeded code: type: integer description: 结果码 / result code (0 = success) msg: type: string description: 提示信息 / message data: type: object properties: outShopId: type: string description: 企业系统的门店ID,与入参的outShopId一致 shopId: type: string description: 创建成功后产生的门店ID shopName: type: string description: 门店名称,与入参一致 example: msg: '' code: 0 data: outShopId: '' shopName: '' shopId: '' success: false '401': description: access_token 缺失或已过期 / missing or expired access_token /api/v1/shop/deleteShop: post: operationId: apiV1ShopDeleteShop summary: 删除门店接口 tags: - Accounts x-source-documentation: https://dev.3vjia.com/document?apiId=474673473520762925 x-documentation-category: 账号模块 / 门店管理 description: 删除门店 requestBody: required: false content: application/json: schema: type: object properties: outShopId: type: string description: 门店对应的企业系统门店ID,shopId和outShopId两个至少传一个,用于查找要删除的门店,不传shopId时outShopId有效 examples: - '456789' shopId: type: string description: 三维家门店ID,shopId和outShopId两个至少传一个,用于查找要删除的门店,传入shopId后将忽略outShopId examples: - '20171234' example: outShopId: '456789' shopId: '20171234' responses: '200': description: 成功 / OK content: application/json: schema: type: object properties: success: type: boolean description: 请求是否成功 / whether the call succeeded code: type: integer description: 结果码 / result code (0 = success) msg: type: string description: 提示信息 / message data: type: object example: msg: 成功 code: 0 data: true success: true '401': description: access_token 缺失或已过期 / missing or expired access_token /api/v1/shop/getShop: post: operationId: apiV1ShopGetShop summary: 获取门店信息接口 tags: - Accounts x-source-documentation: https://dev.3vjia.com/document?apiId=474670751249698875 x-documentation-category: 账号模块 / 门店管理 description: 获取单个门店信息 requestBody: required: false content: application/json: schema: type: object properties: outShopId: type: string description: 门店对应的企业系统门店ID,shopId和outShopId两个至少传一个,用于查找要删除的门店,不传shopId时outShopId有效 examples: - '456789' shopId: type: string description: 三维家门店ID,shopId和outShopId两个至少传一个,用于查找要删除的门店,传入shopId后将忽略outShopId examples: - '20171234' example: outShopId: '456789' shopId: '20171234' responses: '200': description: 成功 / OK content: application/json: schema: type: object properties: success: type: boolean description: 请求是否成功 / whether the call succeeded code: type: integer description: 结果码 / result code (0 = success) msg: type: string description: 提示信息 / message data: type: object properties: address: type: string description: 门店地址 city: type: string description: 市 contactMan: type: string description: 门店联系人 createDate: type: string description: 创建时间,格式yyyy-MM-ddHH:mm:ss customerCode: type: string description: 门店编码 deptList: type: array items: type: object properties: customerCode: type: string description: 部门对应客户部门编码 deptId: type: string description: 部门ID deptName: type: string description: 部门名称 outDeptId: type: string description: 部门所绑定企业系统部门ID,绑定过才有值 storeType: type: integer format: int32 description: 类型0=门店,1=部门 description: 上级部门信息 district: type: string description: 区 extParam: type: array items: type: object properties: fieldName: type: string description: 扩展字段名称 fieldValue: type: string description: 扩展字段值 description: 门店信息结构,V2 organ: type: object properties: organId: type: string description: 企业ID organName: type: string description: 企业名称 description: 部门所属机构信息 outShopId: type: string description: 门店绑定的企业系统门店ID,要绑定过才有值 province: type: string description: 省 shopId: type: string description: 门店ID shopName: type: string description: 门店名称 shopNameShort: type: string description: 门店简称 storeType: type: string description: 门店类型 tel: type: string description: 门店联系方式 virtualDeptId: type: string description: 虚拟部门ID,兼容旧业务 example: msg: 成功 code: 0 data: organ: organName: '' organId: '' storeType: '' address: '' city: '' extParam: - fieldName: '' fieldValue: '' outShopId: '' customerCode: '' shopName: '' contactMan: '' virtualDeptId: '' deptList: - deptName: '' storeType: 0 deptId: '' customerCode: '' outDeptId: '' province: '' district: '' shopNameShort: '' tel: '' shopId: '' createDate: '' success: true '401': description: access_token 缺失或已过期 / missing or expired access_token /api/v1/shop/getShopListByPage: post: operationId: apiV1ShopGetShopListByPage summary: 获取门店列表接口 tags: - Accounts x-source-documentation: https://dev.3vjia.com/document?apiId=474672236729569288 x-documentation-category: 账号模块 / 门店管理 description: 分页获取门店列表,当不需要过滤时,入参请传空字典,而非不传 requestBody: required: false content: application/json: schema: type: object properties: deptId: type: string description: 门店所关联的三维家部门ID,传入deptId时将忽略outDeptId examples: - '20172012' likeShopName: type: string description: 门店名称,模糊查询 examples: - 测试 outDeptId: type: string description: 门店所关联的企业系统部门ID(需要已做绑定),deptId为空时outDeptId有效 examples: - '123456' pageIndex: type: integer format: int32 description: 页码,最小值为1,默认值为1 examples: - '1' pageSize: type: integer format: int32 description: 分页大小,最小值1,最大值500,默认值50 examples: - '50' storeType: type: integer format: int32 description: 门店类型:0=直营店,1=加盟店 examples: - '0' example: storeType: 0 deptId: '20172012' pageSize: 50 likeShopName: 测试 pageIndex: 1 outDeptId: '123456' responses: '200': description: 成功 / OK content: application/json: schema: type: object properties: success: type: boolean description: 请求是否成功 / whether the call succeeded code: type: integer description: 结果码 / result code (0 = success) msg: type: string description: 提示信息 / message data: type: object properties: pageIndex: type: integer format: int64 description: 当前查询第几页 pageSize: type: integer format: int64 description: 当前查询页记录数 recordCount: type: integer format: int64 description: 总数 result: type: array items: type: object properties: address: type: string description: 门店地址 city: type: string description: 市 createDate: type: string description: 创建时间,格式yyyy-MM-ddHH:mm:ss customerCode: type: string description: 门店编码 deptList: type: array items: type: object properties: customerCode: type: string description: 部门对应客户部门编码 deptId: type: string description: 部门ID deptName: type: string description: 部门名称 outDeptId: type: string description: 部门绑定的企业系统部门ID,要绑定过才有值 description: 部门基本信息结构,V2 district: type: string description: 区 outShopId: type: string description: 门店绑定的企业系统门店ID,要绑定过才有值 province: type: string description: 省 shopId: type: string description: 门店ID shopName: type: string description: 门店名称 storeType: type: integer format: int32 description: 门店类型:0=直营店,1=加盟店 virtualDeptId: type: string description: 虚拟部门ID,兼容旧业务 description: 门店信息结构,列表用,V2 totalPage: type: integer format: int64 description: 总页数 example: msg: '' code: 0 data: totalPage: 0 recordCount: 0 pageSize: 0 result: - storeType: 0 address: '' city: '' outShopId: '' customerCode: '' shopName: '' virtualDeptId: '' deptList: - deptName: '' deptId: '' customerCode: '' outDeptId: '' province: '' district: '' shopId: '' createDate: '' pageIndex: 0 success: false '401': description: access_token 缺失或已过期 / missing or expired access_token /api/v1/shop/updateShop: post: operationId: apiV1ShopUpdateShop summary: 编辑门店接口 tags: - Accounts x-source-documentation: https://dev.3vjia.com/document?apiId=474673473520762921 x-documentation-category: 账号模块 / 门店管理 description: 编辑门店 requestBody: required: false content: application/json: schema: type: object properties: address: type: string description: 门店地址 city: type: string description: 市,province有值时此字段才有效,注意这里不要传【市】字,如广州应该传【广州】而非【广州市】 contactMan: type: string description: 门店联系人 customerCode: type: string description: 门店编码 district: type: string description: 县/区,province、city有值时此字段才有效,注意这里不要传【区】【县】字,如天河应该传【天河】而非【天河区】 newOutShopId: type: string description: 门店对应的企业系统门店ID,要修改门店对应的企业系统门店时传入 outShopId: type: string description: 门店对应的企业系统门店ID,shopId和outShopId两个至少传一个,用于查找要修改的门店,不作为修改项,不传shopId时outShopId有效 province: type: string description: 省,注意这里不要传【省】字,如广东应该传【广东】而非【广东省】 shopId: type: string description: 三维家门店ID,shopId和outShopId两个至少传一个,用于查找要修改的门店,不作为修改项,传入shopId后将忽略outShopId shopName: type: string description: 门店名称 storeType: type: integer format: int32 description: 门店类型:0=直营店,1=加盟店 tel: type: string description: 门店联系方式 example: newOutShopId: '' storeType: 0 address: '' city: '' outShopId: '' customerCode: '' shopName: '' contactMan: '' province: '' district: '' tel: '' shopId: '' responses: '200': description: 成功 / OK content: application/json: schema: type: object properties: success: type: boolean description: 请求是否成功 / whether the call succeeded code: type: integer description: 结果码 / result code (0 = success) msg: type: string description: 提示信息 / message data: type: object example: msg: 成功 code: 0 data: true success: true '401': description: access_token 缺失或已过期 / missing or expired access_token /api/v1/shoporders/createReplenishOrderForOpen: post: operationId: apiV1ShopordersCreateReplenishOrderForOpen summary: 创建售后单和补单 tags: - MOS x-source-documentation: https://dev.3vjia.com/document?apiId=490584514674896923 x-documentation-category: MOS系统 / 订单管理 requestBody: required: false content: application/json: schema: type: object properties: operationUserId: type: string description: 操作用户id,与操作用户名二选一必填,id优先 operationUserName: type: string description: 操作用户名 orderNo: type: string description: 原单订单号 orderRecordId: type: string description: 原单订单记录ID,与原单订单号二选一必填,ID优先 orderTypeCode: type: string description: 订单类型编码,SH售后单,BD补单,非必填 reasonId: type: string description: 补单原因id,非必填 remark: type: string description: 补单备注,非必填 example: orderTypeCode: '' orderNo: '' remark: '' operationUserName: '' orderRecordId: '' operationUserId: '' reasonId: '' responses: '200': description: 成功 / OK content: application/json: schema: type: object properties: success: type: boolean description: 请求是否成功 / whether the call succeeded code: type: integer description: 结果码 / result code (0 = success) msg: type: string description: 提示信息 / message data: type: object properties: cause: type: string description: 补单/售后原因 causeName: type: string description: 补单/售后原因 clientRecordid: type: string description: 客户Id colorRecordId: type: string description: 主材样式id consigneeAddress: type: string description: 收货地址 contactRealName: type: string description: 联系人 createTime: type: string description: 下单时间(创建时间) customerName: type: string description: 客户姓名 deptId: type: string description: 部门id deptName: type: string description: 部门名称 designId: type: string description: 设计方案的id designRecordId: type: string description: 设计方案的recordid designerName: type: string description: 设计师账号 designerRealName: type: string description: 设计师真实姓名 designerUserName: type: string description: 设计师userName disOrderRecordIdShenHe: type: string description: 审核方案recordId用户打开审核方案 diyOrderNo: type: string description: 自定义订单号 drawingType: type: string description: 产品类型(板式,实木,移门,掩门) id: type: string description: ID isOnlyFile: type: string description: 只有附件的订单0-否1-是 orderName: type: string description: 订单名称 orderNo: type: string description: 订单编号 orderType: type: string description: 订单类别(常规单、样品单、材料单) orderType3DCode: type: string description: 3D橱衣系统柜浴室柜等模块分类代码 orderTypeCategoryName: type: string description: 订单类型名称 orderTypeId: type: string description: 订单类别id orderTypeName: type: string description: 订单类别名称 organName: type: string description: 机构名称 organRecordID: type: string description: 机构id planSetupTime: type: string description: 预约安装时间 productType: type: string description: 产品类型(板式,实木,移门,掩门) remark: type: string description: 备注 salesChannel: type: string description: 订单类别(常规单、样品单、材料单) schemeId: type: string description: 完整方案的id shopOrderRecordId: type: string description: 店铺订单RecordId solutionId: type: string description: 订单报价方案ID spatialName: type: string description: 空间信息 stateCode: type: string description: 订单状态code stateName: type: string description: 订单状态 stateRecordId: type: string description: 订单状态recordid submitTime: type: string description: 提交订单时间 urgentRecordId: type: string description: 加急等级 verifyRecordId: type: string description: 审核方案的recordid example: msg: '' code: 0 data: deptName: '' orderType: '' cause: '' orderTypeId: '' remark: '' schemeId: '' disOrderRecordIdShenHe: '' planSetupTime: '' salesChannel: '' verifyRecordId: '' diyOrderNo: '' isOnlyFile: '' designerUserName: '' orderTypeCategoryName: '' orderType3DCode: '' stateName: '' id: '' productType: '' consigneeAddress: '' orderName: '' urgentRecordId: '' drawingType: '' shopOrderRecordId: '' orderNo: '' causeName: '' deptId: '' customerName: '' designerName: '' orderTypeName: '' designRecordId: '' spatialName: '' organName: '' submitTime: '' createTime: '' colorRecordId: '' designId: '' contactRealName: '' designerRealName: '' stateCode: '' solutionId: '' clientRecordid: '' organRecordID: '' stateRecordId: '' success: false '401': description: access_token 缺失或已过期 / missing or expired access_token /api/v1/taskAluminumOptimizeData/getNewList: post: operationId: apiV1TaskAluminumOptimizeDataGetNewList summary: 铝门窗任务优化结果查询列表 tags: - AIMES x-source-documentation: https://dev.3vjia.com/document?apiId=479322398315880481 x-documentation-category: AIMES系统 / 生产管理 requestBody: required: false content: application/json: schema: type: object properties: taskCode: type: string description: 任务号 taskId: type: integer format: int64 description: 任务Id example: taskCode: '' taskId: 0 responses: '200': description: 成功 / OK content: application/json: schema: type: object properties: success: type: boolean description: 请求是否成功 / whether the call succeeded code: type: integer description: 结果码 / result code (0 = success) msg: type: string description: 提示信息 / message data: type: object properties: materialShortages: type: array items: type: object properties: innerMaterial: type: string description: 材料颜色 innerPartNumber: type: string description: 材料颜色编码 length: type: number format: bigdecimal description: 材料长度 materialCode: type: string description: 材料编码 shortageNum: type: integer format: int32 description: 材料数量 description: 任务优化缺料信息 optimizeDataResults: type: array items: type: object properties: childMaterials: type: array items: type: object properties: childMaterials: type: array items: {} description: 铝门窗生产任务优化结果明细信息 color: type: string description: 颜色 createTime: type: string format: date-time description: 创建时间 creatorName: type: string description: 创建人 deptId: type: string description: 部门 heatInsulationBar: type: string description: 隔热条 id: type: integer format: int64 description: 主键id innerMaterial: type: string description: 室内颜色名称 innerPartnumber: type: string description: 室内颜色编号 isCompoundMaterials: type: integer format: int32 description: 是否复合料(0-否;1-是) isSurplusMaterials: type: integer format: int32 description: 是否余料(0-否;1-是) length: type: number format: bigdecimal description: 长度 locationCode: type: string description: 仓位 materialCode: type: string description: 物料编号 materialName: type: string description: 物料名称 materialType: type: string description: 物料类型 modifierName: type: string description: 修改人 num: type: integer format: int32 description: 数量 organId: type: string description: 机构ID outerMaterial: type: string description: 室外颜色名称 outerPartnumber: type: string description: 室外颜色编号 parentId: type: integer format: int64 description: 父级id series: type: string description: 系列 shortageNum: type: integer format: int32 description: 缺料数量 taskCode: type: string description: 任务编号 taskId: type: integer format: int64 description: 任务ID warehouseCode: type: string description: 仓库编号 warehouseName: type: string description: 仓库名称 required: - createTime - id description: 铝门窗生产任务优化结果明细信息 color: type: string description: 颜色 createTime: type: string format: date-time description: 创建时间 creatorName: type: string description: 创建人 deptId: type: string description: 部门 heatInsulationBar: type: string description: 隔热条 heatInsulationBarCode: type: string heatInsulationBarName: type: string id: type: integer format: int64 description: 主键id innerMaterial: type: string description: 室内颜色名称 innerPartnumber: type: string description: 室内颜色编号 isCompoundMaterials: type: integer format: int32 description: 是否复合料(0-否;1-是) isSurplusMaterials: type: integer format: int32 description: 是否余料(0-否;1-是) length: type: number format: bigdecimal description: 长度 locationCode: type: string description: 仓位 materialCode: type: string description: 物料编号 materialName: type: string description: 物料名称 materialType: type: string description: 物料类型 modifierName: type: string description: 修改人 num: type: integer format: int32 description: 数量 organId: type: string description: 机构ID outerMaterial: type: string description: 室外颜色名称 outerPartnumber: type: string description: 室外颜色编号 parentId: type: integer format: int64 description: 父级id series: type: string description: 系列 shortageNum: type: integer format: int32 description: 缺料数量 taskCode: type: string description: 任务编号 taskId: type: integer format: int64 description: 任务ID warehouseCode: type: string description: 仓库编号 warehouseName: type: string description: 仓库名称 required: - createTime - id description: 铝门窗优化结果返参 example: data: optimizeDataResults: - outerMaterial: '' color: '' num: 0 creatorName: '' warehouseName: '' warehouseCode: '' taskCode: '' id: 0 heatInsulationBarCode: '' isSurplusMaterials: 0 childMaterials: - outerMaterial: '' color: '' num: 0 creatorName: '' warehouseName: '' warehouseCode: '' taskCode: '' id: 0 isSurplusMaterials: 0 childMaterials: [] isCompoundMaterials: 0 innerMaterial: '' materialType: '' deptId: '' length: 0 innerPartnumber: '' materialCode: '' parentId: 0 materialName: '' shortageNum: 0 createTime: '' series: '' outerPartnumber: '' organId: '' modifierName: '' heatInsulationBar: '' locationCode: '' taskId: 0 isCompoundMaterials: 0 innerMaterial: '' materialType: '' deptId: '' length: 0 innerPartnumber: '' materialCode: '' parentId: 0 materialName: '' shortageNum: 0 createTime: '' series: '' outerPartnumber: '' organId: '' modifierName: '' heatInsulationBar: '' locationCode: '' heatInsulationBarName: '' taskId: 0 materialShortages: - innerMaterial: '' length: 0 materialCode: '' innerPartNumber: '' shortageNum: 0 errorMessage: '' success: false '401': description: access_token 缺失或已过期 / missing or expired access_token /api/v1/texture/oss/getUploadToken: post: operationId: apiV1TextureOssGetUploadToken summary: 获取贴图上传签名接口 tags: - Products x-source-documentation: https://dev.3vjia.com/document?apiId=594831372460384307 x-documentation-category: 产品模块 / 贴图上传 description: 注意:支持上传的图片大小不可大于10M requestBody: required: true content: application/json: schema: type: object properties: fileSuffix: type: string description: 上传文件后缀,不带'.',支持:jpg、jpeg、png examples: - jpg required: - fileSuffix example: fileSuffix: jpg responses: '200': description: 成功 / OK content: application/json: schema: type: object properties: success: type: boolean description: 请求是否成功 / whether the call succeeded code: type: integer description: 结果码 / result code (0 = success) msg: type: string description: 提示信息 / message data: type: object properties: accessKeyId: type: string description: 访问密钥标识 contentType: type: string description: 华为云和腾讯云都要把 Content-Type 作为表单字段返回(非空的时候带过去,或者指定 prefix 的时候要自己生成并带过去) contentTypePrefix: type: string description: 内容类型前缀 expireAt: type: integer format: int64 description: 签名过期10位秒级时间戳 expireTime: type: string format: date-time description: 签名过期时间 formFields: type: object description: 表单字段,用于前端直传时的表单字段填充 key: type: string description: 约束上传的key keyPrefix: type: string description: 约束上传的key前缀 ossHost: type: string description: 需要上传到哪个OSS上,值为OSS地址或者CDN域名 policy: type: string description: 签名上传的约束策略,比如大小、前缀等 readDomain: type: string description: 对于公共读bucket,该值用于拼接完整域名 securityToken: type: string description: 安全令牌(当基于STS或者IAM生成签名时前端的表单必须同时携带该参数) signature: type: string description: 签名信息 vendor: type: string description: 本次生成签名对应的厂商 required: - expireTime - vendor example: msg: '' code: 0 data: accessKeyId: '' signature: '' contentTypePrefix: '' expireAt: 0 keyPrefix: '' ossHost: '' securityToken: '' expireTime: '' readDomain: '' vendor: '' formFields: '' contentType: '' key: '' policy: '' success: false '401': description: access_token 缺失或已过期 / missing or expired access_token /api/v1/texture/upload/uploadDiffuseImageNew: post: operationId: apiV1TextureUploadUploadDiffuseImageNew summary: 保存贴图文件记录接口 tags: - Products x-source-documentation: https://dev.3vjia.com/document?apiId=594856867340115995 x-documentation-category: 产品模块 / 贴图上传 requestBody: required: true content: application/json: schema: type: object properties: description: type: string description: 渲染通道:diffuse=漫反射 default: diffuse isCustomModule: type: boolean description: 是否是自定义模块 examples: - 'false' default: 'false' originalFileName: type: string description: 上传源文件名称 examples: - xxx.jpg ossPath: type: string description: 贴图文件路径,对应“获取贴图上传签名接口”返回值的key字段值 examples: - matImage/C00000001/20240629/fe6ff1a302904eb588d300c15d805921.jpg unCompressed: type: boolean description: 是否压缩图片,默认为false(不压缩) examples: - 'false' default: 'false' required: - originalFileName - ossPath example: originalFileName: xxx.jpg description: '' isCustomModule: false unCompressed: false ossPath: matImage/C00000001/20240629/fe6ff1a302904eb588d300c15d805921.jpg responses: '200': description: 成功 / OK content: application/json: schema: type: object properties: success: type: boolean description: 请求是否成功 / whether the call succeeded code: type: integer description: 结果码 / result code (0 = success) msg: type: string description: 提示信息 / message data: type: object properties: fileId: type: string description: 上传文件ID fileName: type: string description: 上传文件名称 filePath: type: string description: 上传文件路径 subjectId: type: string description: 上传文件关联子ID example: msg: '' code: 0 data: fileName: '' filePath: '' subjectId: '' fileId: '' success: false '401': description: access_token 缺失或已过期 / missing or expired access_token /api/v1/texture/uploadchartlet/addChartlets: post: operationId: apiV1TextureUploadchartletAddChartlets summary: 保存贴图数据接口 tags: - Products x-source-documentation: https://dev.3vjia.com/document?apiId=594863501818880096 x-documentation-category: 产品模块 / 贴图上传 requestBody: required: true content: application/json: schema: type: object properties: picHeight: type: number format: double description: 高 examples: - '200' picWidth: type: number format: double description: 宽 examples: - '200' belongType: type: integer format: int32 description: 归属:0=个人素材,1=门店素材,2=企业素材 examples: - '2' default: '0' categoryid: type: integer format: int32 description: 素材分类ID chartletImgsDTOS: type: array items: type: object properties: description: type: string description: 材质属性 imgPath: type: string description: 临时图片路径 description: 贴图多张渲染图 description: type: string description: 渲染通道:diffuse=漫反射 examples: - diffuse default: diffuse imagePath: type: string description: 素材主图路径,对应“获取贴图上传签名接口”返回值的key字段值 isNew: type: integer format: int32 description: 是否新材质:1=新材质,0=旧材质 materialName: type: string description: 素材名字 modelFlag: type: integer format: int32 description: 素材模块 property: type: string description: 材质属性 required: - picHeight - picWidth - belongType - categoryid - imagePath - isNew - modelFlag - property example: - belongType: 2 categoryid: 0 chartletImgsDTOS: - description: '' imgPath: '' description: diffuse imagePath: '' isNew: 0 materialName: '' modelFlag: 0 property: '' responses: '200': description: 成功 / OK content: application/json: schema: type: object properties: success: type: boolean description: 请求是否成功 / whether the call succeeded code: type: integer description: 结果码 / result code (0 = success) msg: type: string description: 提示信息 / message data: type: object properties: materialId: type: string productId: type: string example: msg: '' code: 0 data: - productId: '' materialId: '' success: false '401': description: access_token 缺失或已过期 / missing or expired access_token /api/v1/ucp/multiOrgan/bindOrUnbind: post: operationId: apiV1UcpMultiOrganBindOrUnbind summary: 绑定或解绑子机构账号接口 tags: - Dedicated Services x-source-documentation: https://dev.3vjia.com/document?apiId=523496510302834715 x-documentation-category: 专属服务 / C00002400 requestBody: required: true content: application/json: schema: type: object properties: mainUserId: type: string description: 主机构绑定用户ID subUserId: type: string description: 子机构绑定用户ID(ID不为空为绑定,为空则为解绑) required: - mainUserId example: mainUserId: '' subUserId: '' responses: '200': description: 成功 / OK content: application/json: schema: type: object properties: success: type: boolean description: 请求是否成功 / whether the call succeeded code: type: integer description: 结果码 / result code (0 = success) msg: type: string description: 提示信息 / message data: type: object example: msg: '' code: 0 data: false success: false '401': description: access_token 缺失或已过期 / missing or expired access_token /api/v1/upload/line/generateMultiSection: post: operationId: apiV1UploadLineGenerateMultiSection summary: 批量保存线条文件接口 tags: - Products x-source-documentation: https://dev.3vjia.com/document?apiId=644942232721448984 x-documentation-category: 产品模块 / 线条上传 requestBody: required: true content: application/json: schema: type: object properties: cadUrl: type: string description: 线条文件的全路径 lineType: type: string description: 线条类型:ceilingline=天花线,waistline=腰线,footline=脚线,topline=顶线,cabinetlightline=灯线,cabinettable=台面,slidingdoorline=趟门线 module: type: string description: 模块:bathRoom=淋浴房,bathCabinet=浴室柜,doorWindow=门窗,wardrobe=衣柜,cupboard=橱柜,systemCabinet=系统柜,showerRoom=卫浴,aluminum=铝门窗,Universal=通用,brickSystem=铺砖,ceiling=顶墙 needDimension: type: boolean description: 是否标注尺寸 needImage: type: boolean description: 是否返回图片 stretchType: type: string description: 拉伸方向:x(默认),y,z required: - cadUrl - lineType - module - needDimension - needImage - stretchType example: - cadUrl: '' lineType: '' module: '' needDimension: false needImage: false stretchType: '' responses: '200': description: 成功 / OK content: application/json: schema: type: object properties: success: type: boolean description: 请求是否成功 / whether the call succeeded code: type: integer description: 结果码 / result code (0 = success) msg: type: string description: 提示信息 / message data: type: object properties: errCode: type: string description: 错误码 errMsg: type: string description: 错误信息 fileList: type: array items: type: object properties: dwgUrl: type: string description: 线条文件的全路径 imageUrl: type: string description: 图片路径 xmlUrl: type: string description: XML路径 description: 文件列表 example: msg: '' code: 0 data: errMsg: '' errCode: '' fileList: - xmlUrl: '' imageUrl: '' dwgUrl: '' success: false '401': description: access_token 缺失或已过期 / missing or expired access_token /api/v1/uploadcategory/getProperty: post: operationId: apiV1UploadcategoryGetProperty summary: 获取旧版材质属性接口 tags: - Products x-source-documentation: https://dev.3vjia.com/document?apiId=820245294661931083 x-documentation-category: 产品模块 / 贴图上传 responses: '200': description: 成功 / OK content: application/json: schema: type: object properties: success: type: boolean description: 请求是否成功 / whether the call succeeded code: type: integer description: 结果码 / result code (0 = success) msg: type: string description: 提示信息 / message data: type: object properties: id: type: string name: type: string example: msg: '' code: 0 data: - name: '' id: '' success: false '401': description: access_token 缺失或已过期 / missing or expired access_token /api/v1/uploadmaterial/createLines: post: operationId: apiV1UploadmaterialCreateLines summary: 批量保存线条接口 tags: - Products x-source-documentation: https://dev.3vjia.com/document?apiId=644945570976391206 x-documentation-category: 产品模块 / 线条上传 requestBody: required: false content: application/json: schema: type: object properties: belongType: type: integer format: int32 description: 所属类型:1=门店,2=企业 categoryid: type: integer format: int32 description: 素材分类ID designCode: type: string description: 部件编号 imagePath: type: string description: 素材主图路径 materialName: type: string description: 素材名称 modelFlag: type: integer format: int32 description: 素材模块 thumbPath: type: string description: 缩略图路径 xmlContentUrl: type: string description: XmlContent路径 example: - belongType: 0 categoryid: 0 designCode: '' imagePath: '' materialName: '' modelFlag: 0 thumbPath: '' xmlContentUrl: '' responses: '200': description: 成功 / OK content: application/json: schema: type: object properties: success: type: boolean description: 请求是否成功 / whether the call succeeded code: type: integer description: 结果码 / result code (0 = success) msg: type: string description: 提示信息 / message data: type: object properties: materialId: type: string productId: type: string example: msg: '' code: 0 data: - productId: '' materialId: '' success: false '401': description: access_token 缺失或已过期 / missing or expired access_token /api/v1/user/create: post: operationId: apiV1UserCreate summary: 添加账号接口 tags: - Accounts x-source-documentation: https://dev.3vjia.com/document?apiId=454656043478220890 x-documentation-category: 账号模块 / 账号管理 description: 添加三维家账号,并绑定企业用户 requestBody: required: true content: application/json: schema: type: object properties: deptId: type: string description: 账号所属三维家部门ID,关联部门传该字段 examples: - '123456' extendRoleList: type: array items: {} description: 账号所拥有的额外角色列表,角色需在三维家CRM后台管理中创建 examples: - '["123456","456789"]' mobile: type: string description: 用户手机号码,若传此值,需要保证此值符合手机号码格式,且此手机号没有被任何一个企业注册过三维家 examples: - '13800000000' name: type: string description: 用户姓名 examples: - 测试人员 nickName: type: string description: 用户昵称 examples: - 测试人员 note: type: string description: 备注,不超过256个字符 examples: - 备注 outUserId: type: string description: 账号在企业系统里的用户ID,此值将和三维家用户ID做绑定关系,用于单点登录等场景 examples: - A123456 password: type: string description: 账号密码,密码必须由6-20位字母、数字和符号的组合,至少需要包含两种 examples: - abc123456 selfIntro: type: string description: 自我介绍,不能超过2000个字符 examples: - 自我介绍 sex: type: string description: 性别,0=男,1=女,默认0 examples: - '0' shopId: type: string description: 账号所属三维家门店ID,关联门店传该字段 examples: - '123456' userName: type: string description: 要新增的三维家用户账号,需要由4-20个数字、字母组成(数字+字母,两者都需要有),账号名需要全网唯一,若传入的账号被其他企业注册过,会注册失败,建议使用机构的字母简称+手机号码 examples: - 3vj123456 required: - name - outUserId - password - userName example: note: 备注 nickName: 测试人员 sex: '0' deptId: '123456' mobile: '13800000000' outUserId: A123456 userName: 3vj123456 extendRoleList: [] password: abc123456 name: 测试人员 shopId: '123456' selfIntro: 自我介绍 responses: '200': description: 成功 / OK content: application/json: schema: type: object properties: success: type: boolean description: 请求是否成功 / whether the call succeeded code: type: integer description: 结果码 / result code (0 = success) msg: type: string description: 提示信息 / message data: type: object properties: outUserId: type: string description: 企业用户ID,和三维家用户ID绑定 examples: - A123456 userId: type: string description: 创建成功后的三维家用户ID examples: - 3vj123456 userName: type: string description: 创建成功后的三维家账号 examples: - 3vj123456 example: msg: '' code: 0 data: outUserId: A123456 userName: 3vj123456 userId: 3vj123456 success: false '401': description: access_token 缺失或已过期 / missing or expired access_token /api/v1/user/deleteBatch: post: operationId: apiV1UserDeleteBatch summary: 删除账号接口 tags: - Accounts x-source-documentation: https://dev.3vjia.com/document?apiId=454657671153385525 x-documentation-category: 账号模块 / 账号管理 description: 批量删除三维家用户,支持按三维家用户ID、三维家账号、企业用户ID进行删除,不会删除用户的绑定关系 requestBody: required: false content: application/json: schema: type: object properties: outUserIds: type: array items: {} description: 要删除的用户的企业用户ID列表,最多只能10个用户,userIds、userNames、outUserIds三个参数至少传1个,outUserIds优先级最低 examples: - '["A123456","B123456"]' userIds: type: array items: {} description: 要删除的用户的三维家用户ID列表,最多只能10个用户,userIds、userNames、outUserIds三个参数至少传1个,userIds优先级最高 examples: - '["1000123456","1000456789"]' userNames: type: array items: {} description: 要删除的用户的三维家用户账号列表,最多只能10个用户,userIds、userNames、outUserIds三个参数至少传1个,userNames优先级第二 examples: - '["3vj123456","3vj456789"]' example: outUserIds: [] userIds: [] userNames: [] responses: '200': description: 成功 / OK content: application/json: schema: type: object properties: success: type: boolean description: 请求是否成功 / whether the call succeeded code: type: integer description: 结果码 / result code (0 = success) msg: type: string description: 提示信息 / message data: type: object example: msg: '' code: 0 data: '' success: false '401': description: access_token 缺失或已过期 / missing or expired access_token /api/v1/user/get: post: operationId: apiV1UserGet summary: 获取账号信息接口 tags: - Accounts x-source-documentation: https://dev.3vjia.com/document?apiId=454659385306710071 x-documentation-category: 账号模块 / 账号管理 description: 获取三维家账号的基本信息,支持按三维家用户ID、三维家账号、企业用户ID获取,回收站内的账号无法获取 requestBody: required: false content: application/json: schema: type: object properties: outUserId: type: string description: 企业账号绑定时使用的企业用户ID,userId、userName、outUserId至少传一个,outUserId优先级第三 examples: - '123456' userId: type: string description: 三维家用户ID,userId、userName、outUserId至少传一个,userId优先级最高 examples: - '1000122456' userName: type: string description: 三维家账号,userId、userName、outUserId至少传一个,userName优先级第二 examples: - 3vj123456 example: outUserId: '123456' userName: 3vj123456 userId: '1000122456' responses: '200': description: 成功 / OK content: application/json: schema: type: object properties: success: type: boolean description: 请求是否成功 / whether the call succeeded code: type: integer description: 结果码 / result code (0 = success) msg: type: string description: 提示信息 / message data: type: object properties: createTime: type: string description: 账号创建时间,格式yyyy-MM-ddHH:mm:ss examples: - '2020-05-06 08:25:25' deptInfo: type: object properties: customerCode: type: string description: 部门对应客户部门编码 deptId: type: string description: 部门ID examples: - 00013678 deptName: type: string description: 部门名称 examples: - 运营管理部 outDeptId: type: string description: 部门所绑定企业系统部门ID,绑定过才有值 examples: - '123456' storeType: type: integer format: int32 description: 类型0=门店,1=部门 description: 上级部门信息 employeeStatus: type: integer format: int32 description: 员工状态,0:未启用,1:已启用,2:未注册,3:离职 examples: - '1' mobile: type: string description: 手机号码,需要设计师维护过才会有 examples: - '13800000000' modifyTime: type: string description: 账号最后修改时间,格式yyyy-MM-ddHH:mm:ss examples: - '2020-05-06 08:25:25' name: type: string description: 姓名 examples: - 丽丽 nickName: type: string description: 昵称 examples: - 丽丽 organInfo: type: object properties: organId: type: string description: 企业ID examples: - C00000000 organName: type: string description: 企业名称 examples: - XXX科技 description: 部门所属机构信息 outUserId: type: string description: 账号在当前AppId下所绑定的企业用户ID,有绑定才有 examples: - '12345678' sex: type: string description: 性别,0-男,1-女 examples: - '0' shopInfo: type: object properties: outShopId: type: string description: 门店所绑定企业系统门店ID,绑定过才有值 examples: - '123456' shopId: type: string description: 门店ID examples: - 00013678 shopName: type: string description: 门店名称 examples: - 天河店 description: 账号所属的门店信息,只包含基本信息 status: type: integer format: int32 description: 账号状态,1-正常2-锁定3-注销 examples: - '1' userId: type: string description: 三维家用户ID examples: - '1100151410' username: type: string description: 三维家账号 examples: - 3vj123456 example: msg: '' code: 0 data: shopInfo: outShopId: '123456' shopName: 天河店 shopId: 00013678 nickName: 丽丽 sex: '0' mobile: '13800000000' outUserId: '12345678' employeeStatus: 1 userId: '1100151410' modifyTime: '2020-05-06 08:25:25' createTime: '2020-05-06 08:25:25' organInfo: organName: XXX科技 organId: C00000000 name: 丽丽 deptInfo: deptName: 运营管理部 storeType: 0 deptId: 00013678 customerCode: '' outDeptId: '123456' status: 1 username: 3vj123456 success: false '401': description: access_token 缺失或已过期 / missing or expired access_token /api/v1/user/listByPage: post: operationId: apiV1UserListByPage summary: 获取账号列表接口 tags: - Accounts x-source-documentation: https://dev.3vjia.com/document?apiId=454659385306710073 x-documentation-category: 账号模块 / 账号管理 description: 分页获取三维家账号列表,当不需要过滤时,入参请传空字典,而非不传 requestBody: required: false content: application/json: schema: type: object properties: createBeginTime: type: string description: 账号创建时间-开始时间,格式yyyy-MM-ddHH:mm:ss examples: - '2019-12-01 01:01:00' createEndTime: type: string description: 账号创建时间-结束时间,格式yyyy-MM-ddHH:mm:ss examples: - '2019-12-02 01:01:00' deptId: type: string description: 账号所在三维家部门ID,传入此字段时,将忽略outDeptId字段 examples: - '1234567' likeName: type: string description: 用户真实姓名(模糊查询) examples: - 张三 likeNickname: type: string description: 用户昵称,模糊查询 examples: - 张三 mobile: type: string description: 用户手机号 examples: - '18390006000' modifyBeginTime: type: string description: 账号最后修改时间-开始时间,格式yyyy-MM-ddHH:mm:ss examples: - '2019-12-02 01:01:00' modifyEndTime: type: string description: 账号最后修改时间-结束时间,格式yyyy-MM-ddHH:mm:ss examples: - '2019-12-02 01:01:00' nickname: type: string description: 用户昵称,精确查询 examples: - 张三 outDeptId: type: string description: 账号所在三维家部门所绑定的的企业系统部门ID,deptId不传时,此字段有效 examples: - A123456 pageIndex: type: integer format: int32 description: 页码,最小值为1,默认值为1 examples: - '1' pageSize: type: integer format: int32 description: 分页大小,最小值1,最大值500,默认值50 examples: - '50' status: type: integer format: int32 description: 员工状态,0:已禁用,1:已启用 examples: - '1' userName: type: string description: 用户账号 examples: - zhangsan example: createBeginTime: '2019-12-01 01:01:00' likeNickname: 张三 deptId: '1234567' mobile: '18390006000' pageSize: 50 modifyEndTime: '2019-12-02 01:01:00' modifyBeginTime: '2019-12-02 01:01:00' userName: zhangsan likeName: 张三 pageIndex: 1 createEndTime: '2019-12-02 01:01:00' nickname: 张三 outDeptId: A123456 status: 1 responses: '200': description: 成功 / OK content: application/json: schema: type: object properties: success: type: boolean description: 请求是否成功 / whether the call succeeded code: type: integer description: 结果码 / result code (0 = success) msg: type: string description: 提示信息 / message data: type: object properties: pageIndex: type: integer format: int64 description: 当前查询第几页 examples: - '2' pageSize: type: integer format: int64 description: 当前查询页记录数 examples: - '50' recordCount: type: integer format: int64 description: 总数 examples: - '500' result: type: array items: type: object properties: createTime: type: string description: 账号创建时间,格式yyyy-MM-ddHH:mm:ss examples: - '2019-10-02 12:12:13' employeeStatus: type: integer format: int32 description: 员工状态,0:未启用,1:已启用,2:未注册,3:离职 examples: - '1' mobile: type: string description: 手机号码,需要设计师维护过才会有 examples: - '13800000000' modifyTime: type: string description: 账号最后修改时间,格式yyyy-MM-ddHH:mm:ss examples: - '2019-10-02 12:12:13' name: type: string description: 姓名 examples: - 丽丽 nickName: type: string description: 昵称 examples: - 丽丽 outUserId: type: string description: 账号在当前AppId下所绑定的企业用户ID,有绑定才有 examples: - '123456789' sex: type: string description: 性别:男,女 examples: - 男 status: type: integer format: int32 description: 账号状态,1-活动2-锁定 examples: - '1' userId: type: string description: 三维家用户ID examples: - '1100151410' username: type: string description: 三维家账号 examples: - 3vj123456 description: 分页记录 totalPage: type: integer format: int64 description: 总页数 examples: - '10' example: msg: '' code: 0 data: totalPage: 10 recordCount: 500 pageSize: 50 result: - nickName: 丽丽 sex: 男 mobile: '13800000000' outUserId: '123456789' employeeStatus: 1 userId: '1100151410' modifyTime: '2019-10-02 12:12:13' createTime: '2019-10-02 12:12:13' name: 丽丽 status: 1 username: 3vj123456 pageIndex: 2 success: false '401': description: access_token 缺失或已过期 / missing or expired access_token /api/v1/user/modifyUserStatus: post: operationId: apiV1UserModifyUserStatus summary: 修改用户状态接口 tags: - Accounts x-source-documentation: https://dev.3vjia.com/document?apiId=454662700002246694 x-documentation-category: 账号模块 / 账号管理 description: 修改用户的状态,锁定/解锁 requestBody: required: false content: application/json: schema: type: object properties: outUserId: type: string description: 企业账号绑定时使用的企业用户ID,userId、userName、outUserId至少传一个,outUserId优先级第三 examples: - '123456' status: type: integer format: int32 description: 员工状态0:已禁用,1:已启用 examples: - '1' userId: type: string description: 三维家用户ID,userId、userName、outUserId至少传一个,userId优先级最高 examples: - '1000122456' userName: type: string description: 三维家账号,userId、userName、outUserId至少传一个,userName优先级第二 examples: - 3vj123456 example: outUserId: '123456' userName: 3vj123456 userId: '1000122456' status: 1 responses: '200': description: 成功 / OK content: application/json: schema: type: object properties: success: type: boolean description: 请求是否成功 / whether the call succeeded code: type: integer description: 结果码 / result code (0 = success) msg: type: string description: 提示信息 / message data: type: object '401': description: access_token 缺失或已过期 / missing or expired access_token /api/v1/user/pageRoleByCondition: post: operationId: apiV1UserPageRoleByCondition summary: 查询企业类服务到期详情接口 tags: - Common Services x-source-documentation: https://dev.3vjia.com/document?apiId=852149073124429870 x-documentation-category: 通用服务 requestBody: required: true content: application/json: schema: type: object properties: beginExpiration: type: string format: date-time description: 开始过期时间 current: type: integer format: int64 description: 当前查询第几页 examples: - '1' default: '1' endExpiration: type: string format: date-time description: 结束过期时间 size: type: integer format: int64 description: 当前查询页记录数 examples: - '10' default: '10' required: - current - size example: beginExpiration: '' endExpiration: '' current: 1 size: 10 responses: '200': description: 成功 / OK content: application/json: schema: type: object properties: success: type: boolean description: 请求是否成功 / whether the call succeeded code: type: integer description: 结果码 / result code (0 = success) msg: type: string description: 提示信息 / message data: type: object properties: current: type: integer format: int64 description: 当前查询第几页 records: type: array items: type: object properties: mobile: type: string description: 联系方式 name: type: string description: 账号/对象(用户账号/门店id/租户id) roleExpirationRespList: type: array items: type: object properties: expiration: type: string format: date-time description: 角色到期时间 remainDay: type: integer format: int64 description: 剩余天数 roleId: type: string description: 角色ID roleName: type: string description: 角色名称 description: 角色到期时间返参 shopName: type: string description: 门店名称 tenantName: type: string description: 企业名称 description: 列表返参 size: type: integer format: int64 description: 当前查询页记录数 total: type: integer format: int64 description: 总数 required: - current - size - total example: msg: '' code: 0 data: records: - roleExpirationRespList: - roleId: '' remainDay: 0 roleName: '' expiration: '' mobile: '' shopName: '' tenantName: '' name: '' current: 0 total: 0 size: 0 success: false '401': description: access_token 缺失或已过期 / missing or expired access_token /api/v1/user/recoverBatch: post: operationId: apiV1UserRecoverBatch summary: 恢复账号接口 tags: - Accounts x-source-documentation: https://dev.3vjia.com/document?apiId=454661186751889441 x-documentation-category: 账号模块 / 账号管理 description: 批量恢复三维家用户,支持按三维家用户ID、三维家账号、企业用户ID进行恢复 requestBody: required: false content: application/json: schema: type: object properties: userIds: type: array items: {} description: 要恢复的用户的三维家用户ID列表,最多只能10个用户,userIds、userNames参数至少传1个,userIds优先级最高 examples: - '["1000123456","1000456789"]' userNames: type: array items: {} description: 要恢复的用户的三维家用户账号列表,最多只能10个用户,userIds、userNames参数至少传1个,userNames优先级第二 examples: - '["3vj123456","3vj456789"]' example: userIds: [] userNames: [] responses: '200': description: 成功 / OK content: application/json: schema: type: object properties: success: type: boolean description: 请求是否成功 / whether the call succeeded code: type: integer description: 结果码 / result code (0 = success) msg: type: string description: 提示信息 / message data: type: object example: msg: '' code: 0 data: '' success: false '401': description: access_token 缺失或已过期 / missing or expired access_token /api/v1/user/update: post: operationId: apiV1UserUpdate summary: 编辑账号接口 tags: - Accounts x-source-documentation: https://dev.3vjia.com/document?apiId=454661186751889443 x-documentation-category: 账号模块 / 账号管理 description: 修改三维家用户的基本信息,回收站内的账号无法修改 requestBody: required: false content: application/json: schema: type: object properties: deptId: type: string description: 账号所属三维家部门ID,关联部门传该字段 mobile: type: string description: 用户手机号码,若传此值,需要保证此值符合手机号码格式,且此手机号没有被任何一个企业注册过三维家 name: type: string description: 姓名 nickName: type: string description: 昵称,长度必须为2-20个字符 note: type: string description: 备注,不超过256个字符 outUserId: type: string description: 企业用户ID(绑定过对应三维家账号),userId、username、outUserId三个字段至少传1个,用于查找对应用户(不作为更新字段),优先级userId最高,username第二,outUserId最低 examples: - a123456 selfIntro: type: string description: 自我介绍,不能超过2000个字符 sex: type: string description: 性别,0=男,1=女 shopId: type: string description: 账号所属三维家门店ID,关联门店传该字段 userId: type: string description: 三维家用户ID,userId、userName、outUserId三个字段至少传1个,用于查找对应用户(不作为更新字段),优先级userId最高,username第二,outUserId最低 examples: - '123456' userName: type: string description: 三维家账号,userId、userName、outUserId三个字段至少传1个,用于查找对应用户(不作为更新字段),优先级userId最高,username第二,outUserId最低 examples: - 3vj123456 example: note: '' nickName: '' sex: '' deptId: '' mobile: '' outUserId: a123456 userName: 3vj123456 userId: '123456' name: '' shopId: '' selfIntro: '' responses: '200': description: 成功 / OK content: application/json: schema: type: object properties: success: type: boolean description: 请求是否成功 / whether the call succeeded code: type: integer description: 结果码 / result code (0 = success) msg: type: string description: 提示信息 / message data: type: object example: msg: '' code: 0 data: '' success: false '401': description: access_token 缺失或已过期 / missing or expired access_token /api/v1/userLimit/batchAllocateUserLimit: post: operationId: apiV1UserLimitBatchAllocateUserLimit summary: 批量分配额度 tags: - Asset Management x-source-documentation: https://dev.3vjia.com/document?apiId=875783510055624770 x-documentation-category: 资产管理 requestBody: required: true content: application/json: schema: type: object properties: salesTarget: type: integer format: int32 description: 资产属性(可售卖对象:1:个人,2:门店),分配给个人时,填1,分配给门店填2 shopIds: type: array items: {} description: 门店ids(分配给门店时,必填) source: type: string description: 操作来源 userIds: type: array items: {} description: 用户ids(分配给个人时,必填) userLimitId: type: string description: 额度ID required: - salesTarget - userLimitId example: salesTarget: 0 userLimitId: '' source: '' shopIds: [] userIds: [] responses: '200': description: 成功 / OK content: application/json: schema: type: object properties: success: type: boolean description: 请求是否成功 / whether the call succeeded code: type: integer description: 结果码 / result code (0 = success) msg: type: string description: 提示信息 / message data: type: object properties: failList: type: array items: {} description: 失败分配列表(salesTarget为1存的是userId,2存的是shopId) salesTarget: type: integer format: int32 description: 资产属性(可售卖对象:1:PERSONAL-个人,2:STORE-门店,3:ENTERPRISE-企业) successList: type: array items: {} description: 成功分配列表(salesTarget为1存的是userId,2存的是shopId) userLimitId: type: string description: 额度ID example: msg: '' code: 0 data: successList: [] salesTarget: 0 userLimitId: '' failList: [] success: false '401': description: access_token 缺失或已过期 / missing or expired access_token /api/v1/userLimit/pageBaseUserLimitByCondition: post: operationId: apiV1UserLimitPageBaseUserLimitByCondition summary: 分页查询未过期服务包 tags: - Asset Management x-source-documentation: https://dev.3vjia.com/document?apiId=875780238448148587 x-documentation-category: 资产管理 requestBody: required: true content: application/json: schema: type: object properties: current: type: integer format: int64 description: 当前查询第几页 default: '1' salesTarget: type: integer format: int32 description: 资产属性(可售卖对象:1:PERSONAL-个人,2:STORE-门店,3:ENTERPRISE-企业) serialNumber: type: string description: 订单编号 size: type: integer format: int64 description: 当前查询页记录数 default: '10' userLimitName: type: string description: 服务包名称 userLimitState: type: integer format: int32 description: 服务包状态(额度状态:0:UnAllocation-未分配,1:HasAllocation-已分配) required: - current - salesTarget - size example: serialNumber: '' salesTarget: 0 userLimitState: 0 current: 0 size: 0 userLimitName: '' responses: '200': description: 成功 / OK content: application/json: schema: type: object properties: success: type: boolean description: 请求是否成功 / whether the call succeeded code: type: integer description: 结果码 / result code (0 = success) msg: type: string description: 提示信息 / message data: type: object properties: current: type: integer format: int64 description: 当前查询第几页 records: type: array items: type: object properties: activateState: type: integer format: int32 description: 是否激活 0:未激活 1:已激活 canReallocate: type: boolean description: 是否允许重新分配 endTime: type: string description: 结束时间 firstReallocateTime: type: string description: 新规则首次分配或重新分配时间 hasOperation: type: integer format: int32 description: 是否有撤回/重新分配/分配操作,1是,0否 isDelete: type: boolean description: 是否刪除 limitValue: type: integer format: int32 description: 额度值 orderName: type: string description: 订单名称 orderOwnerId: type: string description: 订单归属ID(门店ID,企业ID) orderOwnerType: type: integer format: int32 description: 订单归属类型 0:门店 1:企业 ownerNickname: type: string description: 被分配人昵称 ownerUserId: type: string description: 被分配用户ID ownerUserName: type: string description: 被分配人对象 ownerUserTenantId: type: string description: 被分配用户租户ID reallocateDeadline: type: string description: 重新分配截止时间 relationId: type: string description: 商品ID,新商品为skuId,旧商品为套餐ID remainTime: type: integer format: int64 description: 剩余时长,单位-毫秒(剩余使用额度) salesTarget: type: integer format: int32 description: 资产属性(可售卖对象:1:PERSONAL-个人,2:STORE-门店,3:ENTERPRISE-企业) serialNumber: type: string description: 订单编号 skuTitle: type: string description: 商品名称,新商品为skuTitle,旧商品为订单名称 startTime: type: string description: 开始时间 userLimitId: type: string description: 额度ID userLimitName: type: string description: 服务包名称 userLimitState: type: integer format: int32 description: 服务包状态(额度状态:0:UnAllocation-未分配,1:HasAllocation-已分配) description: 基础额度信息返参 size: type: integer format: int64 description: 当前查询页记录数 total: type: integer format: int64 description: 总数 required: - current - size - total example: msg: '' code: 0 data: records: - limitValue: 0 skuTitle: '' serialNumber: '' isDelete: false salesTarget: 0 orderOwnerType: 0 relationId: '' remainTime: 0 userLimitId: '' ownerNickname: '' orderOwnerId: '' canReallocate: false userLimitState: 0 hasOperation: 0 activateState: 0 firstReallocateTime: '' ownerUserId: '' ownerUserName: '' ownerUserTenantId: '' startTime: '' endTime: '' reallocateDeadline: '' userLimitName: '' orderName: '' current: 0 total: 0 size: 0 success: false '401': description: access_token 缺失或已过期 / missing or expired access_token /api/v1/video/doubaoVideo: post: operationId: apiV1VideoDoubaoVideo summary: 创建视频生成任务 tags: - 3vjia AI x-source-documentation: https://dev.3vjia.com/document?apiId=832636727683354682 x-documentation-category: 三维家AI / 视频生成 requestBody: required: true content: application/json: schema: type: object properties: audioUrls: type: array items: {} description: 参考音频url列表,仅 seedance-2 / seedance-2-fast 支持。1. 该字段用于多模态参考生视频,提交后会按 reference_audio 发送给上游。2. 不可单独传入,至少需要配合 1 张参考图片或 1 个参考视频。3. 不可与首帧/首尾帧场景混用。格式:wav、mp3。单个音频时长:[2, 15] s,最多传入 3 段参考音频,所有音频总时长不超过 15 s。大小:单个音频不超过 15 MB,请求体大小不超过 64 MB。 camerafixed: type: boolean description: '是否固定摄像头, 为true时, 平台会在用户提示词中追加固定摄像头,实际效果不保证。有参考视频的时候不可支持固定摄像头。 默认值: false' durationSecs: type: integer format: int32 description: 视频时长,单位秒。当前接口透传给豆包视频生成接口,常用可选值 2~15 秒;不同模型的实际上限以下游模型能力为准。 executionExpiresAfter: type: integer format: int32 description: '执行过期时间,单位秒,仅当offline为true时生效。 默认值: 28800' fps: type: integer format: int32 description: 帧率, 默认值:24 generateAudio: type: boolean description: 是否生成有声视频,默认值:false。该参数表示是否让模型产出带音轨视频;与 audioUrls 作为参考音频输入不是同一个概念。 imageUrl: type: string description: '首图url。1. 文生视频场景可不传。2. 首帧生视频/首尾帧生视频场景下,表示首帧图片。3. 当reference=true,或同时传入videoUrls/audioUrls时,表示参考图之一。4. 多模态参考生视频、首帧生视频、首尾帧生视频是互斥场景,不可混用。支持格式: JPEG(JPG)、PNG、WEBP、BMP、TIFF、GIF;宽高比: (0.4,2.5);边长: [300,6000] px;大小: 小于30MB。' keyFrames: type: array items: {} description: '关键帧/参考图url列表。1. reference=false 且传入时,当前仅取第1张作为尾帧,用于首尾帧生视频。2. reference=true 时,全部作为参考图使用;配合imageUrl时,imageUrl也会作为参考图一并提交。3. seedance-2/seedance-2-fast 多模态参考生视频下,也可作为参考图输入,最多 9 张。4. 多模态参考生视频、首帧生视频、首尾帧生视频互斥,不可混用。支持格式: JPEG(JPG)、PNG、WEBP、BMP、TIFF、GIF;宽高比: (0.4,2.5);边长: [300,6000] px;大小: 小于30MB。' modelCode: type: string description: 模型,目前支持:v_d_t_1=seedance-lite-t2v;v_d_i_1=seedance-lite-i2v;v_d_1=seedance-pro;v_d_15=seedance-1.5-pro;v_d_2=seedance-2;v_d_2_fast=seedance-2-fast offline: type: boolean description: '是否离线模式, 当业务允许小时级别的延迟的话,建议使用离线模式, 价格打5折。 默认值: false' promptText: type: string description: 提示语,可选。中文不超 500 字,英文不超 1000 字。多张参考图场景建议使用“[图1]... [图2]...”方式描述,便于模型对齐具体参考素材。 ratio: type: string description: 视频比例,请传字符串枚举名称,可选值:DEFAULT=adaptive、R_21_9=21:9、R_16_9=16:9、R_4_3=4:3、R_1_1=1:1、R_3_4=3:4、R_9_16=9:16、R_9_21=9:21。 reference: type: boolean description: 是否使用参考图,默认值:false。1. false:imageUrl 视为首帧,keyFrames 第1张视为尾帧。2. true:imageUrl 与 keyFrames 全部按参考图处理。3. 当传入 videoUrls 或 audioUrls 时,会进入多模态参考生视频场景,此时图片也会按参考图处理。 resolution: type: string description: 视频分辨率,请传字符串枚举名称,可选值:P480=480p、P720=720p、P1080=1080p;默认值P720。 seed: type: integer format: int64 description: 随机种子 videoUrls: type: array items: {} description: 参考视频url列表,仅 seedance-2 / seedance-2-fast 支持。1. 该字段用于多模态参考生视频,提交后会按 reference_video 发送给上游。2. 可与参考图、提示词、参考音频组合使用。3. 不可与首帧/首尾帧场景混用。4. 最多传入 3 个参考视频,所有视频总时长不超过 15s。视频格式:mp4、mov。分辨率:480p、720p。单个视频时长:[2, 15] s。宽高比(宽/高):[0.4, 2.5]。宽高长度(px):[300, 6000]。总像素数:[409600, 927408]。大小:单个视频不超过 50 MB。帧率(FPS):[24, 60]。 required: - modelCode - ratio example: audioUrls: [] seed: 0 fps: 0 videoUrls: [] resolution: '' executionExpiresAfter: 0 generateAudio: false keyFrames: [] reference: false offline: false durationSecs: 0 camerafixed: false modelCode: '' imageUrl: '' promptText: '' ratio: '' responses: '200': description: 成功 / OK content: application/json: schema: type: object properties: success: type: boolean description: 请求是否成功 / whether the call succeeded code: type: integer description: 结果码 / result code (0 = success) msg: type: string description: 提示信息 / message data: type: object properties: failure: type: string description: 失败原因 failureCode: type: string description: 错误码 lastFrameUrl: type: string description: 最后一帧图片地址 msg: type: string description: 任务状态描述 progress: type: number format: float description: 进度, 当状态为RUNNING时有值, 取值范围[0, 1]之间 seed: type: integer format: int64 description: seed, 此次生成视频所用的Seed status: type: string description: 任务状态. -1:未知或者任务不存在, 1:排队中, 2:生成中, 3:生成成功, 4:生成失败, 5:已取消 taskId: type: string description: 任务ID videoUrl: type: string description: 视频地址 consumeQuantity: type: number format: bigdecimal description: 消耗创点数量 recordTransactionId: type: string description: 创点消费流水号 remainingPersonQuantity: type: number format: bigdecimal description: 个人剩余数量 remainingShopQuantity: type: number format: bigdecimal description: 门店剩余数量(共享情况下会返回) remainingTenantQuantity: type: number format: bigdecimal description: 租户剩余数量(共享情况下会返回) example: msg: '' code: 0 data: msg: '' failureCode: '' seed: 0 recordTransactionId: '' remainingShopQuantity: 0 consumeQuantity: 0 remainingTenantQuantity: 0 remainingPersonQuantity: 0 videoUrl: '' failure: '' progress: 0 taskId: '' lastFrameUrl: '' status: '' success: false '401': description: access_token 缺失或已过期 / missing or expired access_token /api/v1/video/getTaskStatus: post: operationId: apiV1VideoGetTaskStatus summary: 获取视频任务状态 tags: - 3vjia AI x-source-documentation: https://dev.3vjia.com/document?apiId=697518375739478144 x-documentation-category: 三维家AI / 视频生成 requestBody: required: true content: application/json: schema: type: object properties: taskId: type: string description: 任务ID required: - taskId example: taskId: '' responses: '200': description: 成功 / OK content: application/json: schema: type: object properties: success: type: boolean description: 请求是否成功 / whether the call succeeded code: type: integer description: 结果码 / result code (0 = success) msg: type: string description: 提示信息 / message data: type: object properties: failure: type: string description: 失败原因 failureCode: type: string description: 错误码 msg: type: string description: 任务状态描述 progress: type: number format: float description: 进度, 当状态为RUNNING时有值, 取值范围[0, 1]之间 status: type: string description: 任务状态. -1:未知或者任务不存在, 1:排队中, 2:生成中, 3:生成成功, 4:生成失败, 5:已取消 taskId: type: string description: 任务ID videoUrl: type: string description: 视频地址 example: msg: '' code: 0 data: msg: '' failureCode: '' videoUrl: '' failure: '' progress: 0 taskId: '' status: '' success: false '401': description: access_token 缺失或已过期 / missing or expired access_token /api/v1/vrlayout/checkingReBuildHouse: post: operationId: apiV1VrlayoutCheckingReBuildHouse summary: 户型图检测 tags: - 3D Show x-source-documentation: https://dev.3vjia.com/document?apiId=492394844031889453 x-documentation-category: 3D秀 description: 验证上传户型图->验证通过则生成2d户型图 requestBody: required: false content: application/json: schema: type: object properties: IndoorArea: type: number format: double description: 户型套内面积 b64_img: type: string description: 图片的二进制流base64格式 example: b64_img: '' responses: '200': description: 成功 / OK content: application/json: schema: type: object properties: success: type: boolean description: 请求是否成功 / whether the call succeeded code: type: integer description: 结果码 / result code (0 = success) msg: type: string description: 提示信息 / message data: type: object properties: key: type: object example: msg: '' code: 0 data: key: '' success: false '401': description: access_token 缺失或已过期 / missing or expired access_token /api/v1/vrlayout/createLayoutAndFinishDraw: post: operationId: apiV1VrlayoutCreateLayoutAndFinishDraw summary: 提交上传户型 tags: - 3D Show x-source-documentation: https://dev.3vjia.com/document?apiId=492400473068875805 x-documentation-category: 3D秀 description: 验证上传户型图->验证通过则生成2d户型图 requestBody: required: false content: application/json: schema: type: object properties: area: type: number format: double description: 建筑面积 buildingName: type: string description: 楼盘名称 city: type: string description: 市代码 correctImgPath: type: string description: 矫正后的户型图路径 isCorrect: type: boolean description: 是否矫正过1是0否 layoutImage: type: string description: 上传户型图oss路径 layoutXml: type: string description: AI户型XMLxmloss链接 province: type: string description: 省代码 roomNum: type: string description: x室x厅x厨x卫 towards: type: integer format: int32 description: 朝向(0东1南2西3北4东南5西南6东北7西北) useDeviceType: type: integer format: int32 description: '@seecom.swj.api.njvr.enums.UseDeviceType使用设备分类:1pc、2小程序' example: city: '' correctImgPath: '' towards: 0 buildingName: '' province: '' roomNum: '' layoutImage: '' useDeviceType: 0 layoutXml: '' isCorrect: false responses: '200': description: 成功 / OK content: application/json: schema: type: object properties: success: type: boolean description: 请求是否成功 / whether the call succeeded code: type: integer description: 结果码 / result code (0 = success) msg: type: string description: 提示信息 / message data: type: object example: msg: '' code: 0 data: false success: false '401': description: access_token 缺失或已过期 / missing or expired access_token /api/v1/vrlayout/getPlatformAndPersonalLayoutInfo: post: operationId: apiV1VrlayoutGetPlatformAndPersonalLayoutInfo summary: 选择我家户型接口 tags: - 3D Show x-source-documentation: https://dev.3vjia.com/document?apiId=502120622118256726 x-documentation-category: 3D秀 description: 选择我家户型接口(聚合平台+私有) requestBody: required: false content: application/json: schema: type: object properties: areaId: type: integer format: int32 description: 户型面积1:小于等于50平方,2:(50,70],3:(70,90],4:(90,140],5:大于140平方, buildingName: type: string description: 小区名(楼盘名称) city: type: string description: 城市code encryptTenantId: type: string description: 加密tenantId encryptUserId: type: string description: 加密userId layoutId: type: string description: 户型id layoutOrganType: type: integer format: int32 description: 户型分类(1平台、2企业(私有))不传则聚合检索 pageIndex: type: integer format: int32 description: 页码 pageSize: type: integer format: int32 description: 页容量 roomTypeId: type: integer format: int32 description: 户型类型列表,1:一居,2:二居,3:三居,4:四居,5:五居及以上的 searchAfter: type: array items: {} description: "This is List Type \n翻页参数:首次查询不需传该参数,进行翻页时把上一次查询结果返回的searchAfter传到该处" stateGroup: type: array items: {} description: "This is List Type \n入库状态" swjUser: type: string description: 三维家用户支持ID和账号 example: encryptUserId: '' city: '' pageSize: 0 swjUser: '' layoutId: '' roomTypeId: 0 buildingName: '' encryptTenantId: '' stateGroup: [] areaId: 0 pageIndex: 0 searchAfter: [] layoutOrganType: 0 responses: '200': description: 成功 / OK content: application/json: schema: type: object properties: success: type: boolean description: 请求是否成功 / whether the call succeeded code: type: integer description: 结果码 / result code (0 = success) msg: type: string description: 提示信息 / message data: type: object properties: recordCount: type: integer format: int32 result: type: array items: type: object properties: address: type: string description: 楼盘地址 aiImagePath: type: string area: type: number format: double description: 建筑面积 buildingId: type: integer format: int64 description: 楼盘id buildingName: type: string description: 楼盘名字,xxx楼盘 city: type: string description: 市代码 createDate: type: object description: 注册时间 createUser: type: string description: 创建人 district: type: string description: 区代码 grounding: type: integer format: int32 description: 是否上架,0:否,1:是 houseType: type: string description: 房型(例:3室2厅1厨1卫03020101) houseTypeZh: type: string description: 房型中文 innerWallJsonUrl: type: string description: 内墙json地址(缓存数据) isDelete: type: integer format: int32 description: 是否已删除(逻辑删除标记),0:未删除;1:已删除 layout2d: type: string description: 2D户型图2D截图没有则显示默认图 layoutGlbUrl: type: string description: 户型glbUrl layoutId: type: string description: 户型id layoutImage: type: string description: 户型图路径 layoutName: type: string description: 户型图名称 layoutOrganType: type: integer format: int32 description: 户型类型:1平台2私有 layoutXml: type: string description: 户型xml province: type: string description: 省代码 schemeId: type: string description: 3D方案id tenantId: type: string description: 租户id updateDate: type: object description: 注册时间 updateUser: type: string description: 更新人 description: This is List Type searchAfter: type: array items: {} description: "This is List Type \n翻页参数" example: msg: '' code: 0 data: recordCount: 0 result: - updateDate: '' city: '' aiImagePath: '' schemeId: '' layoutName: '' layout2d: '' province: '' layoutGlbUrl: '' layoutXml: '' createDate: '' address: '' isDelete: 0 houseType: '' updateUser: '' layoutId: '' buildingId: 0 houseTypeZh: '' buildingName: '' district: '' tenantId: '' createUser: '' layoutImage: '' grounding: 0 innerWallJsonUrl: '' layoutOrganType: 0 searchAfter: [] success: false '401': description: access_token 缺失或已过期 / missing or expired access_token /api/v1/web3D/updateOrderBaseInfo: post: operationId: apiV1Web3DUpdateOrderBaseInfo summary: 修改订单拆单状态和基地信息 tags: - Dedicated Services x-source-documentation: https://dev.3vjia.com/document?apiId=751107739698217063 x-documentation-category: 专属服务 / C00063204 description: 修改订单拆单状态和基地信息 requestBody: required: true content: application/json: schema: type: object properties: factoryCode: type: string description: 工厂基地 id: type: integer format: int64 description: 工厂单ID isAutomaticDisassemble: type: integer format: int32 description: 是否自动化拆单,1=是,0或无=否 required: - id example: factoryCode: '' isAutomaticDisassemble: 0 id: 0 responses: '200': description: 成功 / OK content: application/json: schema: type: object properties: success: type: boolean description: 请求是否成功 / whether the call succeeded code: type: integer description: 结果码 / result code (0 = success) msg: type: string description: 提示信息 / message data: type: object example: msg: '' code: 0 data: false success: false '401': description: access_token 缺失或已过期 / missing or expired access_token /api/v2/scheme/getSchemeListByPage: post: operationId: apiV2SchemeGetSchemeListByPage summary: 获取方案列表v2接口 tags: - Design Schemes x-source-documentation: https://dev.3vjia.com/document?apiId=665501438172098592 x-documentation-category: 方案模块 / 方案数据 description: 具备和【工作台】-【方案管理】-【方案列表】一致的查询能力,支持返回多层方案数据等。 requestBody: required: true content: application/json: schema: type: object properties: areaType: type: integer format: int32 description: 标签筛选:面积 beginCreateDate: type: string format: date description: 起始创建时间 examples: - '2024-01-10' current: type: integer format: int64 description: 当前查询第几页 examples: - '1' default: '1' customCategoryIds: type: array items: {} description: 自定义分类ID集合 designerUsername: type: string description: 设计师账号 endCreateDate: type: string format: date description: 结束创建时间 examples: - '2025-01-01' houseType: type: string description: 标签筛选:户型 likeCustomerName: type: string description: 客户名称 likeDesignerName: type: string description: 设计师姓名 likeSchemeName: type: string description: 方案名称 publishState: type: integer format: int32 description: 发布状态 roomType: type: string description: 标签筛选:空间 schemeId: type: string description: 方案编号 size: type: integer format: int64 description: 当前查询页记录数 examples: - '20' default: '20' sortType: type: string description: 排序方式:MODIFY_TIME_DESC 按更新时间倒序,MODIFY_TIME_ASC 按更新时间正序,CREATE_TIME_DESC 创建时间倒序,CREATE_TIME_ASC 按创建时间正序 examples: - CREATE_TIME_DESC default: CREATE_TIME_DESC sourceType: type: integer format: int32 description: 方案来源:1=企业,2=门店 styleType: type: string description: 标签筛选:风格 required: - current - size example: publishState: 0 designerUsername: '' endCreateDate: '2025-01-01' houseType: '' schemeId: '' beginCreateDate: '2024-01-10' styleType: '' current: 1 likeSchemeName: '' size: 20 sortType: CREATE_TIME_DESC sourceType: 0 areaType: 0 customCategoryIds: [] roomType: '' likeCustomerName: '' likeDesignerName: '' responses: '200': description: 成功 / OK content: application/json: schema: type: object properties: success: type: boolean description: 请求是否成功 / whether the call succeeded code: type: integer description: 结果码 / result code (0 = success) msg: type: string description: 提示信息 / message data: type: object properties: current: type: integer format: int64 description: 当前查询第几页 records: type: array items: type: object properties: createDate: type: string format: date-time description: 创建时间 designerName: type: string description: 设计师 imagePath: type: string description: 封面图,完整路径自行拼接:https://3vj-scheme.3vjia.com+字段值 examples: - https://3vj-scheme.3vjia.com/UpFile_Scheme/C01833639/20250102/50a2/50a2e390-6a2b-4fee-992d-a04f930654e3.jpg isMainScheme: type: integer format: int32 description: 是否主方案:多层中只有一个主方案。非多层的,方案本身为主方案 isNewArrival: type: integer format: int32 description: 是否是样板间方案 modifyDate: type: string format: date-time description: 更新时间 projectId: type: integer format: int64 description: 项目ID publishState: type: integer format: int32 description: 发布状态:0=未提交,1=待审核,2=审核通过(已发布) schemeId: type: string description: 方案编号 schemeName: type: string description: 方案名称 schemeType: type: integer format: int32 description: 方案类型:1=3D,2=自定义 sourceType: type: integer format: int32 description: 方案来源:1=企业,2=门店 storeyId: type: integer format: int64 description: 楼层ID user: type: string description: 使用者 userName: type: string description: 使用者账号 fullHouse2dPic: type: string description: 户型2D图全路径(带域名,新增用于兼容客户端直显) fullImagePath: type: string description: 方案图片全路径(带域名,新增用于兼容客户端直显) house2dPic: type: string description: 户型图2D description: 方案列表查询出参 size: type: integer format: int64 description: 当前查询页记录数 total: type: integer format: int64 description: 总数 required: - current - size - total example: msg: '' code: 0 data: records: - publishState: 0 modifyDate: '' schemeType: 0 isMainScheme: 0 fullImagePath: '' imagePath: https://3vj-scheme.3vjia.com/UpFile_Scheme/C01833639/20250102/50a2/50a2e390-6a2b-4fee-992d-a04f930654e3.jpg fullHouse2dPic: '' schemeName: '' storeyId: 0 schemeId: '' userName: '' designerName: '' sourceType: 0 house2dPic: '' isNewArrival: 0 projectId: 0 user: '' createDate: '' current: 0 total: 0 size: 0 success: false '401': description: access_token 缺失或已过期 / missing or expired access_token /api/vrrule/getAllMaterialSelectSort: post: operationId: apiVrruleGetAllMaterialSelectSort summary: 获取选择素材分类列表结构目录 tags: - Light Design x-source-documentation: https://dev.3vjia.com/document?apiId=843159135649435699 x-documentation-category: 轻设计 requestBody: required: false content: application/json: schema: type: object properties: organType: type: integer format: int32 description: 机构类型:1平台、2企业 categoryId: type: integer format: int32 description: 类别id groupType: type: integer format: int32 description: 素材组类型(只有首次获取目录时需要传递):1地板瓷砖、2涂料、3模型、4墙体瓷砖、6模型组合 tenantId: type: string example: groupType: 0 tenantId: '' organType: 0 categoryId: 0 responses: '200': description: 成功 / OK content: application/json: schema: type: object properties: success: type: boolean description: 请求是否成功 / whether the call succeeded code: type: integer description: 结果码 / result code (0 = success) msg: type: string description: 提示信息 / message data: type: object properties: categoryList: type: array items: type: object properties: categoryCode: type: string description: 类别代码 categoryId: type: integer format: int32 description: 素材分类id categoryName: type: string description: 类别名称 enterprise: type: string description: 企业名称 leftValue: type: integer format: int32 description: 左分值(>0表示有子集) module: type: string description: 所属模块 organId: type: string description: 企业Id parentId: type: integer format: int32 description: 父类编号 subList: type: array items: {} description: "This is List Type \n子集" description: "This is List Type \n分类" pageIndex: type: integer format: int32 returnList: type: array items: type: object properties: author: type: string description: 上传用户 brushStyleXmlUrl: type: string description: 风格刷对应XML数据URL categoryId: type: integer format: int32 description: 素材分类id categoryTags: type: string description: 素材的标签集合 color: type: string description: 素材颜色 contentUrl: type: string description: content路径 deptId: type: string description: 部门Id designMaterialTagIds: type: string description: 新素材标签id,多个用逗号隔开 glbUrl: type: string description: glburl height: type: number format: double description: 图片高 imagePath: type: string description: 图片路径 isDelete: type: integer format: int32 description: 是否删除 isFavorite: type: boolean description: 是否收藏 length: type: number format: double description: 图片长 matImg: type: array items: {} description: "This is List Type \n砖块贴图路径列表,matImg.length=seqWidth*seqHeight" matType: type: integer format: int32 description: Single=0,//普通纹理noSingleMix=1,//单砖混铺MPS_RandomPaveMultiSeq=2,//多砖连纹MultiMix=3,//多砖混铺MPS_MultiBrickPave
砖块贴图显示方式多转混铺:0MPS_MultiBrickPave随机混铺:1MPS_RandomPave matTypeStr: type: string description: 砖块贴图显示方式字符串多转混铺:0MPS_MultiBrickPave随机混铺:1MPS_RandomPave materialCategory: type: string description: 素材分类 materialId: type: string description: 素材Id materialName: type: string description: 素材名称 modelDepth: type: number format: double description: 模型深度 modelFlag: type: integer format: int32 description: 模型标志1成品模型,15组合,2贴图,14铺砖 organId: type: string description: 发布商家 picSize: type: string description: 素材图片的尺寸大小,例如:806A504 postTime: type: string description: 上传时间 productId: type: string description: 产品Id schemeType: type: string description: 方案种类cupboard:橱柜wardrobe:衣柜systemCabinet:系统柜 seqHeight: type: integer format: int32 description: 几列的连纹,不是连纹则为0 seqWidth: type: integer format: int32 description: 几行的连纹,不是连纹则为0 useArea: type: string description: 使用区域 width: type: number format: double description: 图片宽 xmlContentUrl: type: string description: xmlContent路径 description: "This is List Type \n素材集合" totalCount: type: integer format: int32 description: 总数 example: msg: '' code: 0 data: totalCount: 0 pageIndex: 0 categoryList: - subList: [] enterprise: '' leftValue: 0 module: '' categoryCode: '' categoryName: '' parentId: 0 organId: '' categoryId: 0 returnList: - color: '' schemeType: '' imagePath: '' matTypeStr: '' xmlContentUrl: '' matImg: [] categoryTags: '' useArea: '' postTime: '' modelFlag: 0 productId: '' author: '' isDelete: 0 brushStyleXmlUrl: '' deptId: '' picSize: '' designMaterialTagIds: '' materialId: '' seqWidth: 0 matType: 0 materialCategory: '' glbUrl: '' materialName: '' contentUrl: '' seqHeight: 0 organId: '' categoryId: 0 isFavorite: false success: false '401': description: access_token 缺失或已过期 / missing or expired access_token /api/vrrule/getDesignMaterials: post: operationId: apiVrruleGetDesignMaterials summary: 分页查询素材列表 tags: - Light Design x-source-documentation: https://dev.3vjia.com/document?apiId=843159135649435701 x-documentation-category: 轻设计 requestBody: required: false content: application/json: schema: type: object properties: categoryId: type: string description: 素材分类id groupType: type: integer format: int32 description: 素材组类型:1地板瓷砖、2墙体涂料、3模型、4墙体瓷砖、6模型组合 likeMaterialId: type: string description: 模糊查询-素材Id likeMaterialName: type: string description: 模糊查询-素材名称 materialId: type: string description: 素材Id materialIds: type: array items: {} description: "This is List Type \n素材ID列表" materialName: type: string description: 素材名称 orderBy: type: string description: 排序 organType: type: integer format: int32 description: 机构类型:1平台、2企业 pageIndex: type: integer format: int32 pageSize: type: integer format: int32 planId: type: string description: 方案id projectId: type: string description: 项目id subApp: type: string description: 大后台模块:系统柜SchemeType:systemCabinet衣柜SchemeType:wardrobe橱柜SchemeType:cupboard tenantId: type: string description: 定制企业租户ID example: groupType: 0 orderBy: '' pageSize: 0 materialId: '' likeMaterialId: '' materialName: '' likeMaterialName: '' pageIndex: 0 materialIds: [] tenantId: '' planId: '' subApp: '' organType: 0 projectId: '' categoryId: '' responses: '200': description: 成功 / OK content: application/json: schema: type: object properties: success: type: boolean description: 请求是否成功 / whether the call succeeded code: type: integer description: 结果码 / result code (0 = success) msg: type: string description: 提示信息 / message data: type: object properties: pageIndex: type: integer format: int32 pageSize: type: integer format: int32 recordCount: type: integer format: int32 result: type: array items: type: object properties: author: type: string description: 上传用户 brushStyleXmlUrl: type: string description: 风格刷对应XML数据URL categoryId: type: integer format: int32 description: 素材分类id categoryTags: type: string description: 素材的标签集合 color: type: string description: 素材颜色 contentUrl: type: string description: content路径 deptId: type: string description: 部门Id designMaterialTagIds: type: string description: 新素材标签id,多个用逗号隔开 glbUrl: type: string description: glburl height: type: number format: double description: 图片高 imagePath: type: string description: 图片路径 isDelete: type: integer format: int32 description: 是否删除 isFavorite: type: boolean description: 是否收藏 length: type: number format: double description: 图片长 matImg: type: array items: {} description: "This is List Type \n砖块贴图路径列表,matImg.length=seqWidth*seqHeight" matType: type: integer format: int32 description: Single=0,//普通纹理noSingleMix=1,//单砖混铺MPS_RandomPaveMultiSeq=2,//多砖连纹MultiMix=3,//多砖混铺MPS_MultiBrickPave
砖块贴图显示方式多转混铺:0MPS_MultiBrickPave随机混铺:1MPS_RandomPave matTypeStr: type: string description: 砖块贴图显示方式字符串多转混铺:0MPS_MultiBrickPave随机混铺:1MPS_RandomPave materialCategory: type: string description: 素材分类 materialId: type: string description: 素材Id materialName: type: string description: 素材名称 modelDepth: type: number format: double description: 模型深度 modelFlag: type: integer format: int32 description: 模型标志1成品模型,15组合,2贴图,14铺砖 organId: type: string description: 发布商家 picSize: type: string description: 素材图片的尺寸大小,例如:806A504 postTime: type: string description: 上传时间 productId: type: string description: 产品Id schemeType: type: string description: 方案种类cupboard:橱柜wardrobe:衣柜systemCabinet:系统柜 seqHeight: type: integer format: int32 description: 几列的连纹,不是连纹则为0 seqWidth: type: integer format: int32 description: 几行的连纹,不是连纹则为0 useArea: type: string description: 使用区域 width: type: number format: double description: 图片宽 xmlContentUrl: type: string description: xmlContent路径 description: This is List Type example: msg: '' code: 0 data: recordCount: 0 pageSize: 0 result: - color: '' schemeType: '' imagePath: '' matTypeStr: '' xmlContentUrl: '' matImg: [] categoryTags: '' useArea: '' postTime: '' modelFlag: 0 productId: '' author: '' isDelete: 0 brushStyleXmlUrl: '' deptId: '' picSize: '' designMaterialTagIds: '' materialId: '' seqWidth: 0 matType: 0 materialCategory: '' glbUrl: '' materialName: '' contentUrl: '' seqHeight: 0 organId: '' categoryId: 0 isFavorite: false pageIndex: 0 success: false '401': description: access_token 缺失或已过期 / missing or expired access_token /common/api/joinAuth/authorize: post: operationId: commonApiJoinAuthAuthorize summary: 获取授权登录授权码 tags: - Authorization x-source-documentation: https://dev.3vjia.com/document?apiId=454639980770304080 x-documentation-category: 登录授权 requestBody: required: true content: application/json: schema: type: object properties: enterpriseUserId: type: string description: 企业用户ID svjUserId: type: string description: 三维家用户ID,不指定默认为管理员账号 tokenExpiresIn: type: integer format: int32 description: Token过期时间(单位:秒) bizExtParams: type: string description: 业务扩展参数 required: - enterpriseUserId example: svjUserId: '' bizExtParams: '' enterpriseUserId: '' tokenExpiresIn: 0 responses: '200': description: 成功 / OK content: application/json: schema: type: object properties: success: type: boolean description: 请求是否成功 / whether the call succeeded code: type: integer description: 结果码 / result code (0 = success) msg: type: string description: 提示信息 / message data: type: object properties: code: type: string description: 临时授权code,十分钟内有效 tokenExpiresIn: type: integer format: int32 description: token过期时间(非code过期时间) example: msg: '' code: 0 data: code: '' tokenExpiresIn: 0 success: false '401': description: access_token 缺失或已过期 / missing or expired access_token /web/export_archive/list: post: operationId: webExportarchiveList summary: 列表查询导出存档 tags: - CAD x-source-documentation: https://dev.3vjia.com/document?apiId=821806566599704659 x-documentation-category: CAD模块 description: 列表查询导出存档 requestBody: required: false content: application/json: schema: type: object properties: archiveName: type: string description: 存档名称 fileType: type: string description: 文件类型 orderNumber: type: string description: 订单号 schemeId: type: string description: 方案id version: type: string description: 版本号 example: orderNumber: '' archiveName: '' schemeId: '' version: '' fileType: '' responses: '200': description: 成功 / OK content: application/json: schema: type: object properties: success: type: boolean description: 请求是否成功 / whether the call succeeded code: type: integer description: 结果码 / result code (0 = success) msg: type: string description: 提示信息 / message data: type: object properties: archiveId: type: string description: 存档id archiveName: type: string description: 存档名称 attachmentType: type: string description: 附件类型 created: type: integer format: int64 description: 创建时间 designId: type: string description: 方案id drawingNo: type: string description: 图纸编号 fileType: type: string description: 文件类型 level: type: integer format: int32 description: 层级 resources: type: array items: type: object properties: pageConfigIds: type: array items: {} description: 页面配置id列表 resourceId: type: string description: 资源id resourceName: type: string description: 资源名称 resourceUrl: type: string description: 资源url type: type: integer format: int32 description: 类型 description: 文件列表 example: msg: '' code: 0 data: - attachmentType: '' level: 0 archiveName: '' created: 0 resources: - resourceId: '' resourceName: '' type: 0 resourceUrl: '' pageConfigIds: [] archiveId: '' drawingNo: '' designId: '' fileType: '' success: false '401': description: access_token 缺失或已过期 / missing or expired access_token