eBay Trading APIVersion 1039

SetSellingManagerTemplateAutomationRule

Revises, or adds to, the Selling Manager automation rules associated with a specific template. A Selling Manager automation rule is a rule for automatically listing items. Examples of automation rules include, but are not limited to, keeping a fixed number of listing active, relisting items continuously, and listing according to a schedule. To use this call, you must be a Selling Manager Pro subscriber.

Whether or not a seller has existing rules, you can add rules with SetSellingManagerTemplateAutomationRule. To determine if a new customer has any existing rules, use GetSellingManagerTemplateAutomationRule.

To delete rules and then add rules, use DeleteSellingManagerTemplateAutomationRule, then SetSellingManagerTemplateAutomationRule.

Before testing SetSellingManagerTemplateAutomationRule, obtain a SaleTemplateID (that is, a Selling Manager template ID) by calling GetSellingManagerInventory or AddSellingManagerTemplate. Use the SaleTemplateID from that call's response as input for your SetSellingManagerTemplateAutomationRule call.

Note: This call is subject to change without notice; the deprecation process is inapplicable to this call.

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:



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"?>
<SetSellingManagerTemplateAutomationRuleRequest xmlns="urn:ebay:apis:eBLBaseComponents">
  <!-- Call-specific Input Fields -->
  <AutomatedListingRule> SellingManagerAutoListType
    <KeepMinActive> SellingManagerAutoListMinActiveItemsType
      <ListingHoldInventoryLevel> int </ListingHoldInventoryLevel>
      <ListTimeFrom> time </ListTimeFrom>
      <ListTimeTo> time </ListTimeTo>
      <MinActiveItemCount> int </MinActiveItemCount>
      <SpacingIntervalInMinutes> int </SpacingIntervalInMinutes>
    </KeepMinActive>
    <ListAccordingToSchedule> SellingManagerAutoListAccordingToScheduleType
      <DayOfWeek> DayOfWeekCodeType </DayOfWeek>
      <!-- ... more DayOfWeek values allowed here ... -->
      <EndTime> dateTime </EndTime>
      <ListAtSpecificTimeOfDay> time </ListAtSpecificTimeOfDay>
      <ListingHoldInventoryLevel> int </ListingHoldInventoryLevel>
      <ListingPeriodInWeeks> int </ListingPeriodInWeeks>
      <MaxActiveItemCount> int </MaxActiveItemCount>
      <StartTime> dateTime </StartTime>
    </ListAccordingToSchedule>
    <SourceSaleTemplateID> long </SourceSaleTemplateID>
  </AutomatedListingRule>
  <AutomatedRelistingRule> SellingManagerAutoRelistType
    <BestOfferDetails> BestOfferDetailsType
      <BestOfferEnabled> boolean </BestOfferEnabled>
    </BestOfferDetails>
    <ListingHoldInventoryLevel> int </ListingHoldInventoryLevel>
    <RelistAfterDays> int </RelistAfterDays>
    <RelistAfterHours> int </RelistAfterHours>
    <RelistCondition> SellingManagerAutoRelistOptionCodeType </RelistCondition>
    <Type> SellingManagerAutoRelistTypeCodeType </Type>
  </AutomatedRelistingRule>
  <AutomatedSecondChanceOfferRule> SellingManagerAutoSecondChanceOfferType
    <Amount> AmountType (double) </Amount>
    <Duration> SecondChanceOfferDurationCodeType </Duration>
    <ListingHoldInventoryLevel> int </ListingHoldInventoryLevel>
    <ProfitPercent> float </ProfitPercent>
    <SecondChanceOfferCondition> SellingManagerAutoSecondChanceOfferTypeCodeType </SecondChanceOfferCondition>
  </AutomatedSecondChanceOfferRule>
  <SaleTemplateID> long </SaleTemplateID>
  <!-- Standard Input Fields -->
  <ErrorLanguage> string </ErrorLanguage>
  <MessageID> string </MessageID>
  <Version> string </Version>
  <WarningLevel> WarningLevelCodeType </WarningLevel>
