ODBC Driver for eBay

Build 20.0.7587

AddItem

Create and publish a new Item Listing on an eBay site.

Stored Procedure Specific Information

Upon the successful creation of an Item Listing, an Item Id is returned in the response along with the estimated fees for listing the Item. After adding an item, you can use the ItemListing table to update, delete, and query.

The inputs required to add any item are the following: Title, Description, CategoryId, StartPrice, ConditionId, Country, Currency, DispatchTimeMax, ListingDuration, ListingType, PaymentMethod, PayPalEmailAddress, Quantity, Location, and ReturnsAcceptedOption.

You also need to specify several inputs required to select a shipping type: Flat or Calculated. Both shipping types require a ShippingService to be specified.

Add an Item

You can follow the procedure below to obtain the required values and add an item through SQL:

  1. Use the Categories view to select a top-level category; for example, Books. You can use the following query:
    SELECT * FROM Categories
  2. Use the Categories view to select a leaf category; for example, Fiction & Literature. A leaf category Id is required to add an item. You can use a query like the following:
    SELECT * FROM Categories WHERE CategoryParentId='267'
  3. Use the ShippingServices view to select a Shipping Service. The value of the ValidForSellingFlow column must be true; otherwise, that particular shipping service option is no longer valid and cannot be offered to buyers through a listing.

Selecting Flat Shipping

The following inputs are required for the Flat shipping type: ShippingType, ShippingService, ShippingServicePriority, and ShippingServiceCost.

Selecting CalculatedShipping

The Calculated shipping type requires additional information related to package stats. The following inputs are required for this shipping type: ShippingType, WeightMajor, WeightMinor, OriginatingPostalCode, ShippingService, and ShippingServicePriority.

Input

