fulfillment APIv1.15.0

LineItem

This type contains the details of each line item in an order.

Type that uses LineItem

Calls that use LineItem

Fields

Field
Type
Description
appliedPromotions
This array contains information about one or more sales promotions or discounts applied to the line item. It is always returned, but will be returned as an empty array if no special sales promotions or discounts apply to the order line item.
deliveryCost
This container consists of a breakdown of all costs associated with the fulfillment of the line item.
discountedLineItemCost
The cost of the line item after applying any discounts. This container is only returned if the order line item was discounted through a promotion.
ebayCollectAndRemitTaxes
This container will be returned if the order line item is subject to a 'Collect and Remit' tax that eBay will collect and remit to the proper taxing authority on the buyer's behalf. 'Collect and Remit' tax includes US state-mandated sales tax and 'Goods and Services' tax (collected in Australia and New Zealand). The amount of this tax is shown in the amount field, and the type of tax is shown in the taxType field.

eBay will display the tax type and amount during checkout in accordance with the buyer's address, and handle collection and remittance of the tax without requiring the seller to take any action.
giftDetails
This container consists of information that is needed by the seller to send a digital gift card to the buyer, or recipient of the digital gift card. This container is only returned and applicable for digital gift card line items.
legacyItemId
The eBay-generated legacy listing item ID of the listing. Note that the unique identifier of a listing in REST-based APIs is called the listingId instead.
legacyVariationId
The unique identifier of a single variation within a multiple-variation listing. This field is only returned if the line item purchased was from a multiple-variation listing.
lineItemCost
The selling price of the line item before applying any discounts. The value of this field is calculated by multiplying the single unit price by the number of units purchased (value of the quantity field).
lineItemFulfillmentInstructions
This container consists of information related to shipping dates and expectations, including the 'ship-by date' and expected delivery windows that are based on the seller's stated handling time and the shipping service option that will be used. These fields provide guidance on making sure expected delivery dates are made, whether the order is a eBay Guaranteed Delivery order or a non-guaranteed delivery order.
lineItemFulfillmentStatus
This enumeration value indicates the current fulfillment status of the line item.
lineItemId
This is the unique identifier of an eBay order line item. This field is created as soon as there is a commitment to buy from the seller.
listingMarketplaceId
The unique identifier of the eBay marketplace where the line item was listed.
properties
Contains information about the eBay programs, if any, under which the line item was listed.
purchaseMarketplaceId
The unique identifier of the eBay marketplace where the line item was listed. Often, the listingMarketplaceId and the purchaseMarketplaceId identifier are the same, but there are occasions when an item will surface on multiple eBay marketplaces.
quantity
The number of units of the line item in the order. These are represented as a group by a single lineItemId.
refunds
This array is always returned, but is returned as an empty array unless the seller has submitted a partial or full refund to the buyer for the order. If a refund has occurred, the refund amount and refund date will be shown for each refund.
sku
Seller-defined Stock-Keeping Unit (SKU). This inventory identifier must be unique within the seller's eBay inventory. SKUs are optional when listing in the legacy/Trading API system, but SKUs are required when listing items through the Inventory API model.
soldFormat
The eBay listing type of the line item. The most common listing types are AUCTION and FIXED_PRICE.
taxes
array of Tax
Contains a list of taxes applied to the line item, if any. This array is always returned, but will be returned as empty if no taxes are applicable to the line item, or if the seller is opted in to eBay managed payments.
title
The title of the listing.
total
This is the total price that the buyer must pay for the line item after all costs (item cost, delivery cost, taxes) are added, minus any discounts and/or promotions.

Note: Beginning in early November 2019, for orders that are subject to 'eBay Collect and Remit' tax, which includes US state-mandated sales tax and 'Good and Services' tax in Australia and New Zealand, the 'Collect and Remit' tax amount for the order will be included in this total value.

To determine if 'Collect and Remit' taxes were added into this total value, the user can check for the corresponding lineItems.ebayCollectAndRemitTaxes and the lineItems.taxes containers in the response. If both of these containers appear for this line item in the response with a taxType value of STATE_SALES_TAX (in US) or GST (in Australia or New Zealand), the 'Collect and Remit' tax amount that the buyer paid is in this amount.

Sellers should be aware that the 'Collect and Remit' 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 'Collect and Remit' tax amount shortly after the payment clears, and will distribute the 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.