字段

名称

类型

描述

process_status

退换单处理状态

string

退换单处理状态 5 补款 10已取消 20待审核 30已同意 40已拒绝 50待财审 60待收货 63待推送 64推送失败 65委外待收货 69待收货(已结算) 70部分到货 71部分到货(已结算) 80待结算 90已完成

time_type

时间类型

string

0，最后更新时间，1，结算时间。默认值0

start_time

开始时间

string

按最后修改（结算）时间增量获取数据,start_time作为开始时间，格式：yyyy-MM-dd HH:mm:ss

end_time

结束时间

string

按最后修改时间（结算）增量获取数据,end_time作为结束时间，格式：yyyy-MM-dd HH:mm:ss

page_size

分页大小

string

每页返回的数据条数，输入值范围140，不传本参数，输入值默认为40，使用举例单击这里

shop_no

店铺编号

string

店铺编号

page_no

页号

string

不传值默认从0页开始

refund_no

Erp内退换单编号

string

Erp内退换单编号，传该字段可以不传时间

src_refund_no

平台原始退换单号

string

平台原始退换单号，传该字段可以不传时间

trade_no

系统订单编号

string

系统订单编号，传该字段可以不传时间

tid

原始单号

string

原始单号，传该字段可以不传时间

字段

名称

类型

描述

modified

最后修改时间

string

最后修改时间 格式：yyyy-MM-dd HH:mm:ss

refund_id

退换单主键

string

退换单主键

refund_no

erp退换单号

string

erp退换单号，默认TK开头

finish_time

结算时间

string

旺店通内操作结算的时间 格式：yyyy-MM-dd HH:mm:ss

customer_no

客户档案编号

string

客户档案编号

api_outer_no

API单号

string

接口创建退换单的外部单号

platform_id

平台类型

string

平台类型，响应值为代表平台的ID数字，ID对应的平台名称单击这里

customer_name

收件人姓名

string

收件人姓名（如需唯一值，以receiver_name为准）

src_no

平台退款单号

string

平台退款单号

swap_zip

收件人邮编

string

收件人邮编

swap_logistics_type

换货新订单物流公司类别

string

响应值为代表换货新订单物流公司类别的数字，数字对应的物流公司类别名称单击这里

type

类型

string

1退款(未发货，退款申请)2退货3换货4退款不退货5订单补款

process_status

处理状态

string

5补款10已取消20待审核30已同意40已拒绝50待财审60待收货63待推送64推送失败65委外待收货69待收货(已结算)70部分到货71部分到货(已结算)80待结算90已完成

swap_logistics_name

换货新订单物流公司名称

string

换货新订单物流公司名称

creator_name

建单员姓名

string

建单员姓名

status

平台状态

string

平台状态0表示为空，1取消退款，2已申请退款，3等待退货，4等待收货，5退款成功，10换货待处理，20待买家退货，30买家已退货待收货，40待买家修改，50待发出换货商品，55待买家收货，60换货改退货，70换货关闭，80换货成功

guarantee_mode

担保方式

string

担保方式1担保交易2非担保交易3非担保在线交易（ecshop）

error_msg

逆向物流错误信息

string

逆向物流错误信息

cs_status

退款阶段

string

退款阶段 0售中 1售后

created

创建时间

string

创建时间

shop_no

店铺编号

string

代表店铺所有属性的唯一编码，用于店铺区分，ERP内支持自定义（ERP店铺界面设置）

outer_no

外部编号

string

默认为''，外部编号,与wms对接使用

shop_name

店铺名称

string

店铺名称

swap_trade_id

换出原始单id

string

换出原始单id

warehouse_id

仓库id

string

默认为'0'，期望退回的仓库

pay_account

买家支付帐号

string

买家支付帐号

shop_id

店铺id

string

店铺id

pay_no

支付订单号

string

支付订单号

advance_status

预先状态

string

goods_amount

退货金额

string

退货金额

refund_amount

买家申请退款金额

string

买家申请退款金额

is_goods_received

是否收到货品

string

默认为'0'，买家是否收到货

customer_id

客户id

string

默认为'0'，客户id

direct_refund_amount

