AddSellingManagerProduct

Adds a Selling Manager product and creates a new ProductID. Sellers can use Selling Manager products as containers for storing SYI forms for use as listing templates. Products can be contained in the folders created with the AddSellingManagerInventoryFolder request.

Note: This call is subject to change without notice; the deprecation process is inapplicable to this call. For more information about writing Selling Manager applications, please see http://developer.ebay.com/products/selling-manager-applications.

Prerequisites

To use this call, you must be a Selling Manager Pro subscriber.

Related Information

See:
    Using Selling Manager Calls in the Trading API
    Selling Manager page on the eBay Site
    Selling Manager Pro page on the eBay Site

See also the reference documentation for these calls:

AddSellingManagerTemplate - Adds a Selling Manager template.
GetSellingManagerTemplates - Retrieves Selling Manager templates.
AddSellingManagerInventoryFolder - Adds a new product folder to a user's Selling Manager account.

AddSellingManagerProduct Input

The box below lists all fields that could be included in the call request. To learn more about an individual field or its type, click its name in the box (or scroll down to find it in the table below the box).

See also Samples.

See also the Deprecated Objects link above. Fields presented in this color are deprecated, and fields presented in this color are (or soon will be) non-operational.

The XML prototype does not include requester credentials. This is a documentation limitation only (see Standard Requester Credentials for Making Calls).

<?xml version="1.0" encoding="utf-8"?>
<AddSellingManagerProductRequest xmlns="urn:ebay:apis:eBLBaseComponents">
  <!-- Standard Input Fields -->
  <ErrorLanguage> string </ErrorLanguage>
  <MessageID> string </MessageID>
  <Version> string </Version>
  <WarningLevel> WarningLevelCodeType </WarningLevel>
  <!-- Call-specific Input Fields -->
  <FolderID> long </FolderID>
  <SellingManagerProductDetails> SellingManagerProductDetailsType 
    <CustomLabel> string </CustomLabel>
    <QuantityAvailable> int </QuantityAvailable>
    <UnitCost> AmountType (double) </UnitCost>
  </SellingManagerProductDetails>
  <SellingManagerProductSpecifics> SellingManagerProductSpecificsType 
    <ItemSpecifics> NameValueListArrayType 
      <NameValueList> NameValueListType 
        <Name> string </Name>
        <Value> string </Value>
        <!-- ... more Value nodes here ... -->
      </NameValueList>
      <!-- ... more NameValueList nodes here ... -->
    </ItemSpecifics>
    <PrimaryCategoryID> string </PrimaryCategoryID>
    <Variations> VariationsType 
      <Pictures> PicturesType 
        <VariationSpecificName> string </VariationSpecificName>
        <VariationSpecificPictureSet> VariationSpecificPictureSetType 
          <PictureURL> anyURI </PictureURL>
          <!-- ... more PictureURL nodes here ... -->
          <VariationSpecificValue> string </VariationSpecificValue>
        </VariationSpecificPictureSet>
        <!-- ... more VariationSpecificPictureSet nodes here ... -->
      </Pictures>
      <!-- ... more Pictures nodes here ... -->
      <Variation> VariationType 
        <Quantity> int </Quantity>
        <SKU> SKUType (string) </SKU>
        <StartPrice> AmountType (double) </StartPrice>
        <UnitCost> AmountType (double) </UnitCost>
        <UnitsAvailable> int </UnitsAvailable>
        <VariationSpecifics> NameValueListArrayType 
          <NameValueList> NameValueListType 
            <Name> string </Name>
            <Value> string </Value>
            <!-- ... more Value nodes here ... -->
          </NameValueList>
          <!-- ... more NameValueList nodes here ... -->
        </VariationSpecifics>
      </Variation>
      <!-- ... more Variation nodes here ... -->
      <VariationSpecificsSet> NameValueListArrayType 
        <NameValueList> NameValueListType 
          <Name> string </Name>
          <Value> string </Value>
          <!-- ... more Value nodes here ... -->
        </NameValueList>
        <!-- ... more NameValueList nodes here ... -->
      </VariationSpecificsSet>
    </Variations>
  </SellingManagerProductSpecifics>
</AddSellingManagerProductRequest>

Argument	Type	Occurrence	Meaning

Standard Input Fields [Jump to call-specific fields]

