eBay::API::XML::DataType::DisputeType - eBay::API::XML::DataType::DisputeType documentation

eBay-API documentation Contained in the eBay-API distribution.

Index

Code Index:

NAME

Top

eBay::API::XML::DataType::DisputeType

DESCRIPTION

Top

Contains all information describing a dispute.

SYNOPSIS

Top

INHERITANCE

Top

eBay::API::XML::DataType::DisputeType inherits from the eBay::API::XML::BaseDataType class

Subroutines:

Top

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'

eBay-API documentation Contained in the eBay-API distribution. 
#!/usr/bin/perl

package eBay::API::XML::DataType::DisputeType;

use strict;
use warnings;  

##########################################################################
#
# Module: ............... <user defined location>eBay/API/XML
# File: ................. DisputeType.pm
# Generated by: ......... genEBayApiDataTypes.pl
# Last Generated: ....... 08/24/2008 16:44
# API Release Number: ... 579
#
##########################################################################  


use eBay::API::XML::BaseDataType;
our @ISA = ("eBay::API::XML::BaseDataType");

use eBay::API::XML::DataType::DisputeIDType;
use eBay::API::XML::DataType::DisputeMessageType;
use eBay::API::XML::DataType::DisputeResolutionType;
use eBay::API::XML::DataType::ItemType;
use eBay::API::XML::DataType::UserIDType;
use eBay::API::XML::DataType::Enum::DisputeCreditEligibilityCodeType;
use eBay::API::XML::DataType::Enum::DisputeExplanationCodeType;
use eBay::API::XML::DataType::Enum::DisputeReasonCodeType;
use eBay::API::XML::DataType::Enum::DisputeRecordTypeCodeType;
use eBay::API::XML::DataType::Enum::DisputeStateCodeType;
use eBay::API::XML::DataType::Enum::DisputeStatusCodeType;
use eBay::API::XML::DataType::Enum::TradingRoleCodeType;


my @gaProperties = ( [ 'BuyerUserID', 'ns:UserIDType', ''
	     ,'eBay::API::XML::DataType::UserIDType', '1' ]
	, [ 'DisputeCreatedTime', 'xs:dateTime', '', '', '' ]
	, [ 'DisputeCreditEligibility', 'ns:DisputeCreditEligibilityCodeType', ''
	     ,'eBay::API::XML::DataType::Enum::DisputeCreditEligibilityCodeType', '' ]
	, [ 'DisputeExplanation', 'ns:DisputeExplanationCodeType', ''
	     ,'eBay::API::XML::DataType::Enum::DisputeExplanationCodeType', '' ]
	, [ 'DisputeID', 'ns:DisputeIDType', ''
	     ,'eBay::API::XML::DataType::DisputeIDType', '1' ]
	, [ 'DisputeMessage', 'ns:DisputeMessageType', '1'
	     ,'eBay::API::XML::DataType::DisputeMessageType', '1' ]
	, [ 'DisputeModifiedTime', 'xs:dateTime', '', '', '' ]
	, [ 'DisputeReason', 'ns:DisputeReasonCodeType', ''
	     ,'eBay::API::XML::DataType::Enum::DisputeReasonCodeType', '' ]
	, [ 'DisputeRecordType', 'ns:DisputeRecordTypeCodeType', ''
	     ,'eBay::API::XML::DataType::Enum::DisputeRecordTypeCodeType', '' ]
	, [ 'DisputeResolution', 'ns:DisputeResolutionType', '1'
	     ,'eBay::API::XML::DataType::DisputeResolutionType', '1' ]
	, [ 'DisputeState', 'ns:DisputeStateCodeType', ''
	     ,'eBay::API::XML::DataType::Enum::DisputeStateCodeType', '' ]
	, [ 'DisputeStatus', 'ns:DisputeStatusCodeType', ''
	     ,'eBay::API::XML::DataType::Enum::DisputeStatusCodeType', '' ]
	, [ 'Escalation', 'xs:boolean', '', '', '' ]
	, [ 'Item', 'ns:ItemType', ''
	     ,'eBay::API::XML::DataType::ItemType', '1' ]
	, [ 'OtherPartyName', 'xs:string', '', '', '' ]
	, [ 'OtherPartyRole', 'ns:TradingRoleCodeType', ''
	     ,'eBay::API::XML::DataType::Enum::TradingRoleCodeType', '' ]
	, [ 'PurchaseProtection', 'xs:boolean', '', '', '' ]
	, [ 'SellerUserID', 'ns:UserIDType', ''
	     ,'eBay::API::XML::DataType::UserIDType', '1' ]
	, [ 'TransactionID', 'xs:string', '', '', '' ]
	, [ 'UserRole', 'ns:TradingRoleCodeType', ''
	     ,'eBay::API::XML::DataType::Enum::TradingRoleCodeType', '' ]
                    );
push @gaProperties, @{eBay::API::XML::BaseDataType::getPropertiesList()};

my @gaAttributes = ( 
                    );
