eBay::API::XML::Call::ReviseCheckoutStatus::ReviseCheckoutStatusRequestType - eBay::API::XML::Call::ReviseCheckoutStatus::ReviseCheckoutStatusRequestType documentation

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

Index

Code Index:

NAME

Top

eBay::API::XML::Call::ReviseCheckoutStatus::ReviseCheckoutStatusRequestType

DESCRIPTION

Top

Enables a seller to update the payment status of an item.

SYNOPSIS

Top

INHERITANCE

Top

eBay::API::XML::Call::ReviseCheckoutStatus::ReviseCheckoutStatusRequestType inherits from the eBay::API::XML::RequestDataType class

Subroutines:

Top

setAdjustmentAmount()

Discount or charge agreed to by the buyer and seller. A positive value indicates that the amount is an extra charge being paid to the seller by the buyer. A negative value indicates that the amount is a discount given to the buyer by the seller.

  RequiredInput: No
#    Argument: 'ns:AmountType'

getAdjustmentAmount()

# Returns: 'ns:AmountType'

setAmountPaid()

The amount paid by the buyer. For an eBay Stores item, the value passed in AmountPaid is the transaction/item price. For a US eBay Motors item, AmountPaid is the total amount paid by the buyer for the deposit.

  RequiredInput: No
#    Argument: 'ns:AmountType'

getAmountPaid()

# Returns: 'ns:AmountType'

setBuyerID()

eBay ID for the buyer in the transaction being revised. A transaction is uniquely identified by one of two means: (a) You provide a TransactionID and ItemID. (This is the preferred approach.), OR, (b) You provide a BuyerID and ItemID and eBay identifies only one transaction for that combination (an error is returned if there are multiple transactions for that combination). Note: If all three are provided (that is, BuyerID, ItemID and TransactionID), BuyerID is ignored.

  RequiredInput: Conditionally
#    Argument: 'xs:string'

getBuyerID()

# Returns: 'xs:string'

setCODCost()

Italy site (site ID 101) only. Enables you to specify the cash-on-delivery (COD) cost, for COD shipping.

SeeLink: URL: http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=CODInShippingDetails Title: Specifying the Cash on Delivery Option in Shipping Details

  RequiredInput: No
#    Argument: 'ns:AmountType'

getCODCost()

# Returns: 'ns:AmountType'

setCheckoutMethod()

Not supported.

  RequiredInput: No
#    Argument: 'ns:CheckoutMethodCodeType'

getCheckoutMethod()

# Returns: 'ns:CheckoutMethodCodeType'

setCheckoutStatus()

The current status of the checkout process for the transaction.

  RequiredInput: Yes
#    Argument: 'ns:CompleteStatusCodeType'

getCheckoutStatus()

# Returns: 'ns:CompleteStatusCodeType'

setEncryptedID()

Not supported.

MaxLength: 20

  RequiredInput: No
#    Argument: 'xs:string'

getEncryptedID()

# Returns: 'xs:string'

setExternalTransaction()

Not supported.

  RequiredInput: No
#    Argument: 'ns:ExternalTransactionType'

getExternalTransaction()

# Returns: 'ns:ExternalTransactionType'

setInsuranceType()

The insurance option selected by the buyer.

  RequiredInput: No
#    Argument: 'ns:InsuranceSelectedCodeType'

getInsuranceType()

# Returns: 'ns:InsuranceSelectedCodeType'

setItemID()

Unique ID for the item associated with the checkout. A transaction is uniquely identified by one of two means: (a) You provide a TransactionID and ItemID. (This is the preferred approach.), OR, (b) You provide a BuyerID and ItemID and eBay identifies only one transaction for that combination (an error is returned if there are multiple transactions for that combination). Note: If all three are provided (that is, BuyerID, ItemID and TransactionID), BuyerID is ignored.

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'

setMultipleSellerPaymentID()

Not supported.

  RequiredInput: No
#    Argument: 'xs:string'

getMultipleSellerPaymentID()

# Returns: 'xs:string'