ErrorLanguage	string	Optional	Use ErrorLanguage to return error strings for the call in a different language from the language commonly associated with the site that the requesting user is registered with. Specify the standard RFC 3066 language identification tag (e.g., en_US). ID--- country ----- ----- de_AT Austria de_CH Switzerland de_DE Germany en_AU Australia en_CA Canada en_GB United Kingdom en_SG Singapore en_US United States es_ES Spain fr_BE Belgium (French) fr_CA Canada (French) fr_FR France it_IT Italy nl_BE Belgium (Dutch) nl_NL Netherlands zh_CN China en_IN India en_IE Ireland zh_HK Hong Kong See Tags for the Identification of Languages.
MessageID	string	Optional	In most cases, all calls support a MessageID element in the request and a CorrelationID element in the response. If you pass a message ID in a request, we will return the same value in CorrelationID in the response. You can use this for tracking that a response is returned for every request and to match particular responses to particular requests. If you do not pass MessageID in the request, CorrelationID is not returned. Note: GetCategories, GetAttributesCS, GetCategory2CS, GetAttributesXSL, GetProductFinder, GetProductFinderXSL, and GetProductSearchPage are designed to retrieve very large sets of metadata that change once a day or less often. To improve performance, these calls return cached responses when you request all available data (with no filters). When this occurs, the MessageID and CorrelationID fields aren't applicable. However, if you specify an input filter to reduce the amount of data returned, the calls retrieve the latest data (not cached). When this occurs, MessageID and CorrelationID are applicable.
Version	string	Conditional	The version number of the API code that you are programming against (e.g., 549). The version you specify for a call has these basic effects: - It indicates the version of the code lists and other data that eBay should use to process your request. - It indicates the schema version you are using. You need to use a version that is greater than or equal to the lowest supported version. For the SOAP API: If you are using the SOAP API, this field is required. Specify the version of the WSDL your application is using. For the XML API: If you are using the XML API, this field has no effect. Instead, specify the version in the X-EBAY-API-COMPATIBILITY-LEVEL HTTP header. (If you specify Version in the body of an XML API request and it is different from the value in the HTTP header, eBay returns an informational warning that the value in the HTTP header was used instead.) See: HTTP Headers (XML API Only) eBay Schema Versioning Strategy Lowest Supported Version
WarningLevel	WarningLevelCodeType	Optional	Controls whether or not to return warnings when the application passes unrecognized or deprecated elements in a request. An unrecognized element is one that is not defined in any supported version of the schema. Schema element names are case-sensitive, so using WarningLevel can also help you remove any potential hidden bugs within your application due to incorrect case or spelling in field names before you put your application into the Production environment. WarningLevel only validates elements; it doesn't validate XML attributes. It also doesn't control warnings related to user-entered strings or numbers, or warnings for logical errors. We recommend that you only use this during development and debugging. Do not use this in requests in your production code. Applicable values: • High (in) Return warnings when the application passes unrecognized or deprecated elements in a request. • Low (in) Do not return warnings when the application passes unrecognized or deprecated elements in a request. This is the default value if WarningLevel is not specified. See Warning Level.