</SetSellingManagerTemplateAutomationRuleRequest>
Argument Type Occurrence Meaning
Call-specific Input Fields [Jump to standard fields]
AutomatedListingRule SellingManagerAutoListType Optional The information for the automated listing rule to be associated with the template.
AutomatedListingRule
  .KeepMinActive
SellingManagerAutoListMinActiveItemsType Optional Specifies an automated listing rule that keeps a minimum number of listings on the site.
AutomatedListingRule
  .KeepMinActive
  .ListingHoldInventoryLevel
int Optional Sets a minimum inventory level for listings of associated products to occur.
AutomatedListingRule
  .KeepMinActive.ListTimeFrom
time Optional The start time of the time interval during which new listings should start.
AutomatedListingRule
  .KeepMinActive.ListTimeTo
time Optional The end time of the time interval during which new listings should start.
AutomatedListingRule
  .KeepMinActive
  .MinActiveItemCount
int Optional The minimum number of listings that should be active on the site.
AutomatedListingRule
  .KeepMinActive
  .SpacingIntervalInMinutes
int Optional Provides a number of minutes for spacing start times of listings. Used when you list multiple items at the same time. Delays subsequent listings by the specified number of minutes.
AutomatedListingRule
  .ListAccordingToSchedule
SellingManagerAutoListAccordingToScheduleType Optional Specifies an automated listing rule that lists items according to a specified schedule.
AutomatedListingRule
  .ListAccordingToSchedule
  .DayOfWeek
DayOfWeekCodeType Optional,
repeatable: [0..*]
The day of the week on which items should be listed.

Applicable values: See DayOfWeek.
AutomatedListingRule
  .ListAccordingToSchedule
  .EndTime
dateTime Optional The date after which the rule is disabled.
AutomatedListingRule
  .ListAccordingToSchedule
  .ListAtSpecificTimeOfDay
time Optional The time at which items should be listed.
AutomatedListingRule
  .ListAccordingToSchedule
  .ListingHoldInventoryLevel
int Optional Sets a minimum inventory level for listings of associated products to occur.
AutomatedListingRule
  .ListAccordingToSchedule
  .ListingPeriodInWeeks
int Optional The number of weeks between rule executions.
AutomatedListingRule
  .ListAccordingToSchedule
  .MaxActiveItemCount
int Optional The number of current, listed items required for the rule to no longer be run.
AutomatedListingRule
  .ListAccordingToSchedule
  .StartTime
dateTime Optional The date from which the rule is active.
AutomatedListingRule
  .SourceSaleTemplateID
long Optional The source template ID for the rule that was retrieved. In the case of automated listing rules retrieved for an item, even if the item does not have an associated automation rule, an automated listing rule is inherited from the source template.
AutomatedRelistingRule SellingManagerAutoRelistType Optional The information for the automated relisting rule to be associated with the template.
AutomatedRelistingRule
  .BestOfferDetails
BestOfferDetailsType Optional Specifies whether Best Offer should be enabled on the auto-relisted item.
AutomatedRelistingRule
  .BestOfferDetails
  .BestOfferEnabled
boolean Optional This field indicates whether or not the Best Offer feature is enabled for the listing. A seller can enable the Best Offer feature for a fixed-price or classified ad listing as long as the category supports the Best Offer feature. To see if an eBay category supports the Best Offer feature, run a GetCategoryFeatures call, including BestOfferEnabled as a FeatureID value in the call request payload.

A listing enabled with the Best Offer feature allows a buyer to bargain with the seller and make a lower-priced offer than the fixed price. The seller can then decide whether to accept the buyer's Best Offer price or propose a counter offer higher than the Best Offer price, but lower than the fixed price.