setOrderID()

Unique ID for a multi-item order. If specified, ItemID and TransactionID are ignored if specified in the same call. Changes to the checkout status are applied to the specified order as a whole (and thus the child transactions associated with the order).

  RequiredInput: No
#    Argument: 'xs:string'

getOrderID()

# Returns: 'xs:string'

setPaymentMethodUsed()

Payment method used by the buyer. Required if CheckoutStatus is Complete. (Please note that only PayPal can set this value to PayPal.) <br> <span class="tablenote"><b>Note:</b> Required or allowed payment methods vary by site and category. Refer to <a href="http://developer.ebay.com/DevZone/XML/docs/WebHelp/wwhelp/wwhimpl/js/html/wwhelp.htm?context=eBay_XML_API&topic=PaymentMethodDifferences"> Payment Method Differences (PaymentMethod)</a> in the eBay Trading API Guide for information to help you determine which payment methods you are required or allowed to specify. </span><br> <br>

AllValuesExcept: PayPal

  RequiredInput: Conditionally
#    Argument: 'ns:BuyerPaymentMethodCodeType'

getPaymentMethodUsed()

# Returns: 'ns:BuyerPaymentMethodCodeType'

setPaymentStatus()

Not supported.

  RequiredInput: No
#    Argument: 'ns:RCSPaymentStatusCodeType'

getPaymentStatus()

# Returns: 'ns:RCSPaymentStatusCodeType'

setSalesTax()

Amount of money paid for sales tax. For Third-Party Checkout applications.

  RequiredInput: No
#    Argument: 'ns:AmountType'

getSalesTax()

# Returns: 'ns:AmountType'

setShippingAddress()

For internal use.

  RequiredInput: No
#    Argument: 'ns:AddressType'

getShippingAddress()

# Returns: 'ns:AddressType'

setShippingCost()

Amount of money paid for shipping. For Third-party Checkout applications.

  RequiredInput: No
#    Argument: 'ns:AmountType'

getShippingCost()

# Returns: 'ns:AmountType'

setShippingIncludedInTax()

An indicator of whether shipping costs were included in the taxable amount. For Third-Party Checkout applications.

Default: false

  RequiredInput: No
#    Argument: 'xs:boolean'

isShippingIncludedInTax()

# Returns: 'xs:boolean'

setShippingInsuranceCost()

Amount of money paid for insurance. For Third Party Checkout applications.

  RequiredInput: No
#    Argument: 'ns:AmountType'

getShippingInsuranceCost()

# Returns: 'ns:AmountType'

setShippingService()

The shipping service selected by the buyer from among the shipping services offered by the seller (such as UPS Ground). For a list of valid values that you can cache for future use, call GeteBayDetails with DetailName set to ShippingServiceDetails.

  RequiredInput: No
#    Argument: 'xs:token'

getShippingService()

# Returns: 'xs:token'

setTransactionID()

Unique ID for the transaction associated with the checkout. For Chinese auctions, the value passed in the TransactionID argument must be 0 or the call will fail with an error. For all other auction types, TransactionID accepts the actual, nonzero transaction ID. Call GetItemTransactionsCall or GetSellerTransactionsCall to determine the correct transaction ID. A transaction is uniquely identified by one of two means: (a) You provide a TransactionID and ItemID. (This is the preferred approach.), OR, (b) You provide a BuyerID and ItemID and eBay identifies only one transaction for that combination (an error is returned if there are multiple transactions for that combination). Note: If all three are provided (that is, BuyerID, ItemID and TransactionID), BuyerID is ignored.

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

  RequiredInput: Conditionally
#    Argument: 'xs:string'

getTransactionID()

# Returns: 'xs:string'

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

package eBay::API::XML::Call::ReviseCheckoutStatus::ReviseCheckoutStatusRequestType;

use strict;
use warnings;  

