eBay Merchant Data APIVersion 1179

OrderLineItemType

Specifics for the sale data for a single SKU or item.

Type that uses OrderLineItemType:

Calls that use OrderLineItemType:

Fields



ActualShippingCost ( AmountType (double) ) [0..1]
This indicates the shipping cost for the order line item, and it's only emitted if promotional shipping service is selected and payment has been made.
See the Field Index to learn which calls use ActualShippingCost.

BuyerPaymentTransactionNumber ( string ) [0..1]
If payment has been marked as sent (on the Buyer's MyeBay page), this field returns the transaction number assigned to the payment event by the eBay application. Sellers might use this field to determine when they can ship an item. This field is only included in the response after the Buyer has completed checkout.

If a buyer has completed checkout using PayPal, the Payment is automatically marked as sent, and the BuyerPaymentTransactionNumber will be the same number as the PayPal External Transaction ID. Otherwise, the buyer must mark the item as paid manually on the MyeBay page.
See the Field Index to learn which calls use BuyerPaymentTransactionNumber.

FeeAmount ( AmountType (double) ) [0..1]
Fee Amount for a certain Fee type.
See the Field Index to learn which calls use FeeAmount.

FeeDescription ( string ) [0..1]
Description of the fee type.
See the Field Index to learn which calls use FeeDescription.

GlobalCategoryDescription ( string ) [0..1]
Description of the category used.
See the Field Index to learn which calls use GlobalCategoryDescription.

InsuranceCost ( AmountType (double) ) [0..1]
Cost of insuring the delivery of this order with the courier.
See the Field Index to learn which calls use InsuranceCost.

ItemID ( ItemIDType (string) ) [0..1]
The ID that uniquely identifies the item listing. The ID is generated by eBay after an item is listed. You cannot choose or revise this value.
See the Field Index to learn which calls use ItemID.

ItemTitle ( string ) [0..1]
Title of the item listing.
See the Field Index to learn which calls use ItemTitle.

ListingSiteID ( int ) [0..1]
eBay site where the seller is registered.
See the Field Index to learn which calls use ListingSiteID.

Memo ( string ) [0..1]
Notes for this transaction.
See the Field Index to learn which calls use Memo.

OrderLineItemID ( string ) [0..1]
An ID that uniquely identifies each line item within an order. If the buyer only purchased one item, there will be one Order ID and one Order Line Item ID. If a buyer purchases multiple items, there will be one Order ID and multiple Order Line Item IDs.

OrderLineItemID is a based upon the combination of the eBay Trading API's ItemID and TransactionID fields. The number before the hyphen is the Item ID and the number after the hyphen is the Transaction ID. The Transaction field in the Trading API is a container that can include many types of order line item (transaction) information.

See Trading API for more information.
See the Field Index to learn which calls use OrderLineItemID.

OriginalChargeTime ( dateTime ) [0..1]
Applicable for adjustment, the original transaction occurs date time.
See the Field Index to learn which calls use OriginalChargeTime.

PaymentClearedTime ( dateTime ) [0..1]
The date and time that the payment was acknowledged. Only returned for SoldReport if payment has been marked as received.
See the Field Index to learn which calls use PaymentClearedTime.

QuantitySold ( int ) [0..1]
The number of items sold to a specific buyer within a single order line item (transaction).
See the Field Index to learn which calls use QuantitySold.

SalePrice ( AmountType (double) ) [0..1]
Price of the item.
See the Field Index to learn which calls use SalePrice.

SaleTime ( dateTime ) [0..1]
The date and time that the item was sold.
See the Field Index to learn which calls use SaleTime.

SecondDescription ( string ) [0..1]
Second description of the item sold.
See the Field Index to learn which calls use SecondDescription.

SellingManagerSaleRecordID ( int ) [0..1]
For users of the Selling Manager or Selling Manager Pro tools only. If you are not using Selling Manager or Selling Manager Pro, this field will not be returned in your response.

Unique identifier for the record, assigned by eBay. An example of a recordId: 1111:222:333:444:x.
See the Field Index to learn which calls use SellingManagerSaleRecordID.

SerialNumber ( string ) [0..1]
Serial number for this item, only applicable for motors.
See the Field Index to learn which calls use SerialNumber.

ShippingCost ( AmountType (double) ) [0..1]
Calculated shipping cost based on item weight, buyer's postal code, and shipping service.
See the Field Index to learn which calls use ShippingCost.

SiteDescription ( string ) [0..1]
Site description for the site where the listing occurred.
See the Field Index to learn which calls use SiteDescription.

SKU ( SKUType (string) ) [0..1]
Stock Keeping Unit that serves as a unique identifier for an item. Many merchants assign a SKU number to an item of a specific type, size, and color. This way, they can keep track of how many products of each type, size, and color are selling, and they can re-stock their shelves according to customer demand. You can use SKU numbers to add Fixed Price Items and to keep track of your eBay inventory, instead of (or in addition to) the Item ID.
See the Field Index to learn which calls use SKU.

Container consisting of status details of an order line item, including payment information. Several of these fields change values during the checkout flow. See TransactionStatusType for its child elements.

For SoldReport, only the PaymentHoldStatus child element is returned. The fields indicating the status of the order are actually found in the OrderDetails.CheckoutStatus container.
See the Field Index to learn which calls use Status.

TaxAmount ( AmountType (double) ) [0..1]
Calculated tax fee based on the sale price and the sales tax at the buyer's location.
See the Field Index to learn which calls use TaxAmount.

TaxCategory ( string ) [0..1]
A tax exception category code. This is returned only if set for the listing.
See the Field Index to learn which calls use TaxCategory.

Taxes ( TaxesType ) [0..1]
Details about taxes applicable to this order line item (transaction). Returned only if enabled for the account. (Otherwise see OrderLineItem.TaxAmount.)
See the Field Index to learn which calls use Taxes.

TotalCost ( AmountType (double) ) [0..1]
The total cost of the order line item, which includes the sale price of all order line items, shipping costs, and taxes. If multiple order line items between the same buyer and seller have been combined into a Combined Payment order, the TotalCost value returned for each order line item reflects the amount paid for the Combined Payment order and not the individual order line item.

Note: As of November 2019, for orders subject to eBay 'Collect and Remit' taxes, PayPal has begun distributing order funds to the seller's account with the sales tax included. eBay 'Collect and Remit' tax includes US sales tax for numerous states, and 'Good and Services' tax that is applicable to Australian and New Zealand sellers. This 'Collect and Remit' tax amount for each order line item will be included in the TotalCost value. To determine if 'Collect and Remit' taxes were added into TotalCost value, the user can check for the TotalIncludeseBayCollectedTax boolean value. If this value is returned as true, the tax amount shown in the Taxes.TaxDetails.TaxAmount field for each order line item is reflected in the TotalCost value.

Sellers should be aware that the sales tax that the buyer pays for the order will initially be included when the order funds are distributed to their PayPal account, but that PayPal will pull out the sales tax amount shortly after the payment clears, and will distribute the sales tax to the appropriate taxing authority. Previous to this change, PayPal would strip out the 'Collect and Remit' tax before distributing order funds to the seller's account.

This logic change does not apply to sellers who are in eBay managed payments, so the amount in this field will never reflect any 'Collect and Remit' tax, even if the order is subject to 'Collect and Remit' tax.
See the Field Index to learn which calls use TotalCost.

TotalIncludeseBayCollectedTax ( boolean ) [0..1]
This boolean field is returned as true if the TotalCost value (for the line item) includes eBay 'Collect and Remit' taxes. eBay 'Collect and Remit' taxes include US state-mandated sales tax and 'Goods and Services' taxes that are applicable to orders from Australian and New Zealand sellers.

More and more US states are mandating the collection of sales tax for Internet sales. For a full list of affected states and effective dates, see the eBay sales tax collection help page.

For eBay managed payment orders, this field should always be returned as false, since eBay will always strip out any applicable sales tax (and remit to taxing authority) before the seller payout for the order line item is distributed to the seller's account.

Note: As of November 2019, for orders subject to eBay 'Collect and Remit' taxes, PayPal has begun distributing order funds to the seller's account with the sales tax included. However, shortly after the order funds clear in the seller's account, the 'Collect and Remit' tax amount will be pulled by PayPal from the seller's account and then disributed to the appropriate taxing authority. Previously, PayPal was stripping this 'Collect and Remit' tax from the buyer's payment and directly submitting this amount to the appropriate taxing authority, and this tax amount never shows up in the sellers account.
See the Field Index to learn which calls use TotalIncludeseBayCollectedTax.

TransactionTime ( dateTime ) [0..1]
The date time when the transaction occur.
See the Field Index to learn which calls use TransactionTime.

UnpaidItem ( UnpaidItemType ) [0..1]
Unpaid Item Details.
See the Field Index to learn which calls use UnpaidItem.

Variations are multiple similar (but not identical) items in one fixed-price listing. For example, a clothing listing can contain items of the same brand that vary by color and size. Each variation specifies a combination of one of these colors and sizes. Each variation can have a different quantity and price. Only returned if the order line item is for a variation.
See the Field Index to learn which calls use Variation.