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. 请求参数
| 参数 | 是否必须 | 类型 | 示例 | 备注 |
|---|---|---|---|---|
| shopIdList | N | List |
[1001] | 店铺id列表,不超过100个 与 shopNameList 二选一必填,若两者都提供,则以本参数为准 |
| shopNameList | N | List |
["店铺A"] | 店铺名称列表,不超过100个 与 shopIdList 二选一必填 |
| 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 | Long | 1735697410000 | 订单回款时间 |
| payoutTimeFormatted | Y | String | "2025-01-01 10:10:10" | 订单回款时间 |
| currency | Y | String | PHP | 币种货币单位 |
| adjustmentLevel | N | String | ORDER | 调整维度 |
| orderStatus | N | String | COMPLETED | 订单状态 |
| returnsn | N | String | 退货单号 | |
| refundsn | N | String | 退款单号 | |
| escrowAmount | N | BigDecimal | 拨款金额 | |
| originalPrice | N | BigDecimal | 商品原价(退后) | |
| orderSellingPrice | N | BigDecimal | 商品售价(退后) | |
| sellerDiscount | N | BigDecimal | 商品优惠金额(退后) | |
| productSaleAmount | N | BigDecimal | 优惠后商品金额 | |
| originalPriceBeforeRefund | N | BigDecimal | 商品原价(退前) | |
| sellingPriceBeforeRefund | N | BigDecimal | 商品售价(退前) | |
| sellerDiscountBeforeRefund | 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 | 反向运费减免 | |
| shippingSellerProtectionFeeAmount | N | BigDecimal | 退货运费险(Change of Mind Returns Program Fee) | |
| 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 | 虾皮优惠券金额 | |
| shippingFeeSst | N | BigDecimal | 卖家运费SST费用 | |
| reverseShippingFeeSst | N | BigDecimal | 卖家退货运费SST费用 | |
| finalEscrowProductGst | N | BigDecimal | 进口商品和服务税 | |
| finalEscrowShippingGst | N | BigDecimal | 进口商品运费服务税 | |
| campaignFee | N | BigDecimal | 平台收取活动费 | |
| shopeeCoinsRedeemed | N | BigDecimal | SHOPEE买家Coins抵扣 | |
| withholdingTax | N | BigDecimal | 预扣税 | |
| salesTaxOnLvg | N | BigDecimal | LVG税费 | |
| vatOnImportedGoods | N | BigDecimal | 进口征收增值税 | |
| fsfSellerProtectionFeeClaimAmount | N | BigDecimal | 运费索赔金额 | |
| overseasReturnServiceFee | 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 | Long | 1735697410000 | 更新时间 |
| shopTimeZone | N | String | "Asia/Shanghai" | 店铺时区 |
| publicId | N | String | "550318454795" | 公共Id |
| udf1 | N | BigDecimal | 卖家订单操作费 | |
| udf2 | N | BigDecimal | 个人所得税(代扣代缴) | |
| udf3 | N | BigDecimal | 卖家增值税 | |
| udf4 | N | BigDecimal | 卖方以旧换新奖金 | |
| udf5 | N | BigDecimal | FBS进口商品运费服务税 | |
| udf6 | N | BigDecimal | 最终返回给卖家的运费 | |
| udf7 | N | BigDecimal | 广告托管或技术支持费用 | |
| udf8 | N | BigDecimal | 进口税 | |
| udf9 | N | BigDecimal | 预留字段,当前未使用 | |
| udf10 | N | BigDecimal | 预留字段,当前未使用 | |
| udf11 | N | BigDecimal | 预留字段,当前未使用 | |
| udf12 | N | BigDecimal | 预留字段,当前未使用 | |
| udf13 | N | BigDecimal | 预留字段,当前未使用 | |
| udf14 | N | BigDecimal | 预留字段,当前未使用 | |
| udf15 | N | BigDecimal | 预留字段,当前未使用 |
1.2. Lazada交易明细查询接口
1.2.1. SERVICE_TYPE
QUERY_LAZADA_TRANSACTION_DETAIL_LIST
1.2.2. 请求参数
| 参数 | 是否必须 | 类型 | 示例 | 备注 |
|---|---|---|---|---|
| shopIdList | N | List |
[1001] | 店铺id列表,不超过100个 与 shopNameList 二选一必填,若两者都提供,则以本参数为准 |
| shopNameList | N | List |
["店铺A"] | 店铺名称列表,不超过100个 与 shopIdList 二选一必填 |
| 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 | "2025-01-01" | 日期 |
| transactionTimestamp | Y | Long | 1735660800000 | 日期 |
| 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 | Long | 1735660800000 | 更新时间 |
| shopTimeZone | N | String | "Asia/Shanghai" | 店铺时区 |
| publicId | N | String | "550318454795" | 公共Id |
1.3. TikTok交易明细查询接口
1.3.1. SERVICE_TYPE
QUERY_TIKTOK_TRANSACTION_DETAIL_LIST
1.3.2. 请求参数
| 参数 | 是否必须 | 类型 | 示例 | 备注 |
|---|---|---|---|---|
| shopIdList | N | List |
[1001] | 店铺id列表,不超过100个 与 shopNameList 二选一必填,若两者都提供,则以本参数为准 |
| shopNameList | N | List |
["店铺A"] | 店铺名称列表,不超过100个 与 shopIdList 二选一必填 |
| 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交易明细)
| 参数 | 是否必须 | 类型 | 示例 | 备注 |
|---|---|---|---|---|
| shopId | Y | Long | 1001 | 店铺id |
| shopName | Y | String | 店铺A | 店铺名称 |
| currency | Y | String | PHP | 币种货币单位 |
| orderId | Y | String | 2011asd | 订单号 |
| adjustmentId | Y | String | 调整单号 | |
| relatedOrderId | Y | String | 关联单号 | |
| settlementTime | N | Long | 1735660800000 | 回款时间 |
| settlementTimeFormatted | N | String | "2025-01-01" | 回款时间 |
| 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服务费 | |
| transactionFeeRefund | N | BigDecimal | 退款交易费用 | |
| wht | N | BigDecimal | 预扣税 | |
| logisticsReimbursement | N | BigDecimal | 物流更新费 | |
| tokLogisticsReimbursement | N | BigDecimal | 物流相关费用 | |
| satisfactionSubsidy | N | BigDecimal | 满意度补贴 | |
| bonusCashbackServiceFee | N | BigDecimal | 奖金返现服务费 | |
| referralFee | N | BigDecimal | 推荐费 | |
| affiliateCommissionBeforePit | N | BigDecimal | 税前达人佣金 | |
| pitAmount | N | BigDecimal | 代扣代缴费用 | |
| creditCardInstallmentHandlingFee | N | BigDecimal | 信用卡服务费 | |
| mallServiceFee | N | BigDecimal | 商城服务费 | |
| affiliateAdsCommission | N | BigDecimal | 联盟广告费 | |
| affiliateAdsCommissionBeforePit | N | BigDecimal | 联盟广告佣金税前 | |
| updateTime | N | Long | 1735660800000 | 更新时间 |
| shopTimeZone | N | String | "Asia/Shanghai" | 店铺时区 |
| publicId | N | String | "550318454795" | 公共Id |
1.4. shopee回款记录查询接口
1.4.1. SERVICE_TYPE
QUERY_SHOPEE_PAYOUT_DETAIL_LIST
1.4.2. 请求参数
| 参数 | 是否必须 | 类型 | 示例 | 备注 |
|---|---|---|---|---|
| shopIdList | N | List |
[1001] | 店铺id列表,不超过100个 与 shopNameList 二选一必填,若两者都提供,则以本参数为准 |
| shopNameList | N | List |
["店铺A"] | 店铺名称列表,不超过100个 与 shopIdList 二选一必填 |
| payoutTimeFrom | Y | Date | 2022-09-05 | 回款时间起始 |
| payoutTimeTo | Y | Date | 2022-09-05 | 回款时间结束 |
| updateTimeFrom | N | Date | 2022-09-05 00:00:00 | 更新时间起始 |
| updateTimeTo | N | Date | 2022-09-05 10:00:00 | 更新时间结束 |
| 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 | Long | 1735697410000 | 交易时间 |
| transactionTimeFormatted | N | String | "2025-01-01 10:10:10" | 回款时间 |
| updateTime | N | Long | 1735697410000 | 修改时间 |
| orderSn | N | String | 2011asd | 订单编号 |
| refundSn | N | String | 退款单号 | |
| withdrawalType | N | String | 提现类型 | |
| transactionFee | N | BigDecimal | 交易费用 | |
| description | N | String | 描述 | |
| buyerName | N | String | 买家名称 | |
| withdrawId | N | String | 提现ID | |
| reason | N | String | 与交易或提现相关的说明原因 | |
| rootWithdrawalId | N | String | 根提现ID | |
| payoutExchangeCurrency | N | String | 实际金额币种 | |
| payoutExchangeAmount | N | BigDecimal | 实际金额 | |
| payoutExchangeRate | N | String | 汇率 | |
| payoutPayeeId | N | String | 卖家收款账号 | |
| shopTimeZone | N | String | "Asia/Shanghai" | 店铺时区 |
| publicId | N | String | "550318454795" | 公共Id |
1.5. Lazada我的余额查询接口
1.5.1. SERVICE_TYPE
QUERY_LAZADA_ACCOUNT_TRANSACTION_LIST
1.5.2. 请求参数
| 参数 | 是否必须 | 类型 | 示例 | 备注 |
|---|---|---|---|---|
| shopIdList | N | List |
[1001] | 店铺id列表,不超过100个 与 shopNameList 二选一必填,若两者都提供,则以本参数为准 |
| shopNameList | N | List |
["店铺A"] | 店铺名称列表,不超过100个 与 shopIdList 二选一必填 |
| payoutTimeFrom | Y | Date | 2022-09-05 | 回款时间起始 |
| payoutTimeTo | Y | Date | 2022-09-05 | 回款时间结束 |
| updateTimeFrom | N | Date | 2022-09-05 00:00:00 | 更新时间起始 |
| updateTimeTo | N | Date | 2022-09-05 10:00:00 | 更新时间结束 |
| 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 | Long | 1735697410000 | 交易时间 |
| transactionTimeFormatted | N | String | "2025-01-01 10:10:10" | 交易时间 |
| 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 | 平台名称 |
| updateTime | N | Long | 1735697410000 | 修改时间 |
| shopTimeZone | N | String | "Asia/Shanghai" | 店铺时区 |
| publicId | N | String | "550318454795" | 公共Id |
1.6. TikTok V2交易明细查询接口
1.6.1. SERVICE_TYPE
QUERY_TIKTOK_V2_TRANSACTION_DETAIL_LIST
1.6.2. 请求参数
| 参数 | 是否必须 | 类型 | 示例 | 备注 |
|---|---|---|---|---|
| shopIdList | N | List |
[1001] | 店铺id列表,不超过100个 与 shopNameList 二选一必填,若两者都提供,则以本参数为准 |
| shopNameList | N | List |
["店铺A"] | 店铺名称列表,不超过100个 与 shopIdList 二选一必填 |
| 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交易明细)
commercePlatform 说明
Toko / TikTok 标识来自订单拉取至 ERP 后写入的来源标签;未同步订单到ERP时为NULL。
- 取值:
TIKTOK、TOKOPEDIA。未同步订单到ERP时为NULL。 typeCode=ORDER且orderId非空且在ERP已拉到订单时。
| 参数 | 是否必须 | 类型 | 示例 | 备注 |
|---|---|---|---|---|
| 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 | 订单号 |
| commercePlatform | N | String | TIKTOK | 仅 TIKTOK、TOKOPEDIA 或空。见上方说明。 |
| orderCreateTime | N | Long | 订单创建时间 | |
| settlementTime | N | Long | 1735660800000 | 账单交易时间 |
| settlementTimeFormatted | N | String | "2025-01-01" | 账单交易时间 |
| adjustmentId | N | String | 调整单 | |
| adjustmentOrderId | N | String | 调整关联订单 | |
| adjustmentAmount | N | BigDecimal | 调整费 | |
| settlementAmount | N | BigDecimal | 结算费 | |
| revenueAmount | N | BigDecimal | 收入 | |
| shippingCostAmount | N | BigDecimal | 运费 | |
| shippingCostBreakDown | N | TiktokV2025SettlementShippingCostBreakDownVO | 运费明细 | |
| 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 | N | BigDecimal | Xtra计划服务费 | |
| udf2 | N | BigDecimal | Flash销售服务费 | |
| udf3 | N | BigDecimal | 共同促销服务费 | |
| udf4 | N | BigDecimal | 预购买服务费 | |
| udf5 | N | BigDecimal | TSP佣金 | |
| udf6 | N | BigDecimal | Ditayani Tokopedia手续费 | |
| udf7 | N | BigDecimal | Paylater手续费 | |
| udf8 | N | BigDecimal | 平台动态佣金 | |
| udf9 | N | BigDecimal | 固定基础设施费 | |
| udf10 | N | BigDecimal | PRO环境贡献费 | |
| udf11 | N | BigDecimal | 每件商品销售费用 | |
| udf12 | N | BigDecimal | 合作推广服务费 | |
| udf13 | N | BigDecimal | EAMSP服务费 | |
| udf14 | N | BigDecimal | 订单支付后创作者佣金费 | |
| udf15 | N | BigDecimal | 订单结算后创作者佣金退费 | |
| udf16 | N | BigDecimal | 退货运费(客户支付) | |
| udf17 | N | BigDecimal | 退货运费(平台资助) | |
| udf18 | N | BigDecimal | 达人伙伴TAP广告佣金 | |
| udf19 | N | BigDecimal | 活动资源费佣金 | |
| udf20 | N | BigDecimal | 平台安装服务费 | |
| udf21 | N | BigDecimal | 平台特殊服务费 | |
| udf22 | N | BigDecimal | ISR | |
| udf23 | N | BigDecimal | IVA | |
| udf24 | N | BigDecimal | 反倾销税金额 | |
| udf25 | N | BigDecimal | PIT | |
| udf26 | N | BigDecimal | Smart促销费 | |
| udf27 | N | BigDecimal | GMV Max广告充值金 | |
| udf28 | N | BigDecimal | 半托管平台佣金 | |
| udf29 | N | BigDecimal | CFP活动期费 | |
| udf30 | N | BigDecimal | SP活动期费 | |
| udf31 | N | BigDecimal | 卖家增长费 | |
| udf32 | N | BigDecimal | 推荐费销售税 | |
| udf33 | N | BigDecimal | Smart Promotion销售税 | |
| udf34 | N | BigDecimal | Cedular 税 | |
| udf35 | N | BigDecimal | 预留字段 | |
| udf40 | N | BigDecimal | GMV Max 券支付 | |
| updateTime | N | Long | 1735660800000 | 更新时间 |
| shopTimeZone | N | String | "Asia/Shanghai" | 店铺时区 |
| publicId | N | String | "550318454795" | 公共Id |
TiktokV2025SettlementShippingCostBreakDownVO(运费明细)
| 参数 | 是否必须 | 类型 | 示例 | 备注 |
|---|---|---|---|---|
| actualShippingFeeAmount | N | BigDecimal | 实际支出运费 | |
| shippingFeeDiscountAmount | N | BigDecimal | 平台运费补贴 | |
| customerPaidShippingFeeAmount | N | BigDecimal | 买家实付运费 | |
| returnShippingFeeAmount | N | BigDecimal | 退货运费支出 | |
| replacementShippingFeeAmount | N | BigDecimal | 换货支出 | |
| exchangeShippingFeeAmount | N | BigDecimal | 交付货物(印尼) | |
| signatureConfirmationFeeAmount | N | BigDecimal | 签名包裹服务 | |
| shippingInsuranceFeeAmount | N | BigDecimal | 航运保险 | |
| shippingCostSupplementaryComponent | N | TiktokV2025SettlementShippingCostBreakDownOtherInfoVO | 其他运费明细 |
TiktokV2025SettlementShippingCostBreakDownOtherInfoVO(其他运费明细)
| 参数 | 是否必须 | 类型 | 示例 | 备注 |
|---|---|---|---|---|
| platformShippingFeeDiscountAmount | N | BigDecimal | 平台运费折扣 | |
| promoShippingIncentiveAmount | N | BigDecimal | 免费送货运费补贴 | |
| shippingFeeSubsidyAmount | N | BigDecimal | 平台运费补贴 | |
| sellerShippingFeeDiscountAmount | N | BigDecimal | 卖家运费折扣 | |
| customerShippingFeeOffsetAmount | N | BigDecimal | 买家折扣后运费支出(仅US) | |
| fbmShippingCostAmount | N | BigDecimal | 卖家TikTOk Shipping运费支出 | |
| fbtShippingCostAmount | N | BigDecimal | 卖家FBT运费支出(除US) | |
| fbtFulfillmentFeeAmount | N | BigDecimal | 卖家FBT运费+仓库履行支出(仅US) |
1.7. TikTok回款记录查询接口
1.7.1. SERVICE_TYPE
QUERY_TIKTOK_WITHDRAWALS_DETAIL_LIST
1.7.2. 请求参数
| 参数 | 是否必须 | 类型 | 示例 | 备注 |
|---|---|---|---|---|
| shopIdList | N | List |
[1001] | 店铺id列表,不超过100个 与 shopNameList 二选一必填,若两者都提供,则以本参数为准 |
| shopNameList | N | List |
["店铺A"] | 店铺名称列表,不超过100个 与 shopIdList 二选一必填 |
| payoutTimeFrom | Y | Date | 2022-09-05 | 回款时间起始 |
| payoutTimeTo | Y | Date | 2022-09-05 | 回款时间结束 |
| updateTimeFrom | N | Date | 2022-09-05 00:00:00 | 更新时间起始 |
| updateTimeTo | N | Date | 2022-09-05 10:00:00 | 更新时间结束 |
| 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 | Long | 1735697410000 | 提现创建时间 |
| withdrawalsCreateTimestamp | N | Long | 1735697410000 | 提现创建时间戳 |
| withdrawalsCreateTimeFormatted | N | String | "2025-01-01 10:10:10" | 提现创建时间 |
| shopName | N | String | 店铺A | 店铺名称 |
| siteCode | N | String | PH | 站点 |
| updateTime | N | Date | 1735697410000 | 更新时间 |
| shopTimeZone | N | String | "Asia/Shanghai" | 店铺时区 |
| publicId | N | String | "550318454795" | 公共Id |
1.8. 进销存报表查询接口
1.8.1. SERVICE_TYPE
QUERY_INVENTORY_DAILY_REPORT
1.8.2. 请求参数
| 参数 | 是否必须 | 类型 | 示例 | 备注 |
|---|---|---|---|---|
| skuParam | N | String | 商品 | 商品编码/商品名称/UPC 输入框 |
| spuKeywords | N | String | 商品 | SPU/款式名称(模糊) |
| spuKeywordList | N | List |
["SPU-A"] | SPU/款式名称批量精确搜索 |
| warehouse | N | String | 仓库1 | 仓库名称。与 warehouses 至少填一个;都传时合并去重。须为开放应用已授权仓库 |
| warehouses | N | List |
["仓库1","仓库2"] | 仓库名称列表。与 warehouse 至少填一个;都传时合并去重。须为开放应用已授权仓库 |
| dateFrom | Y | String | 2025-01-18 | 快照开始时间(仓库时区) 最长跨度不超过1个月 (yyyy-MM-dd) |
| dateTo | Y | String | 2025-02-18 | 快照截止时间(仓库时区) 最长跨度不超过1个月 (yyyy-MM-dd) |
| enable | N | Integer | 1 | 系统商品状态:1启用,0停用 |
| warehouseSkuEnable | N | String | ON | 仓库商品状态:ON启用/OFF停用,兼容 1/0 |
| categorySelectList | N | List |
[{"categoryLevel1":11}] | 商品分类多选,详见 CategorySelect |
| page | Y | Integer | 1 | 页码,默认1 |
| pageSize | Y | Integer | 100 | 每页条数,不超过200条,默认100条 |
CategorySelect (商品分类)
| 参数 | 是否必须 | 类型 | 示例 | 备注 |
|---|---|---|---|---|
| categoryLevel1 | N | Long | 11 | 一级类目ID |
| categoryLevel2 | N | Long | 22 | 二级类目ID |
| categoryLevel3 | N | Long | 33 | 三级类目ID |
不支持仓库组筛选。金额按账号币种计价,不支持切换币种。
1.8.3. 返回参数
| 参数 | 是否必须 | 类型 | 示例 | 备注 |
|---|---|---|---|---|
| errorCode | Y | String | 错误码 | |
| errorMsg | Y | String | 业务错误信息 | |
| state | Y | String | 请求结果 | |
| total | Y | Integer | 100 | 总条数 |
| result | Y | List |
详见 OpenApiInventoryDailyReportDTO |
OpenApiInventoryDailyReportDTO (进销存数据)
金额字段为数字,不带货币符号;展示用 currency / currencySymbol。体积 = 对应数量 × 系统商品长×宽×高,缺尺寸为 0。费用为摊平字段,不含嵌套 costDetail、logList、statistics。
| 参数 | 是否必须 | 类型 | 示例 | 备注 |
|---|---|---|---|---|
| picUrl | N | String | 商品图片 | |
| sku | N | String | 1001 | 商品编码 |
| skuName | N | String | 123456 | 商品名称 |
| category | N | String | 商品分类 | |
| spu | N | String | SPU | |
| spuTitle | N | String | 款式名称 | |
| warehouseName | N | String | PHP | 仓库 |
| warehouseId | N | Long | 1001 | ERP 仓库主键 |
| color | N | String | RED | 颜色,取自系统商品 |
| size | N | String | M | 尺寸,取自系统商品 |
| itemPackage | N | Long | 1 | 包装,取自系统商品 |
| barcode | N | String | 商品条码,取自系统商品 | |
| upc | N | String | UPC,取自系统商品 | |
| customProp1 | N | String | 自定义1,取自系统商品 | |
| customProp2 | N | String | 自定义2,取自系统商品 | |
| totalBefore | N | Long | 10 | 期初库存 |
| totalCostBefore | N | BigDecimal | 40.0000 | 期初成本 |
| volumeBefore | N | BigDecimal | 1.2000 | 期初体积 |
| goodTotalBefore | N | Long | 8 | 期初库存(良品) |
| goodTotalCostBefore | N | BigDecimal | 32.0000 | 期初成本(良品) |
| goodVolumeBefore | N | BigDecimal | 0.9600 | 期初体积(良品) |
| defectiveTotalBefore | N | Long | 2 | 期初库存(不良品) |
| defectiveTotalCostBefore | N | BigDecimal | 8.0000 | 期初成本(不良品) |
| defectiveVolumeBefore | N | BigDecimal | 0.2400 | 期初体积(不良品) |
| costDetailBeforePurchaseFee | N | BigDecimal | 20.0000 | 期初采购费用 |
| costDetailBeforeFirstLegFee | N | BigDecimal | 10.0000 | 期初头程费用 |
| costDetailBeforeTransferFee | N | BigDecimal | 10.0000 | 期初调拨费用 |
| shippingQuantityBefore | N | Long | 50 | 期初在途 |
| shippingCostBefore | N | BigDecimal | 40.0000 | 期初在途成本 |
| shippingVolumeBefore | N | BigDecimal | 6.0000 | 期初在途体积 |
| inboundQuantity | N | Long | 20 | 入库数量 |
| inboundCost | N | BigDecimal | 40.0000 | 入库成本 |
| inboundVolume | N | BigDecimal | 2.4000 | 入库体积 |
| inboundCostDetailPurchaseFee | N | BigDecimal | 20.0000 | 入库采购费用 |
| inboundCostDetailFirstLegFee | N | BigDecimal | 10.0000 | 入库头程费用 |
| inboundCostDetailTransferFee | N | BigDecimal | 10.0000 | 入库调拨费用 |
| outboundQuantity | N | Long | 30 | 出库数量 |
| outboundCost | N | BigDecimal | 40.0000 | 出库成本 |
| outboundVolume | N | BigDecimal | 3.6000 | 出库体积 |
| outboundCostDetailPurchaseFee | N | BigDecimal | 20.0000 | 出库采购费用 |
| outboundCostDetailFirstLegFee | N | BigDecimal | 10.0000 | 出库头程费用 |
| outboundCostDetailTransferFee | N | BigDecimal | 10.0000 | 出库调拨费用 |
| totalAfter | N | Long | 40 | 期末库存 |
| totalCostAfter | N | BigDecimal | 40.0000 | 期末成本 |
| volumeAfter | N | BigDecimal | 4.8000 | 期末体积 |
| goodTotalAfter | N | Long | 36 | 期末库存(良品) |
| goodTotalCostAfter | N | BigDecimal | 36.0000 | 期末成本(良品) |
| goodVolumeAfter | N | BigDecimal | 4.3200 | 期末体积(良品) |
| defectiveTotalAfter | N | Long | 4 | 期末库存(不良品) |
| defectiveTotalCostAfter | N | BigDecimal | 4.0000 | 期末成本(不良品) |
| defectiveVolumeAfter | N | BigDecimal | 0.4800 | 期末体积(不良品) |
| costDetailAfterPurchaseFee | N | BigDecimal | 20.0000 | 期末采购费用 |
| costDetailAfterFirstLegFee | N | BigDecimal | 10.0000 | 期末头程费用 |
| costDetailAfterTransferFee | N | BigDecimal | 10.0000 | 期末调拨费用 |
| shippingQuantityAfter | N | Long | 60 | 期末在途 |
| shippingCostAfter | N | BigDecimal | 40.0000 | 期末在途成本 |
| shippingVolumeAfter | N | BigDecimal | 7.2000 | 期末在途体积 |
| shippingPurchaseFeeAfter | N | BigDecimal | 12.0000 | 期末在途采购费用 |
| iorder | N | Long | 1 | 订单入库 |
| ireturn | N | Long | 1 | 订单退货 |
| imanual | N | Long | 1 | 手工单入库 |
| ipurchase | N | Long | 1 | 采购单入库 |
| ifirstLeg | N | Long | 1 | 头程入库 |
| ifirstLegWithdrawShipped | N | Long | 1 | 头程撤销入库 |
| iplan | N | Long | 1 | 计划调拨入库 |
| iavailable | N | Long | 1 | 可用调拨入库 |
| iassembly | N | Long | 1 | 加工单入库 |
| irestore | N | Long | 1 | 拆分单入库 |
| adjustmentManual | N | Long | 1 | 手工调整单入库 |
| adjustmentAuto | N | Long | 1 | 自动调整单入库 |
| istorageLocation | N | Long | 1 | 库存转移入库 |
| countExtra | N | Long | 1 | 盘盈调增 |
| iimportInbound | N | Long | 1 | 库存导入 |
| oorder | N | Long | 1 | 订单出库 |
| omanualOdo | N | Long | 1 | 手工出库 |
| opurchaseReturn | N | Long | 1 | 采购退货出库 |
| ofirstLeg | N | Long | 1 | 头程出库 |
| oplan | N | Long | 1 | 计划调拨出库 |
| oavailable | N | Long | 1 | 可用调拨出库 |
| adjustmentManualOut | N | Long | 1 | 手工调整单出库 |
| adjustmentAutoOut | N | Long | 1 | 自动调整单出库 |
| oassembly | N | Long | 1 | 加工单出库 |
| orestore | N | Long | 1 | 拆分单出库 |
| ostorageLocation | N | Long | 1 | 库存转移出库 |
| countMissing | N | Long | 1 | 盘亏调减 |
| currency | N | String | CNY | 账号币种代码 |
| currencySymbol | N | String | ¥ | 账号币种符号 |