Call-specific Input Fields
FolderID	long	Optional	Unique identifier of the folder. This ID is created when the folder is added and is returned by the AddSellingManagerInventoryFolder call.
SellingManagerProductDetails	SellingManagerProductDetailsType	Required	Contains product information that the seller has recorded, such as a product description and inventory and restocking details.
SellingManagerProductDetails .CustomLabel	string	Optional	Custom label of this product.
SellingManagerProductDetails .QuantityAvailable	int	Optional	Quantity of items in the seller's inventory for this product.
SellingManagerProductDetails .UnitCost	AmountType (double)	Optional	Cost of each item of this product.
SellingManagerProductSpecifics	SellingManagerProductSpecificsType	Required	Specifies an eBay category associated with the product, defines Item Specifics that are relevant to the product, and defines variations available for the product (which may be used to create mult-variation listings).
SellingManagerProductSpecifics .ItemSpecifics	NameValueListArrayType	Optional	A list of custom Item Specifics for the product. Custom Item Specifics give sellers a structured way to describe details of their items in a name-value format. For example, a book could have Item Specifics like Author=J.K. Rowling and Format=Hardcover. To determine which categories support custom Item Specifics, use GetCategoryFeatures.
SellingManagerProductSpecifics .ItemSpecifics.NameValueList	NameValueListType	Optional, repeatable: [0..*]	For the AddItem family of calls: Contains the name and value(s) for an Item Specific. Only required when the ItemSpecifics container is specified. For the AddFixedPriceItem family of calls: The same NameValueList schema is used for the ItemSpecifics node, the VariationSpecifics node, and the VariationSpecifcsSet node. If the listing has varations, any name that you use in the VariationSpecifics and VariationSpecificsSet nodes can't be used in the ItemSpecifics node. When you list with Item Variations: a) Specify shared Item Specifics (e.g., Brand) in the ItemSpecifics node. b) Specify up to five VariationSpecifics in each Variation node. c) Specify all applicable names with all their supported values in the VariationSpecificSet node. See the Variation sample in the AddFixedPriceItem call reference for examples. For PlaceOffer: Required if the item being purchased includes Item Variations.
SellingManagerProductSpecifics .ItemSpecifics.NameValueList .Name	string	Optional	A name in a name/value pair. For the AddItem and AddFixedPriceItem families of calls: In the Item.ItemSpecifics context, this can be any name that the seller wants to use. However, to help buyers find items more easily, it is a good idea to try to use a recommended name when possible (see GetCategorySpecifics or GetItemRecommendations). You can't specify the same name twice within the same listing. For the AddFixedPriceItem family of calls: In the VariationSpecifics context, this can be any name that the seller wants to use, unless the VariationsEnabled flag is false for the name in the GetCategorySpecifics response. For example, for some categories eBay may recommend that you only use "Brand" as a shared name at the Item level, not in variations. For GetCategorySpecifics and GetItemRecommendations: This is a recommended (popular) name to use for items in the specified category (e.g., "Brand" might be recommended, not "Manufacturer"). For search calls: In the GetSearchResults response, this the name of an attribute (Attribute) that was used in the listing. Specifically: If SearchRequest was used to perform a "Product Finder" search, this contains the name of one attribute (i.e, the name of one ID-based Item Specifics field). If IncludeCondition was true in the request, this returns the condition attribute name (e.g., "Item Condition"). In the GetProducts response, this is an attribute name that is defined for a catalog product. For PlaceOffer: Required if the item being purchased includes Item Variations.
SellingManagerProductSpecifics .ItemSpecifics.NameValueList .Value	string	Optional, repeatable: [0..*]	A value associated with the name. For the AddItem family of calls: If you specify multiple values for Item Specifics, eBay only stores the first one, unless GetCategorySpecifics or GetItemRecommendations indicates that the corresponding name supports multiple values. For the AddFixedPriceItem family of calls: If you specify multiple values for Item Specifics or Variation Specifics, eBay only stores the first one, unless GetCategorySpecifics or GetItemRecommendations indicates that the corresponding name supports multiple values. In VariationSpecificSet, you typically specify multiple Value fields for each name. For example, if Name=Size, you would specify all size values that you wan to offer in the listing. For GetCategorySpecifics and GetItemRecommendations: The most highly recommended values are returned first. For these calls, Value is only returned when recommended values are available. For search calls: In the GetSearchResults response, if SearchRequest was used to perform a "Product Finder" search, this contains the value of one attribute. If IncludeCondition was true in the request, this returns the condition attribute value (e.g., "New"). For PlaceOffer: Required if the item being purchased includes Item Variations.
SellingManagerProductSpecifics .PrimaryCategoryID	string	Conditional	Category ID for a product with variations. Only applicable (and required on input) when Variations and/or ItemSpecifics is specified in the request or returned in a response.
SellingManagerProductSpecifics .Variations	VariationsType	Optional	Variations are multiple similar (but not identical) versions of the same product. For example, two shirt variations could have the same brand and sleeve style, but could vary by color and size (like "Blue, Large" and "Black, Medium"). On eBay, a single fixed-price (or Store Inventory Format) listing can include multiple variations. Each variation can have its own quantity and price. To determine which categories support variations, use GetCategoryFeatures.
SellingManagerProductSpecifics .Variations.Pictures	PicturesType	Optional, repeatable: [0..1]	Contains a set of pictures that correspond to one of the variation specifics, such as Color. For example, if a listing has blue and black color variations, you could choose Color for all the pictures, and then include a set of pictures for the blue variations and another set of pictures for the black variations. We strongly recommend that you also include shared pictures in Item.PictureDetails, as this results in a better experience for buyers. For ReviseFixedPriceItem only: To replace or delete individual pictures, pass in the entire Pictures node with the complete set of variation pictures that you want in the listing. If the applicable variations have purchases or the listing ends in less than 12 hours, you can add pictures, but you can't remove existing pictures. Note: Only one Pictures node is allowed for a listing. However, the node has been defined as unbounded (repeatable) in the schema to allow for different use cases for some calls or sites in the future. See Defining Pictures for Variations.
SellingManagerProductSpecifics .Variations.Pictures .VariationSpecificName	string	Optional	One aspect of the variations that will be illustrated in the pictures for all variations. For example, if each variation is visually distinguished by color and the pictures show the different colors available, then specify "Color" as the name. The name must match one of the names specified in the variation specifics. Required when variation pictures are present.
SellingManagerProductSpecifics .Variations.Pictures .VariationSpecificPictureSet	VariationSpecificPictureSetType	Optional, repeatable: [0..*]	One or more pictures that help buyers distinguish the Variations. Multiple picture sets can be specified. For example, suppose a listing contains blue and black color variations, and VariationSpecificName=Color. In this case, one picture set could contain pictures of the blue shirts (e.g., front view, back view, and close-up of a trim detail), and another picture set could contain pictures of the black shirts. At least one picture set is required if the Pictures node is present in the request. You are not required to provide pictures for all values that correspond to the variation specific name. For example, a listing could have pictures depicting the blue and black color variations, but not the pink variations.
SellingManagerProductSpecifics .Variations.Pictures .VariationSpecificPictureSet .PictureURL	anyURI	Optional, repeatable: [0..*]	The URL of a picture that is associated with VariationSpecificValue. Images can be hosted by eBay Picture Services (EPS) or they can be self-hosted, but you can't mix the two. (That is, pictures in PictureDetails and VariationSpecificPictureSet need to either all be hosted by EPS, or all self-hosted.) If specified, this cannot have an empty/null value. To specify multiple pictures, send each URL in a separate, adjacent PictureURL field. The first PictureURL is also used as the gallery picture for applicable variations. For example, if the picture set contains pictures of red shirts (i.e., VariationSpecificName=Color and VariationSpecificValue=Red), the first picture is used as the gallery picture for all the red shirt variations. You can use Item.PictureDetails to specify additional pictures. For example, the item-level pictures could include a model wearing a black shirt, as a typical example of the shirt style.
SellingManagerProductSpecifics .Variations.Pictures .VariationSpecificPictureSet .VariationSpecificValue	string	Optional	A value that is associated with VariationSpecificName. For example, suppose this set of pictures is showing blue shirts, and some of the variations include Color=Blue in their variation specifics. If VariationSpecificName is "Color", then VariationSpecificValue would be "Blue".
SellingManagerProductSpecifics .Variations.Variation	VariationType	Optional, repeatable: [0..*]	Contains data that distinguishes one variation from another. For example, if the items vary by color and size, each Variation node specifies a combination of one of those colors and sizes. When listing or relisting an item, you are allowed to create a listing with only one variation if you plan to add more variations to it in the future. However, if you don't plan to add other variations, we recommend that you avoid listing with only one variation, so that you avoid confusing buyers. When you modify a variation, it's safest to specify all the fields with the values you want in the listing. At a minimum, StartPrice and VariationSpecifics are required to modify an existing variation. If you omit SKU, the existing SKU (if any) is deleted from the variation. If you omit Quantity, it is set to 0. See Multi-Variation Listings.
SellingManagerProductSpecifics .Variations.Variation.Quantity	int	Optional	For AddFixedPriceItem and related calls: On input, this should be the number of items available for sale that are associated with this variation. If you set Quantity to zero when you create a new listing (or relist), the variation is dropped from the listing. For GetItem and related calls: On output, this is the total number of items associated with the variation (including the quantity sold). To calculate the quantity available for sale, subtract QuantitySold from this value. For ReviseFixedPriceItem: You can revise a variation's quantity at any time, even if it has purchases. However, at least one variation must remain with a non-zero quantity in order for the listing to remain active. When you modify a variation during revise or relist, you need to include both its StartPrice and Quantity. If you revise the Quantity value for a variation after items have already sold, specify the quantity available for sale. (eBay will automatically add the quantity sold to the value you specify.) If you set the quantity to 0 and the variation has no purchases, the variation may be dropped from the listing. For GetSellerTransactions: See Item.Quantity instead. See the Trading API Guide for more details about setting and modifying a variation's quantity. See Setting and Modifying a Variation's Quantity.
SellingManagerProductSpecifics .Variations.Variation.SKU	SKUType (string)	Optional	A SKU (stock keeping unit) is an identifier defined by a seller. Some sellers use SKUs to track complex flows of products and information on the client side. eBay preserves the SKU on the variation, enabling you to obtain it before and after a transaction is created. All SKU values must be unique within the Variations node. That is, no two variations within the same listing can have the same SKU (if specified). If Item.InventoryTrackingMethod is set to true, the SKU values must be specified and they must be unique across all the seller's active listings. Only returned if the seller specified a SKU for the variation. Max length: 70. See Setting the Variation SKU.
SellingManagerProductSpecifics .Variations.Variation .StartPrice	AmountType (double)	Optional	The fixed price of all items identified by this variation. For example, a "Blue, Large" variation price could be USD 10.00, and a "Black, Medium" variation price could be USD 5.00. Each variation requires its own price, and the prices can be different for each variation. This enables sellers to provide discounts on certain variations without affecting the price of others. Required (and always returned) for listings with variations. You can revise a variation's price at any time (even if it has purchases). When you modify a variation during revise or relist, you need to include both its StartPrice and Quantity. See Setting the Variation Price.
SellingManagerProductSpecifics .Variations.Variation.UnitCost	AmountType (double)	Optional	Cost of the Selling Manager product that matches this variation.
SellingManagerProductSpecifics .Variations.Variation .UnitsAvailable	int	Optional	Quantity of items in the seller's inventory for this Selling Manager product. This is not the same as the quantity available in a listed item. Required when a Selling Manager product defines variations.
SellingManagerProductSpecifics .Variations.Variation .VariationSpecifics	NameValueListArrayType	Optional	A list of name/value pairs that uniquely identify the variation within the listing. All variations must specify the same set of names, and each variation must provide a unique combination of values for those names. For example, if the items vary by color and size, then every variation must specify Color and Size as names, and no two variations can specify the same combination of color and size values. When you revise a listing that includes variations, you can't add or change names or values in variation specifics (because the set of variation specifics serves as a unique identifier). However, you can delete or replace individual variations as needed to match your current inventory. Use the Variation.Delete field to delete a variation that has no sales (transactions). If the variation has sales, then set the Quantity to 0. For GetSellerEvents To keep the GetSellerEvents response smaller, variation specifics are not returned if the variation has a SKU. If the variation has no SKU, then variation specifics are returned instead. Optionally, you can pass IncludeVariationSpecifics as true in the request to force variation specifics to be returned, even when the SKU is returned. See: Setting Item Specifics for Variations Revising and Relisting with Variations
SellingManagerProductSpecifics .Variations.Variation .VariationSpecifics .NameValueList	NameValueListType	Optional, repeatable: [0..*]	For the AddItem family of calls: Contains the name and value(s) for an Item Specific. Only required when the ItemSpecifics container is specified. For the AddFixedPriceItem family of calls: The same NameValueList schema is used for the ItemSpecifics node, the VariationSpecifics node, and the VariationSpecifcsSet node. If the listing has varations, any name that you use in the VariationSpecifics and VariationSpecificsSet nodes can't be used in the ItemSpecifics node. When you list with Item Variations: a) Specify shared Item Specifics (e.g., Brand) in the ItemSpecifics node. b) Specify up to five VariationSpecifics in each Variation node. c) Specify all applicable names with all their supported values in the VariationSpecificSet node. See the Variation sample in the AddFixedPriceItem call reference for examples. For PlaceOffer: Required if the item being purchased includes Item Variations.
SellingManagerProductSpecifics .Variations.Variation .VariationSpecifics .NameValueList.Name	string	Optional	A name in a name/value pair. For the AddItem and AddFixedPriceItem families of calls: In the Item.ItemSpecifics context, this can be any name that the seller wants to use. However, to help buyers find items more easily, it is a good idea to try to use a recommended name when possible (see GetCategorySpecifics or GetItemRecommendations). You can't specify the same name twice within the same listing. For the AddFixedPriceItem family of calls: In the VariationSpecifics context, this can be any name that the seller wants to use, unless the VariationsEnabled flag is false for the name in the GetCategorySpecifics response. For example, for some categories eBay may recommend that you only use "Brand" as a shared name at the Item level, not in variations. For GetCategorySpecifics and GetItemRecommendations: This is a recommended (popular) name to use for items in the specified category (e.g., "Brand" might be recommended, not "Manufacturer"). For search calls: In the GetSearchResults response, this the name of an attribute (Attribute) that was used in the listing. Specifically: If SearchRequest was used to perform a "Product Finder" search, this contains the name of one attribute (i.e, the name of one ID-based Item Specifics field). If IncludeCondition was true in the request, this returns the condition attribute name (e.g., "Item Condition"). In the GetProducts response, this is an attribute name that is defined for a catalog product. For PlaceOffer: Required if the item being purchased includes Item Variations.
SellingManagerProductSpecifics .Variations.Variation .VariationSpecifics .NameValueList.Value	string	Optional, repeatable: [0..*]	A value associated with the name. For the AddItem family of calls: If you specify multiple values for Item Specifics, eBay only stores the first one, unless GetCategorySpecifics or GetItemRecommendations indicates that the corresponding name supports multiple values. For the AddFixedPriceItem family of calls: If you specify multiple values for Item Specifics or Variation Specifics, eBay only stores the first one, unless GetCategorySpecifics or GetItemRecommendations indicates that the corresponding name supports multiple values. In VariationSpecificSet, you typically specify multiple Value fields for each name. For example, if Name=Size, you would specify all size values that you wan to offer in the listing. For GetCategorySpecifics and GetItemRecommendations: The most highly recommended values are returned first. For these calls, Value is only returned when recommended values are available. For search calls: In the GetSearchResults response, if SearchRequest was used to perform a "Product Finder" search, this contains the value of one attribute. If IncludeCondition was true in the request, this returns the condition attribute value (e.g., "New"). For PlaceOffer: Required if the item being purchased includes Item Variations.
SellingManagerProductSpecifics .Variations .VariationSpecificsSet	NameValueListArrayType	Optional	The set of all variation names and values that can be applicable to the listing (at any time in its life cycle). This must include (but is not limited to) all names and values specified in the VariationSpecifics nodes. This set configures variation selection widgets that appear on eBay's View Item page. For example, if you specify Color and Size names in the set, eBay's View Item page displays Color and Size drop-down lists to enable a buyer to choose a variation of interest. The order in which you specify the names and values also controls the order in which the selection widgets appear on the View Item page. For example, if you specify "Color", then "Size", and then "Sleeve Style" as names, the View Item page shows drop-down lists with those labels in that order. For "Size", if you specify "S", "M", and "L" as values, the View Item page shows the values in that order in the Size drop-down list. Use GetCategorySpecifics to retrieve recommendations for names, values, and order. Required when Variations are specified in a new listing (e.g., in AddFixedPriceItem). See Configuring Variation-Selection Widgets for Buyers (View Item).
SellingManagerProductSpecifics .Variations .VariationSpecificsSet .NameValueList	NameValueListType	Optional, repeatable: [0..*]	For the AddItem family of calls: Contains the name and value(s) for an Item Specific. Only required when the ItemSpecifics container is specified. For the AddFixedPriceItem family of calls: The same NameValueList schema is used for the ItemSpecifics node, the VariationSpecifics node, and the VariationSpecifcsSet node. If the listing has varations, any name that you use in the VariationSpecifics and VariationSpecificsSet nodes can't be used in the ItemSpecifics node. When you list with Item Variations: a) Specify shared Item Specifics (e.g., Brand) in the ItemSpecifics node. b) Specify up to five VariationSpecifics in each Variation node. c) Specify all applicable names with all their supported values in the VariationSpecificSet node. See the Variation sample in the AddFixedPriceItem call reference for examples. For PlaceOffer: Required if the item being purchased includes Item Variations.
SellingManagerProductSpecifics .Variations .VariationSpecificsSet .NameValueList.Name	string	Optional	A name in a name/value pair. For the AddItem and AddFixedPriceItem families of calls: In the Item.ItemSpecifics context, this can be any name that the seller wants to use. However, to help buyers find items more easily, it is a good idea to try to use a recommended name when possible (see GetCategorySpecifics or GetItemRecommendations). You can't specify the same name twice within the same listing. For the AddFixedPriceItem family of calls: In the VariationSpecifics context, this can be any name that the seller wants to use, unless the VariationsEnabled flag is false for the name in the GetCategorySpecifics response. For example, for some categories eBay may recommend that you only use "Brand" as a shared name at the Item level, not in variations. For GetCategorySpecifics and GetItemRecommendations: This is a recommended (popular) name to use for items in the specified category (e.g., "Brand" might be recommended, not "Manufacturer"). For search calls: In the GetSearchResults response, this the name of an attribute (Attribute) that was used in the listing. Specifically: If SearchRequest was used to perform a "Product Finder" search, this contains the name of one attribute (i.e, the name of one ID-based Item Specifics field). If IncludeCondition was true in the request, this returns the condition attribute name (e.g., "Item Condition"). In the GetProducts response, this is an attribute name that is defined for a catalog product. For PlaceOffer: Required if the item being purchased includes Item Variations.
SellingManagerProductSpecifics .Variations .VariationSpecificsSet .NameValueList.Value	string	Optional, repeatable: [0..*]	A value associated with the name. For the AddItem family of calls: If you specify multiple values for Item Specifics, eBay only stores the first one, unless GetCategorySpecifics or GetItemRecommendations indicates that the corresponding name supports multiple values. For the AddFixedPriceItem family of calls: If you specify multiple values for Item Specifics or Variation Specifics, eBay only stores the first one, unless GetCategorySpecifics or GetItemRecommendations indicates that the corresponding name supports multiple values. In VariationSpecificSet, you typically specify multiple Value fields for each name. For example, if Name=Size, you would specify all size values that you wan to offer in the listing. For GetCategorySpecifics and GetItemRecommendations: The most highly recommended values are returned first. For these calls, Value is only returned when recommended values are available. For search calls: In the GetSearchResults response, if SearchRequest was used to perform a "Product Finder" search, this contains the value of one attribute. If IncludeCondition was true in the request, this returns the condition attribute value (e.g., "New"). For PlaceOffer: Required if the item being purchased includes Item Variations.