For a ReviseItem or ReviseFixedPriceItem call, this boolean value can only be changed (enable or disable) in a fixed-price listing if the listing has not had any sales (Best Offer or standard purchase), the listing does not have any Best Offer or counter offers pending, and the listing is not scheduled to end within 12 hours. Some large merchant accounts are enabled to revise this field through a Revise call even within 12 hours of the listing's scheduled end time, but these sellers are still subject to the other two rules - no sales of any kind for the listing, and no Best Offers or counter offers pending.

Note: Historically, the Best Offer feature has not been available for auction listings, but beginning with Version 1027, sellers in the US, UK, and DE sites will be able to offer the Best Offer feature in auction listings. The seller can offer Buy It Now or Best Offer in an auction listing, but not both features.
AutomatedRelistingRule
  .ListingHoldInventoryLevel
int Optional Specifies that item is not listed if inventory levels on the associated product are at or below the specified level.
AutomatedRelistingRule
  .RelistAfterDays
int Optional Used when RelistCondition equals RelistAfterDaysHours; specifies the number days after the item ends that it should be relisted.
AutomatedRelistingRule
  .RelistAfterHours
int Optional Used when RelistCondition equals RelistAfterDaysHours; specifies the number hours after the item ends that it should be relisted.
AutomatedRelistingRule
  .RelistCondition
SellingManagerAutoRelistOptionCodeType Optional The condition under which relist occurs.

Applicable values:

CustomCode
(in/out) Reserved for internal or future use.
RelistAfterDaysHours
(in/out) If this value is set, the item is relisted after a specified number of days and/or hours. If this value is set, the RelistAfterDays and/or the RelistAfterHours fields must also be set.
RelistAtSpecificTimeOfDay
(in/out) If this value is set, the item is relisted at a specific time of day, either the day when the listing ends (if the specified time has not passed), or the day after (if the specified time has already passed on that day). If this value is set, the RelistAtSpecificTimeOfDay field must also be set.
RelistImmediately
(in/out) If this value is set, the item is relisted immediately after the original listing ends.
AutomatedRelistingRule.Type SellingManagerAutoRelistTypeCodeType Optional The type of auto-relist rule for the item.

Applicable values:

CustomCode
(in/out) Reserved for internal or future use.
RelistContinuously
(in/out) Relist the item continuously.
RelistContinuouslyUntilSold
(in/out) Relist the item continuously, until it is sold.
RelistOnceIfNotSold
(in/out) If the item is unsold, relist the item once.
AutomatedSecondChanceOfferRule SellingManagerAutoSecondChanceOfferType Optional The information for the automated Second Chance Offer rule to be associated with the template.
AutomatedSecondChanceOfferRule
  .Amount
AmountType (double) Optional Used when SecondChanceOfferCondition is equal to BidsGreaterThanAmount or BidsGreaterThanCostPlusAmount. Specifies the amount associated with the SecondChanceOfferCondition.
AutomatedSecondChanceOfferRule
  .Duration
SecondChanceOfferDurationCodeType Optional Specifies the length of time the Second Chance Offer listing will be active. The recipient bidder has that much time to purchase the item or the offer expires.

Applicable values:

CustomCode
(in/out) This value is reserved for internal or future use.
Days_1
(in/out) The seller specifies this value to make the Second Chance offer available to the bidder for one day. This value will affect the EndTime value returned in the AddSecondChanceItem or AddTransactionConfirmationItem responses.
Days_3
(in/out) The seller specifies this value to make the Second Chance offer available to the bidder for three days. This value will affect the EndTime value returned in the AddSecondChanceItem or AddTransactionConfirmationItem responses.
Days_5
(in/out) The seller specifies this value to make the Second Chance offer available to the bidder for five days. This value will affect the AddSecondChanceItem or AddTransactionConfirmationItem responses.
Days_7
(in/out) The seller specifies this value to make the Second Chance offer available to the bidder for seven days. This value will affect the EndTime value returned in the AddSecondChanceItem or AddTransactionConfirmationItem responses.
AutomatedSecondChanceOfferRule
  .ListingHoldInventoryLevel