push @gaAttributes, @{eBay::API::XML::BaseDataType::getAttributesList()};


sub new {
  my $classname = shift;
  my %args = @_;
  my $self = $classname->SUPER::new(%args);
  return $self;
}

sub isScalar {
   return 0; 
}




sub setBuyerUserID {
  my $self = shift;
  $self->{'BuyerUserID'} = shift
}


sub getBuyerUserID {
  my $self = shift;
  return $self->_getDataTypeInstance( 'BuyerUserID'
		,'eBay::API::XML::DataType::UserIDType');
}



sub setDisputeCreatedTime {
  my $self = shift;
  $self->{'DisputeCreatedTime'} = shift
}


sub getDisputeCreatedTime {
  my $self = shift;
  return $self->{'DisputeCreatedTime'};
}



sub setDisputeCreditEligibility {
  my $self = shift;
  $self->{'DisputeCreditEligibility'} = shift
}


sub getDisputeCreditEligibility {
  my $self = shift;
  return $self->{'DisputeCreditEligibility'};
}



sub setDisputeExplanation {
  my $self = shift;
  $self->{'DisputeExplanation'} = shift
}


sub getDisputeExplanation {
  my $self = shift;
  return $self->{'DisputeExplanation'};
}



sub setDisputeID {
  my $self = shift;
  $self->{'DisputeID'} = shift
}


sub getDisputeID {
  my $self = shift;
  return $self->_getDataTypeInstance( 'DisputeID'
		,'eBay::API::XML::DataType::DisputeIDType');
}



sub setDisputeMessage {
  my $self = shift;
  $self->{'DisputeMessage'} = 
		$self->convertArray_To_RefToArrayIfNeeded(@_);
}


sub getDisputeMessage {
  my $self = shift;
  return $self->_getDataTypeArray('DisputeMessage');
}



sub setDisputeModifiedTime {
  my $self = shift;
  $self->{'DisputeModifiedTime'} = shift
}


sub getDisputeModifiedTime {
  my $self = shift;
  return $self->{'DisputeModifiedTime'};
}



sub setDisputeReason {
  my $self = shift;
  $self->{'DisputeReason'} = shift
}


sub getDisputeReason {
  my $self = shift;
  return $self->{'DisputeReason'};
}



sub setDisputeRecordType {
  my $self = shift;
  $self->{'DisputeRecordType'} = shift
}


sub getDisputeRecordType {
  my $self = shift;
  return $self->{'DisputeRecordType'};
}



sub setDisputeResolution {
  my $self = shift;
  $self->{'DisputeResolution'} = 
		$self->convertArray_To_RefToArrayIfNeeded(@_);
}


sub getDisputeResolution {
  my $self = shift;
  return $self->_getDataTypeArray('DisputeResolution');
}



sub setDisputeState {
  my $self = shift;
  $self->{'DisputeState'} = shift
}


sub getDisputeState {
  my $self = shift;
  return $self->{'DisputeState'};
}



sub setDisputeStatus {
  my $self = shift;
  $self->{'DisputeStatus'} = shift
}


sub getDisputeStatus {
  my $self = shift;
  return $self->{'DisputeStatus'};
}



sub setEscalation {
  my $self = shift;
  $self->{'Escalation'} = shift
}


sub isEscalation {
  my $self = shift;
  return $self->{'Escalation'};
}



sub setItem {
  my $self = shift;
  $self->{'Item'} = shift
}


sub getItem {
  my $self = shift;
  return $self->_getDataTypeInstance( 'Item'
		,'eBay::API::XML::DataType::ItemType');
}



sub setOtherPartyName {
  my $self = shift;
  $self->{'OtherPartyName'} = shift
}


sub getOtherPartyName {
  my $self = shift;
  return $self->{'OtherPartyName'};
}



sub setOtherPartyRole {
  my $self = shift;
  $self->{'OtherPartyRole'} = shift
}


sub getOtherPartyRole {
  my $self = shift;
  return $self->{'OtherPartyRole'};
}



sub setPurchaseProtection {
  my $self = shift;
  $self->{'PurchaseProtection'} = shift
}


sub isPurchaseProtection {
  my $self = shift;
  return $self->{'PurchaseProtection'};
}



sub setSellerUserID {
  my $self = shift;
  $self->{'SellerUserID'} = shift
}


sub getSellerUserID {
  my $self = shift;
  return $self->_getDataTypeInstance( 'SellerUserID'
		,'eBay::API::XML::DataType::UserIDType');
}



sub setTransactionID {
  my $self = shift;
  $self->{'TransactionID'} = shift
}


sub getTransactionID {
  my $self = shift;
  return $self->{'TransactionID'};
}



sub setUserRole {
  my $self = shift;
  $self->{'UserRole'} = shift
}


sub getUserRole {
  my $self = shift;
  return $self->{'UserRole'};
}





##  Attribute and Property lists
sub getPropertiesList {
   my $self = shift;
   return \@gaProperties;
}

sub getAttributesList {
   my $self = shift;
   return \@gaAttributes;
}



1;