GetPromotionalSaleDetails

Use this call to retrieve information about promotional sales set up by an eBay store owner (the authenticated caller). Promotional sales are discounts that eBay store owners apply to items listed in their stores. This call is part of the Promotional Price Display feature, which enables sellers to apply discounts across many listings.

If you do not specify a PromotionalSaleID value in the request, GetPromotionalSaleDetails returns all promotional sales for the authenticated user. Promotional sales apply to single and multi-quantity Store Inventory format, regular fixed-price format, auction, and auction/BIN formats. Auction and auction/BIN format listings can include only free shipping as a promotional discount.

You can test this call in the Sandbox environment. However, you (or the test user) must be a registered store owner to use this call.

See Putting Store Items on Sale.

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.
SetPromotionalSaleListings - Defines the SetPromotionalSaleListings call request.

GetPromotionalSaleDetails 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"?>
<GetPromotionalSaleDetailsRequest xmlns="urn:ebay:apis:eBLBaseComponents">
  <!-- Call-specific Input Fields -->
  <PromotionalSaleID> long </PromotionalSaleID>
  <PromotionalSaleStatus> PromotionalSaleStatusCodeType </PromotionalSaleStatus>
  <!-- ... more PromotionalSaleStatus values allowed here ... -->
  <!-- Standard Input Fields -->
  <ErrorLanguage> string </ErrorLanguage>
  <MessageID> string </MessageID>
  <Version> string </Version>
  <WarningLevel> WarningLevelCodeType </WarningLevel>
</GetPromotionalSaleDetailsRequest>

Argument	Type	Occurrence	Meaning

Call-specific Input Fields [Jump to standard fields]

PromotionalSaleID

long

Optional

The ID of the promotional sale about which you want information. If you do not specify this field, then all promotional sales for the seller making the call are returned or only those promotional sales matching the specified promotional sale status filter, PromotionalSaleStatus.

If PromotionalSaleID and PromotionalSaleStatus are both specified, the single promotional sale specified by ID is returned only if its status matches the specified status filter.

PromotionalSaleStatus

PromotionalSaleStatusCodeType

Optional,
repeatable: [0..*]

Specifies the promotional sales to return, based upon their status. For example, specify "Scheduled" to retrieve only promotional sales with a Status of Scheduled. If you want to retrieve promotional sales for more than one status, you can repeat the field with an additional status value, such as Active.

If this field is used together with PromotionalSaleID, the single promotional sale specified by ID is returned only if its status matches the specified status filter.

If neither field is used, all of the seller's promotional sales are returned, regardless of status.
Default: No filtering.

Applicable values:

• Active

(in/out) The promotional sale is active.

• CustomCode

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

• Deleted

(in/out) The promotional sale has been deleted. Deleted promotional sales cannot be updated or reactivated.

• Inactive

(in/out) The promotional sale is inactive, the sale has ended. You can reschedule a sale once it has ended, but you will need to wait at least 24 hours before it can become active.

• Processing

(in/out) The status of the promotional sale is pending. When first scheduling a Sale, if you select over 200 listings to be in any given Sale, it will take some time for eBay to process the request.

• Scheduled

(in/out) The promotional sale is scheduled. That is, the start time is in the future.

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

GetPromotionalSaleDetails 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"?>
<GetPromotionalSaleDetailsResponse xmlns="urn:ebay:apis:eBLBaseComponents">
  <!-- Call-specific Output Fields -->
  <PromotionalSaleDetails> PromotionalSaleArrayType
    <PromotionalSale> PromotionalSaleType
      <DiscountType> DiscountCodeType </DiscountType>
      <DiscountValue> double </DiscountValue>
      <PromotionalSaleEndTime> dateTime </PromotionalSaleEndTime>
      <PromotionalSaleID> long </PromotionalSaleID>
      <PromotionalSaleItemIDArray> ItemIDArrayType
        <ItemID> ItemIDType (string) </ItemID>
        <!-- ... more ItemID values allowed here ... -->
      </PromotionalSaleItemIDArray>
      <PromotionalSaleName> string </PromotionalSaleName>
      <PromotionalSaleStartTime> dateTime </PromotionalSaleStartTime>
      <PromotionalSaleType> PromotionalSaleTypeCodeType </PromotionalSaleType>
      <Status> PromotionalSaleStatusCodeType </Status>
    </PromotionalSale>
    <!-- ... more PromotionalSale nodes allowed here ... -->
  </PromotionalSaleDetails>
  <!-- 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>
