eBay::API::XML::Call::EndItem::EndItemRequestType - eBay::API::XML::Call::EndItem::EndItemRequestType documentation

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

Index

Code Index:

NAME

Top

eBay::API::XML::Call::EndItem::EndItemRequestType

DESCRIPTION

Top

Ends the specified item listing before the date and time at which it would normally end (per the listing duration). <br> <br> For competitive-bidding listings that have bids on them, you must specify an EndingReason value. If you specify SellToHighBidder, the listing ends as a successful auction with winning bidder(s). Otherwise, all bids are cancelled before the item is ended. <br> <br> There are two restrictions for ending items early in the last 12 hours of a listing. If there is a qualified bid (i.e., current high bid that, when applicable, meets the minimum reserve price) in the last 12 hours of a listing, the seller cannot end the item early. If the seller has cancelled a bid in the last 12 hours of the listing, the seller cannot end the item early. <br> <br> Only the item's seller can use EndItem to end an item listing. Applicable to items listed on eBay.com and Half.com. For eBay Live Auctions, you cannot delete items that have been closed or that are part of a Live Auction event that has started.

SYNOPSIS

Top

INHERITANCE

Top

eBay::API::XML::Call::EndItem::EndItemRequestType inherits from the eBay::API::XML::RequestDataType class

Subroutines:

Top

setEndingReason()

Indicates the seller's reason for ending the listing early. This field is required if the seller is ending the item early and the item did not successfully sell. Also applicable to Half.com.

  RequiredInput: Yes
#    Argument: 'ns:EndReasonCodeType'

getEndingReason()

# Returns: 'ns:EndReasonCodeType'

setItemID()

Unique item ID that identifies the item listing to end. Also applicable to Half.com. For Half.com listings, you can either specify ItemID or SellerInventoryID. For eBay Live Auctions, you cannot delete items that have been closed or that are part of a Live Auction event that has started.

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'

setSellerInventoryID()

Unique identifier that the seller specified when they listed the Half.com item. For Half.com items, you can either specify ItemID or SellerInventoryID. If you specify both ItemID and SellerInventoryID, they must be for the same item (otherwise an error will occur). Only applicable to Half.com.

  RequiredInput: Conditionally
#    Argument: 'xs:string'

getSellerInventoryID()

# Returns: 'xs:string'

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

package eBay::API::XML::Call::EndItem::EndItemRequestType;

use strict;
use warnings;  

##########################################################################
#
# Module: ............... <user defined location>eBay/API/XML
# File: ................. EndItemRequestType.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::EndReasonCodeType;


my @gaProperties = ( [ 'EndingReason', 'ns:EndReasonCodeType', ''
	     ,'eBay::API::XML::DataType::Enum::EndReasonCodeType', '' ]
	, [ 'ItemID', 'ns:ItemIDType', ''
	     ,'eBay::API::XML::DataType::ItemIDType', '1' ]
	, [ 'SellerInventoryID', '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 setEndingReason {
  my $self = shift;
  $self->{'EndingReason'} = shift
}


sub getEndingReason {
  my $self = shift;
  return $self->{'EndingReason'};
}



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


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



sub setSellerInventoryID {
  my $self = shift;
  $self->{'SellerInventoryID'} = shift
}


sub getSellerInventoryID {
  my $self = shift;
  return $self->{'SellerInventoryID'};
}





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

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



1;