Qeasy Cloud
Get Started

领星ERP 回款明细 - ShopeePayout API

Platform
领星ERP
Type
WebAPI
Effect
QUERY
API Version
1.0
Adapter
\Adapter\LingXing\LXQueryAdapter
Auth Mode
OTHER
Description
多平台 / 财务 / Shopee财务 · POST · 请求参数 19 个(必填 2) · 响应参数 45 个 · 限流令牌桶容量 1
Updated At
2026-11-21

回款明细 - ShopeePayout

POST/basicOpen/finance/shopee/payout/list
Factory
{
  "operation": {
    "method": "POST",
    "path": "/basicOpen/finance/shopee/payout/list"
  },
  "protocol": "HTTPS",
  "host": "https://openapi.lingxing.com",
  "rateLimit": {
    "tokenBucketCapacity": 1,
    "text": ""
  },
  "requestExample": "curl --location 'https://openapi.lingxing.com/basicOpen/finance/shopee/payout/list?access_token=value&timestamp=value&sign=value&app_key=value' \\\n--header 'Content-Type: application/json' \\\n--data '{\n    \"compareLogic\": \"AND\",\n    \"currencyCode\": \"USD\",\n    \"startDate\": \"2026-03-01\",\n    \"endDate\": \"2026-03-17\",\n    \"length\": 20,\n    \"offset\": 0,\n    \"searchType\": \"1\",\n    \"searchSingleValue\": \"PAY001\",\n    \"sids\": [10001,10002],\n    \"sites\": [\"SG\",\"MY\"],\n    \"storeType\": 1\n}'",
  "responseExample": {
    "code": 0,
    "message": "success",
    "error_details": [],
    "request_id": "ccafcc7d9a72484fac5a3889b5db2986.231.17611516492143035",
    "response_time": "2025-10-23 00:47:29",
    "data": {
      "totalCount": 2,
      "totalSum": {
        "difference": "12.35",
        "fromAmount": "980.50",
        "fromCurrency": "USD",
        "fromCurrencyIcon": "$",
        "payoutAmount": "992.85",
        "payoutCurrency": "USD",
        "payoutCurrencyIcon": "$",
        "settlementAdjustmentTotal": "52.35",
        "settlementIncomeTotal": "940.50",
        "settlementTotal": "992.85",
        "totalCount": 2
      },
      "list": [
        {
          "uniqueNo": "SHOPEE-PAYOUT-001",
          "payoutAmount": "520.30",
          "payoutCurrencyIcon": "$",
          "settlementAdjustmentTotal": "20.00",
          "settlementTotal": "520.30",
          "fromCurrencyIcon": "$",
          "payoutCurrency": "USD",
          "payoutTime": "2026-03-17 12:30:00",
          "settlementIncomeTotal": "500.30",
          "exchangeRate": "1.0000",
          "payService": "Payoneer",
          "storeName": "Shopee-SG",
          "fromCurrency": "USD",
          "id": 1001,
          "payeeId": 99887766,
          "originalPayoutTime": 1742198400,
          "storeType": 1,
          "fromAmount": "500.30",
          "siteDisplay": "新加坡",
          "storeId": 10001,
          "encryptedPayoutId": 1234567890,
          "site": "SG",
          "storeTypeDisplay": "跨境店",
          "difference": "6.20",
          "platformCode": "shopee"
        }
      ]
    }
  }
}

Request Parameters

