GetCrossPromotions

Note: This call is no longer recommended as eBay Store Cross Promotions are no longer supported in the Trading API.

Use this call to retrieve a list of upsell or cross-sell items associated with the specified item ID. The seller must be the owner of an eBay Stores storefront to cross-promote items.

GetCrossPromotions retrieves a list of upsell or cross-sell items for one referring item. This call is a component of the Merchandising Manager feature. To use GetCrossPromotions, the seller must be the owner of an eBay Stores storefront, with any level of eBay Stores subscription.

GetCrossPromotions returns all the promotion rules associated with the referring item. The call does not return promotion rules associated with store categories.

See Cross-Promotions.

See also the reference documentation for these calls:

GetPromotionRules - No longer recommended. eBay Store Cross Promotions are no longer supported in the Trading API.
SetPromotionalSale - Creates or modifies a promotional sale. Promotional sales enable sellers to apply discounts and/or free shipping across many listings.

GetCrossPromotions 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"?>
<GetCrossPromotionsRequest xmlns="urn:ebay:apis:eBLBaseComponents">
  <!-- Call-specific Input Fields -->
  <ItemID> ItemIDType (string) </ItemID>
  <PromotionMethod> PromotionMethodCodeType </PromotionMethod>
  <PromotionViewMode> TradingRoleCodeType </PromotionViewMode>
  <!-- Standard Input Fields -->
  <ErrorLanguage> string </ErrorLanguage>
  <MessageID> string </MessageID>
  <OutputSelector> string </OutputSelector>
  <!-- ... more OutputSelector values allowed here ... -->
  <Version> string </Version>
  <WarningLevel> WarningLevelCodeType </WarningLevel>
</GetCrossPromotionsRequest>

Argument	Type	Occurrence	Meaning

Call-specific Input Fields [Jump to standard fields]

ItemID

ItemIDType (string)

Required

The unique ID of the referring item. The cross-promoted items will supplement this item.
Max length: 19 (Note: The eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits).

PromotionMethod

PromotionMethodCodeType

Required

The cross-promotion method you want to use for the returned list, either UpSell or CrossSell.

Applicable values:

• CrossSell

(in/out) Promote/present items that are related to or can be used with the specified item.

• CustomCode

(in/out) Reserved for internal or future use.

• UpSell

(in/out) Promote/present items that of higher quality or more expensive than the specified item.

PromotionViewMode

TradingRoleCodeType

Optional

The role of the person requesting to view the cross-promoted items, either seller or buyer. Default is buyer.

Applicable values:

• Buyer

(in/out) The eBay user is acting as the buyer for the order(s). In GetOrders, this value should be passed into the OrderRole field in the request to retrieve orders in which the calling eBay user is the buyer in the order.

• CustomCode

(in/out) This value is reserved for future or internal use.

• Seller

(in/out) The eBay user is acting as the seller for the order(s). In GetOrders, this value should be passed into the OrderRole field in the request to retrieve orders in which the calling eBay user is the seller in the order.

Standard Input 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	Most Trading API calls support a MessageID element in the request and a CorrelationID element in the response. If you pass in a MessageID in a request, the same value will be returned in the CorrelationID field in the response. Pairing these values can help you track and confirm that a response is returned for every request and to match specific responses to specific requests. If you do not pass a MessageID value in the request, CorrelationID is not returned. Note: GetCategories is 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.
OutputSelector	string	Optional, repeatable: [0..*]	You can use the OutputSelector field to restrict the data returned by this call. When you make a call such as GetItem that retrieves data from eBay, the OutputSelector field is useful for restricting the data returned. This field makes the call response easier to use, especially when a large payload would be returned. If you use the OutputSelector field, the output data will include only the fields you specified in the request. For example, if you are using GetItem and you want the item data in the response to be restricted to the ViewItemURL (the URL where a user can view the listing) and BuyItNowPrice, then within the GetItem request, specify those output fields. To use this field, see the information at the following link. See Selecting Fields to Retrieve.
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: Routing the Request (Gateway URLs) 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.

