# 订单接口

# 新增订单

接口说明:

请求方式: POST(HTTPS
**请求地址: ** https://openapi.qince.com/api/ig/v2/orderAdd/{ openid }/{ timestamp }/{ digest }/{ msg_id } 在线调试
请求示例:

{
  "customerCode": "CUS001", //客户(必填) 或者 "customerId": 6928823652322085688
  "orderDate": "2025-06-12", //下单日期
  "receiptInfoName": "张三",// 收货信息,会关联客户过滤 或者 "receiptInfoId": 5420850610602186677
  "quotationCode": "QUO001",// 报价单 或者 "quotationId": 5420850610602186677
  "contractCode": "CON001",// 合同 或者 "contractId": 5420850610602186677
  "opportunitiesInfoCode": "OPP001",// 商机 或者 "opportunitiesInfoId": 5420850610602186677
  "wholeOrderDiscount": 0.8,// 整单折扣 不传默认为 `1`(100%);如果实际售价合计金额为0,则强制记为100%
  "orderTotalAmount": 100, // 订单总额 如果实际售价合计金额不为0,则计算订单总额=实际售价合计金额*整单折扣;如果实际售价合计金额为0,则订单总额按录入记录
  //订单明细(必填)
  "detailList": [
    {
      "pdCode": "P001", //商品(必填)若是bom详见说明 或者 "pdId": 5279580533528147536 或者 "pdSourceCode": "PS001"
      // "unitName": "包", //单位 未开启多单位定价时只读,启用多单位定价时必填 或者 "unitId": 8605307914170421101
      "pdCount": 2, //商品数量(必填)
      "actualPrice": 20, //实际售价(必填)
      "extFields": {
        "custom_field_1": "订单行自定义值1",
        "custom_field_2": 100
      }
    }
  ],
  "extFields": {
    "custom_order_field_1": "订单头自定义值1",
    "custom_order_field_2": "2025-06-15"
  },
  "extSlaveList": {
    "ext_slave_obj1": [
      {
        "slave_obj1_field_1": "订单自定义从对象值1",
        "slave_obj1_field_2": "2025-06-15"
      }
    ]
  }
}
说明: 本示例仅供参考,具体以参数说明为准。

参数说明:

字段 名称 类型 必填 说明
isTrigger 触发工作流 Boolean 是否触发工作流,默认 false
triggerEmployee 触发员工 Long 触发员工 ID。
isTrigger=true 时必填
checkRule 校验规则 Boolean 是否校验验证规则,默认 false
customerId 客户ID Long 客户 ID。
customerCode 至少传入一个,优先使用 customerId
customerCode 客户编号 String 客户编号。
customerId 至少传入一个
orderDate 下单日期 String 格式:yyyy-MM-dd,如 2025-06-12
receiptInfoId 收货信息ID Long 收货信息 ID,会关联客户过滤。
receiptInfoName 二选一,优先使用 receiptInfoId
receiptInfoName 收货人姓名 String 收货人姓名,会关联客户过滤。
传入后系统会自动补齐收货人、手机、固话、地址
quotationId 报价单ID Long 报价单 ID。
quotationCode 二选一,优先使用 quotationId
quotationCode 报价单编号 String 报价单编号
contractId 合同ID Long 销售合同 ID。
contractCode 二选一,优先使用 contractId
contractCode 合同编号 String 销售合同编号
opportunitiesInfoId 商机ID Long 商机 ID。
opportunitiesInfoCode 二选一,优先使用 opportunitiesInfoId
opportunitiesInfoCode 商机编号 String 商机编号
wholeOrderDiscount 整单折扣 BigDecimal 百分比格式,如 0.8 表示 80%。
不传默认为 1(100%)
如果实际售价合计金额为0,则强制记为100%
orderTotalAmount 订单总额 BigDecimal 如果实际售价合计金额不为0,
则计算订单总额=实际售价合计金额*整单折扣;
如果实际售价合计金额为0,则订单总额按录入记录
currencyType 币种 String 不开启币种管理只读,币种代码,如 CNY。不传则使用本位币
extFields 自定义字段 Map 主对象自定义字段,格式:{"fieldKey": "fieldValue"}
extSlaveList 自定义从对象 Map 自定义从对象数据,格式:{"ObjectKey": [{ {"fieldKey": "fieldValue"} }]}
pd_price 价目表 Long 只读 系统管理,openApi仅支持标准价目表
receipt_name 收货人姓名 String 只读 根据收货信息自动补齐
receipt_phone 收货人手机 String 只读 根据收货信息自动补齐
receipt_landline 收货人固话 String 只读 根据收货信息自动补齐
receipt_address 收货地址 String 只读 根据收货信息自动补齐
delivery_status 订单发货状态 String 只读 系统管理
cm_useful_amount 客户可用额度 BigDecimal 只读 系统管理
delivered_amount_total 已发货金额 BigDecimal 只读 根据关联发货单自动统计
pending_delivery_amount_total 待发货金额 BigDecimal 只读 根据关联发货单自动统计
payment_received_amount_total 已回款金额 BigDecimal 只读 根据关联收款单自动统计
confirm_receipt_amount_total 确认收货金额 BigDecimal 只读 根据关联发货单自动统计
detailList 明细列表 List 订单明细列表,至少包含一条明细
detailList.pdId 商品ID Long 商品 ID。
pdCodepdSourceCode 至少传入一个,优先使用 pdIdpdCode
对接时,如果对应的商品组合是标准BOM,
按父商品信息和商品组合信息,自动补齐商品组合明细对应子商品对应的订单明细行
如果对应的商品组合是配置BOM,则报错提示“不支持配置BOM的对接,请通过页面进行新建。”
detailList.pdCode 商品编码 String 商品编码。
pdIdpdSourceCode 至少传入一个,优先使用 pdIdpdCode
detailList.pdSourceCode 商品第三方编码 String 商品第三方编码。
pdIdpdCode 至少传入一个,优先使用 pdIdpdCode
detailList.unitId 单位ID Long 单位 ID,会关联商品过滤。未开启多单位定价时只读,系统赋值基本单位。
启用多单位定价时必填
unitName 二选一,优先使用 unitId
detailList.unitName 单位名称 String 单位名称,会关联商品过滤。优先使用 unitId
detailList.pdCount 数量 BigDecimal 商品数量,必须大于 0
detailList.actualPrice 实际售价 BigDecimal 实际售价,必须大于等于 0
detailList.pdPortfolioId 商品组合ID Long 商品组合 ID。
pdPortfolioCode 二选一,优先使用 pdPortfolioId
启用 CPQ 且商品是组合父商品时必填。
仅支持标准 BOM,配置 BOM 会报错
detailList.pdPortfolioCode 商品组合编码 String 商品组合编码。
启用 CPQ 且商品是组合父商品时必填。
仅支持标准 BOM,配置 BOM 会报错
detailList.extFields 自定义字段 Map 明细自定义字段,格式:{"fieldKey": "fieldValue"}
detailList.slave_pd_price 价目表 Long 只读 系统管理,openApi仅支持标准价目表
detailList.price_detail 价目表明细 Long 只读 根据价目表、商品、单位、数量自动匹配
detailList.pd_portfolio_detail 商品组合明细 Long 只读 系统自动处理
detailList.pd_origin_price 原价 BigDecimal 只读 从价目表获取
detailList.suggested_selling_price 建议售价 BigDecimal 只读 从价目表获取
detailList.sys_discount 系统折扣 BigDecimal 只读 自动计算:实际售价 / 建议售价
detailList.additional_discount 额外折扣 BigDecimal 只读 自动计算:实际售价 / 原价
detailList.is_gift 是否赠品 Boolean 只读 系统自动处理
detailList.slave_quotation_id 报价单编码 String 只读 不支持openApi录入
detailList.quotation_detail_id 报价单明细 Long 只读 不支持openApi录入
detailList.slave_contract_id 合同编码 String 只读 不支持openApi录入
detailList.contract_detail_id 合同明细 Long 只读 不支持openApi录入
detailList.node_id BOM节点ID Long 只读 BOM 展开时自动生成
detailList.parent_node_id BOM父节点ID Long 只读 BOM 展开时自动生成
detailList.root_node_id BOM根节点ID Long 只读 BOM 展开时自动生成
detailList.tree_data BOM树数据 String 只读 BOM 展开时自动生成
detailList.delivery_count 已发货数量 BigDecimal 只读 根据关联单据自动统计
detailList.back_count 退货数量 BigDecimal 只读 根据关联单据自动统计

响应示例:

{
  "return_code": 0,
  "return_msg": "success",
  "msg_id": "X0001",
  "response_data": "{\"id\":\"7123456789012345678\"}"
}

异常示例:

{
  "msg_id": "X000001",
  "return_code": 1,
  "return_msg": "数据不存在,dataName=CUS001"
}

参数说明:

参数 说明
return_code 响应编码。0:成功,1:失败。其他详见附录错误码说明 (opens new window)
return_msg 响应信息
msg_id 消息ID
response_data 返回数据,JSON字符串,包含新增的框架合同ID

# 删除订单

接口说明:

请求方式: POST(HTTPS
**请求地址: ** https://openapi.qince.com/api/ig/v2/orderDelete/{ openid }/{ timestamp }/{ digest }/{ msg_id } 在线调试
请求示例:

{
  "orderId": "6928823652322085688"
  // "orderCode": "DD2025062700048"
}
说明: 本示例仅供参考,具体以参数说明为准。

参数说明:

参数 类型 必填 说明
orderId VARCHAR(32) 订单ID,与orderCode至少传入一个
orderCode VARCHAR 订单编号(name字段),与orderId至少传入一个

响应示例:

{
  "return_code": 0,
  "return_msg": "success",
  "msg_id": "X0001",
  "response_data": null
}

异常示例:

{
  "msg_id": "X000001",
  "return_code": 1,
  "return_msg": "数据不存在,orderCode=DD2025062700048"
}

参数说明:

参数 说明
return_code 响应编码。0:成功,1:失败。其他详见附录错误码说明 (opens new window)
return_msg 响应信息
msg_id 消息ID

# 修改订单

接口说明: 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": "6928823652322085688",
  "fields": {
    "id": "6928823652322085688",
    "order_date": 1749017111000,
    "opportunities_info_id": null,
    "quotation_id": "6356101812300667105",
    "contract_id": "5298777734526242195",
    "pd_price": "7086934903373518037",
    "whole_order_discount": "0.8",
    "receipt_info": "8920258747221683719",
    "fieldKey(自定义字段key)": "fieldValue(数据格式参见附录六)"
  },
  "slave_fields": {
    "ig_order_detail": [
      {
        "currency_type": "CNY",
        "exchange_rate": 1,
        "pd_id": "5812809358061436658",
        "pd_portfolio": null,
        "pd_portfolio_detail": null,
        "node_id": null,
        "parent_node_id": null,
        "tree_data": null,
        "root_node_id": null,
        "portfolio_group": null,
        "unit_id": "6237374727925106334",
        "pd_count": 1,
        "actual_price": 8.8,
        "fieldKey(自定义字段key)": "fieldValue(数据格式参见附录六)"
      }
    ],
    "objectKey(自定义从对象对象key)": [
      {
        "fieldKey(自定义字段key)": "fieldValue(数据格式参见附录六)"
      }
    ]
  },
  "is_trigger": false,
  "check_rule": false
}
说明: 本示例仅供参考,具体以参数说明为准。

参数说明:

字段 名称 类型 必填 说明
is_trigger 触发工作流 Boolean 是否触发工作流,默认 false
trigger_employee 触发员工 Long 触发员工 ID。
isTrigger=true 时必填
check_rule 校验规则 Boolean 是否校验验证规则,默认 false
data_id 数据id Boolean 订单数据id
fields 订单主属性数据 Map JSON格式字符串。格式:{字段key:value},
(数据格式参见附录六)
fields.order_date 下单日期 Number 格式为时间戳
fields.whole_order_discount 整单折扣 BigDecimal 百分比格式,如 0.8 表示 80%。
不传默认为 1(100%)
如果实际售价合计金额为0,则强制记为100%
fields.order_total_amount 订单总额 BigDecimal 如果实际售价合计金额不为0,
则计算订单总额=实际售价合计金额*整单折扣;
如果实际售价合计金额为0,则订单总额按录入记录
fields.receipt_info 收货信息ID Long 支持修改
fields.customer 客户ID Long 只读 不支持修改。
fields.quotation_id 报价单ID Long 只读 不支持修改
fields.contract_id 合同ID Long 只读 不支持修改
fields.opportunities_info_id 商机ID Long 只读 不支持修改
fields.currency_type 币种 String 只读 不开启币种管理只读,币种代码,如 CNY。不传则使用本位币
fields.pd_price 价目表 Long 只读 系统管理,openApi仅支持标准价目表
fields.receipt_name 收货人姓名 String 只读 根据收货信息自动补齐
fields.receipt_phone 收货人手机 String 只读 根据收货信息自动补齐
fields.receipt_landline 收货人固话 String 只读 根据收货信息自动补齐
fields.receipt_address 收货地址 String 只读 根据收货信息自动补齐
fields.delivery_status 订单发货状态 String 只读 系统管理
fields.cm_useful_amount 客户可用额度 BigDecimal 只读 系统管理
fields.delivered_amount_total 已发货金额 BigDecimal 只读 根据关联发货单自动统计
fields.pending_delivery_amount_total 待发货金额 BigDecimal 只读 根据关联发货单自动统计
fields.payment_received_amount_total 已回款金额 BigDecimal 只读 根据关联收款单自动统计
fields.confirm_receipt_amount_total 确认收货金额 BigDecimal 只读 根据关联发货单自动统计
fields.field_x 自定义字段 Any 只读 自定义字段,字段类型和格式参见附录六
slave_fields 从对象数据 Map 数据中传入id为编辑,无id为新增,
格式:{对象key:[{字段key:字段值}]}(字段数据格式参见附录六)
slave_fields.ig_order_detail 订单明细 List 订单明细列表,至少包含一条明细
slave_fields.ig_order_detail.pd_id 商品ID Long 商品 ID。对接时,如果对应的商品组合是标准BOM,
按父商品信息和商品组合信息,自动补齐商品组合明细对应子商品对应的订单明细行
如果对应的商品组合是配置BOM,则报错提示“不支持配置BOM的对接,请通过页面进行新建。”
slave_fields.ig_order_detail.unit_id 单位ID Long 单位 ID,会关联商品过滤。未开启多单位定价时只读,系统赋值基本单位。
启用多单位定价时必填
slave_fields.ig_order_detail.pd_count 数量 BigDecimal 商品数量,必须大于 0
slave_fields.ig_order_detail.actual_price 实际售价 BigDecimal 实际售价,必须大于等于 0
slave_fields.ig_order_detail.pd_portfolio 商品组合ID Long 商品组合 ID。
启用 CPQ 且商品是组合父商品时必填。
仅支持标准 BOM,配置 BOM 会报错
slave_fields.ig_order_detail.slave_pd_price 价目表 Long 只读 系统管理,openApi仅支持标准价目表
slave_fields.ig_order_detail.price_detail 价目表明细 Long 只读 根据价目表、商品、单位、数量自动匹配
slave_fields.ig_order_detail.pd_portfolio_detail 商品组合明细 Long 只读 系统自动处理
slave_fields.ig_order_detail.pd_origin_price 原价 BigDecimal 只读 从价目表获取
slave_fields.ig_order_detail.suggested_selling_price 建议售价 BigDecimal 只读 从价目表获取
slave_fields.ig_order_detail.sys_discount 系统折扣 BigDecimal 只读 自动计算:实际售价 / 建议售价
slave_fields.ig_order_detail.additional_discount 额外折扣 BigDecimal 只读 自动计算:实际售价 / 原价
slave_fields.ig_order_detail.is_gift 是否赠品 Boolean 只读 系统自动处理
slave_fields.ig_order_detail.slave_quotation_id 报价单编码 String 只读 不支持openApi录入
slave_fields.ig_order_detail.quotation_detail_id 报价单明细 Long 只读 不支持openApi录入
slave_fields.ig_order_detail.slave_contract_id 合同编码 String 只读 不支持openApi录入
slave_fields.ig_order_detail.contract_detail_id 合同明细 Long 只读 不支持openApi录入
slave_fields.ig_order_detail.node_id BOM节点ID Long 只读 BOM 展开时自动生成
slave_fields.ig_order_detail.parent_node_id BOM父节点ID Long 只读 BOM 展开时自动生成
slave_fields.ig_order_detail.root_node_id BOM根节点ID Long 只读 BOM 展开时自动生成
slave_fields.ig_order_detail.tree_data BOM树数据 String 只读 BOM 展开时自动生成
slave_fields.ig_order_detail.delivery_count 已发货数量 BigDecimal 只读 根据关联单据自动统计
slave_fields.ig_order_detail.back_count 退货数量 BigDecimal 只读 根据关联单据自动统计

响应示例:

{
  "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": "1",
  "rows": "100",
  "sorts": [
    {
      "field_key": "create_time",
      "type": "desc"
    }
  ],
  "query_group": [
    {
      "connector": "OR",
      "filters": [
        {
          "field_key": "name",
          "operator": "ISN"
        }
      ]
    },
    {
      "connector": "OR",
      "filters": [
        {
          "field_key": "field_xjcv4",
          "operator": "NQ",
          "field_values": [
            "1"
          ]
        }
      ]
    }
  ]
}
说明: 本示例仅供参考,具体以参数说明为准。

参数说明:

参数 类型 必填 说明
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": {
      "format": "YYYY-MM-DD",
      "value": "2025-03-13"
    },
    "field_T08db": "222",
    "field_TtFXb": "222",
    "field_dWPHL": [
      {
        "code": "91CIFbjO",
        "label": "选项1",
        "status": "1"
      }
    ],
    "id": "9222626961451321265",
    "field_pOceu": "1",
    "lock_status": {
      "code": "UNLOCK",
      "label": "未锁定"
    },
    "field_whz1e": "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": {
      "code": "nPFlJR4S",
      "label": "选项1"
    },
    "name": "0313cs02",
    "creator_id": {
      "name": "x1",
      "id": "6611719441804418541",
      "status": "1"
    },
    "field_GOITb": {
      "format": "YYYY-MM-DD",
      "value": "2025-03-13"
    },
    "field_8JouQ": {
      "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": "1.00",
    "field_Y4dFC": "00005",
    "business_type": {
      "code": "busitype_default",
      "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": {
      "format": "YYYY-MM-DD HH:mm",
      "value": "2025-03-13 15:23"
    },
    "field_ujceN": "222"
  }
]