AddSellingManagerProduct Output

The box below lists all fields that might be returned in the response. To learn more about an individual field or its type, click its name in the box (or scroll down to find it in the table below the box).

See also Samples.

See also the Deprecated Objects link above. Fields presented in this color are deprecated, and fields presented in this color are not returned (or soon will not be returned) or are not operational (or soon will be non-operational).

The XML prototype does not include requester credentials. This is a documentation limitation only (see Standard Requester Credentials for Making Calls).

<?xml version="1.0" encoding="utf-8"?>
<AddSellingManagerProductResponse xmlns="urn:ebay:apis:eBLBaseComponents">
  <!-- Standard Output Fields -->
  <Ack> AckCodeType </Ack>
  <Build> string </Build>
  <CorrelationID> string </CorrelationID>
  <Errors> ErrorType 
    <ErrorClassification> ErrorClassificationCodeType </ErrorClassification>
    <ErrorCode> token </ErrorCode>
    <ErrorParameters ParamID="string"> ErrorParameterType 
      <Value> string </Value>
    </ErrorParameters>
    <!-- ... more ErrorParameters nodes here ... -->
    <LongMessage> string </LongMessage>
    <SeverityCode> SeverityCodeType </SeverityCode>
    <ShortMessage> string </ShortMessage>
  </Errors>
  <!-- ... more Errors nodes here ... -->
  <HardExpirationWarning> string </HardExpirationWarning>
  <Timestamp> dateTime </Timestamp>
  <Version> string </Version>
  <!-- Call-specific Output Fields -->
  <SellingManagerProductDetails> SellingManagerProductDetailsType 
    <CustomLabel> string </CustomLabel>
    <ProductID> long </ProductID>
    <QuantityAvailable> int </QuantityAvailable>
    <UnitCost> AmountType (double) </UnitCost>
  </SellingManagerProductDetails>
