This doc page has moved! You should be automatically redirected to the resources page for the eBay Fulfillment API. If you are not redirected automatically, follow this link to the Fulfillment API.

eBay Fulfillment APIVersion 1.2.0

LineItem

This type contains the details of a line item in an order. A line item consists of one or more units of a specific variation and version of a listed item that has been purchased.

Type that uses LineItem:

Calls that use LineItem:

Fields



appliedPromotions ( array of AppliedPromotion ) [0..?]
Contains information about one or more sales promotions or discounts applied to the line item.
See the Field Index to learn which calls use appliedPromotions.

deliveryCost ( DeliveryCost ) [0..?]
Contains a breakdown of all costs associated with the fulfillment of the line item.
See the Field Index to learn which calls use deliveryCost.

discountedLineItemCost ( Amount ) [0..?]
The cost of the line item after applying any discounts.
See the Field Index to learn which calls use discountedLineItemCost.

giftDetails ( GiftDetails ) [0..?]
Contains gift information about the line item. This container is returned only if the line item was purchased as a gift.
See the Field Index to learn which calls use giftDetails.

legacyItemId ( string ) [0..?]
The eBay-generated legacy listing item ID of the line item. This partially identifies the line item, but does not include the variation, version, or unit quantity.
See the Field Index to learn which calls use legacyItemId.

legacyVariationId ( string ) [0..?]
An eBay-generated string that uniquely identifies the combination of item variations that apply to this line item.
See the Field Index to learn which calls use legacyVariationId.

lineItemCost ( Amount ) [0..?]
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 value of the quantity field.
See the Field Index to learn which calls use lineItemCost.

lineItemFulfillmentInstructions ( LineItemFulfillmentInstructions ) [0..?]
Contains the specifications for processing the fulfillment of the line item, including the handling and delivery timing in support of eBay Guaranteed Delivery. These fields provide guidance for eBay Guaranteed Delivery as well as for non-guaranteed delivery.
See the Field Index to learn which calls use lineItemFulfillmentInstructions.

lineItemFulfillmentStatus ( LineItemFulfillmentStatusEnum ) [0..?]
The degree to which fulfillment of the line item is complete.
See the Field Index to learn which calls use lineItemFulfillmentStatus.

lineItemId ( string ) [0..?]
The globally unique eBay-generated identifier of the line item.

Note: A single line item can consist of multiple units of a purchased item, and one unit can consist of multiple parts or components. Although these components might be provided by the manufacturer in separate packaging, the seller cannot distribute them among multiple shipping packages. Thus, each line item ID will appear in exactly one fulfillment.
See the Field Index to learn which calls use lineItemId.

listingMarketplaceId ( MarketplaceIdEnum ) [0..?]
The eBay marketplace where the line item was listed.
See the Field Index to learn which calls use listingMarketplaceId.

properties ( LineItemProperties ) [0..?]
Contains information about the eBay programs, if any, under which the line item was listed.
See the Field Index to learn which calls use properties.

purchaseMarketplaceId ( MarketplaceIdEnum ) [0..?]
The eBay marketplace where the line item was purchased.
See the Field Index to learn which calls use purchaseMarketplaceId.

quantity ( integer ) [0..?]
The number of units of the line item in the order. These are represented as a group by a single lineItemId.
See the Field Index to learn which calls use quantity.

refunds ( LineItemRefund ) [0..?]
Not used by any call.

This field is reserved for internal or future use.
See the Field Index to learn which calls use refunds.

sku ( string ) [0..?]
Stock Keeping Unit. This is the seller's inventory reference identifier, which typically applies to a specific variation and version of the item.
See the Field Index to learn which calls use sku.

soldFormat ( SoldFormatEnum ) [0..?]
The eBay listing type of the line item.
See the Field Index to learn which calls use soldFormat.

taxes ( array of Tax ) [0..?]
Contains a list of taxes applied to the line item, if any.
See the Field Index to learn which calls use taxes.

title ( string ) [0..?]
The seller's listing title for the line item.
See the Field Index to learn which calls use title.

total ( Amount ) [0..?]
The net monetary amount of promotions, delivery costs, fees, combined unit prices, refunds, and taxes that apply to the line item.
See the Field Index to learn which calls use total.