异常示例:

{
  "msg_id": "X000001",
  "return_code": 1,
  "return_msg": "查询失败!"
}

参数说明:

参数 类型 说明
msg_id String 请求消息ID
return_code int 响应编码。0:成功,1:失败。其他详见附录错误码说明 (opens new window)
return_msg String 响应说明
response_data List 响应数据列表,包含订单信息

响应数据字段说明(response_data):

字段 类型 说明
id String 订单ID
name String 订单编号
customer Object 客户信息,包含id、name、status等
order_date Object 下单日期,包含format和value
order_total_amount String 订单总额
whole_order_discount String 整单折扣
receipt_info Object 收货信息,包含id、name、status等
receipt_name String 收货人姓名
receipt_phone String 收货人手机
receipt_landline String 收货人固话
receipt_address String 收货地址
quotation_id Object 报价单信息,包含id、name、status等
contract_id Object 合同信息,包含id、name、status等
opportunities_info_id Object 商机信息,包含id、name、status等
pd_price Object 价目表信息,包含id、name、status等
currency_type String 币种代码,如CNY
delivery_status Object 订单发货状态,包含code和label
delivered_amount_total String 已发货金额
pending_delivery_amount_total String 待发货金额
payment_received_amount_total String 已回款金额
confirm_receipt_amount_total String 确认收货金额
cm_useful_amount String 客户可用额度
status Object 数据状态,包含code和label,如NORMAL-正常
lock_status Object 锁定状态,包含code和label,如UNLOCK-未锁定
approval_status Object 审批状态,包含code和label,如APPROVED-已通过
source_type Object 来源类型,包含code和label,如LROPFXCJ-自建
business_type Object 业务类型,包含code、id、label等
owner Object 负责人,包含id、name、status等
department Object 部门,包含id、name、status等
creator_id Object 创建人,包含id、name、status等
modifyier_id Object 修改人,包含id、name、status等
create_time Object 创建时间,包含format和value
modify_time Object 修改时间,包含format和value
field_xxx Any 自定义字段,字段类型和格式参见附录六