</GetPromotionalSaleDetailsResponse>

Return Value	Type	Occurrence	Meaning

Call-specific Output Fields [Jump to standard fields]

PromotionalSaleDetails	PromotionalSaleArrayType	Conditionally	Contains information about a promotional sale or sales. If you did not specify a PromotionalSaleID in the request, then all promotional sales for the seller are returned. Promotional sales enable sellers to add discounts and/or free shipping to items.
PromotionalSaleDetails .PromotionalSale	PromotionalSaleType	Conditionally, repeatable: [0..*]	Contains promotional sale information based on the request. If you did not specify a PromotionalSaleID in the request, then all promotional sales for the seller are returned.
PromotionalSaleDetails .PromotionalSale.DiscountType	DiscountCodeType	Conditionally	Type of a promotional sale discount for items (for example, percentage). Applies to price discount sales only. Applicable values: • CustomCode (in/out) Future use • Percentage (in/out) Specifies discount type as percentage. • Price (in/out) Specifies discount type as a fixed amount. Discount will be in the currency of the original listing.
PromotionalSaleDetails .PromotionalSale.DiscountValue	double	Conditionally	Value of a promotional sale discount for items, a percentage discount or a fixed amount reduction. Percentage discounts must be at least 5% and cannot exceed 75% of the original listing price. Fixed amount discounts will be in the currency of the original listing. Applies to price discount sales only.
PromotionalSaleDetails .PromotionalSale .PromotionalSaleEndTime	dateTime	Conditionally	End date of a promotional sale discount for items. Maximum listing durations vary by site from 14 days to 45 days. The minimum promotional sale duration is 1 day for most sites, but 3 days on some sites.
PromotionalSaleDetails .PromotionalSale .PromotionalSaleID	long	Conditionally	Unique ID of a promotional sale (discount and/or free shipping) for items. This field is an input field only for the SetPromotionalSale call and only if you are not adding a new promotional sale.
PromotionalSaleDetails .PromotionalSale .PromotionalSaleItemIDArray	ItemIDArrayType	Conditionally	Items covered by a promotional sale.
PromotionalSaleDetails .PromotionalSale .PromotionalSaleItemIDArray .ItemID	ItemIDType (string)	Conditionally, repeatable: [0..*]	A unique identifier for an item listing. For SetPromotionalSaleListings, the seller passes in the ItemID value for each listing that he/she wishes to become part of the Promotional Sale identified by the PromotionalSaleID value. For GetPromotionalSaleDetails, each listing returned in the response is a part of the Promotional Sale identified by the PromotionalSaleID value.
PromotionalSaleDetails .PromotionalSale .PromotionalSaleName	string	Conditionally	Name of a promotional sale for items.
PromotionalSaleDetails .PromotionalSale .PromotionalSaleStartTime	dateTime	Conditionally	Start date of a promotional sale for items. Promotional sales can start immediately or be scheduled to start at a later date. Some sites require items to have been listed for a specific duration before they can be added to a promotional sale (for example, on the US site, items must have been listed for a day before they can be added to a promotional sale).
PromotionalSaleDetails .PromotionalSale .PromotionalSaleType	PromotionalSaleTypeCodeType	Conditionally	Type of promotional sale: price discount, free shipping, or both. Applicable values: • CustomCode (in/out) Reserved for internal or future use. • FreeShippingOnly (in/out) Sale offers free shipping only. • PriceDiscountAndFreeShipping (in/out) Sale offers both price discount and free shipping. • PriceDiscountOnly (in/out) Sale offers price discount only.
PromotionalSaleDetails .PromotionalSale.Status	PromotionalSaleStatusCodeType	Conditionally	Status of a promotional sale for items. Applicable values: • Active (in/out) The promotional sale is active. • CustomCode (in/out) Reserved for internal or future use. • Deleted (in/out) The promotional sale has been deleted. Deleted promotional sales cannot be updated or reactivated. • Inactive (in/out) The promotional sale is inactive, the sale has ended. You can reschedule a sale once it has ended, but you will need to wait at least 24 hours before it can become active. • Processing (in/out) The status of the promotional sale is pending. When first scheduling a Sale, if you select over 200 listings to be in any given Sale, it will take some time for eBay to process the request. • Scheduled (in/out) The promotional sale is scheduled. That is, the start time is in the future.

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.

GetPromotionalSaleDetails Detail Controls

Detail Control: DetailLevel

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

GetPromotionalSaleDetails 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

Gets seller's promotional sales with the specified status values.

