NAME

eBay::API::XML::DataType::InternationalShippingServiceOptionsType

DESCRIPTION

Shipping costs and options related to an international shipping service. When used as input, if one is provided, at least one domestic ShippingService must be provided.

SYNOPSIS

INHERITANCE

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

Subroutines:

setShipToLocation()

An international location or region to which the item may be shipped via this particular shipping service. Associated with the shipping service by the seller. Use GeteBayDetails to determine which locations are valid per site. These values are string equivalents of values found in ShippingRegionCodeType and CountryCodeType. For the AddItem family of calls, this field is required if any international shipping service has been specified.

SeeLink: URL: http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=ShipToLocation Title: ShipToLocation

            

              
              
Calls: SendInvoice
RequiredInput: No
Calls: AddItem
       GetItemRecommendations
       AddOrder
       RelistItem
       ReviseItem
       VerifyAddItem
RequiredInput: Conditionally
            
          

# Argument: reference to an array of 'xs:string'

getShipToLocation()

            

              
              
Calls: GetSellerList
Returned: Conditionally
Details: DetailLevel: ItemReturnDescription, ReturnAll
Calls: GetBidderList
       GetItemShipping
Returned: Conditionally
Calls: GetItem
Returned: Conditionally
Details: DetailLevel: none, ItemReturnDescription,
                                        ItemReturnAttributes, ReturnAll
Calls: GetOrders
Returned: Conditionally
Details: DetailLevel: none
Calls: GetOrderTransactions
Returned: Conditionally
Details: DetailLevel: none, ItemReturnDescription, ReturnAll
Calls: GetItemTransactions
Returned: Conditionally
Details: DetailLevel: none, ReturnAll
            
          

# Returns: reference to an array of 'xs:string'

setShippingInsuranceCost()

The insurance cost associated with shipping a single item with this shipping service. Exception: for GetItemShipping, this is proportional to QuantitySold. If the item has not yet been sold, insurance information cannot be calculated and the value is 0.00. For calculated shipping only. Also applicable to Half.com (for GetOrders).

SeeLink: URL: http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=Shipping Title: Shipping

            

              
              
Calls: AddOrder
       SendInvoice
RequiredInput: No
            
          

# Argument: 'ns:AmountType'

getShippingInsuranceCost()

            

              
              
Calls: GetItemShipping
Returned: Conditionally
Calls: GetOrders
Returned: Conditionally
Details: DetailLevel: none
Calls: GetOrderTransactions
Returned: Conditionally
Details: DetailLevel: none, ItemReturnDescription, ReturnAll
Calls: GetItemTransactions
       GetSellerTransactions
Returned: Conditionally
Details: DetailLevel: none, ReturnAll
            
          

# Returns: 'ns:AmountType'

setShippingService()

An international shipping service offered for shipping the item. For a list of valid values that you can cache for future use, call GeteBayDetails with DetailName set to ShippingServiceDetails. For flat and calculated shipping.

SeeLink: URL: http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=GeteBayDetails Title: GeteBayDetails

            

              
              
Calls: SendInvoice
RequiredInput: No
Calls: AddItem
       AddOrder
       GetItemRecommendations
       RelistItem
       ReviseItem
       VerifyAddItem
RequiredInput: Conditionally
            
          

# Argument: 'xs:token'

getShippingService()

            

              
              
Calls: GetSellerList
Returned: Conditionally
Details: DetailLevel: ItemReturnDescription, ReturnAll
Calls: GetBidderList
       GetItemShipping
Returned: Conditionally
Calls: GetItem
Returned: Conditionally
Details: DetailLevel: none, ItemReturnDescription,
                                        ItemReturnAttributes, ReturnAll
Calls: GetOrders
Returned: Conditionally
Details: DetailLevel: none
Calls: GetOrderTransactions
Returned: Conditionally
Details: DetailLevel: none, ItemReturnDescription, ReturnAll
Calls: GetItemTransactions
Returned: Conditionally
Details: DetailLevel: none, ReturnAll
            
          