int Optional Do not list if inventory levels on the associated product are at or below the specified amount.
AutomatedSecondChanceOfferRule
  .ProfitPercent
float Optional Used when SecondChanceOfferCondition is equal to BidsGreaterThanCostPlusPercentage to specify the amount of profit associated with the SecondChanceOfferCondition.
AutomatedSecondChanceOfferRule
  .SecondChanceOfferCondition
SellingManagerAutoSecondChanceOfferTypeCodeType Optional The condition under which a Second Chance Offer should be sent.

Applicable values:

BidsGreaterThanAmount
(in/out) Sends a Second Chance Offer to all bidders who bid more than a specific amount.
BidsGreaterThanCostPlusAmount
(in/out) Sends a Second Chance Offer to all bidders who bid more than the cost plus a specific amount.
BidsGreaterThanCostPlusPercentage
(in/out) Sends a Second Chance Offer to all bidders who bid more than the cost plus a specific percentage.
CustomCode
(in/out) Reserved for internal or future use.
SaleTemplateID long Required The ID of the Selling Manager template whose automation rules you want to change. You can obtain a SaleTemplateID by calling GetSellingManagerInventory.
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"?>
<SetSellingManagerTemplateAutomationRuleResponse xmlns="urn:ebay:apis:eBLBaseComponents">
  <!-- Call-specific Output Fields -->
  <AutomatedListingRule> SellingManagerAutoListType
    <KeepMinActive> SellingManagerAutoListMinActiveItemsType
      <ListingHoldInventoryLevel> int </ListingHoldInventoryLevel>
      <ListTimeFrom> time </ListTimeFrom>
      <ListTimeTo> time </ListTimeTo>
      <MinActiveItemCount> int </MinActiveItemCount>
      <SpacingIntervalInMinutes> int </SpacingIntervalInMinutes>
    </KeepMinActive>
    <ListAccordingToSchedule> SellingManagerAutoListAccordingToScheduleType
      <DayOfWeek> DayOfWeekCodeType </DayOfWeek>
      <!-- ... more DayOfWeek values allowed here ... -->
      <EndTime> dateTime </EndTime>
      <ListAtSpecificTimeOfDay> time </ListAtSpecificTimeOfDay>
      <ListingHoldInventoryLevel> int </ListingHoldInventoryLevel>
      <ListingPeriodInWeeks> int </ListingPeriodInWeeks>
      <MaxActiveItemCount> int </MaxActiveItemCount>
      <StartTime> dateTime </StartTime>
    </ListAccordingToSchedule>
    <SourceSaleTemplateID> long </SourceSaleTemplateID>
  </AutomatedListingRule>
  <AutomatedRelistingRule> SellingManagerAutoRelistType
    <BestOfferDetails> BestOfferDetailsType
      <BestOfferEnabled> boolean </BestOfferEnabled>
    </BestOfferDetails>
    <ListingHoldInventoryLevel> int </ListingHoldInventoryLevel>
    <RelistAfterDays> int </RelistAfterDays>
    <RelistAfterHours> int </RelistAfterHours>
    <RelistAtSpecificTimeOfDay> time </RelistAtSpecificTimeOfDay>
    <RelistCondition> SellingManagerAutoRelistOptionCodeType </RelistCondition>
    <Type> SellingManagerAutoRelistTypeCodeType </Type>
  </AutomatedRelistingRule>
  <AutomatedSecondChanceOfferRule> SellingManagerAutoSecondChanceOfferType
    <Amount currencyID="CurrencyCodeType"> AmountType (double) </Amount>
    <Duration> SecondChanceOfferDurationCodeType </Duration>
    <ListingHoldInventoryLevel> int </ListingHoldInventoryLevel>
    <ProfitPercent> float </ProfitPercent>
    <SecondChanceOfferCondition> SellingManagerAutoSecondChanceOfferTypeCodeType </SecondChanceOfferCondition>
  </AutomatedSecondChanceOfferRule>
  <Fees> FeesType
    <Fee> FeeType
      <Fee currencyID="CurrencyCodeType"> AmountType (double) </Fee>
      <Name> string </Name>
      <PromotionalDiscount currencyID="CurrencyCodeType"> AmountType (double) </PromotionalDiscount>
    </Fee>
    <!-- ... more Fee nodes allowed here ... -->
  </Fees>
  <!-- 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>