</AddSellingManagerProductResponse>

Return Value	Type	Occurrence	Meaning

Standard Output Fields [Jump to call-specific fields]

Ack	AckCodeType	Always	A token representing the application-level acknowledgement code that indicates the response status (e.g., success). The AckCodeType list specifies the possible values for Ack. Applicable values: • CustomCode (out) Reserved for internal or future use. • Failure (out) Request processing failed • Success (out) Request processing succeeded • Warning (out) Request processing completed with warning information being included in the response message (Not all values in AckCodeType apply to this field.)
Build	string	Always	This refers to the specific software build that eBay used when processing the request and generating the response. This includes the version number plus additional information. eBay Developer Support may request the build information when helping you resolve technical issues.
CorrelationID	string	Conditionally	In most cases, all calls support a MessageID element in the request and a CorrelationID element in the response. If you pass a message ID in a request, we will return the same value in CorrelationID in the response. You can use this for tracking that a response is returned for every request and to match particular responses to particular requests. If you do not pass MessageID in the request, CorrelationID is not returned. Note: GetCategories, GetAttributesCS, GetCategory2CS, GetAttributesXSL, GetProductFinder, GetProductFinderXSL, and GetProductSearchPage are designed to retrieve very large sets of metadata that change once a day or less often. To improve performance, these calls return cached responses when you request all available data (with no filters). When this occurs, the MessageID and CorrelationID fields aren't applicable. However, if you specify an input filter to reduce the amount of data returned, the calls retrieve the latest data (not cached). When this occurs, MessageID and CorrelationID are applicable.
Errors	ErrorType	Conditionally, repeatable: [0..*]	A list of application-level errors (if any) that occurred when eBay processed the request. See Error Handling.
Errors.ErrorClassification	ErrorClassificationCodeType	Conditionally	API errors are divided between two classes: system errors and request errors. Applicable values: • CustomCode (out) Reserved for internal or future use. • RequestError (out) An error has occurred either as a result of a problem in the sending application or because the application's end-user has attempted to submit invalid data (or missing data). In these cases, do not retry the request. The problem must be corrected before the request can be made again. If the problem is due to something in the application (such as a missing required field), the application must be changed. If the problem is a result of end-user data, the application must alert the end-user to the problem and provide the means for the end-user to correct the data. Once the problem in the application or data is resolved, resend the request to eBay with the corrected data. • SystemError (out) Indicates that an error has occurred on the eBay system side, such as a database or server down. An application can retry the request as-is a reasonable number of times (eBay recommends twice). If the error persists, contact Developer Technical Support. Once the problem has been resolved, the request may be resent in its original form.
Errors.ErrorCode	token	Conditionally	A unique code that identifies the particular error condition that occurred. Your application can use error codes as identifiers in your customized error-handling algorithms. See the "Errors by Number" document.
Errors.ErrorParameters	ErrorParameterType	Conditionally, repeatable: [0..*]	This optional element carries a list of context-specific error variables that indicate details about the error condition. These are useful when multiple instances of ErrorType are returned.
Errors.ErrorParameters [ attribute ParamID ]	string	Conditionally	The index of the parameter in the list of parameter types returned within the error type.
Errors.ErrorParameters.Value	string	Conditionally	The value of the variable (e.g., the attribute set ID)
Errors.LongMessage	string	Conditionally	A more detailed description of the condition that raised the error.
Errors.SeverityCode	SeverityCodeType	Conditionally	Indicates whether the error is a severe error (causing the request to fail) or an informational error (a warning) that should be communicated to the user. Applicable values: • CustomCode (out) Reserved for internal or future use • Error (out) Application-level error • Warning (out) Warning or informational error
Errors.ShortMessage	string	Conditionally	A brief description of the condition that raised the error.
HardExpirationWarning	string	Conditionally	Expiration date of the user's authentication token. Only returned within the 7-day period prior to a token's expiration. To ensure that user authentication tokens are secure and to help avoid a user's token being compromised, tokens have a limited life span. A token is only valid for a period of time (set by eBay). After this amount of time has passed, the token expires and must be replaced with a new token.
Timestamp	dateTime	Always	This value represents the date and time when eBay processed the request. The time zone of this value is GMT and the format is the ISO 8601 date and time format (YYYY-MM-DDTHH:MM:SS.SSSZ). See Time Values in the eBay Web Services guide for information about this time format and converting to and from the GMT time zone. Note: GetCategories, GetAttributesCS, GetCategory2CS, GetAttributesXSL, GetProductFinder, GetProductFinderXSL, and GetProductSearchPage are designed to retrieve very large sets of metadata that change once a day or less often. To improve performance, these calls return cached responses when you request all available data (with no filters). When this occurs, this time value reflects the time the cached response was created. Thus, this value is not necessarily when the request was processed. However, if you specify an input filter to reduce the amount of data returned, the calls retrieve the latest data (not cached). When this occurs, this time value does reflect when the request was processed.
Version	string	Always	The version of the response payload schema. Indicates the version of the schema that eBay used to process the request. See "Standard Data for All Calls" in the eBay Web Services Guide for information on using the response version when troubleshooting "CustomCode" values that appear in the response.

