eBay · Schema
OrderLineItemV2
A type that defines the fields for line item information in a purchase order.
AuctionsCommerceProductsMarketplaceFortune 500
Properties
| Name | Type | Description | ||
|---|---|---|---|---|
| authenticityVerification | object | A container that is returned for orders that are eligible for eBay's Authenticity Guarantee program. The seller ships Authenticity Guarantee program items to the authentication partner instead of the | ||
| baseUnitPrice | object | The cost of a single quantity of the line item. Note: The price includes the value-added tax (VAT) for applicable jurisdictions when requested from supported mark |
||
| fees | array | A breakdown of the fees applicable to the line item. | ||
| image | object | An eBay-assigned URL of the item image. | ||
| itemId | string | The eBay identifier of an item. This ID is returned by the Browse and Feed API methods. | ||
| itemOnHold | boolean | When this value is true it indicates that the item has been put on hold due to a violation of eBay Policy. |
||
| legacyReference | object | A container that returns fields to support using the Post Order API for returns and cancellations. For information abo | ||
| lineItemId | string | A unique eBay-assigned ID value that identifies a line item in a checkout session. This is created by the lineItemPaymentStatus | string | An enumeration value that indicates the payment status of the line item. For implementation help, refer to e |
| lineItemStatus | string | An enumeration value that indicates the fulfillment state of this line item. Note: When there is no tracking information, the status will never change from |
||
| netPrice | object | The total cost for the line item, taking into account the quantity, any seller item discounts, and any coupon that applies. Note: This does not include any shippi |
||
| orderId | string | The unique order ID for the line item. Maximum Length: 40 characters |
||
| promotions | array | An array of promotions applied to the line item. | ||
| quantity | integer | The quantity ordered for the line item. | ||
| seller | object | A container for information about the seller offering this item, such as the seller's user name. | ||
| shippingDetail | object | A container for information about the shipping details of the order. | ||
| taxDetails | array | A container for the tax information for the line item. | ||
| title | string | The seller-created title of the item. |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "#/components/schemas/OrderLineItemV2",
"title": "OrderLineItemV2",
"type": "object",
"properties": {
"authenticityVerification": {
"description": "A container that is returned for orders that are eligible for eBay's Authenticity Guarantee program. The seller ships Authenticity Guarantee program items to the authentication partner instead of the buyer. If the item is successfully authenticated, the authenticator will ship the item to the buyer.",
"$ref": "#/components/schemas/AuthenticityVerificationProgram"
},
"baseUnitPrice": {
"description": "The cost of a single quantity of the line item.<br><br><span class=\"tablenote\"><b>Note:</b> The price includes the value-added tax (VAT) for applicable jurisdictions when requested from supported marketplaces. In this case, users must pass the <a href=\"/api-docs/static/rest-request-components.html#HTTP\"><code>X-EBAY-C-MARKETPLACE-ID</code></a> request header specifying the supported marketplace (such as <code>EBAY_GB</code>) to see VAT-inclusive pricing. For more information on VAT, refer to <a href=\"https://www.ebay.co.uk/help/listings/default/vat-obligations-eu?id=4650&st=12&pos=1&query=Your%20VAT%20obligations%20in%20the%20EU&intent=VAT\">VAT Obligations in the EU</a>.</span>",
"$ref": "#/components/schemas/Amount"
},
"fees": {
"type": "array",
"description": "A breakdown of the fees applicable to the line item.",
"items": {
"$ref": "#/components/schemas/Fee"
}
},
"image": {
"description": "An eBay-assigned URL of the item image.",
"$ref": "#/components/schemas/Image"
},
"itemId": {
"type": "string",
"description": "The eBay identifier of an item. This ID is returned by the <b>Browse</b> and <b>Feed</b> API methods."
},
"itemOnHold": {
"type": "boolean",
"description": "When this value is <code>true</code> it indicates that the item has been put on hold due to a violation of eBay Policy."
},
"legacyReference": {
"description": "A container that returns fields to support using the <a href=\"https://developer.ebay.com/devzone/post-order/index.html#callindex \">Post Order API</a> for returns and cancellations. For information about what is returned in these fields and how to use the Post Order API, see <a href=\"/api-docs/buy/static/api-order.html#using\">Using the Post Order API</a>.<br><br><b>Note:</b> The Post Order API can be used only with eBay member checkouts.",
"$ref": "#/components/schemas/LegacyReference"
},
"lineItemId": {
"type": "string",
"description": "A unique eBay-assigned ID value that identifies a line item in a checkout session. This is created by the <a href=\"/api-docs/buy/order/resources/guest_checkout_session/methods/initiateGuestCheckoutSession\">initiateGuestCheckoutSession</a>."
},
"lineItemPaymentStatus": {
"type": "string",
"description": "An enumeration value that indicates the payment status of the line item. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/buy/order/types/gct:LineItemPaymentStatusEnum'>eBay API documentation</a>"
},
"lineItemStatus": {
"type": "string",
"description": "An enumeration value that indicates the fulfillment state of this line item.<br><br><span class=\"tablenote\"><b>Note:</b> When there is no tracking information, the status will never change from <code>FULFILLMENT_IN_PROGRESS</code>; without tracking information, eBay has no way of knowing whether the order was delivered.</span> For implementation help, refer to <a href='https://developer.ebay.com/api-docs/buy/order/types/gct:LineItemStatusEnum'>eBay API documentation</a>"
},
"netPrice": {
"description": "The total cost for the line item, taking into account the quantity, any seller item discounts, and any coupon that applies.<br><br><span class=\"tablenote\"><b>Note:</b> This does not include any shipping discounts, shipping costs, fees, or seller adjustments.</span>",
"$ref": "#/components/schemas/Amount"
},
"orderId": {
"type": "string",
"description": "The unique order ID for the line item.<br><br><b>Maximum Length:</b> 40 characters"
},
"promotions": {
"type": "array",
"description": "An array of promotions applied to the line item.",
"items": {
"$ref": "#/components/schemas/Promotion"
}
},
"quantity": {
"type": "integer",
"description": "The quantity ordered for the line item.",
"format": "int32"
},
"seller": {
"description": "A container for information about the seller offering this item, such as the seller's user name.",
"$ref": "#/components/schemas/Seller"
},
"shippingDetail": {
"description": "A container for information about the shipping details of the order.",
"$ref": "#/components/schemas/ShippingDetail"
},
"taxDetails": {
"type": "array",
"description": "A container for the tax information for the line item.",
"items": {
"$ref": "#/components/schemas/TaxDetail"
}
},
"title": {
"type": "string",
"description": "The seller-created title of the item."
}
},
"description": "A type that defines the fields for line item information in a purchase order."
}