</SetSellingManagerTemplateAutomationRuleResponse>
Return Value Type Occurrence Meaning
Call-specific Output Fields [Jump to standard fields]
AutomatedListingRule SellingManagerAutoListType Conditionally Contains the automated listing rule associated with this template.
AutomatedListingRule
  .KeepMinActive
SellingManagerAutoListMinActiveItemsType Conditionally Specifies an automated listing rule that keeps a minimum number of listings on the site.
AutomatedListingRule
  .KeepMinActive
  .ListingHoldInventoryLevel
int Conditionally Sets a minimum inventory level for listings of associated products to occur.
AutomatedListingRule
  .KeepMinActive.ListTimeFrom
time Conditionally The start time of the time interval during which new listings should start.
AutomatedListingRule
  .KeepMinActive.ListTimeTo
time Conditionally The end time of the time interval during which new listings should start.
AutomatedListingRule
  .KeepMinActive
  .MinActiveItemCount
int Conditionally The minimum number of listings that should be active on the site.
AutomatedListingRule
  .KeepMinActive
  .SpacingIntervalInMinutes
int Conditionally Provides a number of minutes for spacing start times of listings. Used when you list multiple items at the same time. Delays subsequent listings by the specified number of minutes.
AutomatedListingRule
  .ListAccordingToSchedule
SellingManagerAutoListAccordingToScheduleType Conditionally Specifies an automated listing rule that lists items according to a specified schedule.
AutomatedListingRule
  .ListAccordingToSchedule
  .DayOfWeek
DayOfWeekCodeType Conditionally,
repeatable: [0..*]
The day of the week on which items should be listed.

Applicable values: See DayOfWeek.
Code so that your app gracefully handles any future changes to this list.
AutomatedListingRule
  .ListAccordingToSchedule
  .EndTime
dateTime Conditionally The date after which the rule is disabled.
AutomatedListingRule
  .ListAccordingToSchedule
  .ListAtSpecificTimeOfDay
time Conditionally The time at which items should be listed.
AutomatedListingRule
  .ListAccordingToSchedule
  .ListingHoldInventoryLevel
int Conditionally Sets a minimum inventory level for listings of associated products to occur.
AutomatedListingRule
  .ListAccordingToSchedule
  .ListingPeriodInWeeks
int Conditionally The number of weeks between rule executions.
AutomatedListingRule
  .ListAccordingToSchedule
  .MaxActiveItemCount
int Conditionally The number of current, listed items required for the rule to no longer be run.
AutomatedListingRule
  .ListAccordingToSchedule
  .StartTime
dateTime Conditionally The date from which the rule is active.
AutomatedListingRule
  .SourceSaleTemplateID
long Conditionally The source template ID for the rule that was retrieved. In the case of automated listing rules retrieved for an item, even if the item does not have an associated automation rule, an automated listing rule is inherited from the source template.
AutomatedRelistingRule SellingManagerAutoRelistType Conditionally Contains the automated relisting rule associated with this template.
AutomatedRelistingRule
  .BestOfferDetails
BestOfferDetailsType Conditionally Specifies whether Best Offer should be enabled on the auto-relisted item.
AutomatedRelistingRule
  .BestOfferDetails
  .BestOfferEnabled