# 查询订单明细

接口说明 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": "1",
  "rows": "100",
  "sorts": [
    {
      "field_key": "create_time",
      "type": "desc"
    }
  ],
  "query_group": [
    {
      "connector": "OR",
      "filters": [
        {
          "field_key": "name",
          "operator": "ISN"
        }
      ]
    },
    {
      "connector": "OR",
      "filters": [
        {
          "field_key": "field_xjcv4",
          "operator": "NQ",
          "field_values": [
            "1"
          ]
        }
      ]
    }
  ]
}
说明: 本示例仅供参考,具体以参数说明为准。

参数说明:

参数 类型 必填 说明
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": {
      "format": "YYYY-MM-DD",
      "value": "2025-03-13"
    },
    "field_T08db": "222",
    "field_TtFXb": "222",
    "field_dWPHL": [
      {
        "code": "91CIFbjO",
        "label": "选项1",
        "status": "1"
      }
    ],
    "id": "9222626961451321265",
    "field_pOceu": "1",
    "lock_status": {
      "code": "UNLOCK",
      "label": "未锁定"
    },
    "field_whz1e": "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": {
      "code": "nPFlJR4S",
      "label": "选项1"
    },
    "name": "0313cs02",
    "creator_id": {
      "name": "x1",
      "id": "6611719441804418541",
      "status": "1"
    },
    "field_GOITb": {
      "format": "YYYY-MM-DD",
      "value": "2025-03-13"
    },
    "field_8JouQ": {
      "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": "1.00",
    "field_Y4dFC": "00005",
    "business_type": {
      "code": "busitype_default",
      "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": {
      "format": "YYYY-MM-DD HH:mm",
      "value": "2025-03-13 15:23"
    },
    "field_ujceN": "222"
  }
]