线下退款金额

string

订单确认收货之后的退款金额

guarante_refund_amount

平台退款金额

string

平台退款金额

swap_warehouse_id

换出仓库id

string

默认为'0'，换出货品出库仓库

actual_refund_amount

实际退款/收款金额

string

实际退款/收款金额

swap_logistics_id

换出物流id

string

默认为'0'，换货新订单物流公司ID

warehouse_type

仓库类型

string

exchange_amount

换货金额

string

换货金额

post_amount

邮费金额

string

邮费金额

wms_status

wms状态

string

默认为'0'，外部状态,与wms对接使用0初始化1失败2成功

other_amount

其它金额

string

其它金额

wms_result

wms结果

string

默认为''，外部结果,与wms对接使用

wms_outer_no

外部仓库的单号

string

默认为''，对应外部仓库的单号

paid

已退款/已收款

string

已退款/已收款

from_type

建立方式

string

默认为'1'，建立方式1api抓单2手式建单3外部导入4天猫换货5菜鸟回传自动创建

tid

订单的原始单号

string

订单的原始单号

sales_trade_id

系统订单ID

string

系统订单ID

return_goods_count

退回货品数量

string

默认为'0'，退回货品数量

sales_tid

系统订单号

string

系统订单编号，默认单号为JY开头，ERP内支持自定义（设置路径：设置——编码设置）

op_constraint

约束

string

默认为'0'，1不允许拒绝2需要到网页版操作

buyer_nick

昵称

string

昵称

refund_version

退款版本

string

默认为''，退款版本,大于0后表明已经从平台下载完成，退款单不可修改

receiver_name

收件人姓名

string

收件人姓名

consign_mode

发货方式

string

默认为'0'，发货方式：0默认1审核退款单后立即生成换货订单2退货完成后生成换货订单

receiver_address

收件人地址

string

收件人地址

logistics_name

物流公司名称

string

默认为''，物流公司名称

receiver_telno

收件人电话

string

收件人电话

logistics_no

物流单号

string

默认为''，物流单号

push_no

物流递交单号

string

默认为''，物流递交单号

return_name

退货人姓名

string

退货人姓名

return_mobile

退货人手机号

string

退货人手机号

logistics_style

物流形式

string

默认为'0'，取件方式:0客户取件，1顺丰取件，2拒收退回

reason_id

原因

string

默认为'0'，原因

return_telno

退货人电话

string

退货人电话

revert_reason

驳回原因

string

默认为'0'，驳回原因

return_address

退回仓库地址

string

退回仓库地址

return_logistics_name

退回物流公司名称

string

退回物流公司名称

bad_reason

错误原因

string

默认为'0'，错误原因

return_mask

返回标志

string

return_logistics_no

退回物流单号

string

退回物流单号

swap_receiver

换货收件人姓名

string

换货收件人姓名

is_trade_charged

是否结算后生成订单

string

默认为'0'，是否结算后生成订单

swap_mobile

换收发件人姓名手机

string

换收发件人姓名手机

stockin_pre_no

预入库单

string

默认为''，预入库单

swap_telno

换货收件人姓名电话

string

换货收件人姓名电话

revert_reason_info

驳回原因名称

string

驳回原因名称

refund_order_list

退款子订单信息

array

退款子订单信息,refund_order_list结构

refund_order_list.order_id

货品明细主键

string

退换单退回货品明细主键

refund_order_list.refund_id

退换单主键

string

退换单主键

refund_order_list.oid

原始子订单id

string

原始子订单编号

refund_order_list.tid

订单子订单的原始单号

string

订单子订单的原始单号

refund_order_list.src_no

平台退款单号

string

平台退款单号

refund_order_list.process_status

处理状态

string

处理状态0已取消10待递交20待审核30已同意40已拒绝50待财审60待收货70部分到货80已完成

refund_order_list.sales_tid

销售订单编号

string

销售订单编号

refund_order_list.order_num

实际数量

string

实际数量

refund_order_list.price

价格

string

价格

refund_order_list.platform_id

平台类型

string

平台类型，响应值为代表平台的ID数字，ID对应的平台名称单击这里

