inventory APIv1.6.0

EbayOfferDetailsWithAll

This type provides details of an offer, and is used by the response payloads of the getOffer and the getOffers calls.

Type that uses EbayOfferDetailsWithAll

Calls that use EbayOfferDetailsWithAll

Fields

Field
Type
Description
availableQuantity
This integer value indicates the quantity of the inventory item (specified by the sku value) that will be available for purchase by buyers shopping on the eBay site specified in the marketplaceId field. For unpublished offers where the available quantity has yet to be set, the availableQuantity value is set to 0.
categoryId
The unique identifier of the primary eBay category that the inventory item is listed under. This field is always returned for published offers, but is only returned if set for unpublished offers.
listingDescription
The description of the eBay listing that is part of the unpublished or published offer. This field is always returned for published offers, but is only returned if set for unpublished offers.

Max Length: 500000
listingPolicies
This container indicates the listing policies that are applied to the offer. This container consists of the payment, return, and fulfillment listing policies that will be associated with the listing. It is required that the seller be opted in to Business Policies before being able to create live eBay listings through the Inventory API. Sellers can opt-in to Business Policies through My eBay or by using the Account API's optInToProgram call. Similarly, payment, return, and fulfillment listing policies may be created/managed in My eBay or by using the listing policy calls of the Account API.

For unpublished offers where listing policies have yet to be specified, this container will be returned as empty.
merchantLocationKey
The unique identifier of the inventory location. This identifier is set up by the merchant when the inventory location is first created with the createInventoryLocation call. Once this value is set for an inventory location, it can not be modified. To get more information about this inventory location, the getInventoryLocation call can be used, passing in this value at the end of the call URI.

This field is always returned for published offers, but is only returned if set for unpublished offers.

Max length: 36
pricingSummary
This container shows the listing price for the product offer, and if applicable, the settings for the Minimum Advertised Price and Strikethrough Pricing features. The Minimum Advertised Price feature is only available on the US site. Strikethrough Pricing is available on the US, eBay Motors, UK, Germany, Canada (English and French), France, Italy, and Spain sites.

For unpublished offers where pricing information has yet to be specified, this container will be returned as empty.
quantityLimitPerBuyer
This field is only applicable and set if the seller wishes to set a restriction on the purchase quantity of an inventory item per seller. If this field is set by the seller for the offer, then each distinct buyer may purchase up to, but not exceed the quantity in this field. So, if this field's value is 5, each buyer may purchase a quantity of the inventory item between one and five, and the purchases can occur in one multiple-quantity purchase, or over multiple transactions. If a buyer attempts to purchase one or more of these products, and the cumulative quantity will take the buyer beyond the quantity limit, that buyer will be blocked from that purchase.
tax
This container is only returned if a sales tax table, a Value-Added Tax (VAT) rate, and/or a tax exception category code was applied to the offer. Only Business Sellers can apply VAT to their listings. It is possible that the applyTax field will be included with a value of true, but a buyer's purchase will not involve sales tax. A sales tax rate must be set up in the seller's sales tax table for the buyer's state/tax jurisdiction in order for that buyer to be subject to sales tax.

See the Using a tax table help page for more information on setting up and using a sales tax table.
storeCategoryNames
array of string
This container is returned if the seller chose to place the inventory item into one or two eBay store categories that the seller has set up for their eBay store. The string value(s) in this container will be the full path(s) to the eBay store categories, as shown below:
"storeCategoryNames": [
"/Fashion/Men/Shirts",
"/Fashion/Men/Accessories" ],
lotSize
This field is only applicable and returned if the listing is a lot listing. A lot listing is a listing that has multiple quantity of the same product. An example would be a set of four identical car tires. The integer value in this field is the number of identical items being sold through the lot listing.
format
This enumerated value indicates the listing format of the offer. Currently, the only supported value for this field is FIXED_PRICE.
marketplaceId
This enumeration value is the unique identifier of the eBay site on which the offer is available, or will be made available.
sku
This is the seller-defined SKU value of the product in the offer.

Max Length: 50
offerId
The unique identifier of the offer. This identifier is used in many offer-related calls, and it is also used in the bulkUpdatePriceQuantity call.
listing
For published offers, this container is always returned in the getOffer and getOffers calls, and includes the eBay listing ID associated with the offer, the status of the listing, and the quantity sold through the listing. The listing container is not returned at all for unpublished offers.
status
The enumeration value in this field specifies the status of the offer - either PUBLISHED or UNPUBLISHED.