# 退货单接口

# 新增退货单

接口说明: 1、通过查询对象配置 (opens new window)接口,获得对象对应的fieldList --> 字段列表结构信息 2、详细字段入参规范说明参见 附录六:aPaaS字段类型样式说明 (opens new window) 3、部分预置字段的特殊逻辑,参考 fields特殊参数说明、slave_fields.ig_back_order_detail特殊参数说明

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

{
  "fields": {
    "customer": "6928823652322085688",
    "order_id": "8260806049276379882",
    "order_date": "2025-06-12",
    "fieldKey(自定义字段key)": "fieldValue(数据格式参见附录六)"
  },
  "slave_fields": {
    "ig_back_order_detail": [
      {
        "order_detail_id": "4626879479901376126",
        "back_count": "2"
      },
      {
        "order_detail_id": "7942171627478385837",
        "back_count": "2"
      },
      {
        "order_detail_id": "7814914111393830123",
        "back_count": "2"
      }
    ],
    "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
fields 主属性数据 Map JSON格式字符串。格式:{字段key:value},
(数据格式参见附录六)
fields.customer 客户ID Long 必传
fields.order_date 下单日期 Number 格式为时间戳
fields.order_type 订单类型 String 1-退货订单 2-换货订单
fields.take_info 取货地址 Long 需匹配对应客户收货地址
fields.order_id 订单ID Long 订单类型为“退货订单”时必填,且需要是当前客户的订单
fields.currency_type 币种 String 币种代码,如 CNY
未开启多币种时,不需要传,无论币种字段传入什么值均不接收;
开启多币种后,币种字段不传默认为本位币,传值取传入的值。
fields.back_reason 退货原因 String
fields.name 退货单编号 String 只读 系统管理
fields.back_order_status 退货状态 String 只读 系统管理
fields.receipt_name 收货人姓名 String 只读 根据取货信息自动补齐
fields.receipt_phone 收货人手机 String 只读 根据取货信息自动补齐
fields.receipt_landline 收货人固话 String 只读 根据取货信息自动补齐
fields.take_address 取货地址 String 只读 根据取货信息自动补齐
fields.confirm_receipt_amount_total 确认收货金额 BigDecimal 只读 自动统计
fields.field_xxx__c 自定义字段 Any 只读 自定义字段,字段类型和格式参见附录六
slave_fields 从对象数据 Map 格式:{对象key:[{字段key:字段值}]}(字段数据格式参见附录六)
slave_fields.ig_back_order_detail 退货单明细 List 退货单明细列表,至少包含一条明细
slave_fields.ig_back_order_detail.order_detail_id 订单明细ID Long 订单为“订单退货”时,必填;需属于退货头上的订单号
slave_fields.ig_back_order_detail.price_id 价目表ID Long 订单类型为“商品退货”时,系统自动获取价目表价格
订单类型为“订单退货”时,由订单明细编码的信息补齐
slave_fields.ig_back_order_detail.price_detail_id 价目表明细ID Long 订单类型为"商品退货"时,系统自动获取价目表价格
订单类型为"订单退货"时,由订单明细编码的信息补齐
slave_fields.ig_back_order_detail.pd_id 商品ID Long 订单类型为“商品退货”时商品必填,如果对应的商品组合是标准BOM,
按父商品信息和商品组合信息,自动补齐商品组合明细对应子商品对应的订单明细行
如果对应的商品组合是配置BOM,则报错提示“不支持配置BOM的对接,请通过页面进行新建。”
订单类型为“订单退货”时,由订单明细编码的信息补齐
slave_fields.ig_back_order_detail.pd_unit_id 单位ID Long 订单类型为“商品退货”时必填
订单类型为“订单退货”时,由订单明细编码的信息补齐
slave_fields.ig_back_order_detail.pd_portfolio 商品组合 Long 订单类型为“商品退货”时,如果“启用CPQ”且商品是商品组合父商品,则要求必填
订单类型为“订单退货”时,由订单明细编码的信息补齐
slave_fields.ig_back_order_detail.back_count 退货数量 BigDecimal 退货数量,必须大于 0
slave_fields.ig_back_order_detail.back_amount 退货金额 BigDecimal 支持传入退货金额,若不传入则系统自动计算:
1. 若退货数量 >= 可退货数量(发货数量-已退货数量-在途退货数量),则使用未退货金额(优惠后金额-已退货金额)
2. 否则按比例计算:单价 × 退货数量
slave_fields.ig_back_order_detail.pd_portfolio 商品组合ID Long 商品组合 ID。
启用 CPQ 且商品是组合父商品时必填。
仅支持标准 BOM,配置 BOM 会报错
slave_fields.ig_back_order_detail.name 退货单明细编号 String 只读 系统管理
slave_fields.ig_back_order_detail.pd_portfolio_detail 商品组合明细 Long 只读 不需要传入
slave_fields.ig_back_order_detail.back_order_id 退货单ID Long 只读 系统管理
slave_fields.ig_back_order_detail.slave_order_id 订单ID Long 只读 由订单明细补齐
slave_fields.ig_back_order_detail.sign_count 签收数量 BigDecimal 只读 自动统计
slave_fields.ig_back_order_detail.field_xxx__c 自定义字段 Any 只读 自定义字段,字段类型和格式参见附录六

响应示例:

{
  "msg_id": "X000001",
  "return_code": 0,
  "return_msg": "",
  "response_data": null
}

异常示例:

{
  "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、请求入参操作符,详见附录操作符说明 (opens new window) 3、字段出参规范说明参见 附录六:aPaaS字段类型样式说明 (opens new window)

请求方式: POST(HTTPS
**请求地址: ** https://openapi.qince.com/api/ig/v1/backOrderQuery/{ 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__c",
          "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__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": "查询失败!"
}

参数说明:

参数 类型 说明
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_id Object 订单信息,包含id、name、status等
order_date Object 退货日期,包含format和value
back_total_amount String 退货总金额
back_status Object 退货状态,包含code和label 0-待确认 5-待签收 1-已完成 6-部分退货 2-已打回
reverse_status Object 红冲状态,包含code和label
order_type Object 订单类型,包含code和label
currency_type String 币种代码,如CNY
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__c Any 自定义字段,字段类型和格式参见附录六

# 查询退货单明细

接口说明 1、通过查询对象配置 (opens new window)接口,获得对象对应的fieldList --> 字段列表结构信息 2、请求入参操作符,详见附录操作符说明 (opens new window) 3、字段出参规范说明参见 附录六:aPaaS字段类型样式说明 (opens new window)

请求方式: POST(HTTPS
**请求地址: ** https://openapi.qince.com/api/ig/v1/backOrderDetailQuery/{ 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__c",
          "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__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": "查询失败!"
}

参数说明:

参数 类型 说明
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 退货单明细编号
back_order_id Object 退货单信息,包含id、name
slave_order_id Object 订单信息,包含id、name、status等
order_detail_id Object 订单明细信息,包含id、name、status等
pd_id Object 商品信息,包含id、name、status等
pd_unit_id Object 单位信息,包含id、name、status等
back_count String 退货数量
back_amount String 退货金额
price String 单价
price_id Object 价目表信息,包含id、name、status等
price_detail_id Object 价目表明细信息,包含id、name、status等
pd_portfolio Object 商品组合信息,包含id、name、status等
pd_portfolio_detail Object 商品组合明细信息,包含id、name、status等
back_model Object 订单类型,包含code和label
is_bom Object 是否BOM,包含code和label
separate_present Object 是否独立发货,包含code和label
node_id String BOM节点ID
parent_node_id String BOM父节点ID
root_node_id String BOM根节点ID
tree_data String BOM树数据
currency_type Object 币种,包含code和label
exchange_rate 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
field_xxx__c Any 自定义字段,字段类型和格式参见附录六

# 删除退货单

接口说明:

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

{
  "dataId": "6306446111600440638"
}
说明: 本示例仅供参考,具体以参数说明为准。

参数说明:

参数 类型 必填 说明
dataId VARCHAR(32) 退货单数据ID,与dataName至少传入一个
dataName VARCHAR 退货单编号(name字段),与dataId至少传入一个

响应示例:

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

异常示例:

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

参数说明:

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

# 推送退货单

推送说明:参见 推送aPaaS对象数据变更 (opens new window)

请求示例:

{
  "appId": 200004,
  "data": {
    "objectKey": "ig_back_order",
    "owner": {
      "name": "hts",
      "id": "7007385368014262146",
      "status": "1"
    },
    "slaveObjectMap": {
      "ig_back_order_detail": [
        {
          "slave_order_id": {
            "name": "DD2025061300027",
            "id": "5026567945695121137",
            "status": "1"
          },
          "modify_time": {
            "format": "YYYY-MM-DD HH:mm:ss",
            "value": "2025-07-04 08:54:15"
          },
          "tree_data": "",
          "back_model": {
            "code": "PTO",
            "label": "PTO(允许按子商品进行分批交付)"
          },
          "back_amount": "20.00",
          "back_count": "2.00",
          "pd_portfolio": {
            "name": "ZH20250613000262",
            "id": "6828518669092637650",
            "status": "1"
          },
          "business_type": {
            "code": "busitype_default__c",
            "id": "7977955542741030243",
            "label": "默认业务类型",
            "status": "1"
          },
          "modifyier_id": {
            "name": "外部系统",
            "id": "998"
          },
          "id": "8783733298222774920",
          "department": {
            "name": "CPG",
            "id": "10",
            "status": "1"
          },
          "pd_id": {
            "name": "root节点L1父商品-PTO",
            "id": "7307951445481009003",
            "status": "1"
          },
          "owner": {
            "name": "hts",
            "id": "7007385368014262146",
            "status": "1"
          },
          "lock_status": {
            "code": "UNLOCK",
            "label": "未锁定"
          },
          "exchange_rate": "1.000000",
          "create_time": {
            "format": "YYYY-MM-DD HH:mm:ss",
            "value": "2025-07-04 08:54:15"
          },
          "approval_status": {
            "code": "APPROVED",
            "label": "已通过"
          },
          "back_order_id": {
            "name": "FH2025070400021",
            "id": "6306446111600440638"
          },
          "source_type": {
            "code": "LROPFXCJ",
            "label": "自建"
          },
          "root_node_id": "5878298479055129061",
          "order_detail_id": {
            "name": "DDMX2025061300068",
            "id": "4626879479901376126",
            "status": "1"
          },
          "pd_unit_id": {
            "name": "箱",
            "id": "5859522895738938134",
            "status": "1"
          },
          "currency_type": {
            "code": "CNY",
            "label": "人民币"
          },
          "creator_id": {
            "name": "外部系统",
            "id": "998"
          },
          "name": "FHMX2025070400122",
          "status": {
            "code": "NORMAL",
            "label": "正常"
          },
          "node_id": "5878298479055129061"
        },
        {
          "is_bom": {
            "code": "false",
            "label": "否"
          },
          "slave_order_id": {
            "name": "DD2025061300027",
            "id": "5026567945695121137",
            "status": "1"
          },
          "modify_time": {
            "format": "YYYY-MM-DD HH:mm:ss",
            "value": "2025-07-04 08:54:15"
          },
          "back_model": {
            "code": "PTO",
            "label": "PTO(允许按子商品进行分批交付)"
          },
          "back_count": "2.00",
          "parent_node_id": "5878298479055129061",
          "pd_portfolio": {
            "name": "ZH20250613000262",
            "id": "6828518669092637650",
            "status": "1"
          },
          "business_type": {
            "code": "busitype_default__c",
            "id": "7977955542741030243",
            "label": "默认业务类型",
            "status": "1"
          },
          "modifyier_id": {
            "name": "外部系统",
            "id": "998"
          },
          "id": "9044563084357906977",
          "department": {
            "name": "CPG",
            "id": "10",
            "status": "1"
          },
          "pd_id": {
            "name": "叶节点L201-可独立发货",
            "id": "7460595801255834310",
            "status": "1"
          },
          "owner": {
            "name": "hts",
            "id": "7007385368014262146",
            "status": "1"
          },
          "lock_status": {
            "code": "UNLOCK",
            "label": "未锁定"
          },
          "exchange_rate": "1.000000",
          "create_time": {
            "format": "YYYY-MM-DD HH:mm:ss",
            "value": "2025-07-04 08:54:15"
          },
          "approval_status": {
            "code": "APPROVED",
            "label": "已通过"
          },
          "back_order_id": {
            "name": "FH2025070400021",
            "id": "6306446111600440638"
          },
          "source_type": {
            "code": "LROPFXCJ",
            "label": "自建"
          },
          "root_node_id": "5878298479055129061",
          "pd_portfolio_detail": {
            "name": "ZHMX20250613000429",
            "id": "4967115001311135508",
            "status": "1"
          },
          "order_detail_id": {
            "name": "DDMX2025061300069",
            "id": "7942171627478385837",
            "status": "1"
          },
          "pd_unit_id": {
            "name": "包",
            "id": "5778096904880721227",
            "status": "1"
          },
          "currency_type": {
            "code": "CNY",
            "label": "人民币"
          },
          "creator_id": {
            "name": "外部系统",
            "id": "998"
          },
          "name": "FHMX2025070400123",
          "separate_present": {
            "code": "true",
            "label": "是"
          },
          "status": {
            "code": "NORMAL",
            "label": "正常"
          },
          "node_id": "5503227998577776453"
        }
      ]
    },
    "lock_status": {
      "code": "UNLOCK",
      "label": "未锁定"
    },
    "create_time": {
      "format": "YYYY-MM-DD HH:mm:ss",
      "value": "2025-07-04 08:54:15"
    },
    "approval_status": {
      "code": "APPROVED",
      "label": "已通过"
    },
    "back_total_amount": "20.00",
    "modify_time": {
      "format": "YYYY-MM-DD HH:mm:ss",
      "value": "2025-07-04 08:54:15"
    },
    "source_type": {
      "code": "LROPFXCJ",
      "label": "自建"
    },
    "order_date": {
      "format": "YYYY-MM-DD",
      "value": "2025-06-26"
    },
    "business_type": {
      "code": "busitype_default__c",
      "id": "4933400189895259551",
      "label": "默认业务类型",
      "status": "1"
    },
    "modifyier_id": {
      "name": "外部系统",
      "id": "998"
    },
    "reverse_status": {
      "code": "1",
      "label": "正常"
    },
    "creator_id": {
      "name": "外部系统",
      "id": "998"
    },
    "name": "FH2025070400021",
    "id": "6306446111600440638",
    "department": {
      "name": "CPG",
      "id": "10",
      "status": "1"
    },
    "order_id": {
      "name": "DD2025061300027",
      "id": "5026567945695121137",
      "status": "1"
    },
    "back_status": {
      "code": "0",
      "label": "待签收"
    },
    "status": {
      "code": "NORMAL",
      "label": "正常"
    },
    "customer": {
      "objectKey": "bas_cm_customer",
      "name": "测试客户",
      "objectName": "客户",
      "id": "6928823652322085688",
      "status": "1"
    }
  },
  "dataFormat": "json",
  "dataId": "6306446111600440638",
  "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_back_order
id String 退货单ID
name String 退货单编号
customer Object 客户信息,包含objectKey、objectName、id、name、status等
order_id Object 订单信息,包含id、name、status等
order_date Object 退货日期,包含format和value
back_total_amount String 退货总金额
back_status Object 退货状态,包含code和label 0-待确认 5-待签收 1-已完成 6-部分退货 2-已打回
reverse_status Object 红冲状态,包含code和label
order_type Object 订单类型,包含code和label
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_back_order_detail):

字段 类型 说明
id String 退货单明细ID
name String 退货单明细编号
back_order_id Object 退货单信息,包含id、name
slave_order_id Object 订单信息,包含id、name、status等
order_detail_id Object 订单明细信息,包含id、name、status等
pd_id Object 商品信息,包含id、name、status等
pd_unit_id Object 单位信息,包含id、name、status等
back_count String 退货数量
back_amount String 退货金额
pd_portfolio Object 商品组合信息,包含id、name、status等
pd_portfolio_detail Object 商品组合明细信息,包含id、name、status等
back_model Object 订单类型,包含code和label
is_bom Object 是否BOM,包含code和label
separate_present Object 是否独立发货,包含code和label
node_id String BOM节点ID
parent_node_id String BOM父节点ID
root_node_id String BOM根节点ID
tree_data String BOM树数据
currency_type Object 币种,包含code和label
exchange_rate 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

# 查询退货签收单

接口说明 1、通过查询对象配置 (opens new window)接口,获得对象对应的fieldList --> 字段列表结构信息 2、请求入参操作符,详见附录操作符说明 (opens new window) 3、字段出参规范说明参见 附录六:aPaaS字段类型样式说明 (opens new window)

请求方式: POST(HTTPS
**请求地址: ** https://openapi.qince.com/api/ig/v1/signOrderQuery/{ 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__c",
          "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__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": "查询失败!"
}

参数说明:

参数 类型 说明
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 退货签收单编号
back_order_id Object 退货单信息,包含id、name、status等
sign_date Object 签收日期,包含format和value
sign_total_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__c Any 自定义字段,字段类型和格式参见附录六

# 查询退货签收单明细

接口说明 1、通过查询对象配置 (opens new window)接口,获得对象对应的fieldList --> 字段列表结构信息 2、请求入参操作符,详见附录操作符说明 (opens new window) 3、字段出参规范说明参见 附录六:aPaaS字段类型样式说明 (opens new window)

请求方式: POST(HTTPS
**请求地址: ** https://openapi.qince.com/api/ig/v1/signOrderDetailQuery/{ 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__c",
          "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__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": "查询失败!"
}

参数说明:

参数 类型 说明
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 退货签收单明细编号
sign_order_id Object 退货签收单信息,包含id、name
back_order_id Object 退货单信息,包含id、name、status等
back_order_detail_id Object 退货单明细信息,包含id、name、status等
pd_id Object 商品信息,包含id、name、status等
pd_unit_id Object 单位信息,包含id、name、status等
sign_count String 签收数量
sign_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
field_xxx__c Any 自定义字段,字段类型和格式参见附录六