refund_order_list.cost_price

成本价

string

成本价

refund_order_list.original_price

原价

string

原价

refund_order_list.discount

优惠

string

优惠

refund_order_list.paid

已付金额

string

已付金额

refund_order_list.market_price

单品市场价

string

单品市场价

refund_order_list.refund_num

退款数量

string

退款数量

refund_order_list.refund_order_amount

明细退款金额

string

明细退款金额，由主单退款金额分摊

refund_order_list.total_amount

退货金额

string

退货金额

refund_order_list.spec_id

erp商品主键

string

erp商品主键

refund_order_list.spec_no

商家编码

string

代表单品(sku)所有属性的唯一编码，用于系统单品区分，SKU概念介绍,单击这里

字段

名称

类型

描述

resubmitCheckKey

保证请求的幂等性

string

保证请求的幂等性,该值由客户端生成,并且必须是全局唯一的，长度不能超过32位。更多信息,请参见«MDD幂等性»

code

单据编码

string

单据编码，以系统编码规则配置为准：系统设置为手工编号时必输，系统设置为自动编号时非必输；修改时必传 示例："S0T5-0000000000-20210831-000000"

salesOrgId

销售组织

string

销售组织，传id或者code 示例：2163951720681984

transactionTypeId

交易类型

string

交易类型，传id或者code 示例：2155547426656517

agentId

客户

string

客户，传id或者code 示例：2251598175195392

retailInvestors

是否散户

string

是否散户, true:是、false:否、 示例：false

headFreeItem!define2

销售类型

string

saleDepartmentId

销售部门

string

销售部门，传id或者code 示例："2163953113665792"

vouchdate

单据日期

string

单据日期 示例："2021-08-31 00:00:00"

corpContact

销售业务员

string

销售业务员 示例："2163960865427712"

settlementOrgId

开票组织

string

开票组织，传id或者code 示例："2163951720681984"

currency

币种

string

币种，传id或者code 示例："2155547424560384"

exchangeRateType

汇率类型

string

汇率类型，传id或者code 示例："csrka3z7"

natCurrency

本币

string

本币，传id或者code 示例："2155547424560384"

retailAgentName

散户名称

string

散户名称 示例："散户2"

saleReturnMemo

备注

object

备注

saleReturnMemo.remark

备注

string

备注 示例："销售退货"

saleReturnMemo.refundStatus

退货单退款状态

string

退货单退款状态，由系统业务自动生成，接口无需传值。 示例："NONE"

saleReturnMemo.refundAmount

退款金额

string

退款金额 示例：1

saleReturnMemo.isWfControlled

是否受审批流控制

string

是否受审批流控制 示例：false

saleReturnMemo.exchRate

汇率

string

汇率 示例：1

saleReturnMemo.taxInclusive

单价含税

string

单价含税, true:是、false:否、 示例：true

saleReturnMemo.saleReturnSourceType

退货类型

string

退货类型, NONE:无来源、DELIVERYEND:销售出库单、ORDER:销售订单 示例："DELIVERYEND"

saleReturnMemo.bizFlow_name

流程名称

string

流程名称 示例："001"

saleReturnMemo.bizFlow_version

版本信息

string

版本信息 示例："版本1"

saleReturnMemo.logisticWayId

物流公司id

string

物流公司id 示例：321321

saleReturnMemo.invoiceAgentId

开票客户

string

开票客户，传id或者code 示例：2216247878177024

saleReturnMemo.realMoney

应付金额

string

应付金额，等于表头的退货金额 示例：100

saleReturnMemo.modifyInvoiceType

发票类型是否可改

string

发票类型是否可改, true:是、false:否、 示例：true

saleReturnMemo.logisticsBillNo

物流单号

string

物流单号 示例："4321"

saleReturnMemo.logisticsUserName

司机姓名

string

司机姓名 示例："王一"

saleReturnMemo.logisticsUserPhone

司机电话

string

司机电话 示例："18888888888"

saleReturnMemo.logisticsCarNum

车牌号

string

车牌号 示例："京A-ax245"

saleReturnMemo.receiver

收货人

string

