API开放平台

TIP

# 退货单接口

# 新增退货单

接口说明： 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",
    "back_date": "2025-06-12",
    "fieldKey(自定义字段key)": "fieldValue(数据格式参见附录六)"
  },
  "slave_fields": {
    "ig_back_order_detail": [
      {
        "slave_order_id": "5026567945695121137",
        "order_detail_id": "4626879479901376126",
        "back_count": "2"
      },
      {
        "slave_order_id": "5026567945695121137",
        "order_detail_id": "7942171627478385837",
        "back_count": "2"
      },
      {
        "slave_order_id": "5026567945695121137",
        "order_detail_id": "7814914111393830123",
        "back_count": "2"
      }
    ],
    "objectKey(自定义从对象对象key)": [
      {
        "fieldKey(自定义字段key)": "fieldValue(数据格式参见附录六)"
      }
    ]
  },
  "is_trigger": false,
  "check_rule": false
}
说明： 本示例仅供参考，具体以参数说明为准。

参数说明：

参数 类型 必填 说明
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_type 单选框 否 不需要传入，本期默认退货订单
订单号 order_id 关联关系 否 退货模式为“关联订单退货”时，必填
收货人姓名 receipt_name 单行文本 否 不需要传入，根据取货信息赋值
收货人手机 receipt_phone 手机 否 不需要传入，根据取货信息赋值
收货人固定电话 receipt_landline 单行文本 否 不需要传入，根据取货信息赋值
收货地址 receipt_address 地区 否 不需要传入，根据取货信息赋值
币种 currency_type 单选框 否 未开启多币种时，不需要传，无论币种字段传入什么值均不接收；
开启多币种后，退货模式为“选择商品退货”时，系统自动根据订单的币种； 退货模式为“关联订单退货”时，不传值则默认本位币，传值以接口传值为准，单价进行币种自动转化

slave_fields.ig_back_order_detail特殊参数说明：

字段名称 字段key 字段类型 必填 特殊说明
订单明细编码 order_detail_id 关联关系 否 退货模式为“关联订单退货”时，必填；需属于退货头上的订单号
订单号 slave_order_id 关联关系 否 不需要传入，由订单明细编码的信息补齐
商品名称 pd_id 关联关系 否 退货模式为“选择商品退货”时商品必填，如果对应的商品组合是标准BOM，
按父商品信息和商品组合信息，自动补齐商品组合明细对应子商品对应的订单明细行
如果对应的商品组合是配置BOM，则报错提示“不支持配置BOM的对接，请通过页面进行新建。”
退货模式为“关联订单退货”时，由订单明细编码的信息补齐
商品组合编号 pd_portfolio 关联关系 否 退货模式为“选择商品退货”时，如果“启用CPQ”且商品是商品组合父商品，则要求必填
退货模式为“关联订单退货”时，由订单明细编码的信息补齐
商品组合明细编号 pd_portfolio_detail 关联关系 否 不需要传入
单位名称 pd_unit_id 关联关系 否 退货模式为“选择商品退货”时必填
退货模式为“关联订单退货”时，由订单明细编码的信息补齐
单价 price 金额 否 退货模式为“选择商品退货”时，系统自动获取价目表价格
退货模式为“关联订单退货”时，由订单明细编码的信息补齐
价目表 price_id 关联关系 否 退货模式为“选择商品退货”时，取标准价目表
退货模式为“关联订单退货”时，由订单明细编码的信息补齐
价目表明细 price_detail_id 关联关系 否 退货模式为“选择商品退货”时，系统自动获取价目表价格
退货模式为“关联订单退货”时，由订单明细编码的信息补齐

响应示例：

{
  "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": "查询失败！"
}

# 查询退货单明细

接口说明 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": "查询失败！"
}

# 推送退货单

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

← 退货签收单 →