异常示例:

{
  "msg_id": "X000001",
  "return_code": 1,
  "return_msg": "查询失败!"
}

参数说明:

参数 类型 说明
msg_id String 请求消息ID
return_code int 响应编码。0:成功,1:失败。其他详见附录错误码说明 (opens new window)
return_msg String 响应说明
response_data List 响应数据列表,包含订单明细信息

响应数据字段说明(response_data):

字段 类型 说明
id String 订单明细ID
name String 订单明细编号
order_id Object 订单信息,包含id、name等
pd_id Object 商品信息,包含id、name、status等
unit_id Object 单位信息,包含id、name、status等
pd_count String 商品数量
actual_price String 实际售价
pd_origin_price String 原价
suggested_selling_price String 建议售价
pd_origin_amount String 原价金额
suggested_selling_amount String 建议售价金额
actual_selling_amount String 实际售价金额
sys_discount String 系统折扣
additional_discount String 额外折扣
amount_after_the_offer String 优惠后金额
is_gift Boolean 是否赠品
delivery_count String 已发货数量
back_count String 退货数量
slave_pd_price Object 价目表信息,包含id、name、status等
price_detail Object 价目表明细信息,包含id、name、status等
pd_portfolio Object 商品组合信息,包含id、name等
pd_portfolio_detail Object 商品组合明细信息
node_id String BOM节点ID
parent_node_id String BOM父节点ID
root_node_id String BOM根节点ID
tree_data String BOM树数据
portfolio_group String 组合分组
slave_quotation_id Object 报价单信息
quotation_detail_id Object 报价单明细信息
slave_contract_id Object 合同信息
contract_detail_id Object 合同明细信息
currency_type String 币种代码,如CNY
exchange_rate Number 汇率
status Object 数据状态,包含code和label,如NORMAL-正常
lock_status Object 锁定状态,包含code和label,如UNLOCK-未锁定
approval_status Object 审批状态,包含code和label,如APPROVED-已通过
source_type Object 来源类型,包含code和label,如LROPFXCJ-自建
business_type Object 业务类型,包含code、id、label等
owner Object 负责人,包含id、name、status等
department Object 部门,包含id、name、status等
creator_id Object 创建人,包含id、name、status等
modifyier_id Object 修改人,包含id、name、status等
create_time Object 创建时间,包含format和value
modify_time Object 修改时间,包含format和value
field_xxx Any 自定义字段,字段类型和格式参见附录六

