The London Perl and Raku Workshop takes place on 26th Oct 2024. If your company depends on Perl, please consider sponsoring and/or attending.
 / 
eBay-API-0.25
River stage zero No dependents
/ eBay::API::XML::DataType::ShippingDetailsType

NAME

eBay::API::XML::DataType::ShippingDetailsType

DESCRIPTION

Type for the shipping-related details for an item or transaction, including flat and calculated shipping costs and shipping insurance costs.

SYNOPSIS

INHERITANCE

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

Subroutines:

setAllowPaymentEdit()

Instead of using this tag, see the PaymentEdited tag. Originally, the AllowPaymentEdit tag specified whether the seller allows the buyer to edit the payment amount for the transaction. (Sellers enabled this property in their My eBay user preferences on the eBay site.) ShippingDetails.AllowPaymentEdit is no longer being populated by calls to GetItemTransactions. Not applicable to Half.com.

# Argument: 'xs:boolean'

isAllowPaymentEdit()

Calls: GetBidderList
Returned: Conditionally

Calls: GetSellerList
Returned: Conditionally
Details: DetailLevel: ItemReturnDescription, ReturnAll

Calls: GetOrderTransactions
Returned: Conditionally
Details: DetailLevel: none, ItemReturnDescription, ReturnAll

Calls: GetItem
Returned: Conditionally
Details: DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll

# Returns: 'xs:boolean'

setApplyShippingDiscount()