# Returns: 'xs:token'

setShippingServiceAdditionalCost()

Cost of shipping each additional item beyond the first item. Should be zero for single-item listings. Default value is 0.00. For flat shipping only.

            

              
              
Calls: SendInvoice
RequiredInput: No
Calls: AddItem
       GetItemRecommendations
       AddOrder
       RelistItem
       ReviseItem
       VerifyAddItem
RequiredInput: No
            
          

# Argument: 'ns:AmountType'

getShippingServiceAdditionalCost()

            

              
              
Calls: GetSellerList
Returned: Conditionally
Details: DetailLevel: ItemReturnDescription, ReturnAll
Calls: GetItem
Returned: Conditionally
Details: DetailLevel: none, ItemReturnDescription,
                                        ItemReturnAttributes, ReturnAll
Calls: GetBidderList
       GetItemShipping
Returned: Conditionally
Calls: GetOrders
Returned: Conditionally
Details: DetailLevel: none
Calls: GetOrderTransactions
Returned: Conditionally
Details: DetailLevel: none, ItemReturnDescription, ReturnAll
Calls: GetItemTransactions
Returned: Conditionally
Details: DetailLevel: none, ReturnAll
            
          

# Returns: 'ns:AmountType'

setShippingServiceCost()

The meaning of this element depends on the call and on whether flat or calculated shipping has been selected. (For example, it could be the cost to ship a single item, the cost to ship all items, or the cost to ship just the first of many items, with ShippingServiceAdditionalCost accounting for the rest.) When returned by GetItemShipping, it includes the packaging and handling cost. For flat and calculated shipping.

SeeLink: URL: http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=Shipping Title: Shipping

            

              
              
Calls: SendInvoice
RequiredInput: No
Calls: AddItem
       GetItemRecommendations
       AddOrder
       RelistItem
       ReviseItem
       VerifyAddItem
RequiredInput: Conditionally
            
          

# Argument: 'ns:AmountType'

getShippingServiceCost()

            

              
              
Calls: GetSellerList
Returned: Conditionally
Details: DetailLevel: ItemReturnDescription, ReturnAll
Calls: GetItem
Returned: Conditionally
Details: DetailLevel: none, ItemReturnDescription,
                                        ItemReturnAttributes, ReturnAll
Calls: GetBidderList
       GetItemShipping
Returned: Conditionally
Calls: GetOrders
Returned: Conditionally
Details: DetailLevel: none
Calls: GetOrderTransactions
Returned: Conditionally
Details: DetailLevel: none, ItemReturnDescription, ReturnAll
Calls: GetItemTransactions
Returned: Conditionally
Details: DetailLevel: none, ReturnAll
            
          

# Returns: 'ns:AmountType'

setShippingServicePriority()

Seller-preferred presentation order relative to other service options. Valid values are: 1, 2 and 3 (first, second and third choices). For flat and calculated shipping.

            

              
              
Calls: SendInvoice
RequiredInput: No
Calls: AddItem
       GetItemRecommendations
       AddOrder
       RelistItem
       ReviseItem
       VerifyAddItem
RequiredInput: Conditionally
            
          

# Argument: 'xs:int'

getShippingServicePriority()

            

              
              
Calls: GetSellerList
Returned: Conditionally
Details: DetailLevel: ItemReturnDescription, ReturnAll
Calls: GetBidderList
       GetItemShipping
Returned: Conditionally
Calls: GetItem
Returned: Conditionally
Details: DetailLevel: none, ItemReturnDescription,
                                        ItemReturnAttributes, ReturnAll
Calls: GetOrders
Returned: Conditionally
Details: DetailLevel: none
Calls: GetOrderTransactions
Returned: Conditionally
Details: DetailLevel: none, ItemReturnDescription, ReturnAll
Calls: GetItemTransactions
Returned: Conditionally
Details: DetailLevel: none, ReturnAll
            
          

# Returns: 'xs:int'

cpanm eBay::API

perl -MCPAN -e shell
install eBay::API