# 订单2.0接口
# 新增订单
接口说明: 1、通过查询对象配置 (opens new window)接口,获得对象对应的fieldList --> 字段列表结构信息 2、详细字段入参规范说明参见 附录六:aPaaS字段类型样式说明 (opens new window) 3、部分预置字段的特殊逻辑,参考 fields特殊参数说明、slave_fields.ig_order_detail特殊参数说明
请求方式: POST(HTTPS)
**请求地址:
** https://openapi.qince.com/api/ig/v1/orderAdd/{ openid }/{ timestamp }/{ digest }/{ msg_id }
在线调试
请求示例:
参数说明:
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
fields | VARCHAR | 是 | JSON格式字符串。格式:{字段key:value}, (非特殊字段数据格式参见附录六) |
slave_fields | VARCHAR | 是 | JSON格式字符串。数据中传入id为编辑,无id为新增, 格式:{对象key:[{字段key:字段值}]}(非特殊字段数据格式参见附录六) |
is_trigger | boolean | 否 | 是否触发工作流;true:触发,false:不触发 |
trigger_employee | VARCHAR(32) | 否 | 是否触发工作流为true的时候必填,员工id |
check_rule | boolean | 否 | 是否校验验证规则和查重规则;true:校验,false:不校验 |
fields特殊参数说明:
字段名称 | 字段key | 字段类型 | 必填 | 特殊说明 |
---|---|---|---|---|
收货人姓名 | receipt_name | 单行文本 | 否 | 不需要传入,根据收货信息赋值 |
收货人手机 | receipt_phone | 手机 | 否 | 不需要传入,根据收货信息赋值 |
收货人固定电话 | receipt_landline | 单行文本 | 否 | 不需要传入,根据收货信息赋值 |
收货地址 | receipt_address | 地区 | 否 | 不需要传入,根据收货信息赋值 |
订单总额 | order_total_amount | 统计字段 | 否 | openAPI不需要,根据公式计算, 计算公式:订单总额 = SUM(关联明细行实际售价金额) * 整单折扣 |
币种 | currency_type | 单选框 | 否 | 未开启多币种时,不需要传,无论币种字段传入什么值均不接收; 开启多币种后,币种字段不传默认为本位币,传值取传入的值; |
slave_fields.ig_order_detail特殊参数说明:
字段名称 | 字段key | 字段类型 | 必填 | 特殊说明 |
---|---|---|---|---|
商品名称 | pd_id | 关联关系 | 是 | 对接时,如果对应的商品组合是标准BOM, 按父商品信息和商品组合信息,自动补齐商品组合明细对应子商品对应的订单明细行 如果对应的商品组合是配置BOM,则报错提示“不支持配置BOM的对接,请通过页面进行新建。” |
价目表 | slave_pd_price | 关联关系 | 否 | 不需要传入,按标准价目表获取 |
价目表明细编码 | price_detail | 关联关系 | 否 | 不需要传入,根据价目表、商品、单位、数量获取价格, 如果对应单位未找到明细则报错 |
商品组合编号 | pd_portfolio | 关联关系 | 否 | 不要求必填,但如果“启用CPQ”且商品是商品组合父商品,则要求必填 |
商品组合明细编号 | pd_portfolio_detail | 关联关系 | 否 | 不需要传入 |
报价单 | slave_quotation_id | 关联关系 | 否 | 不需要传入 |
报价单明细编号 | quotation_detail_id | 关联关系 | 否 | 不需要传入 |
合同编号 | slave_contract_id | 关联关系 | 否 | 不需要传入 |
合同明细编号 | contract_detail_id | 关联关系 | 否 | 不需要传入 |
原价 | pd_origin_price | 金额 | 否 | 不需要传入,根据价目表、商品、单位、数量获取价格,并转换为头上的币种 |
建议售价 | suggested_selling_price | 金额 | 否 | 不需要传入 ,根据价目表、商品、单位、数量获取价格,并转换为头上的币种 |
实际售价 | actual_price | 金额 | 是 | 必填 |
系统折扣 | sys_discount | 金额 | 否 | 不需要传入,根据计算获取 |
额外折扣 | additional_discount | 金额 | 否 | 不需要传入,根据计算获取 |
原价金额 | pd_origin_amount | 金额 | 否 | 不需要传入,根据计算获取 |
建议售价金额 | suggested_selling_amount | 金额 | 否 | 不需要传入,根据计算获取 |
实际售价金额 | actual_selling_amount | 金额 | 否 | 不需要传入,根据计算获取 |
优惠后金额 | amount_after_the_offer | 金额 | 否 | 不需要传入,固化逻辑为优惠后金额 = 实际售价金额 |
商品组合明细唯一标识 | node_id | 单行文本 | 否 | 不需要传入 |
商品组合明细父节点 | parent_node_id | 单行文本 | 否 | 不需要传入 |
根节点id | root_node_id | 单行文本 | 否 | 不需要传入 |
商品组合明细配置 | tree_data | 单行文本 | 否 | 不需要传入 |
响应示例:
{
"msg_id": "X000001",
"return_code": 0,
"return_msg": "",
"response_data": "6066483328179541690"
}
异常示例:
{
"msg_id": "X000001",
"return_code": 1,
"return_msg": "保存失败!"
}
参数说明:
参数 | 类型 | 说明 |
---|---|---|
msg_id | String | 请求消息ID |
return_code | int | 响应编码。0:成功,1:失败。其他详见附录错误码说明 (opens new window) |
return_msg | String | 响应说明 |
return_data | String |
# 修改订单
接口说明: 1、通过查询对象配置 (opens new window)接口,获得对象对应的fieldList --> 字段列表结构信息 2、详细字段入参规范说明参见 附录六:aPaaS字段类型样式说明 (opens new window) 3、订单头修改只支持自定义字段和部分预置字段 4、订单行针对已有的订单行,可以修改自定义字段,暂不支持修改预置字段 5、订单行支持新增订单行,新增订单行的逻辑同新增订单
请求方式: POST(HTTPS)
**请求地址:
** https://openapi.qince.com/api/ig/v1/orderEdit/{ openid }/{ timestamp }/{ digest }/{ msg_id }
在线调试
请求示例:
参数说明:
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
data_id | VARCHAR | 是 | 数据id |
fields | VARCHAR | 是 | JSON格式字符串。格式:{字段key:value}, (非特殊字段数据格式参见附录六) |
slave_fields | VARCHAR | 是 | JSON格式字符串。数据中传入id为编辑,无id为新增, 格式:{对象key:[{字段key:字段值}]}(非特殊字段数据格式参见附录六) |
is_trigger | boolean | 否 | 是否触发工作流;true:触发,false:不触发 |
trigger_employee | VARCHAR(32) | 否 | 是否触发工作流为true的时候必填,员工id |
check_rule | boolean | 否 | 是否校验验证规则和查重规则;true:校验,false:不校验 |
fields特殊参数说明: 其余预置字段都不支持修改
字段名称 | 字段key | 字段类型 | 必填 | 特殊说明 |
---|---|---|---|---|
下单日期 | order_date | 日期 | 否 | 支持修改 |
收货信息 | receipt_info | 关联关系 | 否 | 支持修改 |
收货人姓名 | receipt_name | 单行文本 | 否 | 不需要传入,根据收货信息赋值 |
收货人手机 | receipt_phone | 手机 | 否 | 不需要传入,根据收货信息赋值 |
收货人固定电话 | receipt_landline | 单行文本 | 否 | 不需要传入,根据收货信息赋值 |
整单折扣 | whole_order_discount | 百分比 | 否 | 支持修改,修改后重新计算订单总额 |
订单总额 | order_total_amount | 统计字段 | 否 | openAPI不需要,根据公式计算, 计算公式:订单总额 = SUM(关联明细行实际售价金额) * 整单折扣 |
slave_fields.ig_order_detail特殊参数说明:
字段名称 | 字段key | 字段类型 | 必填 | 特殊说明 |
---|---|---|---|---|
商品名称 | pd_id | 关联关系 | 是 | 对接时,如果对应的商品组合是标准BOM, 按父商品信息和商品组合信息,自动补齐商品组合明细对应子商品对应的订单明细行 如果对应的商品组合是配置BOM,则报错提示“不支持配置BOM的对接,请通过页面进行新建。” |
价目表 | slave_pd_price | 关联关系 | 否 | 不需要传入,按标准价目表获取 |
价目表明细编码 | price_detail | 关联关系 | 否 | 不需要传入,根据价目表、商品、单位、数量获取价格, 如果对应单位未找到明细则报错 |
商品组合编号 | pd_portfolio | 关联关系 | 否 | 不要求必填,但如果“启用CPQ”且商品是商品组合父商品,则要求必填 |
商品组合明细编号 | pd_portfolio_detail | 关联关系 | 否 | 不需要传入 |
报价单 | slave_quotation_id | 关联关系 | 否 | 不需要传入 |
报价单明细编号 | quotation_detail_id | 关联关系 | 否 | 不需要传入 |
合同编号 | slave_contract_id | 关联关系 | 否 | 不需要传入 |
合同明细编号 | contract_detail_id | 关联关系 | 否 | 不需要传入 |
原价 | pd_origin_price | 金额 | 否 | 不需要传入,根据价目表、商品、单位、数量获取价格,并转换为头上的币种 |
建议售价 | suggested_selling_price | 金额 | 否 | 不需要传入 ,根据价目表、商品、单位、数量获取价格,并转换为头上的币种 |
实际售价 | actual_price | 金额 | 是 | 必填 |
系统折扣 | sys_discount | 金额 | 否 | 不需要传入,根据计算获取 |
额外折扣 | additional_discount | 金额 | 否 | 不需要传入,根据计算获取 |
原价金额 | pd_origin_amount | 金额 | 否 | 不需要传入,根据计算获取 |
建议售价金额 | suggested_selling_amount | 金额 | 否 | 不需要传入,根据计算获取 |
实际售价金额 | actual_selling_amount | 金额 | 否 | 不需要传入,根据计算获取 |
优惠后金额 | amount_after_the_offer | 金额 | 否 | 不需要传入,固化逻辑为优惠后金额 = 实际售价金额 |
商品组合明细唯一标识 | node_id | 单行文本 | 否 | 不需要传入 |
商品组合明细父节点 | parent_node_id | 单行文本 | 否 | 不需要传入 |
根节点id | root_node_id | 单行文本 | 否 | 不需要传入 |
商品组合明细配置 | tree_data | 单行文本 | 否 | 不需要传入 |
响应示例:
{
"msg_id": "X000001",
"return_code": 0,
"return_msg": ""
}
异常示例:
{
"msg_id": "X000001",
"return_code": 1,
"return_msg": "保存失败!"
}
参数说明:
参数 | 类型 | 说明 |
---|---|---|
msg_id | String | 请求消息ID |
return_code | int | 响应编码。0:成功,1:失败。其他详见附录错误码说明 (opens new window) |
return_msg | String | 响应说明 |
# 查询订单
接口说明 1、通过查询对象配置 (opens new window)接口,获得对象对应的fieldList --> 字段列表结构信息 2、请求入参操作符,详见附录操作符说明 (opens new window) 3、字段出参规范说明参见 附录六:aPaaS字段类型样式说明 (opens new window)
请求方式: POST(HTTPS)
**请求地址:
** https://openapi.qince.com/api/ig/v1/orderQuery/{ openid }/{ timestamp }/{ digest }/{ msg_id }
在线调试
请求示例:
参数说明:
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
page | INT | 是 | 页数,默认值为1 |
rows | INT | 是 | 条数,默认值为100 |
sorts | List | 是 | 排序,默认按创建时间倒序排序 |
sorts.field_key | VARCHAR(30) | 是 | 排序字段 |
sorts.type | VARCHAR(4) | 是 | 排序类型:asc 正序,desc 倒序 |
query_group | List | 是 | 查询条件列表 |
query_group.connector | List | 是 | 组内查询条件,条件AND或OR |
query_group.filters | VARCHAR(4) | 是 | 组内查询条件 |
query_group.filters.field_key | VARCHAR(32) | 是 | 字段key |
query_group.filters.operator | VARCHAR(10) | 是 | 操作符,详见附录操作符说明 (opens new window) |
query_group.filters.field_values | List | 是 | 字段值集合 |
响应示例:
{
"msg_id": "X000001",
"return_code": 0,
"return_msg": "",
"response_data": "<<DATA>>"
}
数据DATA示例:
[
{
"field_QxaDA__c": {
"format": "YYYY-MM-DD",
"value": "2025-03-13"
},
"field_T08db__c": "222",
"field_TtFXb__c": "222",
"field_dWPHL__c": [
{
"code": "91CIFbjO",
"label": "选项1",
"status": "1"
}
],
"id": "9222626961451321265",
"field_pOceu__c": "1",
"lock_status": {
"code": "UNLOCK",
"label": "未锁定"
},
"field_whz1e__c": "222",
"create_time": {
"format": "YYYY-MM-DD HH:mm:ss",
"value": "2025-03-13 15:23:46"
},
"approval_status": {
"code": "APPROVED",
"label": "已通过"
},
"source_type": {
"code": "LROPFXCJ",
"label": "自建"
},
"field_3kgN5__c": {
"code": "nPFlJR4S",
"label": "选项1"
},
"name": "0313cs02",
"creator_id": {
"name": "x1",
"id": "6611719441804418541",
"status": "1"
},
"field_GOITb__c": {
"format": "YYYY-MM-DD",
"value": "2025-03-13"
},
"field_8JouQ__c": {
"code": "true",
"label": "是"
},
"status": {
"code": "NORMAL",
"label": "正常"
},
"modify_time": {
"format": "YYYY-MM-DD HH:mm:ss",
"value": "2025-03-13 15:23:46"
},
"field_Dxf38__c": "1.00",
"field_Y4dFC__c": "00005",
"business_type": {
"code": "busitype_default__c",
"id": "8438431948543484993"
},
"modifyier_id": {
"name": "x1",
"id": "6611719441804418541",
"status": "1"
},
"department": {
"name": "IP16",
"id": "10",
"status": "1"
},
"owner": {
"name": "x1",
"id": "6611719441804418541",
"status": "1"
},
"field_MhfYa__c": {
"format": "YYYY-MM-DD HH:mm",
"value": "2025-03-13 15:23"
},
"field_ujceN__c": "222"
}
]
异常示例:
{
"msg_id": "X000001",
"return_code": 1,
"return_msg": "查询失败!"
}
# 查询订单明细
接口说明 1、通过查询对象配置 (opens new window)接口,获得对象对应的fieldList --> 字段列表结构信息 2、请求入参操作符,详见附录操作符说明 (opens new window) 3、字段出参规范说明参见 附录六:aPaaS字段类型样式说明 (opens new window)
请求方式: POST(HTTPS)
**请求地址:
** https://openapi.qince.com/api/ig/v1/orderDetailQuery/{ openid }/{ timestamp }/{ digest }/{ msg_id }
在线调试
请求示例:
参数说明:
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
page | INT | 是 | 页数,默认值为1 |
rows | INT | 是 | 条数,默认值为100 |
sorts | List | 是 | 排序,默认按创建时间倒序排序 |
sorts.field_key | VARCHAR(30) | 是 | 排序字段 |
sorts.type | VARCHAR(4) | 是 | 排序类型:asc 正序,desc 倒序 |
query_group | List | 是 | 查询条件列表 |
query_group.connector | List | 是 | 组内查询条件,条件AND或OR |
query_group.filters | VARCHAR(4) | 是 | 组内查询条件 |
query_group.filters.field_key | VARCHAR(32) | 是 | 字段key |
query_group.filters.operator | VARCHAR(10) | 是 | 操作符,详见附录操作符说明 (opens new window) |
query_group.filters.field_values | List | 是 | 字段值集合 |
响应示例:
{
"msg_id": "X000001",
"return_code": 0,
"return_msg": "",
"response_data": "<<DATA>>"
}
数据DATA示例:
[
{
"field_QxaDA__c": {
"format": "YYYY-MM-DD",
"value": "2025-03-13"
},
"field_T08db__c": "222",
"field_TtFXb__c": "222",
"field_dWPHL__c": [
{
"code": "91CIFbjO",
"label": "选项1",
"status": "1"
}
],
"id": "9222626961451321265",
"field_pOceu__c": "1",
"lock_status": {
"code": "UNLOCK",
"label": "未锁定"
},
"field_whz1e__c": "222",
"create_time": {
"format": "YYYY-MM-DD HH:mm:ss",
"value": "2025-03-13 15:23:46"
},
"approval_status": {
"code": "APPROVED",
"label": "已通过"
},
"source_type": {
"code": "LROPFXCJ",
"label": "自建"
},
"field_3kgN5__c": {
"code": "nPFlJR4S",
"label": "选项1"
},
"name": "0313cs02",
"creator_id": {
"name": "x1",
"id": "6611719441804418541",
"status": "1"
},
"field_GOITb__c": {
"format": "YYYY-MM-DD",
"value": "2025-03-13"
},
"field_8JouQ__c": {
"code": "true",
"label": "是"
},
"status": {
"code": "NORMAL",
"label": "正常"
},
"modify_time": {
"format": "YYYY-MM-DD HH:mm:ss",
"value": "2025-03-13 15:23:46"
},
"field_Dxf38__c": "1.00",
"field_Y4dFC__c": "00005",
"business_type": {
"code": "busitype_default__c",
"id": "8438431948543484993"
},
"modifyier_id": {
"name": "x1",
"id": "6611719441804418541",
"status": "1"
},
"department": {
"name": "IP16",
"id": "10",
"status": "1"
},
"owner": {
"name": "x1",
"id": "6611719441804418541",
"status": "1"
},
"field_MhfYa__c": {
"format": "YYYY-MM-DD HH:mm",
"value": "2025-03-13 15:23"
},
"field_ujceN__c": "222"
}
]
异常示例:
{
"msg_id": "X000001",
"return_code": 1,
"return_msg": "查询失败!"
}
# 推送订单
推送说明:参见 推送aPaaS对象数据变更 (opens new window)
请求示例:
{
"appId": 200004,
"data": {
"objectKey": "ig_order",
"whole_order_discount": "1.0000",
"slaveObjectMap": {
"ig_order_detail": [
{
"modify_time": {
"format": "YYYY-MM-DD HH:mm:ss",
"value": "2025-07-04 08:51:09"
},
"additional_discount": "1.0000",
"suggested_selling_price": "2.00",
"pd_origin_amount": "20000.00",
"pd_origin_price": "2.00",
"price_detail": {
"name": "JMMX2025050701539",
"id": "8136834649761603489",
"status": "1"
},
"slave_pd_price": {
"name": "标准价目表",
"id": "7086934903373518037",
"status": "1"
},
"business_type": {
"code": "busitype_default__c",
"id": "5544409283238908775",
"label": "默认业务类型",
"status": "1"
},
"modifyier_id": {
"name": "hts",
"id": "7007385368014262146",
"status": "1"
},
"id": "9124828070269921938",
"department": {
"name": "CPG",
"id": "10",
"status": "1"
},
"unit_id": {
"name": "1",
"id": "5722517964131842984",
"status": "1"
},
"pd_id": {
"name": "摩托罗拉",
"id": "8693321379452492472",
"status": "1"
},
"owner": {
"name": "hts",
"id": "7007385368014262146",
"status": "1"
},
"sys_discount": "1.0000",
"lock_status": {
"code": "UNLOCK",
"label": "未锁定"
},
"create_time": {
"format": "YYYY-MM-DD HH:mm:ss",
"value": "2025-06-27 09:20:07"
},
"actual_price": "2.00",
"approval_status": {
"code": "APPROVED",
"label": "已通过"
},
"suggested_selling_amount": "20000.00",
"source_type": {
"code": "LROPFXCJ",
"label": "自建"
},
"amount_after_the_offer": "20000.00",
"actual_selling_amount": "20000.00",
"pd_count": "10000.00",
"creator_id": {
"name": "hts",
"id": "7007385368014262146",
"status": "1"
},
"name": "DDMX2025062700106",
"order_id": {
"name": "DD2025062700048",
"id": "5526644337503710206"
},
"status": {
"code": "NORMAL",
"label": "正常"
}
},
{
"modify_time": {
"format": "YYYY-MM-DD HH:mm:ss",
"value": "2025-07-04 08:51:09"
},
"additional_discount": "1.0000",
"suggested_selling_price": "1000.00",
"pd_origin_amount": "20000000.00",
"pd_origin_price": "1000.00",
"price_detail": {
"name": "JMMX2025050701540",
"id": "4787656614939975668",
"status": "1"
},
"slave_pd_price": {
"name": "标准价目表",
"id": "7086934903373518037",
"status": "1"
},
"business_type": {
"code": "busitype_default__c",
"id": "5544409283238908775",
"label": "默认业务类型",
"status": "1"
},
"modifyier_id": {
"name": "hts",
"id": "7007385368014262146",
"status": "1"
},
"id": "4869361662077781365",
"department": {
"name": "CPG",
"id": "10",
"status": "1"
},
"unit_id": {
"name": "aadw",
"id": "8369588441145923742",
"status": "1"
},
"pd_id": {
"name": "诺基亚",
"id": "7041673499078735037",
"status": "1"
},
"owner": {
"name": "hts",
"id": "7007385368014262146",
"status": "1"
},
"sys_discount": "1.0000",
"lock_status": {
"code": "UNLOCK",
"label": "未锁定"
},
"create_time": {
"format": "YYYY-MM-DD HH:mm:ss",
"value": "2025-06-27 09:20:07"
},
"actual_price": "1000.00",
"approval_status": {
"code": "APPROVED",
"label": "已通过"
},
"suggested_selling_amount": "20000000.00",
"source_type": {
"code": "LROPFXCJ",
"label": "自建"
},
"amount_after_the_offer": "20000000.00",
"actual_selling_amount": "20000000.00",
"pd_count": "20000.00",
"creator_id": {
"name": "hts",
"id": "7007385368014262146",
"status": "1"
},
"name": "DDMX2025062700107",
"order_id": {
"name": "DD2025062700048",
"id": "5526644337503710206"
},
"status": {
"code": "NORMAL",
"label": "正常"
}
}
]
},
"modify_time": {
"format": "YYYY-MM-DD HH:mm:ss",
"value": "2025-07-04 08:51:09"
},
"business_type": {
"code": "busitype_default__c",
"id": "6427868406516526784",
"label": "默认业务类型",
"status": "1"
},
"modifyier_id": {
"name": "hts",
"id": "7007385368014262146",
"status": "1"
},
"id": "5526644337503710206",
"department": {
"name": "CPG",
"id": "10",
"status": "1"
},
"order_total_amount": "2000.00",
"actual_selling_total_amount": "20020000.00",
"owner": {
"name": "hts",
"id": "7007385368014262146",
"status": "1"
},
"receipt_address": {},
"lock_status": {
"code": "UNLOCK",
"label": "未锁定"
},
"create_time": {
"format": "YYYY-MM-DD HH:mm:ss",
"value": "2025-06-27 09:20:06"
},
"approval_status": {
"code": "APPROVED",
"label": "已通过"
},
"source_type": {
"code": "LROPFXCJ",
"label": "自建"
},
"order_date": {
"format": "YYYY-MM-DD",
"value": "2025-06-27"
},
"creator_id": {
"name": "hts",
"id": "7007385368014262146",
"status": "1"
},
"name": "DD2025062700048",
"status": {
"code": "NORMAL",
"label": "正常"
},
"customer": {
"objectKey": "bas_cm_customer",
"name": "测试客户",
"objectName": "客户",
"id": "6928823652322085688",
"status": "1"
}
},
"dataFormat": "json",
"dataId": "5526644337503710206",
"dataSource": "biz",
"dataType": "apaas_data_change_event",
"tenantId": 7867203268463838962,
"version": "v1"
}