No.FieldNameTypeDefaultRequiredDescription
1compareLogic字段比较条件逻辑关系string—Optional字段比较条件逻辑关系: AND 所有条件都满足 OR 满足任一条件 默认 AND
2currencyCode目标货币代码(为空则使用原币种string—Optional目标货币代码(为空则使用原币种,切换后按打款时间汇率换算)
3endDate结束时间(拨款时间)string—Optional结束时间(拨款时间),格式 yyyy-MM-dd,默认当前日期
4envKey环境标识string—Optional环境标识
5exportFields导出字段值array<any>—Optional导出字段值
6fieldComparesfieldComparesarray<any>—Optional字段比较条件列表(多个条件之间的逻辑关系由 compareLogic 指定)
7length分页大小number—Required分页大小,默认 20,最大不超过 200
8offset分页偏移number—Required分页偏移,默认 0
9platformCode平台码string—Optional平台码
10searchExactly是否精确匹配boolean—Optional是否精确匹配
11searchMultiValue多个搜索值(精确匹配)array<any>—Optional多个搜索值(精确匹配)
12searchSingleValue单个搜索值(支持模糊匹配string—Optional单个搜索值(支持模糊匹配,多个值用逗号分隔)
13searchType搜索类型string—Optional搜索类型: 1 付款ID
14sids店铺 ID 数组array<any>—Optional店铺 ID 数组
15sites站点数组array<any>—Optional站点数组
16sortField排序字段string—Optional排序字段
17sortType排序方向string—Optional排序方向: 1 升序/ASC 0 降序/DESC 默认 0
18startDate开始时间(拨款时间)string—Optional开始时间(拨款时间),格式 yyyy-MM-dd,默认当前月份第一天
19storeType店铺类型number—Optional店铺类型: 1 跨境店(CB)

Response Parameters

No.FieldNameTypeDefaultRequiredDescription
1code状态码number0Required状态码,0:成功
2message消息提示stringsuccessRequired消息提示
3error_details数据校验失败时的错误详情array<any>[]Required数据校验失败时的错误详情
4request_id请求链路idstringccafcc7d9a72484fac5a3889b5db2986.231.17611516492143035Required请求链路id
5response_time响应时间string2025-10-23 00:47:29Required响应时间
6data响应数据object—Required响应数据
6.1totalCount总记录数number2Required总记录数
6.2totalSum汇总数据object—Required汇总数据
6.2.1difference差额汇总string12.35Required差额汇总
6.2.2fromAmount结算金额汇总string980.50Required结算金额汇总
6.2.3fromCurrency结算币种代码stringUSDRequired结算币种代码
6.2.4fromCurrencyIcon结算币种图标string$Required结算币种图标
6.2.5payoutAmount拨款金额汇总string992.85Required拨款金额汇总
6.2.6payoutCurrency拨款币种代码stringUSDRequired拨款币种代码
6.2.7payoutCurrencyIcon拨款币种图标string$Required拨款币种图标
6.2.8settlementAdjustmentTotal总调整金额汇总(Adjustment)string52.35Required总调整金额汇总(Adjustment)
6.2.9settlementIncomeTotal总结算金额汇总(Income)string940.50Required总结算金额汇总(Income)
6.2.10settlementTotal结算明细总和汇总string992.85Required结算明细总和汇总
6.2.11totalCount总记录数number2Required总记录数
6.3list列表数据array<object>—Required列表数据
6.3.1uniqueNo业务唯一键stringSHOPEE-PAYOUT-001Required业务唯一键
6.3.2payoutAmount拨款金额(拨款币种)string520.30Required拨款金额(拨款币种)
6.3.3payoutCurrencyIcon拨款币种图标string$Required拨款币种图标
6.3.4settlementAdjustmentTotal总调整金额(Adjustment)string20.00Required总调整金额(Adjustment)
6.3.5settlementTotalsettlementTotalstring520.30Required结算明细总和(Income + Adjustment)
6.3.6fromCurrencyIcon结算币种图标string$Required结算币种图标
6.3.7payoutCurrency拨款币种stringUSDRequired拨款币种
6.3.8payoutTime拨款时间string2026-03-17 12:30:00Required拨款时间
6.3.9settlementIncomeTotal总结算金额(Income)string500.30Required总结算金额(Income)
6.3.10exchangeRate汇率string1.0000Required汇率
6.3.11payService收款渠道stringPayoneerRequired收款渠道
6.3.12storeName店铺名stringShopee-SGRequired店铺名
6.3.13fromCurrency结算币种stringUSDRequired结算币种
6.3.14id主键 IDnumber1001Required主键 ID
6.3.15payeeId付款IDnumber99887766Required付款ID
6.3.16originalPayoutTime原始拨款时间戳number1742198400Required原始拨款时间戳
6.3.17storeType店铺类型number1Required店铺类型:1-跨境店(CB)
6.3.18fromAmount结算金额(结算币种)string500.30Required结算金额(结算币种)
6.3.19siteDisplay站点中文展示string新加坡Required站点中文展示
6.3.20storeId店铺 IDnumber10001Required店铺 ID
6.3.21encryptedPayoutId付款加密IDnumber1234567890Required付款加密ID
6.3.22site站点代码stringSGRequired站点代码
6.3.23storeTypeDisplay店铺类型展示string跨境店Required店铺类型展示
6.3.24difference差额(总拨款金额(结算)-总订单收入-总调整费)string6.20Required差额(总拨款金额(结算)-总订单收入-总调整费)
6.3.25platformCode平台码stringshopeeRequired平台码

The 回款明细 - ShopeePayout API (/basicOpen/finance/shopee/payout/list) of 领星ERP is curated by the API asset management module of the Qeasy Cloud data integration platform and kept in sync with 领星ERP version updates.

Need to integrate this API?

Qeasy ships with prebuilt adaptation for this API — contact us to start configuring data integration.