DisableUnpaidItemAssistance
Enables a seller to disable the automatic cancellation setting for a specific line item.
Note: This call is deprecated and is scheduled for decommission on January 31, 2023. There is no alternative to this call since eBay no longer supports Unpaid Item cases and the Unpaid Item Assistant. However, there is a page in Selling Preferences in My eBay that allows a seller to cancel and relist any items that have not been paid for after a specified amount of days.
Output Detail Controls Samples Change History |
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"?> <DisableUnpaidItemAssistanceRequest xmlns="urn:ebay:apis:eBLBaseComponents"> <!-- Call-specific Input Fields --> <DisputeID> DisputeIDType (string) </DisputeID> <ItemID> ItemIDType (string) </ItemID> <OrderLineItemID> string </OrderLineItemID> <TransactionID> string </TransactionID> <!-- Standard Input Fields --> <ErrorLanguage> string </ErrorLanguage> <MessageID> string </MessageID> <Version> string </Version> <WarningLevel> WarningLevelCodeType </WarningLevel> </DisableUnpaidItemAssistanceRequest>
Argument | Type | Occurrence | Meaning |
---|
Call-specific Input Fields [Jump to standard fields] |
DisputeID | DisputeIDType (string) | Optional |
Deprecated as of version 1275. No longer recommended. DO NOT USE. This field is no longer applicable. Deprecation version: 1275. See also Deprecated Objects. |
ItemID | ItemIDType (string) | Conditional |
Deprecated as of version 1275. No longer recommended. Unique identifier for an eBay listing. A listing can have multiple order line items, but only one ItemID. To identify a specific order line item for which to disable the automatic cancellation setting, either an ItemID/TransactionID pair, or an OrderLineItemID is required in the request. Deprecation version: 1275. See also Deprecated Objects. |
OrderLineItemID | string | Conditional |
Deprecated as of version 1275. No longer recommended. OrderLineItemID is a unique identifier for an eBay order line item. To identify a specific order line item for which to disable the Unpaid Item preferences, either an ItemID/TransactionID pair or an OrderLineItemID is required in the request. Deprecation version: 1275. See also Deprecated Objects. |
TransactionID | string | Conditional |
Deprecated as of version 1275. No longer recommended. The unique identifier of an order line item. An order line item is created once there is a commitment from a buyer to purchase an item. To identify a specific order line item for which to disable the automatic cancellation setting, either an ItemID/TransactionID pair or an OrderLineItemID is required in the request. The TransactionID value for auction listings is always 0 since there can be only one winning bidder/one sale for an auction listing.
Deprecation version: 1275. See also Deprecated Objects. |
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. Below are some examples from different countries.
|
||||||||||||||||||||||||||||||||||||||||
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., 1149). The version you specify for a call has these basic effects:
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:
|
||||||||||||||||||||||||||||||||||||||||
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 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 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. |
Input Detail Controls Samples Change History |
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"?> <DisableUnpaidItemAssistanceResponse xmlns="urn:ebay:apis:eBLBaseComponents"> <!-- (No call-specific Output fields) --> <!-- 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> </DisableUnpaidItemAssistanceResponse>
Return Value | Type | Occurrence | Meaning |
---|
(No call-specific fields) |
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: (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. |
Errors.ErrorClassification | ErrorClassificationCodeType | Conditionally |
API errors are divided between two classes: system errors and request errors.
Applicable values: 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: If the source of the problem is within the application (such as a missing required element), change the application before you retry the request.
See the Compatible Application Check section of the eBay Features Guide for more information. 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. |
Input Output Samples Change History |
Detail Controls
DetailLevel
This call does not support varying Detail Levels. You do not need to pass DetailLevel in the request.
Input Output Detail Controls Change History |
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.
Available samples:
- Basic Call ↓ - Disables automatic handling of the specified item.
- Have a dispute ID ↓ - Disables automatic handling of the item identified in the dispute.
Disables automatic handling of the specified item.
Description
This call enables a seller who has enabled automated Unpaid Item preferences to switch from automatic handling of the dispute to manual for the specified item.
Input
In this scenario, a buyer has not paid for an item and Unpaid Item preferences has created a dispute. The seller wants to handle this dispute at the seller's own pace instead of letting the preferences control it. So, the seller calls DisableUnpaidItemAssistance with the ItemID/TransactionID pair. This converts the automated dispute to a manual dispute.
XML format.
<?xml version="1.0" encoding="UTF-8"?>
<DisableUnpaidItemAssistanceRequest xmlns="urn:ebay:apis:eBLBaseComponents">
<RequesterCredentials>
<eBayAuthToken>A*******3</eBayAuthToken>
</RequesterCredentials>
<ErrorLanguage>en_US</ErrorLanguage>
<WarningLevel>High</WarningLevel>
<ItemID>1**********2</ItemID>
<TransactionID>0</TransactionID>
</DisableUnpaidItemAssistanceRequest>
Output
XML format.
<?xml version="1.0" encoding="UTF-8"?>
<DisableUnpaidItemAssistanceResponse xmlns="urn:ebay:apis:eBLBaseComponents">
<Timestamp>2019-11-04T17:23:26.518Z</Timestamp>
<Ack>Warning</Ack>
<Version>1131</Version>
<Build>E1131_CORE_API6_19105226_R1</Build>
</DisableUnpaidItemAssistanceResponse>
Disables automatic handling of the item identified in the dispute.
Description
This call enables a seller who has enabled automated Unpaid Item preferences to switch from automatic handling of the dispute to manual for the item noted in the specified dispute.
Input
In this scenario, a buyer has not paid for an item and Unpaid Item preferences has created a dispute. The seller wants to handle this dispute at the seller's own pace instead of letting the preferences control it. So, the seller calls DisableUnpaidItemAssistance with the DisputeID of the automated dispute. This converts it to a manual dispute.
XML format.
<?xml version="1.0" encoding="UTF-8"?>
<DisableUnpaidItemAssistanceRequest xmlns="urn:ebay:apis:eBLBaseComponents">
<RequesterCredentials>
<eBayAuthToken>A*******3</eBayAuthToken>
</RequesterCredentials>
<ErrorLanguage>en_US</ErrorLanguage>
<WarningLevel>High</WarningLevel>
<DisputeID>6****1</DisputeID>
</DisableUnpaidItemAssistanceRequest>
Output
XML format.
<?xml version="1.0" encoding="UTF-8"?>
<DisableUnpaidItemAssistanceResponse xmlns="urn:ebay:apis:eBLBaseComponents">
<Timestamp>2019-11-04T17:23:26.518Z</Timestamp>
<Ack>Warning</Ack>
<Version>1131</Version>
<Build>E1131_CORE_API6_19105226_R1</Build>
</DisableUnpaidItemAssistanceResponse>
Input Output Detail Controls Samples |
Change History
Change Date | Description |
---|---|
705 2011-01-19 |
|
655 2010-02-03 |
|
637 2009-09-30 |
|