eBay Trading APIVersion 1039

SetPromotionalSale

Use this call to create or modify a promotional sale. SetPromotionalSale is part of the Promotional Price Display feature, which enables sellers to apply discounts and/or free shipping across many listings.

Promotional sales apply to regular fixed-price format, auction, and auction/BIN formats. Auction and auction/BIN format listings can be added to free shipping sales only. To use this call, you must be a registered eBay store owner.

You can test this call in the Sandbox, as follows:

  1. Create a Sandbox user and set up an eBay store for the user.
  2. Add several fixed-price items to the store using AddItem.
  3. Call SetPromotionalSale to set up a sale.
  4. Check the Sandbox UI to see your sale.
  5. Use GetPromotionalSaleDetails to see the sale details.
Creating a sale does not automatically apply it to your listings. You will need to use the SetPromotionalSaleListings call to associate the sale with your listings.

See Putting Store Items on Sale.

See also the reference documentation for these calls:



Input

See also Samples.

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 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"?>
<SetPromotionalSaleRequest xmlns="urn:ebay:apis:eBLBaseComponents">
  <!-- Call-specific Input Fields -->
  <Action> ModifyActionCodeType </Action>
  <PromotionalSaleDetails> PromotionalSaleType
    <DiscountType> DiscountCodeType </DiscountType>
    <DiscountValue> double </DiscountValue>
    <PromotionalSaleEndTime> dateTime </PromotionalSaleEndTime>
    <PromotionalSaleID> long </PromotionalSaleID>
    <PromotionalSaleName> string </PromotionalSaleName>
    <PromotionalSaleStartTime> dateTime </PromotionalSaleStartTime>
    <PromotionalSaleType> PromotionalSaleTypeCodeType </PromotionalSaleType>
  </PromotionalSaleDetails>
  <!-- Standard Input Fields -->
  <ErrorLanguage> string </ErrorLanguage>
  <MessageID> string </MessageID>
  <Version> string </Version>
  <WarningLevel> WarningLevelCodeType </WarningLevel>
</SetPromotionalSaleRequest>
Argument Type Occurrence Meaning
Call-specific Input Fields [Jump to standard fields]
Action ModifyActionCodeType Required The seller must include this field and set it to 'Add' to create a new promotional sale, or set it to 'Update' to modify an existing promotional sale, or set it to 'Delete' to delete a promotional sale.

Applicable values:

Add
(in) For SetPromotionalSale, this value is used in the request to create a new promotional sale.

For SetPromotionalSaleListings, this value is used in the request to apply an existing promotional sale to one or more active items or to an entire category of active items.

For SetShippingDiscountProfiles, this value is used in the request to create a new shipping discount profile.
CustomCode
(in) Reserved for future use.
Delete
(in) For SetPromotionalSale, this value is used in the request to delete an existing promotional sale.

For SetPromotionalSaleListings, this value is used in the request to remove one or more active items from an existing promotional sale. This value cannot be used if a CategoryID is specified in the request.

For SetShippingDiscountProfiles, this value is used in the request to delete an existing shipping discount profile.
Update
(in) For SetPromotionalSale, this value is used in the request to modify an existing promotional sale.

For SetShippingDiscountProfiles, this value is used in the request to modify an existing shipping discount profile.
PromotionalSaleDetails PromotionalSaleType Required This container must be included in each SetPromotionalSale call. The fields of this container that will be used will depend on whether the seller is adding a new promotional sale, updating an existing promotional sale, or deleting an existing promotional sale.
PromotionalSaleDetails
  .DiscountType
DiscountCodeType Conditional Type of a promotional sale discount for items (for example, percentage). Applies to price discount sales only.

Applicable values:

CustomCode
(in/out) This value is reserved for future use.
Percentage
(in/out) The enumeration value indicates that the discount being offered is a percentage discount, which means a percentage of the total price to the buyer is being discounted. So, if the total price for an order line item is $100, the DiscountType is Percentage, and the DiscountValue is 15.0 (percent), the buyer will pay just $85.00 for the order line item.
Price
(in/out) The enumeration value indicates that the discount being offered is a price discount, which means the total price to the buyer is being reduced by this amount. So, if the total price for an order line item is $100, the DiscountType is Price, and the DiscountValue is 20.0 (dollars), the buyer will pay just $80.00 for the order line item.
PromotionalSaleDetails
  .DiscountValue
double Conditional 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
  .PromotionalSaleEndTime
dateTime Conditional 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
  .PromotionalSaleID
long Conditional 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
  .PromotionalSaleName
string Conditional Name of a promotional sale for items.
PromotionalSaleDetails
  .PromotionalSaleStartTime
dateTime Conditional 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
  .PromotionalSaleType
PromotionalSaleTypeCodeType Conditional 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.
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
en_AU Australia
de_AT Austria
nl_BE Belgium (Dutch)
fr_BE Belgium (French)
en_CA Canada
fr_CA Canada (French)
zh_CN China
fr_FR France
de_DE Germany
zh_HK Hong Kong
en_IN India
en_IE Ireland
it_IT Italy
nl_NL Netherlands
en_SG Singapore
es_ES Spain
de_CH Switzerland
en_GB United Kingdom
en_US United States

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., 859). 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 performed in the Production environment.

Applicable values:

