1. 报表模块API
API URL
post {HTTP(S)地址}/api/{version}/report
1.1. shopee交易明细查询接口
1.1.1. SERVICE_TYPE
QUERY_SHOPEE_TRANSACTION_DETAIL_LIST
1.1.2. 请求参数
| 参数 |
是否必须 |
类型 |
示例 |
备注 |
| shopNameList |
Y |
List |
["店铺A"] |
店铺名称列表 |
| type |
Y |
Integer |
1 |
账单类型：账单明细(1) 或 跨境店调整费(2) |
| adjustmentLevel |
N |
String |
ORDER |
调整维度，当type=2时必须，ORDER(订单) 或 SHOP(店铺) |
| payoutTimeFrom |
N |
Date |
2022-09-05 |
回款时间起始 |
| payoutTimeTo |
N |
Date |
2022-09-05 |
回款时间结束 |
| updateTimeFrom |
N |
Date |
2022-09-05 00:00:00 |
更新时间起始 |
| updateTimeTo |
N |
Date |
2022-09-05 10:00:00 |
更新时间结束 |
| onlineOrderId |
N |
String |
2011asd |
平台线上单号 |
| onlineOrderIdList |
N |
List |
["2011asd"] |
平台线上单号列表 |
| page |
Y |
Integer |
1 |
页码，默认1 |
| pageSize |
Y |
Integer |
100 |
每页条数，不超过200条，默认100条 |
1.1.3. 返回参数
| 参数 |
是否必须 |
类型 |
示例 |
备注 |
| errorCode |
Y |
String |
|
错误码 |
| errorMsg |
Y |
String |
|
业务错误信息 |
| state |
Y |
String |
|
请求结果 |
| total |
Y |
Integer |
100 |
总条数 |
| result |
Y |
List |
|
详见 ShopeeReportDTO |
ShopeeReportDTO (虾皮交易明细)
| 参数 |
是否必须 |
类型 |
示例 |
备注 |
| shopId |
Y |
Long |
1001 |
店铺id |
| onlineShopId |
Y |
String |
123456 |
线上店铺id |
| shopName |
Y |
String |
店铺A |
店铺名称 |
| ordersn |
Y |
String |
2011asd |
订单号 |
| payoutTime |
Y |
Date |
|
订单回款时间 |
| currency |
Y |
String |
PHP |
币种货币单位 |
| adjustmentLevel |
N |
String |
ORDER |
调整维度 |
| orderStatus |
N |
String |
COMPLETED |
订单状态 |
| returnsn |
N |
String |
|
退货单号 |
| refundsn |
N |
String |
|
退款单号 |
| escrowAmount |
N |
BigDecimal |
|
拨款金额 |
| originalPrice |
N |
BigDecimal |
|
商品原价 |
| sellerDiscount |
N |
BigDecimal |
|
商品折扣 |
| productSaleAmount |
N |
BigDecimal |
|
优惠后商品金额 |
| refundAmount |
N |
BigDecimal |
|
退款金额 |
| shopeeDiscount |
N |
BigDecimal |
|
Shopee回扣金额 |
| voucherFromSeller |
N |
BigDecimal |
|
卖家优惠券金额 |
| sellerCoinCashBack |
N |
BigDecimal |
|
卖家提供的Shopee币回扣 |
| buyerPaidShippingFee |
N |
BigDecimal |
|
买家支付运费 |
| shopeeShippingRebate |
N |
BigDecimal |
|
Shopee运费补贴 |
| actualShippingFee |
N |
BigDecimal |
|
实际运费 |
| reverseShippingFee |
N |
BigDecimal |
|
退货运费 |
| commissionFee |
N |
BigDecimal |
|
佣金 |
| serviceFee |
N |
BigDecimal |
|
服务费 |
| rsfSellerProtectionFeeClaimAmount |
N |
BigDecimal |
|
退货运费险 |
| rsfSellerProtectionFeePremiumAmount |
N |
BigDecimal |
|
反向运费减免 |
| orderAmsCommissionFee |
N |
BigDecimal |
|
AMS佣金 |
| deliverySellerProtectionFeePremiumAmount |
N |
BigDecimal |
|
3PL买家运费险 |
| sellerTransactionFee |
N |
BigDecimal |
|
交易手续费 |
| escrowTax |
N |
BigDecimal |
|
关税 |
| sellerLostCompensation |
N |
BigDecimal |
|
损失赔偿 |
| sellerShippingDiscount |
N |
BigDecimal |
|
卖家的运费促销 |
| buyerTotalAmount |
N |
BigDecimal |
|
买家实付金额 |
| coins |
N |
BigDecimal |
|
虾币 |
| voucherFromShopee |
N |
BigDecimal |
|
虾皮优惠券金额 |
| crossBorderTax |
N |
BigDecimal |
|
跨境税费 |
| paymentPromotion |
N |
BigDecimal |
|
手续费优惠 |
| estimatedShippingFee |
N |
BigDecimal |
|
预估运费 |
| finalShippingFee |
N |
BigDecimal |
|
最终运费 |
| shippingFeeDiscountFrom3pl |
N |
BigDecimal |
|
3PL运费折扣 |
| sellerVoucherCode |
N |
String |
|
卖家优惠券码 |
| offlineAdjustment |
N |
BigDecimal |
|
调整费 |
| module |
N |
String |
|
费用类型(跨境店调整费查询才有值) |
| scenario |
N |
String |
|
调整场景(跨境店调整费查询才有值) |
| adjustmentAmount |
N |
BigDecimal |
|
调整金额(跨境店调整费查询才有值) |
| remark |
N |
String |
|
备注(跨境店调整费查询才有值) |
| updateTime |
N |
Date |
|
更新时间 |
1.2. Lazada交易明细查询接口
1.2.1. SERVICE_TYPE
QUERY_LAZADA_TRANSACTION_DETAIL_LIST
1.2.2. 请求参数
| 参数 |
是否必须 |
类型 |
示例 |
备注 |
| shopNameList |
Y |
List |
["店铺A"] |
店铺名称列表 |
| payoutTimeFrom |
N |
Date |
2022-09-05 |
回款时间起始 |
| payoutTimeTo |
N |
Date |
2022-09-05 |
回款时间结束 |
| updateTimeFrom |
N |
Date |
2022-09-05 00:00:00 |
更新时间起始 |
| updateTimeTo |
N |
Date |
2022-09-05 10:00:00 |
更新时间结束 |
| onlineOrderId |
N |
String |
2011asd |
订单号 |
| onlineOrderIdList |
N |
List |
["2011asd"] |
订单号列表 |
| feeName |
N |
String |
|
费用名称 |
| page |
Y |
Integer |
1 |
页码，默认1 |
| pageSize |
Y |
Integer |
100 |
每页条数，不超过200条，默认100条 |
1.2.3. 返回参数
| 参数 |
是否必须 |
类型 |
示例 |
备注 |
| errorCode |
Y |
String |
|
错误码 |
| errorMsg |
Y |
String |
|
业务错误信息 |
| state |
Y |
String |
|
请求结果 |
| total |
Y |
Integer |
100 |
总条数 |
| result |
Y |
List |
|
详见 LazadaReportDTO |
LazadaReportDTO (Lazada交易明细)
| 参数 |
是否必须 |
类型 |
示例 |
备注 |
| shopId |
Y |
Long |
1001 |
店铺id |
| onlineShopId |
Y |
String |
123456 |
线上店铺id |
| shopName |
Y |
String |
店铺A |
店铺名称 |
| transactionDate |
Y |
String |
2022-09-05 |
日期 |
| transactionNumber |
Y |
String |
|
交易号 |
| transactionType |
Y |
String |
|
交易类型 |
| orderNo |
Y |
String |
2011asd |
订单号 |
| feeName |
N |
String |
|
费用名称 |
| currency |
N |
String |
PHP |
币种货币单位 |
| amount |
N |
String |
|
交易总额 |
| details |
N |
String |
|
明细 |
| sellerSku |
N |
String |
|
Seller SKU |
| vatInAmount |
N |
String |
|
VAT |
| whtAmount |
N |
String |
|
WHT |
| comment |
N |
String |
|
备注 |
| updateTime |
N |
Date |
|
更新时间 |
1.3. TikTok交易明细查询接口
1.3.1. SERVICE_TYPE
QUERY_TIKTOK_TRANSACTION_DETAIL_LIST
1.3.2. 请求参数
| 参数 |
是否必须 |
类型 |
示例 |
备注 |
| shopNameList |
Y |
List |
["店铺A"] |
店铺名称列表 |
| payoutTimeFrom |
Y |
Date |
2022-09-05 |
回款时间起始 |
| payoutTimeTo |
Y |
Date |
2022-09-05 |
回款时间结束 |
| onlineOrderId |
N |
String |
2011asd |
订单号 |
| onlineOrderIdList |
N |
List |
["2011asd"] |
订单号列表 |
| page |
Y |
Integer |
1 |
页码，默认1 |
| pageSize |
Y |
Integer |
100 |
每页条数，不超过200条，默认100条 |
1.3.3. 返回参数
| 参数 |
是否必须 |
类型 |
示例 |
备注 |
| errorCode |
Y |
String |
|
错误码 |
| errorMsg |
Y |
String |
|
业务错误信息 |
| state |
Y |
String |
|
请求结果 |
| total |
Y |
Integer |
100 |
总条数 |
| result |
Y |
List |
|
详见 TiktokReportDTO |
TiktokReportDTO (TikTok交易明细)
| 参数 |
是否必须 |
类型 |
示例 |
备注 |
| shopName |
Y |
String |
店铺A |
店铺名称 |
| currency |
Y |
String |
PHP |
币种货币单位 |
| orderId |
Y |
String |
2011asd |
订单号 |
| adjustmentId |
Y |
String |
|
调整单号 |
| relatedOrderId |
Y |
String |
|
关联单号 |
| settlementTime |
N |
Date |
|
回款时间 |
| skuId |
N |
String |
|
SKUid |
| skuName |
N |
String |
|
SKU名称 |
| productName |
N |
String |
|
产品名称 |
| userPay |
N |
BigDecimal |
|
买家支付 |
| platformPromotion |
N |
BigDecimal |
|
平台优惠 |
| shippingFeeSubsidy |
N |
BigDecimal |
|
运费补贴 |
| refund |
N |
BigDecimal |
|
退款 |
| paymentFee |
N |
BigDecimal |
|
交易手续费 |
| platformCommission |
N |
BigDecimal |
|
平台佣金 |
| flatFee |
N |
BigDecimal |
|
固定费 |
| salesFee |
N |
BigDecimal |
|
销售费 |
| affiliateCommission |
N |
BigDecimal |
|
达人佣金 |
| vat |
N |
BigDecimal |
|
增值税 |
| shippingFee |
N |
BigDecimal |
|
平台运费 |
| smallOrderFee |
N |
BigDecimal |
|
小额订单费 |
| affiliatePartnerCommission |
N |
BigDecimal |
|
达人伙伴佣金 |
| sellerReasonFundDeduction |
N |
BigDecimal |
|
赔偿损失 |
| shippingFeeAdjustment |
N |
BigDecimal |
|
运费调整费 |
| chargeBack |
N |
BigDecimal |
|
差异金额 |
| customerServiceCompensation |
N |
BigDecimal |
|
售后赔付 |
| promotionAdjustment |
N |
BigDecimal |
|
促销调整费 |
| otherAdjustment |
N |
BigDecimal |
|
其他调整费 |
| settlementAmount |
N |
BigDecimal |
|
回款金额 |
| transactionFee |
N |
BigDecimal |
|
交易费用 |
| subtotalAfterSellerDiscounts |
N |
BigDecimal |
|
折扣后商品销售金额 |
| refundSubtotalAfterSellerDiscounts |
N |
BigDecimal |
|
折扣后商品退款金额 |
| gst |
N |
BigDecimal |
|
服务税（新加坡） |
| sfpServiceFee |
N |
BigDecimal |
|
SFP服务费 |
| updateTime |
N |
Date |
|
更新时间 |
1.4. shopee回款记录查询接口
1.4.1. SERVICE_TYPE
QUERY_SHOPEE_PAYOUT_DETAIL_LIST
1.4.2. 请求参数
| 参数 |
是否必须 |
类型 |
示例 |
备注 |
| shopNameList |
Y |
List |
["店铺A"] |
店铺名称列表 |
| payoutTimeFrom |
Y |
Date |
2022-09-05 |
回款时间起始 |
| payoutTimeTo |
Y |
Date |
2022-09-05 |
回款时间结束 |
| type |
N |
String |
|
类型 |
| payoutStatus |
N |
String |
|
交易状态 |
| transactionType |
N |
String |
|
交易类型 |
| onlineOrderId |
N |
String |
2011asd |
订单号 |
| onlineOrderIdList |
N |
List |
["2011asd"] |
订单号列表 |
| page |
Y |
Integer |
1 |
页码，默认1 |
| pageSize |
Y |
Integer |
100 |
每页条数，不超过200条，默认100条 |
1.4.3. 返回参数
| 参数 |
是否必须 |
类型 |
示例 |
备注 |
| errorCode |
Y |
String |
|
错误码 |
| errorMsg |
Y |
String |
|
业务错误信息 |
| state |
Y |
String |
|
请求结果 |
| total |
Y |
Integer |
100 |
总条数 |
| result |
Y |
List |
|
详见 ShoppeePayoutReportDTO |
ShoppeePayoutReportDTO (虾皮拨款明细)
| 参数 |
是否必须 |
类型 |
示例 |
备注 |
| shopId |
Y |
Long |
1001 |
店铺id |
| onlineShopId |
Y |
String |
123456 |
线上店铺id |
| shopName |
Y |
String |
店铺A |
店铺名称 |
| platform |
Y |
String |
Shopee |
平台 |
| siteCode |
Y |
String |
PH |
站点 |
| currency |
Y |
String |
PHP |
币种货币单位 |
| type |
N |
String |
|
类型 |
| payType |
N |
String |
|
付款方式 |
| transactionId |
N |
String |
|
交易编号 |
| payoutStatus |
N |
String |
|
交易状态 |
| transactionType |
N |
String |
|
交易类型 |
| amount |
N |
BigDecimal |
|
金额 |
| currentBalance |
N |
BigDecimal |
|
当前余额 |
| transactionTime |
N |
Date |
|
交易时间 |
| updateTime |
N |
Date |
|
修改时间 |
| orderSn |
N |
String |
2011asd |
订单编号 |
| refundSn |
N |
String |
|
退款单号 |
| withdrawalType |
N |
String |
|
|
| transactionFee |
N |
BigDecimal |
|
交易费用 |
| description |
N |
String |
|
描述 |
| buyerName |
N |
String |
|
买家名称 |
| withdrawId |
N |
String |
|
|
| reason |
N |
String |
|
|
| rootWithdrawalId |
N |
String |
|
|
| payoutExchangeCurrency |
N |
String |
|
|
| payoutExchangeAmount |
N |
BigDecimal |
|
实际金额 |
| payoutExchangeRate |
N |
String |
|
汇率 |
| payoutPayeeId |
N |
String |
|
1.5. Lazada我的余额查询接口
1.5.1. SERVICE_TYPE
QUERY_LAZADA_ACCOUNT_TRANSACTION_LIST
1.5.2. 请求参数
| 参数 |
是否必须 |
类型 |
示例 |
备注 |
| shopNameList |
Y |
List |
["店铺A"] |
店铺名称列表 |
| payoutTimeFrom |
Y |
Date |
2022-09-05 |
回款时间起始 |
| payoutTimeTo |
Y |
Date |
2022-09-05 |
回款时间结束 |
| transactionNumberList |
N |
List |
["T123"] |
交易单号列表 |
| typeList |
N |
List |
["类型A"] |
类型列表 |
| page |
Y |
Integer |
1 |
页码，默认1 |
| pageSize |
Y |
Integer |
100 |
每页条数，不超过200条，默认100条 |
1.5.3. 返回参数
| 参数 |
是否必须 |
类型 |
示例 |
备注 |
| errorCode |
Y |
String |
|
错误码 |
| errorMsg |
Y |
String |
|
业务错误信息 |
| state |
Y |
String |
|
请求结果 |
| total |
Y |
Integer |
100 |
总条数 |
| result |
Y |
List |
|
详见 LazadaAccountTransactionReportDTO |
LazadaAccountTransactionReportDTO (Lazada账户交易明细)
| 参数 |
是否必须 |
类型 |
示例 |
备注 |
| customerId |
N |
Long |
1001 |
客户ID |
| shopId |
N |
Long |
1001 |
店铺ID |
| onlineShopId |
N |
String |
123456 |
线上店铺ID |
| siteCode |
N |
String |
PH |
站点 |
| transactionNumber |
N |
String |
T123 |
交易单号 |
| transactionTime |
N |
Date |
|
交易时间 |
| type |
N |
String |
类型A |
类型 |
| subType |
N |
String |
子类型A |
子类型 |
| amount |
N |
BigDecimal |
|
金额 |
| currency |
N |
String |
PHP |
币种货币单位 |
| remarks |
N |
String |
|
备注 |
| payeeAccount |
N |
String |
|
账号 |
| payeeDescription |
N |
String |
|
描述 |
| payeeJson |
N |
String |
|
|
| trackingListJson |
N |
String |
|
|
| shopName |
N |
String |
店铺A |
店铺名称 |
| platform |
N |
String |
Lazada |
平台名称 |
1.6. TikTok V2交易明细查询接口
1.6.1. SERVICE_TYPE
QUERY_TIKTOK_V2_TRANSACTION_DETAIL_LIST
1.6.2. 请求参数
| 参数 |
是否必须 |
类型 |
示例 |
备注 |
| shopNameList |
Y |
List |
["店铺A"] |
店铺名称列表 |
| payoutTimeFrom |
N |
Date |
2022-09-05 |
回款时间起始 |
| payoutTimeTo |
N |
Date |
2022-09-05 |
回款时间结束 |
| updateTimeFrom |
N |
Date |
2022-09-05 00:00:00 |
更新时间起始 |
| updateTimeTo |
N |
Date |
2022-09-05 10:00:00 |
更新时间结束 |
| onlineOrderId |
N |
String |
2011asd |
订单号 |
| onlineOrderIdList |
N |
List |
["2011asd"] |
订单号列表 |
| page |
Y |
Integer |
1 |
页码，默认1 |
| pageSize |
Y |
Integer |
100 |
每页条数，不超过200条，默认100条 |
1.6.3. 返回参数
| 参数 |
是否必须 |
类型 |
示例 |
备注 |
| errorCode |
Y |
String |
|
错误码 |
| errorMsg |
Y |
String |
|
业务错误信息 |
| state |
Y |
String |
|
请求结果 |
| total |
Y |
Integer |
100 |
总条数 |
| result |
Y |
List |
|
详见 TiktokV2025SettlementReportDTO |
TiktokV2025SettlementReportDTO (TikTok V2交易明细)
| 参数 |
是否必须 |
类型 |
示例 |
备注 |
| shopId |
Y |
Long |
1001 |
类型店铺ID |
| onlineShopId |
Y |
String |
123456 |
线上店铺id |
| currency |
Y |
String |
PHP |
币种货币单位 |
| platform |
Y |
String |
TikTok |
平台信息 |
| shopName |
Y |
String |
店铺A |
店铺名称 |
| typeCode |
N |
String |
|
类型 |
| orderId |
N |
String |
2011asd |
订单号 |
| orderCreateTime |
N |
Long |
|
订单创建时间 |
| settlementTime |
N |
Date |
|
账单交易时间 |
| adjustmentId |
N |
String |
|
调整单 |
| adjustmentOrderId |
N |
String |
|
调整关联订单 |
| adjustmentAmount |
N |
BigDecimal |
|
调整费 |
| settlementAmount |
N |
BigDecimal |
|
结算费 |
| revenueAmount |
N |
BigDecimal |
|
收入 |
| shippingCostAmount |
N |
BigDecimal |
|
运费 |
| feeTaxAmount |
N |
BigDecimal |
|
取fee_tax_breakdown总值 |
| totalFees |
N |
BigDecimal |
|
总费用取fee_tax |
| subtotalAfterDiscountAmount |
N |
BigDecimal |
|
计算得出商品折扣后金额---计算得出 |
| refundSubtotalAfterDiscountAmount |
N |
BigDecimal |
|
商品折扣后金额（退款）--计算得出 |
| subtotalBeforeDiscountAmount |
N |
BigDecimal |
|
商品折前金额 |
| sellerDiscountAmount |
N |
BigDecimal |
|
商家折扣 |
| refundSubtotalBeforeDiscountAmount |
N |
BigDecimal |
|
商品折前金额退款 |
| sellerDiscountRefundAmount |
N |
BigDecimal |
|
商家折扣金额退款 |
| codServiceFeeAmount |
N |
BigDecimal |
|
cod服务费费 |
| refundCodServiceFeeAmount |
N |
BigDecimal |
|
cod退款服务费 |
| feePlatformCommissionAmount |
N |
BigDecimal |
|
平台佣金 |
| feeReferralFeeAmount |
N |
BigDecimal |
|
推荐费 |
| feeRefundAdministrationFeeAmount |
N |
BigDecimal |
|
退货管理费 |
| feeTransactionFeeAmount |
N |
BigDecimal |
|
交易费用 |
| feeCreditCardHandlingFeeAmount |
N |
BigDecimal |
|
信用卡服务费 |
| feeAffiliateCommissionAmount |
N |
BigDecimal |
|
达人佣金 |
| feeAffiliateCommissionAmountBeforePit |
N |
BigDecimal |
|
税前达人佣金 |
| feeAffiliatePartnerCommissionAmount |
N |
BigDecimal |
|
达人伙伴佣金 |
| feeAffiliateAdsCommissionAmount |
N |
BigDecimal |
|
达人广告佣金 |
| feeSfpServiceFeeAmount |
N |
BigDecimal |
|
SFP服务费 |
| feeLiveSpecialsFeeAmount |
N |
BigDecimal |
|
LIVE服务费 |
| feeBonusCashbackServiceFeeAmount |
N |
BigDecimal |
|
奖金返现服务费 |
| feeMallServiceFeeAmount |
N |
BigDecimal |
|
平台商城服务费 |
| taxVatAmount |
N |
BigDecimal |
|
增值税（跨境店） |
| taxImportVatAmount |
N |
BigDecimal |
|
进口增值税 |
| taxCustomsDutyAmount |
N |
BigDecimal |
|
关税（跨境店） |
| taxCustomsClearanceAmount |
N |
BigDecimal |
|
清关服务税（跨境店） |
| taxSstAmount |
N |
BigDecimal |
|
SST服务税 |
| taxGstAmount |
N |
BigDecimal |
|
GST服务税 |
| udf1 到 udf15 |
N |
BigDecimal |
|
自定义字段 |
| updateTime |
N |
Date |
|
更新时间 |
1.7. TikTok回款记录查询接口
1.7.1. SERVICE_TYPE
QUERY_TIKTOK_WITHDRAWALS_DETAIL_LIST
1.7.2. 请求参数
| 参数 |
是否必须 |
类型 |
示例 |
备注 |
| shopNameList |
Y |
List |
["店铺A"] |
店铺名称列表 |
| payoutTimeFrom |
Y |
Date |
2022-09-05 |
回款时间起始 |
| payoutTimeTo |
Y |
Date |
2022-09-05 |
回款时间结束 |
| typeList |
N |
List |
["类型A"] |
交易类型列表 |
| page |
Y |
Integer |
1 |
页码，默认1 |
| pageSize |
Y |
Integer |
100 |
每页条数，不超过200条，默认100条 |
1.7.3. 返回参数
| 参数 |
是否必须 |
类型 |
示例 |
备注 |
| errorCode |
Y |
String |
|
错误码 |
| errorMsg |
Y |
String |
|
业务错误信息 |
| state |
Y |
String |
|
请求结果 |
| total |
Y |
Integer |
100 |
总条数 |
| result |
Y |
List |
|
详见 TiktokWithdrawalsWebReportDTO |
TiktokWithdrawalsWebReportDTO (TikTok提现明细)
| 参数 |
是否必须 |
类型 |
示例 |
备注 |
| shopId |
Y |
Long |
1001 |
店铺ID |
| onlineShopId |
Y |
String |
123456 |
线上店铺id |
| withdrawalsId |
N |
String |
|
ID |
| type |
N |
String |
类型A |
交易类型 |
| amount |
N |
BigDecimal |
|
金额 |
| currency |
N |
String |
PHP |
币种货币单位 |
| status |
N |
String |
|
状态 |
| withdrawalsCreateTime |
N |
Date |
|
提现创建时间 |
| withdrawalsCreateTimestamp |
N |
Long |
|
提现创建时间戳 |
| shopName |
N |
String |
店铺A |
店铺名称 |
| siteCode |
N |
String |
PH |
站点 |