boolean Conditionally This field indicates whether or not the Best Offer feature is enabled for the listing. A seller can enable the Best Offer feature for a fixed-price or classified ad listing as long as the category supports the Best Offer feature. To see if an eBay category supports the Best Offer feature, run a GetCategoryFeatures call, including BestOfferEnabled as a FeatureID value in the call request payload.

A listing enabled with the Best Offer feature allows a buyer to bargain with the seller and make a lower-priced offer than the fixed price. The seller can then decide whether to accept the buyer's Best Offer price or propose a counter offer higher than the Best Offer price, but lower than the fixed price.

For a ReviseItem or ReviseFixedPriceItem call, this boolean value can only be changed (enable or disable) in a fixed-price listing if the listing has not had any sales (Best Offer or standard purchase), the listing does not have any Best Offer or counter offers pending, and the listing is not scheduled to end within 12 hours. Some large merchant accounts are enabled to revise this field through a Revise call even within 12 hours of the listing's scheduled end time, but these sellers are still subject to the other two rules - no sales of any kind for the listing, and no Best Offers or counter offers pending.

Note: Historically, the Best Offer feature has not been available for auction listings, but beginning with Version 1027, sellers in the US, UK, and DE sites will be able to offer the Best Offer feature in auction listings. The seller can offer Buy It Now or Best Offer in an auction listing, but not both features.
AutomatedRelistingRule
  .ListingHoldInventoryLevel
int Conditionally Specifies that item is not listed if inventory levels on the associated product are at or below the specified level.
AutomatedRelistingRule
  .RelistAfterDays
int Conditionally Used when RelistCondition equals RelistAfterDaysHours; specifies the number days after the item ends that it should be relisted.
AutomatedRelistingRule
  .RelistAfterHours
int Conditionally Used when RelistCondition equals RelistAfterDaysHours; specifies the number hours after the item ends that it should be relisted.
AutomatedRelistingRule
  .RelistAtSpecificTimeOfDay
time Conditionally Used when RelistCondition equals RelistAtSpecificTimeOfDay; specifies the time of day the item should be relisted.
AutomatedRelistingRule
  .RelistCondition
SellingManagerAutoRelistOptionCodeType Conditionally The condition under which relist occurs.

Applicable values:

CustomCode
(in/out) Reserved for internal or future use.
RelistAfterDaysHours
(in/out) If this value is set, the item is relisted after a specified number of days and/or hours. If this value is set, the RelistAfterDays and/or the RelistAfterHours fields must also be set.
RelistAtSpecificTimeOfDay
(in/out) If this value is set, the item is relisted at a specific time of day, either the day when the listing ends (if the specified time has not passed), or the day after (if the specified time has already passed on that day). If this value is set, the RelistAtSpecificTimeOfDay field must also be set.
RelistImmediately
(in/out) If this value is set, the item is relisted immediately after the original listing ends.

Code so that your app gracefully handles any future changes to this list.
AutomatedRelistingRule.Type SellingManagerAutoRelistTypeCodeType Conditionally The type of auto-relist rule for the item.

Applicable values:

CustomCode
(in/out) Reserved for internal or future use.
RelistContinuously
(in/out) Relist the item continuously.
RelistContinuouslyUntilSold
(in/out) Relist the item continuously, until it is sold.
RelistOnceIfNotSold
(in/out) If the item is unsold, relist the item once.

Code so that your app gracefully handles any future changes to this list.
AutomatedSecondChanceOfferRule SellingManagerAutoSecondChanceOfferType Conditionally Contains the automated Second Chance Offer rule associated with this template.
AutomatedSecondChanceOfferRule
  .Amount
AmountType (double) Conditionally Used when SecondChanceOfferCondition is equal to BidsGreaterThanAmount or BidsGreaterThanCostPlusAmount. Specifies the amount associated with the SecondChanceOfferCondition.
AutomatedSecondChanceOfferRule
  .Amount
  [ attribute currencyID ]
