eBay Trading APIVersion 1039

GetSellingManagerEmailLog

Retrieves a log of emails sent, or scheduled to be sent, to buyers. Includes success or failure status. To use this call, you must be a Selling Manager Pro subscriber.

Use this call by first calling AddSellingManagerTemplate, and use the SaleTemplateID output field as input in an AddItemFromSellingManagerTemplate call. Next, use the ItemID output field from AddItemFromSellingManagerTemplate as input to your GetSellingManagerEmailLog 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"?>
<GetSellingManagerEmailLogRequest xmlns="urn:ebay:apis:eBLBaseComponents">
  <!-- Call-specific Input Fields -->
  <EmailDateRange> TimeRangeType
    <TimeFrom> dateTime </TimeFrom>
    <TimeTo> dateTime </TimeTo>
  </EmailDateRange>
  <ItemID> ItemIDType (string) </ItemID>
  <OrderID> OrderIDType (string) </OrderID>
  <OrderLineItemID> string </OrderLineItemID>
  <TransactionID> long </TransactionID>
  <!-- Standard Input Fields -->
  <ErrorLanguage> string </ErrorLanguage>
  <MessageID> string </MessageID>
  <Version> string </Version>
  <WarningLevel> WarningLevelCodeType </WarningLevel>
</GetSellingManagerEmailLogRequest>
Argument Type Occurrence Meaning
Call-specific Input Fields [Jump to standard fields]
EmailDateRange TimeRangeType Optional Specifies the earliest (oldest) and latest (most recent) dates to use in a date range filter based on email sent date. Each of the time ranges can be up to 90 days.
EmailDateRange.TimeFrom dateTime Optional Specifies the earliest (oldest) date to be used in a date range.
EmailDateRange.TimeTo dateTime Optional Specifies the latest (most recent) date to be used in a date range.
ItemID ItemIDType (string) Conditional Unique identifier for the eBay item listing associated with the Selling Manager email log. Unless the OrderID or OrderLineItemID value is specified in the request, the ItemID and TransactionID fields must be used to identify the Selling Manager email log to retrieve. You can use GetSellingManagerSoldListings to retrieve the ItemID, TransactionID or OrderLineItemID values that correspond to the Selling Manager sale record (SaleRecordID). All four of these fields are returned under the SellingManagerSoldTransaction container of the GetSellingManagerSoldListings request.
OrderID OrderIDType (string) Optional A unique identifier that identifies a single line item or multiple line item (Combined Invoice) order associated with the Selling Manager email log.

For a single line item order, the OrderID value is identical to the OrderLineItemID value that is generated upon creation of the order line item. For a Combined Payment order, the OrderID value is created by eBay when the buyer or seller (sharing multiple, common order line items) combines multiple order line items into a Combined Payment order through the eBay site (or when the seller creates Combined Payment order through AddOrder). If an OrderID is used in the request, the OrderLineItemID and ItemID/TransactionID pair are not required.
Max length: 50.

See Combined Invoice.

OrderLineItemID string Conditional A unique identifier for an eBay order line item that is associated with the Selling Manager email log. This field is created as soon as there is a commitment to buy from the seller, and its value is based upon the concatenation of ItemID and TransactionID, with a hyphen in between these two IDs. You can use GetSellingManagerSoldListings to retrieve the ItemID, TransactionID or OrderLineItemID values that correspond to the Selling Manager sale record (SaleRecordID). All four of these fields are returned under the SellingManagerSoldTransaction container of the GetSellingManagerSoldListings request. Unless an OrderID or an ItemID/TransactionID pair is specified in the GetSellingManagerSaleRecord request, the OrderLineItemID is required.

Max length: 50 (Note: ItemIDs and TransactionIDs usually consist of 9 to 12 digits.).
TransactionID long Optional Unique identifier for the order line item associated with the Selling Manager email log. Unless the OrderID or OrderLineItemID value is specified in the request, the ItemID and TransactionID fields must be used to identify the Selling Manager email log to retrieve. You can use GetSellingManagerSoldListings to retrieve the ItemID, TransactionID or OrderLineItemID values that correspond to the Selling Manager sale record (SaleRecordID). All four of these fields are returned under the SellingManagerSoldTransaction container of the GetSellingManagerSoldListings request.
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"?>
<GetSellingManagerEmailLogResponse xmlns="urn:ebay:apis:eBLBaseComponents">
  <!-- Call-specific Output Fields -->
  <EmailLog> SellingManagerEmailLogType
    <CustomEmailName> string </CustomEmailName>
    <EmailState> SellingManagerEmailSentStatusCodeType </EmailState>
    <EmailType> SellingManagerEmailTypeCodeType </EmailType>
    <EventTime> dateTime </EventTime>
  </EmailLog>
  <!-- ... more EmailLog nodes allowed here ... -->
  <!-- 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>
</GetSellingManagerEmailLogResponse>
Return Value Type Occurrence Meaning
Call-specific Output Fields [Jump to standard fields]
EmailLog SellingManagerEmailLogType Always,
repeatable: [1..*]
Email logs associated with this order.
EmailLog.CustomEmailName string Conditionally Template name of the custom email.
EmailLog.EmailState SellingManagerEmailSentStatusCodeType Always Success or failure state of this email.

Applicable values:

CustomCode
(out) Reserved for internal or future use.
Failed
(out) Sending of email failed.
Pending
(out) Email is not yet sent and is in Queue.
Successful
(out) Email sent successfully.

Code so that your app gracefully handles any future changes to this list.
EmailLog.EmailType SellingManagerEmailTypeCodeType Always Specifies the type of Selling Manager email.

Applicable values: See EmailType.
Code so that your app gracefully handles any future changes to this list.
EmailLog.EventTime dateTime Always Date on which this email event occurred.
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

Returns the email log related to an item, transaction or order.

Description

User magicalbookseller would like to get a log of emails between her and some buyers relating to questions about a Harry Potter book. She specifies the ItemID in the GetSellingManagerEmailLog call and is given a transcript of the emails related to that item.

Input

All fields in the following GetSellingManagerEmailLog request sample are the basic input required to retrieve an email log related to an item.

XML format.

<?xml version="1.0" encoding="utf-8"?>
<GetSellingManagerEmailLogRequest xmlns="urn:ebay:apis:eBLBaseComponents">
  <RequesterCredentials>
    <eBayAuthToken>ABC...123</eBayAuthToken>
  </RequesterCredentials>
  <Version>967</Version>
  <ItemID>170001996049</ItemID>
  <TransactionID>7426530007</TransactionID>
</GetSellingManagerEmailLogRequest>

Output

The response returns a copy of email logs relating to the specified ItemID.

XML format.
<?xml version="1.0" encoding="utf-8"?>
<GetSellingManagerEmailLogResponse xmlns="urn:ebay:apis:eBLBaseComponents">
  <Timestamp>2016-03-20T19:11:29.987Z</Timestamp>
  <Ack>Success</Ack>
  <Version>967</Version>
  <Build>e967_core_Bundled_8177180_R1</Build>
</GetSellingManagerEmailLogResponse>



Change History

Change Date Description
705
2011-01-19
  • OrderLineItemID (modified): The OrderLineItemID value can now be used in Production to identify an order line item (instead of ItemID/TransactionID pair). An OrderLineItemID value can also be passed into the OrderID field (for single line item orders only).
693
2010-10-27
  • OrderLineItemID (added): A unique identifier for an eBay transaction, which is based upon the concatenation of ItemID and TransactionID with a hyphen in between these two IDs. If you set your request version to 705, OrderLineItemID can be used instead of ItemID and TransactionID in the request.
589
2008-10-29
  • (added) New call.