US and UK markets: New properties added to Finance API

资料正文

§1 US and UK markets: New properties added to Finance API

§2 Summary

Summary

New properties added to the statement-related Finance API endpoints for more detailed finance statements. Please refer to the Required Actions section for more information on the new properties.

§3 Affected Markets and Sellers

Affected Markets and Sellers

This change applies to local sellers in the US and UK markets.

§4 Applicable API Versions

Applicable API Versions

This change applies to the v202309 API version.

§5 Required Actions

Required Actions

Developers who integrate with the following Finance APIs should apply these changes:

Refer to the following table for the properties added to each endpoint:

New properties	Description	Affected API(s)
`net_sales_amount`	The total revenue with any applicable seller discounts deducted. Used for US, UK L2L sellers only. `net_sales_amount = gross_sales_amount + gross_sales_refund_amount + seller_discount_amount + seller_discount_refund_amount`	* Get Order Statement Transactions * Get Statement Transactions * Get Statements
`gross_sales_amount`	The total revenue before any discounts from the seller or TikTok Shop has been deducted.	* Get Order Statement Transactions * Get Statement Transactions
`gross_sales_refund_amount`	The amount of gross sales refunded to customers.	* Get Order Statement Transactions * Get Statement Transactions
`seller_discount_amount`	Seller discounts are the total amount of discounts funded by the seller. These include: 1. Discounts funded by the seller through the seller's promotions (Product Discount, Flash Deal, Buy More Save More, Voucher and Bundle Deal) 2. Seller's portion of a co-funded voucher discount during the seller's participation in co-funding campaigns 3. Discounts funded by the seller during a campaign.	* Get Order Statement Transactions * Get Statement Transactions
`seller_discount_refund_amount`	Discounts refunded to the seller.	* Get Order Statement Transactions * Get Statement Transactions
`shipping_cost_amount`	Only for UK and US Local Sellers, represent the total fees related to shipping. Equates to `fbm_shipping_cost_amount + fbt_shipping_cost_amount + signature_confirmation_fee_amount + customer_paid_shipping_fee_amount + customer_paid_shipping_fee_refund_amount + shipping_cost_discount_amount + refund_shipping_cost_discount_amount + shipping_fee_subsidy_amount + return_shipping_fee_amount + shipping_insurance_amount`	* Get Order Statement Transactions * Get Statement Transactions * Get Statements
`customer_paid_shipping_fee_amount`	The shipping fee incurred by the customer based on the product weight you uploaded.	* Get Order Statement Transactions * Get Statement Transactions
`customer_paid_shipping_fee_refund_amount`	The refunded amount of customer-paid shipping fees deducted from your account.	* Get Order Statement Transactions * Get Statement Transactions
`shipping_fee_subsidy_amount`	The shipping fee subsidy provided by TikTok Shop for orders fulfilled by seller themselves.	* Get Order Statement Transactions * Get Statement Transactions
`return_shipping_fee_amount`	The shipping fee paid by the seller for the delivery of returns.	* Get Order Statement Transactions * Get Statement Transactions

Additionally, the settlement_amount is returned from the same three endpoints:

For orders created after 2024-01-01, the calculation for settlement_amount is adjusted as settlement_amount = net_sales_amount + shipping_cost_amount + fee_amount + adjustment_amount.