Skip to content

Get Order Price Details

GET
/order/202407/orders/{order_id}/price_detail

Get the detailed pricing calculation information of an order or a line item, including vouchers, tax, etc.

order_id
required
string

Order ID

shop_cipher
required
string

Identifies the shop. Obtain it from the Get Authorized Shops API.

Success

Media typeapplication/json
object
code

Status code; 0 means success.

integer format: int64
message

Success or failure message.

string
request_id

Request log ID.

string
data
object
currency

Currency Type. Three-letter code, see ISO 4217.

string
total

Total original price of the order. Calculation: sku_list_price + shipping_list_price

string
payment

Amount paid by the buyer for the order.

string
sku_list_price

Total MSRP price of the products.

string
sku_sale_price

Total promotional sale price of the products. Calculation: sku_list_price - subtotal_deduction_seller - subtotal_deduction_platform

string
subtotal

Total promotional sale price of the products in the order, including tax.

string
subtotal_deduction_seller

Seller provided price discount on the product

string
subtotal_deduction_platform

Platform provided price discount on the product

string
subtotal_tax_amount

Total tax amount on the product

string
voucher_deduction_platform

Total product-price deduction from platform-funded vouchers for the order.

string
voucher_deduction_seller

Total product-price deduction from seller-funded vouchers for the order.

string
shipping_list_price

Original shipping price

string
shipping_sale_price

Promotional shipping price. Calculation: shipping_list_price - shipping_fee_deduction_seller - shipping_fee_deduction_platform

string
shipping_fee_deduction_seller

Shipping discount covered by the seller.

string
shipping_fee_deduction_platform

Shipping discount covered by the platform

string
shipping_fee_deduction_platform_voucher

Shipping-fee deduction from platform-funded vouchers for the order.

string
tax_amount

Total tax amount for the order.

string
tax_rate

Tax rate

string
net_price_amount

Order price excluding tax.

string
cod_fee

COD fee charged by shipping aggregators. For regions outside of Saudi Arabia, the value is 0.00.

string
cod_fee_net_amount

COD fee charged by shipping aggregators including tax. For regions outside of Saudi Arabia, the value is 0.00.

string
sku_gift_original_price

Original sku list price of the gift product from the seller.

string
sku_gift_net_price

Original sku list price of the gift product from the seller including tax.

string
distance_shipping_fee

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.

string
distance_fee

Total distance fee for Horizon+ Program. Only applicable for ID market

string
line_items

Price details for each line item in the order.

Array<object>
object
id

Corresponding line_item id

string
currency

Currency Type. Three-letter code, see ISO 4217.

string
total

Total original price of the line item. Calculation: sku_list_price + shipping_list_price

string
payment

Amount paid by the buyer for the line item.

string
sku_list_price

Total MSRP price of the products.

string
sku_sale_price

Total promotional sale price of the products. Calculation: sku_list_price - subtotal_deduction_seller - subtotal_deduction_platform

string
subtotal

Total promotional sale price for the line item, including tax.

string
subtotal_deduction_seller

Seller provided price discount on the product

string
subtotal_deduction_platform

Platform provided price discount on the product

string
subtotal_tax_amount

Total tax amount on the product

string
voucher_deduction_platform

Product-price deduction from platform-funded vouchers for the line item.

string
voucher_deduction_seller

Product-price deduction from seller-funded vouchers for the line item.

string
shipping_list_price

Original shipping price

string
shipping_sale_price

Promotional shipping price. Calculation: shipping_list_price - shipping_fee_deduction_seller - shipping_fee_deduction_platform

string
shipping_fee_deduction_seller

Shipping discount covered by the seller.

string
shipping_fee_deduction_platform

Shipping discount covered by the platform

string
shipping_fee_deduction_platform_voucher

Shipping-fee deduction from platform-funded vouchers for the line item.

string
tax_amount

Total tax amount for the line item.

string
tax_rate

Tax rate

string
net_price_amount

Line item price excluding tax.

string
cod_fee

COD fee charged by shipping aggregators. For regions outside of Saudi Arabia, the value is 0.00.

string
cod_fee_amount

COD fee charged by shipping aggregators including tax. For regions outside of Saudi Arabia, the value is 0.00.

string
sku_gift_original_price

Original sku list price of the gift product from the seller.

string
sku_gift_net_price

Original sku list price of the gift product from the seller including tax.

string
distance_shipping_fee

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.

string
distance_fee

Total distance fee for Horizon+ Program. Only applicable for ID market

string
seller_funded_product_promotions

Seller-funded product promotions associated with the line item.

Array<object>
object
activity_id

A unique ID that identifies different promotion activities.

string
discount_amount

Discount amount of this activity

string
discount_type

Discount type of this activity. Enumerations:

  • COUPON
  • ACTIVITY
string
Allowed values: COUPON ACTIVITY
seller_funded_shipping_promotions

Seller-funded shipping promotions associated with the line item.

Array<object>
object
activity_id

A unique ID that identifies different promotion activities.

string
discount_amount

Discount amount of this activity

string
discount_type

Discount type of this activity. Enumerations:

  • COUPON
  • ACTIVITY
string
Allowed values: COUPON ACTIVITY
Example
{
"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",
"seller_funded_product_promotions": [
{
"activity_id": "7136104329798256386",
"discount_amount": "2.25",
"discount_type": "COUPON"
}
],
"seller_funded_shipping_promotions": [
{
"activity_id": "7136104329798256386",
"discount_amount": "2.25",
"discount_type": "COUPON"
}
]
}
]
},
"message": "Success",
"request_id": "202203070749000101890810281E8C70B7"
}