Description

User magicalbookseller has defined multiple promotional sales over time. For planning purposes, she wants to review only those sales that are active, pending, or scheduled. That is, she's not interested in deleted or ended/inactive sales.

Input

The PromotionalSaleStatus fields specify the status values her promotional sales must match to be returned.

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

<?xml version="1.0" encoding="utf-8"?>
<GetPromotionalSaleDetailsRequest xmlns="urn:ebay:apis:eBLBaseComponents">
   <RequesterCredentials>
      <eBayAuthToken>ABC...123</eBayAuthToken>
   </RequesterCredentials>
   <ErrorLanguage>en_US</ErrorLanguage>
  <Version>653</Version>
  <WarningLevel>High</WarningLevel>
  <PromotionalSaleStatus>Active</PromotionalSaleStatus>
  <PromotionalSaleStatus>Scheduled</PromotionalSaleStatus>
  <PromotionalSaleStatus>Processing</PromotionalSaleStatus>
</GetPromotionalSaleDetailsRequest>

Output

The Status field indicates that status of a given promotional sale. The PromotionalSaleID field is reqquired to edit the promotional sale with either SetPromotionalSale or SetPromotionalSaleListing.

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

<GetPromotionalSaleDetailsResponse xmlns="urn:ebay:apis:eBLBaseComponents">
   <Timestamp>2010-01-22T00:08:02.122Z</Timestamp>
   <Ack>Success</Ack>
   <Version>653</Version>
   <Build>E653_CORE_BUNDLED_10507929_R1</Build>
   <PromotionalSaleDetails>
      <PromotionalSale>
         <PromotionalSaleID>6001618015</PromotionalSaleID>
         <PromotionalSaleName>Valentine's Day Sale</PromotionalSaleName>
         <PromotionalSaleItemIDArray>
            <ItemID>230000912912</ItemID>
         </PromotionalSaleItemIDArray>
         <Status>Scheduled</Status>
         <DiscountType>Percentage</DiscountType>
         <DiscountValue>10.0</DiscountValue>
         <PromotionalSaleStartTime>2010-02-01T00:00:00.000Z</PromotionalSaleStartTime>
         <PromotionalSaleEndTime>2010-02-14T11:59:00.000Z</PromotionalSaleEndTime>
         <PromotionalSaleType>PriceDiscountOnly</PromotionalSaleType>
      </PromotionalSale>
      <PromotionalSale>
         <PromotionalSaleID>6001619015</PromotionalSaleID>
         <PromotionalSaleName>Free Shipping</PromotionalSaleName>
         <PromotionalSaleItemIDArray>
            <ItemID>230001339257</ItemID>
         </PromotionalSaleItemIDArray>
         <Status>Scheduled</Status>
         <PromotionalSaleStartTime>2010-01-25T00:00:00.000Z</PromotionalSaleStartTime>
         <PromotionalSaleEndTime>2010-01-31T11:59:00.000Z</PromotionalSaleEndTime>
         <PromotionalSaleType>FreeShippingOnly</PromotionalSaleType>
      </PromotionalSale>
      <PromotionalSale>
         <PromotionalSaleID>6001691015</PromotionalSaleID>
         <PromotionalSaleName>Winter Clearance</PromotionalSaleName>
         <PromotionalSaleItemIDArray>
            <ItemID>230000957369</ItemID>
         </PromotionalSaleItemIDArray>
         <Status>Active</Status>
         <DiscountType>Price</DiscountType>
         <DiscountValue>5.0</DiscountValue>
         <PromotionalSaleStartTime>2010-01-21T23:15:00.000Z</PromotionalSaleStartTime>
         <PromotionalSaleEndTime>2010-01-24T11:59:00.000Z</PromotionalSaleEndTime>
         <PromotionalSaleType>PriceDiscountOnly</PromotionalSaleType>
      </PromotionalSale>
   </PromotionalSaleDetails>
</GetPromotionalSaleDetailsResponse>

GetPromotionalSaleDetails Change History

Version	Description
653 2010-01-20	PromotionalSaleStatus (added): Specifies which promotional sales to retrieve, based upon status. Can be repeated to retrieve promotional sales for multiple status values.
555 2008-03-05	PromotionalSaleType.PromotionalSaleType, PromotionalSaleTypeCodeType (added): Indicates the type of promotional sale being offered: price discount only, free shipping only (new), and price discount and free shipping (new).
497 2007-01-24	(added) New call.

User-Contributed Notes

eBay Trading API Call Reference Version 823