eBay::API::XML::Call::AddDispute::AddDisputeRequestType - eBay::API::XML::Call::AddDispute::AddDisputeRequestType documentation

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

Index

Code Index:

NAME

Top

eBay::API::XML::Call::AddDispute::AddDisputeRequestType

DESCRIPTION

Top

Enables a seller to create a new Unpaid Item dispute. (Item Not Received disputes can only be created via the eBay web site.)

SYNOPSIS

Top

INHERITANCE

Top

eBay::API::XML::Call::AddDispute::AddDisputeRequestType inherits from the eBay::API::XML::RequestDataType class

Subroutines:

Top

setDisputeExplanation()

An explanation of the dispute that supplements the DisputeReason. The allowed value depends on the value of DisputeReason.

  RequiredInput: Yes
#    Argument: 'ns:DisputeExplanationCodeType'

getDisputeExplanation()

# Returns: 'ns:DisputeExplanationCodeType'

setDisputeReason()

The top-level reason for the Unpaid Item Dispute. DisputeReasonCodeType has several possible values. However, only BuyerHasNotPaid and TransactionMutuallyCanceled apply to AddDispute--you can only use AddDisputeCall to create Unpaid Item disputes.

  RequiredInput: Yes
#    Argument: 'ns:DisputeReasonCodeType'

getDisputeReason()

# Returns: 'ns:DisputeReasonCodeType'

setItemID()

The eBay ID of the item in dispute, an item which has been sold but not yet paid for.

MaxLength: 19 (Note: The eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits)

  RequiredInput: Yes
#    Argument: 'ns:ItemIDType'

getItemID()

# Returns: 'ns:ItemIDType'

setTransactionID()

The eBay ID of a transaction, created when the buyer committed to purchasing the item. A transaction ID is unique to the item but not across the entire eBay site. The transaction ID must be combined with an item ID to uniquely identify an item.

MaxLength: 19 (Note: The eBay database specifies 38. Currently, transaction IDs are usually 9 to 12 digits.)

  RequiredInput: Yes
#    Argument: 'xs:string'

getTransactionID()

# Returns: 'xs:string'

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

package eBay::API::XML::Call::AddDispute::AddDisputeRequestType;

use strict;
use warnings;  

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


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

use eBay::API::XML::DataType::ItemIDType;
use eBay::API::XML::DataType::Enum::DisputeExplanationCodeType;
use eBay::API::XML::DataType::Enum::DisputeReasonCodeType;


my @gaProperties = ( [ 'DisputeExplanation', 'ns:DisputeExplanationCodeType', ''
	     ,'eBay::API::XML::DataType::Enum::DisputeExplanationCodeType', '' ]
	, [ 'DisputeReason', 'ns:DisputeReasonCodeType', ''
	     ,'eBay::API::XML::DataType::Enum::DisputeReasonCodeType', '' ]
	, [ 'ItemID', 'ns:ItemIDType', ''
	     ,'eBay::API::XML::DataType::ItemIDType', '1' ]
	, [ 'TransactionID', 'xs:string', '', '', '' ]
                    );
push @gaProperties, @{eBay::API::XML::RequestDataType::getPropertiesList()};

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


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

sub isScalar {
   return 0; 
}




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


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



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


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



sub setItemID {
  my $self = shift;
  $self->{'ItemID'} = shift
}


sub getItemID {
  my $self = shift;
  return $self->_getDataTypeInstance( 'ItemID'
		,'eBay::API::XML::DataType::ItemIDType');
}



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


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





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

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



1;