收货人 示例："王二"

saleReturnMemo.receiveMobile

收货人移动电话

string

收货人移动电话 示例："010-12345678"

saleReturnMemo.receiveTelePhone

收货人固定电话

string

收货人固定电话 示例："1555555555"

saleReturnMemo.receiveAddress

收货地址

string

收货地址 示例："北京市海淀区"

saleReturnMemo.receiveZipCode

收货人邮编

string

收货人邮编 示例："011"

saleReturnMemo.bdInvoiceTypeId

发票类型

string

0:收据,1:增值税电子普通发票,2:增值税电子专用发票,3:增值税普通发票,4:增值税专用发票,5:机动车销售统一发票,8:增值税电子普通发票（成品油）,10:增值税普通发票（成品油）,11:增值税专用发票（成品油）,e0:电子收购发票 示例：0

saleReturnMemo.invoiceUpcType

发票类型

string

发票类型, 0:收据、1:增值税专用发票、2:增值税普通发票、3:增值税电子普通发票、4:机动车销售销售统一发票、 示例：0

saleReturnMemo.invoiceTitleType

抬头类型

string

抬头类型, 0:企业、1:个人、2:非营利组织、 示例：0

saleReturnMemo.invoiceTitle

发票抬头

string

发票抬头 示例："中央大客户工信部"

saleReturnMemo.taxNum

纳税识别号

string

纳税识别号 示例："SH999000999"

saleReturnMemo.bankName

开户银行

string

开户银行 示例："中国工商银行"

saleReturnMemo.subBankName

开户支行

string

开户支行 示例："中国工商银行股份有限公司天津中北支行"

saleReturnMemo.bankAccount

账号

string

账号 示例："888888888888888"

saleReturnMemo.invoiceTelephone

营业电话

string

营业电话 示例："012-9998893"

saleReturnMemo.invoiceAddress

营业地址

string

营业地址 示例："北京市海淀区"

saleReturnMemo.totalMoney

总金额

string

总金额 示例：43214

saleReturnMemo.payMoney

退货金额

string

退货金额，需等于表体含税金额的合计 示例：312

saleReturnMemo.totalMoneyOrigTaxfree

无税总金额

string

无税总金额 示例：321

saleReturnMemo.payMoneyOrigTaxfree

无税退货金额

string

无税退货金额 示例：321

saleReturnMemo.totalOriTax

税额

string

税额 示例：3

saleReturnMemo.totalMoneyDomestic

本币总金额

string

本币总金额 示例：643256

saleReturnMemo.payMoneyDomestic

本币退货金额

string

本币退货金额 示例：5432

saleReturnMemo.totalMoneyDomesticTaxfree

本币无税总金额

string

本币无税总金额 示例：5432

saleReturnMemo.payMoneyDomesticTaxfree

本币无税退货金额

string

本币无税退货金额 示例：5432

saleReturnMemo.totalNatTax

本币税额

string

本币税额 示例：5421

saleReturnMemo.bizFlow

流程ID

string

流程ID 示例：213

saleReturnMemo.isFlowCoreBill

是否流程核心单据

string

是否流程核心单据 示例：true

saleReturnMemo.status

操作标识

string

操作标识, Insert:新增、Update:更新 示例："Insert"

saleReturnMemo.saleReturnDetails

退货单详情

array

退货单详情[voucher.salereturn.SaleReturnDetail]

saleReturnMemo.saleReturnDetails.id

表体行ID

string

表体行ID 新增时无需填写，修改时必填 示例：4312432

saleReturnMemo.saleReturnDetails.orderDetailId

订单行id

string

订单行id，有来源必填 示例：2403153858154753

saleReturnMemo.saleReturnDetails.orderDetailIdKey

订单行idkey

string

订单行idkey 示例："6425432"

saleReturnMemo.saleReturnDetails.sourceid

来源单据ID

string

来源单据ID，有来源必填 示例：2403160486547968

saleReturnMemo.saleReturnDetails.sourceautoid

来源单据子表ID

string

来源单据子表ID，有来源必填 示例：2403160486547970

saleReturnMemo.saleReturnDetails.source

来源单据类型

