inventory APIv1.6.0

EbayOfferDetailsWithKeys

This type provides details of an offer, and is used by the base request payload of the createOffer call.

Type that uses EbayOfferDetailsWithKeys

Calls that use EbayOfferDetailsWithKeys

Fields

Field
Type
Description
availableQuantity
This integer value sets 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. Quantity must be set to 1 or more in order for the inventory item to be purchasable, but this field is not necessarily required, even for published offers, if the general quantity of the inventory item has already been set in the inventory item record.
categoryId
The unique identifier of the eBay category that the inventory item will be listed under. This field is not immediately required upon creating an offer, but will be required before publishing the offer. Sellers can use the getCategorySuggestions method of the Taxonomy API or the GetSuggestedCategories call of the Trading API to retrieve suggested category ID values. The seller passes in a query string like "iPhone 6", and category ID values for suggested categories are returned in the response.
listingDescription
The description of the eBay listing.

This field is conditionally required before a single-variation offer may be published unless the product.description field in the inventory item record is defined, in which case the text in that particular field will become the listing description. Similarly, this field is also conditionally required before a multiple-variation offer may be published unless the description field in the inventory item group record is defined, in which case the text in that particular field will become the listing description. However, if this field is provided, the text in this field will overwrite whatever description was given for the inventory item or the inventory item group.

HTML markup tags are supported in the listing description, but keep in mind that these markup tags go toward the maximum character limit for this field.

Max Length: 500000
listingPolicies
This container is used to set the listing policies that will be used to construct the listing. This container consists of the identifiers of the payment, return, and fulfillment listing policies that will be associated with the eBay listing. This container is not initially required upon first creating an offer, but will become required before an offer can be published.

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.
merchantLocationKey
The unique identifier of a merchant's inventory location (where the inventory item in the offer is located). A merchantLocationKey value is established when the merchant creates an inventory location using the createInventoryLocation call. To get more information about inventory locations, the getInventoryLocation call can be used.

This field is not initially required upon first creating an offer, but will become required before an offer can be published.

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.

This container is not initially required upon first creating an offer, but the price of the offer will become required before an offer can be published.
quantityLimitPerBuyer
This field is only applicable and set if the seller wishes to set a restriction on the purchase quantity 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 specified for this field. So, if this field's value is 5, each buyer may purchase between one to five of these products, 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 applicable and used if a sales tax table, a Value-Added Tax (VAT) rate, or a tax exception category code will be 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. Sales tax rates for different jurisdictions can be added/modified in the Payment Preferences section of My eBay, or the seller can use the sales tax calls of the Account API.

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 used if the seller would like 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) passed in to 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 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 passed into this field is the number of identical items being sold through the lot listing.
sku
This is the seller-defined SKU value of the product that will be listed on the eBay site (specified in the marketplaceId field). Only one offer (in unpublished or published state) may exist for each sku/marketplaceId/format combination. This field is required.

Max Length: 50
marketplaceId
This enumeration value is the unique identifier of the eBay site for which the offer will be made available. See MarketplaceEnum for the list of supported enumeration values. This field is required.
format
This enumerated value indicates the listing format of the offer. Currently, the only supported value for this field is FIXED_PRICE, as the Inventory API only supports fixed-price listings at this time.