stable本次发布有变化全部展示
来自 TikTok Shop 官方资料快照 ·
- 当前资料结构化阅读页
- 固定快照已留存，可追溯
- 官方原文可核对
资料正文
§1 Path: /order/202407/orders/{order_id}/price_detail
#§2 Method: [GET]
#§3 Function Description
Get the detailed pricing calculation information of an order or a line item, including vouchers, tax, etc.
§4 Common Parameters
For common parameters, refer to How to call TikTok Shop APIs - Common Parameters
| Properties | Location | Type | Require | Sample | Properties description |
|---|---|---|---|---|---|
| shop_cipher | query | string | Y | GCP_XF90igAAAABh00qsWgtvOiGFNqyubMt3 | Use this property to pass shop information in requesting the API. Failure in passing the correct value when requesting the API for cross-border shops will return incorrect response. |
| Get by API Get Authorization Shop | |||||
| content-type | header | string | Y | application/json | Allowed type: application/json |
§5 Request Path Parameters
| Properties | Type | Require | Sample | Properties description |
|---|---|---|---|---|
| order_id | string | Y | 576461413038785752 | Order ID |
§6 Request Query Parameters
| Properties | Type | Require | Sample | Properties description |
|---|---|---|---|---|
| app_key | string | Y | 38abcd | Every single app will have a unique key. Please use the specific key assigned to your app. |
| sign | string | Y | 5361235029d141222525e303d742f9e38aea052d10896d3197ab9d6233730b8c | Signature generated by gen algorithm. When you send API requests to TTS, you must sign them so that TTS can identify the senders. |
| timestamp | int | Y | 1623812664 | Unix timestamp GMT (UTC+00:00). This timestamp is used across all API requests. Developers can use this convert to local time. |
§7 Request Sample
Query
https://open-api.tiktokglobalshop.com/order/202407/orders/576461413038785752/price_detail?app_key=123abc&sign=5361235029d141222525e303d742f9e38aea052d10896d3197ab9d6233730b8c×tamp=1625484268&shop_cipher=ROW_RHkDDABBAAB8tKAVoAqsMTjsQZFLyNfY
§8 Response Parameters
| Properties | Type | Sample | Properties description |
|---|---|---|---|
| code | int | 0 | The success or failure status code returned in API response. |
| message | string | Success | The success or failure messages returned in API response. Reasons of failure will be described in the message. |
| request_id | string | 202203070749000101890810281E8C70B7 | Request log |
| data | object | Specific return information | |
| ^currency | string | USD | Currency Type. Three-letter code, see ISO 4217. |
| ^total | string | 122.00 | Total number of the original price of the order. Calculation: sku_list_price + shipping_list_price |
| ^payment | string | 101.00 | Payment of the order from the buyer. Calculation: sku_sale_price + shipping_sale_price + tax_amount + small_order_fee |
| ^sku_list_price | string | 97.00 | Total MSRP price of the products. |
| ^sku_sale_price | string | 96.00 | Total promotional sale price of the products. Calculation: sku_list_price - subtotal_deduction_seller - subtotal_deduction_platform |
| ^subtotal | string | 98.00 | Total promotional sale price of the products including tax. Calculation: sku_sale_price + subtotal_tax_amount |
| ^subtotal_deduction_seller | string | 0.50 | Seller provided price discount on the product |
| ^subtotal_deduction_platform | string | 0.50 | Platform provided price discount on the product |
| ^subtotal_tax_amount | string | 2.00 | Total tax amount on the product |
| ^voucher_deduction_platform | string | 1010000 | Type of the platform-providing discount on the product. Possible values: |
1010000: PLATFORM_NEW_USER, | |||
1020000: SELLER_SKU_PRICE`, | |||
1030000: PLATFORM_FREE_SHIPPING | |||
| ^voucher_deduction_seller | string | 1020000 | Type of the seller-providing discount on the product. Possible values: |
1010000: PLATFORM_NEW_USER, | |||
1020000: SELLER_SKU_PRICE, | |||
1030000: PLATFORM_FREE_SHIPPING` | |||
| ^shipping_list_price | string | 25.00 | Original shipping price |
| ^shipping_sale_price | string | 3.00 | Promotional shipping price Calculation: shipping_list_price - shipping_fee_deduction -shipping_fee_deduction_platform |
| ^shipping_fee_deduction_seller | string | 10.00 | Shipping discount covered by the seller. |
| ^shipping_fee_deduction_platform | string | 12.00 | Shipping discount covered by the platform |
| ^shipping_fee_deduction_platform_voucher | string | 1010000 | Shipping discount covered by the platform voucher: |
1010000: PLATFORM_NEW_USER, | |||
1020000: SELLER_SKU_PRICE | |||
1030000: PLATFORM_FREE_SHIPPING | |||
| ^tax_amount | string | 2.00 | Total tax amount. Calculation: subtotal_tax_amount + shipping_fee_tax（in TaxDetail） + cod_fee_tax（TaxDetail） |
| ^tax_rate | string | 0.021 | Tax rate |
| ^net_price_amount | string | 97.00 | Price after tax |
| ^cod_fee | string | 0.00 | COD fee charged by shipping aggregators. For regions outside of Saudi Arabia, the value is 0.00. |
| ^cod_fee_net_amount | string | 0.00 | COD fee charged by shipping aggregators including tax. For regions outside of Saudi Arabia, the value is 0.00. |
| ^sku_gift_original_price | string | 2.00 | Original sku list price of the gift product from the seller. |
| ^sku_gift_net_price | string | 2.02 | Original sku list price of the gift product from the seller including tax. |
| ^distance_shipping_fee | string | 1.00 | Distance shipping fee is fee that charged charged by our logistics partner and covers the separate distance-based cost for deliveries outside Java island as a part of Horizon+ Program. |
| Only applicable in ID Market. | |||
| ^distance_fee | string | 2.00 | Total distance fee for Horizon+ Program. Only applicable for ID market |
| ^line_items | []object | Each object is the same as the "data" field (line 5) without "line_items" | |
| ^^id | string | 576461413032342720 | corresponding line_item id |
| ^^currency | string | USD | Currency Type. Three-letter code, see ISO 4217. |
| ^^total | string | 122.00 | Total number of the original price of the order. Calculation: sku_list_price + shipping_list_price |
| ^^payment | string | 101.00 | Payment of the order from the buyer. Calculation: sku_sale_price + shipping_sale_price + tax_amount + small_order_fee |
| ^^sku_list_price | string | 97.00 | Total MSRP price of the products. |
| ^^sku_sale_price | string | 96.00 | Total promotional sale price of the products. Calculation: sku_list_price - subtotal_deduction_seller - subtotal_deduction_platform |
| ^^subtotal | string | 98.00 | Total promotional sale price of the products including tax. Calculation: sku_sale_price + subtotal_tax_amount |
| ^^subtotal_deduction_seller | string | 0.50 | Seller provided price discount on the product |
| ^^subtotal_deduction_platform | string | 0.50 | Platform provided price discount on the product |
| ^^subtotal_tax_amount | string | 2.00 | Total tax amount on the product |
| ^^voucher_deduction_platform | string | 1010000 | Type of the platform-providing discount on the product. Possible values: |
1010000: PLATFORM_NEW_USER, | |||
1020000: SELLER_SKU_PRICE, | |||
1030000: PLATFORM_FREE_SHIPPING | |||
| ^^voucher_deduction_seller | string | 1020000 | Type of the seller-providing discount on the product. Possible values: |
1010000: PLATFORM_NEW_USER, | |||
1020000: SELLER_SKU_PRICE, | |||
1030000: PLATFORM_FREE_SHIPPING | |||
| ^^shipping_list_price | string | 25.00 | Original shipping price |
| ^^shipping_sale_price | string | 3.00 | Promotional shipping price Calculation: shipping_list_price - shipping_fee_deduction -shipping_fee_deduction_platform |
| ^^shipping_fee_deduction_seller | string | 10.00 | Shipping discount covered by the seller. |
| ^^shipping_fee_deduction_platform | string | 12.00 | Shipping discount covered by the platform |
| ^^shipping_fee_deduction_platform_voucher | string | 1010000 | Shipping discount covered by the platform voucher |
1010000: PLATFORM_NEW_USER | |||
1020000: SELLER_SKU_PRICE | |||
1030000: PLATFORM_FREE_SHIPPING | |||
| ^^tax_amount | string | 2.00 | Total tax amount. Calculation: subtotal_tax_amount + shipping_fee_tax（in TaxDetail） + cod_fee_tax（TaxDetail） |
| ^^tax_rate | string | 0.021 | Tax rate |
| ^^net_price_amount | string | 97.00 | Price after tax |
| ^^cod_fee | string | 0.00 | COD fee charged by shipping aggregators. For regions outside of Saudi Arabia, the value is 0.00. |
| ^^cod_fee_amount | string | 0.00 | COD fee charged by shipping aggregators including tax. For regions outside of Saudi Arabia, the value is 0.00. |
| ^^sku_gift_original_price | string | 2.00 | Original sku list price of the gift product from the seller. |
| ^^sku_gift_net_price | string | 2.02 | Original sku list price of the gift product from the seller including tax. |
| ^^distance_shipping_fee | string | 1.00 | Distance shipping fee is fee that charged charged by our logistics partner and covers the separate distance-based cost for deliveries outside Java island as a part of Horizon+ Program. |
| Only applicable in ID Market. | |||
| ^^distance_fee | string | 2.00 | Total distance fee for Horizon+ Program. Only applicable for ID market |
§9 Response Sample
{"code":0,"data":{"currency":"USD","total":"122.00","payment":"101.00","sku_list_price":"97.00","sku_sale_price":"96.00","subtotal":"98.00","subtotal_deduction_seller":"0.50","subtotal_deduction_platform":"0.50","subtotal_tax_amount":"2.00","voucher_deduction_platform":"1010000","voucher_deduction_seller":"1020000","shipping_list_price":"25.00","shipping_sale_price":"3.00","shipping_fee_deduction_seller":"10.00","shipping_fee_deduction_platform":"12.00","shipping_fee_deduction_platform_voucher":"1010000","tax_amount":"2.00","tax_rate":"0.021","net_price_amount":"97.00","cod_fee":"0.00","cod_fee_net_amount":"0.00","sku_gift_original_price":"2.00","sku_gift_net_price":"2.02","distance_shipping_fee":"1.00","distance_fee":"2.00","line_items":[{"id":"576461413032342720","currency":"USD","total":"122.00","payment":"101.00","sku_list_price":"97.00","sku_sale_price":"96.00","subtotal":"98.00","subtotal_deduction_seller":"0.50","subtotal_deduction_platform":"0.50","subtotal_tax_amount":"2.00","voucher_deduction_platform":"1010000","voucher_deduction_seller":"1020000","shipping_list_price":"25.00","shipping_sale_price":"3.00","shipping_fee_deduction_seller":"10.00","shipping_fee_deduction_platform":"12.00","shipping_fee_deduction_platform_voucher":"1010000","tax_amount":"2.00","tax_rate":"0.021","net_price_amount":"97.00","cod_fee":"0.00","cod_fee_amount":"0.00","sku_gift_original_price":"2.00","sku_gift_net_price":"2.02","distance_shipping_fee":"1.00","distance_fee":"2.00"}]},"message":"Success","request_id":"202203070749000101890810281E8C70B7"}
§10 Error Code
For common error codes, refer to How to call TikTok Shop APIs - Common Error Code
| Code | Message |
|---|---|
| 21001001 | Invalid parameters. Please ensure you are passing the correct request parameter(s). |
| 21008111 | The order or package does not belong to the current seller. |
| 36009003 | Internal error. Please try again. If the issue persists after multiple attempts, please contact platform support. |