CurrencyCodeType Conditionally Used when SecondChanceOfferCondition is equal to BidsGreaterThanAmount or BidsGreaterThanCostPlusAmount. Specifies the amount associated with the SecondChanceOfferCondition.

For a list of possible enumeration values, see CurrencyCodeType.
AutomatedSecondChanceOfferRule
  .Duration
SecondChanceOfferDurationCodeType Conditionally Specifies the length of time the Second Chance Offer listing will be active. The recipient bidder has that much time to purchase the item or the offer expires.

Applicable values:

CustomCode
(in/out) This value is reserved for internal or future use.
Days_1
(in/out) The seller specifies this value to make the Second Chance offer available to the bidder for one day. This value will affect the EndTime value returned in the AddSecondChanceItem or AddTransactionConfirmationItem responses.
Days_3
(in/out) The seller specifies this value to make the Second Chance offer available to the bidder for three days. This value will affect the EndTime value returned in the AddSecondChanceItem or AddTransactionConfirmationItem responses.
Days_5
(in/out) The seller specifies this value to make the Second Chance offer available to the bidder for five days. This value will affect the AddSecondChanceItem or AddTransactionConfirmationItem responses.
Days_7
(in/out) The seller specifies this value to make the Second Chance offer available to the bidder for seven days. This value will affect the EndTime value returned in the AddSecondChanceItem or AddTransactionConfirmationItem responses.

Code so that your app gracefully handles any future changes to this list.
AutomatedSecondChanceOfferRule
  .ListingHoldInventoryLevel
int Conditionally Do not list if inventory levels on the associated product are at or below the specified amount.
AutomatedSecondChanceOfferRule
  .ProfitPercent
float Conditionally Used when SecondChanceOfferCondition is equal to BidsGreaterThanCostPlusPercentage to specify the amount of profit associated with the SecondChanceOfferCondition.
AutomatedSecondChanceOfferRule
  .SecondChanceOfferCondition
SellingManagerAutoSecondChanceOfferTypeCodeType Conditionally The condition under which a Second Chance Offer should be sent.

Applicable values:

BidsGreaterThanAmount
(in/out) Sends a Second Chance Offer to all bidders who bid more than a specific amount.
BidsGreaterThanCostPlusAmount
(in/out) Sends a Second Chance Offer to all bidders who bid more than the cost plus a specific amount.
BidsGreaterThanCostPlusPercentage
(in/out) Sends a Second Chance Offer to all bidders who bid more than the cost plus a specific percentage.
CustomCode
(in/out) Reserved for internal or future use.

Code so that your app gracefully handles any future changes to this list.
Fees FeesType Conditionally Contains fees that may be incurred when items are listed using the automation rules (e.g., a scheduled listing fee). Use of an automation rule does not in itself have a fee, but use can result in a fee.
Fees.Fee FeeType Conditionally,
repeatable: [0..*]
A Fee container is returned for each listing fee associated with listing an item. Each Fee container consists of the fee type, the amount of the fee, and any applicable eBay promotional discount on that listing fee. A Fee container is returned for each listing feature, even if the associated cost is 0.
Fees.Fee.Fee AmountType (double) Conditionally Amount of the fee that eBay will charge the member for the associated listing feature.

See:
    eBay.com Fees for A current schedule of listing features and their associated fees.
    Fees Resulting from Listing an Item for A table listing the type of fees that can be charged when you list an item.

Fees.Fee.Fee
  [ attribute currencyID ]
CurrencyCodeType Conditionally Amount of the fee that eBay will charge the member for the associated listing feature.

For a list of possible enumeration values, see CurrencyCodeType.
Fees.Fee.Name string Conditionally This is the name of the listing feature, such as ListingFee, SubtitleFee, or BoldFee.

See Fees Resulting from Listing an Item.

Fees.Fee.PromotionalDiscount AmountType (double) Conditionally This field exists in the response when the user has selected a feature that participates in a promotional discount.