string

来源单据类型（1.ustock.st_salesout销售出库 2.voucher_order 销售订单）有来源必填 示例："ustock.st_salesout"

saleReturnMemo.saleReturnDetails.makeRuleCode

生单类型编码

string

生单类型编码（1.salesoutTosalereturn 由销售出库生单，2.order_salereturn:由销售订单生单），有来源必填 示例："salesoutTosalereturn"

saleReturnMemo.saleReturnDetails.productId

商品

string

商品，传id或者code 示例：2320711092457728

saleReturnMemo.saleReturnDetails.skuId

商品sku

string

商品sku，传id或者code 示例：2313763385315584

saleReturnMemo.saleReturnDetails.projectId

项目

string

项目，传id或者code 示例："123124312"

saleReturnMemo.saleReturnDetails.unitExchangeType

浮动换算率（销售）

string

浮动换算率（销售） 示例：0

saleReturnMemo.saleReturnDetails.unitExchangeTypePrice

浮动换算率（计价）

string

浮动换算率（计价） 示例：0

saleReturnMemo.saleReturnDetails.taxId

税目税率

string

税目税率，传id或者code 示例："2155547427149061"

saleReturnMemo.saleReturnDetails.stockId

仓库

string

仓库，传id或者code 示例：2192242573644032

saleReturnMemo.saleReturnDetails.stockOrgId

库存组织

string

库存组织，传id或者code 示例："2163951720681984"

saleReturnMemo.saleReturnDetails.saleReturnDepartmentId

退货部门id

string

退货部门id 示例："14321"

saleReturnMemo.saleReturnDetails.iProductAuxUnitId

销售单位

string

销售单位，传id或者code 示例：2263072523178240

saleReturnMemo.saleReturnDetails.iProductUnitId

计价单位

string

计价单位，传id或者code 示例：2312582309908736

saleReturnMemo.saleReturnDetails.masterUnitId

主计量单位

string

主计量单位，传id或者code 示例：2261943548399872

saleReturnMemo.saleReturnDetails.orderProductType

商品类型

string

商品类型, SALE:销售品、GIFT:赠品、MARKUP:加价购、REBATE:返利商品、 示例："SALE"

saleReturnMemo.saleReturnDetails.bizProductId

商家商品id

string

商家商品id 示例：31243141

saleReturnMemo.saleReturnDetails.salesOrgId

销售组织

string

销售组织，传id或者code 示例：6425432

saleReturnMemo.saleReturnDetails.enable

是否有效状态

string

是否有效状态 示例：true

saleReturnMemo.saleReturnDetails.orderNo

源头订单号

string

源头订单号，有来源必填 示例："QbOJ-000000000-20210825-000017"

saleReturnMemo.saleReturnDetails.upcode

来源单据号

string

来源单据号 示例："XSCK20210825000005"

saleReturnMemo.saleReturnDetails.modelDescription

规格

string

规格 示例："规格01"

saleReturnMemo.saleReturnDetails.model

型号

string

型号 示例："001"

saleReturnMemo.saleReturnDetails.specDescription

规格描述

string

规格描述 示例："规格"

saleReturnMemo.saleReturnDetails.invExchRate

销售换算率

string

销售换算率 示例：1

saleReturnMemo.saleReturnDetails.subQty

退货销售数量

string

退货销售数量 示例：100

saleReturnMemo.saleReturnDetails.invPriceExchRate

计价换算率

string

计价换算率 示例：1

saleReturnMemo.saleReturnDetails.priceQty

退货计价数量

string

退货计价数量 示例：100

saleReturnMemo.saleReturnDetails.qty

退货数量

string

退货数量 示例：1

saleReturnMemo.saleReturnDetails.batchNo

批次

string

批次 示例：2

saleReturnMemo.saleReturnDetails.isExpiryDateManage

是否有效期管理

string

是否有效期管理, true:是、false:否、 示例：false

saleReturnMemo.saleReturnDetails.productDate

生产日期

string

生产日期 示例：2021-08-31 00:00:00

saleReturnMemo.saleReturnDetails.expireDateNo

保质期

string

保质期 示例：3