NAME
eBay::API::XML::DataType::DisputeType
DESCRIPTION
Contains all information describing a dispute.
SYNOPSIS
INHERITANCE
eBay::API::XML::DataType::DisputeType inherits from the eBay::API::XML::BaseDataType class
Subroutines:
setBuyerUserID()
The eBay user ID of the buyer involved in the dispute.
# Argument: 'ns:UserIDType'
getBuyerUserID()
Calls: GetDispute
Returned: Always
# Returns: 'ns:UserIDType'
setDisputeCreatedTime()
The date and time the dispute was created, in GMT.
# Argument: 'xs:dateTime'
getDisputeCreatedTime()
Calls: GetDispute
Returned: Always
Calls: GetUserDisputes
Returned: Conditionally
Details: DetailLevel: ReturnSummary, ReturnAll, none
# Returns: 'xs:dateTime'
setDisputeCreditEligibility()
Whether the dispute is currently eligible for Final Value Fee credit. The value is usually Ineligible until 7 days after the dispute was created, unless a fee exception applies.
# Argument: 'ns:DisputeCreditEligibilityCodeType'
getDisputeCreditEligibility()
Calls: GetDispute
Returned: Always
Calls: GetUserDisputes
Returned: Conditionally
Details: DetailLevel: ReturnSummary, ReturnAll, none
# Returns: 'ns:DisputeCreditEligibilityCodeType'
setDisputeExplanation()
The detailed explanation for the dispute. Valid values depend on the value of DisputeReason. See DisputeExplanationCodeList for details.
# Argument: 'ns:DisputeExplanationCodeType'
getDisputeExplanation()
Calls: GetDispute
Returned: Always
Calls: GetUserDisputes
Returned: Conditionally
Details: DetailLevel: ReturnSummary, ReturnAll, none
# Returns: 'ns:DisputeExplanationCodeType'
setDisputeID()
The unique identifier of a dispute, returned by the eBay site when the dispute is created.
# Argument: 'ns:DisputeIDType'
getDisputeID()
Calls: GetDispute
Returned: Always
Calls: GetUserDisputes
Returned: Conditionally
Details: DetailLevel: ReturnSummary, ReturnAll, none
# Returns: 'ns:DisputeIDType'
setDisputeMessage()
A response or message posted to a dispute, either by an application or by a user on the eBay site.
# Argument: reference to an array of 'ns:DisputeMessageType'
getDisputeMessage()
Calls: GetDispute
Returned: Always
Calls: GetUserDisputes
Returned: Conditionally
Details: DetailLevel: ReturnAll, none
# Returns: reference to an array of 'ns:DisputeMessageType'
setDisputeModifiedTime()
The date and time the dispute was modified, in GMT.
# Argument: 'xs:dateTime'
getDisputeModifiedTime()
Calls: GetDispute
Returned: Always
Calls: GetUserDisputes
Returned: Conditionally
Details: DetailLevel: ReturnSummary, ReturnAll, none
# Returns: 'xs:dateTime'
setDisputeReason()
The top-level reason for the dispute. The value of DisputeReason determines which values of DisputeExplanation are valid. See DisputeExplanationCodeList for details.
# Argument: 'ns:DisputeReasonCodeType'
getDisputeReason()
Calls: GetDispute
Returned: Always
Calls: GetUserDisputes
Returned: Conditionally
Details: DetailLevel: ReturnSummary, ReturnAll, none
# Returns: 'ns:DisputeReasonCodeType'
setDisputeRecordType()
The type of dispute.
# Argument: 'ns:DisputeRecordTypeCodeType'
getDisputeRecordType()
Calls: GetDispute
Returned: Always
Calls: GetUserDisputes
Returned: Conditionally
Details: DetailLevel: ReturnSummary, ReturnAll, none
# Returns: 'ns:DisputeRecordTypeCodeType'
setDisputeResolution()
The action resulting from the dispute resolution. The action might include a Final Value Fee credit to the seller, a strike to the buyer, a reversal, or an appeal.
# Argument: reference to an array of 'ns:DisputeResolutionType'
getDisputeResolution()
Calls: GetUserDisputes
Returned: Conditionally
Details: DetailLevel: ReturnAll, none
# Returns: reference to an array of 'ns:DisputeResolutionType'
setDisputeState()
The internal state of the dispute. The value determines which values of DisputeActivity are valid when responding to a dispute.
# Argument: 'ns:DisputeStateCodeType'
getDisputeState()
Calls: GetDispute
Returned: Always
Calls: GetUserDisputes
Returned: Conditionally
Details: DetailLevel: ReturnSummary, ReturnAll, none
# Returns: 'ns:DisputeStateCodeType'
setDisputeStatus()
The status of the dispute, which provides additional information about the dispute state.
# Argument: 'ns:DisputeStatusCodeType'
getDisputeStatus()
Calls: GetDispute
Returned: Always
Calls: GetUserDisputes
Returned: Conditionally
Details: DetailLevel: ReturnSummary, ReturnAll, none
# Returns: 'ns:DisputeStatusCodeType'
setEscalation()
Whether the buyer can close a dispute unhappy and escalate it to the eBay Standard Purchase Protection Program. To escalate, the buyer must be eligible for the PPP. Used in Item Not Received disputes.
# Argument: 'xs:boolean'
isEscalation()
Calls: GetDispute
Returned: Always
# Returns: 'xs:boolean'
setItem()
Information about the item that spawned the transaction. The transaction is a purchase from this item's listing.
# Argument: 'ns:ItemType'
getItem()
Calls: GetDispute
Returned: Always
Calls: GetUserDisputes
Returned: Conditionally
Details: DetailLevel: ReturnSummary, ReturnAll, none
# Returns: 'ns:ItemType'
setOtherPartyName()
The user name of the person involved in the dispute who is not taking action or requesting information. The role is either Buyer or Seller.
# Argument: 'xs:string'
getOtherPartyName()
Calls: GetUserDisputes
Returned: Conditionally
Details: DetailLevel: ReturnSummary, ReturnAll, none
# Returns: 'xs:string'
setOtherPartyRole()
The role of the person involved in the dispute who is not taking action or requesting information. The role is either Buyer or Seller.
# Argument: 'ns:TradingRoleCodeType'
getOtherPartyRole()
Calls: GetUserDisputes
Returned: Conditionally
Details: DetailLevel: ReturnSummary, ReturnAll, none
# Returns: 'ns:TradingRoleCodeType'
setPurchaseProtection()
Whether the buyer is eligible for the eBay Standard Purchase Protection Program. The eligibility rules are described in the eBay site online help. Used in Item Not Received disputes.
# Argument: 'xs:boolean'
isPurchaseProtection()
Calls: GetDispute
Returned: Always
# Returns: 'xs:boolean'
setSellerUserID()
The eBay user ID of the seller involved in the dispute.
# Argument: 'ns:UserIDType'
getSellerUserID()
Calls: GetDispute
Returned: Always
# Returns: 'ns:UserIDType'
setTransactionID()
The unique identifier of the transaction under dispute. The transaction is created when the winning bidder commits to purchasing the item but before the bidder pays.
MaxLength: 19 (Note: The eBay database specifies 38. Currently, transaction IDs are usually 9 to 12 digits.)
# Argument: 'xs:string'
getTransactionID()
Calls: GetDispute
Returned: Always
Calls: GetUserDisputes
Returned: Conditionally
Details: DetailLevel: ReturnSummary, ReturnAll, none
# Returns: 'xs:string'
setUserRole()
The role of the person involved in the dispute who is taking action or requesting information. The role is either Buyer or Seller.
# Argument: 'ns:TradingRoleCodeType'
getUserRole()
Calls: GetUserDisputes
Returned: Conditionally
Details: DetailLevel: ReturnSummary, ReturnAll, none
# Returns: 'ns:TradingRoleCodeType'