/basicOpen/openapi/multiplatform/shopify/returnOrder/list{
"operation": {
"method": "POST",
"path": "/basicOpen/openapi/multiplatform/shopify/returnOrder/list"
},
"protocol": "HTTPS",
"host": "https://openapi.lingxing.com",
"rateLimit": {
"tokenBucketCapacity": 1,
"text": ""
},
"requestExample": "curl --location 'https://openapi.lingxing.com/basicOpen/openapi/multiplatform/shopify/returnOrder/list?access_token=value×tamp=value&sign=value&app_key=value' \\\n--header 'Content-Type: application/json' \\\n--data '{\"dateType\":0.0,\"endDate\":\"\",\"pageNum\":0.0,\"pageSize\":0.0,\"refundStatusList\":[],\"returnReasonList\":[],\"returnStatusList\":[],\"returnTypeList\":[],\"searchMultiValue\":[],\"searchSingleValue\":\"\",\"searchType\":0.0,\"sortField\":\"\",\"sortType\":\"\",\"startDate\":\"\",\"storeIdList\":[]}'",
"responseExample": "{\n\t\"code\":0,\n\t\"message\":\"success\",\n\t\"error_details\":[],\n\t\"request_id\":\"a0d54debf93140f3b58d1ed81e8e3583\",\n\t\"response_time\":\"2026-07-10 12:00:00\",\n\t\"data\":{\n\t\t\"current\":0,\n\t\t\"list\":[\n\t\t\t{\n\t\t\t\t\"firstRefundTimeLocale\":\"\",\n\t\t\t\t\"firstReturnTimeLocale\":\"\",\n\t\t\t\t\"items\":[\n\t\t\t\t\t{\n\t\t\t\t\t\t\"localSku\":\"\",\n\t\t\t\t\t\t\"pname\":\"\",\n\t\t\t\t\t\t\"productImageUrl\":\"\",\n\t\t\t\t\t\t\"refundAmount\":0,\n\t\t\t\t\t\t\"refundCurrency\":\"\",\n\t\t\t\t\t\t\"refundSymbol\":\"\",\n\t\t\t\t\t\t\"restockingFee\":0,\n\t\t\t\t\t\t\"restockingFeeCurrency\":\"\",\n\t\t\t\t\t\t\"restockingFeeSymbol\":\"\",\n\t\t\t\t\t\t\"returnQuantity\":0.0,\n\t\t\t\t\t\t\"returnReason\":\"\",\n\t\t\t\t\t\t\"sku\":\"\",\n\t\t\t\t\t\t\"title\":\"\",\n\t\t\t\t\t\t\"variantId\":\"\"\n\t\t\t\t\t}\n\t\t\t\t],\n\t\t\t\t\"orderCreatedAtLocale\":\"\",\n\t\t\t\t\"orderId\":\"\",\n\t\t\t\t\"orderName\":\"\",\n\t\t\t\t\"otherRefundAmount\":0,\n\t\t\t\t\"refundItemAmount\":0,\n\t\t\t\t\"refundNote\":\"\",\n\t\t\t\t\"refundStatus\":\"\",\n\t\t\t\t\"refundStatusName\":\"\",\n\t\t\t\t\"returnShippingCurrency\":\"\",\n\t\t\t\t\"returnShippingSymbol\":\"\",\n\t\t\t\t\"returnStatus\":\"\",\n\t\t\t\t\"returnTypeList\":[],\n\t\t\t\t\"storeId\":0,\n\t\t\t\t\"storeName\":\"\",\n\t\t\t\t\"totalRefundedAmount\":0,\n\t\t\t\t\"totalRefundedCurrency\":\"\",\n\t\t\t\t\"totalRefundedSymbol\":\"\",\n\t\t\t\t\"totalReturnShippingFee\":0\n\t\t\t}\n\t\t],\n\t\t\"pages\":0,\n\t\t\"size\":0,\n\t\t\"total\":0\n\t}\n}```"
}| 序号 | 字段 | 名称 | 类型 | 默认值 | 必填 | 描述 |
|---|---|---|---|---|---|---|
| 1 | startDate | 开始时间 | string | — | 必填 | 开始时间,格式 yyyy-MM-dd 或 yyyy-MM-dd HH:mm:ss |
| 2 | endDate | 结束时间 | string | — | 必填 | 结束时间,格式 yyyy-MM-dd 或 yyyy-MM-dd HH:mm:ss |
| 3 | dateType | 时间类型 | number | — | 必填 | 时间类型:1-订购时间 2-退款时间 3-退货时间 查询时间范围不超过一年 |
| 4 | pageNum | 查询起始位置 | number | — | 可选 | 查询起始位置 |
| 5 | pageSize | 分页大小 | number | — | 可选 | 分页大小 |
| 6 | refundStatusList | 退款状态 | array<any> | — | 可选 | 退款状态:PENDING / PARTIALLY_REFUNDED / REFUNDED |
| 7 | returnReasonList | 退货原因(子行过滤) | array<any> | — | 可选 | 退货原因(子行过滤):COLOR / DEFECTIVE / NOT_AS_DESCRIBED / SIZE_TOO_LARGE / SIZE_TOO_SMALL / STYLE / UNWANTED / WRONG_ITEM / UNKNOWN / OTHER |
| 8 | returnStatusList | 退货状态 | array<any> | — | 可选 | 退货状态:IN_PROGRESS / INSPECTION_COMPLETE / NO_RETURN / RETURN_FAILED / RETURN_REQUESTED / RETURNED |
| 9 | returnTypeList | 售后类型筛选 | array<any> | — | 可选 | 售后类型筛选:refund(退款)/ return(退货),支持多选 |
| 10 | searchMultiValue | 批量精确搜索关键词列表(换行分隔后传入) | array<any> | — | 可选 | 批量精确搜索关键词列表(换行分隔后传入) |
| 11 | searchSingleValue | 单个模糊搜索关键词 | string | — | 可选 | 单个模糊搜索关键词 |
| 12 | searchType | 搜索字段类型 | number | — | 可选 | 搜索字段类型:1-平台订单号 2-商品标题 3-MSKU 4-变体ID 5-SKU 6-品名 |
| 13 | sortField | 排序字段 | string | — | 可选 | 排序字段:orderCreatedAtLocale(默认) / firstRefundTimeLocale / firstReturnTimeLocale |
| 14 | sortType | 排序方式 | string | — | 可选 | 排序方式:asc / desc,默认 desc |
| 15 | storeIdList | 店铺ID列表 | array<any> | — | 可选 | 店铺ID列表 |
| 序号 | 字段 | 名称 | 类型 | 默认值 | 必填 | 描述 |
|---|---|---|---|---|---|---|
| 1 | code | 状态码 | integer | 0 | 必填 | 状态码,0:成功 |
| 2 | message | 消息提示 | string | success | 必填 | 消息提示 |
| 3 | error_details | 数据校验失败时的错误详情 | array<any> | — | 必填 | 数据校验失败时的错误详情 |
| 4 | request_id | 请求链路id | string | a0d54debf93140f3b58d1ed81e8e3583 | 必填 | 请求链路id |
| 5 | response_time | 响应时间 | string | 2026-07-10 12:00:00 | 必填 | 响应时间 |
| 6 | data | 响应数据 | object | — | 必填 | 响应数据 |
| 6.1 | current | current | integer | — | 必填 | |
| 6.2 | list | list | array<object> | — | 必填 | |
| 6.2.1 | firstRefundTimeLocale | 退款时间(站点本地时间) | string | — | 必填 | 退款时间(站点本地时间) |
| 6.2.2 | firstReturnTimeLocale | 退货时间(站点本地时间) | string | — | 必填 | 退货时间(站点本地时间) |
| 6.2.3 | items | 商品明细列表 | array<object> | — | 必填 | 商品明细列表 |
| 6.2.3.1 | localSku | localSku | string | — | 必填 | SKU(关联 all_product_info.local_sku) |
| 6.2.3.2 | pname | pname | string | — | 必填 | 品名(关联 all_product_info.pname) |
| 6.2.3.3 | productImageUrl | 商品图片URL(TODO | string | — | 必填 | 商品图片URL(TODO:通过 feign 实时获取) |
| 6.2.3.4 | refundAmount | 商品退款金额 | integer | — | 必填 | 商品退款金额 |
| 6.2.3.5 | refundCurrency | 退款币种 | string | — | 必填 | 退款币种 |
| 6.2.3.6 | refundSymbol | 退款币种符号 | string | — | 必填 | 退款币种符号 |
| 6.2.3.7 | restockingFee | 退货手续费 | integer | — | 必填 | 退货手续费 |
| 6.2.3.8 | restockingFeeCurrency | 退货手续费币种 | string | — | 必填 | 退货手续费币种 |
| 6.2.3.9 | restockingFeeSymbol | 退货手续费币种符号 | string | — | 必填 | 退货手续费币种符号 |
| 6.2.3.10 | returnQuantity | 退货数量 | number | — | 必填 | 退货数量 |
| 6.2.3.11 | returnReason | 退货原因 | string | — | 必填 | 退货原因 |
| 6.2.3.12 | sku | sku | string | — | 必填 | MSKU |
| 6.2.3.13 | title | 商品标题 | string | — | 必填 | 商品标题 |
| 6.2.3.14 | variantId | 变体ID | string | — | 必填 | 变体ID |
| 6.2.4 | orderCreatedAtLocale | 订购时间(站点本地时间) | string | — | 必填 | 订购时间(站点本地时间) |
| 6.2.5 | orderId | 平台订单号 | string | — | 必填 | 平台订单号,7047273152793 |
| 6.2.6 | orderName | 平台参考号 | string | — | 必填 | 平台参考号,如 #1346 |
| 6.2.7 | otherRefundAmount | otherRefundAmount | integer | — | 必填 | 其他退款(totalRefundedAmount - refundItemAmount,Service 层计算) |
| 6.2.8 | refundItemAmount | refundItemAmount | integer | — | 必填 | 商品退款金额(items 中 refundAmount 的合计,Service 层计算) |
| 6.2.9 | refundNote | 退款备注 | string | — | 必填 | 退款备注 |
| 6.2.10 | refundStatus | 退款状态原始值 | string | — | 必填 | 退款状态原始值 |
| 6.2.11 | refundStatusName | 退款状态 | string | — | 必填 | 退款状态:未退款 / 部分退款 / 全额退款 |
| 6.2.12 | returnShippingCurrency | 退货运费币种 | string | — | 必填 | 退货运费币种 |
| 6.2.13 | returnShippingSymbol | 退货运费币种符号 | string | — | 必填 | 退货运费币种符号 |
| 6.2.14 | returnStatus | 退货状态原始值 | string | — | 必填 | 退货状态原始值 |
| 6.2.15 | returnTypeList | 售后类型标签列表 | array<any> | — | 必填 | 售后类型标签列表:退款 / 退货(可同时存在) |
| 6.2.16 | storeId | 店铺ID | integer | — | 必填 | 店铺ID |
| 6.2.17 | storeName | 店铺名称 | string | — | 必填 | 店铺名称 |
| 6.2.18 | totalRefundedAmount | 订单退款总金额 | integer | — | 必填 | 订单退款总金额 |
| 6.2.19 | totalRefundedCurrency | 退款币种 | string | — | 必填 | 退款币种 |
| 6.2.20 | totalRefundedSymbol | 退款币种符号 | string | — | 必填 | 退款币种符号 |
| 6.2.21 | totalReturnShippingFee | 退货运费 | integer | — | 必填 | 退货运费 |
| 6.3 | pages | pages | integer | — | 必填 | |
| 6.4 | size | size | integer | — | 必填 | |
| 6.5 | total | total | integer | — | 必填 |
领星ERP的接口:多平台 - Shopify售后订单列表(/basicOpen/openapi/multiplatform/shopify/returnOrder/list),由轻易云数据集成平台 API 资产管理模块整理收纳,并随领星ERP版本更新同步更新。