1. Report Module API
API URL
post {HTTP(S) address}/api/{version}/report
1.1. Shopee Transaction Details Query Interface
1.1.1. SERVICE_TYPE
QUERY_SHOPEE_TRANSACTION_DETAIL_LIST
1.1.2. Request Parameters
| Parameter | Required | Type | Example | Description |
|---|---|---|---|---|
| shopNameList | Y | List |
["Shop A"] | Shop name list |
| type | Y | Integer | 1 | Bill type: Bill details (1) or Cross-border store adjustment fee (2) |
| adjustmentLevel | N | String | ORDER | Adjustment dimension, required when type=2, ORDER or SHOP |
| payoutTimeFrom | N | Date | 2022-09-05 | Payout start time |
| payoutTimeTo | N | Date | 2022-09-05 | Payout end time |
| updateTimeFrom | N | Date | 2022-09-05 00:00:00 | Update start time |
| updateTimeTo | N | Date | 2022-09-05 10:00:00 | Update end time |
| onlineOrderId | N | String | 2011asd | Platform online order number |
| onlineOrderIdList | N | List |
["2011asd"] | Platform online order number list |
| page | Y | Integer | 1 | Page number, default 1 |
| pageSize | Y | Integer | 100 | Number of entries per page, no more than 200, default 100 |
1.1.3. Response Parameters
| Parameter | Required | Type | Example | Description |
|---|---|---|---|---|
| errorCode | Y | String | Error Code | |
| errorMsg | Y | String | Business error message | |
| state | Y | String | Request Result | |
| total | Y | Integer | 100 | Total count |
| result | Y | List |
See ShopeeReportDTO for details |
ShopeeReportDTO (Shopee Transaction Details)
| Parameter | Required | Type | Example | Description |
|---|---|---|---|---|
| shopId | Y | Long | 1001 | Shop ID |
| onlineShopId | Y | String | 123456 | Online shop ID |
| shopName | Y | String | Shop A | Shop name |
| ordersn | Y | String | 2011asd | Order number |
| payoutTime | Y | Date | Order payout time | |
| currency | Y | String | PHP | Currency Currency Unit |
| adjustmentLevel | N | String | ORDER | Adjustment dimension |
| orderStatus | N | String | COMPLETED | Order status |
| returnsn | N | String | Return order number | |
| refundsn | N | String | Refund order number | |
| escrowAmount | N | BigDecimal | Escrow amount | |
| originalPrice | N | BigDecimal | Original price | |
| sellerDiscount | N | BigDecimal | Product discount | |
| productSaleAmount | N | BigDecimal | Discounted product amount | |
| refundAmount | N | BigDecimal | Refund amount | |
| shopeeDiscount | N | BigDecimal | Shopee discount amount | |
| voucherFromSeller | N | BigDecimal | Seller coupon amount | |
| sellerCoinCashBack | N | BigDecimal | Seller's Shopee coin cashback | |
| buyerPaidShippingFee | N | BigDecimal | Shipping fee paid by buyer | |
| shopeeShippingRebate | N | BigDecimal | Shopee shipping rebate | |
| actualShippingFee | N | BigDecimal | Actual shipping fee | |
| reverseShippingFee | N | BigDecimal | Reverse shipping fee | |
| commissionFee | N | BigDecimal | Commission fee | |
| serviceFee | N | BigDecimal | Service fee | |
| rsfSellerProtectionFeeClaimAmount | N | BigDecimal | Reverse shipping fee insurance | |
| rsfSellerProtectionFeePremiumAmount | N | BigDecimal | Reverse shipping fee reduction | |
| orderAmsCommissionFee | N | BigDecimal | AMS commission | |
| deliverySellerProtectionFeePremiumAmount | N | BigDecimal | 3PL buyer shipping fee insurance | |
| sellerTransactionFee | N | BigDecimal | Transaction fee | |
| escrowTax | N | BigDecimal | Customs duty | |
| sellerLostCompensation | N | BigDecimal | Loss compensation | |
| sellerShippingDiscount | N | BigDecimal | Seller's shipping promotion | |
| buyerTotalAmount | N | BigDecimal | Amount actually paid by buyer | |
| coins | N | BigDecimal | Shopee coins | |
| voucherFromShopee | N | BigDecimal | Shopee coupon amount | |
| crossBorderTax | N | BigDecimal | Cross-border tax | |
| paymentPromotion | N | BigDecimal | Payment promotion | |
| estimatedShippingFee | N | BigDecimal | Estimated shipping fee | |
| finalShippingFee | N | BigDecimal | Final shipping fee | |
| shippingFeeDiscountFrom3pl | N | BigDecimal | 3PL shipping fee discount | |
| sellerVoucherCode | N | String | Seller coupon code | |
| offlineAdjustment | N | BigDecimal | Adjustment fee | |
| module | N | String | Fee type (only available when querying cross-border store adjustment fee) | |
| scenario | N | String | Adjustment scenario (only available when querying cross-border store adjustment fee) | |
| adjustmentAmount | N | BigDecimal | Adjustment amount (only available when querying cross-border store adjustment fee) | |
| remark | N | String | Remarks (only available when querying cross-border store adjustment fee) | |
| updateTime | N | Date | Update time |
1.2. Lazada Transaction Details Query Interface
1.2.1. SERVICE_TYPE
QUERY_LAZADA_TRANSACTION_DETAIL_LIST
1.2.2. Request Parameters
| Parameter | Required | Type | Example | Description |
|---|---|---|---|---|
| shopNameList | Y | List |
["Shop A"] | Shop name list |
| payoutTimeFrom | N | Date | 2022-09-05 | Payout start time |
| payoutTimeTo | N | Date | 2022-09-05 | Payout end time |
| updateTimeFrom | N | Date | 2022-09-05 00:00:00 | Update start time |
| updateTimeTo | N | Date | 2022-09-05 10:00:00 | Update end time |
| onlineOrderId | N | String | 2011asd | Order number |
| onlineOrderIdList | N | List |
["2011asd"] | Order number list |
| feeName | N | String | Fee name | |
| page | Y | Integer | 1 | Page number, default 1 |
| pageSize | Y | Integer | 100 | Number of entries per page, no more than 200, default 100 |
1.2.3. Response Parameters
| Parameter | Required | Type | Example | Description |
|---|---|---|---|---|
| errorCode | Y | String | Error Code | |
| errorMsg | Y | String | Business error message | |
| state | Y | String | Request Result | |
| total | Y | Integer | 100 | Total count |
| result | Y | List |
See LazadaReportDTO for details |
LazadaReportDTO (Lazada Transaction Details)
| Parameter | Required | Type | Example | Description |
|---|---|---|---|---|
| shopId | Y | Long | 1001 | Shop ID |
| onlineShopId | Y | String | 123456 | Online shop ID |
| shopName | Y | String | Shop A | Shop name |
| transactionDate | Y | String | 2022-09-05 | Date |
| transactionNumber | Y | String | Transaction number | |
| transactionType | Y | String | Transaction type | |
| orderNo | Y | String | 2011asd | Order number |
| feeName | N | String | Fee name | |
| currency | N | String | PHP | Currency Currency Unit |
| amount | N | String | Total transaction amount | |
| details | N | String | Details | |
| sellerSku | N | String | Seller SKU | |
| vatInAmount | N | String | VAT | |
| whtAmount | N | String | WHT | |
| comment | N | String | Remarks | |
| updateTime | N | Date | Update time |
1.3. TikTok Transaction Details Query Interface
1.3.1. SERVICE_TYPE
QUERY_TIKTOK_TRANSACTION_DETAIL_LIST
1.3.2. Request Parameters
| Parameter | Required | Type | Example | Description |
|---|---|---|---|---|
| shopNameList | Y | List |
["Shop A"] | Shop name list |
| payoutTimeFrom | Y | Date | 2022-09-05 | Payout start time |
| payoutTimeTo | Y | Date | 2022-09-05 | Payout end time |
| onlineOrderId | N | String | 2011asd | Order number |
| onlineOrderIdList | N | List |
["2011asd"] | Order number list |
| page | Y | Integer | 1 | Page number, default 1 |
| pageSize | Y | Integer | 100 | Number of entries per page, no more than 200, default 100 |
1.3.3. Response Parameters
| Parameter | Required | Type | Example | Description |
|---|---|---|---|---|
| errorCode | Y | String | Error Code | |
| errorMsg | Y | String | Business error message | |
| state | Y | String | Request Result | |
| total | Y | Integer | 100 | Total count |
| result | Y | List |
See TiktokReportDTO for details |
TiktokReportDTO (TikTok Transaction Details)
| Parameter | Required | Type | Example | Description |
|---|---|---|---|---|
| shopName | Y | String | Shop A | Shop name |
| currency | Y | String | PHP | Currency Currency Unit |
| orderId | Y | String | 2011asd | Order number |
| adjustmentId | Y | String | Adjustment order number | |
| relatedOrderId | Y | String | Related order number | |
| settlementTime | N | Date | Settlement time | |
| skuId | N | String | SKU ID | |
| skuName | N | String | SKU name | |
| productName | N | String | Product name | |
| userPay | N | BigDecimal | Payment by buyer | |
| platformPromotion | N | BigDecimal | Platform promotion | |
| shippingFeeSubsidy | N | BigDecimal | Shipping fee subsidy | |
| refund | N | BigDecimal | Refund | |
| paymentFee | N | BigDecimal | Transaction fee | |
| platformCommission | N | BigDecimal | Platform commission | |
| flatFee | N | BigDecimal | Flat fee | |
| salesFee | N | BigDecimal | Sales fee | |
| affiliateCommission | N | BigDecimal | Affiliate commission | |
| vat | N | BigDecimal | VAT | |
| shippingFee | N | BigDecimal | Platform shipping fee | |
| smallOrderFee | N | BigDecimal | Small order fee | |
| affiliatePartnerCommission | N | BigDecimal | Affiliate partner commission | |
| sellerReasonFundDeduction | N | BigDecimal | Compensation for loss | |
| shippingFeeAdjustment | N | BigDecimal | Shipping fee adjustment | |
| chargeBack | N | BigDecimal | Difference amount | |
| customerServiceCompensation | N | BigDecimal | After-sales compensation | |
| promotionAdjustment | N | BigDecimal | Promotion adjustment fee | |
| otherAdjustment | N | BigDecimal | Other adjustment fee | |
| settlementAmount | N | BigDecimal | Settlement amount | |
| transactionFee | N | BigDecimal | Transaction fee | |
| subtotalAfterSellerDiscounts | N | BigDecimal | Discounted product sales amount | |
| refundSubtotalAfterSellerDiscounts | N | BigDecimal | Discounted product refund amount | |
| gst | N | BigDecimal | GST (Singapore) | |
| sfpServiceFee | N | BigDecimal | SFP service fee | |
| updateTime | N | Date | Update time |
1.4. Shopee Payout Record Query Interface
1.4.1. SERVICE_TYPE
QUERY_SHOPEE_PAYOUT_DETAIL_LIST
1.4.2. Request Parameters
| Parameter | Required | Type | Example | Description |
|---|---|---|---|---|
| shopNameList | Y | List |
["Shop A"] | Shop name list |
| payoutTimeFrom | Y | Date | 2022-09-05 | Payout start time |
| payoutTimeTo | Y | Date | 2022-09-05 | Payout end time |
| type | N | String | Type | |
| payoutStatus | N | String | Transaction Status | |
| transactionType | N | String | Transaction type | |
| onlineOrderId | N | String | 2011asd | Order number |
| onlineOrderIdList | N | List |
["2011asd"] | Order number list |
| page | Y | Integer | 1 | Page number, default 1 |
| pageSize | Y | Integer | 100 | Number of entries per page, no more than 200, default 100 |
1.4.3. Response Parameters
| Parameter | Required | Type | Example | Description |
|---|---|---|---|---|
| errorCode | Y | String | Error Code | |
| errorMsg | Y | String | Business error message | |
| state | Y | String | Request Result | |
| total | Y | Integer | 100 | Total count |
| result | Y | List |
See ShoppeePayoutReportDTO for details |
ShoppeePayoutReportDTO (Shopee Payout Details)
| Parameter | Required | Type | Example | Description |
|---|---|---|---|---|
| shopId | Y | Long | 1001 | Shop ID |
| onlineShopId | Y | String | 123456 | Online shop ID |
| shopName | Y | String | Shop A | Shop name |
| platform | Y | String | Shopee | Platform |
| siteCode | Y | String | PH | Site |
| currency | Y | String | PHP | Currency Currency Unit |
| type | N | String | Type | |
| payType | N | String | Payment method | |
| transactionId | N | String | Transaction ID | |
| payoutStatus | N | String | Transaction status | |
| transactionType | N | String | Transaction type | |
| amount | N | BigDecimal | Amount | |
| currentBalance | N | BigDecimal | Current balance | |
| transactionTime | N | Date | Transaction time | |
| updateTime | N | Date | Update time | |
| orderSn | N | String | 2011asd | Order number |
| refundSn | N | String | Refund order number | |
| withdrawalType | N | String | ||
| transactionFee | N | BigDecimal | Transaction fee | |
| description | N | String | Description | |
| buyerName | N | String | Buyer name | |
| withdrawId | N | String | ||
| reason | N | String | ||
| rootWithdrawalId | N | String | ||
| payoutExchangeCurrency | N | String | ||
| payoutExchangeAmount | N | BigDecimal | Actual amount | |
| payoutExchangeRate | N | String | Exchange rate | |
| payoutPayeeId | N | String |
1.5. Lazada My Balance Query Interface
1.5.1. SERVICE_TYPE
QUERY_LAZADA_ACCOUNT_TRANSACTION_LIST
1.5.2. Request Parameters
| Parameter | Required | Type | Example | Description |
|---|---|---|---|---|
| shopNameList | Y | List |
["Shop A"] | Shop name list |
| payoutTimeFrom | Y | Date | 2022-09-05 | Payout start time |
| payoutTimeTo | Y | Date | 2022-09-05 | Payout end time |
| transactionNumberList | N | List |
["T123"] | Transaction number list |
| typeList | N | List |
["Type A"] | Type List |
| page | Y | Integer | 1 | Page number, default 1 |
| pageSize | Y | Integer | 100 | Number of entries per page, no more than 200, default 100 |
1.5.3. Response Parameters
| Parameter | Required | Type | Example | Description |
|---|---|---|---|---|
| errorCode | Y | String | Error Code | |
| errorMsg | Y | String | Business error message | |
| state | Y | String | Request Result | |
| total | Y | Integer | 100 | Total count |
| result | Y | List |
See LazadaAccountTransactionReportDTO for details |
LazadaAccountTransactionReportDTO (Lazada Account Transaction Details)
| Parameter | Required | Type | Example | Description |
|---|---|---|---|---|
| customerId | N | Long | 1001 | Customer ID |
| shopId | N | Long | 1001 | Shop ID |
| onlineShopId | N | String | 123456 | Online shop ID |
| siteCode | N | String | PH | Site |
| transactionNumber | N | String | T123 | Transaction number |
| transactionTime | N | Date | Transaction time | |
| type | N | String | Type A | Type |
| subType | N | String | Subtype A | Subtype |
| amount | N | BigDecimal | Amount | |
| currency | N | String | PHP | Currency Currency Unit |
| remarks | N | String | Remarks | |
| payeeAccount | N | String | Account | |
| payeeDescription | N | String | Description | |
| payeeJson | N | String | ||
| trackingListJson | N | String | ||
| shopName | N | String | Shop A | Shop name |
| platform | N | String | Lazada | Platform name |
1.6. TikTok V2 Transaction Details Query Interface
1.6.1. SERVICE_TYPE
QUERY_TIKTOK_V2_TRANSACTION_DETAIL_LIST
1.6.2. Request Parameters
| Parameter | Required | Type | Example | Description |
|---|---|---|---|---|
| shopNameList | Y | List |
["Shop A"] | Shop name list |
| payoutTimeFrom | N | Date | 2022-09-05 | Payout start time |
| payoutTimeTo | N | Date | 2022-09-05 | Payout end time |
| updateTimeFrom | N | Date | 2022-09-05 00:00:00 | Update start time |
| updateTimeTo | N | Date | 2022-09-05 10:00:00 | Update end time |
| onlineOrderId | N | String | 2011asd | Order number |
| onlineOrderIdList | N | List |
["2011asd"] | Order number list |
| page | Y | Integer | 1 | Page number, default 1 |
| pageSize | Y | Integer | 100 | Number of entries per page, no more than 200, default 100 |
1.6.3. Response Parameters
| Parameter | Required | Type | Example | Description |
|---|---|---|---|---|
| errorCode | Y | String | Error Code | |
| errorMsg | Y | String | Business error message | |
| state | Y | String | Request Result | |
| total | Y | Integer | 100 | Total count |
| result | Y | List |
See TiktokV2025SettlementReportDTO for details |
TiktokV2025SettlementReportDTO (TikTok V2 Transaction Details)
| Parameter | Required | Type | Example | Description |
|---|---|---|---|---|
| shopId | Y | Long | 1001 | Shop ID |
| onlineShopId | Y | String | 123456 | Online shop ID |
| currency | Y | String | PHP | Currency Currency Unit |
| platform | Y | String | TikTok | Platform information |
| shopName | Y | String | Shop A | Shop name |
| typeCode | N | String | Type | |
| orderId | N | String | 2011asd | Order number |
| orderCreateTime | N | Long | Order creation time | |
| settlementTime | N | Date | Settlement transaction time | |
| adjustmentId | N | String | Adjustment order | |
| adjustmentOrderId | N | String | Adjustment related order | |
| adjustmentAmount | N | BigDecimal | Adjustment fee | |
| settlementAmount | N | BigDecimal | Settlement fee | |
| revenueAmount | N | BigDecimal | Revenue | |
| shippingCostAmount | N | BigDecimal | Shipping fee | |
| feeTaxAmount | N | BigDecimal | Take fee_tax_breakdown total value | |
| totalFees | N | BigDecimal | Total fees take fee_tax | |
| subtotalAfterDiscountAmount | N | BigDecimal | Calculated discounted product amount | |
| refundSubtotalAfterDiscountAmount | N | BigDecimal | Discounted product amount (refund) | |
| subtotalBeforeDiscountAmount | N | BigDecimal | Product amount before discount | |
| sellerDiscountAmount | N | BigDecimal | Seller discount | |
| refundSubtotalBeforeDiscountAmount | N | BigDecimal | Product amount before discount refund | |
| sellerDiscountRefundAmount | N | BigDecimal | Seller discount amount refund | |
| codServiceFeeAmount | N | BigDecimal | COD service fee | |
| refundCodServiceFeeAmount | N | BigDecimal | COD refund service fee | |
| feePlatformCommissionAmount | N | BigDecimal | Platform commission | |
| feeReferralFeeAmount | N | BigDecimal | Referral fee | |
| feeRefundAdministrationFeeAmount | N | BigDecimal | Refund administration fee | |
| feeTransactionFeeAmount | N | BigDecimal | Transaction fee | |
| feeCreditCardHandlingFeeAmount | N | BigDecimal | Credit card handling fee | |
| feeAffiliateCommissionAmount | N | BigDecimal | Affiliate commission | |
| feeAffiliateCommissionAmountBeforePit | N | BigDecimal | Pre-tax affiliate commission | |
| feeAffiliatePartnerCommissionAmount | N | BigDecimal | Affiliate partner commission | |
| feeAffiliateAdsCommissionAmount | N | BigDecimal | Affiliate advertising commission | |
| feeSfpServiceFeeAmount | N | BigDecimal | SFP service fee | |
| feeLiveSpecialsFeeAmount | N | BigDecimal | LIVE service fee | |
| feeBonusCashbackServiceFeeAmount | N | BigDecimal | Bonus cashback service fee | |
| feeMallServiceFeeAmount | N | BigDecimal | Platform mall service fee | |
| taxVatAmount | N | BigDecimal | VAT (cross-border store) | |
| taxImportVatAmount | N | BigDecimal | Import VAT | |
| taxCustomsDutyAmount | N | BigDecimal | Customs duty (cross-border store) | |
| taxCustomsClearanceAmount | N | BigDecimal | Customs clearance tax (cross-border store) | |
| taxSstAmount | N | BigDecimal | SST service tax | |
| taxGstAmount | N | BigDecimal | GST service tax | |
| udf1 to udf15 | N | BigDecimal | Custom fields | |
| updateTime | N | Date | Update time |
1.7. TikTok Payout Record Query Interface
1.7.1. SERVICE_TYPE
QUERY_TIKTOK_WITHDRAWALS_DETAIL_LIST
1.7.2. Request Parameters
| Parameter | Required | Type | Example | Description |
|---|---|---|---|---|
| shopNameList | Y | List |
["Shop A"] | Shop name list |
| payoutTimeFrom | Y | Date | 2022-09-05 | Payout start time |
| payoutTimeTo | Y | Date | 2022-09-05 | Payout end time |
| typeList | N | List |
["Type A"] | Transaction Type List |
| page | Y | Integer | 1 | Page number, default 1 |
| pageSize | Y | Integer | 100 | Number of entries per page, no more than 200, default 100 |
1.7.3. Response Parameters
| Parameter | Required | Type | Example | Description |
|---|---|---|---|---|
| errorCode | Y | String | Error Code | |
| errorMsg | Y | String | Business error message | |
| state | Y | String | Request Result | |
| total | Y | Integer | 100 | Total count |
| result | Y | List |
See TiktokWithdrawalsWebReportDTO for details |
TiktokWithdrawalsWebReportDTO (TikTok Withdrawal Details)
| Parameter | Required | Type | Example | Description |
|---|---|---|---|---|
| shopId | Y | Long | 1001 | Shop ID |
| onlineShopId | Y | String | 123456 | Online shop ID |
| withdrawalsId | N | String | ID | |
| type | N | String | Type A | Transaction Type |
| amount | N | BigDecimal | Amount | |
| currency | N | String | PHP | Currency Currency Unit |
| status | N | String | Status | |
| withdrawalsCreateTime | N | Date | Withdrawal creation time | |
| withdrawalsCreateTimestamp | N | Long | Withdrawal creation timestamp | |
| shopName | N | String | Shop A | Shop name |
| siteCode | N | String | PH | Site |