##########################################################################
#
# Module: ............... <user defined location>eBay/API/XML
# File: ................. ReviseCheckoutStatusRequestType.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::AddressType;
use eBay::API::XML::DataType::AmountType;
use eBay::API::XML::DataType::ExternalTransactionType;
use eBay::API::XML::DataType::ItemIDType;
use eBay::API::XML::DataType::Enum::BuyerPaymentMethodCodeType;
use eBay::API::XML::DataType::Enum::CheckoutMethodCodeType;
use eBay::API::XML::DataType::Enum::CompleteStatusCodeType;
use eBay::API::XML::DataType::Enum::InsuranceSelectedCodeType;
use eBay::API::XML::DataType::Enum::RCSPaymentStatusCodeType;


my @gaProperties = ( [ 'AdjustmentAmount', 'ns:AmountType', ''
	     ,'eBay::API::XML::DataType::AmountType', '1' ]
	, [ 'AmountPaid', 'ns:AmountType', ''
	     ,'eBay::API::XML::DataType::AmountType', '1' ]
	, [ 'BuyerID', 'xs:string', '', '', '' ]
	, [ 'CODCost', 'ns:AmountType', ''
	     ,'eBay::API::XML::DataType::AmountType', '1' ]
	, [ 'CheckoutMethod', 'ns:CheckoutMethodCodeType', ''
	     ,'eBay::API::XML::DataType::Enum::CheckoutMethodCodeType', '' ]
	, [ 'CheckoutStatus', 'ns:CompleteStatusCodeType', ''
	     ,'eBay::API::XML::DataType::Enum::CompleteStatusCodeType', '' ]
	, [ 'EncryptedID', 'xs:string', '', '', '' ]
	, [ 'ExternalTransaction', 'ns:ExternalTransactionType', ''
	     ,'eBay::API::XML::DataType::ExternalTransactionType', '1' ]
	, [ 'InsuranceType', 'ns:InsuranceSelectedCodeType', ''
	     ,'eBay::API::XML::DataType::Enum::InsuranceSelectedCodeType', '' ]
	, [ 'ItemID', 'ns:ItemIDType', ''
	     ,'eBay::API::XML::DataType::ItemIDType', '1' ]
	, [ 'MultipleSellerPaymentID', 'xs:string', '', '', '' ]
	, [ 'OrderID', 'xs:string', '', '', '' ]
	, [ 'PaymentMethodUsed', 'ns:BuyerPaymentMethodCodeType', ''
	     ,'eBay::API::XML::DataType::Enum::BuyerPaymentMethodCodeType', '' ]
	, [ 'PaymentStatus', 'ns:RCSPaymentStatusCodeType', ''
	     ,'eBay::API::XML::DataType::Enum::RCSPaymentStatusCodeType', '' ]
	, [ 'SalesTax', 'ns:AmountType', ''
	     ,'eBay::API::XML::DataType::AmountType', '1' ]
	, [ 'ShippingAddress', 'ns:AddressType', ''
	     ,'eBay::API::XML::DataType::AddressType', '1' ]
	, [ 'ShippingCost', 'ns:AmountType', ''
	     ,'eBay::API::XML::DataType::AmountType', '1' ]
	, [ 'ShippingIncludedInTax', 'xs:boolean', '', '', '' ]
	, [ 'ShippingInsuranceCost', 'ns:AmountType', ''
	     ,'eBay::API::XML::DataType::AmountType', '1' ]
	, [ 'ShippingService', 'xs:token', '', '', '' ]
	, [ '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 setAdjustmentAmount {
  my $self = shift;
  $self->{'AdjustmentAmount'} = shift
}


sub getAdjustmentAmount {
  my $self = shift;
  return $self->_getDataTypeInstance( 'AdjustmentAmount'
		,'eBay::API::XML::DataType::AmountType');
}



sub setAmountPaid {
  my $self = shift;
  $self->{'AmountPaid'} = shift
}


sub getAmountPaid {
  my $self = shift;
  return $self->_getDataTypeInstance( 'AmountPaid'
		,'eBay::API::XML::DataType::AmountType');
}



sub setBuyerID {
  my $self = shift;
  $self->{'BuyerID'} = shift
}


sub getBuyerID {
  my $self = shift;
  return $self->{'BuyerID'};
}



sub setCODCost {
  my $self = shift;
  $self->{'CODCost'} = shift
}


sub getCODCost {
  my $self = shift;
  return $self->_getDataTypeInstance( 'CODCost'
		,'eBay::API::XML::DataType::AmountType');
}



sub setCheckoutMethod {
  my $self = shift;
  $self->{'CheckoutMethod'} = shift
}


sub getCheckoutMethod {
  my $self = shift;
  return $self->{'CheckoutMethod'};
}



sub setCheckoutStatus {
  my $self = shift;
  $self->{'CheckoutStatus'} = shift
}


sub getCheckoutStatus {
  my $self = shift;
  return $self->{'CheckoutStatus'};
}



sub setEncryptedID {
  my $self = shift;
  $self->{'EncryptedID'} = shift
}


sub getEncryptedID {
  my $self = shift;
  return $self->{'EncryptedID'};
}



sub setExternalTransaction {
  my $self = shift;
  $self->{'ExternalTransaction'} = shift
}


sub getExternalTransaction {
  my $self = shift;
  return $self->_getDataTypeInstance( 'ExternalTransaction'
		,'eBay::API::XML::DataType::ExternalTransactionType');
}



sub setInsuranceType {
  my $self = shift;
  $self->{'InsuranceType'} = shift
}


sub getInsuranceType {
  my $self = shift;
  return $self->{'InsuranceType'};
}



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


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



sub setMultipleSellerPaymentID {
  my $self = shift;
  $self->{'MultipleSellerPaymentID'} = shift
}


sub getMultipleSellerPaymentID {
  my $self = shift;
  return $self->{'MultipleSellerPaymentID'};
}



sub setOrderID {
  my $self = shift;
  $self->{'OrderID'} = shift
}


sub getOrderID {
  my $self = shift;
  return $self->{'OrderID'};
}



sub setPaymentMethodUsed {
  my $self = shift;
  $self->{'PaymentMethodUsed'} = shift
}


sub getPaymentMethodUsed {
  my $self = shift;
  return $self->{'PaymentMethodUsed'};
}



sub setPaymentStatus {
  my $self = shift;
  $self->{'PaymentStatus'} = shift
}


sub getPaymentStatus {
  my $self = shift;
  return $self->{'PaymentStatus'};
}



sub setSalesTax {
  my $self = shift;
  $self->{'SalesTax'} = shift
}


sub getSalesTax {
  my $self = shift;
  return $self->_getDataTypeInstance( 'SalesTax'
		,'eBay::API::XML::DataType::AmountType');
}



sub setShippingAddress {
  my $self = shift;
  $self->{'ShippingAddress'} = shift
}


sub getShippingAddress {
  my $self = shift;
  return $self->_getDataTypeInstance( 'ShippingAddress'
		,'eBay::API::XML::DataType::AddressType');
}



sub setShippingCost {
  my $self = shift;
  $self->{'ShippingCost'} = shift
}


sub getShippingCost {
  my $self = shift;
  return $self->_getDataTypeInstance( 'ShippingCost'
		,'eBay::API::XML::DataType::AmountType');
}



sub setShippingIncludedInTax {
  my $self = shift;
  $self->{'ShippingIncludedInTax'} = shift
}


sub isShippingIncludedInTax {
  my $self = shift;
  return $self->{'ShippingIncludedInTax'};
}



sub setShippingInsuranceCost {
  my $self = shift;
  $self->{'ShippingInsuranceCost'} = shift
}


sub getShippingInsuranceCost {
  my $self = shift;
  return $self->_getDataTypeInstance( 'ShippingInsuranceCost'
		,'eBay::API::XML::DataType::AmountType');
}



sub setShippingService {
  my $self = shift;
  $self->{'ShippingService'} = shift
}


sub getShippingService {
  my $self = shift;
  return $self->{'ShippingService'};
}



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;