贸易订单
创建贸易订单
创建贸易订单
端点目标 URL
沙盒环境请求地址:POST https://preapi.futurepay-develop.com/api/v1/trade-order/insert
生产环境请求地址:POST https://api.futurepay.global/api/v1/trade-order/insert
字段说明
调用的特定输入参数
| 字段名 | 必填 | 类型 | 说明 |
|---|---|---|---|
| merchantId | M | Long | 商户ID |
| tradeOrderType | M | Integer | 贸易订单类型:0. 货物贸易;1. 服务贸易 |
| businessId | O | Long | 服务类型ID(服务类型必填) |
| foreignExchangeSettledFlag | M | Integer | 是否需要结汇:0. 否;1. 是 |
| tradeOrderName | M | String | 订单名称 |
| tradeOrderCode | M | String | 订单编码 |
| tradeOrderTotalAmount | M | Number | 贸易订单总额 |
| tradeOrderCurrency | M | String | 贸易订单币种 |
| partnerType | O | String | 合作方官网(服务贸易必填) |
| tradeOrderDate | O | String | 订单时间(货物贸易必填)格式:yyyy-MM-dd |
| fundNature | O | Integer | 资金性质(货物贸易必填):0. 物流费用;1. 一般贸易-代采 2.服务费用 |
| buyerName | M | String | 货物贸易:买家名称;服务贸易:合作方名称 |
| buyerCountry | O | String | 买家国家/地区(货物贸易必填) |
| storeUrl | O | String | 店铺网址(货物贸易必填) |
| tradeOrderItemList | O | List<tradeOrderItemObject> | 贸易订单商品信息(货物贸易必填) |
| isShipped | M | Integer | 是否发货:0. 否;1. 是 货物贸易:是否发货;服务贸易:是否需要物流 |
| tradeOrderLogisticsList | O | List<tradeOrderLogisticsObject> | 物流信息;isShipped=是:必填 |
| remark | O | String | 备注信息 |
| autoPostFlag | M | Integer | 是否自动入账:0. 否;1. 是 |
| tradeOrderFileList | M | List<tradeOrderFileObject> | 附件信息 |
| tradeOrderStatus | M | Integer | 贸易订单状态:0. 保存草稿;1. 立即创建 |
| remitAccName | O | String | 付款人名称 |
| remitAccNo | O | String | 付款人账号 |
| deliveryEtaDate | O | String | 预计发货时间(货物贸易是否发货=否必填)格式:yyyy-MM-dd |
| createPattern | M | Integer | 创建方式:0.智能识别;1.手动填写;2.智能识别-复制;3.手动填写-复制; |
tradeOrderItemObject字段结构
| 字段名 | 必填 | 类型 | 说明 |
|---|---|---|---|
| itemName | M | String | 商品名称 |
| quantity | M | String | 数量 |
| unit | M | Integer | 单位:0. 个;1. 件;2. 套;3. 台;4. 箱;5. 千克 |
tradeOrderLogisticsObject字段结构
| 字段名 | 必填 | 类型 | 说明 |
|---|---|---|---|
| logisticsMethod | M | Integer | 物流方式:0. 国际快递;1. 海运;2. 空运;3. 陆运;4. 铁路;5. 专线运输;6. 其他; |
| logisticsNo | M | String | 货物贸易:出境物流单号;服务贸易:运单号 |
| logisticsCompany | M | String | 货物贸易:物流公司;服务贸易:运输公司 |
| consignedGoods | O | String | 承运物品(服务贸易必填) |
| receivingCountry | O | String | 收货地(服务贸易必填) |
| departureTime | O | Date | 起运时间(服务贸易必填)格式:yyyy-MM-dd |
| tradeOrderFileList | O | List<tradeOrderFileObject> | 物流附件信息(货物贸易必填) |
tradeOrderFileObject字段结构
| 字段名 | 必填 | 类型 | 说明 |
|---|---|---|---|
| fileType | M | Integer | 文件类型:0. 发票附件(PO/CI/PO附件);1. 物流单附件;3. 其他材料附件; |
| fileName | M | String | 文件名称 |
| filePath | M | String | 文件地址 |
集成
创建贸易订单调用输入
{
"merchantId": 0,
"tradeOrderType": 0,
"businessId": 0,
"foreignExchangeSettledFlag": 1,
"tradeOrderName": null,
"tradeOrderCode": null,
"tradeOrderTotalAmount": 0,
"tradeOrderCurrency": null,
"partnerType": null,
"tradeOrderDate": null,
"fundNature": 0,
"buyerName": null,
"buyerCountry": null,
"storeUrl": null,
"tradeOrderItemList": [
{
"itemName": null,
"quantity": null,
"unit": 0
}
],
"isShipped": 1,
"tradeOrderLogisticsList": [
{
"logisticsMethod": 0,
"logisticsNo": null,
"logisticsCompany": null,
"consignedGoods": null,
"receivingCountry": null,
"departureTime": null,
"tradeOrderFileList": [
{
"fileType": 0,
"fileName": null,
"filePath": null
}
]
}
],
"remark": null,
"autoPostFlag": 1,
"tradeOrderFileList": [
{
"fileType": 0,
"fileName": null,
"filePath": null
}
],
"tradeOrderStatus": 0,
"remitAccName": null,
"remitAccNo": null,
"createPattern":1
}创建贸易订单调用输出
{
"code": "",
"msg": "",
"serverTime": 0,
"data": null
}贸易订单系统自动识别填单
贸易订单系统自动识别填单
端点目标 URL
沙盒环境请求地址:POST https://preapi.futurepay-develop.com/api/v1/trade-order/identify
生产环境请求地址:POST https://api.futurepay.global/api/v1/trade-order/identify
字段说明
调用的特定输入参数
| 字段名 | 必填 | 类型 | 说明 |
|---|---|---|---|
| tradeOrderType | M | Integer | 贸易订单类型:0. 货物贸易;1. 服务贸易 |
| filePathList | M | List<String> | 待识别文件路径列表 |
| reqNo | M | String | 唯一请求编码 |
集成
贸易订单系统自动识别填单调用输入
{
"tradeOrderType": 0,
"filePathList": [],
"reqNo": "11111"
}贸易订单系统自动识别填单调用输出
{
"code": "",
"msg": "",
"serverTime": 0,
"data": null
}贸易订单列表查询
贸易订单列表查询
端点目标 URL
沙盒环境请求地址:POST https://preapi.futurepay-develop.com/api/v1/trade-order/list
生产环境请求地址:POST https://api.futurepay.global/api/v1/trade-order/list
字段说明
调用的特定输入参数
| 字段名 | 类型 | 说明 |
|---|---|---|
| searchValue | String | 搜索值(贸易订单号、订单名称、买家名称、合作方名称) |
| buyerCountryList | List<String> | 买家国家/地区 |
| tradeOrderCurrencyList | List<String> | 贸易订单币种 |
| tradeOrderStatusList | List<String> | 贸易订单状态:0. 草稿;1. 待审核;2. 待补充;3. 收款中;4. 更新待审核;5. 驳回;6. 已关闭;7. 已过期;8. 已作废 |
| isShipped | Integer | 是否发货:0. 未发货;1. 已发货 |
| createStartTime | Date | 创建开始时间,格式:yyyy-MM-dd HH:mm:ss |
| createEndTime | Date | 创建结束时间,格式:yyyy-MM-dd HH:mm:ss |
| pageNum | int | 当前页码 |
| pageSize | int | 每页显示条数(页大小) |
调用的特定输出参数
| 字段名 | 类型 | 说明 |
|---|---|---|
| id | Long | 主键 |
| merchantId | Long | 商户ID |
| tradeOrderType | Integer | 贸易订单类型:0. 货物贸易;1. 服务贸易 |
| businessId | Long | 服务类型ID |
| foreignExchangeSettledFlag | Integer | 是否需要结汇:0. 否;1. 是 |
| tradeOrderName | String | 订单名称 |
| tradeOrderCode | String | 订单编码 |
| tradeOrderTotalAmount | BigDecimal | 贸易订单总额 |
| approvedAmount | BigDecimal | 贸易批准总额 |
| tradeOrderCurrency | String | 贸易订单币种 |
| tradeOrderDate | LocalDate | 订单时间 |
| fundNature | Integer | 资金类型:0. 物流费用;1. 一般贸易-代采 |
| buyerName | String | 货物贸易:买家名称;服务贸易:合作方名称 |
| buyerCountry | String | 货物贸易:买家国家/地区;服务贸易:合作方所在国/地区 |
| partnerType | String | 合作方官网 |
| storeUrl | String | 店铺网址 |
| isShipped | Integer | 是否发货:0. 否;1. 是 |
| remark | String | 备注信息 |
| autoPostFlag | Integer | 是否自动入账:0. 否;1. 是 |
| relateOrderCount | Integer | 已关联订单数量 |
| relateOrderAmount | BigDecimal | 已关联订单累计金额 |
| tradeOrderStatus | Integer | 贸易订单状态:0. 草稿;1. 待审核;2. 待补充;3. 收款中;4. 更新待审核;5. 驳回;6. 已关闭;7. 已过期;8. 已作废 |
| approvalType | Integer | 贸易审核类型:0. 创建订单;1. 额度调整;2. 编辑信息;3. 补充信息 |
| approvalMsg | String | 贸易审核留言 |
| remitAccName | String | 付款人名称 |
| remitAccNo | String | 付款人账号 |
| deliveryEtaDate | Date | 预计发货时间,格式:yyyy-MM-dd |
| createTime | Date | 创建时间,格式:yyyy-MM-dd HH:mm:ss |
| updateTime | Date | 修改时间,格式:yyyy-MM-dd |
| isDeleted | Integer | 是否删除:0. 未删除;1. 已删除 |
集成
贸易订单列表查询调用输入
{
"pageNum":1,
"pageSize": 10,
"searchValue": null,
"buyerCountryList": [],
"tradeOrderCurrencyList": [],
"tradeOrderStatusList": [],
"isShipped": 1,
"createStartTime": "2024-05-03 14:22:00",
"createEndTime": "2024-05-03 14:22:00"
}贸易订单列表查询调用输出
{
"code": "",
"msg": "",
"serverTime": 0,
"data": {
"total": 0,
"list": [
{
"id": 0,
"merchantId": 0,
"tradeOrderType": 0,
"businessId": 0,
"foreignExchangeSettledFlag": "1",
"tradeOrderName": "",
"tradeOrderCode": "",
"tradeOrderTotalAmount": "0.000000",
"approvedAmount": "0.000000",
"tradeOrderCurrency": "",
"tradeOrderDate": "",
"fundNature": 0,
"buyerName": "",
"buyerCountry": "",
"partnerType": "",
"storeUrl": "",
"isShipped": "1",
"remark": "",
"autoPostFlag": "1",
"relateOrderCount": "0",
"relateOrderAmount": "0.000000",
"tradeOrderStatus": 0,
"approvalType": 0,
"approvalMsg": "",
"remitAccName": "",
"remitAccNo": "",
"createTime": "2024-05-03 14:22:00",
"updateTime": "2024-05-03 14:22:00",
"isDeleted": "0"
}
],
"pageNum": 0,
"pageSize": 0,
"size": 0,
"startRow": 0,
"endRow": 0,
"pages": 0,
"prePage": 0,
"nextPage": 0,
"isFirstPage": "false",
"isLastPage": "false",
"hasPreviousPage": "false",
"hasNextPage": "false",
"navigatePages": 0,
"navigatepageNums": [
0
],
"navigateFirstPage": 0,
"navigateLastPage": 0
}
}贸易订单列表Total查询
贸易订单列表Total查询
端点目标 URL
沙盒环境请求地址:POST https://preapi.futurepay-develop.com/api/v1/trade-order/queryTradeOrderStatusCount
生产环境请求地址:POST https://api.futurepay.global/api/v1/trade-order/queryTradeOrderStatusCount
字段说明
调用的特定输入参数
| 字段名 | 类型 | 说明 |
|---|---|---|
| searchValue | String | 搜索值(贸易订单号、订单名称、买家名称、合作方名称) |
| buyerCountryList | List<String> | 买家国家/地区 |
| tradeOrderCurrencyList | List<String> | 贸易订单币种 |
| tradeOrderStatusList | List<String> | 贸易订单状态:0. 草稿;1. 待审核;2. 待补充;3. 收款中;4. 更新待审核;5. 驳回;6. 已关闭;7. 已过期;8. 已作废 |
| isShipped | Integer | 是否发货:0. 未发货;1. 已发货 |
| createStartTime | Date | 创建开始时间,格式:yyyy-MM-dd HH:mm:ss |
| createEndTime | Date | 创建结束时间,格式:yyyy-MM-dd HH:mm:ss |
调用的特定输出参数
| 字段名 | 必填 | 类型 | 说明 |
|---|---|---|---|
| status | Integer | 贸易订单状态:0. 草稿;1. 待审核;2. 待补充;3. 收款中;4. 更新待审核;5. 驳回;6. 已关闭;7. 已过期;8. 已作废 | |
| count | Long | 订单数量 |
集成
贸易订单列表Total查询调用输入
{
"searchValue": null,
"buyerCountryList": [],
"tradeOrderCurrencyList": [],
"tradeOrderStatusList": [],
"isShipped": 1,
"createStartTime": "2024-05-03 14:22:00",
"createEndTime": "2024-05-03 14:22:00"
}贸易订单列表Total查询调用输出
{
"code": "",
"msg": "",
"serverTime": 0,
"data": [
{
"status": 0,
"count": 0
}
]
}贸易订单详情查询
贸易订单详情查询
端点目标 URL
沙盒环境请求地址:POST https://preapi.futurepay-develop.com/api/v1/trade-order/{id}
生产环境请求地址:POST https://api.futurepay.global/api/v1/trade-order/{id}
字段说明
调用的特定输入参数
| 字段名 | 类型 | 说明 |
|---|---|---|
| id | Long | 贸易订单ID |
调用的特定输出参数
| 字段名 | 类型 | 说明 |
|---|---|---|
| id | Long | 主键 |
| merchantId | Long | 商户ID |
| tradeOrderType | Integer | 贸易订单类型:0. 货物贸易;1. 服务贸易 |
| businessId | Long | 服务类型ID |
| foreignExchangeSettledFlag | Integer | 是否需要结汇:0. 否;1. 是 |
| tradeOrderName | String | 订单名称 |
| tradeOrderCode | String | 订单编码 |
| tradeOrderTotalAmount | BigDecimal | 贸易订单总额 |
| approvedAmount | BigDecimal | 贸易批准总额 |
| tradeOrderCurrency | String | 贸易订单币种 |
| tradeOrderDate | LocalDate | 订单时间 |
| fundNature | Integer | 资金类型:0. 物流费用;1. 一般贸易-代采 |
| buyerName | String | 货物贸易:买家名称;服务贸易:合作方名称 |
| buyerCountry | String | 货物贸易:买家国家/地区;服务贸易:合作方所在国/地区 |
| partnerType | String | 合作方官网 |
| storeUrl | String | 店铺网址 |
| isShipped | Integer | 是否发货:0. 否;1. 是 |
| remark | String | 备注信息 |
| autoPostFlag | Integer | 是否自动入账:0. 否;1. 是 |
| relateOrderCount | Integer | 已关联订单数量 |
| relateOrderAmount | BigDecimal | 已关联订单累计金额 |
| tradeOrderStatus | Integer | 贸易订单状态:0. 草稿;1. 待审核;2. 待补充;3. 收款中;4. 更新待审核;5. 驳回;6. 已关闭;7. 已过期;8. 已作废 |
| approvalType | Integer | 贸易审核类型:0. 创建订单;1. 额度调整;2. 编辑信息;3. 补充信息 |
| approvalMsg | String | 贸易审核留言 |
| remitAccName | String | 付款人名称 |
| remitAccNo | String | 付款人账号 |
| deliveryEtaDate | Date | 预计发货时间,格式:yyyy-MM-dd |
| createTime | Date | 创建时间,格式:yyyy-MM-dd HH:mm:ss |
| updateTime | Date | 修改时间,格式:yyyy-MM-dd |
| isDeleted | Integer | 是否删除:0. 未删除;1. 已删除 |
| tradeOrderTransactionRelRepList | List<tradeOrderTransactionRelObject> | 贸易订单交易关系列表 |
| tradeOrderItemRepList | List<tradeOrderItemObject> | 贸易订单商品列表 |
| tradeOrderLogisticsRepList | List<tradeOrderLogisticsObject> | 贸易订单物流列表 |
| tradeOrderFileRepList | List<tradeOrderFileObject> | 贸易订单附件列表 |
| tradeOrderSupplement | List<tradeOrderSupplementObject> | 贸易订单补充列表 |
tradeOrderTransactionRelObject字段结构
| 字段名 | 类型 | 说明 |
|---|---|---|
| id | Long | ID |
| bankAccountName | String | 账户名称 |
| remitName | String | 付款人名称 |
| userReqNo | String | 平台流水号 |
| arrivalAmt | Money | 入账金额 |
| entryAmt | Money | 到账金额 |
| relateTime | String | 关联时间,格式:yyyy-MM-dd HH:mm:ss |
| relateAmount | Number | 本次关联金额 |
| tradeOrderCurrency | String | 本次关联金额币种 |
| status | Integer | 收款状态 |
| transactionRecordsId | Long | 收款ID |
tradeOrderItemObject字段结构
| 字段名 | 类型 | 说明 |
|---|---|---|
| id | Long | 主键 |
| tradeOrderId | Long | 贸易订单ID |
| itemName | String | 商品名称 |
| quantity | String | 数量 |
| unit | Integer | 单位:0. 个;1. 件;2. 套;3. 台;4. 箱;5. 千克 |
| createTime | Date | 创建时间 |
| updateTime | Date | 修改时间 |
| isDeleted | Integer | 是否删除:0. 未删除;1. 已删除 |
tradeOrderLogisticsObject字段结构
| 字段名 | 类型 | 说明 |
|---|---|---|
| id | Long | 主键 |
| tradeOrderId | Long | 贸易订单ID |
| logisticsMethod | Integer | 物流方式:0. 国际快递;1. 海运;2. 空运;3. 陆运;4. 铁路;5. 专线运输;6. 其他; |
| logisticsNo | String | 货物贸易:出境物流单号;服务贸易:运单号 |
| logisticsCompany | String | 货物贸易:物流公司;服务贸易:运输公司 |
| consignedGoods | String | 承运物品 |
| receivingCountry | String | 收货地 |
| departureTime | Date | 起运时间,格式:yyyy-MM-dd |
| createTime | Date | 创建时间 |
| updateTime | Date | 修改时间 |
| isDeleted | Integer | 是否删除:0. 未删除;1. 已删除 |
| tradeOrderFileRepList | List<tradeOrderFileObject> | 关联的物流图片列表(非数据库字段) |
tradeOrderFileObject字段结构
| 字段名 | 类型 | 说明 |
|---|---|---|
| id | Long | 主键 |
| tradeOrderId | Long | 贸易订单ID |
| businessId | Long | 业务ID:对应贸易订单下对应文件类型的 ID |
| fileType | Integer | 文件类型:0. 发票附件(PO/CI/PO附件);1. 物流单附件;3. 其他材料附件; |
| fileName | String | 文件名称 |
| filePath | String | 文件地址 |
| createTime | Date | 创建时间 |
| updateTime | Date | 修改时间 |
| isDeleted | Integer | 是否删除:0. 未删除;1. 已删除 |
tradeOrderSupplementObject字段结构
| 字段名 | 类型 | 说明 |
|---|---|---|
| id | Long | 主键 |
| businessId | Long | 业务ID |
| businessType | Integer | 业务类型:0. 贸易订单;1. 收款订单 |
| merchantId | Long | 商户ID |
| version | Integer | 版本 |
| noticeMethod | String | 通知方式:messages、email |
| keepHistoricalFlag | Integer | 是否保留历史问题:0. 是;1. 否 |
| createTime | Date | 创建时间 |
| updateTime | Date | 修改时间 |
| isDeleted | Integer | 是否删除:0. 未删除;1. 已删除 |
| tradeOrderSupplementMaterialList | List<tradeOrderSupplementMaterialtObject> | 问题集合 |
| tradeOrderCode | String | 贸易订单编号 |
tradeOrderSupplementMaterialtObject字段结构
| 字段名 | 类型 | 说明 |
|---|---|---|
| id | Long | 主键 |
| tradeOrderSupplementId | Long | 贸易补充信息ID |
| question | String | 问题 |
| questionType | Integer | 问题类型 |
| createTime | Date | 创建时间 |
| updateTime | Date | 修改时间 |
| isDeleted | Integer | 是否删除:0. 未删除;1. 已删除 |
| tradeOrderSupplementMaterialDetails | List<TradeOrderSupplementMaterialDetailObject> | 补充内容集合 |
TradeOrderSupplementMaterialDetailObject字段结构
| 字段名 | 类型 | 说明 |
|---|---|---|
| id | Long | 主键 |
| tradeOrderSupplementMaterialId | Long | 贸易补充材料ID |
| questionReply | String | 补充内容 |
| createTime | Date | 创建时间 |
| updateTime | Date | 修改时间 |
| isDeleted | Integer | 是否删除:0. 未删除;1. 已删除 |
集成
贸易订单详情查询调用输出
{
"code": "",
"msg": "",
"serverTime": 0,
"data": {
"id": 0,
"merchantId": 0,
"tradeOrderType": 0,
"businessId": 0,
"foreignExchangeSettledFlag": "1",
"tradeOrderName": "",
"tradeOrderCode": "",
"tradeOrderTotalAmount": "0.00",
"approvedAmount": "0.00",
"tradeOrderCurrency": "",
"tradeOrderDate": "",
"fundNature": 0,
"buyerName": "",
"buyerCountry": "",
"partnerType": "",
"storeUrl": "",
"isShipped": "1",
"remark": "",
"autoPostFlag": "1",
"relateOrderCount": "0",
"relateOrderAmount": "0.00",
"tradeOrderStatus": 0,
"approvalType": 0,
"approvalMsg": "",
"remitAccName": "",
"remitAccNo": "",
"createTime": "2024-05-03 14:22:00",
"updateTime": "2024-05-03 14:22:00",
"isDeleted": "0",
"tradeOrderTransactionRelRepList": [
{
"id": 0,
"bankAccountName": "",
"remitName": "",
"userReqNo": "",
"arrivalAmt": {
"amount": 0.0,
"currency": "",
"accuracy": 0
},
"entryAmt": {
"amount": 0.0,
"currency": "",
"accuracy": 0
},
"relateTime": "",
"relateAmount": "0.000000",
"tradeOrderCurrency": "",
"status": 0,
"transactionRecordsId": 0
}
],
"tradeOrderItemRepList": [
{
"id": 0,
"tradeOrderId": 0,
"itemName": "",
"quantity": "1",
"unit": 0,
"createTime": "2024-05-03 14:22:00",
"updateTime": "2024-05-03 14:22:00",
"isDeleted": "0",
"newFlag": 0
}
],
"tradeOrderLogisticsRepList": [
{
"id": 0,
"tradeOrderId": 0,
"logisticsMethod": 0,
"logisticsNo": "",
"logisticsCompany": "",
"consignedGoods": "",
"receivingCountry": "",
"departureTime": "",
"createTime": "2024-05-03 14:22:00",
"updateTime": "2024-05-03 14:22:00",
"isDeleted": "0",
"tradeOrderFileRepList": [
{
"id": 0,
"tradeOrderId": 0,
"businessId": 0,
"fileType": 0,
"fileName": "",
"filePath": "",
"version": "",
"createBy": 0,
"source": "来源",
"createTime": "2024-05-03 14:22:00",
"updateTime": "2024-05-03 14:22:00",
"isDeleted": "0"
}
],
"newFlag": 0
}
],
"tradeOrderFileRepList": [
{
"id": 0,
"tradeOrderId": 0,
"businessId": 0,
"fileType": 0,
"fileName": "",
"filePath": "",
"version": "",
"createBy": 0,
"source": "来源",
"createTime": "2024-05-03 14:22:00",
"updateTime": "2024-05-03 14:22:00",
"isDeleted": "0",
"newFlag": 0
}
],
"tradeOrderSupplement": [
{
"id": 0,
"businessId": 0,
"businessType": 0,
"merchantId": 0,
"version": 0,
"noticeMethod": "",
"keepHistoricalFlag": 0,
"createTime": "",
"updateTime": "",
"isDeleted": 0,
"tradeOrderSupplementMaterialList": [
{
"id": 0,
"tradeOrderSupplementId": 0,
"question": "",
"questionType": 0,
"createTime": "",
"updateTime": "",
"isDeleted": 0,
"tradeOrderSupplementMaterialDetails": [
{
"id": 0,
"tradeOrderSupplementMaterialId": 0,
"questionReply": "",
"createTime": "",
"updateTime": "",
"isDeleted": 0
}
]
}
],
"tradeOrderCode": ""
}
]
}
}编辑贸易订单
编辑贸易订单
端点目标 URL
沙盒环境请求地址:POST https://preapi.futurepay-develop.com/api/v1/trade-order/update
生产环境请求地址:POST https://api.futurepay.global/api/v1/trade-order/update
字段说明
调用的特定输入参数
| 字段名 | 必填 | 类型 | 说明 |
|---|---|---|---|
| id | M | Long | 贸易订单ID |
| merchantId | M | Long | 商户ID |
| tradeOrderType | M | Integer | 贸易订单类型:0. 货物贸易;1. 服务贸易 |
| businessId | O | Long | 服务类型ID(服务类型必填) |
| foreignExchangeSettledFlag | M | Integer | 是否需要结汇:0. 否;1. 是 |
| tradeOrderName | M | String | 订单名称 |
| tradeOrderCode | M | String | 订单编码 |
| tradeOrderTotalAmount | M | Number | 贸易订单总额 |
| tradeOrderCurrency | M | String | 贸易订单币种 |
| partnerType | O | String | 合作方官网(服务贸易必填) |
| tradeOrderDate | O | String | 订单时间(货物贸易必填)格式:yyyy-MM-dd |
| fundNature | O | Integer | 资金性质(货物贸易必填):0. 物流费用;1. 一般贸易-代采 2.服务费用 |
| buyerName | M | String | 货物贸易:买家名称;服务贸易:合作方名称 |
| buyerCountry | O | String | 买家国家/地区(货物贸易必填) |
| storeUrl | O | String | 店铺网址(货物贸易必填) |
| tradeOrderItemList | O | List<tradeOrderItemObject> | 贸易订单商品信息(货物贸易必填) |
| isShipped | M | Integer | 是否发货:0. 否;1. 是 货物贸易:是否发货;服务贸易:是否需要物流 |
| tradeOrderLogisticsList | O | List<tradeOrderLogisticsObject> | 物流信息;isShipped=是:必填 |
| remark | O | String | 备注信息 |
| autoPostFlag | M | Integer | 是否自动入账:0. 否;1. 是 |
| tradeOrderFileList | M | List<tradeOrderFileObject> | 附件信息 |
| tradeOrderStatus | M | Integer | 贸易订单状态:0. 保存草稿;1. 立即创建 |
| remitAccName | O | String | 付款人名称 |
| remitAccNo | O | String | 付款人账号 |
| deliveryEtaDate | O | String | 预计发货时间(货物贸易是否发货=否必填)格式:yyyy-MM-dd |
tradeOrderItemObject字段结构
| 字段名 | 必填 | 类型 | 说明 |
|---|---|---|---|
| id | M | Long | 商品信息ID |
| tradeOrderId | M | Long | 贸易订单ID |
| itemName | M | String | 商品名称 |
| quantity | M | String | 数量 |
| unit | M | Integer | 单位:0. 个;1. 件;2. 套;3. 台;4. 箱;5. 千克 |
tradeOrderLogisticsObject字段结构
| 字段名 | 必填 | 类型 | 说明 |
|---|---|---|---|
| id | M | Long | 物流信息ID |
| tradeOrderId | M | Long | 贸易订单ID |
| logisticsMethod | M | Integer | 物流方式:0. 国际快递;1. 海运;2. 空运;3. 陆运;4. 铁路;5. 专线运输;6. 其他; |
| logisticsNo | M | String | 货物贸易:出境物流单号;服务贸易:运单号 |
| logisticsCompany | M | String | 货物贸易:物流公司;服务贸易:运输公司 |
| consignedGoods | O | String | 承运物品(服务贸易必填) |
| receivingCountry | O | String | 收货地(服务贸易必填) |
| departureTime | O | Date | 起运时间(服务贸易必填)格式:yyyy-MM-dd |
| tradeOrderFileList | O | List<tradeOrderFileObject> | 物流附件信息(货物贸易必填) |
tradeOrderFileObject字段结构
| 字段名 | 必填 | 类型 | 说明 |
|---|---|---|---|
| id | M | Long | 物流信息ID |
| tradeOrderId | M | Long | 贸易订单ID |
| businessId | M | Long | 业务ID(根据文件类型存储对应的ID) |
| fileType | M | Integer | 文件类型:0. 发票附件(PO/CI/PO附件);1. 物流单附件;3. 其他材料附件; |
| fileName | M | String | 文件名称 |
| filePath | M | String | 文件地址 |
集成
编辑贸易订单调用输入
{
"id": 0,
"merchantId": 0,
"tradeOrderType": 0,
"businessId": 0,
"foreignExchangeSettledFlag": 1,
"tradeOrderName": null,
"tradeOrderCode": null,
"tradeOrderTotalAmount": 0,
"tradeOrderCurrency": null,
"partnerType": null,
"tradeOrderDate": null,
"fundNature": 0,
"buyerName": null,
"buyerCountry": null,
"storeUrl": null,
"tradeOrderItemList": [
{
"id": 0,
"tradeOrderId": 0,
"itemName": null,
"quantity": null,
"unit": 0
}
],
"isShipped": 1,
"tradeOrderLogisticsList": [
{
"id": 0,
"tradeOrderId": 0,
"logisticsMethod": 0,
"logisticsNo": null,
"logisticsCompany": null,
"consignedGoods": null,
"receivingCountry": null,
"departureTime": null,
"tradeOrderFileList": [
{
"id": 0,
"tradeOrderId": 0,
"businessId": 0,
"fileType": 0,
"fileName": null,
"filePath": null
}
]
}
],
"remark": null,
"autoPostFlag": 1,
"tradeOrderFileList": [
{
"id": 0,
"tradeOrderId": 0,
"businessId": 0,
"fileType": 0,
"fileName": null,
"filePath": null
}
],
"tradeOrderStatus": 0,
"remitAccName": null,
"remitAccNo": null
}编辑贸易订单调用输出
{
"code": "",
"msg": "",
"serverTime": 0,
"data": null
}作废贸易订单
作废贸易订单
端点目标 URL
沙盒环境请求地址:PUT [https://preapi.futurepay-develop.com/api/v1/trade-order/canceled/{id}](https://preapi.futurepay-develop.com/api/v1/virtual-account/queryVaExpandDetail)
生产环境请求地址:PUT [https://api.futurepay.global/api/v1/trade-order/canceled/{id}](https://api.futurepay.global/api/v1/virtual-account/queryVaExpandDetail)
字段说明
调用的特定输入参数
| 字段名 | 类型 | 说明 |
|---|---|---|
| id | Long | 贸易订单ID |
集成
编辑贸易订单调用输出
{
"code": "",
"msg": "",
"serverTime": 0,
"data": null
}删除贸易订单
删除贸易订单
端点目标 URL
沙盒环境请求地址:DELETE https://preapi.futurepay-develop.com/api/v1/trade-order/{id}
生产环境请求地址:DELETE https://api.futurepay.global/api/v1/trade-order/{id}
字段说明
调用的特定输入参数
| 字段名 | 类型 | 说明 |
|---|---|---|
| id | Long | 贸易订单ID |
集成
编辑贸易订单调用输出
{
"code": "",
"msg": "",
"serverTime": 0,
"data": null
}关联贸易订单信息查询
关联贸易订单信息查询
端点目标 URL
沙盒环境请求地址:POST https://preapi.futurepay-develop.com/api/v1/transaction/queryRelateTradeOrderDetail
生产环境请求地址:POST https://api.futurepay.global/api/v1/transaction/queryRelateTradeOrderDetail
字段说明
调用的特定输入参数
| 字段名 | 类型 | 说明 |
|---|---|---|
| id | Long | 收款订单ID |
| searchValue | String | 搜索值(支持贸易订单编号、订单名称、买家名称模糊查询) |
调用的特定输出参数
| 字段名 | 类型 | 说明 |
|---|---|---|
| id | Long | 收款订单ID |
| remitAccName | String | 付款人名称 |
| remitAccNo | String | 付款账号 |
| ccy | String | 币种 |
| relateAmount | Number | 本次最大可关联金额 |
| relateTradeOrderDetailReps | List<relateTradeOrderDetailObject> | 订单收款记录关联关系 |
relateTradeOrderDetailObject字段结构
| 字段名 | 类型 | 说明 |
|---|---|---|
| tradeOrderId | Long | 贸易订单ID |
| remitAccName | String | 付款人名称 |
| remitAccNo | String | 付款人账号 |
| buyerName | String | 货物贸易:买家名称;服务贸易:合作方名称 |
| relateAmount | BigDecimal | 可关联金额 |
| relateOrderAmount | BigDecimal | 已关联金额 |
| approvedTotalAmount | BigDecimal | 订单金额 |
| tradeOrderCurrency | String | 贸易订单币种 |
| relateOrderCount | Integer | 已关联订单数 |
| tradeOrderCode | String | 贸易订单编号 |
| consFlag | Integer | 是否需要补充材料:0. 是;1. 否 |
| tradeOrderType | Integer | 贸易订单类型:0. 货物贸易;1. 服务贸易 |
集成
关联贸易订单信息查询调用输入
{
"id": 1,
"searchValue": ""
}关联贸易订单信息查询调用输出
{
"code": "",
"msg": "",
"serverTime": 0,
"data": {
"id": 0,
"remitAccName": "",
"remitAccNo": "",
"ccy": "",
"relateAmount": 0,
"relateTradeOrderDetailReps": [
{
"tradeOrderId": 0,
"remitAccName": "",
"remitAccNo": "",
"buyerName": "",
"relateAmount": 0,
"relateOrderAmount": 0,
"approvedTotalAmount": 0,
"tradeOrderCurrency": "",
"relateOrderCount": 0,
"tradeOrderCode": "",
"consFlag": 1,
"tradeOrderType": 0
}
]
}
}关联贸易订单
关联贸易订单
端点目标 URL
沙盒环境请求地址:POST https://preapi.futurepay-develop.com/api/v1/trade-order-transaction-rel/associateTradeOrders
生产环境请求地址:POST https://api.futurepay.global/api/v1/trade-order-transaction-rel/associateTradeOrders
字段说明
调用的特定输入参数
| 字段名 | 类型 | 说明 |
|---|---|---|
| tradeOrderId | Long | 贸易订单ID |
| relateAmount | BigDecimal | 关联金额 |
| transactionRecordsId | Long | 收款ID |
| merchantId | Long | 商户ID |
| remark | String | 备注 |
| fileStr | String | 附件 |
| consFlag | Integer | 是否需要补充材料:0. 是;1. 否 |
集成
关联贸易订单调用输入
{
"associateTradeOrderReqs": [
{
"tradeOrderId": 0,
"relateAmount": 0,
"transactionRecordsId": 0,
"merchantId": 0,
"remark": "string",
"fileStr": "string",
"consFlag": 0
}
]
}关联贸易订单调用输出
{
"code": "",
"msg": "",
"serverTime": 0,
"data": null
}贸易订单补充材料查询信息
贸易订单补充材料查询信息
端点目标 URL
沙盒环境请求地址:POST https://preapi.futurepay-develop.com/api/v1/trade-order-supplement/selectNewestVersion
生产环境请求地址:POST https://api.futurepay.global/api/v1/trade-order-supplement/selectNewestVersion
字段说明
调用的特定输入参数
| 字段名 | 类型 | 说明 |
|---|---|---|
| businessId | Long | 贸易订单ID |
| businessType | Integer | 业务类型,固定传0 |
调用的特定输出参数
| 字段名 | 类型 | 说明 |
|---|---|---|
| id | Long | 主键 |
| businessId | Long | 业务ID |
| businessType | Integer | 业务类型:0. 贸易订单;1. 收款订单 |
| merchantId | Long | 商户ID |
| version | Integer | 版本 |
| noticeMethod | String | 通知方式:messages、email |
| keepHistoricalFlag | Integer | 是否保留历史问题:0. 是;1. 否 |
| createTime | Date | 创建时间 |
| updateTime | Date | 修改时间 |
| isDeleted | Integer | 是否删除:0. 未删除;1. 已删除 |
| tradeOrderSupplementMaterialList | List<tradeOrderSupplementMaterialObject> | 问题集合 |
tradeOrderSupplementMaterialObject字段结构
| 字段名 | 必填 | 类型 | 说明 |
|---|---|---|---|
| id | M | Long | 问题ID |
| tradeOrderSupplementId | M | Long | 补充信息ID |
| question | M | String | 问题 |
| questionType | M | Integer | 问题类型 |
| createTime | M | Date | 创建时间 |
| updateTime | M | Date | 修改时间 |
| isDeleted | M | Integer | 是否删除:0. 未删除;1. 已删除 |
集成
贸易订单补充材料查询信息调用输入
{
"businessId": 111,
"businessType": 0
}贸易订单补充材料查询信息调用输出
{
"data": {
"id": 0,
"businessId": 0,
"businessType": 0,
"merchantId": 0,
"version": 0,
"noticeMethod": "string",
"keepHistoricalFlag": 0,
"createTime": "string",
"updateTime": "string",
"isDeleted": 0,
"tradeOrderSupplementMaterialList": [
{
"id": 0,
"tradeOrderSupplementId": 0,
"question": "string",
"questionType": 0,
"createTime": "string",
"updateTime": "string",
"isDeleted": 0
}
]
}
}关联贸易订单补充材料查询信息
关联贸易订单补充材料查询信息
端点目标 URL
沙盒环境请求地址:POST https://preapi.futurepay-develop.com/api/v1/trade-order-supplement/selectBatchNewestVersion
生产环境请求地址:POST https://api.futurepay.global/api/v1/trade-order-supplement/selectBatchNewestVersion
字段说明
调用的特定输入参数
| 字段名 | 类型 | 说明 |
|---|---|---|
| businessIds | List<Long> | 贸易订单ID集合 |
| businessType | Integer | 业务类型,固定传1 |
调用的特定输出参数
| 字段名 | 类型 | 说明 |
|---|---|---|
| id | Long | 主键 |
| businessId | Long | 业务ID |
| businessType | Integer | 业务类型:0. 贸易订单;1. 收款订单 |
| merchantId | Long | 商户ID |
| version | Integer | 版本 |
| noticeMethod | String | 通知方式:messages、email |
| keepHistoricalFlag | Integer | 是否保留历史问题:0. 是;1. 否 |
| createTime | Date | 创建时间 |
| updateTime | Date | 修改时间 |
| isDeleted | Integer | 是否删除:0. 未删除;1. 已删除 |
| tradeOrderSupplementMaterialList | List<tradeOrderSupplementMaterialObject> | 问题集合 |
| tradeOrderCode | String | 贸易订单编号 |
tradeOrderSupplementMaterialObject字段结构
| 字段名 | 必填 | 类型 | 说明 |
|---|---|---|---|
| id | M | Long | 问题ID |
| tradeOrderSupplementId | M | Long | 补充信息ID |
| question | M | String | 问题 |
| questionType | M | Integer | 问题类型:0.文本;1.文件 |
| createTime | M | Date | 创建时间 |
| updateTime | M | Date | 修改时间 |
| isDeleted | M | Integer | 是否删除:0. 未删除;1. 已删除 |
集成
关联贸易订单补充材料查询信息调用输入
{
"businessIds": [1,2,3],
"businessType": 0
}关联贸易订单补充材料查询信息调用输出
{
"data": [
{
"id": 0,
"businessId": 0,
"businessType": 0,
"merchantId": 0,
"version": 0,
"noticeMethod": "string",
"keepHistoricalFlag": 0,
"createTime": "string",
"updateTime": "string",
"isDeleted": 0,
"tradeOrderSupplementMaterialList": [
{
"id": 0,
"tradeOrderSupplementId": 0,
"question": "string",
"questionType": 0,
"createTime": "string",
"updateTime": "string",
"isDeleted": 0
}
],
"tradeOrderCode": "string"
}
]
}贸易订单补充材料回复
贸易订单补充材料回复
端点目标 URL
沙盒环境请求地址:POST https://preapi.futurepay-develop.com/api/v1/trade-order-supplement-detail/insert
生产环境请求地址:POST https://api.futurepay.global/api/v1/trade-order-supplement-detail/insert
字段说明
调用的特定输入参数
| 字段名 | 类型 | 说明 |
|---|---|---|
| businessId | Long | 贸易订单ID |
| businessType | Integer | 业务类型,固定传0 |
| supleMenterialDetailReqs | List<supleMenterialDetailObject> | 补充材料集合 |
supleMenterialDetailObject字段结构
| 字段名 | 类型 | 说明 |
|---|---|---|
| tradeOrderSupplementMaterialId | Long | 补充材料ID |
| questionReply | String | 补充回复内容 传参说明: 文本格式:1111 文件格式:"[{"fileName":"1.pdf","fileUrl":"xxxxxx.pdf"}]" |
集成
贸易订单补充材料回复调用输入
{
"businessId": 0,
"businessType": 0,
"supleMenterialDetailReqs": [
{
"tradeOrderSupplementMaterialId": 0,
"questionReply": null
}
]
}贸易订单补充材料回复调用输出
{
"code": "",
"msg": "",
"serverTime": 0,
"data": null
}关联贸易订单补充材料回复
关联贸易订单补充材料回复
端点目标 URL
沙盒环境请求地址:POST https://preapi.futurepay-develop.com/api/v1/trade-order-supplement-detail/batchInsert
生产环境请求地址:POST https://api.futurepay.global/api/v1/trade-order-supplement-detail/batchInsert
字段说明
调用的特定输入参数
| 字段名 | 类型 | 说明 |
|---|---|---|
| businessId | Long | 贸易订单ID |
| businessType | Integer | 业务类型,固定传0 |
| supleMenterialDetailReqs | List<supleMenterialDetailObject> | 补充材料集合 |
supleMenterialDetailObject字段结构
| 字段名 | 类型 | 说明 |
|---|---|---|
| tradeOrderSupplementMaterialId | Long | 补充材料ID |
| questionReply | String | 补充回复内容 传参说明: 文本格式:1111 文件格式:"[{"fileName":"1.pdf","fileUrl":"xxxxxx.pdf"}]" |
集成
关联贸易订单补充材料回复调用输入
{
"tradeOrderSupplementMaterialDetails": [
{
"businessId": 0,
"businessType": 0,
"supleMenterialDetailReqs": [
{
"tradeOrderSupplementMaterialId": 0,
"questionReply": null
}
]
}
]
}关联贸易订单补充材料回复调用输出
{
"code": "",
"msg": "",
"serverTime": 0,
"data": null
}Updated about 1 month ago