GetSellingManagerTemplateAutomationRule

Retrieves the set of Selling Manager automation rules associated with a Selling Manager 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.

Before testing GetSellingManagerTemplateAutomationRule, obtain a SaleTemplateID by calling GetSellingManagerInventory or AddSellingManagerTemplate. Use the SaleTemplateID from that call's response as input for a GetSellingManagerTemplateAutomationRule request.

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:

AddSellingManagerTemplate - Adds a Selling Manager template.
GetSellingManagerTemplates - Retrieves Selling Manager templates.
SetSellingManagerTemplateAutomationRule - Revises or adds to the Selling Manager automation rules associated with a specific template.

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

GetSellingManagerTemplateAutomationRule 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"?>
<GetSellingManagerTemplateAutomationRuleResponse 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>
    <!-- ... 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>
</GetSellingManagerTemplateAutomationRuleResponse>

Return Value	Type	Occurrence	Meaning

Call-specific Output Fields [Jump to standard fields]

AutomatedListingRule	SellingManagerAutoListType	Conditionally	The information for the automated listing rule associated with the 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: • CustomCode (in/out) Reserved for internal or future use. • Friday (in/out) Friday • Monday (in/out) Monday • Saturday (in/out) Saturday • Sunday (in/out) Sunday • Thursday (in/out) Thursday • Tuesday (in/out) Tuesday • Wednesday (in/out) Wednesday
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	The information for the automated relisting rule associated with the 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 this item. A seller of a fixed-price item (in a category for which Best Offer is also enabled) can opt that item into the Best Offer feature. This feature enables a buyer to make a lower-priced binding offer on that item. If a listing has no active Best Offers, you can change this value (true to false, and vice versa). If a listing does have an active Best Offer, you cannot change the value to false.
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) Relist the item after a specified number of days and hours. • RelistAtSpecificTimeOfDay (in/out) Relist the item at a specified time of day. • RelistImmediately (in/out) Relist the item immediately.
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.
AutomatedSecondChanceOfferRule	SellingManagerAutoSecondChanceOfferType	Conditionally	The information for the automated second chance offer rule associated with the 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	Three-digit code representing the currency type being used. In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany. 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 response. • 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 response. • 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 EndTime value returned in the AddSecondChanceItem response. • 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 response.
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.
Fees	FeesType	Conditionally	Contains fees that may be incurred when items are listed using the automation rule (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..*]	Contains the name, fee, and possible discount amount for an item listing feature. A Fee container is returned for each listing feature, even if the associated cost (Fee value) is 0.

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.

GetSellingManagerTemplateAutomationRule Detail Controls

Detail Control: DetailLevel

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

GetSellingManagerTemplateAutomationRule Samples

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

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

Sample: Basic Call

Returns information about an automation rule for a specified template.

Description

User magicalbookseller wants to view the automation rules she has set up for a particular Harry Potter template. In GetSellingManagerTemplateAutomationRule, she specifies the template ID of the template.

Input

To use GetSellingManagerTemplateAutomationRule, specify the ID of the template whose automation rule(s) you want information about, as in the following example.

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

<?xml version="1.0" encoding="utf-8"?>
<GetSellingManagerTemplateAutomationRuleRequest xmlns="urn:ebay:apis:eBLBaseComponents">
  <RequesterCredentials>
    <eBayAuthToken>ABC...123</eBayAuthToken>
  </RequesterCredentials>
  <Version>615</Version>
  <SaleTemplateID>6014296013</SaleTemplateID>
</GetSellingManagerTemplateAutomationRuleRequest>

Output

This sample response includes information about a rule that, at an earlier time, was assigned to the template specified in the request. The rule is a ListAccordingToSchedule rule, which is a type of auto-list rule.

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

<?xml version="1.0" encoding="utf-8"?>
<GetSellingManagerTemplateAutomationRuleResponse xmlns="urn:ebay:apis:eBLBaseComponents">
  <Timestamp>2009-05-04T17:59:05.013Z</Timestamp>
  <Ack>Success</Ack>
  <Version>615</Version>
  <Build>e615__Bundled_8608811_R1</Build>
  <AutomatedListingRule>
    <ListAccordingToSchedule>
      <DayOfWeek>Tuesday</DayOfWeek>
      <DayOfWeek>Wednesday</DayOfWeek>
      <ListingPeriodInWeeks>1</ListingPeriodInWeeks>
      <ListAtSpecificTimeOfDay>09:00:00.000Z</ListAtSpecificTimeOfDay>
      <StartTime>2008-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>
</GetSellingManagerTemplateAutomationRuleResponse>

GetSellingManagerTemplateAutomationRule Change History

Version	Description
589 2008-10-29	(added) New call.

User-Contributed Notes

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.

eBay Trading API Call Reference Version 823