High
(in) The WarningLevel value is set to High if the user wishes to receive warnings when the application passes unrecognized or deprecated elements in an API call request. Setting the WarningLevel value to High is not recommended in a production environment. Instead, it should only be used during the development/debugging stage.
Low
(in) The WarningLevel value is set to Low if the user does not wish to receive warnings when the application passes unrecognized or deprecated elements in an API call request. This is the default value if WarningLevel is not specified in the call request.

See Warning Level.



Output

See also Samples.

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 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"?>
<SetPromotionalSaleResponse xmlns="urn:ebay:apis:eBLBaseComponents">
  <!-- Call-specific Output Fields -->
  <PromotionalSaleID> long </PromotionalSaleID>
  <Status> PromotionalSaleStatusCodeType </Status>
  <!-- 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>
</SetPromotionalSaleResponse>
Return Value Type Occurrence Meaning
Call-specific Output Fields [Jump to standard fields]
PromotionalSaleID long Always The unique identifier of the new promotional sale, or in the case of a delete or modify action, the unique identifier of the existing promotional sale that was deleted or modified.
Status PromotionalSaleStatusCodeType Always The enumeration value in this field indicates the status of the promotional sale action (add or delete). See PromotionalSaleStatusCodeType for more information on status values.

Applicable values: See Status.
Code so that your app gracefully handles any future changes to this list.
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 the Ack field.

Applicable values:

CustomCode
(out) Reserved for internal or future use.
Failure
(out) This value indicates that the call request processing failed.
Success
(out) This value indicates that the call request was processed successfully without any issues.
Warning
(out) This value indicates that the call request was successful, but processing was not without any issues. These issues can be checked in the Errors container, that will also be returned when one or more known issues occur with the call request.

(Not all values in AckCodeType apply to this field.)

Code so that your app gracefully handles any future changes to this list.
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.

Code so that your app gracefully handles any future changes to this list.
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 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.Value string Conditionally This is the value of the request parameter noted in the ParamID attribute. So, if the ParamID value was ItemID, the value in this field would be the actual value of that ItemID.
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) The request that triggered the error was not processed successfully. When a serious application-level error occurs, the error is returned instead of the business data.

If the source of the problem is within the application (such as a missing required element), change the application before you retry the request.
  • If the problem is due to end-user input data, please alert the end-user to the problem and provide the means for them to correct the data. Once the problem in the application or data is resolved, you can attempt to re-send the request to eBay.
  • If the source of the problem is on eBay's side, 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.


See the Compatible Application Check section of the eBay Features Guide for more information.
Warning
(out) The request was processed successfully, but something occurred that may affect your application or the user. For example, eBay may have changed a value the user sent in. In this case, eBay returns a normal, successful response and also returns the warning.

When a warning occurs, the error is returned in addition to the business data. In this case, you do not need to retry the request (as the original request was successful). However, depending on the cause or nature of the warning, you might need to contact either the end user or eBay to effect a long term solution to the problem to prevent it from reoccurring in the future.

Code so that your app gracefully handles any future changes to this list.
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 the Time Values section in the eBay Features 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 the Standard Data for All Calls section in the eBay Features Guide for information on using the response version when troubleshooting CustomCode values that appear in the response.



Detail Controls


DetailLevel

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



Samples

New to making API calls? Please see Making a Call.

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

Creates a Promotional Sale for a specific time duration.

Description

Magical Bookseller wants to set set up a New Years sale for her customers, so she sets a sale to that takes 10% off the price of all her fixed-price items. The sale extends for roughly five days.

Input

XML format.

<?xml version="1.0" encoding="utf-8"?>
<SetPromotionalSaleRequest xmlns="urn:ebay:apis:eBLBaseComponents">
  <RequesterCredentials>
    <eBayAuthToken>ABC...123</eBayAuthToken>
  </RequesterCredentials>
  <WarningLevel>High</WarningLevel>
  <Action>Add</Action>
  <PromotionalSaleDetails>
    <PromotionalSaleName>MyBigNYSale</PromotionalSaleName>
    <DiscountType>Price</DiscountType>
    <DiscountValue>10</DiscountValue>
    <PromotionalSaleType>PriceDiscountOnly</PromotionalSaleType>
    <PromotionalSaleStartTime>2016-02-05T10:00:00.000Z</PromotionalSaleStartTime>
    <PromotionalSaleEndTime>2016-02-10T00:15:00.000Z</PromotionalSaleEndTime>
  </PromotionalSaleDetails>
</SetPromotionalSaleRequest>

Output

XML format.
<SetPromotionalSaleResponse xmlns="urn:ebay:apis:eBLBaseComponents">
  <Timestamp>2016-02-04T20:36:33.176Z</Timestamp>
  <Ack>Success</Ack>
  <Version>967</Version>
  <Build>E967_CORE_BUNDLED_10549562_R1</Build>
  <Status>Scheduled</Status>
  <PromotionalSaleID>5500230001</PromotionalSaleID>
</SetPromotionalSaleResponse>



Change History

Change Date Description
555
2008-03-05
  • PromotionalSaleType.PromotionalSaleType, PromotionalSaleTypeCodeType (added): Allows store owners to offer the following types of promotional sales: price discount only, free shipping only (new), and price discount and free shipping (new).
497
2007-01-24
  • (added) New call.