Call-specific Output Fields
SellingManagerProductDetails	SellingManagerProductDetailsType	Always	The details of the product.
SellingManagerProductDetails .CustomLabel	string	Conditionally	Custom label of this product.
SellingManagerProductDetails .ProductID	long	Always	The ID of a Selling Manager product. When you call AddSellingManagerProduct, a product ID is returned for the product created. When you use this ID to make subsequent calls, such as AddSellingManagerTemplate, the ProductID you provide on input is returned in the output.
SellingManagerProductDetails .QuantityAvailable	int	Always	Quantity of items in the seller's inventory for this product.
SellingManagerProductDetails .UnitCost	AmountType (double)	Conditionally	Cost of each item of this product.

AddSellingManagerProduct Detail Controls

Detail Control: DetailLevel

This call does not support varying Detail Levels. You do not need to pass DetailLevel in the request.

AddSellingManagerProduct Samples

New to making API calls? Please see Routing the Request.

Note: Some item IDs, user IDs, or other data in these samples might no longer be active on eBay. If necessary, you can substitute current eBay data in your requests.

Sample: Basic Call

Adds a product listing into Selling Manager.

Description

User magicalbookseller would like to add a new Harry Potter product into Selling Manager. She can accomplish this via AddSellingManagerProduct, a call that will enable her to assign templates to a particular product. She creates the new product in a folder, specified in FolderID in the request.