Whether the seller specifies that a shipping discount is to be applied (in the event that an item's transaction is later combined with others into a single order). Not applicable to Half.com.

# Argument: 'xs:boolean'

isApplyShippingDiscount()

Calls: GetSellerList
Returned: Conditionally
Details: DetailLevel: ItemReturnDescription, ReturnAll
         GranularityLevel: Fine


Calls: GetBidderList
Returned: Conditionally

Calls: GetItem
Returned: Conditionally
Details: DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll

# Returns: 'xs:boolean'

setCODCost()

Italy site (site ID 101) only. Contains 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

Calls: AddItem
       RelistItem
       ReviseItem
       VerifyAddItem
       AddOrder
RequiredInput: Conditionally

# Argument: 'ns:AmountType'

getCODCost()

Calls: GetItemShipping
Returned: Conditionally

Calls: GetItem
Returned: Conditionally
Details: DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll

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

Calls: GetOrders
Returned: Conditionally
Details: DetailLevel: none

Calls: GetOrderTransactions
Returned: Conditionally
Details: DetailLevel: none, ItemReturnDescription, ReturnAll
ExcludeFromContext: Transaction
Context: Order

# Returns: 'ns:AmountType'

setCalculatedShippingDiscount()

If a calculated shipping discount was offered for the domestic shipping services, this contains the details of the calculated shipping discount. Otherwise, it is not returned. Only returned if the calling user is the seller.

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

# Argument: 'ns:CalculatedShippingDiscountType'

getCalculatedShippingDiscount()

Calls: GetItem
Returned: Conditionally
Details: DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll

# Returns: 'ns:CalculatedShippingDiscountType'

setCalculatedShippingRate()

Details pertinent to one or more items for which calculated shipping has been offered by the seller, such as package dimension and weight and packaging/handling costs. Not applicable to Half.com or eBay Motors vehicle listings. If your call may specify a large-dimension item listed with UPS, see <a href="http://ebay.custhelp.com/cgi-bin/ebay.cfg/php/enduser/std_adp.php?p_faqid=1159">Dimensional Weight limit on UPS shipping services results in failure of shipping calculator</a>. For Germany and the UK, this field is ignored when Item.ListingType=Express. <p></p> <span class="tablenote"><b>Note:</b> At the end of April 2008, UK and Germany eBay Express will be shutdown. No users will be eligible to list on these sites. All users previously registered on UK and Germany Express will have their registered status revoked. Any Express only items listed on these sites will be ended and credited the full insertion fee to their sellers. Please refer to the respective Express sites for more information. </span>

Calls: AddItem
       GetItemRecommendations
       RelistItem
       ReviseItem
       VerifyAddItem
RequiredInput: Conditionally

# Argument: 'ns:CalculatedShippingRateType'

getCalculatedShippingRate()

Calls: GetItem
Returned: Conditionally
Details: DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll

Calls: GetSellerList
Returned: Conditionally
Details: DetailLevel: ItemReturnDescription, ReturnAll

Calls: GetItemShipping
Returned: Conditionally

Calls: GetItemTransactions
       GetSellerTransactions
Returned: Conditionally
Details: DetailLevel: none, ReturnAll

# Returns: 'ns:CalculatedShippingRateType'

setChangePaymentInstructions()

Whether the seller specified payment and shipping instructions during checkout (for example, to update the details of a transaction). Flat and calculated shipping. Not applicable to Half.com.

# Argument: 'xs:boolean'

isChangePaymentInstructions()

Calls: GetItemShipping
Returned: Conditionally

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

Calls: GetOrderTransactions
Returned: Conditionally
Details: DetailLevel: none, ItemReturnDescription, ReturnAll

# Returns: 'xs:boolean'

setDefaultShippingCost()

The default shipping cost for the item. If the seller specified multiple shipping services, this is the "first" shipping service as specified by the seller when they listed the item. <br> <br> For GetSearchResults:<br> If ShippingType has the value Flat, then the actual shipping cost is shown. If ShippingType has the value Free, then zero is shown. If ShippingType has the value Calculated, then this tag (DefaultShippingCost) is not shown. If ShippingType has the value NotSpecified, then this tag (DefaultShippingCost) is not shown. If ShippingType has the value Freight, then this tag (DefaultShippingCost) is not shown. <br> <br> In GetSearchResultsExpress:<br> If flat shipping was specified or the shipping cost is 0.00 (free) for the item, then the actual shipping cost is shown. If calculated shipping was specified for the item, then this tag (DefaultShippingCost) is only shown if PostalCode is specified in the GetSearchResultsExpress request. Otherwise, ShippingRateErrorMessage is returned with a message that the postal code is required for the shipping calculation. Only returned when ItemDetails is set to Fine. <br> <br> Not applicable to Half.com.

# Argument: 'ns:AmountType'

getDefaultShippingCost()

Calls: GetProducts
Returned: Conditionally

Calls: GetSearchResults
Returned: Conditionally
Details: DetailLevel: ItemReturnAttributes, ItemReturnCategories, none, ReturnAll
         GranularityLevel: Coarse

# Returns: 'ns:AmountType'

setFlatShippingDiscount()

If a flat rate shipping discount was offered for the domestic shipping services, this contains the details of the flat rate shipping discount. Otherwise, it is not returned. Only returned if the calling user is the seller.

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

# Argument: 'ns:FlatShippingDiscountType'

getFlatShippingDiscount()

Calls: GetItem
Returned: Conditionally
Details: DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll

# Returns: 'ns:FlatShippingDiscountType'

setGetItFast()

Indicates whether the seller has opted the listing into the Get It Fast feature. If GetItFast is true and if at least one of the domestic shipping services offered by the seller is an expedited shipping service, every shipping service offered by the seller is considered a Get It Fast service, and the seller commits to delivering the item to the buyer-selected shipping service within one day. Also applicable to Half.com (for GetOrders).

# Argument: 'xs:boolean'

isGetItFast()

  Calls: GetBidderList
         GetItemShipping
  Returned: Conditionally

  Calls: GetItem
  Returned: Conditionally
  Details: DetailLevel: none, ItemReturnDescription,
						ItemReturnAttributes, ReturnAll

  Calls: GetItemTransactions
         GetSellerTransactions
  Returned: Conditionally
  Details: DetailLevel: none, ReturnAll

  Calls: GetOrders
  Returned: Always
  Details: DetailLevel: none

  Calls: GetOrderTransactions
  Returned: Always
  Details: DetailLevel: none, ItemReturnDescription, ReturnAll

# Returns: 'xs:boolean'

setInsuranceDetails()

Container for domestic insurance information. (Note that there are fields named InsuranceFee and InsuranceOption at the same level as this container. These were once used for representing both domestic and international insurance details.) If this (newer) container is provided on input and if ShippingDetails.InsuranceFee or ShippingDetails.InsuranceOption are also provided, those two (older fields) are ignored. If this container is omitted on input, its InsuranceFee and InsuranceOption subfields are set to match whatever (the older fields) ShippingDetails.InsuranceFee and ShippingDetails.InsuranceOption are set to. For flat and calculated shipping, depending on which subfields are used.

Calls: AddItem
       RelistItem
       ReviseItem
       VerifyAddItem
RequiredInput: No

# Argument: 'ns:InsuranceDetailsType'

getInsuranceDetails()

Calls: GetBidderList
Returned: Conditionally

Calls: GetItem
Returned: Always
Details: DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll

# Returns: 'ns:InsuranceDetailsType'

setInsuranceFee()

Cost of shipping insurance set by the seller. If the buyer bought more than one of this item, this is the insurance for just a single item. Exception: for GetItemShipping, this is proportional to QuantitySold. Value should be greater than 0.00 if InsuranceOption is Optional or Required. For flat shipping only. Optional as input and only allowed if ChangePaymentInstructions is true. This field is ignored when InsuranceOption is not specified in the request. This field is ignored when Item.ListingType=Express. <br> <br> Applicable to Half.com for GetOrders. Not applicable to eBay Motors vehicle listings.

Max: Default: 0.00 Min: Calls: AddItem GetItemRecommendations AddOrder RelistItem ReviseItem VerifyAddItem RequiredInput: No

# Argument: 'ns:AmountType'

getInsuranceFee()

Calls: GetBidderList
       GetItemShipping
Returned: Conditionally

Calls: GetItem
Returned: Conditionally
Details: DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll

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

Calls: GetOrders
Returned: Always
Details: DetailLevel: none

Calls: GetOrderTransactions
Returned: Always
Details: DetailLevel: none, ItemReturnDescription, ReturnAll
ExcludeFromContext: Transaction
Context: Order

# Returns: 'ns:AmountType'

setInsuranceOption()

Whether the seller offers shipping insurance and, if so, whether the insurance is optional or required. Flat and calculated shipping. Optional as input and only allowed if ChangePaymentInstructions is true. Also applicable to Half.com (for GetOrders). This field is ignored when Item.ListingType=Express. If this field is not included in the request, values specified in the InsuranceFee field will be ignored.

Calls: AddItem
       GetItemRecommendations
       AddOrder
       RelistItem
       ReviseItem
       VerifyAddItem
RequiredInput: No
AllValuesExcept: NotOfferedOnSite

# Argument: 'ns:InsuranceOptionCodeType'

getInsuranceOption()

Calls: GetBidderList
       GetItemShipping
Returned: Conditionally

Calls: GetSellerList
Returned: Conditionally
Details: DetailLevel: ItemReturnDescription, ReturnAll
         GranularityLevel: Fine


Calls: GetItem
Returned: Conditionally
Details: DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll

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

Calls: GetOrders
Returned: Always
Details: DetailLevel: none

Calls: GetOrderTransactions
Returned: Always
Details: DetailLevel: none, ItemReturnDescription, ReturnAll

# Returns: 'ns:InsuranceOptionCodeType'

setInsuranceWanted()

Whether the buyer selected to pay for insurance offered by the seller as an option. This only has a value after the buyer has gone through checkout and selected the insurance preference. Also applicable to Half.com (for GetOrders).

# Argument: 'xs:boolean'

isInsuranceWanted()

Calls: GetOrders
Returned: Always
Details: DetailLevel: none

Calls: GetOrderTransactions
Returned: Always
Details: DetailLevel: none, ItemReturnDescription, ReturnAll

Calls: GetItemShipping
Returned: Conditionally

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

# Returns: 'xs:boolean'

setInternationalCalculatedShippingDiscount()

If a calculated shipping discount was offered for the international shipping services, this contains the details of the calculated shipping discount. Otherwise, it is not returned. Only returned if the calling user is the seller.

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

# Argument: 'ns:CalculatedShippingDiscountType'

getInternationalCalculatedShippingDiscount()

Calls: GetItem
Returned: Conditionally
Details: DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll

# Returns: 'ns:CalculatedShippingDiscountType'

setInternationalFlatShippingDiscount()

If a flat rate shipping discount was offered for the international shipping services, this contains the details of the flat rate shipping discount. Otherwise, it is not returned. Only returned if the calling user is the seller.

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

# Argument: 'ns:FlatShippingDiscountType'

getInternationalFlatShippingDiscount()

Calls: GetItem
Returned: Conditionally
Details: DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll

# Returns: 'ns:FlatShippingDiscountType'

setInternationalInsuranceDetails()

Container for international insurance information. (Note that there are fields named InsuranceFee and InsuranceOption at the same level as this container. These were once used for representing both domestic and international insurance details.) If this (newer) container is provided on input and if ShippingDetails.InsuranceFee or ShippingDetails.InsuranceOption are also provided, those two (older fields) are ignored. If this container is omitted on input, its InsuranceFee and InsuranceOption subfields are set to match whatever (the older fields) ShippingDetails.InsuranceFee and ShippingDetails.InsuranceOption are set to. For flat and calculated shipping, depending on which subfields are used.

Calls: AddItem
       RelistItem
       ReviseItem
       VerifyAddItem
RequiredInput: No

# Argument: 'ns:InsuranceDetailsType'

getInternationalInsuranceDetails()

Calls: GetBidderList
Returned: Conditionally

Calls: GetItem
Returned: Always
Details: DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll

# Returns: 'ns:InsuranceDetailsType'

setInternationalPromotionalShippingDiscount()

On input, this specifies whether to offer the promotional shipping discount for the international shipping services of this listing (only applicable if the seller has a promotional shipping discount in effect at the moment). On output, this indicates whether the promotional shipping discount is being offered for the international shipping services of this listing (if the listing is still active--this is only possible if the seller has a promotional shipping discount in effect at the moment) or whether the discount was offered at the time the listing ended. Only returned if the calling user is the seller.

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

Calls: AddItem
       RelistItem
       ReviseItem
       VerifyAddItem
RequiredInput: Conditionally

# Argument: 'xs:boolean'

isInternationalPromotionalShippingDiscount()

Calls: GetItem
Returned: Conditionally
Details: DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll

# Returns: 'xs:boolean'

setInternationalShippingDiscountProfileID()

On input, this is the ID of the shipping discount to offer for the international shipping services (where the shipping discount is either of type FlatShippingDiscount or CalculatedShippingDiscount). On output, this is the ID of the shipping discount offered and corresponds to whichever is returned: FlatShippingDiscount or CalculatedShippingDiscount. Only returned if the calling user is the seller.

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

Calls: AddItem
       RelistItem
       ReviseItem
       VerifyAddItem
RequiredInput: Conditionally

# Argument: 'xs:string'

getInternationalShippingDiscountProfileID()

Calls: GetItem
Returned: Conditionally
Details: DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll

# Returns: 'xs:string'

setInternationalShippingServiceOption()

Shipping costs and options related to an international shipping service. If used, at least one domestic shipping service must also be provided in ShippingServiceOptions.<br> <br> If you specify multiple InternationalShippingServiceOption nodes, the repeating nodes must be contiguous. That is, you cannot insert other nodes between InternationalShippingServiceOption nodes.<br> <br> If you specify ShippingDetails when you revise or relist an item but you omit InternationalShippingServiceOption, eBay will drop the international shipping services from the listing. This may also have unintended side effects, as other fields that depend on this data may be dropped as well. To retain the shipping services and dependent fields when you modify other shipping details, it may be simplest to specify all ShippingDetails that you still want to include in the listing.<br> <br> Not applicable to Half.com or eBay Motors vehicle listings. This field is ignored when Item.ListingType=Express.

SeeLink: URL: http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=SchemaOverview For: rules regarding repeating instances of a nodes (nodes for which maxOccurs is "unbounded" or is greater than 1) Title: Overview of the API Schema

Calls: AddItem
       AddOrder
       GetItemRecommendations
       RelistItem
       ReviseItem
       VerifyAddItem
RequiredInput: No

# Argument: reference to an array of 'ns:InternationalShippingServiceOptionsType'

getInternationalShippingServiceOption()

  Calls: GetBidderList
         GetItemShipping
  Returned: Conditionally

  Calls: GetItem
  Returned: Conditionally
  Details: DetailLevel: none, ItemReturnDescription,
							ItemReturnAttributes, ReturnAll

  Calls: GetSellerList
  Returned: Conditionally
  Details: DetailLevel: ItemReturnDescription, ReturnAll

  Calls: GetItemTransactions
  Returned: Conditionally
  Details: DetailLevel: none, ReturnAll

  Calls: GetOrders
  Returned: Conditionally
  Details: DetailLevel: none

  Calls: GetOrderTransactions
  Returned: Conditionally
  Details: DetailLevel: none, ItemReturnDescription, ReturnAll

# Returns: reference to an array of 'ns:InternationalShippingServiceOptionsType'

setPaymentEdited()

Whether the seller allows the buyer to edit the payment amount for the transaction. (Sellers enable this property in their My eBay user preferences on the eBay site.) Not applicable to Half.com.

# Argument: 'xs:boolean'

isPaymentEdited()

Calls: GetItemShipping
Returned: Conditionally

Calls: GetSellerList
Returned: Conditionally
Details: DetailLevel: ItemReturnDescription, ReturnAll

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

# Returns: 'xs:boolean'

setPaymentInstructions()

Payment instructions/message from the seller to the buyer. These instructions appear on eBay's View Item page and on eBay's checkout page when the buyer pays for the item. Sellers usually use this field to specify payment instructions, return policy details, how soon the item will shipped, feedback instructions, and other reminders that the buyer should be aware of when they bid on or buy an item. This field can be specified regardless of the shipping type. Some sites also let you specify a standard return policy by using Item.AttributeSetArray in addition or instead. eBay only allows 500 characters as input, but due to the way the eBay Web site UI treats characters, this field can return more than 500 characters in the response. Characters like & and ' (apostrophe/single quote) count as 5 characters each. To remove this value when revising or relisting an item, use DeletedField. Applicable to eBay Motors (usually used for the return policy). Not applicable to Half.com.

SeeLink: URL: http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=ReturnPolicy Title: Offering a Clear Return Policy , URL: io_AddItem.html#Request.Item.AttributeSetArray Title: (AddItem) Item.AttributeSetArray , URL: io_GetItem.html#Response.Item.AttributeSetArray Title: (GetItem) Item.AttributeSetArray

MaxLength: 1000

Calls: AddItem
       GetItemRecommendations
       RelistItem
       ReviseItem
       VerifyAddItem
RequiredInput: No

# Argument: 'xs:string'

getPaymentInstructions()

  Calls: GetBidderList
         GetItemShipping
  Returned: Conditionally

  Calls: GetItem
  Returned: Conditionally
  Details: DetailLevel: none, ItemReturnDescription,
						ItemReturnAttributes, ReturnAll

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

# Returns: 'xs:string'

setPromotionalShippingDiscount()

On input, this specifies whether to offer the promotional shipping discount for the domestic shipping services of this listing (only applicable if the seller has a promotional shipping discount in effect at the moment). On output, this indicates whether the promotional shipping discount is being offered for the domestic shipping services of this listing (if the listing is still active--this is only possible if the seller has a promotional shipping discount in effect at the moment) or whether the discount was offered at the time the listing ended. Only returned if the calling user is the seller.

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

Calls: AddItem
       RelistItem
       ReviseItem
       VerifyAddItem
RequiredInput: Conditionally

# Argument: 'xs:boolean'

isPromotionalShippingDiscount()

Calls: GetItem
Returned: Conditionally
Details: DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll

# Returns: 'xs:boolean'

setPromotionalShippingDiscountDetails()

Details of the promotional shipping discount, if such is being offered while the listing is active or was offered at the time the listing ended. Only returned if the calling user is the seller.

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

# Argument: 'ns:PromotionalShippingDiscountDetailsType'

getPromotionalShippingDiscountDetails()

Calls: GetShippingDiscountProfiles
Returned: Conditionally

Calls: GetItem
Returned: Conditionally
Details: DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll

# Returns: 'ns:PromotionalShippingDiscountDetailsType'

setSalesTax()

Sales tax details. US site only. Flat and calculated shipping. Also applicable to Half.com (for GetOrders). If your application normally calculates sales tax without using eBay's tax tables, you should understand how purchases via eBay Express will affect the way you process payments. For general information about listings on eBay Express, see the eBay Web Services Guide links below. Not applicable to eBay Motors vehicle listings.

SeeLink: URL: http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=SalesTax Title: Enabling Multi-jurisdiction Sales Tax , URL: http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=ExpressTax Title: Specify Sales Tax for Express and eBay

Calls: AddItem
       AddOrder
       GetItemRecommendations
       RelistItem
       ReviseItem
       VerifyAddItem
RequiredInput: No

# Argument: 'ns:SalesTaxType'

getSalesTax()

Calls: GetSellerList
Returned: Conditionally
Details: DetailLevel: ItemReturnDescription, ReturnAll
         GranularityLevel: Fine


Calls: GetBidderList
       GetItemShipping
Returned: Conditionally

Calls: GetItem
Returned: Conditionally
Details: DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll

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

Calls: GetOrders
Returned: Always
Details: DetailLevel: none

Calls: GetOrderTransactions
Returned: Always
Details: DetailLevel: none, ItemReturnDescription, ReturnAll

# Returns: 'ns:SalesTaxType'

setSellingManagerSalesRecordNumber()

Applicable to Selling Manager Pro sellers. Also applicable to Half.com (for GetOrders). For GetOrders, the Transaction container includes this element within ShippingDetails.

# Argument: 'xs:int'

getSellingManagerSalesRecordNumber()

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

Calls: GetOrders
Returned: Conditionally
Details: DetailLevel: none

Calls: GetOrderTransactions
Returned: Conditionally
Details: DetailLevel: none, ItemReturnDescription, ReturnAll

# Returns: 'xs:int'

setShipmentTrackingNumber()

Shipment tracking number supplied by the shipping carrier. Not applicable to Half.com.

# Argument: 'xs:string'

getShipmentTrackingNumber()

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

# Returns: 'xs:string'

setShippingDiscountProfileID()

On input, this is the ID of the shipping discount to offer for the domestic shipping services (where the shipping discount is either of type FlatShippingDiscount or CalculatedShippingDiscount). On output, this is the ID of the shipping discount offered and corresponds to whichever is returned: FlatShippingDiscount or CalculatedShippingDiscount. Only returned if the calling user is the seller. Only returned if the calling user is the seller.

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

Calls: AddItem
       RelistItem
       ReviseItem
       VerifyAddItem
RequiredInput: Conditionally

# Argument: 'xs:string'

getShippingDiscountProfileID()

Calls: GetItem
Returned: Conditionally
Details: DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll

# Returns: 'xs:string'

setShippingRateErrorMessage()

For most applicable calls, returns the words No Error or returns an error message related to an attempt to calculate shipping rates. For calculated shipping only. Not applicable to Half.com or eBay Motors vehicle listings. <br> <br> GetSearchResultsExpress returns this when no PostalCode was specified in the request and the item was listed with calculated shipping rates. The message text explains that a postal code is needed to calculate shipping. Only returned when ItemDetails is set to Fine.

# Argument: 'xs:string'

getShippingRateErrorMessage()

Calls: GetItemShipping
Returned: Conditionally

Calls: GetItemTransactions
       GetSellerTransactions
Returned: Conditionally
Details: DetailLevel: none, ReturnAll

# Returns: 'xs:string'

setShippingRateType()

A shipping rate scale for shipping through UPS that affects the shipping cost calculated for UPS (lower if ShippingRateType is DailyPickup). ShippingRateType is only returned if ShippingService is one of the UPS shipping services. For calculated shipping only. Not applicable to Half.com or eBay Motors vehicle listings.

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

# Argument: 'ns:ShippingRateTypeCodeType'

getShippingRateType()

Calls: GetItemShipping
Returned: Conditionally

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

# Returns: 'ns:ShippingRateTypeCodeType'

setShippingServiceOptions()

Shipping costs and options related to domestic shipping services offered by the seller. Flat and calculated shipping. Required if InternationalShippingServiceOption is specified.<br> <br> If you specify multiple ShippingServiceOptions nodes, the repeating nodes must be contiguous. For example, you can insert InternationalShippingServiceOption nodes after a list of repeating ShippingServiceOptions nodes, but not between them:<br> <br> &lt;ShippingServiceOptions&gt;...&lt;/ShippingServiceOptions&gt;<br> &lt;ShippingServiceOptions&gt;...&lt;/ShippingServiceOptions&gt;<br> &lt;ShippingServiceOptions&gt;...&lt;/ShippingServiceOptions&gt;<br> &lt;InternationalShippingServiceOption&gt;...&lt;/InternationalShippingServiceOption&gt;<br> &lt;InternationalShippingServiceOption&gt;...&lt;/InternationalShippingServiceOption&gt;<br><br> <br> If you specify ShippingDetails when you revise or relist an item but you omit ShippingServiceOptions, eBay will drop the domestic shipping services from the listing. This may also have unintended side effects, as other fields that depend on this data may be dropped as well. To retain the shipping services and dependent fields when you modify other shipping details, it may be simplest to specify all ShippingDetails that you still want to include in the listing.<br> <br> Not applicable to Half.com or eBay Motors vehicle listings.

SeeLink: URL: http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=SchemaOverview For: rules regarding repeating instances of a nodes (nodes for which maxOccurs is "unbounded" or is greater than 1) Title: Overview of the API Schema

Calls: AddItem
       GetItemRecommendations
       RelistItem
       ReviseItem
       VerifyAddItem
RequiredInput: Conditionally

Calls: AddOrder
RequiredInput: No

# Argument: reference to an array of 'ns:ShippingServiceOptionsType'

getShippingServiceOptions()

Calls: GetItem
Returned: Always
Details: DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll

Calls: GetMyeBayBuying
Returned: Conditionally
Details: DetailLevel: none, ReturnSummary, ReturnAll
Context: BidList
         WonList
         WatchList
         DeletedFromWonList
         BestOfferList

Calls: GetMyeBaySelling
Returned: Conditionally
Details: DetailLevel: none, ReturnSummary, ReturnAll
Context: BidList
         ActiveList
         ScheduledList

Calls: GetSellerList
Returned: Conditionally
Details: DetailLevel: ItemReturnDescription, ReturnAll

Calls: GetItemShipping
Returned: Conditionally

Calls: GetItemTransactions
Returned: Conditionally
Details: DetailLevel: none, ReturnAll

Calls: GetOrders
Returned: Conditionally
Details: DetailLevel: none

Calls: GetOrderTransactions
Returned: Conditionally
Details: DetailLevel: none, ItemReturnDescription, ReturnAll

# Returns: reference to an array of 'ns:ShippingServiceOptionsType'

setShippingServiceUsed()

The shipping service that actually shipped the item(s). Not applicable to Half.com.

# Argument: 'xs:token'

getShippingServiceUsed()

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

# Returns: 'xs:token'

setShippingType()

The shipping cost model offered by the seller. This is not returned for various calls since shipping type can be deduced: if a CalculatedShippingRate structure is returned by the call, the shipping type is Calculated. Otherwise, it is one of the other non-Calculated shipping types. Not applicable to Half.com.

Calls: AddItem
       RelistItem
       ReviseItem
       VerifyAddItem
RequiredInput: No
AllValuesExcept: Free, Freight

Calls: GetItemRecommendations
RequiredInput: No
AllValuesExcept: Free, Freight

# Argument: 'ns:ShippingTypeCodeType'

getShippingType()

Calls: GetBidderList
Returned: Conditionally
AllValuesExcept: Free

Calls: GetProducts
Returned: Conditionally

Calls: GetSearchResults
Returned: Conditionally
Details: DetailLevel: ItemReturnAttributes, ItemReturnCategories, none, ReturnAll
         GranularityLevel: Coarse


Calls: GetItemTransactions
Returned: Conditionally
AllValuesExcept: Free, Freight
Details: DetailLevel: ItemReturnDescription, none, ReturnAll

Calls: GetSellerTransactions
Returned: Conditionally
AllValuesExcept: Free, Freight
Details: DetailLevel: ItemReturnDescription, none, ReturnAll

Calls: GetItem
Returned: Conditionally
AllValuesExcept: Free, Freight
Details: DetailLevel: ItemReturnAttributes, none, ReturnAll

# Returns: 'ns:ShippingTypeCodeType'

setTaxTable()

Tax details for a jurisdiction such as a state or province. If no tax table is associated with the item, no tax table is returned, even if IncludeTaxTable is set to true. <p> If a tax table is associated with the item: <br> - the tax table is returned if DetailLevel is ReturnAll or ItemReturnDescription (and the value of IncludeTaxTable does not matter) <br> - if no DetailLevel is specified or if DetailLevel is ItemReturnAttributes, the tax table is returned only if IncludeTaxTable is true <p> Not applicable to Half.com.

# Argument: 'ns:TaxTableType'

getTaxTable()

Calls: GetItem
Returned: Conditionally
Details: DetailLevel: ItemReturnDescription, ReturnAll

Calls: GetBidderList
       GetItemShipping
Returned: Conditionally

Calls: GetOrderTransactions
Returned: Conditionally
Details: DetailLevel: ReturnAll

Calls: GetSellerList
Returned: Conditionally
Details: DetailLevel: ItemReturnDescription, ReturnAll
         GranularityLevel: Coarse, Medium, Fine


Calls: GetItemTransactions
       GetSellerTransactions
Returned: Conditionally
Details: DetailLevel: none, ReturnAll

# Returns: 'ns:TaxTableType'

setThirdPartyCheckout()

Whether checkout for this is to be handled by a Third-Party Checkout application. The counterpart in the AddItem family of calls is Item.ThirdPartyCheckout. Not applicable to Half.com.

SeeLink: URL: http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=ThirdPartyCheckout Title: Third Party Checkout , URL: io_AddItem.html#Request.Item.ThirdPartyCheckout Title: (AddItem) Item.ThirdPartyCheckout

Calls: AddOrder
RequiredInput: No

# Argument: 'xs:boolean'

isThirdPartyCheckout()

  Calls: GetItem
  Returned: Always
  Details: DetailLevel: none, ItemReturnDescription,
						ItemReturnAttributes, ReturnAll

  Calls: GetSellerList
  Returned: Conditionally
  Details: DetailLevel: ItemReturnDescription, ReturnAll
           GranularityLevel: Fine


  Calls: GetBidderList
         GetItemShipping
  Returned: Conditionally

  Calls: GetItemTransactions
         GetSellerTransactions
  Returned: Conditionally
  Details: DetailLevel: none, ReturnAll

# Returns: 'xs:boolean'