Name Type Required Description
Title String False Name of the item as it appears in the listing or search results.
Description String False The description of the item by the seller. In listing requests, you can use CDATA tags to submit your description if you want to use HTML or XML-reserved characters in the description.
CategoryId String False Category Id for the first (or only) category in which the item is listed (or will be listed, if the item is new).
StartPrice String False The original price of the item at listing or relisting time. If this value changes when the item is revised, the new value becomes the original price.
ConditionId String False An identifier for the condition of the item. For example, 1000 for New or 3000 for Used.
Country String False Defines the 2-letter ISO 3166 country code.
Currency String False Currency associated with the price information of the item. 3-letter ISO 4217 currency code.
DispatchTimeMax String False Specifies the maximum number of business days the seller commits to for preparing an item to be shipped after receiving a cleared payment. This time does not include the shipping time (the transit time of the carrier).
ListingDuration String False Describes the number of days the seller wants the listing to be active (available for bidding/buying).
ListingType String False The format of the listing the seller wants to use, such as Chinese auction or fixed price.
PaymentMethod String False Identifies the payment method (such as PayPal) that the seller will accept when the buyer pays for the item. Use the CategoryFeatures view to find the available payment methods for a category.
PayPalEmailAddress String False The PayPal email address of the seller.
Quantity String False The Quantity value for auction listings must always be 1. For a fixed-price listing, the Quantity value indicates the number of identical items the seller has available for sale in the listing.
Location String False Indicates the geographical location of the item (along with Country). When you revise a listing, you can add or change this value only if the listing has no bids (or no items have sold), and it does not end within 12 hours.
ReturnsAcceptedOption String False Indicates whether the seller allows the buyer to return the item. One of the following values: ReturnsAccepted or ReturnsNotAccepted. If you specify ReturnsNotAccepted, the View Item page will indicate that returns are not accepted instead.
Sku String False A SKU (Stock Keeping Unit) value is a seller-defined identifier for a product.
ShippingType String False The shipping cost model offered by the seller.
FreeShipping String False Specifies that the seller wants to offer free shipping. This applies only to the first specified domestic shipping service and is ignored if set for any other shipping service.
ShippingService String False A shipping service option being offered by the seller to ship an item to a buyer. For a list of valid ShippingService values, query the ShippingServices view; the ShippingService returned must have a value of true in the ValidForSellingFlow column.
ShippingServiceCost String False The base cost of shipping the item by using the shipping service specified in the ShippingService field, if one was specified. This column includes the packaging and handling cost for flat and calculated shipping. If this is for calculated shipping for a listing that has not yet ended, note that the cost cannot be determined until the listing has ended and the buyer has specified a postal code. This value reflects savings from a promotional shipping service option. Also applicable to Half.com.
ShippingServicePriority String False This integer value controls the order (relative to other shipping services) in which the corresponding ShippingService will appear in the View Item and Checkout page. Sellers can specify up to four domestic shipping services.
ShippingServiceAdditionalCost String False The cost of shipping each additional item if the same buyer purchases multiple quantities of the same line item. If less than ShippingServiceCost, this column gives the buyer a shipping discount. This field is required when creating a multiple-quantity fixed-price listing. This field is not applicable for single-quantity listings.
CalculatedShippingMeasurementSystem String False System of measurement (e.g., English).
CalculatedShippingMeasurementUnit String False Specifies the unit type of the weight and dimensions of a shipping package.
CalculatedShippingPackageLength String False Length of the package, in a whole number of inches (English) or centimeters (Metric), needed to ship the item.
CalculatedShippingPackageDepth String False Depth of the package, in a whole number of inches (English) or centimeters (Metric), needed to ship the item.
CalculatedShippingPackageWidth String False Width of the package, in a whole number of inches (English) or centimeters (Metric), needed to ship the item.
ShippingPackage String False The nature of the package used to ship the item(s). Required for calculated shipping only.
WeightMajor String False The major unit used to specify the weight of a shipping package. For example, lbs.
WeightMinor String False The minor unit used to specify the weight of a shipping package. For example, oz.
OriginatingPostalCode String False Postal code for the location from which the package will be shipped. Required for calculated shipping. Use Item.PostalCode to specify the location of the item used for searches by location.
CategoryMappingAllowed String False Controls how eBay handles cases in which the category no longer exists in the current category structure: If true, eBay will use the new Id for the listing; if false, an error is returned.
BestOfferEnabled String False This field indicates whether or not the Best Offer feature is enabled for this item.
LinkedPayPalAccount String False The seller includes and sets this field to true as a mechanism to block bidders who do not have a PayPal account linked to their eBay account.
MaximumBuyerPolicyViolations String False This integer value sets the maximum number of buyer policy violations that a prospective buyer is allowed to have during a specified time period (MaximumBuyerPolicyViolationsPeriod) before being blocked from buying/bidding on the item.
MaximumBuyerPolicyViolationsPeriod String False This value defines the length of time over which the buyer policy violations for a prospective buyer will be counted.
MaximumItemCount String False The number of maximum items a buyer can purchase from the seller during a 10-day period before being blocked from buying/bidding on the item.
MaximumUnpaidItemStrikesInfo String False The maximum number of unpaid item strikes that a prospective buyer is allowed to have during a specified time period (MaximumUnpaidItemStrikesInfoPeriod) before being blocked from buying/bidding on the item.
MaximumUnpaidItemStrikesInfoPeriod String False The length of time over which the unpaid item strikes of a prospective buyer will be counted. If the number of unpaid item strikes during this defined period exceeds the value set in the MaximumUnpaidStrikesInfo field, that prospective buyer is blocked from buying/bidding on the item.
MinimumFeedbackScore String False The seller includes this field as a mechanism to block bidders who have a Feedback Score less than the specified value.
ShipToRegistrationCountry String False The seller includes and sets this field to true as a mechanism to block bidders who reside (according to their eBay primary shipping address) in countries that are on the ship-to exclusion list.
VerifiedUser String False To block nonverified users from buying/bidding on their items, the seller should include this field and set its value to true.
ZeroFeedbackScore String False This Buyer Requirements feature is only available to sellers on the China site, and is only applicable to fixed-price or auction Buy It Now items.
CategoryBasedAttributesPrefill String False If true, eBay will autofill some of the Item Specifics values values based on the category (or categories) of the listing. For example, brand, size, or color.
StoreCategoryId String False Unique identifier of a primary custom category in which to list the item.
StoreCategoryName String False Category name of a primary custom category in which to list the item.
StoreCategoryId2 String False Unique identifier for the secondary custom category in which to list the item.
StoreCategoryName2 String False Name of the secondary custom category in which to list the item.
IncludeRecommendations String False This boolean field should be included and set to true if the seller wishes to see listing recommendations.
LiveAuction String False This field must be included and set to true if the listing will be a part of a Live Auction. This boolean field is returned as true in the ItemList table if the listing is part of a Live Auction. See the eBay Live Auctions home page for more information about Live Auctions on eBay.com.
LotSize String False A lot is a set of two or more similar items included in a single listing that must be purchased together in a single order line item. The LotSize value is the number of items in the lot. This field is required if two or more items are including in one listing.
DaysToFullPayment String False This integer value indicates the number of days that a buyer has (after he/she commits to buy) to make full payment to the seller and close the remaining balance on a motor vehicle. Valid values are 3, 7 (default), 10, and 14.
PostalCode String False Postal code of the place where the item is located. This value is used for proximity searches.
Brand String False The brand of the product. eBay searches against the names that are publicly available in its product catalogs. This means you can specify the well-known brand name that an average user would recognize. Both Brand and MPN must be specified if the BrandMPN column is used.
BrandMPN String False The manufacturer part number of the product. Use the value specified by the manufacturer.
EAN String False Applicable for listing use cases only (not buy-side searching). EAN is a unique 8 or 13 digit identifier that many industries (such as book publishers) use to identify products.
IncludeeBayProductDetails String False This boolean field controls whether or not an eBay catalog product is used to help create or revise an item listing.
IncludeStockPhotoURL String False If true, indicates that the item listing includes the stock photo.
ISBN String False Applicable for listing use cases only (not buy-side searching). ISBN is a unique identifer for books (an international standard). Specify a 10 or 13 character ISBN.
ProductId String False The unique identifier for a specific version of a product.
ProductReferenceId String False The short global reference Id for a catalog product.
UPC String False Applicable for listing use cases only (not buy-side searching). UPC is a unique, 12-character identifier that many industries use to identify products.
UseStockPhotoURLAsGallery String False If true, indicates that the stock photo for an item (if available) is used as the gallery thumbnail. IncludeStockPhotoURL must also be true and Item.
MinimumRemnantSet String False Enables you (the seller) to avoid being left with 1 item in your listing. A typical use case is event tickets in reserved, adjacent seats, or items that typically only sell if more than 1 can be purchased at once.
ScheduleTime String False Allows the user to specify the time that the listing becomes active on eBay.
PaymentProfileId String False The unique identifier of a Business Policies payment profile. A PaymentProfileId or PaymentProfileName can be specified.
PaymentProfileName String False The name of a Business Policies payment profile. A PaymentProfileId or PaymentProfileName can be specified.
ReturnProfileId String False The unique identifier of a Business Policies return policy profile. A ReturnProfileId or ReturnProfileName can be specified.
ReturnProfileName String False The name of a Business Policies return policy profile. A ReturnProfileId or ReturnProfileName can be specified.
ShippingProfileId String False The unique identifier of a Business Policies shipping policy profile. A ShippingProfileId or ShippingProfileName can be specified.
ShippingProfileName String False The name of a Business Policies shipping policy profile. A ShippingProfileId or ShippingProfileName can be specified.
MeasurementUnit String False Specifies the unit type of the weight and dimensions of a shipping package.
PackageDepth String False Depth of the package, in a whole number of inches, needed to ship the item.
MeasurementSystem String False System of Measurement (e.g., English).
Unit String False Unit of measurement (e.g., lbs, oz, kg, g, in, cm).
PackageLength String False Length of the package, in a whole number of inches, needed to ship the item.
PackageWidth String False Width of the package, in a whole number of inches, needed to ship the item.
ShippingIrregular String False Whether a package is irregular and therefore cannot go through the stamping machine at the shipping service office and thus requires special or fragile handling.
SubTitle String False Subtitle to use in addition to the title.
TaxCategory String False Tax exception category code.
ThirdPartyCheckout String False Determines whether or not checkout is to be handled by an authorized Third-Party Checkout application.
TransactionId String False A unique identifier for an order line item (transaction). An order line item is created when a buyer commits to purchasing an item. Since you can change active multiple-quantity fixed-price listings even after one of the items has been purchased, the TransactionId is associated with a snapshot of the item data at the time of the purchase. Max length: 19.
UseRecommendedProduct String False If true, and the item details in the request match a product in the eBay catalog, the matching product is used to list the item.
UseTaxTable String False Indicates whether the tax table of the seller is to be used when applying and calculating sales tax for an order line item.
UUID String False Universally unique constraint tag. Use UUID to ensure that you only list a particular item once, particularly if you are listing many items at once.
BusinessSeller String False If true, this indicates that the seller is a business user and intends to use listing features that are offered to business users only.
RestrictedToBusiness String False If true, this indicates that the seller elects to offer the item exclusively to business users. If false or not specified, this indicates that the seller elects to offer the item to all users.
VATPercent String False VAT rate for the item, if any.
VIN String False This field displays the Vehicle Identification Number, which is a unique serial number for a motor vehicle.
VRM String False Vehicle Registration Mark, which is a unique identifier for a motor vehicle in the UK.
GalleryDuration String False Number of days that the Featured Gallery type applies to a listing. Applicable values include Days_7 and LifeTime.
GalleryURL String False This field is used internally only. The Gallery image is always the first PictureURL passed in and this field is set to that value.
PhotoDisplay String False Specifies the type of image display used in a listing. Some options are only available if images are hosted through eBay Picture Services (EPS).
PictureUrl# String False Source of the picture. Use this input to add multiple pictures. PictureUrl#1, PictureUrl#2, PictureUrl#3 etc.
ItemSpecificName# String False Item specifics' name. Combine this with ItemSpecificValue.
ItemSpecificValue# String False Item specifics' value. Combine this with ItemSpecificName.
ShippingServiceCost String False The base cost of shipping the item by using the shipping service specified in the ShippingService field, if one was specified. This column includes the packaging and handling cost for flat and calculated shipping. If this is for calculated shipping for a listing that has not yet ended, note that the cost cannot be determined until the listing has ended and the buyer has specified a postal code. This value reflects savings from a promotional shipping service option. Also applicable to Half.com.
ShippingSurcharge String False An additional fee to charge U.S. buyers who have the item shipped via UPS or FedEx to Alaska, Hawaii, or Puerto Rico. Can only be assigned a value for the eBay U.S. site and for items in the Parts and Accessories category of the eBay Motors site. If some line items in an order have a surcharge, surcharge is added only for those line items. Flat rate shipping only.

Result Set Columns

Name Type Description
ItemId String The unique identifier of the created item.
StartTime String Starting date and time for the new listing.
EndTime String Date and time when the new listing is scheduled to end based on the start time and the listing duration value that was set in the ListingDuration field at listing time.
FeesAggregate String An array of fees associated with the creation of the listing.
DiscountReason String One or more listing fee/upgrade discount types being offered by eBay to the seller. Applicable values: CustomCode, Promotion, SpecialOffer.

Copyright (c) 2020 CData Software, Inc. - All rights reserved.
Build 20.0.7587