The container that returns information about the costs of the order, such as the total cost, discounts, etc., of all the line items.
Types that use PricingSummary
CheckoutSessionResponsePurchaseOrder
Calls that use PricingSummary
Fields
addonServicesFee
The total amount of fees for all add-on services among all line items. If the checkout session does not include any add-on services, this value is returned as zero.
adjustment
The total amount of any seller adjustments. An adjustment can be a credit or debit. This is used to catch any monetary changes to the order that are not already captured in one of the other fields.
deliveryCost
The shipping cost for all of the line items after any shipping discounts are applied.
Let's say there are four line items, and the shipping cost for each line item is $5. One of the line items qualifies for free shipping. The deliveryCost value would be $15, which is the total cost for shipping all of the line items after the discount is applied.
Let's say there are four line items, and the shipping cost for each line item is $5. One of the line items qualifies for free shipping. The deliveryCost value would be $15, which is the total cost for shipping all of the line items after the discount is applied.
deliveryDiscount
The total amount of the order shipping discounts for all of the line items, such as free shipping.
Let's say there are four line items, and the shipping cost for each line item is $5. One of the line items qualifies for free shipping. The deliveryDiscounts value would be 5, which is the value of the free shipping discount.
Note: This will always be a negative number.
Let's say there are four line items, and the shipping cost for each line item is $5. One of the line items qualifies for free shipping. The deliveryDiscounts value would be 5, which is the value of the free shipping discount.
Note: This will always be a negative number.
importCharges
The sum of all the Global Shipping Program import charges for all the line items.
Note: US sellers are transitioning from GSP to eBay International Shipping (eIS), and for any seller already transitioned to eIS, import charges will be shown in the
Note: US sellers are transitioning from GSP to eBay International Shipping (eIS), and for any seller already transitioned to eIS, import charges will be shown in the
ImportDuties
container instead.importDuties
The total amount of import duties for all line items, which is paid by the buyer when checking out.
Note: This is applicable only for eBay International Shipping (eIS) orders, and eIS is only available to sellers on US marketplace.
For GSP orders, the import charges will be shown in the
Note: This is applicable only for eBay International Shipping (eIS) orders, and eIS is only available to sellers on US marketplace.
For GSP orders, the import charges will be shown in the
pricingSummary.importCharges
container.importTax
This container provides the type of import tax applicable to the order, and the total amount of tax for all line items in the order.
priceDiscount
The total amount of all the item discounts for all line items, such as Buy 1 Get 1 free.
Let's say there were 4 line items. One of the line items qualifies for free shipping, which is $5 and two items qualify for a Buy 1 Get 1 offer, which is a $6 and a $15 discount.
The priceDiscount value would be 21, which is the total of the two Buy 1 Get 1 discounts. The shipping discount in not included. It is returned in the deliveryDiscount field.
Note: This will always be a negative number.
Let's say there were 4 line items. One of the line items qualifies for free shipping, which is $5 and two items qualify for a Buy 1 Get 1 offer, which is a $6 and a $15 discount.
The priceDiscount value would be 21, which is the total of the two Buy 1 Get 1 discounts. The shipping discount in not included. It is returned in the deliveryDiscount field.
Note: This will always be a negative number.
priceSubtotal
The total amount for all the line items taking into account the item quantity but before adding in taxes and shipping costs, or applying discounts, fees, and adjustments.
Note: The price includes the value-added tax (VAT) for applicable jurisdictions when requested from supported marketplaces. In this case, users must pass the
Note: The price includes the value-added tax (VAT) for applicable jurisdictions when requested from supported marketplaces. In this case, users must pass the
X-EBAY-C-MARKETPLACE-ID
request header specifying the supported marketplace (such as EBAY_GB
) to see VAT-inclusive pricing. For more information on VAT, refer to VAT Obligations in the EU.total
The total of the purchase order.
total = priceSubtotal + priceDiscount + deliveryCost + deliveryDiscounts + tax + additionalSavings + adjustment + fee + importCharges
Note: additionalSavings, deliveryDiscounts, and priceDiscount are negative numbers.
total = priceSubtotal + priceDiscount + deliveryCost + deliveryDiscounts + tax + additionalSavings + adjustment + fee + importCharges
Note: additionalSavings, deliveryDiscounts, and priceDiscount are negative numbers.