GetCrossPromotions 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).

<?xml version="1.0" encoding="utf-8"?>
<GetCrossPromotionsResponse xmlns="urn:ebay:apis:eBLBaseComponents">
  <!-- Call-specific Output Fields -->
  <CrossPromotion> CrossPromotionsType
    <ItemID> ItemIDType (string) </ItemID>
    <PrimaryScheme> PromotionSchemeCodeType </PrimaryScheme>
    <PromotedItem> PromotedItemType
    </PromotedItem>
    <!-- ... more PromotedItem nodes allowed here ... -->
    <PromotionMethod> PromotionMethodCodeType </PromotionMethod>
    <SellerID> string </SellerID>
    <ShippingDiscount> boolean </ShippingDiscount>
    <StoreName> string </StoreName>
  </CrossPromotion>
  <!-- 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 allowed here ... -->
    <LongMessage> string </LongMessage>
    <SeverityCode> SeverityCodeType </SeverityCode>
    <ShortMessage> string </ShortMessage>
  </Errors>
  <!-- ... more Errors nodes allowed here ... -->
  <HardExpirationWarning> string </HardExpirationWarning>
  <Timestamp> dateTime </Timestamp>
  <Version> string </Version>
</GetCrossPromotionsResponse>

Return Value	Type	Occurrence	Meaning

Call-specific Output Fields [Jump to standard fields]

CrossPromotion	CrossPromotionsType	Always	eBay Store Cross Promotions are no longer supported in the Trading API, so the CrossPromotion container will either not be returned, or, if it is returned, the data in the container may not be accurate. A list of cross-promoted items defined for a specific referring item. The list is either upsell or cross-sell items, according to the value of PromotionMethod in GetCrossPromotionsRequest. Not applicable to Half.com.
CrossPromotion.ItemID	ItemIDType (string)	Always	Unique item ID for the referring item. Max length: 19 (Note: The eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits).
CrossPromotion.PrimaryScheme	PromotionSchemeCodeType	Always	The primary cross-promotion rule scheme that was applied to return the cross-promoted item. Applicable values: • CategoryProximity (out) This scheme is returned as a backfill scheme used to promote items. • CustomCode (out) Reserved for internal or future use. • DefaultCrossSellLogic (out) This scheme is returned as a backfill scheme used to promote items. • DefaultRule (out) The seller specifies a store category or eBay category, with optional keywords, for referring items and one for promoted items. When a referring item is selected from the category and keywords, items from the promoted category and keywords are also displayed. • DefaultUpSellLogic (out) This scheme is returned as a backfill scheme used to promote items. • ItemToDefaultRule (out) The seller specifies a referring item and defines promoted items selected from a store category, eBay category, or keywords. • ItemToItem (out) The seller specifies individual items in the store that are promoted when a buyer views, bids on, or purchases a store item. • ItemToStoreCat (out) The seller specifies a store category from which items are promoted when a buyer views, bids on, or purchases an individual item in the store. • RelatedCategoryRule (out) This scheme is returned as related category scheme used to promote items. • StoreToStoreCat (out) The seller specifies referring and promoted categories, both from the store. When a buyer views or acts on any item from that category, items from the promoted category are also displayed.
CrossPromotion.PromotedItem	PromotedItemType	Conditionally, repeatable: [0..*]	Contains one cross-promoted item.
CrossPromotion.PromotionMethod	PromotionMethodCodeType	Always	The type of promotion, CrossSell or UpSell. Applicable values: • CrossSell (in/out) Promote/present items that are related to or can be used with the specified item. • CustomCode (in/out) Reserved for internal or future use. • UpSell (in/out) Promote/present items that of higher quality or more expensive than the specified item.
CrossPromotion.SellerID	string	Always	The eBay user ID of the seller offering the cross-promoted item.
CrossPromotion .ShippingDiscount	boolean	Always	Whether a shipping discount is offered by the seller when the cross-promoted item is purchased.
CrossPromotion.StoreName	string	Conditionally	The store name of the seller offering the cross-promoted item.