Input

The fields in the following AddSellingManagerProduct request sample are the basic input required to add a product into Selling Manager.

XML format (HTTP POST). Also available is the .txt version of this XML.

<?xml version="1.0" encoding="utf-8"?>
<AddSellingManagerProductRequest xmlns="urn:ebay:apis:eBLBaseComponents">
  <Version>607</Version>
  <RequesterCredentials>
      <eBayAuthToken>ABC...123</eBayAuthToken>
  </RequesterCredentials>
  <SellingManagerProductDetails>
    <ProductName>Harry Potter Book4</ProductName>
    <QuantityAvailable>50</QuantityAvailable>
    <FolderID>4651612545</FolderID>
  </SellingManagerProductDetails>
</AddSellingManagerProductRequest>

Output

The response includes the Ack declaring success or failure.

XML format. Also available is the .txt version of this XML.

<?xml version="1.0" encoding="utf-8"?>
<AddSellingManagerProductResponse xmlns="urn:ebay:apis:eBLBaseComponents">
  <Timestamp>2009-03-19T01:01:36.380Z</Timestamp>
  <Ack>Success</Ack>
  <Version>609</Version>
  <Build>e609_core_Bundled_8177180_R1</Build>
  <SellingManagerProductDetails>
    <ProductName>Harry Potter Book4</ProductName>
    <ProductID>6025561013</ProductID>
    <QuantityAvailable>50</QuantityAvailable>
  </SellingManagerProductDetails>
</AddSellingManagerProductResponse>

AddSellingManagerProduct Change History

Version	Description
615 2008-04-29	SellingManagerProductSpecifics (added): New node for describing variations in a multi-variation product, item specifics, and a primary category ID.
589 2008-10-30	(added) New call.

This document was generated with a customized version of the apireferencedocs tool.

eBay Trading API Call Reference Version 643

Prerequisites

Related Information

eBay Trading API
Call Reference Version 643