Note: Verify calls might not return the PromotionalDiscount fee in the response.

See Standard selling fees for A current schedule of listing features and their associated fees..

Fees.Fee.PromotionalDiscount
  [ attribute currencyID ]
CurrencyCodeType Conditionally This field exists in the response when the user has selected a feature that participates in a promotional discount.

Note: Verify calls might not return the PromotionalDiscount fee in the response.

For a list of possible enumeration values, see CurrencyCodeType.
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

Sets template automation rules in Selling Manager.

Description

User magicalbookseller wants to automatically list a Harry Potter book according to a set schedule, to ensure a steady inventory level. She creates a Selling Manager template and records the template ID. Then she makes a SetSellingManagerTemplateAutomationRule call, specifying the template ID, when the item should be listed, and related schedule information. The response includes the schedule she specifed, along with the related fees.

Input

The following container, and its child fields, specify when listings will occur: AutomatedListingRule.ListAccordingToSchedulefields.

XML format.

<?xml version="1.0" encoding="utf-8"?>
<SetSellingManagerTemplateAutomationRuleRequest xmlns="urn:ebay:apis:eBLBaseComponents">
  <RequesterCredentials>
    <eBayAuthToken>ABC...123</eBayAuthToken>
  </RequesterCredentials>
  <WarningLevel>High</WarningLevel>
  <ErrorHandling>BestEffort</ErrorHandling>
  <DetailLevel>ReturnAll</DetailLevel>
  <Version>967</Version>
  <ErrorLanguage>en_US</ErrorLanguage>
  <AutomatedListingRule>
    <ListAccordingToSchedule>
      <DayOfWeek>Tuesday</DayOfWeek>
      <DayOfWeek>Wednesday</DayOfWeek>
      <ListingPeriodInWeeks>1</ListingPeriodInWeeks>
      <ListAtSpecificTimeOfDay>09:00:00.000Z</ListAtSpecificTimeOfDay>
      <StartTime>2015-09-16T07:00:00.000Z</StartTime>
      <MaxActiveItemCount>16</MaxActiveItemCount>
      <ListingHoldInventoryLevel>6</ListingHoldInventoryLevel>
    </ListAccordingToSchedule>
  </AutomatedListingRule>
  <SaleTemplateID>6014296013</SaleTemplateID>
</SetSellingManagerTemplateAutomationRuleRequest>

Output

The response includes the AutomatedListingRule.ListAccordingToSchedulefields container specified in the request, and its child fields, along with the related Fees.

XML format.
<?xml version="1.0" encoding="utf-8"?>
<SetSellingManagerTemplateAutomationRuleResponse xmlns="urn:ebay:apis:eBLBaseComponents">
  <Timestamp>2016-03-26T21:04:46.434Z</Timestamp>
  <Ack>Success</Ack>
  <Version>967</Version>
  <Build>e967_core_Bundled_8215700_R1</Build>
  <AutomatedListingRule>
    <ListAccordingToSchedule>
      <DayOfWeek>Tuesday</DayOfWeek>
      <DayOfWeek>Wednesday</DayOfWeek>
      <ListingPeriodInWeeks>1</ListingPeriodInWeeks>
      <ListAtSpecificTimeOfDay>09:00:00.000Z</ListAtSpecificTimeOfDay>
      <StartTime>2015-09-16T07:00:00.000Z</StartTime>
      <MaxActiveItemCount>16</MaxActiveItemCount>
      <ListingHoldInventoryLevel>6</ListingHoldInventoryLevel>
    </ListAccordingToSchedule>
  </AutomatedListingRule>
  <Fees>
    <Fee>
      <Name>SchedulingFee</Name>
      <Fee currencyID="USD">0.1</Fee>
    </Fee>
  </Fees>
</SetSellingManagerTemplateAutomationRuleResponse>



Change History

Change Date Description
589
2008-10-29
  • (added) New call.