# 作废订单

接口说明:将订单状态改为"已作废"

请求方式: POST(HTTPS
**请求地址: ** https://openapi.qince.com/api/ig/v1/orderInvalid/{ openid }/{ timestamp }/{ digest }/{ msg_id } 在线调试
请求示例:

{
  "orderCodes": "ORD202601001,ORD202601002"
  // 订单编号列表(必填) 或者 "orderIds": "7123456789012345678,7123456789012345679"
}
说明: 本示例仅供参考,具体以参数说明为准。

参数说明:

参数名 类型 必填 说明
orderIds String 订单ID列表(使用逗号分隔),与 orderCodes 至少传一个,优先使用 orderIds
orderCodes String 订单编号列表(name字段,使用逗号分隔),与 orderIds 至少传一个

响应示例:

{
  "return_code": 0,
  "return_msg": "success",
  "msg_id": "X0001",
  "response_data": null
}

异常示例:

{
  "msg_id": "X000001",
  "return_code": 1,
  "return_msg": "部分单据执行异常",
  "response_data": "[{\"id\":\"19586\", \"msg\":\"仅支持审批中、审批通过的订单进行作废\"}]"
}

参数说明:

参数 说明
return_code 响应编码。0:成功,1:失败。其他详见附录错误码说明 (opens new window)
return_msg 响应信息
msg_id 消息ID

# 关闭订单

接口说明:将订单状态改为"已关闭"

请求方式: POST(HTTPS
**请求地址: ** https://openapi.qince.com/api/ig/v1/orderClose/{ openid }/{ timestamp }/{ digest }/{ msg_id } 在线调试
请求示例:

{
  "orderCode": "ORD202601001" // 订单(必填) 或者 "orderId": 7123456789012345678
}
说明: 本示例仅供参考,具体以参数说明为准。

参数说明:

参数名 类型 必填 说明
orderId Long 订单ID,与 orderCode 至少传一个,优先使用 orderId
orderCode String 订单编号(name字段),与 orderId 至少传一个

响应示例:

{
  "return_code": 0,
  "return_msg": "success",
  "msg_id": "X0001",
  "response_data": null
}

异常示例:

{
  "msg_id": "X000001",
  "return_code": 1,
  "return_msg": "订单不存在"
}

参数说明:

参数 说明
return_code 响应编码。0:成功,1:失败。其他详见附录错误码说明 (opens new window)
return_msg 响应信息
msg_id 消息ID

# 推送订单

推送说明:参见 推送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",
            "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",
            "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",
      "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"
}

参数说明:

参数 类型 说明
appId Number 应用ID
dataFormat String 数据格式,如json
dataId String 数据ID,订单ID
dataSource String 数据来源,如biz
dataType String 数据类型,如apaas_data_change_event
tenantId Number 租户ID
version String 版本号,如v1
data Object 订单数据对象

订单数据字段说明(data):

字段 类型 说明
objectKey String 对象key,固定为ig_order
id String 订单ID
name String 订单编号
customer Object 客户信息,包含objectKey、objectName、id、name、status等
order_date Object 下单日期,包含format和value
order_total_amount String 订单总额
actual_selling_total_amount String 实际售价合计金额
whole_order_discount String 整单折扣
receipt_info Object 收货信息,包含id、name、status等
receipt_name String 收货人姓名
receipt_phone String 收货人手机
receipt_landline String 收货人固话
receipt_address Object 收货地址
quotation_id Object 报价单信息,包含id、name、status等
contract_id Object 合同信息,包含id、name、status等
opportunities_info_id Object 商机信息,包含id、name、status等
pd_price Object 价目表信息,包含id、name、status等
currency_type String 币种代码,如CNY
delivery_status Object 订单发货状态,包含code和label
delivered_amount_total String 已发货金额
pending_delivery_amount_total String 待发货金额
payment_received_amount_total String 已回款金额
confirm_receipt_amount_total String 确认收货金额
cm_useful_amount String 客户可用额度
status Object 数据状态,包含code和label,如NORMAL-正常
lock_status Object 锁定状态,包含code和label,如UNLOCK-未锁定
approval_status Object 审批状态,包含code和label,如APPROVED-已通过
source_type Object 来源类型,包含code和label,如LROPFXCJ-自建
business_type Object 业务类型,包含code、id、label、status等
owner Object 负责人,包含id、name、status等
department Object 部门,包含id、name、status等
creator_id Object 创建人,包含id、name、status等
modifyier_id Object 修改人,包含id、name、status等
create_time Object 创建时间,包含format和value
modify_time Object 修改时间,包含format和value
slaveObjectMap Object 从对象映射,包含订单明细等从对象数据

订单明细字段说明(data.slaveObjectMap.ig_order_detail):

字段 类型 说明
id String 订单明细ID
name String 订单明细编号
order_id Object 订单信息,包含id、name
pd_id Object 商品信息,包含id、name、status等
unit_id Object 单位信息,包含id、name、status等
pd_count String 商品数量
actual_price String 实际售价
pd_origin_price String 原价
suggested_selling_price String 建议售价
pd_origin_amount String 原价金额
suggested_selling_amount String 建议售价金额
actual_selling_amount String 实际售价金额
sys_discount String 系统折扣
additional_discount String 额外折扣
amount_after_the_offer String 优惠后金额
is_gift Boolean 是否赠品
delivery_count String 已发货数量
back_count String 退货数量
slave_pd_price Object 价目表信息,包含id、name、status等
price_detail Object 价目表明细信息,包含id、name、status等
pd_portfolio Object 商品组合信息
pd_portfolio_detail Object 商品组合明细信息
node_id String BOM节点ID
parent_node_id String BOM父节点ID
root_node_id String BOM根节点ID
tree_data String BOM树数据
portfolio_group String 组合分组
slave_quotation_id Object 报价单信息
quotation_detail_id Object 报价单明细信息
slave_contract_id Object 合同信息
contract_detail_id Object 合同明细信息
currency_type String 币种代码,如CNY
exchange_rate Number 汇率
status Object 数据状态,包含code和label,如NORMAL-正常
lock_status Object 锁定状态,包含code和label,如UNLOCK-未锁定
approval_status Object 审批状态,包含code和label,如APPROVED-已通过
source_type Object 来源类型,包含code和label,如LROPFXCJ-自建
business_type Object 业务类型,包含code、id、label、status等
owner Object 负责人,包含id、name、status等
department Object 部门,包含id、name、status等
creator_id Object 创建人,包含id、name、status等
modifyier_id Object 修改人,包含id、name、status等
create_time Object 创建时间,包含format和value
modify_time Object 修改时间,包含format和value