Standard Output 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	Most Trading API calls support a MessageID element in the request and a CorrelationID element in the response. If you pass in a MessageID in a request, the same value will be returned in the CorrelationID field in the response. Pairing these values can help you track and confirm that a response is returned for every request and to match specific responses to specific requests. If you do not pass a MessageID value in the request, CorrelationID is not returned. Note: GetCategories is 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 and other Trading API calls 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.

GetCrossPromotions Detail Controls

Detail Control: DetailLevel

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

GetCrossPromotions 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

Returns the cross promotions for the specified item.

Description

This example returns the UpSell promotions for the specified item ID.

Input

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

<?xml version="1.0" encoding="utf-8"?>
<GetCrossPromotionsRequest xmlns="urn:ebay:apis:eBLBaseComponents">
  <RequesterCredentials>
    <eBayAuthToken>ABC...123</eBayAuthToken>
  </RequesterCredentials>
  <PromotionMethod>UpSell</PromotionMethod>
  <ItemID>110043904462</ItemID>
</GetCrossPromotionsRequest>

Output

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

<GetCrossPromotionsResponse xmlns="urn:ebay:apis:eBLBaseComponents">
  <Timestamp>2010-02-27T00:24:20.407Z</Timestamp>
  <Ack>Success</Ack>
  <Version>657</Version>
  <Build>E657_CORE_BUNDLED_10708779_R1</Build>
  <CrossPromotion>
    <ItemID>110043904462</ItemID>
    <PrimaryScheme>DefaultCrossSellLogic</PrimaryScheme>
    <PromotionMethod>UpSell</PromotionMethod>
    <SellerID>magicalbookseller</SellerID>
    <ShippingDiscount>false</ShippingDiscount>
    <StoreName>MagicalBooksForYou</StoreName>
    <PromotedItem>
      <ItemID>110035506541</ItemID>
      <Position>1</Position>
      <SelectionType>Automatic</SelectionType>
      <Title>Pink Floyd CD (with basic fields) (cmg)</Title>
      <ListingType>FixedPriceItem</ListingType>
      <PromotionDetails>
        <PromotionPrice currencyID="USD">5.0</PromotionPrice>
        <PromotionPriceType>BuyItNowPrice</PromotionPriceType>
      </PromotionDetails>
    </PromotedItem>
  </CrossPromotion>
</GetCrossPromotionsResponse>

GetCrossPromotions Change History

Version	Description
797 2012-10-24	GetCrossPromotionsRequest (modified): This call is no longer recommended as eBay Store Cross Promotions are no longer supported in the Trading API.
499 2007-02-07	PromotedItem.PromotionPrice, PromotedItem.PromotionPriceType, PromotedItem.SelfHostedURL, SellerKey (modified): Deleted previously deprecated objects from the latest schema. Some of these objects are still supported with lower request versions. See Deprecated Objects.
485 2006-11-01	PromotedItem.PromotionDetails (added): Contains details about a promoted item for a given PromotionPriceType. Emitted for a request version of 485 or higher only. Replaces PromotedItem.PromotionPrice and PromotedItem.PromotionPriceType. PromotionDetails also includes BidCount for auction items and ConvertedPromotionPrice for items listed on sites different from the site specified in the request. PromotedItem.TimeLeft (added): Indicates the time left before the listing for the cross-promoted item ends. CrossPromotion.PrimaryScheme.DefaultUpSellLogic (added): New output to identify Up-sell as the scheme used for promoting items. CrossPromotion.PrimaryScheme.DefaultCrossSellLogic (added): New output to identify Cross-sell as the scheme used for promoting items. PromotedItem.PromotionPrice (deprecated): With a request version of 485 or higher, PromotionPrice is returned within a PromotionDetails container. PromotedItem.PromotionPriceType (deprecated): With a request version of 485 or higher, PromotionPriceType is returned within a PromotionDetails container.
477 2006-09-06	PromotionSchemeCodeType.RelatedCategoryRule (added): New output to identify Related Category as the scheme used for promoting items.

User-Contributed Notes

eBay Trading API Call Reference Version 827