Trading API885

GetSellerTransactions

Use this call to retrieve all of your order line items (transactions). This call can potentially return many order line items, depending on the recent sale activity of the authenticated user.

Note: If you typically use GetItemTransactions or GetSellerTransactions for order (sales) management, consider using GetOrders instead. The GetOrders call can retrieve single line item orders (traditionally known as 'transactions') and multiple line item orders (known as Combined Invoice orders).

An order line item contains information about the sale of one or more items. It involves one buyer, one seller, and a single listing. For more information, see Creating an Order Line Item.

For auction listings, order line items are not created until the auction ends with a winning bidder or if the Buy It Now feature is enabled for the listing and used by the buyer to purchase the item. For fixed-price listings, order line items are created after a buyer has committed to purchase the item(s).

GetSellerTransactions returns each of the seller's order line items in a TransactionArray.Transaction object.

In addition to order line item data, each TransactionArray.Transaction node contains an Item object that contains the details needed to process each of the order line items. For example, if it is a multi-quantity listing of 20 items and 10 of the items have sold, Item.Quantity is 20 and Item.SellingStatus.QuantitySold is 10.(Be aware that the Item objects returned by this call do not contain all possible details about the item. If you need more detailed item information, use GetSellerList or GetItem.)

GetSellerTransactions also returns a Seller object that describes the seller whose order line items are retrieved. Because all order line items returned by this call are for the same seller, Seller is returned at the root level.

Note: To retrieve order line item data for one particular listing, use GetItemTransactions.

See also Integrating PayPal With Your eBay Applications.

Usage Details

This call does not take a seller ID as input because it only retrieves order line items for the user authenticated by the call. However, because this call can potentially return a very large number of order line items, it can be desirable to control the amount of data returned from your GetSellerTransactions calls.

For example, you can pass in a time filter to limit the volume of the response to a particular time range and you can set the number of order line item to return per call. You can also control the amount of information returned for each call with DetailLevel settings. See the Detail Controls section for information on the fields returned for each of the settings.

Returned order line items are sorted by Transaction.Status.LastTimeModified in ascending order (that is, the most recently modified order line items are returned last).

Filtering by Time

Because of the number of order line items this call can return, it's recommended that you specify a time filter so you only get order line items whose status was modified within a narrow time frame. For example, the NumberOfDays field enables you to specify the number of days worth of new and modified order line items to return for a given call.

The time filters used with GetSellerTransactions do not represent the start and end times of the listing, but instead represent order line item status modification times related to the item listing. The order line item status modification time is available in the Transaction.Status.LastTimeModified output field. This value is updated each time the Checkout status of an order changes. The Checkout status can change any time (in seconds, minutes, or days) after the order line item is created.

Perhaps the most useful time filter is the NumberOfDays filter. This filter narrows the request to order line items that occurred within the specified number of days since the time of the request. In addition, the call also supports ModTimeFrom and ModTimeTo time filters.

Some order line items are processed by means of back-end batch jobs. Because of this, there can be a short delay between the end time of the item and the recording of the initial order line item entry in the eBay database. The following approaches help to ensure you do not miss any order line items when using ModTimeFrom and ModTimeTo:

Depending on the time range you specify, the call can still return hundreds of order line items. Therefore, it is often a good idea to configure the request to retrieve one page of data at a time (where each page contains a more manageable number of order line items). See Pagination for more information.

Pagination

To help manage large sets of output data, you can configure the request to retrieve controlled pages of data where each page contains a more manageable number of order line items.

Use the Pagination input property to control the number of order line items returned per request. The Pagination.EntriesPerPage controls the number of items returned and Pagination.PageNumber specifies which page of data to retrieve for the current call. The value specified for EntriesPerPage must be between 1 and 200.

In the output, ReturnedTransactionCountActual indicates how many order line items were actually returned in the call. HasMoreTransactions, if true, indicates that there are more order line items to be returned, requiring one or more additional calls to retrieve the entire result set. PageNumber indicates the page of data returned and TransactionsPerPage gives the number of order line items returned per call.

If you use pagination in a call, you must set at least one date-range filter. However, the reverse is not true, you can use a date-range filter without also using pagination.

Pertinent Response Data

In general, only fields relevant to order line items are returned. To note:

Working with the Response

GetSellerTransactions order line items for the authenticated seller in a TransactionArray object.

  1. Traverse the elements of the array to visit each Transaction object contained in the response and inspect the properties of each Transaction object to get the values for each of the order line items in the response.
  2. As applicable for the application, store the data for later use. See Completing the Sale for a more information.

The following Knowledge Base article contains some tips for working with this call: Best Practices for GetSellerEvents and GetSellerTransactions

Related Information

See:
    Email and Address Privacy Policy for the conditions under which buyer and seller email and address are returned
    Retrieving Order Line Item Data and Managing Orders

See also the reference documentation for these calls:



Back to top

GetSellerTransactions Input

The box below lists all fields that could be included in the call request. To learn more about an individual field or its type, click its name in the box (or scroll down to find it in the table below the box).

See also Samples.

See also the Deprecated Objects link above. Fields presented in this color are deprecated, and fields presented in this color are (or soon will be) non-operational.

The XML prototype does not include requester credentials. This is a documentation limitation only (see Standard Requester Credentials for Making Calls).

<?xml version="1.0" encoding="utf-8"?>
<GetSellerTransactionsRequest xmlns="urn:ebay:apis:eBLBaseComponents">
  <!-- Call-specific Input Fields -->
  <IncludeCodiceFiscale> boolean </IncludeCodiceFiscale>
  <IncludeContainingOrder> boolean </IncludeContainingOrder>
  <IncludeFinalValueFee> boolean </IncludeFinalValueFee>
  <InventoryTrackingMethod> InventoryTrackingMethodCodeType </InventoryTrackingMethod>
  <ModTimeFrom> dateTime </ModTimeFrom>
  <ModTimeTo> dateTime </ModTimeTo>
  <NumberOfDays> int </NumberOfDays>
  <Pagination> PaginationType
    <EntriesPerPage> int </EntriesPerPage>
    <PageNumber> int </PageNumber>
  </Pagination>
  <Platform> TransactionPlatformCodeType </Platform>
  <SKUArray> SKUArrayType
    <SKU> SKUType (string) </SKU>
    <!-- ... more SKU values allowed here ... -->
  </SKUArray>
  <!-- Standard Input Fields -->
  <DetailLevel> DetailLevelCodeType </DetailLevel>
  <!-- ... more DetailLevel values allowed here ... -->
  <ErrorLanguage> string </ErrorLanguage>
  <MessageID> string </MessageID>
  <OutputSelector> string </OutputSelector>
  <!-- ... more OutputSelector values allowed here ... -->
  <Version> string </Version>
  <WarningLevel> WarningLevelCodeType </WarningLevel>
</GetSellerTransactionsRequest>
Argument Type Occurrence Meaning
Call-specific Input Fields [Jump to standard fields]
IncludeCodiceFiscale boolean Optional If true, returns the Tax code for the user.
Default: false.
IncludeContainingOrder boolean Optional Include this field and set it to True if you want the ContainingOrder container to be returned in the response under each Transaction node. For single line item orders, the ContainingOrder.OrderID value takes the value of the OrderLineItemID value for the order line item. For Combined Invoice orders, the ContainingOrder.OrderID value will be shared by at least two order line items (transactions) that are part of the same order.
Default: false.

See Combined Invoice.

IncludeFinalValueFee boolean Optional Indicates whether to include Final Value Fee (FVF) in the response. For most listing types, the Final Value Fee is returned in Transaction.FinalValueFee. The Final Value Fee is returned for each order line item.
InventoryTrackingMethod InventoryTrackingMethodCodeType Optional Filters the response to only include order line items for listings that match this InventoryTrackingMethod setting.

For example, if you set this to SKU, the call returns order line items for your listings that are tracked by SKU. If you set this to ItemID, the call omits order line items for your listings that are tracked by SKU. If you don't pass this in, the call returns all order line items, regardless of whether they are tracked by SKU or ItemID.

Note: To specify InventoryTrackingMethod when you create a listing, use AddFixedPriceItem or RelistFixedPriceItem. AddFixedPriceItem and RelistFixedPriceItem are defined in the Merchant Data API (part of Large Merchant Services).

You can combine SKUArray with InventoryTrackingMethod. For example, if you set this to SKU and you also pass in SKUArray, the response only includes order line items for listings that include InventoryTrackingMethod=SKU and one of the requested SKUs.

Applicable values:

•   CustomCode

(in/out) Reserved for internal or future use

•   ItemID

(in/out) The seller prefers to track the listing by its eBay item ID. This is the default for all listings.

•   SKU

(in/out) The seller prefers to track the listing by their own SKU. When you track by SKU, it means you can pass your SKU instead of the eBay item ID in other calls that support SKU as an input field. If you choose SKU as your tracking preference for a listing, the value in Item.SKU must be unique across your active listings. You cannot create new listings with the same Item.SKU value while the listing is active (that is, until the existing listing with that SKU has ended). However, you can use ReviseInventoryStatus to update the quantity and/or price for the existing SKU as needed. When revising a listing where the InventoryTrackingMethod was set to SKU, you must pass in both the InventoryTrackingMethod tag (with the value set to SKU) and the SKU tag with the SKU value from your original listing.


ModTimeFrom dateTime Optional The ModTimeFrom and ModTimeTo fields specify a date range for retrieving order line items associated with the seller. The ModTimeFrom field is the starting date range. All of the seller's order line items that were last modified within this date range are returned in the output. The maximum date range that may be specified is 30 days. This field is not applicable if the NumberOfDays date filter is used.

If you don't specify a ModTimeFrom/ModTimeTo filter, the NumberOfDays time filter is used and it defaults to 30 (days).
ModTimeTo dateTime Optional The ModTimeFrom and ModTimeTo fields specify a date range for retrieving order line items associated with the seller. The ModTimeTo field is the ending date range. All of the seller's order line items that were last modified within this date range are returned in the output. The maximum date range that may be specified is 30 days. If the ModTimeFrom field is used and the ModTimeTo field is omitted, the ModTimeTo value defaults to the present time or to 30 days past the ModTimeFrom value (if ModTimeFrom value is more than 30 days in the past). This field is not applicable if the NumberOfDays date filter is used.

If you don't specify a ModTimeFrom/ModTimeTo filter, the NumberOfDays time filter is used and it defaults to 30 (days).
NumberOfDays int Optional NumberOfDays enables you to specify the number of days' worth of new and modified order line items that you want to retrieve. The call response contains the order line items whose status was modified within the specified number of days since the API call was made. NumberOfDays is often preferable to using the ModTimeFrom and ModTimeTo filters because you only need to specify one value. If you use NumberOfDays, then ModTimeFrom and ModTimeTo are ignored. For this field, one day is defined as 24 hours.
Max: 30.
Pagination PaginationType Optional Child elements control pagination of the output. Use EntriesPerPage property to control the number of transactions to return per call and PageNumber property to specify the page of data to return.
Pagination.EntriesPerPage int Optional This integer value is used to specify the maximum number of entries to return in a single "page" of data. This value, along with the number of entries that match the input criteria, will determine the total pages (see PaginationResult.TotalNumberOfPages) in the result set. For most Trading API calls, the maximum value is 200 and the default value is 25 entries per page.

For GetOrders, the maximum value is 100 and the default value is 25 orders per page.

For GetUserDisputes, this value is hard-coded at 200, and any pagination input is ignored.

For GetProducts, the maximum value is 20, and any higher values are ignored.
Pagination.PageNumber int Optional Specifies the number of the page of data to return in the current call. Default is 1 for most calls. For some calls, the default is 0. Specify a positive value equal to or lower than the number of pages available (which you determine by examining the results of your initial request). See the documentation for other individual calls to determine the correct default value.
Min: 1. Default: 1.
Platform TransactionPlatformCodeType Optional The default behavior of GetSellerTransactions is to retrieve all order line items originating from eBay.com and Half.com. If the user wants to retrieve only eBay.com order line items or Half.com order line items, this filter can be used to perform that function. Inserting 'eBay' into this field will restrict retrieved order line items to those originating on eBay.com, and inserting 'Half' into this field will restrict retrieved order line items to those originating on Half.com.

Applicable values:

•   CustomCode

(in/out) Reserved for future use.

•   eBay

(in/out) The order line item was created on the main eBay site.

•   Half

(in/out) The order line item was created on Half.com site.


(Not all values in TransactionPlatformCodeType apply to this field.)
SKUArray SKUArrayType Optional Container for a set of SKUs. Filters (reduces) the response to only include order line items for listings that include any of the specified SKUs. If multiple listings include the same SKU, order line items for all of them are returned (assuming they also match the other criteria in the GetSellerTransactions request).

You can combine SKUArray with InventoryTrackingMethod. For example, if you also pass in InventoryTrackingMethod=SKU, the response only includes order line items for listings that include InventoryTrackingMethod=SKU and one of the requested SKUs.
SKUArray.SKU SKUType (string) Optional,
repeatable: [0..*]
A SKU (stock keeping unit) is an identifier defined by a seller. Some sellers use SKUs to track complex flows of products and information on the client side. A seller can specify a SKU when listing an item with AddItem and related calls. eBay preserves the SKU on the item, enabling you to obtain it before and after an order line item is created. (SKU is recommended as an alternative to ApplicationData.)

A SKU is not required to be unique. A seller can specify a particular SKU value on one item or on multiple items. Different sellers can use the same SKUs.

If the SKU is unique across a seller's active listings, and if the seller listed the item by using AddFixedPriceItem or RelistFixedPriceItem, the seller can also set Item.InventoryTrackingMethod to SKU. This allows the seller to use SKU instead of ItemID as a unique identifier in subsequent calls, such as GetItem and ReviseInventoryStatus.

Note: AddFixedPriceItem and RelistFixedPriceItem are defined in the Merchant Data API (part of Large Merchant Services).
Max length: 50.
Standard Input Fields  
DetailLevel DetailLevelCodeType Optional,
repeatable: [0..*]
Detail levels are instructions that define standard subsets of data to return for particular data components (e.g., each Item, Transaction, or User) within the response payload. For example, a particular detail level might cause the response to include buyer-related data in every result (e.g., for every Item), but no seller-related data. Specifying a detail level is like using a predefined attribute list in the SELECT clause of an SQL query. Use the DetailLevel element to specify the required detail level that the client application needs pertaining to the data components that are applicable to the request.

The DetailLevelCodeType defines the global list of available detail levels for all request types. Most request types support certain detail levels or none at all. If you pass a detail level that exists in the schema but that isn't valid for a particular request, eBay ignores it processes the request without it. For each request type, see the detail level tables in the Input/Output Reference to determine which detail levels are applicable and which elements are returned for each applicable detail level.

Note that DetailLevel is required input for GetMyMessages.

With GetSellerList and other calls that retrieve large data sets, please avoid using 'ReturnAll' when possible. For example, if you use GetSellerList, use GranularityLevel instead, or use GetSellerEvents. If you do use 'ReturnAll' with GetSellerList, use a small Pagination.EntriesPerPage value and a narrow EndTimeFrom/EndTimeTo date range for better performance.

Applicable values:

•   ItemReturnDescription

(in) Returns Description, plus the ListingDesigner node and some additional information if applicable

•   ReturnAll

(in) Returns all available data. With GetSellerList and other calls that retrieve large data sets, please avoid using ReturnAll when possible. For example, if you use GetSellerList, use a GranularityLevel or use the GetSellerEvents call instead. If you use ReturnAll with GetSellerList, use a small EntriesPerPage value and a short EndTimeFrom/EndTimeTo range for better performance.


(Not all values in DetailLevelCodeType apply to this field.)
ErrorLanguage string Optional Use ErrorLanguage to return error strings for the call in a different language from the language commonly associated with the site that the requesting user is registered with. Specify the standard RFC 3066 language identification tag (e.g., en_US).

ID Country
en_AU Australia
de_AT Austria
nl_BE Belgium (Dutch)
fr_BE Belgium (French)
en_CA Canada
fr_CA Canada (French)
zh_CN China
fr_FR France
de_DE Germany
zh_HK Hong Kong
en_IN India
en_IE Ireland
it_IT Italy
nl_NL Netherlands
en_SG Singapore
es_ES Spain
de_CH Switzerland
en_GB United Kingdom
en_US United States

See Tags for the Identification of Languages.

MessageID string Optional Most Trading API calls support a MessageID element in the request and a CorrelationID element in the response. If you pass in a MessageID in a request, the same value will be returned in the CorrelationID field in the response. Pairing these values can help you track and confirm that a response is returned for every request and to match specific responses to specific requests. If you do not pass a MessageID value in the request, CorrelationID is not returned.

Note: GetCategories is designed to retrieve very large sets of metadata that change once a day or less often. To improve performance, these calls return cached responses when you request all available data (with no filters). When this occurs, the MessageID and CorrelationID fields aren't applicable. However, if you specify an input filter to reduce the amount of data returned, the calls retrieve the latest data (not cached). When this occurs, MessageID and CorrelationID are applicable.
OutputSelector string Optional,
repeatable: [0..*]
You can use the OutputSelector field to restrict the data returned by a call. This field can make the call response easier to manage, especially when a large payload is returned. If you use the OutputSelector field, the output data will only include the fields you specified in the request. For example, if you are using GetItem and you only want to retrieve the URL of the View Item page (emitted in ViewItemURL field) and the item's Buy It Now price (emitted in BuyItNowPrice field), you would include two separate OutputSelector fields and set the value for each one as 'ViewItemURL' and 'BuyItNowPrice' as in the following example:

 ...
<OutputSelector>ViewItemURL</OutputSelector>
<OutputSelector>BuyItNowPrice</OutputSelector>

...

See Selecting Fields to Retrieve.

Version string Conditional The version number of the API code that you are programming against (e.g., 859). The version you specify for a call has these basic effects:
- It indicates the version of the code lists and other data that eBay should use to process your request.
- It indicates the schema version you are using.
You need to use a version that is greater than or equal to the lowest supported version.

For the SOAP API: If you are using the SOAP API, this field is required. Specify the version of the WSDL your application is using.

For the XML API: If you are using the XML API, this field has no effect. Instead, specify the version in the X-EBAY-API-COMPATIBILITY-LEVEL HTTP header. (If you specify Version in the body of an XML API request and it is different from the value in the HTTP header, eBay returns an informational warning that the value in the HTTP header was used instead.)

See:
    Routing the Request (Gateway URLs)
    eBay Schema Versioning Strategy
    Lowest Supported Version

WarningLevel WarningLevelCodeType Optional Controls whether or not to return warnings when the application passes unrecognized or deprecated elements in a request.

An unrecognized element is one that is not defined in any supported version of the schema. Schema element names are case-sensitive, so using WarningLevel can also help you remove any potential hidden bugs within your application due to incorrect case or spelling in field names before you put your application into the Production environment.

WarningLevel only validates elements; it doesn't validate XML attributes. It also doesn't control warnings related to user-entered strings or numbers, or warnings for logical errors.

We recommend that you only use this during development and debugging. Do not use this in requests performed in the Production environment.

Applicable values:

•   High

(in) Return warnings when the application passes unrecognized or deprecated elements in a request.

•   Low

(in) Do not return warnings when the application passes unrecognized or deprecated elements in a request. This is the default value if WarningLevel is not specified.


See Warning Level.



Back to top

GetSellerTransactions Output

The box below lists all fields that might be returned in the response. To learn more about an individual field or its type, click its name in the box (or scroll down to find it in the table below the box).

See also Samples.

See also the Deprecated Objects link above. Fields presented in this color are deprecated, and fields presented in this color are not returned (or soon will not be returned) or are not operational (or soon will be non-operational).

<?xml version="1.0" encoding="utf-8"?>
<GetSellerTransactionsResponse xmlns="urn:ebay:apis:eBLBaseComponents">
  <!-- Call-specific Output Fields -->
  <HasMoreTransactions> boolean </HasMoreTransactions>
  <PageNumber> int </PageNumber>
  <PaginationResult> PaginationResultType
    <TotalNumberOfEntries> int </TotalNumberOfEntries>
    <TotalNumberOfPages> int </TotalNumberOfPages>
  </PaginationResult>
  <PayPalPreferred> boolean </PayPalPreferred>
  <ReturnedTransactionCountActual> int </ReturnedTransactionCountActual>
  <Seller> UserType
    <AboutMePage> boolean </AboutMePage>
    <CharityAffiliations> CharityAffiliationsType
      <CharityID> CharityIDType (string) </CharityID>
      <!-- ... more CharityID nodes allowed here ... -->
    </CharityAffiliations>
    <eBayGoodStanding> boolean </eBayGoodStanding>
    <EIASToken> string </EIASToken>
    <Email> string </Email>
    <FeedbackPrivate> boolean </FeedbackPrivate>
    <FeedbackRatingStar> FeedbackRatingStarCodeType </FeedbackRatingStar>
    <FeedbackScore> int </FeedbackScore>
    <IDVerified> boolean </IDVerified>
    <NewUser> boolean </NewUser>
    <PositiveFeedbackPercent> float </PositiveFeedbackPercent>
    <RegistrationAddress> AddressType
      <AddressAttribute type="AddressAttributeCodeType"> AddressAttributeType (string) </AddressAttribute>
      <!-- ... more AddressAttribute nodes allowed here ... -->
      <AddressID> string </AddressID>
      <AddressUsage> AddressUsageCodeType </AddressUsage>
      <ExternalAddressID> string </ExternalAddressID>
      <Name> string </Name>
    </RegistrationAddress>
    <RegistrationDate> dateTime </RegistrationDate>
    <SellerInfo> SellerType
      <AllowPaymentEdit> boolean </AllowPaymentEdit>
      <CheckoutEnabled> boolean </CheckoutEnabled>
      <CIPBankAccountStored> boolean </CIPBankAccountStored>
      <GoodStanding> boolean </GoodStanding>
      <MerchandizingPref> MerchandizingPrefCodeType (token) </MerchandizingPref>
      <QualifiesForB2BVAT> boolean </QualifiesForB2BVAT>
      <SafePaymentExempt> boolean </SafePaymentExempt>
      <SellereBayPaymentProcessConsent> SellereBayPaymentProcessConsentCodeType
        <PayoutMethod> PayoutMethodType </PayoutMethod>
        <PayoutMethodSet> boolean </PayoutMethodSet>
        <UserAgreementInfo> UserAgreementInfoType
          <AcceptedTime> dateTime </AcceptedTime>
          <SellereBayPaymentProcessEnableTime> dateTime </SellereBayPaymentProcessEnableTime>
          <SellereBayPaymentProcessStatus> SellereBayPaymentProcessStatusCodeType </SellereBayPaymentProcessStatus>
          <Site> SiteCodeType </Site>
          <UserAgreementURL> anyURI </UserAgreementURL>
        </UserAgreementInfo>
        <!-- ... more UserAgreementInfo nodes allowed here ... -->
      </SellereBayPaymentProcessConsent>
      <SellereBayPaymentProcessStatus> SellereBayPaymentProcessStatusCodeType </SellereBayPaymentProcessStatus>
      <SellerGuaranteeLevel> SellerGuaranteeLevelCodeType </SellerGuaranteeLevel>
      <SellerLevel> SellerLevelCodeType </SellerLevel>
      <StoreOwner> boolean </StoreOwner>
      <StoreURL> anyURI </StoreURL>
      <TopRatedSeller> boolean </TopRatedSeller>
    </SellerInfo>
    <Site> SiteCodeType </Site>
    <Status> UserStatusCodeType </Status>
    <UserID> UserIDType (string) </UserID>
    <UserIDChanged> boolean </UserIDChanged>
    <UserIDLastChanged> dateTime </UserIDLastChanged>
    <VATStatus> VATStatusCodeType </VATStatus>
  </Seller>
  <TransactionArray> TransactionArrayType
    <Transaction> TransactionType
      <ActualHandlingCost currencyID="CurrencyCodeType"> AmountType (double) </ActualHandlingCost>
      <ActualShippingCost currencyID="CurrencyCodeType"> AmountType (double) </ActualShippingCost>
      <AdjustmentAmount currencyID="CurrencyCodeType"> AmountType (double) </AdjustmentAmount>
      <AmountPaid currencyID="CurrencyCodeType"> AmountType (double) </AmountPaid>
      <BestOfferSale> boolean </BestOfferSale>
      <Buyer> UserType
        <AboutMePage> boolean </AboutMePage>
        <BuyerInfo> BuyerType
          <BuyerTaxIdentifier> TaxIdentifierType
            <Attribute name="TaxIdentifierAttributeCodeType"> TaxIdentifierAttributeType (string) </Attribute>
            <!-- ... more Attribute nodes allowed here ... -->
            <ID> string </ID>
            <Type> ValueTypeCodeType </Type>
          </BuyerTaxIdentifier>
          <!-- ... more BuyerTaxIdentifier nodes allowed here ... -->
          <ShippingAddress> AddressType
            <AddressAttribute type="AddressAttributeCodeType"> AddressAttributeType (string) </AddressAttribute>
            <!-- ... more AddressAttribute nodes allowed here ... -->
            <AddressID> string </AddressID>
            <AddressUsage> AddressUsageCodeType </AddressUsage>
            <CityName> string </CityName>
            <Country> CountryCodeType </Country>
            <CountryName> string </CountryName>
            <ExternalAddressID> string </ExternalAddressID>
            <Name> string </Name>
            <Phone> string </Phone>
            <PostalCode> string </PostalCode>
            <StateOrProvince> string </StateOrProvince>
            <Street> string </Street>
            <Street1> string </Street1>
            <Street2> string </Street2>
          </ShippingAddress>
        </BuyerInfo>
        <CharityAffiliations> CharityAffiliationsType
          <CharityID> CharityIDType (string) </CharityID>
          <!-- ... more CharityID nodes allowed here ... -->
        </CharityAffiliations>
        <eBayGoodStanding> boolean </eBayGoodStanding>
        <EIASToken> string </EIASToken>
        <Email> string </Email>
        <FeedbackPrivate> boolean </FeedbackPrivate>
        <FeedbackRatingStar> FeedbackRatingStarCodeType </FeedbackRatingStar>
        <FeedbackScore> int </FeedbackScore>
        <IDVerified> boolean </IDVerified>
        <NewUser> boolean </NewUser>
        <PositiveFeedbackPercent> float </PositiveFeedbackPercent>
        <RegistrationAddress> AddressType
          <AddressAttribute type="AddressAttributeCodeType"> AddressAttributeType (string) </AddressAttribute>
          <!-- ... more AddressAttribute nodes allowed here ... -->
          <AddressID> string </AddressID>
          <AddressUsage> AddressUsageCodeType </AddressUsage>
          <ExternalAddressID> string </ExternalAddressID>
          <Name> string </Name>
        </RegistrationAddress>
        <RegistrationDate> dateTime </RegistrationDate>
        <Site> SiteCodeType </Site>
        <StaticAlias> string </StaticAlias>
        <Status> UserStatusCodeType </Status>
        <UserID> UserIDType (string) </UserID>
        <UserIDChanged> boolean </UserIDChanged>
        <UserIDLastChanged> dateTime </UserIDLastChanged>
        <VATStatus> VATStatusCodeType </VATStatus>
      </Buyer>
      <BuyerCheckoutMessage> string </BuyerCheckoutMessage>
      <BuyerGuaranteePrice currencyID="CurrencyCodeType"> AmountType (double) </BuyerGuaranteePrice>
      <CartID> string </CartID>
      <CodiceFiscale> string </CodiceFiscale>
      <ContainingOrder> OrderType
        <BuyerTaxIdentifier> TaxIdentifierType
          <Attribute name="TaxIdentifierAttributeCodeType"> TaxIdentifierAttributeType (string) </Attribute>
          <!-- ... more Attribute nodes allowed here ... -->
          <ID> string </ID>
          <Type> ValueTypeCodeType </Type>
        </BuyerTaxIdentifier>
        <!-- ... more BuyerTaxIdentifier nodes allowed here ... -->
        <CancelDetail> CancelDetailType
          <CancelCompleteDate> dateTime </CancelCompleteDate>
          <CancelIntiationDate> dateTime </CancelIntiationDate>
          <CancelIntiator> token </CancelIntiator>
          <CancelReason> token </CancelReason>
          <CancelReasonDetails> string </CancelReasonDetails>
        </CancelDetail>
        <!-- ... more CancelDetail nodes allowed here ... -->
        <CancelReason> token </CancelReason>
        <CancelReasonDetails> string </CancelReasonDetails>
        <CancelStatus> CancelStatusCodeType </CancelStatus>
        <CreatingUserRole> TradingRoleCodeType </CreatingUserRole>
        <IntegratedMerchantCreditCardEnabled> boolean </IntegratedMerchantCreditCardEnabled>
        <IsMultiLegShipping> boolean </IsMultiLegShipping>
        <LogisticsPlanType> token </LogisticsPlanType>
        <MonetaryDetails> PaymentsInformationType
          <Payments> PaymentInformationType
            <Payment> PaymentTransactionType
              <FeeOrCreditAmount currencyID="CurrencyCodeType"> AmountType (double) </FeeOrCreditAmount>
              <Payee type="UserIdentityCodeType"> UserIdentityType (string) </Payee>
              <Payer type="UserIdentityCodeType"> UserIdentityType (string) </Payer>
              <PaymentAmount currencyID="CurrencyCodeType"> AmountType (double) </PaymentAmount>
              <PaymentReferenceID type="TransactionReferenceCodeType"> TransactionReferenceType (string) </PaymentReferenceID>
              <!-- ... more PaymentReferenceID nodes allowed here ... -->
              <PaymentStatus> PaymentTransactionStatusCodeType </PaymentStatus>
              <PaymentTime> dateTime </PaymentTime>
              <ReferenceID type="TransactionReferenceCodeType"> TransactionReferenceType (string) </ReferenceID>
            </Payment>
            <!-- ... more Payment nodes allowed here ... -->
          </Payments>
          <Refunds> RefundInformationType
            <Refund> RefundTransactionInfoType
              <FeeOrCreditAmount currencyID="CurrencyCodeType"> AmountType (double) </FeeOrCreditAmount>
              <ReferenceID type="TransactionReferenceCodeType"> TransactionReferenceType (string) </ReferenceID>
              <RefundAmount currencyID="CurrencyCodeType"> AmountType (double) </RefundAmount>
              <RefundStatus> PaymentTransactionStatusCodeType </RefundStatus>
              <RefundTime> dateTime </RefundTime>
              <RefundTo type="UserIdentityCodeType"> UserIdentityType (string) </RefundTo>
              <RefundType> RefundSourceTypeCodeType </RefundType>
            </Refund>
            <!-- ... more Refund nodes allowed here ... -->
          </Refunds>
        </MonetaryDetails>
        <MultiLegShippingDetails> MultiLegShippingDetailsType
          <SellerShipmentToLogisticsProvider> MultiLegShipmentType
            <ShippingServiceDetails> MultiLegShippingServiceType
              <ShippingService> token </ShippingService>
              <TotalShippingCost currencyID="CurrencyCodeType"> AmountType (double) </TotalShippingCost>
            </ShippingServiceDetails>
            <ShippingTimeMax> int </ShippingTimeMax>
            <ShippingTimeMin> int </ShippingTimeMin>
            <ShipToAddress> AddressType
              <AddressAttribute type="AddressAttributeCodeType"> AddressAttributeType (string) </AddressAttribute>
              <!-- ... more AddressAttribute nodes allowed here ... -->
              <AddressID> string </AddressID>
              <AddressOwner> AddressOwnerCodeType </AddressOwner>
              <AddressUsage> AddressUsageCodeType </AddressUsage>
              <CityName> string </CityName>
              <Country> CountryCodeType </Country>
              <CountryName> string </CountryName>
              <ExternalAddressID> string </ExternalAddressID>
              <Name> string </Name>
              <Phone> string </Phone>
              <PostalCode> string </PostalCode>
              <ReferenceID> string </ReferenceID>
              <StateOrProvince> string </StateOrProvince>
              <Street1> string </Street1>
              <Street2> string </Street2>
            </ShipToAddress>
          </SellerShipmentToLogisticsProvider>
        </MultiLegShippingDetails>
        <OrderID> OrderIDType (string) </OrderID>
        <OrderStatus> OrderStatusCodeType </OrderStatus>
        <PaymentHoldDetails> PaymentHoldDetailType
          <ExpectedReleaseDate> dateTime </ExpectedReleaseDate>
          <NumOfReqSellerActions> int </NumOfReqSellerActions>
          <PaymentHoldReason> PaymentHoldReasonCodeType </PaymentHoldReason>
          <RequiredSellerActionArray> RequiredSellerActionArrayType
            <RequiredSellerAction> RequiredSellerActionCodeType </RequiredSellerAction>
            <!-- ... more RequiredSellerAction values allowed here ... -->
          </RequiredSellerActionArray>
        </PaymentHoldDetails>
        <PaymentHoldStatus> PaymentHoldStatusCodeType </PaymentHoldStatus>
        <RefundArray> RefundArrayType
          <Refund> RefundType
            <EstimatedRefundCompletionTime> dateTime </EstimatedRefundCompletionTime>
            <ExternalReferenceID> string </ExternalReferenceID>
            <RefundAmount currencyID="CurrencyCodeType"> AmountType (double) </RefundAmount>
            <RefundCompletionTime> dateTime </RefundCompletionTime>
            <RefundFailureReason> RefundFailureReasonType
              <RefundFailureCode> RefundFailureCodeType </RefundFailureCode>
            </RefundFailureReason>
            <RefundFundingSourceArray> RefundFundingSourceArrayType
              <RefundFundingSource> RefundFundingSourceType
                <AccountNumber> string </AccountNumber>
                <BuyerExternalTransactionID> string </BuyerExternalTransactionID>
                <RefundAmount currencyID="CurrencyCodeType"> AmountType (double) </RefundAmount>
                <RefundingSourceType> RefundingSourceTypeCodeType </RefundingSourceType>
                <SellerExternalTransactionID> string </SellerExternalTransactionID>
              </RefundFundingSource>
              <!-- ... more RefundFundingSource nodes allowed here ... -->
            </RefundFundingSourceArray>
            <RefundID> string </RefundID>
            <RefundRequestedTime> dateTime </RefundRequestedTime>
            <RefundStatus> RefundStatusCodeType </RefundStatus>
            <RefundTransactionArray> RefundTransactionArrayType
              <RefundTransaction> RefundTransactionType
                <ItemID> string </ItemID>
                <OrderID> string </OrderID>
                <RefundLineArray> RefundLineArrayType
                  <RefundLine type="RefundLineTypeCodeType" currencyID="CurrencyCodeType"> RefundLineType </RefundLine>
                  <!-- ... more RefundLine nodes allowed here ... -->
                </RefundLineArray>
                <TransactionID> string </TransactionID>
              </RefundTransaction>
              <!-- ... more RefundTransaction nodes allowed here ... -->
            </RefundTransactionArray>
            <SellerNoteToBuyer> string </SellerNoteToBuyer>
          </Refund>
          <!-- ... more Refund nodes allowed here ... -->
        </RefundArray>
        <ShippingConvenienceCharge currencyID="CurrencyCodeType"> AmountType (double) </ShippingConvenienceCharge>
      </ContainingOrder>
      <ConvertedAdjustmentAmount currencyID="CurrencyCodeType"> AmountType (double) </ConvertedAdjustmentAmount>
      <ConvertedAmountPaid currencyID="CurrencyCodeType"> AmountType (double) </ConvertedAmountPaid>
      <ConvertedTransactionPrice currencyID="CurrencyCodeType"> AmountType (double) </ConvertedTransactionPrice>
      <CreatedDate> dateTime </CreatedDate>
      <DepositType> DepositTypeCodeType </DepositType>
      <ExternalTransaction> ExternalTransactionType
        <ExternalTransactionID> string </ExternalTransactionID>
        <ExternalTransactionStatus> PaymentTransactionStatusCodeType </ExternalTransactionStatus>
        <ExternalTransactionTime> dateTime </ExternalTransactionTime>
        <FeeOrCreditAmount currencyID="CurrencyCodeType"> AmountType (double) </FeeOrCreditAmount>
        <PaymentOrRefundAmount currencyID="CurrencyCodeType"> AmountType (double) </PaymentOrRefundAmount>
      </ExternalTransaction>
      <!-- ... more ExternalTransaction nodes allowed here ... -->
      <FinalValueFee currencyID="CurrencyCodeType"> AmountType (double) </FinalValueFee>
      <IntangibleItem> boolean </IntangibleItem>
      <InvoiceSentTime> dateTime </InvoiceSentTime>
      <IsMultiLegShipping> boolean </IsMultiLegShipping>
      <Item> ItemType
        <ApplicationData> string </ApplicationData>
        <AutoPay> boolean </AutoPay>
        <BuyerProtection> BuyerProtectionCodeType </BuyerProtection>
        <BuyItNowPrice currencyID="CurrencyCodeType"> AmountType (double) </BuyItNowPrice>
        <Charity> CharityType
          <CharityListing> boolean </CharityListing>
        </Charity>
        <Country> CountryCodeType </Country>
        <Currency> CurrencyCodeType </Currency>
        <GetItFast> boolean </GetItFast>
        <IntegratedMerchantCreditCardEnabled> boolean </IntegratedMerchantCreditCardEnabled>
        <InventoryTrackingMethod> InventoryTrackingMethodCodeType </InventoryTrackingMethod>
        <ItemID> ItemIDType (string) </ItemID>
        <ListingDetails> ListingDetailsType
          <Adult> boolean </Adult>
          <BindingAuction> boolean </BindingAuction>
          <CheckoutEnabled> boolean </CheckoutEnabled>
          <ConvertedBuyItNowPrice currencyID="CurrencyCodeType"> AmountType (double) </ConvertedBuyItNowPrice>
          <ConvertedReservePrice currencyID="CurrencyCodeType"> AmountType (double) </ConvertedReservePrice>
          <ConvertedStartPrice currencyID="CurrencyCodeType"> AmountType (double) </ConvertedStartPrice>
          <EndTime> dateTime </EndTime>
          <HasPublicMessages> boolean </HasPublicMessages>
          <HasReservePrice> boolean </HasReservePrice>
          <MinimumBestOfferPrice currencyID="CurrencyCodeType"> AmountType (double) </MinimumBestOfferPrice>
          <RelistedItemID> ItemIDType (string) </RelistedItemID>
          <StartTime> dateTime </StartTime>
          <TCROriginalItemID> ItemIDType (string) </TCROriginalItemID>
          <ViewItemURL> anyURI </ViewItemURL>
          <ViewItemURLForNaturalSearch> anyURI </ViewItemURLForNaturalSearch>
        </ListingDetails>
        <ListingType> ListingTypeCodeType </ListingType>
        <LotSize> int </LotSize>
        <PaymentMethods> BuyerPaymentMethodCodeType </PaymentMethods>
        <!-- ... more PaymentMethods values allowed here ... -->
        <PrivateListing> boolean </PrivateListing>
        <Quantity> int </Quantity>
        <SellingStatus> SellingStatusType
          <BidCount> int </BidCount>
          <ConvertedCurrentPrice currencyID="CurrencyCodeType"> AmountType (double) </ConvertedCurrentPrice>
          <CurrentPrice currencyID="CurrencyCodeType"> AmountType (double) </CurrentPrice>
          <FinalValueFee currencyID="CurrencyCodeType"> AmountType (double) </FinalValueFee>
          <ListingStatus> ListingStatusCodeType </ListingStatus>
          <QuantitySold> int </QuantitySold>
        </SellingStatus>
        <Site> SiteCodeType </Site>
        <SKU> SKUType (string) </SKU>
        <StartPrice currencyID="CurrencyCodeType"> AmountType (double) </StartPrice>
        <Title> string </Title>
      </Item>
      <ListingCheckoutRedirectPreference> ListingCheckoutRedirectPreferenceType
        <SellerThirdPartyUsername> string </SellerThirdPartyUsername>
      </ListingCheckoutRedirectPreference>
      <LogisticsPlanType> token </LogisticsPlanType>
      <MonetaryDetails> PaymentsInformationType
        <Payments> PaymentInformationType
          <Payment> PaymentTransactionType
            <FeeOrCreditAmount currencyID="CurrencyCodeType"> AmountType (double) </FeeOrCreditAmount>
            <Payee type="UserIdentityCodeType"> UserIdentityType (string) </Payee>
            <Payer type="UserIdentityCodeType"> UserIdentityType (string) </Payer>
            <PaymentAmount currencyID="CurrencyCodeType"> AmountType (double) </PaymentAmount>
            <PaymentReferenceID type="TransactionReferenceCodeType"> TransactionReferenceType (string) </PaymentReferenceID>
            <!-- ... more PaymentReferenceID nodes allowed here ... -->
            <PaymentStatus> PaymentTransactionStatusCodeType </PaymentStatus>
            <PaymentTime> dateTime </PaymentTime>
            <ReferenceID type="TransactionReferenceCodeType"> TransactionReferenceType (string) </ReferenceID>
          </Payment>
          <!-- ... more Payment nodes allowed here ... -->
        </Payments>
        <Refunds> RefundInformationType
          <Refund> RefundTransactionInfoType
            <FeeOrCreditAmount currencyID="CurrencyCodeType"> AmountType (double) </FeeOrCreditAmount>
            <ReferenceID type="TransactionReferenceCodeType"> TransactionReferenceType (string) </ReferenceID>
            <RefundAmount currencyID="CurrencyCodeType"> AmountType (double) </RefundAmount>
            <RefundStatus> PaymentTransactionStatusCodeType </RefundStatus>
            <RefundTime> dateTime </RefundTime>
            <RefundTo type="UserIdentityCodeType"> UserIdentityType (string) </RefundTo>
            <RefundType> RefundSourceTypeCodeType </RefundType>
          </Refund>
          <!-- ... more Refund nodes allowed here ... -->
        </Refunds>
      </MonetaryDetails>
      <MultiLegShippingDetails> MultiLegShippingDetailsType
        <SellerShipmentToLogisticsProvider> MultiLegShipmentType
          <ShippingServiceDetails> MultiLegShippingServiceType
            <ShippingService> token </ShippingService>
            <TotalShippingCost currencyID="CurrencyCodeType"> AmountType (double) </TotalShippingCost>
          </ShippingServiceDetails>
          <ShippingTimeMax> int </ShippingTimeMax>
          <ShippingTimeMin> int </ShippingTimeMin>
          <ShipToAddress> AddressType
            <AddressAttribute type="AddressAttributeCodeType"> AddressAttributeType (string) </AddressAttribute>
            <!-- ... more AddressAttribute nodes allowed here ... -->
            <AddressID> string </AddressID>
            <AddressOwner> AddressOwnerCodeType </AddressOwner>
            <AddressUsage> AddressUsageCodeType </AddressUsage>
            <CityName> string </CityName>
            <Country> CountryCodeType </Country>
            <CountryName> string </CountryName>
            <ExternalAddressID> string </ExternalAddressID>
            <Name> string </Name>
            <Phone> string </Phone>
            <PostalCode> string </PostalCode>
            <ReferenceID> string </ReferenceID>
            <StateOrProvince> string </StateOrProvince>
            <Street1> string </Street1>
            <Street2> string </Street2>
          </ShipToAddress>
        </SellerShipmentToLogisticsProvider>
      </MultiLegShippingDetails>
      <OrderLineItemID> string </OrderLineItemID>
      <PaidTime> dateTime </PaidTime>
      <PaymentHoldDetails> PaymentHoldDetailType
        <ExpectedReleaseDate> dateTime </ExpectedReleaseDate>
        <NumOfReqSellerActions> int </NumOfReqSellerActions>
        <PaymentHoldReason> PaymentHoldReasonCodeType </PaymentHoldReason>
        <RequiredSellerActionArray> RequiredSellerActionArrayType
          <RequiredSellerAction> RequiredSellerActionCodeType </RequiredSellerAction>
          <!-- ... more RequiredSellerAction values allowed here ... -->
        </RequiredSellerActionArray>
      </PaymentHoldDetails>
      <PayPalEmailAddress> string </PayPalEmailAddress>
      <PickupDetails> PickupDetailsType
        <PickupOptions> PickupOptionsType
          <PickupMethod> token </PickupMethod>
          <PickupPriority> int </PickupPriority>
        </PickupOptions>
        <!-- ... more PickupOptions nodes allowed here ... -->
      </PickupDetails>
      <PickupMethodSelected> PickupMethodSelectedType
        <MerchantPickupCode> string </MerchantPickupCode>
        <PickupFulfillmentTime> dateTime </PickupFulfillmentTime>
        <PickupLocationUUID> string </PickupLocationUUID>
        <PickupMethod> token </PickupMethod>
        <PickupStatus> PickupStatusCodeType </PickupStatus>
        <PickupStoreID> string </PickupStoreID>
      </PickupMethodSelected>
      <Platform> TransactionPlatformCodeType </Platform>
      <QuantityPurchased> int </QuantityPurchased>
      <RefundArray> RefundArrayType
        <Refund> RefundType
          <EstimatedRefundCompletionTime> dateTime </EstimatedRefundCompletionTime>
          <ExternalReferenceID> string </ExternalReferenceID>
          <RefundAmount currencyID="CurrencyCodeType"> AmountType (double) </RefundAmount>
          <RefundCompletionTime> dateTime </RefundCompletionTime>
          <RefundFailureReason> RefundFailureReasonType
            <RefundFailureCode> RefundFailureCodeType </RefundFailureCode>
          </RefundFailureReason>
          <RefundFundingSourceArray> RefundFundingSourceArrayType
            <RefundFundingSource> RefundFundingSourceType
              <AccountNumber> string </AccountNumber>
              <BuyerExternalTransactionID> string </BuyerExternalTransactionID>
              <RefundAmount currencyID="CurrencyCodeType"> AmountType (double) </RefundAmount>
              <RefundingSourceType> RefundingSourceTypeCodeType </RefundingSourceType>
              <SellerExternalTransactionID> string </SellerExternalTransactionID>
            </RefundFundingSource>
            <!-- ... more RefundFundingSource nodes allowed here ... -->
          </RefundFundingSourceArray>
          <RefundID> string </RefundID>
          <RefundRequestedTime> dateTime </RefundRequestedTime>
          <RefundStatus> RefundStatusCodeType </RefundStatus>
          <RefundTransactionArray> RefundTransactionArrayType
            <RefundTransaction> RefundTransactionType
              <ItemID> string </ItemID>
              <OrderID> string </OrderID>
              <RefundLineArray> RefundLineArrayType
                <RefundLine type="RefundLineTypeCodeType" currencyID="CurrencyCodeType"> RefundLineType </RefundLine>
                <!-- ... more RefundLine nodes allowed here ... -->
              </RefundLineArray>
              <TransactionID> string </TransactionID>
            </RefundTransaction>
            <!-- ... more RefundTransaction nodes allowed here ... -->
          </RefundTransactionArray>
          <SellerNoteToBuyer> string </SellerNoteToBuyer>
        </Refund>
        <!-- ... more Refund nodes allowed here ... -->
      </RefundArray>
      <SellerContactBuyerByEmail> boolean </SellerContactBuyerByEmail>
      <SellerDiscounts> SellerDiscountsType
        <OriginalItemPrice currencyID="CurrencyCodeType"> AmountType (double) </OriginalItemPrice>
        <OriginalItemShippingCost currencyID="CurrencyCodeType"> AmountType (double) </OriginalItemShippingCost>
        <SellerDiscount> SellerDiscountType
          <CampaignDisplayName> string </CampaignDisplayName>
          <CampaignID> long </CampaignID>
          <ItemDiscountAmount currencyID="CurrencyCodeType"> AmountType (double) </ItemDiscountAmount>
          <ShippingDiscountAmount currencyID="CurrencyCodeType"> AmountType (double) </ShippingDiscountAmount>
        </SellerDiscount>
        <!-- ... more SellerDiscount nodes allowed here ... -->
      </SellerDiscounts>
      <SellingManagerProductDetails> SellingManagerProductDetailsType
        <ProductName> string </ProductName>
      </SellingManagerProductDetails>
      <ShippedTime> dateTime </ShippedTime>
      <ShippingConvenienceCharge currencyID="CurrencyCodeType"> AmountType (double) </ShippingConvenienceCharge>
      <ShippingDetails> ShippingDetailsType
        <CalculatedShippingRate> CalculatedShippingRateType
          <InternationalPackagingHandlingCosts currencyID="CurrencyCodeType"> AmountType (double) </InternationalPackagingHandlingCosts>
          <OriginatingPostalCode> string </OriginatingPostalCode>
          <PackageDepth unit="token"> MeasureType (decimal) </PackageDepth>
          <PackageLength unit="token"> MeasureType (decimal) </PackageLength>
          <PackageWidth unit="token"> MeasureType (decimal) </PackageWidth>
          <PackagingHandlingCosts currencyID="CurrencyCodeType"> AmountType (double) </PackagingHandlingCosts>
          <ShippingIrregular> boolean </ShippingIrregular>
          <ShippingPackage> ShippingPackageCodeType </ShippingPackage>
          <WeightMajor unit="token"> MeasureType (decimal) </WeightMajor>
          <WeightMinor unit="token"> MeasureType (decimal) </WeightMinor>
        </CalculatedShippingRate>
        <ChangePaymentInstructions> boolean </ChangePaymentInstructions>
        <CODCost currencyID="CurrencyCodeType"> AmountType (double) </CODCost>
        <ExcludeShipToLocation> string </ExcludeShipToLocation>
        <!-- ... more ExcludeShipToLocation values allowed here ... -->
        <GetItFast> boolean </GetItFast>
        <InsuranceFee currencyID="CurrencyCodeType"> AmountType (double) </InsuranceFee>
        <InsuranceOption> InsuranceOptionCodeType </InsuranceOption>
        <InsuranceWanted> boolean </InsuranceWanted>
        <PaymentEdited> boolean </PaymentEdited>
        <PaymentInstructions> string </PaymentInstructions>
        <SalesTax> SalesTaxType
          <SalesTaxAmount currencyID="CurrencyCodeType"> AmountType (double) </SalesTaxAmount>
          <SalesTaxPercent> float </SalesTaxPercent>
          <SalesTaxState> string </SalesTaxState>
          <ShippingIncludedInTax> boolean </ShippingIncludedInTax>
        </SalesTax>
        <SellingManagerSalesRecordNumber> int </SellingManagerSalesRecordNumber>
        <ShipmentTrackingDetails> ShipmentTrackingDetailsType
          <ShipmentTrackingNumber> string </ShipmentTrackingNumber>
          <ShippingCarrierUsed> string </ShippingCarrierUsed>
        </ShipmentTrackingDetails>
        <!-- ... more ShipmentTrackingDetails nodes allowed here ... -->
        <ShippingRateErrorMessage> string </ShippingRateErrorMessage>
        <ShippingRateType> ShippingRateTypeCodeType </ShippingRateType>
        <ShippingServiceUsed> token </ShippingServiceUsed>
        <ShippingType> ShippingTypeCodeType </ShippingType>
        <TaxTable> TaxTableType
          <TaxJurisdiction> TaxJurisdictionType
            <JurisdictionID> string </JurisdictionID>
            <SalesTaxPercent> float </SalesTaxPercent>
            <ShippingIncludedInTax> boolean </ShippingIncludedInTax>
          </TaxJurisdiction>
          <!-- ... more TaxJurisdiction nodes allowed here ... -->
        </TaxTable>
      </ShippingDetails>
      <ShippingServiceSelected> ShippingServiceOptionsType
        <ExpeditedService> boolean </ExpeditedService>
        <ImportCharge currencyID="CurrencyCodeType"> AmountType (double) </ImportCharge>
        <LogisticPlanType> string </LogisticPlanType>
        <ShippingInsuranceCost currencyID="CurrencyCodeType"> AmountType (double) </ShippingInsuranceCost>
        <ShippingPackageInfo> ShippingPackageInfoType
          <ActualDeliveryTime> dateTime </ActualDeliveryTime>
          <EstimatedDeliveryTimeMax> dateTime </EstimatedDeliveryTimeMax>
          <EstimatedDeliveryTimeMin> dateTime </EstimatedDeliveryTimeMin>
          <ScheduledDeliveryTimeMax> dateTime </ScheduledDeliveryTimeMax>
          <ScheduledDeliveryTimeMin> dateTime </ScheduledDeliveryTimeMin>
          <ShippingTrackingEvent> token </ShippingTrackingEvent>
          <StoreID> string </StoreID>
        </ShippingPackageInfo>
        <!-- ... more ShippingPackageInfo nodes allowed here ... -->
        <ShippingService> token </ShippingService>
        <ShippingServiceAdditionalCost currencyID="CurrencyCodeType"> AmountType (double) </ShippingServiceAdditionalCost>
        <ShippingServiceCost currencyID="CurrencyCodeType"> AmountType (double) </ShippingServiceCost>
        <ShippingServicePriority> int </ShippingServicePriority>
        <ShippingSurcharge currencyID="CurrencyCodeType"> AmountType (double) </ShippingSurcharge>
        <ShippingTimeMax> int </ShippingTimeMax>
        <ShippingTimeMin> int </ShippingTimeMin>
      </ShippingServiceSelected>
      <Status> TransactionStatusType
        <BuyerSelectedShipping> boolean </BuyerSelectedShipping>
        <CheckoutStatus> CheckoutStatusCodeType </CheckoutStatus>
        <CompleteStatus> CompleteStatusCodeType </CompleteStatus>
        <eBayPaymentMismatchDetails> eBayPaymentMismatchDetailsType
          <ActionRequiredBy> dateTime </ActionRequiredBy>
          <MismatchAmount currencyID="CurrencyCodeType"> AmountType (double) </MismatchAmount>
          <MismatchType> MismatchTypeCodeType </MismatchType>
        </eBayPaymentMismatchDetails>
        <eBayPaymentStatus> PaymentStatusCodeType </eBayPaymentStatus>
        <InquiryStatus> InquiryStatusCodeType </InquiryStatus>
        <IntegratedMerchantCreditCardEnabled> boolean </IntegratedMerchantCreditCardEnabled>
        <LastTimeModified> dateTime </LastTimeModified>
        <PaymentHoldStatus> PaymentHoldStatusCodeType </PaymentHoldStatus>
        <PaymentMethodUsed> BuyerPaymentMethodCodeType </PaymentMethodUsed>
        <ReturnStatus> ReturnStatusCodeType </ReturnStatus>
      </Status>
      <Taxes> TaxesType
        <TaxDetails> TaxDetailsType
          <Imposition> TaxTypeCodeType </Imposition>
          <TaxAmount currencyID="CurrencyCodeType"> AmountType (double) </TaxAmount>
          <TaxCode> string </TaxCode>
          <TaxDescription> TaxDescriptionCodeType </TaxDescription>
          <TaxOnHandlingAmount currencyID="CurrencyCodeType"> AmountType (double) </TaxOnHandlingAmount>
          <TaxOnShippingAmount currencyID="CurrencyCodeType"> AmountType (double) </TaxOnShippingAmount>
          <TaxOnSubtotalAmount currencyID="CurrencyCodeType"> AmountType (double) </TaxOnSubtotalAmount>
        </TaxDetails>
        <!-- ... more TaxDetails nodes allowed here ... -->
        <TotalTaxAmount currencyID="CurrencyCodeType"> AmountType (double) </TotalTaxAmount>
      </Taxes>
      <TransactionID> string </TransactionID>
      <TransactionPrice currencyID="CurrencyCodeType"> AmountType (double) </TransactionPrice>
      <TransactionSiteID> SiteCodeType </TransactionSiteID>
      <UnpaidItem> UnpaidItemType
        <Status> UnpaidItemCaseStatusTypeCodeType </Status>
        <Type> UnpaidItemCaseOpenTypeCodeType </Type>
      </UnpaidItem>
      <Variation> VariationType
        <SKU> SKUType (string) </SKU>
        <VariationSpecifics> NameValueListArrayType
          <NameValueList> NameValueListType
            <Name> string </Name>
            <Value> string </Value>
            <!-- ... more Value values allowed here ... -->
          </NameValueList>
          <!-- ... more NameValueList nodes allowed here ... -->
        </VariationSpecifics>
        <!-- ... more VariationSpecifics nodes allowed here ... -->
        <VariationTitle> string </VariationTitle>
        <VariationViewItemURL> anyURI </VariationViewItemURL>
      </Variation>
    </Transaction>
    <!-- ... more Transaction nodes allowed here ... -->
  </TransactionArray>
  <TransactionsPerPage> int </TransactionsPerPage>
  <!-- Standard Output Fields -->
  <Ack> AckCodeType </Ack>
  <Build> string </Build>
  <CorrelationID> string </CorrelationID>
  <Errors> ErrorType
    <ErrorClassification> ErrorClassificationCodeType </ErrorClassification>
    <ErrorCode> token </ErrorCode>
    <ErrorParameters ParamID="string"> ErrorParameterType
      <Value> string </Value>
    </ErrorParameters>
    <!-- ... more ErrorParameters nodes allowed here ... -->
    <LongMessage> string </LongMessage>
    <SeverityCode> SeverityCodeType </SeverityCode>
    <ShortMessage> string </ShortMessage>
  </Errors>
  <!-- ... more Errors nodes allowed here ... -->
  <HardExpirationWarning> string </HardExpirationWarning>
  <Timestamp> dateTime </Timestamp>
  <Version> string </Version>
</GetSellerTransactionsResponse>
Return Value Type Occurrence Meaning
Call-specific Output Fields [Jump to standard fields]
HasMoreTransactions boolean Always This flag indicates whether there are additional pages of order line items to view. This field will be returned as 'true' if there are additional pages or order line items to view, or 'false' if the current page of order line item data is the last page of data.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
PageNumber int Always This value indicates the page number of retrieved order line items that match the input criteria. This value is controlled by the Pagination.PageNumber value passed in the call request. To scroll through all pages of order line items that match the input criteria, you increment the Pagination.PageNumber value by '1' with each subsequent GetSellerTransactions call.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
PaginationResult PaginationResultType Always Container consisting of the total number of order line items that match the input criteria and the total number of pages that must be scrolled through to view all order line items. To scroll through each page of order line item data, make subsequent GetSellerTransactions calls, incrementing the Pagination.PageNumber field by a value of '1' each time.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
PaginationResult
  .TotalNumberOfEntries
int Always Indicates the total number of entries that could be returned by repeated call requests. Returned with a value of 0 if no entries are available.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
PaginationResult
  .TotalNumberOfPages
int Always Indicates the total number of pages of data that could be returned by repeated requests. Returned with a value of 0 if no pages are available.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
PayPalPreferred boolean Always Indicates whether the seller has the preference enabled that shows that the seller prefers PayPal as the method of payment for an item. This preference is indicated on an item's View Item page and is intended to influence a buyer to use PayPal to pay for the item.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
ReturnedTransactionCountActual int Always This value indicates the total number of (non-empty) order line items retrieved in the current page of results. The ReturnedTransactionCountActual value will be lower than the TransactionsPerPage value if one or more empty order line items are retrieved on the page.

Note: Due to the fact that item data on the eBay platform has a shorter retention period than order data, it is possible that some retrieved pages will contain no data. For pages that contain no order line item data, the ReturnedTransactionCountActual value will be '0'. It is also possible that pages 2, 3, and 4 have no data, but pages 1 and 5 do have data. Therefore, we recommend that you scroll through each page of data (making subsequent GetSellerTransactions calls and incrementing the Pagination.PageNumber value by '1' each time) until you reach the last page, indicated by HasMoreTransactions=false.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
Seller UserType Always Contains information about the seller whose order line items are being returned. See the reference guide for information about the Seller object fields that are returned.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
Seller.AboutMePage boolean Always If true, indicates that the user has set up an About Me page.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
Seller.CharityAffiliations CharityAffiliationsType Conditionally Contains information about the seller's charity affliations. Returned if the user is affiliated with one or more charities. Seller must be registered with the eBay Giving Works provider to be affiliated with a charity non-profit organization.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.

See eBay Giving Works Program.

Seller.CharityAffiliations
  .CharityID
CharityIDType (string) Conditionally,
repeatable: [0..*]
Indicates the affiliation status for nonprofit charity organizations registered with the dedicated eBay Giving Works provider.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
Seller.eBayGoodStanding boolean Always If true, indicates that the user is in good standing with eBay.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
Seller.EIASToken string Always Unique identifier for the user that does not change when the eBay user name is changed. Use when an application needs to associate a new eBay user name with the corresponding eBay user.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.

See Working with Anonymous User Information.

Seller.Email string Always Email address for the user. Please see the links below to the topics related to anonymous user information and static email addresses. You cannot retrieve an email address for any user with whom you do not have an order relationship, regardless of site. An email address of another user is only returned if you and the other user are in an order relationship, within a certain time of order line item creation (although this limitation isn't applicable to the GetAllBidders call in the case of motor vehicles categories.) Based on Trust and Safety policies, the time is unspecified and can vary by site.

Since a bidder's user info is anonymous, this tag will be returned only to that bidder, and to the seller of an item that the user is bidding on.

For the order retrieval calls, the buyer's registration email address is only returned if the buyer is registered on the DE, AT, or CH sites, regardless of the seller's registration site and the site to which the seller sends the request.
Max length: 64 for US. May differ for other countries. Note: The eBay database allocates up to 128 characters for this field .

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.

See:
    Working with Anonymous User Information
    Static Email Addresses in Trading API Calls

Seller.FeedbackPrivate boolean Always Indicates whether the user has chosen to make their feedback score and feedback details private (hidden from other users). Note that the percentage of positive feedback can still be returned, even if other feedback details are private.

Since a bidder's user info is anonymous, this tag will be returned only to that bidder, and to the seller of an item that the user is bidding on.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.

See Working with Anonymous User Information.

Seller.FeedbackRatingStar FeedbackRatingStarCodeType Always Visual indicator of user's feedback score. See FeedbackRatingStarCodeType for specific values.

Applicable values:

•   Blue

(out) Blue Star, feedback score 50-99.

•   CustomCode

(out) Reserved for internal or future use.

•   Green

(out) Green Star, feedback score 5,000-9,999.

•   GreenShooting

(out) Green Shooting Star, feedback score 500,000-999,999.

•   None

(out) No graphic displayed, feedback score 0-9.

•   Purple

(out) Purple Star, feedback score 500-999.

•   PurpleShooting

(out) Purple Shooting Star, feedback score 50,000-99,999.

•   Red

(out) Red Star, feedback score 1,000-4,999

•   RedShooting

(out) Red Shooting Star, feedback score 100,000-499,999.

•   SilverShooting

(out) Silver Shooting Star, feedback score 1,000,000 and above.

•   Turquoise

(out) Turquoise Star, feedback score 100-499.

•   TurquoiseShooting

(out) Turquoise Shooting Star, feedback score 25,000-49,999.

•   Yellow

(out) Yellow Star, feedback score 10-49.

•   YellowShooting

(out) Yellow Shooting Star, feedback score 10,000-24,999.




DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
Seller.FeedbackScore int Always The aggregate feedback score for a user. A user's feedback score is the net positive feedback minus the net negative feedback left for the user. Feedback scores are a quantitative expression of the desirability of dealing with a user as a buyer or a seller in either side of an order. Each order line item can result in one feedback entry for a given user (the buyer can leave feedback for the seller, and the seller can leave feedback for the buyer.). That one feedback can be positive, negative, or neutral. The aggregated feedback counts for a particular user represent that user's overall feedback score (referred to as a "feedback rating" on the eBay site). If the user has chosen to make their feedback private and that user is not the user identified in the request's authentication token, FeedbackScore is not returned and FeedbackPrivate is returned with a value of true.

In GetMyeBayBuying and GetMyeBaySelling, feedback information (FeedbackScore and FeedbackRatingStar) is returned in BidList.ItemArray.Item.Seller. For GetMyeBayBuying, the feedback score of each seller with an item having received a bid from the buyer is returned. For GetMyeBaySelling, the feedback score of the seller is returned.

GetMyeBayBuying and GetMyeBaySelling also return feedback information (FeedbackScore and FeedbackRatingStar) in BidList.ItemArray.Item.SellingStatus.HighBidder. GetMyeBayBuying returns feedback information on the high bidder of each item the buyer is bidding on. GetMyeBaySelling returns feedback information on the high bidder of each item the seller is selling.

Since a bidder's user info is anonymous, the real feedback score will be returned only to that bidder, and to the seller of an item that the user is bidding on. For all other users, the value -99 is returned.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.

See Working with Anonymous User Information.

Seller.IDVerified boolean Always Indicates whether the user has been verified. For more information about the ID Verify program, see: http://pages.ebay.com/help/policies/identity-idverify.html

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
Seller.NewUser boolean Always If true, identifies a new user who has been a registered eBay user for 30 days or less. Always false after the user has been registered for more than 30 days. Does not indicate an ID change (see UserIdChanged).

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
Seller.PositiveFeedbackPercent float Conditionally Percent of total feedback that is positive. For example, if the member has 50 feedbacks, where 49 are positive and 1 is neutral or negative, the positive feedback percent could be 98.0. The value uses a max precision of 4 and a scale of 1. If the user has feedback, this value can be returned regardless of whether the member has chosen to make their feedback private. Not returned if the user has no feedback.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
Seller.RegistrationAddress AddressType Conditionally This container consists of the Registration address for the eBay user making the call.

GetUser: eBay returns complete RegistrationAddress details (including Phone), as applicable to the registration site for the eBay user making the call. The RegistrationAddress container will only be returned if the Detail

GetItem and GetSellerTransactions: RegistrationAddress for another user (except for Phone) is only returned if you have an order relationship with that user AND that user is registered on DE/AT/CH, regardless of your registration site and the site to which you send the request. For example, the seller can see the buyer's registration address if the buyer is registered on DE/AT/CH, or the buyer can see the seller's registration address if the seller is registered on DE/AT/CH. (The buyer and seller won't see their own registration addresses in GetItem.)

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
Seller.RegistrationAddress
  .AddressAttribute
AddressAttributeType (string) Conditionally,
repeatable: [0..*]
This field shows an attribute for the address, and its corresponding value. Currently, this field is only used to display the reference ID for a "Click and Collect" order, but in the future, other address attributes may be returned in this field.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
Seller.RegistrationAddress
  .AddressAttribute
  [ attribute type ]
AddressAttributeCodeType Conditionally This field shows an attribute for the address, and its corresponding value. Currently, this field is only used to display the reference ID for a "Click and Collect" order, but in the future, other address attributes may be returned in this field.

For a list of possible enumeration values, see AddressAttributeCodeType.
Seller.RegistrationAddress
  .AddressID
string Conditionally Unique ID for a user's address in the eBay database. This value can help prevent the need to store an address multiple times across multiple orders. The ID changes if a user changes their address.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
Seller.RegistrationAddress
  .AddressUsage
AddressUsageCodeType Conditionally This tag tells whether current address is a default shipping address or one of the shipping addresses in address book.

Applicable values:

•   CustomCode

(out) Reserved for internal or future use.

•   DefaultShipping

(out) This is default shipping address which is rendered to buyer on checkout.

•   Invalid

(out) This is not a valid address. Please use another address.

•   Shipping

(out) This is an address which is in user's address book. It can be used at the time of checkout.




DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
Seller.RegistrationAddress
  .ExternalAddressID
string Conditionally ID assigned to the address by the address owner, e.g. by the PayPal system. Currently, the ExternalAddressID only applies for a customer address in the PayPal system. The ID changes if a user changes their address. Also see the AddressOwner field. The ExternalAddressID value also is applicable to Half.com (for GetOrders).
Max length: 20.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
Seller.RegistrationAddress
  .Name
string Conditionally User's name for the address. Also applicable to Half.com (for GetOrders).
Max length: This varies based on the user's country. Currently, the maximum length is 64 for the US. Note: The eBay database allocates up to 128 characters for this field. .

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
Seller.RegistrationDate dateTime Always Indicates the date the specified user originally registered with eBay.

Since a bidder's user info is anonymous, this tag will be returned only to that bidder, and to the seller of an item that the user is bidding on.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.

See Working with Anonymous User Information.

Seller.SellerInfo SellerType Always Contains information about a seller, including listing settings, listing preferences, seller rankings, and seller type.

This field is replaced by the SellerBusinessType field if the user is a business seller with a site ID of 77 (Germany), ID of 3 (UK), ID of 205 (Ireland) or ID of 0 (US Motors).

See SellerType or SellerBusinessCodeType for the child elements.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
Seller.SellerInfo
  .AllowPaymentEdit
boolean Always Indicates whether the user as a seller by default allows buyers to edit the total cost of an item (while in checkout). (Sellers enable this property in their My eBay user preferences on the eBay site.)

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
Seller.SellerInfo
  .CheckoutEnabled
boolean Always This flag indicates whether or not the seller's Checkout Enabled preference is turned on (at account level or at listing level). This preference is managed through Payment Preferences in My eBay. If this preference is enabled, a Pay Now button will appear in checkout flow pages and in the email notifications that are sent to buyers. This preferance is enabled by default if PayPal is one of the payment methods.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
Seller.SellerInfo
  .CIPBankAccountStored
boolean Always If true, this flag indicates that the seller has stored bank account information on file with eBay. A seller must have stored bank account information on file with eBay in order to use 'CashOnPickup' as a payment method (known as 'Pay upon Pickup' on the site). This field is applicable to all eBay sites that support 'CashOnPickup' as a payment method.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
Seller.SellerInfo.GoodStanding boolean Always If true, indicates that the user is in good standing with eBay. (One of the requirements for listing a new item with Immediate Payment.)

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
Seller.SellerInfo
  .MerchandizingPref
MerchandizingPrefCodeType (token) Always Indicates whether the seller participates in the Merchandising Manager feature. If so, the seller can set up rules for cross-promoting items from the seller's store. If not, eBay cross-promotes items as the seller's items are being viewed or purchased.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
Seller.SellerInfo
  .QualifiesForB2BVAT
boolean Always Indicates whether the user is subject to VAT. Users who have registered with eBay as VAT-exempt are not subject to VAT.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
Seller.SellerInfo
  .SafePaymentExempt
boolean Always If true, the user is currently exempt from the requirement to offer at least one safe payment method (PayPal/PaisaPay or one of the credit cards specified in Item.PaymentMethods) when listing items. This value should only return true for sellers who registered before January 17, 2007. Otherwise, it should return false. This setting overrides both the site and category values for SafePaymentRequired.
Default: false.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
Seller.SellerInfo
  .SellereBayPaymentProcessConsent
SellereBayPaymentProcessConsentCodeType Conditionally This container is returned to all DE and AT sellers and consists of details of the seller's account status regarding the new eBay payment process. This information includes the seller's payout preferences and whether or not the seller has accepted the supplemental user agreement for the new eBay payment process.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
Seller.SellerInfo
  .SellereBayPaymentProcessConsent
  .PayoutMethod
PayoutMethodType Conditionally Enumeration value that indicates the account type that the DE or AT seller has selected as their default seller payout account. Once a DE or AT seller has accepted the supplemental user agreement for the new eBay payment process, that seller must set the default payout account in My eBay preferences. eBay will distribute seller payouts to this account. This field will not be returned if PayoutMethodSet='false'.

Note: The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice.

Applicable values:

•   EFT

(out) This value indicates that the seller wants eBay to distribute payouts to their bank account via EFT (Electronic Funds Transfer).

•   MONEYBOOKERS

(out) This value indicates that the seller wants eBay to distribute payouts to their Moneybookers (Skrill) account.

•   PAYPAL

(out) This value indicates that the seller wants eBay to distribute payouts to their PayPal account.




DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
Seller.SellerInfo
  .SellereBayPaymentProcessConsent
  .PayoutMethodSet
boolean Conditionally Flag to indicate whether or not a DE or AT seller has set the payout method type on the account. This field is always returned with the SellereBayPaymentProcessConsent container.

Note: The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
Seller.SellerInfo
  .SellereBayPaymentProcessConsent
  .UserAgreementInfo
UserAgreementInfoType Conditionally,
repeatable: [0..*]
Container consisting of details related to the current status of a DE or AT seller signing the required supplemental user agreement for the new eBay payment process. This container will always be returned to DE and AT sellers and the child values that are returned will be dependent on the current SellereBayPaymentProcessStatus value for the seller's account.

If the seller lists items on both the DE and AT sites, a UserAgreementInfo container will be returned for each site, with the sites being distinguished by the UserAgreementInfo.Site value (either 'Germany' or 'Austria').

Note: The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
Seller.SellerInfo
  .SellereBayPaymentProcessConsent
  .UserAgreementInfo
  .AcceptedTime
dateTime Conditionally This timestamp indicates the date on which the DE or AT seller accepted the supplemental user agreement for the new payment process. Unless the UserAgreementInfo.SellereBayPaymentProcessStatus value is 'MustAcceptUA', this value is always returned with UserAgreementInfo container.

Note: The introduction of the new eBay payment process for the entire German and Austrian eBay marketplace has been delayed until further notice.


DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
Seller.SellerInfo
  .SellereBayPaymentProcessConsent
  .UserAgreementInfo
  .SellereBayPaymentProcessEnableTime
dateTime Conditionally This timestamp indicates the date on which the new eBay payment process was fully enabled (if UserAgreementInfo.SellereBayPaymentProcessStatus='eBayPaymentProcessEnabled') or scheduled to be enabled (if UserAgreementInfo.SellereBayPaymentProcessStatus='AcceptedUA' or 'MustAcceptUA', and the enable date is known by eBay). Unless the eBay payment process enable date is not known for the seller, this value is always returned with UserAgreementInfo container.

Note: The introduction of the new eBay payment process for the entire German and Austrian eBay marketplace has been delayed until further notice.


DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
Seller.SellerInfo
  .SellereBayPaymentProcessConsent
  .UserAgreementInfo
  .SellereBayPaymentProcessStatus
SellereBayPaymentProcessStatusCodeType Conditionally Enumeration value that indicates whether or not a new DE or AT seller has accepted the supplement user agreement for the new payment process for that site (indicated by the UserAgreementInfo.site value). This value is always returned with the UserAgreementInfo container.

Note: The introduction of the new eBay payment process for the entire German and Austrian eBay marketplace has been delayed until further notice.


Applicable values:

•   AcceptedUA

(out) This value indicates that the DE or AT seller has accepted the supplemental user agreement related to the new payment process, but the new payment process has yet to be fully implemented on the seller's account.

Note: The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice.

•   CustomCode

(out) Reserved for internal or future use

•   eBayPaymentProcessEnabled

(out) This value indicates that the DE or AT seller has accepted the supplemental user agreement related to the new payment process and the new payment process is fully implemented on the seller's account.

Note: The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice.

•   MustAcceptUA

(out) This value indicates that the DE or AT seller has yet to accept the supplemental user agreement related to the new payment process. If the new payment process has been fully implemented on the seller's account, this seller will be blocked from listing on the DE and AT sites until the user agreement is accepted.

Note: The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice.




DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
Seller.SellerInfo
  .SellereBayPaymentProcessConsent
  .UserAgreementInfo.Site
SiteCodeType Conditionally String value that indicates the site to which the supplemental user agreement information pertains. This value is always returned with the UserAgreementInfo container.

Although this value is based on SiteCodeType (which contains many values), the only values that will be returned here are 'Germany' or 'Austria'.

Note: The introduction of the new eBay payment process for the entire German and Austrian eBay marketplace has been delayed until further notice.


Applicable values: See Site.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
Seller.SellerInfo
  .SellereBayPaymentProcessConsent
  .UserAgreementInfo
  .UserAgreementURL
anyURI Conditionally This is the URL for new eBay payment process supplemental user agreement. This URL is only returned if the UserAgreementInfo.SellereBayPaymentProcessStatus='MustAcceptUA'.

Note: The introduction of the new eBay payment process for the entire German and Austrian eBay marketplace has been delayed until further notice.


DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
Seller.SellerInfo
  .SellereBayPaymentProcessStatus
SellereBayPaymentProcessStatusCodeType Conditionally This enumeration value indicates the current status of a DE or AT seller's account related to the new eBay payment process.

'AcceptedUA' is returned if the DE or AT seller has accepted the supplemental user agreement for the new eBay payment process, but that same seller's account is not yet ramped up in the new eBay payment process.

'eBayPaymentProcessEnabled' is returned if the DE or AT seller has accepted the supplemental user agreement for the new eBay payment process, and that same seller's account is ramped up in the new eBay payment process.

'MustAcceptUA' is returned if the DE or AT seller has not accepted the supplemental user agreement for the new eBay payment process. If this is the case, the seller can find the URL to the supplemental user agreement in the SellereBayPaymentProcessConsent.UserAgreementInfo.UserAgreementURL field.

Applicable values:

•   AcceptedUA

(out) This value indicates that the DE or AT seller has accepted the supplemental user agreement related to the new payment process, but the new payment process has yet to be fully implemented on the seller's account.

Note: The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice.

•   CustomCode

(out) Reserved for internal or future use

•   eBayPaymentProcessEnabled

(out) This value indicates that the DE or AT seller has accepted the supplemental user agreement related to the new payment process and the new payment process is fully implemented on the seller's account.

Note: The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice.

•   MustAcceptUA

(out) This value indicates that the DE or AT seller has yet to accept the supplemental user agreement related to the new payment process. If the new payment process has been fully implemented on the seller's account, this seller will be blocked from listing on the DE and AT sites until the user agreement is accepted.

Note: The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice.




DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
Seller.SellerInfo
  .SellerGuaranteeLevel
SellerGuaranteeLevelCodeType Conditionally Deprecated as of version 773. No longer recommended.
No longer supported.

Applicable values:

•   CustomCode

(out) Reserved for internal or future use.

•   NotEligible

(out) Not eligible for Seller Level Guarantee

•   Premium

(out) Premium eligibility level

•   Regular

(out) Regular eligibility level

•   Ultra

(out) Ultra eligibility level




DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
Deprecation version: 773. See also Deprecated Objects.
Seller.SellerInfo.SellerLevel SellerLevelCodeType Always The user's eBay PowerSeller tier. Possible values are enumerated in the SellerLevelCodeType code list. SellerInfo.SellerLevel is no longer returned in the GetUser, GetBidderList, GetSellerList, GetItem, and GetItemTransactions responses for the US, DE/AT/CH, and UK/IE sites, for version 629 and later. If you are using a version older than 629, SellerInfo.SellerLevel will still be returned. Developers should note that SellerInfo.SellerLevel could potentially be removed from other sites as well.

Applicable values:

•   Bronze

(out) Bronze (lowest tier)

•   CustomCode

(out) Reserved for internal or future use

•   Gold

(out) Gold (between Silver and Platinum)

•   None

(out) Not a PowerSeller (eBay has not yet evaluated your PowerSeller status, or you have not chosen to be a member of the PowerSeller program, or you lost your PowerSeller status due to a policy violation.)

•   Platinum

(out) Platinum (between Gold and Titanium)

•   Silver

(out) Silver (between Bronze and Gold)

•   Titanium

(out) Titanium (highest tier)




DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
Seller.SellerInfo.StoreOwner boolean Always Boolean value indicates whether or not the seller is an eBay Store owner.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
Seller.SellerInfo.StoreURL anyURI Always The URL for the seller's eBay Store. This field is only returned if the seller is a store owner. To determine if a seller is a Store owner, check for the User.SellerInfo.StoreOwner and a value of true. The eBay Stores domain that is returned in this field is based on the SITEID header that is passed in the request, and not on the user's registration address, as was the case prior to version 757. So, if the seller's registration county is the UK, but a SITEID value of 71 (France) is passed into the call, the eBay Stores domain that is returned would be stores.ebay.fr.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
Seller.SellerInfo
  .TopRatedSeller
boolean Conditionally This boolean field indicates if the seller is certified as a Top Rated Seller. To qualify as a Top Rated Seller, a seller must meet the following requirements:
  • 100 or more selling transactions in a one-year period
  • Shipment tracking information provided to the buyer within the specified handling time for at least 90 percent of their listings
This field is returned for the following sites only: US (EBAY-US), Motors (EBAY-MOTOR), AT (EBAY-AT), CH (EBAY-CH), DE (EBAY-DE), IE (EBAY-IE) and UK (EBAY-GB).

On the eBay US site, Top Rated Sellers are eligible to receive a Top Rated Plus seal for their listings. For a Top Rated Seller's listing to qualify as a Top Rated Plus listing, that listing must accept returns and the handling time must be set to one day (DispatchTimeMax=1). Top Rated Plus listings get increased visibility in fixed-price searches and receive a Final Value Fee discount.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.

See:
    Top Rated Seller Resource Center for more information about how to become a Top Rated Seller and qualify for Top Rated Plus on the eBay US site
    Seller Help Page for more information about how to qualify as a Top Rated Seller on the eBay US, AT, CH, DE, IE and UK sites

Seller.Site SiteCodeType Always eBay site the user is registered with.

Since a bidder's user info is anonymous, this tag will be returned only to that bidder, and to the seller of an item that the user is bidding on.

Applicable values: See Site.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.

See Working with Anonymous User Information.

Seller.Status UserStatusCodeType Always Indicates the user's registration/user status.

Applicable values:

•   AccountOnHold

(out) User's account is on hold, such as for non-payment of amounts due eBay; user cannot sell or buy items

•   Confirmed

(out) User has completed online registration and has properly responded to confirmation email; most users should fall in this category

•   CreditCardVerify

(out) User has completed registration and confirmation, but needs to complete verification of credit card information. A user has this status if this user began registration as a seller but did not complete it. A seller with this status can begin to list an item but cannot complete the listing until the seller completes seller registration. (For information on what is needed to complete seller registration, see http://pages.ebay.com/help/sell/questions/sell-requirements.html.)

•   CreditCardVerifyHalfOptIn

(out) User has completed the registration for Half.com and opted to automatically also be registered with eBay, but the user needs to complete verification of credit card information. A user has this status on eBay if this user began registration as a seller but did not complete it. A seller with this status can begin to list an item but cannot complete the listing until the seller completes seller registration. (For information on what is needed to complete seller registration, see http://pages.ebay.com/help/sell/questions/sell-requirements.html.)

•   CustomCode

(out) Reserved for internal or future use

•   Deleted

(out) Records for the specified user have been deleted

•   Ghost

(out) Registered users of AuctionWeb (pre-eBay) who never re-registered on eBay

•   Guest

(out) The user is a guest user. The user has not added a password and has not confirmed an email address. The user has not signed up as a regular user, but has agreed to the User Agreement and Privacy Policy. The user has been through the buying flow for a guest; the user has been through checkout using the streamlined Buy-It-Now flow.

•   InMaintenance

(out) Temporary user record state indicating the record is in the process of being changed by eBay; query user information again to get new status

•   Merged

(out) User record has been merged with another account record for the same user

•   RegistrationCodeMailOut

(out) User has completed online registration and has been sent the confirmation email, but has not yet responded to the confirmation email

•   Suspended

(out) User has been suspended from selling and buying, such as for violations of eBay terms or agreement

•   TermPending

(out) User has been scheduled for account closure (typically when a user has requested to have their account closed) A user in this state should not be considered an active user

•   Unconfirmed

(out) User has completed online registration, but has either not responded to confirmation email or has not yet been sent the confirmation email. Or, if this user began registration as a seller but did not complete it, the user will have this status. A seller with this status can begin to list an item but cannot complete the listing until the seller completes seller registration. (For information on what is needed to complete seller registration, see http://pages.ebay.com/help/sell/questions/sell-requirements.html.)

•   UnconfirmedHalfOptIn

(out) User has completed the registration for Half.com and opted to automatically also be registered with eBay, but the registration confirmation is still pending

•   Unknown

(out) User properties have never been set; this value should seldom, if ever, be returned and typically represents a problem


(Not all values in UserStatusCodeType apply to this field.)


DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
Seller.UserID UserIDType (string) Always Unique eBay user ID for the user.

Since a bidder's user info is anonymous, this tag contains the actual value of an ID only for that bidder, and for the seller of an item that the user is bidding on. For other users, the actual value is replaced by an anonymous value, according to these rules:

When bidding on items, UserID is replaced with the value "a****b" where a and b are random characters from the UserID. For example, if the UserID = IBidALot, it might be displayed as, "I****A".

Note that in this format, the anonymous bidder ID can change for each auction.

For GetMyeBayBuying only, when bidding on items: UserID is replaced with the value "a****b" where a and b are random characters from the UserID.

When bidding on items listed on the the Philippines site: UserID is replaced with the value "Bidder X" where X is a number indicating the order of that user's first bid. For example, if the user was the third bidder, UserID = Bidder 3.

Note that in this Philippines site format, the anonymous bidder ID stays the same for a given auction, but is different for different auctions. For example, a bidder who is the third and then the seventh bidder in an auction will be listed for both bids as "Bidder 3". However, if that same bidder is the first bidder on a different auction, the bidder will be listed for that auction as "Bidder 1", not "Bidder 3".

For GetMyeBayBuying only, when bidding on items listed on the UK and AU sites: UserID is replaced with the string "High Bidder".

For PlaceOffer, see also SellingStatus.HighBidder.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.

See Working with Anonymous User Information.

Seller.UserIDChanged boolean Always If true, identifies a user whose ID has changed within the last 30 days. Does not indicate a new user (see NewUser).

Since a bidder's user info is anonymous, this tag will be returned only to that bidder, and to the seller of an item that the user is bidding on.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.

See Working with Anonymous User Information.

Seller.UserIDLastChanged dateTime Always Date and time the user's data was last changed (in GMT).

Since a bidder's user info is anonymous, this tag will be returned only to that bidder, and to the seller of an item that the user is bidding on.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.

See Working with Anonymous User Information.

Seller.VATStatus VATStatusCodeType Always Indicates whether or not the user is subject to VAT. Users who have registered with eBay as VAT-exempt are not subject to VAT. See documentation on Value-Added Tax (VAT).

Applicable values:

•   CustomCode

(out) Reserved for internal or future use

•   NoVATTax

(out) VAT is not applicable

•   VATExempt

(out) Residence in a country with VAT and user is registered as VAT-exempt

•   VATTax

(out) Residence in a country with VAT and user is not registered as VAT-exempt




DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.

See Value-Added Tax (VAT).

TransactionArray TransactionArrayType Conditionally List of Transaction objects representing the seller's recent sales. Each Transaction object contains the data for one purchase (of one or more items in the same listing). See the reference guide for more information about the fields that are returned for each order line item.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction TransactionType Conditionally,
repeatable: [0..*]
The Transaction container consists of detailed information on one order line item. Also applicable to Half.com (for GetOrders).

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.

See Listing an Item.

TransactionArray.Transaction
  .ActualHandlingCost
AmountType (double) Conditionally The handling cost that the seller has charged for the order line item. This field is only returned after checkout is complete.

The value of this field is returned as zero dollars (0.0) if the seller did not specify a handling cost for the listing.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ActualHandlingCost
  [ attribute currencyID ]
CurrencyCodeType Always The handling cost that the seller has charged for the order line item. This field is only returned after checkout is complete.

The value of this field is returned as zero dollars (0.0) if the seller did not specify a handling cost for the listing.

For a list of possible enumeration values, see CurrencyCodeType.
TransactionArray.Transaction
  .ActualShippingCost
AmountType (double) Conditionally The shipping cost paid by the buyer for the order line item. This field is only returned after checkout is complete.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ActualShippingCost
  [ attribute currencyID ]
CurrencyCodeType Always The shipping cost paid by the buyer for the order line item. This field is only returned after checkout is complete.

For a list of possible enumeration values, see CurrencyCodeType.
TransactionArray.Transaction
  .AdjustmentAmount
AmountType (double) Conditionally Adjustment amount entered by the buyer. A positive amount indicates the amount is an extra charge being paid to the seller by the buyer. A negative value indicates this amount is a credit given to the buyer by the seller.

Not applicable to Half.com.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .AdjustmentAmount
  [ attribute currencyID ]
CurrencyCodeType Always Adjustment amount entered by the buyer. A positive amount indicates the amount is an extra charge being paid to the seller by the buyer. A negative value indicates this amount is a credit given to the buyer by the seller.

Not applicable to Half.com.

For a list of possible enumeration values, see CurrencyCodeType.
TransactionArray.Transaction
  .AmountPaid
AmountType (double) Conditionally The total amount the buyer paid for the order line item. This amount includes all costs such as shipping, handling, or sales tax. If the seller allowed the buyer to change the total for an order, the buyer is able to change the total up until the time when Checkout status is Complete. Determine whether the buyer changed the amount by retrieving the order line item data and comparing the AmountPaid value to what the seller expected. If multiple order line items between the same buyer and seller have been combined into a Combined Invoice order, the AmountPaid value returned in GetSellerTransactions and GetItemTransactions reflects the amount paid for the Combined Invoice order and not the individual order line item. You can determine the order line items that belong to the same Combined Invoice order by checking to see if the ContainingOrder.OrderID value is the same. For Motors items, AmountPaid is the amount paid by the buyer for the deposit.

Not applicable to Half.com.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.

See Combined Invoice.

TransactionArray.Transaction
  .AmountPaid
  [ attribute currencyID ]
CurrencyCodeType Always The total amount the buyer paid for the order line item. This amount includes all costs such as shipping, handling, or sales tax. If the seller allowed the buyer to change the total for an order, the buyer is able to change the total up until the time when Checkout status is Complete. Determine whether the buyer changed the amount by retrieving the order line item data and comparing the AmountPaid value to what the seller expected. If multiple order line items between the same buyer and seller have been combined into a Combined Invoice order, the AmountPaid value returned in GetSellerTransactions and GetItemTransactions reflects the amount paid for the Combined Invoice order and not the individual order line item. You can determine the order line items that belong to the same Combined Invoice order by checking to see if the ContainingOrder.OrderID value is the same. For Motors items, AmountPaid is the amount paid by the buyer for the deposit.

Not applicable to Half.com.

For a list of possible enumeration values, see CurrencyCodeType.
TransactionArray.Transaction
  .BestOfferSale
boolean Conditionally Indicates whether or not the order line item was created as the result of the seller accepting a Best Offer from a buyer.

Not applicable to Half.com.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .Buyer
UserType Conditionally Container consisting of user and shipping details for the buyer. See UserType for its child elements. Returned by GetItemsAwaitingFeedback if Seller is making the request.

Applicable to Half.com (for GetOrders only).

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .Buyer.AboutMePage
boolean Conditionally If true, indicates that the user has set up an About Me page.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .Buyer.BuyerInfo
BuyerType Conditionally Contains information about the user as a buyer, such as the shipping address. See BuyerType for its child elements.

Since a bidder's user info is anonymous, this tag will be returned only to that bidder, and to the seller of an item that the user is bidding on.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.

See Working with Anonymous User Information.

TransactionArray.Transaction
  .Buyer.BuyerInfo
  .BuyerTaxIdentifier
TaxIdentifierType Conditionally,
repeatable: [0..*]
This container consists of taxpayer identification for the buyer. Although this container may be used for other purposes at a later date, it is currently used by sellers selling on the Italy or Spain site to retrieve the taxpayer ID of the buyer.

It is now required that buyers registered on the Italy site provide their Codice Fiscale ID (similar to the Social Security Number for US citizens) before buying an item on the Italy site.

On the Spain site, a Spanish seller has the option to require that Spanish buyers (registered on Spain site) provide a tax ID before checkout. This option is set by the seller at the account level. Once a Spanish buyer provides a tax ID, this tax ID is associated with his/her account, and once a tax ID is associated with the account, Spanish buyer will be asked to provide the tax ID during checkout on all eBay sites. Buyers with a registered address outside of Spain will not be asked to provide a tax ID during checkout.

This container is only returned for Spanish or Italian sellers when the buyer was asked to provide tax identifier information during checkout. A BuyerTaxIdentifier will be returned for each tax ID that is associated with the buyer's account.

Note: The ability for Italian and Spanish sellers to require the buyer's tax ID at checkout is currently ramping up.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .Buyer.BuyerInfo
  .BuyerTaxIdentifier.Attribute
TaxIdentifierAttributeType (string) Conditionally,
repeatable: [0..*]
This field shows an attribute, and its corresponding value for the buyer's tax identification card. Currently, this field is only used to indicate which country issued the buyer's tax ID, but in the future, other attributes related to the tax ID may be returned in this field. This field's value will be an ISO 3166-1 two-digit code that represents the issuing country.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .Buyer.BuyerInfo
  .BuyerTaxIdentifier.Attribute
  [ attribute name ]
TaxIdentifierAttributeCodeType Conditionally This field shows an attribute, and its corresponding value for the buyer's tax identification card. Currently, this field is only used to indicate which country issued the buyer's tax ID, but in the future, other attributes related to the tax ID may be returned in this field. This field's value will be an ISO 3166-1 two-digit code that represents the issuing country.

For a list of possible enumeration values, see TaxIdentifierAttributeCodeType.
TransactionArray.Transaction
  .Buyer.BuyerInfo
  .BuyerTaxIdentifier.ID
string Conditionally This value is the actual tax ID for the buyer. The type of tax ID is shown in the Type field.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .Buyer.BuyerInfo
  .BuyerTaxIdentifier.Type
ValueTypeCodeType Conditionally This enumeration value identifies the type of tax ID that was supplied by the buyer during the checkout process.

Applicable values:

•   CEDULA

(out) This value indicates that the tax ID in the ID field is a Cedula number, which is an identifier used by the Chilean, Columbian, and Dominican Republic governments to identify taxpayers in those countries. This ID is sometimes referred to as a 'Cedula de Identidad'.

•   CodiceFiscale

(out) This value indicates that the tax ID in the ID field is a Codice Fiscale ID, which is an identifier used by the Italian government to identify taxpayers in Italy.

•   CPFTaxID

(out) This value indicates that the tax ID in the ID field is a Tax Registration Number, which is an identifier used by the Brazilian government to identify taxpayers in Brazil. In Portuguese, this ID is known as the 'Cadastro de Pessoas Fisicas', or 'CPF'.

•   CustomCode

(out) Reserved for future use.

•   DNI

(out) This value indicates that the tax ID in the ID field is a Spanish National Identity Number, which is one identifier used by the Spanish government to identify taxpayers in Spain. In Spanish, this ID is known as the 'Documento nacional de identidad'. The other tax identifier for Spanish residents is the NIE number, or 'Numero de Identidad de Extranjero'.

•   NIE

(out) This value indicates that the tax ID in the ID field is a NIE Number, which is one identifier used by the Spanish government to identify taxpayers in Spain. 'NIE' stands for 'Numero de Identidad de Extranjero'. The other tax identifier for Spanish residents is the DNI number, or 'Documento nacional de identidad'. Spanish residents can also be identified by their Spanish VAT (Value-Added Tax) number, which is also called the 'Numero de Identificacion Fiscal' or NIF.

•   NIF

(out) This value indicates that the ID in the ID field is an NIF Number, which is also known as their Spanish VAT (Value-Added Tax) number. 'NIF' stands for 'Numero de Identificacion Fiscal'. Spanish residents can also be identified by their DNI ('Documento nacional de identidad') number or their NIE ('Numero de Identidad de Extranjero') number.

•   NIT

(out) This value indicates that the tax ID in the ID field is a NIT number, which is an identifier used by the Guatemalan government to identify taxpayers in Guatemala. In Spanish, this ID is known as the 'Numero de identificacion tributaria'.

•   RussianPassport

(out) This value indicates that the tax ID in the ID field is a Russian Passport number.

•   TurkeyID

(out) This value indicates that the tax ID in the ID field is a Turkish Identification Number, which is an identifier used by the Turkish government to identify taxpayers in Turkey. In Turkish, this ID is known as the 'Turkiye Cumhuriyeti Kimlik Numarasi', often abbreviated as T.C. Kimlik No.


(Not all values in ValueTypeCodeType apply to this field.)


DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .Buyer.BuyerInfo
  .ShippingAddress
AddressType Conditionally Contains the shipping address of the buyer. See AddressType for its child elements. GetAllBidders is returning only Country and PostalCode currently. Output only.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .Buyer.BuyerInfo
  .ShippingAddress
  .AddressAttribute
AddressAttributeType (string) Conditionally,
repeatable: [0..*]
This field shows an attribute for the address, and its corresponding value. Currently, this field is only used to display the reference ID for a "Click and Collect" order, but in the future, other address attributes may be returned in this field.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .Buyer.BuyerInfo
  .ShippingAddress
  .AddressAttribute
  [ attribute type ]
AddressAttributeCodeType Conditionally This field shows an attribute for the address, and its corresponding value. Currently, this field is only used to display the reference ID for a "Click and Collect" order, but in the future, other address attributes may be returned in this field.

For a list of possible enumeration values, see AddressAttributeCodeType.
TransactionArray.Transaction
  .Buyer.BuyerInfo
  .ShippingAddress.AddressID
string Conditionally Unique ID for a user's address in the eBay database. This value can help prevent the need to store an address multiple times across multiple orders. The ID changes if a user changes their address.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .Buyer.BuyerInfo
  .ShippingAddress.AddressUsage
AddressUsageCodeType Conditionally This tag tells whether current address is a default shipping address or one of the shipping addresses in address book.

Applicable values:

•   CustomCode

(out) Reserved for internal or future use.

•   DefaultShipping

(out) This is default shipping address which is rendered to buyer on checkout.

•   Invalid

(out) This is not a valid address. Please use another address.

•   Shipping

(out) This is an address which is in user's address book. It can be used at the time of checkout.




DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .Buyer.BuyerInfo
  .ShippingAddress.CityName
string Conditionally The name of the user's city. Also applicable to Half.com (for GetOrders).
Max length: This varies based on the user's country. Currently, the maximum length is 64 for the US. Note: The eBay database allocates up to 128 characters for this field. .

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .Buyer.BuyerInfo
  .ShippingAddress.Country
CountryCodeType Conditionally The two-digit code representing the country of the user.

If not provided as input, eBay uses the country associated with the eBay Site ID when the call is made.

For a Global Shipping Program order, GetSellerList returns the country code of the buyer, not the international shipping provider.

Also applicable to Half.com (for GetOrders).

Applicable values: See Country.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .Buyer.BuyerInfo
  .ShippingAddress.CountryName
string Conditionally The name of the user's country. Also applicable to Half.com (for GetOrders).
Max length: eBay validates the content, but not the length for this field. Note: The eBay database allocates up to 128 characters for this field. .

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .Buyer.BuyerInfo
  .ShippingAddress
  .ExternalAddressID
string Conditionally ID assigned to the address by the address owner, e.g. by the PayPal system. Currently, the ExternalAddressID only applies for a customer address in the PayPal system. The ID changes if a user changes their address. Also see the AddressOwner field. The ExternalAddressID value also is applicable to Half.com (for GetOrders).
Max length: 20.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .Buyer.BuyerInfo
  .ShippingAddress.Name
string Conditionally User's name for the address. Also applicable to Half.com (for GetOrders).
Max length: This varies based on the user's country. Currently, the maximum length is 64 for the US. Note: The eBay database allocates up to 128 characters for this field. .

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .Buyer.BuyerInfo
  .ShippingAddress.Phone
string Conditionally User's primary phone number. This may return a value of "Invalid Request" if you are not authorized to see the user's phone number.

In the US, the area code (3 digits), the prefix (3 digits), the line number (4 digits), and phone extension (if specified by the user) are returned in this field. The extension can be one or more digits. Non-breaking spaces are used as delimiters between these phone number components.

Also applicable to Half.com (for GetOrders).
Max length: eBay validates the content (should only be integer values and delimiters), but not the length for this field. Note: The eBay database allocates up to 128 characters for this field. .

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .Buyer.BuyerInfo
  .ShippingAddress.PostalCode
string Conditionally User's postal code.

For a Global Shipping Program order, GetSellerList and GetMyeBaySelling return the postal code of the buyer, not that of the international shipping provider.

Also applicable to Half.com (for GetOrders).
Max length: This varies based on the user's country. Currently, the maximum length is 9 (not counting delimiter characters) for the US. Note: The eBay database allocates up to 24 characters for this field. .

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .Buyer.BuyerInfo
  .ShippingAddress
  .StateOrProvince
string Conditionally The region of the user's address. Also applicable to Half.com (for GetOrders).
Max length: This varies based on the user's country. Currently, the maximum length is 64 for the US. Note: The eBay database allocates up to 128 characters for this field. .

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .Buyer.BuyerInfo
  .ShippingAddress.Street
string Conditionally A concatenation of Street1 and Street2, primarily for RegistrationAddress. Not applicable to Half.com.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .Buyer.BuyerInfo
  .ShippingAddress.Street1
string Conditionally Line 1 of the user's street address. Also applicable to Half.com (for GetOrders).
Max length: This varies based on the user's country. Currently, the maximum length is 180 for the US. Note: The eBay database allocates up to 512 characters for this field. .

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .Buyer.BuyerInfo
  .ShippingAddress.Street2
string Conditionally Line 2 of the user's address (such as an apartment number). Returned if the user specified a second street value for their address. Also applicable to Half.com (for GetOrders).
In case of Item.SellerContactDetails, Street2 can be used to provide City, Address, State, and Zip code (if applicable).
Max length: This varies based on the user's country. Currently, the maximum length is 180 for the US. Note: The eBay database allocates up to 512 characters for this field. .

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .Buyer.CharityAffiliations
CharityAffiliationsType Conditionally Contains information about the seller's charity affliations. Returned if the user is affiliated with one or more charities. Seller must be registered with the eBay Giving Works provider to be affiliated with a charity non-profit organization.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.

See eBay Giving Works Program.

TransactionArray.Transaction
  .Buyer.CharityAffiliations
  .CharityID
CharityIDType (string) Conditionally,
repeatable: [0..*]
Indicates the affiliation status for nonprofit charity organizations registered with the dedicated eBay Giving Works provider.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .Buyer.eBayGoodStanding
boolean Conditionally If true, indicates that the user is in good standing with eBay.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .Buyer.EIASToken
string Conditionally Unique identifier for the user that does not change when the eBay user name is changed. Use when an application needs to associate a new eBay user name with the corresponding eBay user.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.

See Working with Anonymous User Information.

TransactionArray.Transaction
  .Buyer.Email
string Conditionally Email address for the user. Please see the links below to the topics related to anonymous user information and static email addresses. You cannot retrieve an email address for any user with whom you do not have an order relationship, regardless of site. An email address of another user is only returned if you and the other user are in an order relationship, within a certain time of order line item creation (although this limitation isn't applicable to the GetAllBidders call in the case of motor vehicles categories.) Based on Trust and Safety policies, the time is unspecified and can vary by site.

Since a bidder's user info is anonymous, this tag will be returned only to that bidder, and to the seller of an item that the user is bidding on.

For the order retrieval calls, the buyer's registration email address is only returned if the buyer is registered on the DE, AT, or CH sites, regardless of the seller's registration site and the site to which the seller sends the request.
Max length: 64 for US. May differ for other countries. Note: The eBay database allocates up to 128 characters for this field .

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.

See:
    Working with Anonymous User Information
    Static Email Addresses in Trading API Calls

TransactionArray.Transaction
  .Buyer.FeedbackPrivate
boolean Conditionally Indicates whether the user has chosen to make their feedback score and feedback details private (hidden from other users). Note that the percentage of positive feedback can still be returned, even if other feedback details are private.

Since a bidder's user info is anonymous, this tag will be returned only to that bidder, and to the seller of an item that the user is bidding on.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.

See Working with Anonymous User Information.

TransactionArray.Transaction
  .Buyer.FeedbackRatingStar
FeedbackRatingStarCodeType Conditionally Visual indicator of user's feedback score. See FeedbackRatingStarCodeType for specific values.

Applicable values:

•   Blue

(out) Blue Star, feedback score 50-99.

•   CustomCode

(out) Reserved for internal or future use.

•   Green

(out) Green Star, feedback score 5,000-9,999.

•   GreenShooting

(out) Green Shooting Star, feedback score 500,000-999,999.

•   None

(out) No graphic displayed, feedback score 0-9.

•   Purple

(out) Purple Star, feedback score 500-999.

•   PurpleShooting

(out) Purple Shooting Star, feedback score 50,000-99,999.

•   Red

(out) Red Star, feedback score 1,000-4,999

•   RedShooting

(out) Red Shooting Star, feedback score 100,000-499,999.

•   SilverShooting

(out) Silver Shooting Star, feedback score 1,000,000 and above.

•   Turquoise

(out) Turquoise Star, feedback score 100-499.

•   TurquoiseShooting

(out) Turquoise Shooting Star, feedback score 25,000-49,999.

•   Yellow

(out) Yellow Star, feedback score 10-49.

•   YellowShooting

(out) Yellow Shooting Star, feedback score 10,000-24,999.




DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .Buyer.FeedbackScore
int Conditionally The aggregate feedback score for a user. A user's feedback score is the net positive feedback minus the net negative feedback left for the user. Feedback scores are a quantitative expression of the desirability of dealing with a user as a buyer or a seller in either side of an order. Each order line item can result in one feedback entry for a given user (the buyer can leave feedback for the seller, and the seller can leave feedback for the buyer.). That one feedback can be positive, negative, or neutral. The aggregated feedback counts for a particular user represent that user's overall feedback score (referred to as a "feedback rating" on the eBay site). If the user has chosen to make their feedback private and that user is not the user identified in the request's authentication token, FeedbackScore is not returned and FeedbackPrivate is returned with a value of true.

In GetMyeBayBuying and GetMyeBaySelling, feedback information (FeedbackScore and FeedbackRatingStar) is returned in BidList.ItemArray.Item.Seller. For GetMyeBayBuying, the feedback score of each seller with an item having received a bid from the buyer is returned. For GetMyeBaySelling, the feedback score of the seller is returned.

GetMyeBayBuying and GetMyeBaySelling also return feedback information (FeedbackScore and FeedbackRatingStar) in BidList.ItemArray.Item.SellingStatus.HighBidder. GetMyeBayBuying returns feedback information on the high bidder of each item the buyer is bidding on. GetMyeBaySelling returns feedback information on the high bidder of each item the seller is selling.

Since a bidder's user info is anonymous, the real feedback score will be returned only to that bidder, and to the seller of an item that the user is bidding on. For all other users, the value -99 is returned.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.

See Working with Anonymous User Information.

TransactionArray.Transaction
  .Buyer.IDVerified
boolean Conditionally Indicates whether the user has been verified. For more information about the ID Verify program, see: http://pages.ebay.com/help/policies/identity-idverify.html

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .Buyer.NewUser
boolean Conditionally If true, identifies a new user who has been a registered eBay user for 30 days or less. Always false after the user has been registered for more than 30 days. Does not indicate an ID change (see UserIdChanged).

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .Buyer.PositiveFeedbackPercent
float Conditionally Percent of total feedback that is positive. For example, if the member has 50 feedbacks, where 49 are positive and 1 is neutral or negative, the positive feedback percent could be 98.0. The value uses a max precision of 4 and a scale of 1. If the user has feedback, this value can be returned regardless of whether the member has chosen to make their feedback private. Not returned if the user has no feedback.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .Buyer.RegistrationAddress
AddressType Conditionally This container consists of the Registration address for the eBay user making the call.

GetUser: eBay returns complete RegistrationAddress details (including Phone), as applicable to the registration site for the eBay user making the call. The RegistrationAddress container will only be returned if the Detail

GetItem and GetSellerTransactions: RegistrationAddress for another user (except for Phone) is only returned if you have an order relationship with that user AND that user is registered on DE/AT/CH, regardless of your registration site and the site to which you send the request. For example, the seller can see the buyer's registration address if the buyer is registered on DE/AT/CH, or the buyer can see the seller's registration address if the seller is registered on DE/AT/CH. (The buyer and seller won't see their own registration addresses in GetItem.)

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .Buyer.RegistrationAddress
  .AddressAttribute
AddressAttributeType (string) Conditionally,
repeatable: [0..*]
This field shows an attribute for the address, and its corresponding value. Currently, this field is only used to display the reference ID for a "Click and Collect" order, but in the future, other address attributes may be returned in this field.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .Buyer.RegistrationAddress
  .AddressAttribute
  [ attribute type ]
AddressAttributeCodeType Conditionally This field shows an attribute for the address, and its corresponding value. Currently, this field is only used to display the reference ID for a "Click and Collect" order, but in the future, other address attributes may be returned in this field.

For a list of possible enumeration values, see AddressAttributeCodeType.
TransactionArray.Transaction
  .Buyer.RegistrationAddress
  .AddressID
string Conditionally Unique ID for a user's address in the eBay database. This value can help prevent the need to store an address multiple times across multiple orders. The ID changes if a user changes their address.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .Buyer.RegistrationAddress
  .AddressUsage
AddressUsageCodeType Conditionally This tag tells whether current address is a default shipping address or one of the shipping addresses in address book.

Applicable values:

•   CustomCode

(out) Reserved for internal or future use.

•   DefaultShipping

(out) This is default shipping address which is rendered to buyer on checkout.

•   Invalid

(out) This is not a valid address. Please use another address.

•   Shipping

(out) This is an address which is in user's address book. It can be used at the time of checkout.




DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .Buyer.RegistrationAddress
  .ExternalAddressID
string Conditionally ID assigned to the address by the address owner, e.g. by the PayPal system. Currently, the ExternalAddressID only applies for a customer address in the PayPal system. The ID changes if a user changes their address. Also see the AddressOwner field. The ExternalAddressID value also is applicable to Half.com (for GetOrders).
Max length: 20.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .Buyer.RegistrationAddress
  .Name
string Conditionally User's name for the address. Also applicable to Half.com (for GetOrders).
Max length: This varies based on the user's country. Currently, the maximum length is 64 for the US. Note: The eBay database allocates up to 128 characters for this field. .

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .Buyer.RegistrationDate
dateTime Conditionally Indicates the date the specified user originally registered with eBay.

Since a bidder's user info is anonymous, this tag will be returned only to that bidder, and to the seller of an item that the user is bidding on.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.

See Working with Anonymous User Information.

TransactionArray.Transaction
  .Buyer.Site
SiteCodeType Conditionally eBay site the user is registered with.

Since a bidder's user info is anonymous, this tag will be returned only to that bidder, and to the seller of an item that the user is bidding on.

Applicable values: See Site.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.

See Working with Anonymous User Information.

TransactionArray.Transaction
  .Buyer.StaticAlias
string Conditionally Contains the static email address of an eBay member, used within the "reply to" email address when the eBay member sends a message. (Each eBay member is assigned a static alias. The alias is used within a static email address.)

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.

See Static Email Addresses in Trading API Calls.

TransactionArray.Transaction
  .Buyer.Status
UserStatusCodeType Conditionally Indicates the user's registration/user status.

Applicable values:

•   AccountOnHold

(out) User's account is on hold, such as for non-payment of amounts due eBay; user cannot sell or buy items

•   Confirmed

(out) User has completed online registration and has properly responded to confirmation email; most users should fall in this category

•   CreditCardVerify

(out) User has completed registration and confirmation, but needs to complete verification of credit card information. A user has this status if this user began registration as a seller but did not complete it. A seller with this status can begin to list an item but cannot complete the listing until the seller completes seller registration. (For information on what is needed to complete seller registration, see http://pages.ebay.com/help/sell/questions/sell-requirements.html.)

•   CreditCardVerifyHalfOptIn

(out) User has completed the registration for Half.com and opted to automatically also be registered with eBay, but the user needs to complete verification of credit card information. A user has this status on eBay if this user began registration as a seller but did not complete it. A seller with this status can begin to list an item but cannot complete the listing until the seller completes seller registration. (For information on what is needed to complete seller registration, see http://pages.ebay.com/help/sell/questions/sell-requirements.html.)

•   CustomCode

(out) Reserved for internal or future use

•   Deleted

(out) Records for the specified user have been deleted

•   Ghost

(out) Registered users of AuctionWeb (pre-eBay) who never re-registered on eBay

•   Guest

(out) The user is a guest user. The user has not added a password and has not confirmed an email address. The user has not signed up as a regular user, but has agreed to the User Agreement and Privacy Policy. The user has been through the buying flow for a guest; the user has been through checkout using the streamlined Buy-It-Now flow.

•   InMaintenance

(out) Temporary user record state indicating the record is in the process of being changed by eBay; query user information again to get new status

•   Merged

(out) User record has been merged with another account record for the same user

•   RegistrationCodeMailOut

(out) User has completed online registration and has been sent the confirmation email, but has not yet responded to the confirmation email

•   Suspended

(out) User has been suspended from selling and buying, such as for violations of eBay terms or agreement

•   TermPending

(out) User has been scheduled for account closure (typically when a user has requested to have their account closed) A user in this state should not be considered an active user

•   Unconfirmed

(out) User has completed online registration, but has either not responded to confirmation email or has not yet been sent the confirmation email. Or, if this user began registration as a seller but did not complete it, the user will have this status. A seller with this status can begin to list an item but cannot complete the listing until the seller completes seller registration. (For information on what is needed to complete seller registration, see http://pages.ebay.com/help/sell/questions/sell-requirements.html.)

•   UnconfirmedHalfOptIn

(out) User has completed the registration for Half.com and opted to automatically also be registered with eBay, but the registration confirmation is still pending

•   Unknown

(out) User properties have never been set; this value should seldom, if ever, be returned and typically represents a problem


(Not all values in UserStatusCodeType apply to this field.)


DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .Buyer.UserID
UserIDType (string) Conditionally Unique eBay user ID for the user.

Since a bidder's user info is anonymous, this tag contains the actual value of an ID only for that bidder, and for the seller of an item that the user is bidding on. For other users, the actual value is replaced by an anonymous value, according to these rules:

When bidding on items, UserID is replaced with the value "a****b" where a and b are random characters from the UserID. For example, if the UserID = IBidALot, it might be displayed as, "I****A".

Note that in this format, the anonymous bidder ID can change for each auction.

For GetMyeBayBuying only, when bidding on items: UserID is replaced with the value "a****b" where a and b are random characters from the UserID.

When bidding on items listed on the the Philippines site: UserID is replaced with the value "Bidder X" where X is a number indicating the order of that user's first bid. For example, if the user was the third bidder, UserID = Bidder 3.

Note that in this Philippines site format, the anonymous bidder ID stays the same for a given auction, but is different for different auctions. For example, a bidder who is the third and then the seventh bidder in an auction will be listed for both bids as "Bidder 3". However, if that same bidder is the first bidder on a different auction, the bidder will be listed for that auction as "Bidder 1", not "Bidder 3".

For GetMyeBayBuying only, when bidding on items listed on the UK and AU sites: UserID is replaced with the string "High Bidder".

For PlaceOffer, see also SellingStatus.HighBidder.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.

See Working with Anonymous User Information.

TransactionArray.Transaction
  .Buyer.UserIDChanged
boolean Conditionally If true, identifies a user whose ID has changed within the last 30 days. Does not indicate a new user (see NewUser).

Since a bidder's user info is anonymous, this tag will be returned only to that bidder, and to the seller of an item that the user is bidding on.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.

See Working with Anonymous User Information.

TransactionArray.Transaction
  .Buyer.UserIDLastChanged
dateTime Conditionally Date and time the user's data was last changed (in GMT).

Since a bidder's user info is anonymous, this tag will be returned only to that bidder, and to the seller of an item that the user is bidding on.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.

See Working with Anonymous User Information.

TransactionArray.Transaction
  .Buyer.VATStatus
VATStatusCodeType Conditionally Indicates whether or not the user is subject to VAT. Users who have registered with eBay as VAT-exempt are not subject to VAT. See documentation on Value-Added Tax (VAT).

Applicable values:

•   CustomCode

(out) Reserved for internal or future use

•   NoVATTax

(out) VAT is not applicable

•   VATExempt

(out) Residence in a country with VAT and user is registered as VAT-exempt

•   VATTax

(out) Residence in a country with VAT and user is not registered as VAT-exempt




DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.

See Value-Added Tax (VAT).

TransactionArray.Transaction
  .BuyerCheckoutMessage
string Conditionally This field is returned if a buyer left a comment for the seller during the left by buyer during the checkout flow.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .BuyerGuaranteePrice
AmountType (double) Conditionally For the Australia site, BuyerGuaranteePrice is the PayPal Buyer Protection coverage, offered for the item at the time of purchase. Details of coverage are in the following sections of the View Item page: the Buy Safely section and the Payment Details section.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .BuyerGuaranteePrice
  [ attribute currencyID ]
CurrencyCodeType Always For the Australia site, BuyerGuaranteePrice is the PayPal Buyer Protection coverage, offered for the item at the time of purchase. Details of coverage are in the following sections of the View Item page: the Buy Safely section and the Payment Details section.

For a list of possible enumeration values, see CurrencyCodeType.
TransactionArray.Transaction
  .CartID
string Conditionally Unique identifier for an instance of Shopping.com shopping cart. This field is only returned for Shopping.com order line items (transactions).
Max length: 10.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .CodiceFiscale
string Conditionally This field is returned if the IncludeCodiceFiscale flag is included in the request and set to 'true', and if the buyer has provided this value at checkout time.

This field is only applicable to Italian sellers. The Codice Fiscale number is unique for each Italian citizen and is used for tax purposes.
TransactionArray.Transaction
  .ContainingOrder
OrderType Conditionally The Combined Invoice order to which the order line item belongs. This container is only returned if IncludeContainingOrder is included and set to true in a GetItemTransactions or GetSellerTransactions request.

Not applicable to Half.com.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.

See Combined Invoice.

TransactionArray.Transaction
  .ContainingOrder
  .BuyerTaxIdentifier
TaxIdentifierType Conditionally,
repeatable: [0..*]
This container consists of taxpayer identification for the buyer. Although this container may be used for other purposes at a later date, it is currently used by sellers selling on the Italy or Spain site to retrieve the taxpayer ID of the buyer.

It is now required that buyers registered on the Italy site provide their Codice Fiscale ID (similar to the Social Security Number for US citizens) before buying an item on the Italy site.

On the Spain site, a Spanish seller has the option to require that Spanish buyers (registered on Spain site) provide a tax ID before checkout. This option is set by the seller at the account level. Once a Spanish buyer provides a tax ID, this tax ID is associated with his/her account, and once a tax ID is associated with the account, Spanish buyer will be asked to provide the tax ID during checkout on all eBay sites. Buyers with a registered address outside of Spain will not be asked to provide a tax ID during checkout.

This container is only returned for Spanish or Italian sellers when the buyer was asked to provide tax identifier information during checkout. A BuyerTaxIdentifier container will be returned for each tax ID that is associated with the buyer's account.

Note: The ability for Italian and Spanish sellers to require the buyer's tax ID at checkout is in the ramp up stage.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ContainingOrder
  .BuyerTaxIdentifier.Attribute
TaxIdentifierAttributeType (string) Conditionally,
repeatable: [0..*]
This field shows an attribute, and its corresponding value for the buyer's tax identification card. Currently, this field is only used to indicate which country issued the buyer's tax ID, but in the future, other attributes related to the tax ID may be returned in this field. This field's value will be an ISO 3166-1 two-digit code that represents the issuing country.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ContainingOrder
  .BuyerTaxIdentifier.Attribute
  [ attribute name ]
TaxIdentifierAttributeCodeType Conditionally This field shows an attribute, and its corresponding value for the buyer's tax identification card. Currently, this field is only used to indicate which country issued the buyer's tax ID, but in the future, other attributes related to the tax ID may be returned in this field. This field's value will be an ISO 3166-1 two-digit code that represents the issuing country.

For a list of possible enumeration values, see TaxIdentifierAttributeCodeType.
TransactionArray.Transaction
  .ContainingOrder
  .BuyerTaxIdentifier.ID
string Conditionally This value is the actual tax ID for the buyer. The type of tax ID is shown in the Type field.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ContainingOrder
  .BuyerTaxIdentifier.Type
ValueTypeCodeType Conditionally This enumeration value identifies the type of tax ID that was supplied by the buyer during the checkout process.

Applicable values:

•   CEDULA

(out) This value indicates that the tax ID in the ID field is a Cedula number, which is an identifier used by the Chilean, Columbian, and Dominican Republic governments to identify taxpayers in those countries. This ID is sometimes referred to as a 'Cedula de Identidad'.

•   CodiceFiscale

(out) This value indicates that the tax ID in the ID field is a Codice Fiscale ID, which is an identifier used by the Italian government to identify taxpayers in Italy.

•   CPFTaxID

(out) This value indicates that the tax ID in the ID field is a Tax Registration Number, which is an identifier used by the Brazilian government to identify taxpayers in Brazil. In Portuguese, this ID is known as the 'Cadastro de Pessoas Fisicas', or 'CPF'.

•   CustomCode

(out) Reserved for future use.

•   DNI

(out) This value indicates that the tax ID in the ID field is a Spanish National Identity Number, which is one identifier used by the Spanish government to identify taxpayers in Spain. In Spanish, this ID is known as the 'Documento nacional de identidad'. The other tax identifier for Spanish residents is the NIE number, or 'Numero de Identidad de Extranjero'.

•   NIE

(out) This value indicates that the tax ID in the ID field is a NIE Number, which is one identifier used by the Spanish government to identify taxpayers in Spain. 'NIE' stands for 'Numero de Identidad de Extranjero'. The other tax identifier for Spanish residents is the DNI number, or 'Documento nacional de identidad'. Spanish residents can also be identified by their Spanish VAT (Value-Added Tax) number, which is also called the 'Numero de Identificacion Fiscal' or NIF.

•   NIF

(out) This value indicates that the ID in the ID field is an NIF Number, which is also known as their Spanish VAT (Value-Added Tax) number. 'NIF' stands for 'Numero de Identificacion Fiscal'. Spanish residents can also be identified by their DNI ('Documento nacional de identidad') number or their NIE ('Numero de Identidad de Extranjero') number.

•   NIT

(out) This value indicates that the tax ID in the ID field is a NIT number, which is an identifier used by the Guatemalan government to identify taxpayers in Guatemala. In Spanish, this ID is known as the 'Numero de identificacion tributaria'.

•   RussianPassport

(out) This value indicates that the tax ID in the ID field is a Russian Passport number.

•   TurkeyID

(out) This value indicates that the tax ID in the ID field is a Turkish Identification Number, which is an identifier used by the Turkish government to identify taxpayers in Turkey. In Turkish, this ID is known as the 'Turkiye Cumhuriyeti Kimlik Numarasi', often abbreviated as T.C. Kimlik No.


(Not all values in ValueTypeCodeType apply to this field.)


DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ContainingOrder.CancelDetail
CancelDetailType Conditionally,
repeatable: [0..*]
This container consists of details related to an eBay Now order that has been cancelled. It is only returned if an eBay Now order has been cancelled or is in the process of being cancelled.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ContainingOrder.CancelDetail
  .CancelCompleteDate
dateTime Conditionally Timestamp indicating when the cancellation process of an eBay Now order has been completed, which will be indicated if the Order.CancelStatus field has a value of 'CancelComplete'. This field will not be returned until the cancellation process is completed.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ContainingOrder.CancelDetail
  .CancelIntiationDate
dateTime Conditionally This timestamp indicates when the cancellation of the eBay Now order was initiated. This field is always returned with the CancelDetail container.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ContainingOrder.CancelDetail
  .CancelIntiator
token Conditionally This value indicates which party initiated the cancellation of the eBay Now order. This field is always returned with the CancelDetail container. See CancelInitiatorCodeType for a full list of parties that may initiate a cancel request.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ContainingOrder.CancelDetail
  .CancelReason
token Conditionally This value indicates the reason why the eBay Now order was cancelled. This field is always returned with the CancelDetail container. Valid cancel reasons include the item being out of stock, an eBay Now valet being unavailable, or the buyer not showing up at the delivery site.

Note: Currently, the CancelReason field is being returned under the Order container and under the CancelDetail container. However, there are plans to deprecate this field from OrderType in the future.


DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.

Applicable values: See CancelReasonCodeType
TransactionArray.Transaction
  .ContainingOrder.CancelDetail
  .CancelReasonDetails
string Conditionally The detailed reason for the cancellation of an eBay Now order. This field is only returned if it is available for the cancelled eBay Now order.

Note: Currently, the CancelReasonDetails field is being returned under the Order container and under the CancelDetail container. However, there are plans to deprecate this field from OrderType in the future.


DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ContainingOrder.CancelReason
token Conditionally This value indicates the reason why the eBay Now order was cancelled. This field is only returned for cancelled eBay Now orders. Valid cancel reasons include the item being out of stock, an eBay Now valet being unavailable, or the buyer not showing up at the delivery site. See ancelReasonCodeType for a full list of cancel reasons that may be returned.

Note: Currently, the CancelReason field is being returned under the Order container and under the CancelDetail container. However, there are plans to deprecate this field from OrderType in the future.


DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.

Applicable values: See CancelReasonCodeType
TransactionArray.Transaction
  .ContainingOrder
  .CancelReasonDetails
string Conditionally The detailed reason for the cancellation of an eBay Now order. This field is only returned if it is available for the cancelled eBay Now order.

Note: Currently, the CancelReasonDetails field is being returned under the Order container and under the CancelDetail container. However, there are plans to deprecate this field from OrderType in the future.


DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ContainingOrder.CancelStatus
CancelStatusCodeType Conditionally The current status for the order cancellation request if it exists.

Applicable values:

•   CancelClosedForCommitment

(out) This value indicates that the cancellation of the eBay Now order has been closed because the buyer has already committed to buying the item(s).

•   CancelClosedNoRefund

(out) This value indicates that the cancellation of the eBay Now order has been closed, with no refund issued to the buyer.

•   CancelClosedUnknownRefund

(out) This value indicates that the cancellation of the eBay Now order has been closed, and it is unknown whether or not a refund was issued to the buyer.

•   CancelClosedWithRefund

(out) This value indicates that the cancellation of the eBay Now order has been closed, with a refund issued to the buyer.

•   CancelComplete

(out) This value indicates that the cancellation of the eBay Now order has been completed.

•   CancelFailed

(out) This value indicates that the cancellation of the eBay Now order has failed.

•   CancelPending

(out) This value indicates that the cancellation of the eBay Now order has been initiated, but not completed.

•   CancelRejected

(out) This value indicates that the cancellation of the eBay Now order has been rejected.

•   CancelRequested

(out) This value indicates that the cancellation of the eBay Now order has been requested.

•   CustomCode

(out) Reserved for internal or future use.

•   Invalid

(out) This value indicates that the cancellation of the eBay Now order is invalid.

•   NotApplicable

(out) This value indicates that the cancellation of the eBay Now order is not applicable.




DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ContainingOrder
  .CreatingUserRole
TradingRoleCodeType Conditionally This value indicates whether a Combined Invoice order was created by the buyer or by the seller. This field is only returned for Combined Invoice orders.

Applicable values:

•   Buyer

(in/out) The eBay user is acting as the buyer for the order(s). In GetOrders, this value should be passed into the OrderRole field in the request to retrieve orders in which the calling eBay user is the buyer in the order.

•   CustomCode

(in/out) This value is reserved for future or internal use.

•   Seller

(in/out) The eBay user is acting as the seller for the order(s). In GetOrders, this value should be passed into the OrderRole field in the request to retrieve orders in which the calling eBay user is the seller in the order.




DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.

See Combined Invoice.

TransactionArray.Transaction
  .ContainingOrder
  .IntegratedMerchantCreditCardEnabled
boolean Conditionally Indicates whether the item can be paid for through a payment gateway (Payflow) account. If IntegratedMerchantCreditCardEnabled is true, then integrated merchant credit card (IMCC) is enabled for credit cards because the seller has a payment gateway account. Therefore, if IntegratedMerchantCreditCardEnabled is true, and AmEx, Discover, or VisaMC is returned for an item, then on checkout, an online credit-card payment is processed through a payment gateway account.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ContainingOrder
  .IsMultiLegShipping
boolean Conditionally If IsMultilegShipping is true, the order or transaction uses the Global Shipping Program, in which the shipment has a domestic leg and an international leg. The buyer's shipping address is in a country other than the country where the items were listed, and the seller has specified InternationalPriorityShipping as the default international shipping service in the listings of all the items in the shipment.

If IsMultilegShipping is false, the order or transaction doesn't use the Global Shipping Program. The shipment might use a different international shipping service, or it might be domestic.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ContainingOrder
  .LogisticsPlanType
token Conditionally Indicates which type of logistics plan has been selected for the current order by the buyer. A logistics plan categorizes the means by which a package is transported from the seller to the buyer. It is characterized by the type of location where the buyer will take possession of the package, the type and number of carriers involved, and the timing of sending and delivery. A given logistics plan type helps to determine which shipping types, carriers and services the seller can use.

This field is returned only if it has a value.

Note: Currently, LogisticsPlanType has only one applicable value: PickUpDropOff, which is a service available for orders sent and delivered within the UK. When buyers select PickUpDropOff, the order is sent to a contracted third party location, where it is held for pickup by the buyer.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.

Applicable values: See LogisticsPlanCodeType
TransactionArray.Transaction
  .ContainingOrder
  .MonetaryDetails
PaymentsInformationType Conditionally Contains information about how funds exchanged for an order are allocated to payees.

For example, for an order made under eBay's Global Shipping Program, users can see the portion of the buyer's payment that is allocated as shipping and import charges remitted to the international shipping provider. Currently, only payment information is returned.

Note: In an upcoming release, MonetaryDetails will replace the ExternalTransaction container, so you are encouraged to start using MonetaryDetails now.

DetailLevel: ReturnAll.
TransactionArray.Transaction
  .ContainingOrder
  .MonetaryDetails.Payments
PaymentInformationType Conditionally Contains information about how different portions of the funds exchanged for a specified order are allocated among payees. Each allocated portion is represented by a Payment container.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ContainingOrder
  .MonetaryDetails.Payments
  .Payment
PaymentTransactionType Conditionally,
repeatable: [0..*]
Contains information about the funds allocated to one payee from a buyer payment for a specified order.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ContainingOrder
  .MonetaryDetails.Payments
  .Payment.FeeOrCreditAmount
AmountType (double) Conditionally Fee Amount is a positive value and Credit Amount is a negative value.

This field is not returned if the Payee field's type attribute is eBayPartner.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ContainingOrder
  .MonetaryDetails.Payments
  .Payment.FeeOrCreditAmount
  [ attribute currencyID ]
CurrencyCodeType Always Fee Amount is a positive value and Credit Amount is a negative value.

This field is not returned if the Payee field's type attribute is eBayPartner.

For a list of possible enumeration values, see CurrencyCodeType.
TransactionArray.Transaction
  .ContainingOrder
  .MonetaryDetails.Payments
  .Payment.Payee
UserIdentityType (string) Conditionally The person or organization who is to receive the payment allocation.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ContainingOrder
  .MonetaryDetails.Payments
  .Payment.Payee
  [ attribute type ]
UserIdentityCodeType Conditionally The person or organization who is to receive the payment allocation.

For a list of possible enumeration values, see UserIdentityCodeType.
TransactionArray.Transaction
  .ContainingOrder
  .MonetaryDetails.Payments
  .Payment.Payer
UserIdentityType (string) Conditionally The person or organization who submitted the payment.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ContainingOrder
  .MonetaryDetails.Payments
  .Payment.Payer
  [ attribute type ]
UserIdentityCodeType Conditionally The person or organization who submitted the payment.

For a list of possible enumeration values, see UserIdentityCodeType.
TransactionArray.Transaction
  .ContainingOrder
  .MonetaryDetails.Payments
  .Payment.PaymentAmount
AmountType (double) Conditionally The amount of the payment that is allocated to the payee.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ContainingOrder
  .MonetaryDetails.Payments
  .Payment.PaymentAmount
  [ attribute currencyID ]
CurrencyCodeType Always The amount of the payment that is allocated to the payee.

For a list of possible enumeration values, see CurrencyCodeType.
TransactionArray.Transaction
  .ContainingOrder
  .MonetaryDetails.Payments
  .Payment.PaymentReferenceID
TransactionReferenceType (string) Conditionally,
repeatable: [0..*]
The payment transaction ID.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ContainingOrder
  .MonetaryDetails.Payments
  .Payment.PaymentReferenceID
  [ attribute type ]
TransactionReferenceCodeType Conditionally The payment transaction ID.

For a list of possible enumeration values, see TransactionReferenceCodeType.
TransactionArray.Transaction
  .ContainingOrder
  .MonetaryDetails.Payments
  .Payment.PaymentStatus
PaymentTransactionStatusCodeType Conditionally The current status of a buyer payment that is allocated to a specified payee.

Applicable values:

•   CustomCode

(out) Reserved for internal or future use.

•   Failed

(out) This value indicates that the payment transaction failed.

•   Pending

(out) This value indicates that the payment transaction is pending.

•   Succeeded

(out) This value indicates that the payment transaction succeeded.




DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ContainingOrder
  .MonetaryDetails.Payments
  .Payment.PaymentTime
dateTime Conditionally The date and time when the payment is received by the payee.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ContainingOrder
  .MonetaryDetails.Payments
  .Payment.ReferenceID
TransactionReferenceType (string) Conditionally A unique transaction ID for the payment.

This field is not returned if the Payee field's type attribute is eBayPartner.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ContainingOrder
  .MonetaryDetails.Payments
  .Payment.ReferenceID
  [ attribute type ]
TransactionReferenceCodeType Conditionally A unique transaction ID for the payment.

This field is not returned if the Payee field's type attribute is eBayPartner.

For a list of possible enumeration values, see TransactionReferenceCodeType.
TransactionArray.Transaction
  .ContainingOrder
  .MonetaryDetails.Refunds
RefundInformationType Conditionally This container consists of an array of one or more Refund containers, and each Refund container consists of detailed information about a merchant's refund (or store credit) to a buyer who has returned an In-Store Pickup item.

This container is only returned if the buyer has returned an In-Store Pickup item to the merchant at a physical store, and the merchant has notified eBay through the ORDER.RETURNED notification of the Inbound Notifications API.

Note: At this time, the In-Store Pickup feature is generally only available to large retail merchants, and can only be applied to multi-quantity, fixed-price listings.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ContainingOrder
  .MonetaryDetails.Refunds
  .Refund
RefundTransactionInfoType Conditionally,
repeatable: [0..*]
This container consists of detailed information on an In-Store Pickup item refund. This container is only returned if the merchant is refunding (or providing a store credit) the buyer for an In-Store Pickup item. A separate Refund container will be returned for each ORDER.RETURNED notification that the merchant sends to eBay through the Inbound Notifications API.

Note: A seller must be eligible for the In-Store Pickup feature to list an item that is eligible for In-Store Pickup. At this time, the In-Store Pickup feature is generally only available to large retail merchants, and can only be applied to multi-quantity, fixed-price listings. Merchants/developers can test In-Store Pickup functionality in the Sandbox environment, including listing items enabled with the In-Store Pickup feature, creating store locations and adding inventory to these stores using the Inventory Management API, and informing eBay of In-Store Pickup status changes using the Inbound Notifications API.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ContainingOrder
  .MonetaryDetails.Refunds
  .Refund.FeeOrCreditAmount
AmountType (double) Conditionally This dollar value is the total amount of the refund to the buyer for the In-Store Pickup order. Typically, this dollar value will be the same as the RefundAmount value, unless the merchant is issuing multiple refund transactions to the buyer, in which case, the FeeOrCreditAmount value will be the cumulative amount for multiple refund transactions. This field is not returned if the merchant issued the buyer a store credit instead of a refund (RefundType=STORE_CREDIT).

Note: A seller must be eligible for the In-Store Pickup feature to list an item that is eligible for In-Store Pickup. At this time, the In-Store Pickup feature is generally only available to large retail merchants, and can only be applied to multi-quantity, fixed-price listings. Merchants/developers can test In-Store Pickup functionality in the Sandbox environment, including listing items enabled with the In-Store Pickup feature, creating store locations and adding inventory to these stores using the Inventory Management API, and informing eBay of In-Store Pickup status changes using the Inbound Notifications API.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ContainingOrder
  .MonetaryDetails.Refunds
  .Refund.FeeOrCreditAmount
  [ attribute currencyID ]
CurrencyCodeType Always This dollar value is the total amount of the refund to the buyer for the In-Store Pickup order. Typically, this dollar value will be the same as the RefundAmount value, unless the merchant is issuing multiple refund transactions to the buyer, in which case, the FeeOrCreditAmount value will be the cumulative amount for multiple refund transactions. This field is not returned if the merchant issued the buyer a store credit instead of a refund (RefundType=STORE_CREDIT).

Note: A seller must be eligible for the In-Store Pickup feature to list an item that is eligible for In-Store Pickup. At this time, the In-Store Pickup feature is generally only available to large retail merchants, and can only be applied to multi-quantity, fixed-price listings. Merchants/developers can test In-Store Pickup functionality in the Sandbox environment, including listing items enabled with the In-Store Pickup feature, creating store locations and adding inventory to these stores using the Inventory Management API, and informing eBay of In-Store Pickup status changes using the Inbound Notifications API.

For a list of possible enumeration values, see CurrencyCodeType.
TransactionArray.Transaction
  .ContainingOrder
  .MonetaryDetails.Refunds
  .Refund.ReferenceID
TransactionReferenceType (string) Conditionally This value is a merchant-defined identifier used to track In-Store Pickup refunds. This value is picked up by eBay when the merchant passes in the REFUND_ID parameter through the payload of an ORDER.RETURNED notification sent to eBay. This field is not returned if the merchant does not set this value through ORDER.RETURNED notification.

Note: A seller must be eligible for the In-Store Pickup feature to list an item that is eligible for In-Store Pickup. At this time, the In-Store Pickup feature is generally only available to large retail merchants, and can only be applied to multi-quantity, fixed-price listings. Merchants/developers can test In-Store Pickup functionality in the Sandbox environment, including listing items enabled with the In-Store Pickup feature, creating store locations and adding inventory to these stores using the Inventory Management API, and informing eBay of In-Store Pickup status changes using the Inbound Notifications API.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ContainingOrder
  .MonetaryDetails.Refunds
  .Refund.ReferenceID
  [ attribute type ]
TransactionReferenceCodeType Conditionally This value is a merchant-defined identifier used to track In-Store Pickup refunds. This value is picked up by eBay when the merchant passes in the REFUND_ID parameter through the payload of an ORDER.RETURNED notification sent to eBay. This field is not returned if the merchant does not set this value through ORDER.RETURNED notification.

Note: A seller must be eligible for the In-Store Pickup feature to list an item that is eligible for In-Store Pickup. At this time, the In-Store Pickup feature is generally only available to large retail merchants, and can only be applied to multi-quantity, fixed-price listings. Merchants/developers can test In-Store Pickup functionality in the Sandbox environment, including listing items enabled with the In-Store Pickup feature, creating store locations and adding inventory to these stores using the Inventory Management API, and informing eBay of In-Store Pickup status changes using the Inbound Notifications API.

For a list of possible enumeration values, see TransactionReferenceCodeType.
TransactionArray.Transaction
  .ContainingOrder
  .MonetaryDetails.Refunds
  .Refund.RefundAmount
AmountType (double) Conditionally This dollar value is the amount of the refund to the buyer for this specific refund transaction. This field is not returned if the merchant issued the buyer a store credit instead of a refund (RefundType=STORE_CREDIT).

Note: A seller must be eligible for the In-Store Pickup feature to list an item that is eligible for In-Store Pickup. At this time, the In-Store Pickup feature is generally only available to large retail merchants, and can only be applied to multi-quantity, fixed-price listings. Merchants/developers can test In-Store Pickup functionality in the Sandbox environment, including listing items enabled with the In-Store Pickup feature, creating store locations and adding inventory to these stores using the Inventory Management API, and informing eBay of In-Store Pickup status changes using the Inbound Notifications API.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ContainingOrder
  .MonetaryDetails.Refunds
  .Refund.RefundAmount
  [ attribute currencyID ]
CurrencyCodeType Always This dollar value is the amount of the refund to the buyer for this specific refund transaction. This field is not returned if the merchant issued the buyer a store credit instead of a refund (RefundType=STORE_CREDIT).

Note: A seller must be eligible for the In-Store Pickup feature to list an item that is eligible for In-Store Pickup. At this time, the In-Store Pickup feature is generally only available to large retail merchants, and can only be applied to multi-quantity, fixed-price listings. Merchants/developers can test In-Store Pickup functionality in the Sandbox environment, including listing items enabled with the In-Store Pickup feature, creating store locations and adding inventory to these stores using the Inventory Management API, and informing eBay of In-Store Pickup status changes using the Inbound Notifications API.

For a list of possible enumeration values, see CurrencyCodeType.
TransactionArray.Transaction
  .ContainingOrder
  .MonetaryDetails.Refunds
  .Refund.RefundStatus
PaymentTransactionStatusCodeType Conditionally This value indicates the success or failure of the attempt by the merchant to refund or provide store credit to the buyer for a returned In-Store Pickup item. This field is always returned with the Refund container.

Note: A seller must be eligible for the In-Store Pickup feature to list an item that is eligible for In-Store Pickup. At this time, the In-Store Pickup feature is generally only available to large retail merchants, and can only be applied to multi-quantity, fixed-price listings. Merchants/developers can test In-Store Pickup functionality in the Sandbox environment, including listing items enabled with the In-Store Pickup feature, creating store locations and adding inventory to these stores using the Inventory Management API, and informing eBay of In-Store Pickup status changes using the Inbound Notifications API.

Applicable values:

•   CustomCode

(out) Reserved for internal or future use.

•   Failed

(out) This value indicates that the payment transaction failed.

•   Pending

(out) This value indicates that the payment transaction is pending.

•   Succeeded

(out) This value indicates that the payment transaction succeeded.




DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ContainingOrder
  .MonetaryDetails.Refunds
  .Refund.RefundTime
dateTime Conditionally This date/time value is the timestamp for the refund transaction. This field is not returned if the refund was not successful (RefundStatus=FAILED).

Note: A seller must be eligible for the In-Store Pickup feature to list an item that is eligible for In-Store Pickup. At this time, the In-Store Pickup feature is generally only available to large retail merchants, and can only be applied to multi-quantity, fixed-price listings. Merchants/developers can test In-Store Pickup functionality in the Sandbox environment, including listing items enabled with the In-Store Pickup feature, creating store locations and adding inventory to these stores using the Inventory Management API, and informing eBay of In-Store Pickup status changes using the Inbound Notifications API.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ContainingOrder
  .MonetaryDetails.Refunds
  .Refund.RefundTo
UserIdentityType (string) Conditionally This field is the eBay user ID of the buyer who is receiving the refund or store credit from the merchant. This field is always returned with the Refund container.

Note: A seller must be eligible for the In-Store Pickup feature to list an item that is eligible for In-Store Pickup. At this time, the In-Store Pickup feature is generally only available to large retail merchants, and can only be applied to multi-quantity, fixed-price listings. Merchants/developers can test In-Store Pickup functionality in the Sandbox environment, including listing items enabled with the In-Store Pickup feature, creating store locations and adding inventory to these stores using the Inventory Management API, and informing eBay of In-Store Pickup status changes using the Inbound Notifications API.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ContainingOrder
  .MonetaryDetails.Refunds
  .Refund.RefundTo
  [ attribute type ]
UserIdentityCodeType Conditionally This field is the eBay user ID of the buyer who is receiving the refund or store credit from the merchant. This field is always returned with the Refund container.

Note: A seller must be eligible for the In-Store Pickup feature to list an item that is eligible for In-Store Pickup. At this time, the In-Store Pickup feature is generally only available to large retail merchants, and can only be applied to multi-quantity, fixed-price listings. Merchants/developers can test In-Store Pickup functionality in the Sandbox environment, including listing items enabled with the In-Store Pickup feature, creating store locations and adding inventory to these stores using the Inventory Management API, and informing eBay of In-Store Pickup status changes using the Inbound Notifications API.

For a list of possible enumeration values, see UserIdentityCodeType.
TransactionArray.Transaction
  .ContainingOrder
  .MonetaryDetails.Refunds
  .Refund.RefundType
RefundSourceTypeCodeType Conditionally This value indicates whether the merchant refunded or provided a store credit to the buyer for the returned In-Store Pickup item. Applicable values are 'REFUND' and 'STORE_CREDIT'. This value is picked up by eBay when the merchant passes in the REFUND_TYPE parameter through the payload of an ORDER.RETURNED notification sent to eBay.

Note: A seller must be eligible for the In-Store Pickup feature to list an item that is eligible for In-Store Pickup. At this time, the In-Store Pickup feature is generally only available to large retail merchants, and can only be applied to multi-quantity, fixed-price listings. Merchants/developers can test In-Store Pickup functionality in the Sandbox environment, including listing items enabled with the In-Store Pickup feature, creating store locations and adding inventory to these stores using the Inventory Management API, and informing eBay of In-Store Pickup status changes using the Inbound Notifications API.

Applicable values:

•   CustomCode

(out) This value is reserved for internal or future use.

•   PaymentRefund

(out) This value indicates that the merchant issued a cash refund (or debit card/credit card reversal) to the buyer for the amount of the returned item(s).

•   StoreCredit

(out) This value indicates that the merchant issued a store credit to the buyer for the amount of the returned item(s).




DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ContainingOrder
  .MultiLegShippingDetails
MultiLegShippingDetailsType Conditionally Contains details about the domestic leg of a Global Shipping Program shipment.

This information is not returned if IsMultilegShipping is false.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ContainingOrder
  .MultiLegShippingDetails
  .SellerShipmentToLogisticsProvider
MultiLegShipmentType Conditionally Contains information about the domestic leg of a Global Shipping Programn shipment, including the seller-selected shipping service, the domestic shipping cost, the domestic address of the international shipping provider, and the estimated shipping time range.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ContainingOrder
  .MultiLegShippingDetails
  .SellerShipmentToLogisticsProvider
  .ShippingServiceDetails
MultiLegShippingServiceType Conditionally Contains information about the shipping service and cost of the domestic leg of a Global Shipping Program shipment.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ContainingOrder
  .MultiLegShippingDetails
  .SellerShipmentToLogisticsProvider
  .ShippingServiceDetails
  .ShippingService
token Conditionally The shipping service specified for the domestic leg of a Global Shipping Program shipment. For the domestic leg, the value of this field can be any available shipping service that ships to the domestic address of the international shipping provider.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ContainingOrder
  .MultiLegShippingDetails
  .SellerShipmentToLogisticsProvider
  .ShippingServiceDetails
  .TotalShippingCost
AmountType (double) Conditionally The total shipping cost of the domestic leg of a Global Shipping Program shipment.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ContainingOrder
  .MultiLegShippingDetails
  .SellerShipmentToLogisticsProvider
  .ShippingServiceDetails
  .TotalShippingCost
  [ attribute currencyID ]
CurrencyCodeType Always The total shipping cost of the domestic leg of a Global Shipping Program shipment.

For a list of possible enumeration values, see CurrencyCodeType.
TransactionArray.Transaction
  .ContainingOrder
  .MultiLegShippingDetails
  .SellerShipmentToLogisticsProvider
  .ShippingTimeMax
int Conditionally The maximum guaranteed number of days that the shipping carrier will take to ship an item for the domestic leg of a Global Shipping Program shipment (not including the handling time it takes the seller to deliver the item to the domestic shipping carrier).

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ContainingOrder
  .MultiLegShippingDetails
  .SellerShipmentToLogisticsProvider
  .ShippingTimeMin
int Conditionally The minimum number of days that the shipping carrier will take to ship an item for the domestic leg of a Global Shipping Program shipment (not including the handling time it takes the seller to deliver the item to the domestic shipping carrier).

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ContainingOrder
  .MultiLegShippingDetails
  .SellerShipmentToLogisticsProvider
  .ShipToAddress
AddressType Conditionally Contains shipping address information for the domestic leg of a Global Shipping Program shipment. This container includes the ReferenceID field, which can be printed on the package to give the international shipping provider a unique identifier for the order.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ContainingOrder
  .MultiLegShippingDetails
  .SellerShipmentToLogisticsProvider
  .ShipToAddress
  .AddressAttribute
AddressAttributeType (string) Conditionally,
repeatable: [0..*]
This field shows an attribute for the address, and its corresponding value. Currently, this field is only used to display the reference ID for a "Click and Collect" order, but in the future, other address attributes may be returned in this field.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ContainingOrder
  .MultiLegShippingDetails
  .SellerShipmentToLogisticsProvider
  .ShipToAddress
  .AddressAttribute
  [ attribute type ]
AddressAttributeCodeType Conditionally This field shows an attribute for the address, and its corresponding value. Currently, this field is only used to display the reference ID for a "Click and Collect" order, but in the future, other address attributes may be returned in this field.

For a list of possible enumeration values, see AddressAttributeCodeType.
TransactionArray.Transaction
  .ContainingOrder
  .MultiLegShippingDetails
  .SellerShipmentToLogisticsProvider
  .ShipToAddress.AddressID
string Conditionally Unique ID for a user's address in the eBay database. This value can help prevent the need to store an address multiple times across multiple orders. The ID changes if a user changes their address.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ContainingOrder
  .MultiLegShippingDetails
  .SellerShipmentToLogisticsProvider
  .ShipToAddress.AddressOwner
AddressOwnerCodeType Conditionally The realm to which the address belongs (e.g. eBay vs PayPal). For GetOrders, applies only to Half.com.

Applicable values:

•   CustomCode

(out) Reserved for internal or future use.

•   eBay

(out) This value indicates that the shipping address being referenced is on file with eBay.

•   PayPal

(out) This value indicates that the shipping address being referenced is on file with PayPal.




DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ContainingOrder
  .MultiLegShippingDetails
  .SellerShipmentToLogisticsProvider
  .ShipToAddress.AddressUsage
AddressUsageCodeType Conditionally This tag tells whether current address is a default shipping address or one of the shipping addresses in address book.

Applicable values:

•   CustomCode

(out) Reserved for internal or future use.

•   DefaultShipping

(out) This is default shipping address which is rendered to buyer on checkout.

•   Invalid

(out) This is not a valid address. Please use another address.

•   Shipping

(out) This is an address which is in user's address book. It can be used at the time of checkout.




DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ContainingOrder
  .MultiLegShippingDetails
  .SellerShipmentToLogisticsProvider
  .ShipToAddress.CityName
string Conditionally The name of the user's city. Also applicable to Half.com (for GetOrders).
Max length: This varies based on the user's country. Currently, the maximum length is 64 for the US. Note: The eBay database allocates up to 128 characters for this field. .

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ContainingOrder
  .MultiLegShippingDetails
  .SellerShipmentToLogisticsProvider
  .ShipToAddress.Country
CountryCodeType Conditionally The two-digit code representing the country of the user.

If not provided as input, eBay uses the country associated with the eBay Site ID when the call is made.

For a Global Shipping Program order, GetSellerList returns the country code of the buyer, not the international shipping provider.

Also applicable to Half.com (for GetOrders).

Applicable values: See Country.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ContainingOrder
  .MultiLegShippingDetails
  .SellerShipmentToLogisticsProvider
  .ShipToAddress.CountryName
string Conditionally The name of the user's country. Also applicable to Half.com (for GetOrders).
Max length: eBay validates the content, but not the length for this field. Note: The eBay database allocates up to 128 characters for this field. .

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ContainingOrder
  .MultiLegShippingDetails
  .SellerShipmentToLogisticsProvider
  .ShipToAddress
  .ExternalAddressID
string Conditionally ID assigned to the address by the address owner, e.g. by the PayPal system. Currently, the ExternalAddressID only applies for a customer address in the PayPal system. The ID changes if a user changes their address. Also see the AddressOwner field. The ExternalAddressID value also is applicable to Half.com (for GetOrders).
Max length: 20.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ContainingOrder
  .MultiLegShippingDetails
  .SellerShipmentToLogisticsProvider
  .ShipToAddress.Name
string Conditionally User's name for the address. Also applicable to Half.com (for GetOrders).
Max length: This varies based on the user's country. Currently, the maximum length is 64 for the US. Note: The eBay database allocates up to 128 characters for this field. .

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ContainingOrder
  .MultiLegShippingDetails
  .SellerShipmentToLogisticsProvider
  .ShipToAddress.Phone
string Conditionally User's primary phone number. This may return a value of "Invalid Request" if you are not authorized to see the user's phone number.

In the US, the area code (3 digits), the prefix (3 digits), the line number (4 digits), and phone extension (if specified by the user) are returned in this field. The extension can be one or more digits. Non-breaking spaces are used as delimiters between these phone number components.

Also applicable to Half.com (for GetOrders).
Max length: eBay validates the content (should only be integer values and delimiters), but not the length for this field. Note: The eBay database allocates up to 128 characters for this field. .

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ContainingOrder
  .MultiLegShippingDetails
  .SellerShipmentToLogisticsProvider
  .ShipToAddress.PostalCode
string Conditionally User's postal code.

For a Global Shipping Program order, GetSellerList and GetMyeBaySelling return the postal code of the buyer, not that of the international shipping provider.

Also applicable to Half.com (for GetOrders).
Max length: This varies based on the user's country. Currently, the maximum length is 9 (not counting delimiter characters) for the US. Note: The eBay database allocates up to 24 characters for this field. .

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ContainingOrder
  .MultiLegShippingDetails
  .SellerShipmentToLogisticsProvider
  .ShipToAddress.ReferenceID
string Conditionally Uniquely identifies an order shipped using the Global Shipping Program. This value is generated by eBay when the order is completed. The international shipping provider uses the ReferenceID as the primary reference when processing the shipment. Sellers must include this value on the package immediately above the street address of the international shipping provider.

Example: "Reference #1234567890123456"

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ContainingOrder
  .MultiLegShippingDetails
  .SellerShipmentToLogisticsProvider
  .ShipToAddress.StateOrProvince
string Conditionally The region of the user's address. Also applicable to Half.com (for GetOrders).
Max length: This varies based on the user's country. Currently, the maximum length is 64 for the US. Note: The eBay database allocates up to 128 characters for this field. .

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ContainingOrder
  .MultiLegShippingDetails
  .SellerShipmentToLogisticsProvider
  .ShipToAddress.Street1
string Conditionally Line 1 of the user's street address. Also applicable to Half.com (for GetOrders).
Max length: This varies based on the user's country. Currently, the maximum length is 180 for the US. Note: The eBay database allocates up to 512 characters for this field. .

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ContainingOrder
  .MultiLegShippingDetails
  .SellerShipmentToLogisticsProvider
  .ShipToAddress.Street2
string Conditionally Line 2 of the user's address (such as an apartment number). Returned if the user specified a second street value for their address. Also applicable to Half.com (for GetOrders).
In case of Item.SellerContactDetails, Street2 can be used to provide City, Address, State, and Zip code (if applicable).
Max length: This varies based on the user's country. Currently, the maximum length is 180 for the US. Note: The eBay database allocates up to 512 characters for this field. .

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ContainingOrder.OrderID
OrderIDType (string) Conditionally A unique identifier for an eBay order. For a single line item order, this value is actually the OrderLineItemID value, which is a concatenation of ItemID and TransactionID, with a hyphen in between these two values, such as '121124971073-1094989827002' for a fixed-price listing, or '121124971074-0' for an auction listing. For a multiple line item order (known as a Combined Invoice order), the OrderID value is created by eBay when the buyer/seller combines multiple line items into one order, and the buyer makes one payment for all line items from the same seller. "Combined Invoice" orders are created through the Web flow, or when the buyer or seller creates a "Combined Invoice" order by using the AddOrder call. An example of "Combined Invoice" order ID is '155643809010'.

An OrderID value overrides an OrderLineItemID value or an ItemID/TransactionID pair if these fields are also specified in the same request.

Also applicable to Half.com (for GetOrders).

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.

See Combined Invoice.

TransactionArray.Transaction
  .ContainingOrder.OrderStatus
OrderStatusCodeType Conditionally This enumeration value indicates the current status of the order.

Applicable values:

•   Active

(in/out) This value indicates that the cart is active. The 'Active' state is the only order state in which order line items can still be added, removed, or updated in the cart.

•   All

(in/out) This value is passed into the OrderStatus of GetOrders to retrieve order in all states. This is the default value.

•   Authenticated

(out) This value indicates that the cart was authenticated.

•   Cancelled

(out) This value indicates that the cart was cancelled.

•   CancelPending

(in/out) The order was in cancel pending status.

•   Completed

(in/out) This value indicates that the order is completed.

•   CustomCode

(out) Reserved for internal or future use.

•   Default

(out) This value indicates that the order is in default status.

•   Inactive

(in/out) This value indicates that the cart is inactive.

•   InProcess

(out) This value indicates that processing of the buyer's cart has been initiated, but is not yet complete.

•   Invalid

(out) This value indicates that the cart is invalid, or no longer exists.

•   Shipped

(in/out) This value indicates that the Half.com order was shipped. This value is only applicable for Half.com orders.




DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ContainingOrder
  .PaymentHoldDetails
PaymentHoldDetailType Conditionally This container consists of information related to the payment hold on the order, including the reason why the buyer's payment for the order is being held, the expected release date of the funds into the seller's account, and possible action(s) the seller can take to expedite the payout of funds into their account. This container is only returned if PayPal has placed a payment hold on the order.

An American seller (selling on US or US Motors sites) and a Canadian seller (selling on CA and CA- FR sites) may be subject to PayPal payment holds (that last from three to 21 days) if that seller is new to selling on eBay or is classified as a "Below Standard" seller. For other reasons why a seller's funds may be held by PayPal, see the PaymentHoldReason field.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ContainingOrder
  .PaymentHoldDetails
  .ExpectedReleaseDate
dateTime Conditionally Timestamp that indicates the expected date in which eBay/PayPal will distribute the funds to the seller's account. This is not a firm date and is subject to change.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ContainingOrder
  .PaymentHoldDetails
  .NumOfReqSellerActions
int Conditionally Integer value that indicates the number of possible actions that a seller can take to possibly expedite the release of funds into their account. This value should equal the number of RequiredSellerAction fields contained in the RequiredSellerActionArray container.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ContainingOrder
  .PaymentHoldDetails
  .PaymentHoldReason
PaymentHoldReasonCodeType Conditionally Enumerated value that indicates why the buyer's payment for the order is being held by PayPal instead of being distributed to the seller's account. A seller's funds for an order can be held by PayPal for as little as three days after the buyer receives the order, but the hold can be up to 21 days based on the scenario, and in some cases, the seller's lack of action in helping to expedite the release of funds.

Applicable values:

•   BelowStandardSeller

(out) This value indicates that the buyer's payment for the order is being held by PayPal because the seller has been classified as a Below Standard seller.

•   CasualSeller

(out) This value indicates that the buyer's payment for the order is being held by PayPal because the seller is classified as a casual seller on eBay.

•   CustomCode

(out) This value is reserved for internal or future use.

•   EbpCaseOpen

(out) This value indicates that the buyer's payment for the order is being held by PayPal because an eBay Buyer Protection case has been filed against the order. If this value is returned, the seller can expedite the release of PayPal funds into their account by resolving the eBay Buyer Protection case, as indicated by a value of 'ResolveeBPCase' returned in a PaymentHoldDetails.RequiredSellerActionArray.RequiredSellerAction field.

•   NewPaypalAccountAdded

(out) This value indicates that the buyer's payment for the order is being held by PayPal because the seller's PayPal account (identified in Transaction.PayPalEmailAddress) is new and is not fully set up to receive funds.

•   NewSeller

(out) This value indicates that the buyer's payment for the order is being held by PayPal because the seller is new to selling on eBay. Sellers are considered "new" until they have met all three criteria below:

  • More than 90 days have passed since first successful sale
  • More than 25 domestic sales
  • More than $250.00 in total sales

•   NotAvailable

(out) This value indicates that the reason for the buyer's payment for the order being held by PayPal is not known.

•   Other

(out) This value is returned if the reason for the buyer's payment for the order being held by PayPal cannot be classified by any of the other enumeration values.

•   ReinstatementAfterSuspension

(out) This value indicates that the buyer's payment for the order is being held by PayPal because the seller has recently been reinstated as an active eBay seller after their account went through a suspension/restricted period.

After a seller's account is suspended and then reinstated, that seller is treated as a new seller, and must meet the same requirements that a new seller must meet to get beyong the "New Seller" status.




DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ContainingOrder
  .PaymentHoldDetails
  .RequiredSellerActionArray
RequiredSellerActionArrayType Conditionally Container consisting of one or more RequiredSellerAction fields. RequiredSellerAction fields provide possible actions that a seller can take to expedite the release of funds into their account.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ContainingOrder
  .PaymentHoldDetails
  .RequiredSellerActionArray
  .RequiredSellerAction
RequiredSellerActionCodeType Conditionally,
repeatable: [0..*]
This field contains a possible action that a seller can take to expedite the release of a payment hold. There can be one or more RequiredSellerAction fields in the RequiredSellerActionArray container.

Applicable values:

•   ContacteBayCS

(out) This value indicates that the seller should contact eBay Customer Support to discover the next required action to expedite the release of funds into their account.

•   CustomCode

(out) This value is reserved for internal or future use.

•   MarkAsShipped

(out) This value indicates that the seller must mark the order line item as shipped to expedite the release of funds into their account. The seller can use the CompleteSale call to mark an item as shipped. If an order line item is marked as shipped, it is possible that the seller's funds for the order will be released as soon as seven days after the latest estimated delivery date.

•   None

(out) This value is not currently applicable since the new eBay Payment Process for DE and AT sellers has been rolled back indefinitely.

•   ResolveBuyerMessageInr

(out) This value indicates that the buyer has not received the item, and the buyer has contacted the seller through the eBay system in an effort to resolve the issue with the seller. The seller must make it right with the buyer in order to expedite the release of funds into their account.

•   ResolveBuyerMessageSnad

(out) This value indicates that the buyer has received the item, but the item is not as described in the listing; hence, the buyer has contacted the seller through the eBay system in an effort to resolve the issue with the seller. The seller must make it right with the buyer in order to expedite the release of funds into their account.

•   ResolveeBPCase

(out) This value indicates that there is an open eBay Buyer Protection case involving the seller and the item. The seller must address and get the case resolved before the funds can be scheduled for release to the seller's account. See the Resolution Case Management API User Guide for information about retrieving and managing eBay Buyer Protection cases.

•   ResolvePPPIcase

(out) This value indicates that the seller must resolve the PayPal Buyer Protection case filed against the order line item to expedite the release of funds into their account.

•   ResolveReturn

(out) This value indicates that the buyer is returning the item through eBay's managed return process. Upon receiving the returned item from the buyer, the seller must issue a refund to the buyer within five business days, and shortly after this happens, eBay will credit the seller's account with the Final Value Fee that was originally assessed on the sale of the item.

•   UploadTrackingInfo

(out) This value indicates that the seller must provide the buyer the tracking information for the order line item to expedite the release of funds into their account. The seller can use the CompleteSale call to provide tracking information for an order line item. If the tracking information for an order line item is provided, it is possible that the seller's funds for the order will be released as soon as three days after eBay has confirmed that the item has been delivered.




DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ContainingOrder
  .PaymentHoldStatus
PaymentHoldStatusCodeType Conditionally This field indicates the type and/or status of a payment hold on the item.

Applicable values:

•   CustomCode

(out) This value is reserved for internal or future use.

•   MerchantHold

(out) This value indicates a possible issue with a seller. If this value is returned, the TransactionArray.Transaction.SellerPaidStatus field is returned as PaidWithPayPal in GetMyeBaySelling, and the TransactionArray.Transaction.BuyerPaidStatus field is returned as PaidWithPayPal in GetMyeBayBuying.

•   NewSellerHold

(out) This value indicates that there is a "new seller hold" on the item. PayPal may hold payments to a new seller for up to 21 days. Sellers are considered "new" until they have met all three criteria below:

  • More than 90 days have passed since first successful sale
  • More than 25 domestic sales
  • More than $250.00 in total sales

•   None

(out) This value indicates that there is no payment hold on the item.

•   PaymentHold

(out) This value indicates that there is a payment hold on the item.

•   PaymentReview

(out) This value indicates a possible issue with a buyer. If this value is returned, the TransactionArray.Transaction.SellerPaidStatus field is returned as NotPaid in GetMyeBaySelling, and the TransactionArray.Transaction.BuyerPaidStatus field is returned as PaidWithPayPal in GetMyeBayBuying.

•   ReleaseConfirmed

(out) This value indicates that the funds are available in the seller's PayPal account.

•   Released

(out) This value indicates that a payment hold on the item has been released.

•   ReleasePending

(out) This value indicates that the process for the release of funds for the order has been initiated.




DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ContainingOrder.RefundArray
RefundArrayType Conditionally Container consisting of one or more refunds for Half.com orders or DE/AT orders subject to the new eBay payment process. This container is returned only if a refund to a Half.com buyer has occurred or a refund was issued for an order subject to the new eBay payment Process.

Note: The introduction of the new eBay payment process for the entire German and Austrian eBay marketplace has been delayed until further notice.


DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ContainingOrder.RefundArray
  .Refund
RefundType Conditionally,
repeatable: [0..*]
This container consists of information about a Half.com refund. It is only returned for Half.com refund

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ContainingOrder.RefundArray
  .Refund
  .EstimatedRefundCompletionTime
dateTime Conditionally The estimated date and time that the refund is expected to be completed. For eBay orders, Refund containers are only returned for DE/AT orders subject to the new eBay payment process.

Note:The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ContainingOrder.RefundArray
  .Refund.ExternalReferenceID
string Conditionally The unique external reference ID that was passed by the seller when requesting the refund. This ID helps to prevent duplication of refund requests. For eBay orders, Refund containers are only returned for DE/AT orders subject to the new eBay payment process.

Note:The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ContainingOrder.RefundArray
  .Refund.RefundAmount
AmountType (double) Conditionally The total amount of the refund requested. For eBay orders, Refund containers are only returned for DE/AT orders subject to the new eBay payment process.

Note:The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ContainingOrder.RefundArray
  .Refund.RefundAmount
  [ attribute currencyID ]
CurrencyCodeType Always The total amount of the refund requested. For eBay orders, Refund containers are only returned for DE/AT orders subject to the new eBay payment process.

Note:The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice.

For a list of possible enumeration values, see CurrencyCodeType.
TransactionArray.Transaction
  .ContainingOrder.RefundArray
  .Refund.RefundCompletionTime
dateTime Conditionally The date and time that the refund was completed. For eBay orders, Refund containers are only returned for DE/AT orders subject to the new eBay payment process.

Note:The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ContainingOrder.RefundArray
  .Refund.RefundFailureReason
RefundFailureReasonType Conditionally This describes the reason why a refund was not issued by the seller. For eBay orders, Refund containers are only returned for DE/AT orders subject to the new eBay payment process.

Note:The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ContainingOrder.RefundArray
  .Refund.RefundFailureReason
  .RefundFailureCode
RefundFailureCodeType Conditionally An enumerated value indicating the reason why a German or Austrian seller's attempt to distribute a refund to a buyer through the Order Adjustment API's issueRefund call failed. This field is only applicable to orders subject to the new eBay payment process on the German and Austrian sites.

Note: The new eBay payment process for German and Austrian sites has been put on hold indefinitely.

Applicable values:

•   PaypalBillingAgreementCanceled

(out) The refund attempt failed because the seller's billing agreement with PayPal has been cancelled.

Note: The new eBay payment process for German and Austrian sites has been put on hold indefinitely.

•   PaypalRiskDeclinesTransaction

(out) The refund attempt failed because because the PayPayl Risk team declined the transaction. The seller should log in to their PayPal account to proceed with the refund request.

Note: The new eBay payment process for German and Austrian sites has been put on hold indefinitely.


(Not all values in RefundFailureCodeType apply to this field.)


DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ContainingOrder.RefundArray
  .Refund
  .RefundFundingSourceArray
RefundFundingSourceArrayType Conditionally This container lists the funding sources for the refund. For eBay orders, Refund containers are only returned for DE/AT orders subject to the new eBay payment process.

Note:The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ContainingOrder.RefundArray
  .Refund
  .RefundFundingSourceArray
  .RefundFundingSource
RefundFundingSourceType Conditionally,
repeatable: [0..*]
The funding source for the refund issued by the seller through the Order Adjusment API's issueRefund call. It is possible that more than one funding source may be used for this refund.

Note: The new eBay payment process on the German and Austrian sites has been put on hold indefinitely.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ContainingOrder.RefundArray
  .Refund
  .RefundFundingSourceArray
  .RefundFundingSource
  .AccountNumber
string Conditionally The account number of the funding source.

Note: The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ContainingOrder.RefundArray
  .Refund
  .RefundFundingSourceArray
  .RefundFundingSource
  .BuyerExternalTransactionID
string Conditionally The external transaction ID of the buyer's account.

Note: The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ContainingOrder.RefundArray
  .Refund
  .RefundFundingSourceArray
  .RefundFundingSource
  .RefundAmount
AmountType (double) Conditionally The amount of the refund.

Note: The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ContainingOrder.RefundArray
  .Refund
  .RefundFundingSourceArray
  .RefundFundingSource
  .RefundAmount
  [ attribute currencyID ]
CurrencyCodeType Always The amount of the refund.

Note: The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice.

For a list of possible enumeration values, see CurrencyCodeType.
TransactionArray.Transaction
  .ContainingOrder.RefundArray
  .Refund
  .RefundFundingSourceArray
  .RefundFundingSource
  .RefundingSourceType
RefundingSourceTypeCodeType Conditionally The source from which the refund was made.

Note: The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice.

Applicable values:

•   BankAccount

(out) The seller's bank account associated with the transaction.

Note: The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice.

•   CustomCode

(out) Reserved for internal or future use.

•   Paypal

(out) The seller's PayPal account associated with the transaction.

Note: The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice.

•   ScheduledPayout

(out) The seller's scheduled payout account with eBay. When a buyer pays for an item the purchase amount goes into this account. This value indicates that the refund has been issued from the seller's scheduled payout account.

Note: The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice.




DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ContainingOrder.RefundArray
  .Refund
  .RefundFundingSourceArray
  .RefundFundingSource
  .SellerExternalTransactionID
string Conditionally The external transaction ID of the seller's account.

Note: The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ContainingOrder.RefundArray
  .Refund.RefundID
string Conditionally The refund ID for this refund. For eBay orders, Refund containers are only returned for DE/AT orders subject to the new eBay payment process.


Note: The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ContainingOrder.RefundArray
  .Refund.RefundRequestedTime
dateTime Conditionally The date and time when the refund was requested. For eBay orders, Refund containers are only returned for DE/AT orders subject to the new eBay payment process.

Note:The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ContainingOrder.RefundArray
  .Refund.RefundStatus
RefundStatusCodeType Conditionally A code indicating the status of the refund request. For eBay orders, Refund containers are only returned for DE/AT orders subject to the new eBay payment process.

Note:The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice.

Applicable values:

•   CustomCode

(out) Reserved for internal or future use.

•   Failed

(out) The refund request was rejected.

Note: The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice.

•   Pending

(out) The refund request is being processed.

Note: The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice.

•   Successful

(out) The refund request was successful.

Note: The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice.




DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ContainingOrder.RefundArray
  .Refund.RefundTransactionArray
RefundTransactionArrayType Conditionally A container consisting of details about an order line item against which the seller issued a refund. For eBay orders, Refund containers are only returned for DE/AT orders subject to the new eBay payment process.

Note:The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ContainingOrder.RefundArray
  .Refund.RefundTransactionArray
  .RefundTransaction
RefundTransactionType Conditionally,
repeatable: [0..*]
A container consisting of details about an order line item against which the seller issued a refund.

Note: The new eBay payment process on the German and Austrian sites has been put on hold indefinitely.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ContainingOrder.RefundArray
  .Refund.RefundTransactionArray
  .RefundTransaction.ItemID
string Conditionally The item against which the refund was issued. This value must be accompanied by a TransactionID value.

Note: The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ContainingOrder.RefundArray
  .Refund.RefundTransactionArray
  .RefundTransaction.OrderID
string Conditionally The order against which the refund was issued. The presence of this value indicates that the refund was issued against the entire order.

Note: The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ContainingOrder.RefundArray
  .Refund.RefundTransactionArray
  .RefundTransaction
  .RefundLineArray
RefundLineArrayType Conditionally An array of refund lines identifying the order line items against which the refund was issued.

Note: The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ContainingOrder.RefundArray
  .Refund.RefundTransactionArray
  .RefundTransaction
  .RefundLineArray.RefundLine
RefundLineType (AmountType) Conditionally,
repeatable: [0..*]
This field indicates the type and amount of the refund to the buyer involved in an DE/AT order order subject to the new eBay payment process. The type attribute indicates whether the refund is being applied against the purchase price or the shipping price. Using the issueRefund call of the Order Adjustment API, the seller can also issue an optional/additional refund that does not apply to the purchase price or shipping price. The type values are defined in the RefundLineTypeCodeType enumeration type.



RefundLine fields will only be returned if a refund has been issued from the seller to the buyer for a DE/AT order going through the new eBay payment process.

Note: The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ContainingOrder.RefundArray
  .Refund.RefundTransactionArray
  .RefundTransaction
  .RefundLineArray.RefundLine
  [ attribute type ]
RefundLineTypeCodeType Conditionally This field indicates the type and amount of the refund to the buyer involved in an DE/AT order order subject to the new eBay payment process. The type attribute indicates whether the refund is being applied against the purchase price or the shipping price. Using the issueRefund call of the Order Adjustment API, the seller can also issue an optional/additional refund that does not apply to the purchase price or shipping price. The type values are defined in the RefundLineTypeCodeType enumeration type.



RefundLine fields will only be returned if a refund has been issued from the seller to the buyer for a DE/AT order going through the new eBay payment process.

Note: The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice.

For a list of possible enumeration values, see RefundLineTypeCodeType.
TransactionArray.Transaction
  .ContainingOrder.RefundArray
  .Refund.RefundTransactionArray
  .RefundTransaction
  .RefundLineArray.RefundLine
  [ attribute currencyID ]
CurrencyCodeType Always This field indicates the type and amount of the refund to the buyer involved in an DE/AT order order subject to the new eBay payment process. The type attribute indicates whether the refund is being applied against the purchase price or the shipping price. Using the issueRefund call of the Order Adjustment API, the seller can also issue an optional/additional refund that does not apply to the purchase price or shipping price. The type values are defined in the RefundLineTypeCodeType enumeration type.



RefundLine fields will only be returned if a refund has been issued from the seller to the buyer for a DE/AT order going through the new eBay payment process.

Note: The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice.

For a list of possible enumeration values, see CurrencyCodeType.
TransactionArray.Transaction
  .ContainingOrder.RefundArray
  .Refund.RefundTransactionArray
  .RefundTransaction
  .TransactionID
string Conditionally The transaction against which the refund was issued. This value must be accompanied by an ItemID value.

Note: The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ContainingOrder.RefundArray
  .Refund.SellerNoteToBuyer
string Conditionally Comments made by the the seller to the buyer. For eBay orders, Refund containers are only returned for DE/AT orders subject to the new eBay payment process.

Note:The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ContainingOrder
  .ShippingConvenienceCharge
AmountType (double) Conditionally The dollar value in this field indicates the amount that the seller is being charged (at order level) for the convenience of an eBay Now delivery. The standard minimum order amount for an eBay Now delivery is $25, with a "convenience fee" of $5. If the buyer meets the minimum order amount, this value will generally be '5.0'. However, it is also possible that the buyer's order only totals $15, so that buyer is required to pay a "convenience fee" of $10.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ContainingOrder
  .ShippingConvenienceCharge
  [ attribute currencyID ]
CurrencyCodeType Always The dollar value in this field indicates the amount that the seller is being charged (at order level) for the convenience of an eBay Now delivery. The standard minimum order amount for an eBay Now delivery is $25, with a "convenience fee" of $5. If the buyer meets the minimum order amount, this value will generally be '5.0'. However, it is also possible that the buyer's order only totals $15, so that buyer is required to pay a "convenience fee" of $10.

For a list of possible enumeration values, see CurrencyCodeType.
TransactionArray.Transaction
  .ConvertedAdjustmentAmount
AmountType (double) Conditionally Converted value of AdjustmentAmount in the currency of the site that returned the response. Refresh this value every 24 hours to pick up the current conversion rates.

Not applicable to Half.com.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ConvertedAdjustmentAmount
  [ attribute currencyID ]
CurrencyCodeType Always Converted value of AdjustmentAmount in the currency of the site that returned the response. Refresh this value every 24 hours to pick up the current conversion rates.

Not applicable to Half.com.

For a list of possible enumeration values, see CurrencyCodeType.
TransactionArray.Transaction
  .ConvertedAmountPaid
AmountType (double) Conditionally Converted value of AmountPaid in the currency of the site that returned the response. Refresh this value every 24 hours to pick up the current conversion rates.

Not applicable to Half.com.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ConvertedAmountPaid
  [ attribute currencyID ]
CurrencyCodeType Always Converted value of AmountPaid in the currency of the site that returned the response. Refresh this value every 24 hours to pick up the current conversion rates.

Not applicable to Half.com.

For a list of possible enumeration values, see CurrencyCodeType.
TransactionArray.Transaction
  .ConvertedTransactionPrice
AmountType (double) Conditionally Converted value of TransactionPrice in the currency of the site that returned the response. Refresh this value every 24 hours to pick up the current conversion rates.

Not applicable to Half.com.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ConvertedTransactionPrice
  [ attribute currencyID ]
CurrencyCodeType Always Converted value of TransactionPrice in the currency of the site that returned the response. Refresh this value every 24 hours to pick up the current conversion rates.

Not applicable to Half.com.

For a list of possible enumeration values, see CurrencyCodeType.
TransactionArray.Transaction
  .CreatedDate
dateTime Conditionally Indicates the creation time of the order line item. For auction listings, an order line item is created when that listing ends with a high bidder whose bid meets or exceeds the Reserve Price (if set). For a fixed-price listing or a Buy It Now auction listing, an order line item is created once the buyer clicks the Buy button.

Applicable to Half.com (for GetOrders only).

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .DepositType
DepositTypeCodeType Conditionally This value indicates whether or not the seller requires a deposit for the vehicle. This field is only applicable to US eBay Motors listings. Otherwise, this field is returned as an empty value.

Not applicable to Half.com.

Applicable values:

•   None

(in/out) No deposit needed.

•   OtherMethod

(in/out) Pay the deposit using PayPal, and then use any of the other specified payment methods to pay the balance.


(Not all values in DepositTypeCodeType apply to this field.)


DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.

See Listing US and CA eBay Motors Items.

TransactionArray.Transaction
  .ExternalTransaction
ExternalTransactionType Conditionally,
repeatable: [0..*]
Container consisting of details for a PayPal transaction that relates to the eBay order. PayPal transactions may include a buyer payment or refund, or a fee or credit applied to the seller's account. This field is only returned if a PayPal transaction related to order has occurred.

Not applicable to Half.com.

DetailLevel: ReturnAll.
TransactionArray.Transaction
  .ExternalTransaction
  .ExternalTransactionID
string Conditionally Unique identifier for a PayPal payment of an eBay order. If the order was purchased with a payment method other than PayPal, "SIS" is returned, which stands for "Send Information To Seller." This field is only returned after payment has been made.

DetailLevel: ReturnAll.
TransactionArray.Transaction
  .ExternalTransaction
  .ExternalTransactionStatus
PaymentTransactionStatusCodeType Conditionally The current processing status of a PayPal payment for an eBay order.

Applicable values:

•   CustomCode

(out) Reserved for internal or future use.

•   Failed

(out) This value indicates that the payment transaction failed.

•   Pending

(out) This value indicates that the payment transaction is pending.

•   Succeeded

(out) This value indicates that the payment transaction succeeded.




DetailLevel: ReturnAll.
TransactionArray.Transaction
  .ExternalTransaction
  .ExternalTransactionTime
dateTime Conditionally Timestamp for payment transaction.

DetailLevel: ReturnAll.
TransactionArray.Transaction
  .ExternalTransaction
  .FeeOrCreditAmount
AmountType (double) Conditionally Fee Amount is a positive value and Credit Amount is a negative value.

DetailLevel: ReturnAll.
TransactionArray.Transaction
  .ExternalTransaction
  .FeeOrCreditAmount
  [ attribute currencyID ]
CurrencyCodeType Always Fee Amount is a positive value and Credit Amount is a negative value.

For a list of possible enumeration values, see CurrencyCodeType.
TransactionArray.Transaction
  .ExternalTransaction
  .PaymentOrRefundAmount
AmountType (double) Conditionally If positive, the amount the buyer pays the seller through PayPal on the purchase of items. If negative, the amount refunded the buyer. Default = 0.

DetailLevel: ReturnAll.
TransactionArray.Transaction
  .ExternalTransaction
  .PaymentOrRefundAmount
  [ attribute currencyID ]
CurrencyCodeType Always If positive, the amount the buyer pays the seller through PayPal on the purchase of items. If negative, the amount refunded the buyer. Default = 0.

For a list of possible enumeration values, see CurrencyCodeType.
TransactionArray.Transaction
  .FinalValueFee
AmountType (double) Conditionally A Final Value Fee is calculated and charged to a seller's account immediately upon creation of an order line item. Note that this fee is created before the buyer makes a payment.The Final Value Fee for each order line item is returned by GetSellerTransactions, GetItemTransactions, GetOrders, and GetOrderTransactions, regardless of the checkout status.

If a seller requests a Final Value Fee credit, the value of Transaction.FinalValueFee will not change if a credit is issued. The credit only appears in the seller's account data.

Not applicable to Half.com.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .FinalValueFee
  [ attribute currencyID ]
CurrencyCodeType Always A Final Value Fee is calculated and charged to a seller's account immediately upon creation of an order line item. Note that this fee is created before the buyer makes a payment.The Final Value Fee for each order line item is returned by GetSellerTransactions, GetItemTransactions, GetOrders, and GetOrderTransactions, regardless of the checkout status.

If a seller requests a Final Value Fee credit, the value of Transaction.FinalValueFee will not change if a credit is issued. The credit only appears in the seller's account data.

Not applicable to Half.com.

For a list of possible enumeration values, see CurrencyCodeType.
TransactionArray.Transaction
  .IntangibleItem
boolean Conditionally The Intangible flag value is passed over to PayPal during Checkout and disputes. Using this value PayPal will differentiate between transactions.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .InvoiceSentTime
dateTime Conditionally The date on which the invoice was sent.

DetailLevel: ReturnAll.
TransactionArray.Transaction
  .IsMultiLegShipping
boolean Conditionally This field identifies if the Global Shipping was used for the order.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .Item
ItemType Always Container consisting of details about an item in a listing. The child fields return are dependent on the call, the type of item or listing, and the listing site.

Applicable to Half.com (for GetOrders).

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .Item.ApplicationData
string Conditionally Returns custom, application-specific data associated with the item. The data you specify is stored by eBay with the item for your own reference, but it is not used by eBay in any way. Use ApplicationData to store special information for yourself, such as a part number. For a SKU in an eBay.com listing, use the SKU element instead. To remove this value when revising or relisting an item, use DeletedField.

Not applicable to Half.com; use SellerInventoryID instead.
Max length: 32.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .Item.AutoPay
boolean Always To create a requirement that a buyer pays immediately (through PayPal or PaisaPay) for an auction (Buy It Now only) or fixed-price item, the seller can include and set the AutoPay field to 'true' for an Add/Revise/Relist API call. If the seller does not want to create an immediate payment item, this field is either omitted, or included and set to 'false'.

If this feature is enabled for a listing, the buyer must pay immediately for the item through PayPal or PaisaPay (India site only), and the buyer's funds are transferred instantly to the seller's PayPal or PaisaPay account. The seller's item will remain available for purchase by other buyers until the buyer actually completes the payment.

In order for a seller to apply an immediate payment requirement for an item, the following must be true:
  • seller must have a Premier or Business PayPal account (or PaisaPay for India sellers);
  • the Buy It Now price (if applicable) cannot be higher than $10,000 USD;
  • the listing site supports PayPal (or PaisaPay for India site) payments;
  • the category supports PayPal (or PaisaPay for India site) payments;
  • the listing type is fixed-price or auction (with Buy It Now option).

To successfully enable the immediate payment requirement, the seller must also perform the following actions through the API call:
  • seller must provide a valid Item.PayPalEmailAddress value (not required for India site);
  • seller must offer PayPal as the only payment method, or for the India site, one or more of the three supported PaisaPay payment methods;
  • seller must specify all related costs to the buyer, since the buyer will not be able to use the Buyer Request Total feature in an immediate payment listing; these costs include flat-rate shipping costs for each domestic and international shipping service offered, package handling costs, and any shipping surcharges;
  • seller must include and set the PromotionalShippingDiscount field to true if a promotional shipping discount is being applied to the listing;
  • seller must include the ShippingDiscountProfileID and reference a valid flat or calculated Shipping Discount Profile ID if a flat or calculated shipping rule is being applied to the listing.

In the Trading API calls that return the AutoPay field, be aware that the field's appearance in the output does not necessarily indicate that the immediate payment feature was successfully enabled/used for the active or ended listing, but only that the seller attempted to enable (by including and setting AutoPay to 'true' in the request) the immediate payment feature for the listing.

To discover if a category supports immediate payment for an item, use GetCategories and look for the appearance of the AutoPayEnabled boolean field in the output for that category (identified by CategoryID). AutoPayEnabled is returned as an empty element if the category supports immediate payment, and is not returned at all if the category does not support immediate payment.

Not applicable to Half.com.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.

See:
    Specifying a Payment Method
    Requiring Immediate Payment of a Vehicle Deposit

TransactionArray.Transaction
  .Item.BuyerProtection
BuyerProtectionCodeType Conditionally Flag to indicate an item's eligibility for the PayPal Purchase Protection program. This field is only returned if 'true'. If this field is not returned, the item is not eligible for PayPal Purchase Protection. For more information on items that are eligible for PayPal Purchase Protection, see the PayPal Purchase Protection help page.

Not applicable to Half.com.

Applicable values:

•   CustomCode

(out) Reserved for internal or future use.

•   ItemEligible

(out) This value indicates that the item is eligible for buyer protection.

•   ItemIneligible

(out) This value indicates that the item is ineligible for buyer protection. In many cases, the item is ineligible for buyer protection due to the category it is listed under.

•   ItemMarkedEligible

(out) This value indicates that the eBay customer support has marked the item as eligible per special criteria.

•   ItemMarkedIneligible

(out) This value indicates that the eBay customer support has marked the item as ineligible per special criteria (e.g., seller's account closed).

•   NoCoverage

(out) This value indicates that the item is ineligible for coverage under any buyer protection program.




DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.

See Miscellaneous Item Field Differences.

TransactionArray.Transaction
  .Item.BuyItNowPrice
AmountType (double) Conditionally For auction listings, the Buy It Now feature allows a user to purchase the item at a Buy It Now price and end the auction immediately. Use this field to specify the Buy It Now price. Including and specifying a BuyItNowPrice value enables the Buy It Now feature for the auction listing.

There is a minimum percentage value that the Buy It Now price must be set above the Start Price. This minimum percentage value varies by site. To see the valid values for your site, call GeteBayDetails with DetailName set to ListingStartPriceDetails, and then look for the ListingStartPriceDetails.MinBuyItNowPricePercent field in the response. If this value is 40.0 (percent), that means that your Buy It Now price on your auction listing must exceed the Start Price by 40 percent to be valid.

This feature is not applicable to fixed-price listings, Ad Format listings, or Half.com listings.

Once an auction has bids (and the high bid exceeds the Reserve Price, if specified), the listing is no longer eligible for Buy It Now (with some exceptions noted below). However, calls like GetItem still return the BuyItNowPrice that the seller originally set for the listing. Use the GetItem call and look for the inclusion of the Item.ListingDetails.BuyItNowAvailable flag in the output to determine whether the item can still be purchased using Buy It Now. You can also view the Item.SellingStatus.BidCount value in other item retrieval calls to determine whether an auction with Buy It Now has bids or not.

There might be price limits imposed for Buy It Now items, subject to the seller's PayPal account or the payment method used. Such limits cannot be determined via the eBay API and are not covered in eBay's API documentation because they can vary for each user.

To remove this value when revising or relisting an item, use DeletedField.

DetailLevel: ReturnAll.

See:
    Seller Limits
    GeteBayDetails
    Revising US eBay Motors Listings

TransactionArray.Transaction
  .Item.BuyItNowPrice
  [ attribute currencyID ]
CurrencyCodeType Always For auction listings, the Buy It Now feature allows a user to purchase the item at a Buy It Now price and end the auction immediately. Use this field to specify the Buy It Now price. Including and specifying a BuyItNowPrice value enables the Buy It Now feature for the auction listing.

There is a minimum percentage value that the Buy It Now price must be set above the Start Price. This minimum percentage value varies by site. To see the valid values for your site, call GeteBayDetails with DetailName set to ListingStartPriceDetails, and then look for the ListingStartPriceDetails.MinBuyItNowPricePercent field in the response. If this value is 40.0 (percent), that means that your Buy It Now price on your auction listing must exceed the Start Price by 40 percent to be valid.

This feature is not applicable to fixed-price listings, Ad Format listings, or Half.com listings.

Once an auction has bids (and the high bid exceeds the Reserve Price, if specified), the listing is no longer eligible for Buy It Now (with some exceptions noted below). However, calls like GetItem still return the BuyItNowPrice that the seller originally set for the listing. Use the GetItem call and look for the inclusion of the Item.ListingDetails.BuyItNowAvailable flag in the output to determine whether the item can still be purchased using Buy It Now. You can also view the Item.SellingStatus.BidCount value in other item retrieval calls to determine whether an auction with Buy It Now has bids or not.

There might be price limits imposed for Buy It Now items, subject to the seller's PayPal account or the payment method used. Such limits cannot be determined via the eBay API and are not covered in eBay's API documentation because they can vary for each user.

To remove this value when revising or relisting an item, use DeletedField.

For a list of possible enumeration values, see CurrencyCodeType.
TransactionArray.Transaction
  .Item.Charity
CharityType Conditionally Identifies a Giving Works listing and the benefiting nonprofit charity organization selected by the charity seller (if any). If specified, the seller must also accept PayPal as a payment method for the item (see Item.PaymentMethods).

When you revise an item, you can add a charity to a non-charity listing, but you cannot remove or change the charity designation. The rules for adding a charity to a listing depend on the listing type. For an auction listing, you can revise an item to add a charity if there are more than 12 hours left for the listing (whether or not the item has bids). For a fixed-price listing, you can revise an item to add a charity if there are more than 12 hours left for the listing, and the item has not been sold.

When you relist an item, use DeletedField to remove charity information.

Not applicable to Half.com.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.

See:
    Miscellaneous Item Field Differences
    Working with Listings that Benefit Nonprofits

TransactionArray.Transaction
  .Item.Charity.CharityListing
boolean Conditionally If true, indicates that the seller has chosen to use eBay Giving Works to donate a percentage of the item's purchase price to a selected nonprofit organization.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .Item.Country
CountryCodeType Conditionally Defines the 2-letter country code set.

To see the list of currently supported country codes, and the English names associated with each code (e.g., KY="Cayman Islands"), call GeteBayDetails with DetailName set to CountryDetails, and then look for CountryDetails.Country fields in the response.

Most of the codes that eBay uses conform to the ISO 3166 standard, but some of the codes in the ISO 3166 standard are not used by eBay. Plus, there are some non-ISO codes in the eBay list. (Additional codes appear at the end of this code list and are noted as non-ISO.)

Also applicable as input to AddItem and related calls when you list items to Half.com (specify 'US').

Applicable values: See Country.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.

See GeteBayDetails.

TransactionArray.Transaction
  .Item.Currency
CurrencyCodeType Always Currency associated with the item's price information. 3-letter ISO 4217 currency code that corresponds to the site specified in the listing request. Also applicable as input to AddItem and related calls when you list items to Half.com (specify USD). You cannot modify a listing's currency when you revise or relist an item.

To see the list of currently supported currency codes, call GeteBayDetails with DetailName set to CurrencyDetails, and then look for the CurrencyDetails.Currency fields in the response.

Applicable values: See Currency.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.

See:
    GeteBayDetails
    Field Differences for eBay Sites

TransactionArray.Transaction
  .Item.GetItFast
boolean Conditionally Indicates whether the seller has committed to the GetItFast shipping rules for this listing. If the GetItFast field is set to true, and the seller's first priority domestic shipping service (the service that has the ShippingServicePriority field set to 1) is an expedited shipping service, then every shipping service offered for this listing is considered a GetItFast service. Therefore, the seller commits to delivering the item to the buyer-selected shipping service within one day.
Not applicable to Half.com.

DetailLevel: ReturnAll.

See:
    Enabling Multi-Jurisdiction Sales Tax
    Miscellaneous Item Field Differences

TransactionArray.Transaction
  .Item
  .IntegratedMerchantCreditCardEnabled
boolean Always Indicates whether the item can be paid for through a payment gateway (Payflow) account. If IntegratedMerchantCreditCardEnabled is true, then integrated merchant credit card (IMCC) is enabled for credit cards because the seller has a payment gateway account. Therefore, if IntegratedMerchantCreditCardEnabled is true, and AmEx, Discover, or VisaMC is returned for an item, then on checkout, an online credit-card payment is processed through a payment gateway account. A payment gateway account is used by sellers to accept online credit cards (Visa, MasterCard, American Express, and Discover).

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .Item.InventoryTrackingMethod
InventoryTrackingMethodCodeType Conditionally Indicates whether you prefer to track your eBay listings by eBay Item ID or by your own SKU.

If you want to use SKU instead of ItemID as a unique identifier (such as when retrieving items and orders), you can set Item.InventoryTrackingMethod to SKU in AddFixedPriceItem and related calls. In this case, the SKU must be unique across your (the seller's) active listings. Note that if you relist the item, you must reset Item.InventoryTrackingMethod to SKU; otherwise the relisted item will default to ItemID as the tracking method.

If both ItemID and SKU are specified in item-retrieval and order-retrieval calls that support the use of SKU as a unique identifier, the ItemID value takes precedence and is used to identify the listing.
For GetItem and related calls: Only returned when the value is SKU; not returned when the value is ItemID. Not applicable to Half.com.

Applicable values:

•   CustomCode

(in/out) Reserved for internal or future use

•   ItemID

(in/out) The seller prefers to track the listing by its eBay item ID. This is the default for all listings.

•   SKU

(in/out) The seller prefers to track the listing by their own SKU. When you track by SKU, it means you can pass your SKU instead of the eBay item ID in other calls that support SKU as an input field. If you choose SKU as your tracking preference for a listing, the value in Item.SKU must be unique across your active listings. You cannot create new listings with the same Item.SKU value while the listing is active (that is, until the existing listing with that SKU has ended). However, you can use ReviseInventoryStatus to update the quantity and/or price for the existing SKU as needed. When revising a listing where the InventoryTrackingMethod was set to SKU, you must pass in both the InventoryTrackingMethod tag (with the value set to SKU) and the SKU tag with the SKU value from your original listing.




DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.

See eBay Merchant Data API for AddFixedPriceItem and ReviseFixedPriceItem.

TransactionArray.Transaction
  .Item.ItemID
ItemIDType (string) Always The ID that uniquely identifies the item listing. The ID is generated by eBay after an item is listed. You cannot choose or revise this value.

Also applicable to Half.com. For Half.com, you can specify either ItemID or SellerInventoryID in a ReviseItem request to uniquely identify the listing.

In order retrieval calls (such as, GetOrders), use the OrderLineItemID (which is a concatenation of ItemID and TransactionID to uniquely identify an order line item. With multi-quantity listings, a single ItemID can be associated with more than one TransactionID. (For single-quantity listings, the TransactionID is 0.)

In GetItemRecommendations, the item ID is required when the value of ListingFlow is ReviseItem or RelistItem, but it is not applicable when the value of ListingFlow is AddItem.
Note: Although we represent item IDs as strings in the schema, we recommend you store them as 64-bit signed integers. If you choose to store item IDs as strings, allocate at least 19 characters (assuming decimal digits are used) to hold them. eBay will increase the size of IDs over time. Your code should be prepared to handle IDs of up to 19 digits. For more information about item IDs, see Common FAQs on eBay Item IDs and other eBay IDs in the Knowledge Base.
Max length: 19 (Note: the eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits).

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .Item.ListingDetails
ListingDetailsType Conditionally Various details about a listing, some of which are calculated or derived after the item is listed. These include the start and end time, converted (localized) prices, and certain flags that indicate whether the seller specified fields whose values are not visible to the requesting user. For GetMyeBayBuying, returned as a self-closed element if no listings meet the request criteria.

Not applicable to Half.com.

DetailLevel: ReturnAll.
TransactionArray.Transaction
  .Item.ListingDetails.Adult
boolean Conditionally If true, the item is listed in a Mature category. Users must accept the Mature Category agreement on the eBay site to retrieve items listed in Mature categories. (Users do not need to sign this agreement to be able to list items in Mature Categories.)

DetailLevel: ReturnAll.
TransactionArray.Transaction
  .Item.ListingDetails
  .BindingAuction
boolean Conditionally Applicable for Real Estate auctions only. If true, buyers and sellers are expected to follow through on the sale. If false, bids for the Real Estate auction are only expressions of interest.

DetailLevel: ReturnAll.
TransactionArray.Transaction
  .Item.ListingDetails
  .CheckoutEnabled
boolean Conditionally This flag indicates whether or not the seller's Checkout Enabled preference is turned on (at account level or at listing level). This preference is managed through Payment Preferences in My eBay. If this preference is enabled, a Pay Now button will appear in checkout flow pages and in the email notifications that are sent to buyers. This preferance is enabled by default if PayPal is one of the payment methods.

DetailLevel: ReturnAll.

See Checkout.

TransactionArray.Transaction
  .Item.ListingDetails
  .ConvertedBuyItNowPrice
AmountType (double) Conditionally Converted value of the BuyItNowPrice in the currency of the site that returned this response. For active items, refresh this value every 24 hours to pick up the current conversion rates.

DetailLevel: ReturnAll.
TransactionArray.Transaction
  .Item.ListingDetails
  .ConvertedBuyItNowPrice
  [ attribute currencyID ]
CurrencyCodeType Always Converted value of the BuyItNowPrice in the currency of the site that returned this response. For active items, refresh this value every 24 hours to pick up the current conversion rates.

For a list of possible enumeration values, see CurrencyCodeType.
TransactionArray.Transaction
  .Item.ListingDetails
  .ConvertedReservePrice
AmountType (double) Conditionally Converted value of the ReservePrice in the currency of the site that returned this response. Only returned for listings with a reserve price when the requesting user is the listing's seller. For active items, refresh this value every 24 hours to pick up the current conversion rates. Not applicable to Fixed Price listings.

DetailLevel: ReturnAll.
TransactionArray.Transaction
  .Item.ListingDetails
  .ConvertedReservePrice
  [ attribute currencyID ]
CurrencyCodeType Always Converted value of the ReservePrice in the currency of the site that returned this response. Only returned for listings with a reserve price when the requesting user is the listing's seller. For active items, refresh this value every 24 hours to pick up the current conversion rates. Not applicable to Fixed Price listings.

For a list of possible enumeration values, see CurrencyCodeType.
TransactionArray.Transaction
  .Item.ListingDetails
  .ConvertedStartPrice
AmountType (double) Conditionally Converted value of the StartPrice in the currency of the site that returned this response. For active items, refresh this value every 24 hours to pick up the current conversion rates.

In multi-variation listings, this value matches the lowest-priced variation that is still available for sale.

DetailLevel: ReturnAll.
TransactionArray.Transaction
  .Item.ListingDetails
  .ConvertedStartPrice
  [ attribute currencyID ]
CurrencyCodeType Always Converted value of the StartPrice in the currency of the site that returned this response. For active items, refresh this value every 24 hours to pick up the current conversion rates.

In multi-variation listings, this value matches the lowest-priced variation that is still available for sale.

For a list of possible enumeration values, see CurrencyCodeType.
TransactionArray.Transaction
  .Item.ListingDetails.EndTime
dateTime Conditionally Time stamp (in GMT) when the listing is scheduled to end (calculated based on the values of StartTime and ListingDuration) or the actual end time if the item has ended.

DetailLevel: ReturnAll.
TransactionArray.Transaction
  .Item.ListingDetails
  .HasPublicMessages
boolean Conditionally Indicates whether the item has any publicly displayed messages. Use GetMemberMessages to retrieve public messages for the item if this flag indicates that there are any.

DetailLevel: ReturnAll.
TransactionArray.Transaction
  .Item.ListingDetails
  .HasReservePrice
boolean Conditionally If true, the seller specified a value in ReservePrice.

DetailLevel: ReturnAll.
TransactionArray.Transaction
  .Item.ListingDetails
  .MinimumBestOfferPrice
AmountType (double) Conditionally Specifies the minimum acceptable Best Offer price. If a buyer submits a Best Offer that is below this value, the offer is automatically declined by the seller. Applies only to items listed in categories that support the Best Offer Auto-Decline feature. Best Offer must be enabled for the item, and only the seller who listed the item can see this value. To remove this value when revising or relisting an item, use DeletedField.

DetailLevel: ReturnAll.
TransactionArray.Transaction
  .Item.ListingDetails
  .MinimumBestOfferPrice
  [ attribute currencyID ]
CurrencyCodeType Always Specifies the minimum acceptable Best Offer price. If a buyer submits a Best Offer that is below this value, the offer is automatically declined by the seller. Applies only to items listed in categories that support the Best Offer Auto-Decline feature. Best Offer must be enabled for the item, and only the seller who listed the item can see this value. To remove this value when revising or relisting an item, use DeletedField.

For a list of possible enumeration values, see CurrencyCodeType.
TransactionArray.Transaction
  .Item.ListingDetails
  .RelistedItemID
ItemIDType (string) Conditionally Indicates the new item ID for a re-listed item. When an item is re-listed, the item ID for the new item is added to the old listing, so buyers can navigate to the new listing. This value only appears when the old listing is retrieved. The RelistedItemID of the original item should reflect the last relist.

DetailLevel: ReturnAll.
TransactionArray.Transaction
  .Item.ListingDetails.StartTime
dateTime Conditionally The StartTime value returned by non-search calls such as GetItem is the time stamp (in GMT) for when the item was listed.

DetailLevel: ReturnAll.
TransactionArray.Transaction
  .Item.ListingDetails
  .TCROriginalItemID
ItemIDType (string) Conditionally Indicates the item ID of the original item listing from which a Transaction Confirmation Request (TCR) was created. This value is only returned when the data for a TCR is retrieved.

DetailLevel: ReturnAll.
TransactionArray.Transaction
  .Item.ListingDetails
  .ViewItemURL
anyURI Conditionally The URL of the Web page where a user can view the listing. On the US site, this is called the "View Item" page. If you enabled affiliate tracking in a search-related call (for example, if you used the AffiliateTrackingDetails container in an applicable call), ViewItemURL contains a string that includes affiliate tracking information (see the eBay Partner Network).

DetailLevel: ReturnAll.
TransactionArray.Transaction
  .Item.ListingDetails
  .ViewItemURLForNaturalSearch
anyURI Conditionally This URL takes you to the same View Item page as ViewItemURL, but this URL is optimized to support natural search. That is, this URL is designed to make items on eBay easier to find via popular Internet search engines. The URL includes the item title along with other optimizations. To note, "?" (question mark) optimizes to "_W0QQ", "&" (ampersand) optimizes to "QQ", and "=" (equals sign) optimizes to "Z".

If you are an eBAy affiliate, use this URL to promote your affiliate information.

Note: This URL may include additional query parameters that don't appear in ViewItemURL and vice versa. You should not modify the query syntax. For example, eBay won't recognize the URL if you change QQ to ?.

DetailLevel: ReturnAll.
TransactionArray.Transaction
  .Item.ListingType
ListingTypeCodeType Always The format of the listing the seller wants to use, such as auction style or fixed price.

Optional for eBay.com listings (defaults to auction style) in AddItem and VerifyAddItem. Do not specify ListingType for eBay.com listings in ReviseItem. (You can't modify the listing type of an active eBay listing.

Required for Half.com listings (and the value must be Half) in AddItem, VerifyAddItem, and ReviseItem. If you don't specify Half when revising Half.com listings, ReviseItem won't use the correct logic and you may get strange errors (or unwanted side effects in the listing, even if no errors are returned).



Applicable values:

•   AdType

(in/out) Advertisement to solicit inquiries on listings such as real estate. Permits no bidding on that item, service, or property. To express interest, a buyer fills in a contact form that eBay forwards to the seller as a lead. This format does not enable buyers and sellers to transact online through eBay, and eBay Feedback is not available for ad format listings.

•   Chinese

(in/out) Single-quantity online auction format. A Chinese auction has a Quantity of 1. Buyers engage in competitive bidding, although Buy It Now may be offered as long as no bids have been placed. Online auctions are listed on eBay.com, and they are also listed in the seller's eBay Store if the seller is a Store owner.

•   CustomCode

(in/out) Reserved for internal or future use.

•   FixedPriceItem

(in/out) A basic fixed-price item format. Bids do not occur. The quantity of items is one or more.

Also known as Buy It Now Only on some sites (not to be confused with the BuyItNow option that is available for auctions).

Sellers must meet certain feedback requirements and/or be ID Verified to use this format. See eBay Features Guide for more information.

Fixed-price listings are listed on eBay.com, and they are listed in the seller's eBay Store if the seller is a Store owner. Stores fixed price items will be treated as basic fixed-price items. Permitted durations of 30 days and GTC are now available for store and non-store subscribers (in addition to the existing durations of 3, 5, 7, and 10 days).

•   LeadGeneration

(in/out) Lead Generation format (advertisement-style listing to solicit inquiries or offers, no bidding or fixed price, listed on eBay).

•   PersonalOffer

(out) Second chance offer made to a non-winning bidder on an ended listing. A seller can make an offer to a non-winning bidder when either the winning bidder has failed to pay for an item or the seller has a duplicate of the item. A seller can create a Second Chance Offer immediately after a listing ends and up to 60 days after the end of the listing. eBay does not charge an Insertion Fee, but if the bidder accepts the offer, the regular Final Value Fee is charged. In the case of an Unpaid Item, the seller should ensure that everything has been done to resolve the issue with the winning bidder before sending a Second Chance Offer to another bidder. See the Unpaid Items Process for details. Make sure you're aware of other rules and restrictions surrounding Second Chance Offers. Use AddSecondChanceItem to submit Second Chance Offers. Listed on eBay, but does not appear when browsing or searching listings.


(Not all values in ListingTypeCodeType apply to this field.)


DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.

See:
    Different Ways of Selling
    Listing Types (Formats)
    GetCategoryFeatures
    Fees per Site

TransactionArray.Transaction
  .Item.LotSize
int Conditionally A lot is a set of two or more similar items included in a single listing that must be purchased together in a single order line item. The Item.LotSize value is the number of items in the lot. This field is required if two or more items are including in one listing.

Lots can be used for auction and fixed price listings. Lot items can be listed only in lot-enabled categories. Call GetCategories to determine if a category supports lots. If the returned CategoryArray.Category.LSD (LotSize Disabled) value is true, the category does not support lots.

Not applicable to Half.com.
Max: 100000.

DetailLevel: ReturnAll.
TransactionArray.Transaction
  .Item.PaymentMethods
BuyerPaymentMethodCodeType Always,
repeatable: [1..*]
Identifies the payment method (such as PayPal) that the seller will accept when the buyer pays for the item. For the AddItem family of calls, at least one payment method is required.

Use GetCategoryFeatures to determine the payment methods that are allowed for a category on a site. For example, the response data of GetCategoryFeatures will show that on the US site, most categories only allow electronic payments. Also use GetCategoryFeatures to determine the default payment method for a site (see SiteDefaults.PaymentMethod). If a seller does not include at least one payment method in a Add/Revise/RelistItem API call, the default payment method is used for the listing.

Do not use GeteBayDetails to determine the payment methods for a site.

For a DE or AT seller's items that are subject to the new eBay payment process, only one PaymentMethod field will be returned, and the value will always be 'StandardPayment'.

If you specify multiple PaymentMethods fields, the repeating fields must be contiguous. For example, you can specify PayPalEmailAddress after a list of repeating PaymentMethods fields, but not between them:

<PaymentMethods>VisaMC</PaymentMethods>
<PaymentMethods>PayPal</PaymentMethods>
<PayPalEmailAddress>mypaypalemail@ebay.com</PayPalEmailAddress>

In general, if you separate repeating instances of a field, the results will be unpredictable. This rule applies to all repeating fields (maxOccurs="unbounded" or greater than 1) in the schema. See "Overview of the Schema" in the Trading API Guide.

This field is not applicable to eBay Real Estate Ad format, Classified Ad format, or Half.com listings.

For ReviseItem and RelistItem only: A listing must have at least one valid payment method. When you revise or relist an item and you specify a payment method that is invalid for the target site, eBay ignores the invalid payment method, applies the other valid changes, and returns a warning to indicate that the invalid payment method was ignored. If multiple payment methods were invalid, the warning indicates that they were all ignored. If you modify the listing so that it includes no valid payment methods, an error is returned. This situation could occur when the seller removes all valid payment methods or when all the payment methods specified for the item are no longer valid on the target site.

Applicable values: See PaymentMethods.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.

See:
    Determining the Payment Methods Allowed for a Category
    Listing an Item
    (SetUserPreferences) SellerPaymentPreferences
    Overview of the API Schema
    GeteBayDetails

TransactionArray.Transaction
  .Item.PrivateListing
boolean Always The PrivateListing boolean field can be used by the seller in the Add/Relist/Revise family of calls to obscure item title, item ID, and item price from post-order Feedback comments left by buyers. Typically, it is not advisable that sellers use the Private Listing feature, but using this feature may be appropriate for sellers listing in Adults Only categories, or for high-priced and/or celebrity items.

For GetItem, order retrieval calls, and other calls that retrieve the Item object, the PrivateListing field is only returned if 'true'.

Not applicable to Half.com.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .Item.Quantity
int Always The value indicates the quantity of items available for purchase in the listing. This field is required for all auction listings and for non-variation, fixed-price listings. For auction listings, this value is always '1'. For a non-variation, fixed-price listing, the Item.Quantity value indicates the number of identical items the seller has available for purchase in the listing.

For AddFixedPriceItem, VerifyAddFixedPriceItem, RelistFixedPriceItem, and ReviseFixedPriceItem: in a multi-variation, fixed-price listing, the Item.Quantity should not be used; instead, the quantity of each variation is specified in the Variation.Variation.Quantity field instead. See the Creating a listing with variations eBay Help page for more information on variations.

For RelistItem, RelistFixedPriceItem, and VerifyRelistItem: Previously in RelistItem, RelistFixedPriceItem, and VerifyRelistItem the Quantity field retained its value from the previous listing unless you specifically changed it by including the field in a relist call and giving it a new value. And this value was often not accurate with the quantity that was really still available for purchase and it was often out of synch with the QuantityAvailable value that is returned with the GetMyeBaySelling call. As of March 13, 2014, this behavior has been changed in the following manner:
  • For a listing that has ended with an available quantity greater than zero, the Quantity value of the newly relisted item is set to the actual QuantityAvailable value (see the GetMyeBaySelling call) when the previous listing ended.
  • For listings that ended with an available quantity of zero, the relisted item will retain the Quantity value that was passed in at creation time of the previous listing.
So, if you are relisting an item that had an available quantity of zero when the listing ended, we strongly recommend that you pass in the correct available quantity through the Quantity field of a relist call. Alternatively, you can update the correct quantity available by using a ReviseInventoryStatus call and passing in a Quantity value.

You can set the Quantity to 0 (zero) and keep the listing active if OutOfStockControl is set to 'true'.

When eBay auto-renews a GTC listing (ListingDuration=GTC) on your behalf, eBay relists with correct quantity available.

Note: There are seller limits on the US site for users who registered after October 2010. Seller limits control the quantity of items and/or the total value of the item(s) in the listing. (The GetMyeBaySelling call returns the remaining item quantity and remaining total value under the limits for the seller, if any such limits exist for the seller). If a call to add an item or revise an item would result in the exceeding of these limits, the add item or revise item call will fail. For auction listings, the total value limit applies to the start price, not the final sale amount. For more information, see the link to Seller Limits below.
For GetSellerEvents: Quantity is only returned for listings where item quantity is greater than 1.

For GetItem and related calls: This is the total of the number of items available for sale plus the quantity already sold. To determine the number of items available, subtract SellingStatus.QuantitySold from this value. Even for items that supported Dutch auctions, where one of several items can be purchased during the auction, this number does not change.

For order line item calls with variations: In GetItemTransactions, Item.Quantity is the same as GetItem (the total quantity across all variations). In GetSellerTransactions, Transaction.Item.Quantity is the total quantity of the applicable variation (quantity available plus quantity sold).

For GetDispute: Quantity is the number of items being raised in the dispute.

For SetCart input, this is only required if the parent container is submitted.

Also applicable to Half.com (valid range 1 to 1000). You can revise this field for Half.com listings.

Note: The number in the Quantity field represents the current quantity of items that are available using the "Ship to home" fulfillment method. This number does not take into account any quantity of the item that is available through "local" fulfillment methods such as In-Store Pickup, eBay Now, or Click and Collect. This is due to the fact that there is no current implementation (or API field) where the seller informs eBay about the quantity of items available through each local fulfillment method. In the case where a listing is only offering the item through a local fulfillment method, this value should default to '0', and the Item.IgnoreQuantity will also be returned as 'True'.


DetailLevel: ReturnAll.

See:
    Seller Limits
    Selecting a Selling Format

TransactionArray.Transaction
  .Item.SellingStatus
SellingStatusType Always Various details about the current status of the listing, such as the current number of bids and the current high bidder.

Not applicable to Half.com.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .Item.SellingStatus.BidCount
int Conditionally Number of bids placed so far against the auction item.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .Item.SellingStatus
  .ConvertedCurrentPrice
AmountType (double) Conditionally Converted value of the CurrentPrice in the currency of the site that returned this response. For active items, refresh the listing's data every 24 hours to pick up the current conversion rates. Only returned when the item's CurrentPrice on the listing site is in different currency than the currency of the host site for the user/application making the API call. ConvertedCurrentPrice is not returned for Classified listings (Classified listings are not available on all sites).

In multi-variation listings, this value matches the lowest-priced variation that is still available for sale.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .Item.SellingStatus
  .ConvertedCurrentPrice
  [ attribute currencyID ]
CurrencyCodeType Always Converted value of the CurrentPrice in the currency of the site that returned this response. For active items, refresh the listing's data every 24 hours to pick up the current conversion rates. Only returned when the item's CurrentPrice on the listing site is in different currency than the currency of the host site for the user/application making the API call. ConvertedCurrentPrice is not returned for Classified listings (Classified listings are not available on all sites).

In multi-variation listings, this value matches the lowest-priced variation that is still available for sale.

For a list of possible enumeration values, see CurrencyCodeType.
TransactionArray.Transaction
  .Item.SellingStatus
  .CurrentPrice
AmountType (double) Always The current price of the item in the original listing currency.

For auction listings, this price is the starting minimum price (if the listing has no bids) or the current highest bid (if bids have been placed) for the item. This does not reflect the BuyItNow price.

For fixed-price and ad format listings, this is the current listing price.

In multi-variation, fixed-price listings, this value matches the lowest-priced variation that is still available for sale.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .Item.SellingStatus
  .CurrentPrice
  [ attribute currencyID ]
CurrencyCodeType Always The current price of the item in the original listing currency.

For auction listings, this price is the starting minimum price (if the listing has no bids) or the current highest bid (if bids have been placed) for the item. This does not reflect the BuyItNow price.

For fixed-price and ad format listings, this is the current listing price.

In multi-variation, fixed-price listings, this value matches the lowest-priced variation that is still available for sale.

For a list of possible enumeration values, see CurrencyCodeType.
TransactionArray.Transaction
  .Item.SellingStatus
  .FinalValueFee
AmountType (double) Conditionally A seller is changed a Final Value Fee (FVF) when the item is sold, ends with a winning bid, or is purchased. This fee applies whether or not the sale is completed with the buyer and is generated before the buyer makes a payment.

The FVF is calculated using a percentage. This percentage is based on whether the seller has a Store subscription or not. If a seller does have a Store subscription, the FVF is calculated based on the level of that plan. For complete information about selling fees and eBay Store subscription plans, see the Fee Center Home Page.

The Final Value Fee for each order line item is returned by GetSellerTransactions, GetItemTransactions, GetOrders, and GetOrderTransactions, regardless of the checkout status.

If a seller requests a Final Value Fee credit, the value of Transaction.FinalValueFee will not change if a credit is issued. The credit only appears in the seller's account data.

Not applicable to Half.com.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .Item.SellingStatus
  .FinalValueFee
  [ attribute currencyID ]
CurrencyCodeType Always A seller is changed a Final Value Fee (FVF) when the item is sold, ends with a winning bid, or is purchased. This fee applies whether or not the sale is completed with the buyer and is generated before the buyer makes a payment.

The FVF is calculated using a percentage. This percentage is based on whether the seller has a Store subscription or not. If a seller does have a Store subscription, the FVF is calculated based on the level of that plan. For complete information about selling fees and eBay Store subscription plans, see the Fee Center Home Page.

The Final Value Fee for each order line item is returned by GetSellerTransactions, GetItemTransactions, GetOrders, and GetOrderTransactions, regardless of the checkout status.

If a seller requests a Final Value Fee credit, the value of Transaction.FinalValueFee will not change if a credit is issued. The credit only appears in the seller's account data.

Not applicable to Half.com.

For a list of possible enumeration values, see CurrencyCodeType.
TransactionArray.Transaction
  .Item.SellingStatus
  .ListingStatus
ListingStatusCodeType Always Specifies an active or ended listing's status in eBay's processing workflow. If a listing ends with a sale (or sales), eBay needs to update the sale details (e.g., total price and buyer/high bidder) and the final value fee. This processing can take several minutes. If you retrieve a sold item and no details about the buyer/high bidder are returned or no final value fee is available, use this listing status information to determine whether eBay has finished processing the listing.

Applicable values:

•   Active

(out) The listing is still active or the listing has ended with a sale but eBay has not completed processing the sale details (e.g., total price and high bidder). A multi-item listing is considered active until all items have winning bids or purchases or the listing ends with at least one winning bid or purchase. If the listing has ended with a sale but this Active status is returned, please allow several minutes for eBay to finish processing the listing.

•   Completed

(out) The listing has closed and eBay has completed processing the sale. All sale information returned from eBay (e.g., total price and high bidder) should be considered accurate and complete. Although the Final Value Fee (FVF) for FixedPriceItem and StoresFixedPrice items is returned by GetSellerTransactions and GetItemTransactions, all other listing types (excluding Buy It Now purchases) require the listing status to be Completed before the Final Value Fee is returned.

•   Custom

(out) Reserved for internal or future use.

•   CustomCode

(out) Reserved for internal or future use.

•   Ended

(out) The listing has ended. If the listing ended with a sale, eBay has completed processing of the sale. All sale information returned from eBay (e.g., total price and high bidder) should be considered accurate and complete. However, the final value fee is not yet available.




DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .Item.SellingStatus
  .QuantitySold
int Always The total number of items purchased so far (in the listing's lifetime). Subtract this from Quantity to determine the quantity available.

If the listing has Item Variations, then in GetItem (and related calls) and GetItemTransactions, Item.SellingStatus.QuantitySold contains the sum of all quantities sold across all variations in the listing, and Variation.SellingStatus.QuantitySold contains the number of items sold for that variation. In GetSellerTransactions, Transaction.Item.SellingStatus.QuantitySold contains the number of items sold in that order line item.

For order line item calls, also see Transaction.QuantityPurchased for the number of items purchased in the order line item.
In multi-variation listings, this value matches total quantity sold across all variations.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .Item.Site
SiteCodeType Conditionally The name of the site on which the item is listed. The listing site affects the business logic and validation rules that are applied to the request, which in turn affect the values that are returned in the response, as well as values that appear on the eBay Web site. For example, the listing site can affect the validation of Category in listing requests, international business seller requirements, the values of converted (localized) prices in responses, the item-related time stamps that are displayed on the eBay Web site, the visibility of the item in some types of searches, and other information. In some cases, the rules are determined by a combination of the site, the user's registration address, and other information. You cannot change the site when you revise a listing.

When you specify Item.Site in AddItem or AddFixedPriceItem, it must be consistent with the numeric site ID that you specify in the request URL (for the SOAP API) or the X-EBAY- API-SITEID header (for the XML API).

Not applicable to Half.com.

Applicable values: See Site.

See:
    The US and International eBay Sites
    Specifying the Target Site
    Field Differences for eBay Sites

TransactionArray.Transaction
  .Item.SKU
SKUType (string) Conditionally A SKU (stock keeping unit) is an identifier defined by a seller. Some sellers use SKUs to track complex flows of products and information on the client side. A seller can specify a SKU when listing an item with AddItem and related calls. eBay preserves the SKU on the item, enabling you to obtain it before and after an order line item is created. (SKU is recommended as an alternative to ApplicationData.)

A SKU is not required to be unique, when you track listings by their ItemID (the default tracking method). A seller can specify a particular SKU on one item or on multiple items. Different sellers can use the same SKUs.

If you want to use SKU instead of ItemID as a unique identifier (such as when retrieving items and orders), you can set Item.InventoryTrackingMethod to SKU in AddFixedPriceItem and related calls. In this case, the SKU must be unique across your (the seller's) active listings. Note that if you relist the item, you must reset Item.InventoryTrackingMethod to SKU; otherwise the relisted item will default to ItemID as the tracking method.

If both ItemID and SKU are specified in item-retrieval and order-retrieval calls that support the use of SKU as a unique identifier, the ItemID value takes precedence and is used to identify the listing.

For multi-variation listings, the SKU can be used to uniquely identify a variation that is being revised or relisted. If InventoryTrackingMethod is ItemID, an ItemID is also required. When both SKU and VariationSpecifics are passed in the request, the variation specifics take precedence as the unique identifier.

Note: The eBay Web site UI cannot identify listings by SKU. For example, My eBay pages and Search pages all identify listings by item ID. When a buyer contacts you via eBay's messaging functionality, eBay uses the item ID as the identifier. Buyer-focused APIs (like the Shopping API) also do not support SKU as an identifier. For revising and relisting only: To remove a SKU when you revise or relist an item, use DeletedField. (You cannot remove a SKU when Item.InventoryTrackingMethod is set to SKU.)

For GetMyeBaySelling, this is only returned if set.
Not applicable to Half.com.
Max length: 50.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.

See eBay Merchant Data API for AddFixedPriceItem and ReviseFixedPriceItem.

TransactionArray.Transaction
  .Item.StartPrice
AmountType (double) Conditionally This value indicates the starting price of the item when it is listed for the first time, or when it is revised or relisted.

For auction listings: competitive bidding starts at this value. Once at least one bid has been placed, StartPrice remains the same but CurrentPrice is increased to the amount of the current highest bid. If ReservePrice is also specified, the value of StartPrice must be lower than the value of ReservePrice.

For fixed-price listings: This is the fixed-price at which a buyer may purchase the item.

For both auction and fixed-price listings, there is a minimum value that may be specified as a StartPrice value. These minimum values vary per site. To retrieve these minimum values for a site, call GeteBayDetails passing in your SiteID value as a header, and using ListingStartPriceDetails as a DetailName value. In the GeteBayDetails response, look for the ListingStartPriceDetails.StartPrice fields for the 'Chinese' and 'FixedPriceItem' listing types.

Note: There are seller limits on the US site for users who registered after October 2010. Seller limits control the quantity of items and/or the total value of the item(s) in the listing. (The GetMyeBaySelling call returns the remaining item quantity and remaining total value under the limits for the seller, if any such limits exist for the seller). If a call to add an item or revise an item would result in the exceeding of these limits, the add item or revise item call will fail. For auction listings, the total value limit applies to the start price, not the final sale amount. For more information, see the link to Seller Limits below. GetMyeBaySelling does not return Item.StartPrice for fixed-price items; it returns Item.SellingStatus.CurrentPrice.

For AddFixedPriceItem and VerifyAddFixedPriceItem: Required when no variations are specified. If variations are specified, use Variation.StartPrice for each variation instead.

Also applicable to Half.com (valid range 0.75 to 9999.99). You can revise this field for Half.com listings.

DetailLevel: ReturnAll.

See:
    Seller Limits
    GeteBayDetails

TransactionArray.Transaction
  .Item.StartPrice
  [ attribute currencyID ]
CurrencyCodeType Always This value indicates the starting price of the item when it is listed for the first time, or when it is revised or relisted.

For auction listings: competitive bidding starts at this value. Once at least one bid has been placed, StartPrice remains the same but CurrentPrice is increased to the amount of the current highest bid. If ReservePrice is also specified, the value of StartPrice must be lower than the value of ReservePrice.

For fixed-price listings: This is the fixed-price at which a buyer may purchase the item.

For both auction and fixed-price listings, there is a minimum value that may be specified as a StartPrice value. These minimum values vary per site. To retrieve these minimum values for a site, call GeteBayDetails passing in your SiteID value as a header, and using ListingStartPriceDetails as a DetailName value. In the GeteBayDetails response, look for the ListingStartPriceDetails.StartPrice fields for the 'Chinese' and 'FixedPriceItem' listing types.

Note: There are seller limits on the US site for users who registered after October 2010. Seller limits control the quantity of items and/or the total value of the item(s) in the listing. (The GetMyeBaySelling call returns the remaining item quantity and remaining total value under the limits for the seller, if any such limits exist for the seller). If a call to add an item or revise an item would result in the exceeding of these limits, the add item or revise item call will fail. For auction listings, the total value limit applies to the start price, not the final sale amount. For more information, see the link to Seller Limits below. GetMyeBaySelling does not return Item.StartPrice for fixed-price items; it returns Item.SellingStatus.CurrentPrice.

For AddFixedPriceItem and VerifyAddFixedPriceItem: Required when no variations are specified. If variations are specified, use Variation.StartPrice for each variation instead.

Also applicable to Half.com (valid range 0.75 to 9999.99). You can revise this field for Half.com listings.

For a list of possible enumeration values, see CurrencyCodeType.
TransactionArray.Transaction
  .Item.Title
string Conditionally Name of the item as it appears in the listing or search results. Title is required for most items. This field is only optional if you leverage Pre-filled Item Information by using the Item.ProductListingDetails or Item.ExternalProductID containers.

You cannot use HTML or JavaScript in the Title. (HTML characters will be interpreted literally as plain text.)

For the AddItem family of calls: Not applicable to Half.com.

For ReviseItem and ReviseFixedPriceItem You can only add or change the item title if the listing has no bids (for auctions) or sales (for fixed-price listings) and the listing does not end within 12 hours.

Note: For some large merchants, there are no limitations on when the Item Title for a fixed-price listing can be revised, even when the listing has had transactions or is set to end within 12 hours. For GetItemRecommendations: More keywords in the title usually result in more relevant Listing Analyzer recommendations.
Max length: 80.

DetailLevel: ReturnAll.
TransactionArray.Transaction
  .ListingCheckoutRedirectPreference
ListingCheckoutRedirectPreferenceType Conditionally ProStores listing level preferences regarding the store to which checkout should be redirected for the listing if Item.ThirdPartyCheckout is true.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ListingCheckoutRedirectPreference
  .SellerThirdPartyUsername
string Conditionally The user name of the ProStores store. To remove this value when revising or relisting an item, use DeletedField.
Max length: 200.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .LogisticsPlanType
token Conditionally Indicates which type of logistics plan has been selected for the current order line item by the buyer. A logistics plan categorizes the means by which an order line item is transported from the seller to the buyer. It is characterized by the type of location where the buyer will take possession of the package, the type and number of carriers involved, and the timing of sending and delivery. A given logistics plan type helps to determine which shipping types, carriers and services the seller can use.

This field is returned only if it has a value.

Note: Currently, LogisticsPlanType has only one applicable value: PickUpDropOff, which is a service available for orders sent and delivered within the UK. When buyers select PickUpDropOff, the order is sent to a contracted third-party location, where it is held for pickup by the buyer.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.

Applicable values: See LogisticsPlanCodeType
TransactionArray.Transaction
  .MonetaryDetails
PaymentsInformationType Conditionally Contains all payment related information.

DetailLevel: ReturnAll.
TransactionArray.Transaction
  .MonetaryDetails.Payments
PaymentInformationType Conditionally Contains information about how different portions of the funds exchanged for a specified order are allocated among payees. Each allocated portion is represented by a Payment container.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .MonetaryDetails.Payments
  .Payment
PaymentTransactionType Conditionally,
repeatable: [0..*]
Contains information about the funds allocated to one payee from a buyer payment for a specified order.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .MonetaryDetails.Payments
  .Payment.FeeOrCreditAmount
AmountType (double) Conditionally Fee Amount is a positive value and Credit Amount is a negative value.

This field is not returned if the Payee field's type attribute is eBayPartner.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .MonetaryDetails.Payments
  .Payment.FeeOrCreditAmount
  [ attribute currencyID ]
CurrencyCodeType Always Fee Amount is a positive value and Credit Amount is a negative value.

This field is not returned if the Payee field's type attribute is eBayPartner.

For a list of possible enumeration values, see CurrencyCodeType.
TransactionArray.Transaction
  .MonetaryDetails.Payments
  .Payment.Payee
UserIdentityType (string) Conditionally The person or organization who is to receive the payment allocation.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .MonetaryDetails.Payments
  .Payment.Payee
  [ attribute type ]
UserIdentityCodeType Conditionally The person or organization who is to receive the payment allocation.

For a list of possible enumeration values, see UserIdentityCodeType.
TransactionArray.Transaction
  .MonetaryDetails.Payments
  .Payment.Payer
UserIdentityType (string) Conditionally The person or organization who submitted the payment.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .MonetaryDetails.Payments
  .Payment.Payer
  [ attribute type ]
UserIdentityCodeType Conditionally The person or organization who submitted the payment.

For a list of possible enumeration values, see UserIdentityCodeType.
TransactionArray.Transaction
  .MonetaryDetails.Payments
  .Payment.PaymentAmount
AmountType (double) Conditionally The amount of the payment that is allocated to the payee.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .MonetaryDetails.Payments
  .Payment.PaymentAmount
  [ attribute currencyID ]
CurrencyCodeType Always The amount of the payment that is allocated to the payee.

For a list of possible enumeration values, see CurrencyCodeType.
TransactionArray.Transaction
  .MonetaryDetails.Payments
  .Payment.PaymentReferenceID
TransactionReferenceType (string) Conditionally,
repeatable: [0..*]
The payment transaction ID.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .MonetaryDetails.Payments
  .Payment.PaymentReferenceID
  [ attribute type ]
TransactionReferenceCodeType Conditionally The payment transaction ID.

For a list of possible enumeration values, see TransactionReferenceCodeType.
TransactionArray.Transaction
  .MonetaryDetails.Payments
  .Payment.PaymentStatus
PaymentTransactionStatusCodeType Conditionally The current status of a buyer payment that is allocated to a specified payee.

Applicable values:

•   CustomCode

(out) Reserved for internal or future use.

•   Failed

(out) This value indicates that the payment transaction failed.

•   Pending

(out) This value indicates that the payment transaction is pending.

•   Succeeded

(out) This value indicates that the payment transaction succeeded.




DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .MonetaryDetails.Payments
  .Payment.PaymentTime
dateTime Conditionally The date and time when the payment is received by the payee.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .MonetaryDetails.Payments
  .Payment.ReferenceID
TransactionReferenceType (string) Conditionally A unique transaction ID for the payment.

This field is not returned if the Payee field's type attribute is eBayPartner.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .MonetaryDetails.Payments
  .Payment.ReferenceID
  [ attribute type ]
TransactionReferenceCodeType Conditionally A unique transaction ID for the payment.

This field is not returned if the Payee field's type attribute is eBayPartner.

For a list of possible enumeration values, see TransactionReferenceCodeType.
TransactionArray.Transaction
  .MonetaryDetails.Refunds
RefundInformationType Conditionally This container consists of an array of one or more Refund containers, and each Refund container consists of detailed information about a merchant's refund (or store credit) to a buyer who has returned an In-Store Pickup item.

This container is only returned if the buyer has returned an In-Store Pickup item to the merchant at a physical store, and the merchant has notified eBay through the ORDER.RETURNED notification of the Inbound Notifications API.

Note: At this time, the In-Store Pickup feature is generally only available to large retail merchants, and can only be applied to multi-quantity, fixed-price listings.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .MonetaryDetails.Refunds
  .Refund
RefundTransactionInfoType Conditionally,
repeatable: [0..*]
This container consists of detailed information on an In-Store Pickup item refund. This container is only returned if the merchant is refunding (or providing a store credit) the buyer for an In-Store Pickup item. A separate Refund container will be returned for each ORDER.RETURNED notification that the merchant sends to eBay through the Inbound Notifications API.

Note: A seller must be eligible for the In-Store Pickup feature to list an item that is eligible for In-Store Pickup. At this time, the In-Store Pickup feature is generally only available to large retail merchants, and can only be applied to multi-quantity, fixed-price listings. Merchants/developers can test In-Store Pickup functionality in the Sandbox environment, including listing items enabled with the In-Store Pickup feature, creating store locations and adding inventory to these stores using the Inventory Management API, and informing eBay of In-Store Pickup status changes using the Inbound Notifications API.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .MonetaryDetails.Refunds
  .Refund.FeeOrCreditAmount
AmountType (double) Conditionally This dollar value is the total amount of the refund to the buyer for the In-Store Pickup order. Typically, this dollar value will be the same as the RefundAmount value, unless the merchant is issuing multiple refund transactions to the buyer, in which case, the FeeOrCreditAmount value will be the cumulative amount for multiple refund transactions. This field is not returned if the merchant issued the buyer a store credit instead of a refund (RefundType=STORE_CREDIT).

Note: A seller must be eligible for the In-Store Pickup feature to list an item that is eligible for In-Store Pickup. At this time, the In-Store Pickup feature is generally only available to large retail merchants, and can only be applied to multi-quantity, fixed-price listings. Merchants/developers can test In-Store Pickup functionality in the Sandbox environment, including listing items enabled with the In-Store Pickup feature, creating store locations and adding inventory to these stores using the Inventory Management API, and informing eBay of In-Store Pickup status changes using the Inbound Notifications API.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .MonetaryDetails.Refunds
  .Refund.FeeOrCreditAmount
  [ attribute currencyID ]
CurrencyCodeType Always This dollar value is the total amount of the refund to the buyer for the In-Store Pickup order. Typically, this dollar value will be the same as the RefundAmount value, unless the merchant is issuing multiple refund transactions to the buyer, in which case, the FeeOrCreditAmount value will be the cumulative amount for multiple refund transactions. This field is not returned if the merchant issued the buyer a store credit instead of a refund (RefundType=STORE_CREDIT).

Note: A seller must be eligible for the In-Store Pickup feature to list an item that is eligible for In-Store Pickup. At this time, the In-Store Pickup feature is generally only available to large retail merchants, and can only be applied to multi-quantity, fixed-price listings. Merchants/developers can test In-Store Pickup functionality in the Sandbox environment, including listing items enabled with the In-Store Pickup feature, creating store locations and adding inventory to these stores using the Inventory Management API, and informing eBay of In-Store Pickup status changes using the Inbound Notifications API.

For a list of possible enumeration values, see CurrencyCodeType.
TransactionArray.Transaction
  .MonetaryDetails.Refunds
  .Refund.ReferenceID
TransactionReferenceType (string) Conditionally This value is a merchant-defined identifier used to track In-Store Pickup refunds. This value is picked up by eBay when the merchant passes in the REFUND_ID parameter through the payload of an ORDER.RETURNED notification sent to eBay. This field is not returned if the merchant does not set this value through ORDER.RETURNED notification.

Note: A seller must be eligible for the In-Store Pickup feature to list an item that is eligible for In-Store Pickup. At this time, the In-Store Pickup feature is generally only available to large retail merchants, and can only be applied to multi-quantity, fixed-price listings. Merchants/developers can test In-Store Pickup functionality in the Sandbox environment, including listing items enabled with the In-Store Pickup feature, creating store locations and adding inventory to these stores using the Inventory Management API, and informing eBay of In-Store Pickup status changes using the Inbound Notifications API.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .MonetaryDetails.Refunds
  .Refund.ReferenceID
  [ attribute type ]
TransactionReferenceCodeType Conditionally This value is a merchant-defined identifier used to track In-Store Pickup refunds. This value is picked up by eBay when the merchant passes in the REFUND_ID parameter through the payload of an ORDER.RETURNED notification sent to eBay. This field is not returned if the merchant does not set this value through ORDER.RETURNED notification.

Note: A seller must be eligible for the In-Store Pickup feature to list an item that is eligible for In-Store Pickup. At this time, the In-Store Pickup feature is generally only available to large retail merchants, and can only be applied to multi-quantity, fixed-price listings. Merchants/developers can test In-Store Pickup functionality in the Sandbox environment, including listing items enabled with the In-Store Pickup feature, creating store locations and adding inventory to these stores using the Inventory Management API, and informing eBay of In-Store Pickup status changes using the Inbound Notifications API.

For a list of possible enumeration values, see TransactionReferenceCodeType.
TransactionArray.Transaction
  .MonetaryDetails.Refunds
  .Refund.RefundAmount
AmountType (double) Conditionally This dollar value is the amount of the refund to the buyer for this specific refund transaction. This field is not returned if the merchant issued the buyer a store credit instead of a refund (RefundType=STORE_CREDIT).

Note: A seller must be eligible for the In-Store Pickup feature to list an item that is eligible for In-Store Pickup. At this time, the In-Store Pickup feature is generally only available to large retail merchants, and can only be applied to multi-quantity, fixed-price listings. Merchants/developers can test In-Store Pickup functionality in the Sandbox environment, including listing items enabled with the In-Store Pickup feature, creating store locations and adding inventory to these stores using the Inventory Management API, and informing eBay of In-Store Pickup status changes using the Inbound Notifications API.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .MonetaryDetails.Refunds
  .Refund.RefundAmount
  [ attribute currencyID ]
CurrencyCodeType Always This dollar value is the amount of the refund to the buyer for this specific refund transaction. This field is not returned if the merchant issued the buyer a store credit instead of a refund (RefundType=STORE_CREDIT).

Note: A seller must be eligible for the In-Store Pickup feature to list an item that is eligible for In-Store Pickup. At this time, the In-Store Pickup feature is generally only available to large retail merchants, and can only be applied to multi-quantity, fixed-price listings. Merchants/developers can test In-Store Pickup functionality in the Sandbox environment, including listing items enabled with the In-Store Pickup feature, creating store locations and adding inventory to these stores using the Inventory Management API, and informing eBay of In-Store Pickup status changes using the Inbound Notifications API.

For a list of possible enumeration values, see CurrencyCodeType.
TransactionArray.Transaction
  .MonetaryDetails.Refunds
  .Refund.RefundStatus
PaymentTransactionStatusCodeType Conditionally This value indicates the success or failure of the attempt by the merchant to refund or provide store credit to the buyer for a returned In-Store Pickup item. This field is always returned with the Refund container.

Note: A seller must be eligible for the In-Store Pickup feature to list an item that is eligible for In-Store Pickup. At this time, the In-Store Pickup feature is generally only available to large retail merchants, and can only be applied to multi-quantity, fixed-price listings. Merchants/developers can test In-Store Pickup functionality in the Sandbox environment, including listing items enabled with the In-Store Pickup feature, creating store locations and adding inventory to these stores using the Inventory Management API, and informing eBay of In-Store Pickup status changes using the Inbound Notifications API.

Applicable values:

•   CustomCode

(out) Reserved for internal or future use.

•   Failed

(out) This value indicates that the payment transaction failed.

•   Pending

(out) This value indicates that the payment transaction is pending.

•   Succeeded

(out) This value indicates that the payment transaction succeeded.




DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .MonetaryDetails.Refunds
  .Refund.RefundTime
dateTime Conditionally This date/time value is the timestamp for the refund transaction. This field is not returned if the refund was not successful (RefundStatus=FAILED).

Note: A seller must be eligible for the In-Store Pickup feature to list an item that is eligible for In-Store Pickup. At this time, the In-Store Pickup feature is generally only available to large retail merchants, and can only be applied to multi-quantity, fixed-price listings. Merchants/developers can test In-Store Pickup functionality in the Sandbox environment, including listing items enabled with the In-Store Pickup feature, creating store locations and adding inventory to these stores using the Inventory Management API, and informing eBay of In-Store Pickup status changes using the Inbound Notifications API.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .MonetaryDetails.Refunds
  .Refund.RefundTo
UserIdentityType (string) Conditionally This field is the eBay user ID of the buyer who is receiving the refund or store credit from the merchant. This field is always returned with the Refund container.

Note: A seller must be eligible for the In-Store Pickup feature to list an item that is eligible for In-Store Pickup. At this time, the In-Store Pickup feature is generally only available to large retail merchants, and can only be applied to multi-quantity, fixed-price listings. Merchants/developers can test In-Store Pickup functionality in the Sandbox environment, including listing items enabled with the In-Store Pickup feature, creating store locations and adding inventory to these stores using the Inventory Management API, and informing eBay of In-Store Pickup status changes using the Inbound Notifications API.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .MonetaryDetails.Refunds
  .Refund.RefundTo
  [ attribute type ]
UserIdentityCodeType Conditionally This field is the eBay user ID of the buyer who is receiving the refund or store credit from the merchant. This field is always returned with the Refund container.

Note: A seller must be eligible for the In-Store Pickup feature to list an item that is eligible for In-Store Pickup. At this time, the In-Store Pickup feature is generally only available to large retail merchants, and can only be applied to multi-quantity, fixed-price listings. Merchants/developers can test In-Store Pickup functionality in the Sandbox environment, including listing items enabled with the In-Store Pickup feature, creating store locations and adding inventory to these stores using the Inventory Management API, and informing eBay of In-Store Pickup status changes using the Inbound Notifications API.

For a list of possible enumeration values, see UserIdentityCodeType.
TransactionArray.Transaction
  .MonetaryDetails.Refunds
  .Refund.RefundType
RefundSourceTypeCodeType Conditionally This value indicates whether the merchant refunded or provided a store credit to the buyer for the returned In-Store Pickup item. Applicable values are 'REFUND' and 'STORE_CREDIT'. This value is picked up by eBay when the merchant passes in the REFUND_TYPE parameter through the payload of an ORDER.RETURNED notification sent to eBay.

Note: A seller must be eligible for the In-Store Pickup feature to list an item that is eligible for In-Store Pickup. At this time, the In-Store Pickup feature is generally only available to large retail merchants, and can only be applied to multi-quantity, fixed-price listings. Merchants/developers can test In-Store Pickup functionality in the Sandbox environment, including listing items enabled with the In-Store Pickup feature, creating store locations and adding inventory to these stores using the Inventory Management API, and informing eBay of In-Store Pickup status changes using the Inbound Notifications API.

Applicable values:

•   CustomCode

(out) This value is reserved for internal or future use.

•   PaymentRefund

(out) This value indicates that the merchant issued a cash refund (or debit card/credit card reversal) to the buyer for the amount of the returned item(s).

•   StoreCredit

(out) This value indicates that the merchant issued a store credit to the buyer for the amount of the returned item(s).




DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .MultiLegShippingDetails
MultiLegShippingDetailsType Conditionally Contains information about multi leg shipment.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .MultiLegShippingDetails
  .SellerShipmentToLogisticsProvider
MultiLegShipmentType Conditionally Contains information about the domestic leg of a Global Shipping Programn shipment, including the seller-selected shipping service, the domestic shipping cost, the domestic address of the international shipping provider, and the estimated shipping time range.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .MultiLegShippingDetails
  .SellerShipmentToLogisticsProvider
  .ShippingServiceDetails
MultiLegShippingServiceType Conditionally Contains information about the shipping service and cost of the domestic leg of a Global Shipping Program shipment.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .MultiLegShippingDetails
  .SellerShipmentToLogisticsProvider
  .ShippingServiceDetails
  .ShippingService
token Conditionally The shipping service specified for the domestic leg of a Global Shipping Program shipment. For the domestic leg, the value of this field can be any available shipping service that ships to the domestic address of the international shipping provider.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .MultiLegShippingDetails
  .SellerShipmentToLogisticsProvider
  .ShippingServiceDetails
  .TotalShippingCost
AmountType (double) Conditionally The total shipping cost of the domestic leg of a Global Shipping Program shipment.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .MultiLegShippingDetails
  .SellerShipmentToLogisticsProvider
  .ShippingServiceDetails
  .TotalShippingCost
  [ attribute currencyID ]
CurrencyCodeType Always The total shipping cost of the domestic leg of a Global Shipping Program shipment.

For a list of possible enumeration values, see CurrencyCodeType.
TransactionArray.Transaction
  .MultiLegShippingDetails
  .SellerShipmentToLogisticsProvider
  .ShippingTimeMax
int Conditionally The maximum guaranteed number of days that the shipping carrier will take to ship an item for the domestic leg of a Global Shipping Program shipment (not including the handling time it takes the seller to deliver the item to the domestic shipping carrier).

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .MultiLegShippingDetails
  .SellerShipmentToLogisticsProvider
  .ShippingTimeMin
int Conditionally The minimum number of days that the shipping carrier will take to ship an item for the domestic leg of a Global Shipping Program shipment (not including the handling time it takes the seller to deliver the item to the domestic shipping carrier).

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .MultiLegShippingDetails
  .SellerShipmentToLogisticsProvider
  .ShipToAddress
AddressType Conditionally Contains shipping address information for the domestic leg of a Global Shipping Program shipment. This container includes the ReferenceID field, which can be printed on the package to give the international shipping provider a unique identifier for the order.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .MultiLegShippingDetails
  .SellerShipmentToLogisticsProvider
  .ShipToAddress
  .AddressAttribute
AddressAttributeType (string) Conditionally,
repeatable: [0..*]
This field shows an attribute for the address, and its corresponding value. Currently, this field is only used to display the reference ID for a "Click and Collect" order, but in the future, other address attributes may be returned in this field.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .MultiLegShippingDetails
  .SellerShipmentToLogisticsProvider
  .ShipToAddress
  .AddressAttribute
  [ attribute type ]
AddressAttributeCodeType Conditionally This field shows an attribute for the address, and its corresponding value. Currently, this field is only used to display the reference ID for a "Click and Collect" order, but in the future, other address attributes may be returned in this field.

For a list of possible enumeration values, see AddressAttributeCodeType.
TransactionArray.Transaction
  .MultiLegShippingDetails
  .SellerShipmentToLogisticsProvider
  .ShipToAddress.AddressID
string Conditionally Unique ID for a user's address in the eBay database. This value can help prevent the need to store an address multiple times across multiple orders. The ID changes if a user changes their address.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .MultiLegShippingDetails
  .SellerShipmentToLogisticsProvider
  .ShipToAddress.AddressOwner
AddressOwnerCodeType Conditionally The realm to which the address belongs (e.g. eBay vs PayPal). For GetOrders, applies only to Half.com.

Applicable values:

•   CustomCode

(out) Reserved for internal or future use.

•   eBay

(out) This value indicates that the shipping address being referenced is on file with eBay.

•   PayPal

(out) This value indicates that the shipping address being referenced is on file with PayPal.




DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .MultiLegShippingDetails
  .SellerShipmentToLogisticsProvider
  .ShipToAddress.AddressUsage
AddressUsageCodeType Conditionally This tag tells whether current address is a default shipping address or one of the shipping addresses in address book.

Applicable values:

•   CustomCode

(out) Reserved for internal or future use.

•   DefaultShipping

(out) This is default shipping address which is rendered to buyer on checkout.

•   Invalid

(out) This is not a valid address. Please use another address.

•   Shipping

(out) This is an address which is in user's address book. It can be used at the time of checkout.




DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .MultiLegShippingDetails
  .SellerShipmentToLogisticsProvider
  .ShipToAddress.CityName
string Conditionally The name of the user's city. Also applicable to Half.com (for GetOrders).
Max length: This varies based on the user's country. Currently, the maximum length is 64 for the US. Note: The eBay database allocates up to 128 characters for this field. .

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .MultiLegShippingDetails
  .SellerShipmentToLogisticsProvider
  .ShipToAddress.Country
CountryCodeType Conditionally The two-digit code representing the country of the user.

If not provided as input, eBay uses the country associated with the eBay Site ID when the call is made.

For a Global Shipping Program order, GetSellerList returns the country code of the buyer, not the international shipping provider.

Also applicable to Half.com (for GetOrders).

Applicable values: See Country.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .MultiLegShippingDetails
  .SellerShipmentToLogisticsProvider
  .ShipToAddress.CountryName
string Conditionally The name of the user's country. Also applicable to Half.com (for GetOrders).
Max length: eBay validates the content, but not the length for this field. Note: The eBay database allocates up to 128 characters for this field. .

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .MultiLegShippingDetails
  .SellerShipmentToLogisticsProvider
  .ShipToAddress
  .ExternalAddressID
string Conditionally ID assigned to the address by the address owner, e.g. by the PayPal system. Currently, the ExternalAddressID only applies for a customer address in the PayPal system. The ID changes if a user changes their address. Also see the AddressOwner field. The ExternalAddressID value also is applicable to Half.com (for GetOrders).
Max length: 20.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .MultiLegShippingDetails
  .SellerShipmentToLogisticsProvider
  .ShipToAddress.Name
string Conditionally User's name for the address. Also applicable to Half.com (for GetOrders).
Max length: This varies based on the user's country. Currently, the maximum length is 64 for the US. Note: The eBay database allocates up to 128 characters for this field. .

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .MultiLegShippingDetails
  .SellerShipmentToLogisticsProvider
  .ShipToAddress.Phone
string Conditionally User's primary phone number. This may return a value of "Invalid Request" if you are not authorized to see the user's phone number.

In the US, the area code (3 digits), the prefix (3 digits), the line number (4 digits), and phone extension (if specified by the user) are returned in this field. The extension can be one or more digits. Non-breaking spaces are used as delimiters between these phone number components.

Also applicable to Half.com (for GetOrders).
Max length: eBay validates the content (should only be integer values and delimiters), but not the length for this field. Note: The eBay database allocates up to 128 characters for this field. .

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .MultiLegShippingDetails
  .SellerShipmentToLogisticsProvider
  .ShipToAddress.PostalCode
string Conditionally User's postal code.

For a Global Shipping Program order, GetSellerList and GetMyeBaySelling return the postal code of the buyer, not that of the international shipping provider.

Also applicable to Half.com (for GetOrders).
Max length: This varies based on the user's country. Currently, the maximum length is 9 (not counting delimiter characters) for the US. Note: The eBay database allocates up to 24 characters for this field. .

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .MultiLegShippingDetails
  .SellerShipmentToLogisticsProvider
  .ShipToAddress.ReferenceID
string Conditionally Uniquely identifies an order shipped using the Global Shipping Program. This value is generated by eBay when the order is completed. The international shipping provider uses the ReferenceID as the primary reference when processing the shipment. Sellers must include this value on the package immediately above the street address of the international shipping provider.

Example: "Reference #1234567890123456"

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .MultiLegShippingDetails
  .SellerShipmentToLogisticsProvider
  .ShipToAddress.StateOrProvince
string Conditionally The region of the user's address. Also applicable to Half.com (for GetOrders).
Max length: This varies based on the user's country. Currently, the maximum length is 64 for the US. Note: The eBay database allocates up to 128 characters for this field. .

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .MultiLegShippingDetails
  .SellerShipmentToLogisticsProvider
  .ShipToAddress.Street1
string Conditionally Line 1 of the user's street address. Also applicable to Half.com (for GetOrders).
Max length: This varies based on the user's country. Currently, the maximum length is 180 for the US. Note: The eBay database allocates up to 512 characters for this field. .

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .MultiLegShippingDetails
  .SellerShipmentToLogisticsProvider
  .ShipToAddress.Street2
string Conditionally Line 2 of the user's address (such as an apartment number). Returned if the user specified a second street value for their address. Also applicable to Half.com (for GetOrders).
In case of Item.SellerContactDetails, Street2 can be used to provide City, Address, State, and Zip code (if applicable).
Max length: This varies based on the user's country. Currently, the maximum length is 180 for the US. Note: The eBay database allocates up to 512 characters for this field. .

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .OrderLineItemID
string Always A unique identifier for an eBay order line item. This field is created as soon as there is a commitment to buy from the seller, and its value is based upon the concatenation of ItemID and TransactionID, with a hyphen in between these two IDs.
Max length: 50 (Note: ItemIDs and TransactionIDs usually consist of 9 to 12 digits.).

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .PaidTime
dateTime Conditionally Indicates the time when the order was marked paid. This value will only be visible to the user on either side of the order. An order can be marked as paid in the following ways:
  • Automatically when a payment is made via PayPal
  • Seller marks the item as paid in My eBay or through Selling Manager Pro
  • Programmatically by the seller through the ReviseCheckoutStatus or CompleteSale calls.


Not applicable to Half.com.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .PaymentHoldDetails
PaymentHoldDetailType Conditionally Shipping hold details

DetailLevel: ReturnAll.
TransactionArray.Transaction
  .PaymentHoldDetails
  .ExpectedReleaseDate
dateTime Conditionally Timestamp that indicates the expected date in which eBay/PayPal will distribute the funds to the seller's account. This is not a firm date and is subject to change.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .PaymentHoldDetails
  .NumOfReqSellerActions
int Conditionally Integer value that indicates the number of possible actions that a seller can take to possibly expedite the release of funds into their account. This value should equal the number of RequiredSellerAction fields contained in the RequiredSellerActionArray container.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .PaymentHoldDetails
  .PaymentHoldReason
PaymentHoldReasonCodeType Conditionally Enumerated value that indicates why the buyer's payment for the order is being held by PayPal instead of being distributed to the seller's account. A seller's funds for an order can be held by PayPal for as little as three days after the buyer receives the order, but the hold can be up to 21 days based on the scenario, and in some cases, the seller's lack of action in helping to expedite the release of funds.

Applicable values:

•   BelowStandardSeller

(out) This value indicates that the buyer's payment for the order is being held by PayPal because the seller has been classified as a Below Standard seller.

•   CasualSeller

(out) This value indicates that the buyer's payment for the order is being held by PayPal because the seller is classified as a casual seller on eBay.

•   CustomCode

(out) This value is reserved for internal or future use.

•   EbpCaseOpen

(out) This value indicates that the buyer's payment for the order is being held by PayPal because an eBay Buyer Protection case has been filed against the order. If this value is returned, the seller can expedite the release of PayPal funds into their account by resolving the eBay Buyer Protection case, as indicated by a value of 'ResolveeBPCase' returned in a PaymentHoldDetails.RequiredSellerActionArray.RequiredSellerAction field.

•   NewPaypalAccountAdded

(out) This value indicates that the buyer's payment for the order is being held by PayPal because the seller's PayPal account (identified in Transaction.PayPalEmailAddress) is new and is not fully set up to receive funds.

•   NewSeller

(out) This value indicates that the buyer's payment for the order is being held by PayPal because the seller is new to selling on eBay. Sellers are considered "new" until they have met all three criteria below:

  • More than 90 days have passed since first successful sale
  • More than 25 domestic sales
  • More than $250.00 in total sales

•   NotAvailable

(out) This value indicates that the reason for the buyer's payment for the order being held by PayPal is not known.

•   Other

(out) This value is returned if the reason for the buyer's payment for the order being held by PayPal cannot be classified by any of the other enumeration values.

•   ReinstatementAfterSuspension

(out) This value indicates that the buyer's payment for the order is being held by PayPal because the seller has recently been reinstated as an active eBay seller after their account went through a suspension/restricted period.

After a seller's account is suspended and then reinstated, that seller is treated as a new seller, and must meet the same requirements that a new seller must meet to get beyong the "New Seller" status.




DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .PaymentHoldDetails
  .RequiredSellerActionArray
RequiredSellerActionArrayType Conditionally Container consisting of one or more RequiredSellerAction fields. RequiredSellerAction fields provide possible actions that a seller can take to expedite the release of funds into their account.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .PaymentHoldDetails
  .RequiredSellerActionArray
  .RequiredSellerAction
RequiredSellerActionCodeType Conditionally,
repeatable: [0..*]
This field contains a possible action that a seller can take to expedite the release of a payment hold. There can be one or more RequiredSellerAction fields in the RequiredSellerActionArray container.

Applicable values:

•   ContacteBayCS

(out) This value indicates that the seller should contact eBay Customer Support to discover the next required action to expedite the release of funds into their account.

•   CustomCode

(out) This value is reserved for internal or future use.

•   MarkAsShipped

(out) This value indicates that the seller must mark the order line item as shipped to expedite the release of funds into their account. The seller can use the CompleteSale call to mark an item as shipped. If an order line item is marked as shipped, it is possible that the seller's funds for the order will be released as soon as seven days after the latest estimated delivery date.

•   None

(out) This value is not currently applicable since the new eBay Payment Process for DE and AT sellers has been rolled back indefinitely.

•   ResolveBuyerMessageInr

(out) This value indicates that the buyer has not received the item, and the buyer has contacted the seller through the eBay system in an effort to resolve the issue with the seller. The seller must make it right with the buyer in order to expedite the release of funds into their account.

•   ResolveBuyerMessageSnad

(out) This value indicates that the buyer has received the item, but the item is not as described in the listing; hence, the buyer has contacted the seller through the eBay system in an effort to resolve the issue with the seller. The seller must make it right with the buyer in order to expedite the release of funds into their account.

•   ResolveeBPCase

(out) This value indicates that there is an open eBay Buyer Protection case involving the seller and the item. The seller must address and get the case resolved before the funds can be scheduled for release to the seller's account. See the Resolution Case Management API User Guide for information about retrieving and managing eBay Buyer Protection cases.

•   ResolvePPPIcase

(out) This value indicates that the seller must resolve the PayPal Buyer Protection case filed against the order line item to expedite the release of funds into their account.

•   ResolveReturn

(out) This value indicates that the buyer is returning the item through eBay's managed return process. Upon receiving the returned item from the buyer, the seller must issue a refund to the buyer within five business days, and shortly after this happens, eBay will credit the seller's account with the Final Value Fee that was originally assessed on the sale of the item.

•   UploadTrackingInfo

(out) This value indicates that the seller must provide the buyer the tracking information for the order line item to expedite the release of funds into their account. The seller can use the CompleteSale call to provide tracking information for an order line item. If the tracking information for an order line item is provided, it is possible that the seller's funds for the order will be released as soon as three days after eBay has confirmed that the item has been delivered.




DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .PayPalEmailAddress
string Conditionally The seller's Paypal email address. This value is only revealed if it is the seller making the call.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .PickupDetails
PickupDetailsType Conditionally Contains all local pickup related information.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .PickupDetails.PickupOptions
PickupOptionsType Conditionally,
repeatable: [0..*]
Container consisting of an In-Store pickup method and the priority of the pickup method. The priority of each pickup method controls the order (relative to other pickup methods) in which the corresponding pickup method will appear in the View Item and Checkout page. With this initial version of In-Store Pickup, the only pickup method is 'InStorePickup'.

This container is always returned prior to order payment if the seller created/revised/relisted the item with the EligibleForPickupInStore flag in the call request set to 'true'. If and when the In-Store pickup method is selected by the buyer and payment for the order is made, this container will no longer be returned in the response, and will essentially be replaced by the PickupMethodSelected container.

Note: At this time, the In-Store Pickup feature is generally only available to large retail merchants, and can only be applied to multi-quantity, fixed-price listings.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .PickupDetails.PickupOptions
  .PickupMethod
token Conditionally This value indicates an available In-Store pickup method. This field is always returned with the PickupOptions container.

Note: At this time, 'InStorePickup' is the only available pickup method; however, additional pickup methods may be added to list in future releases.

Note: A seller must be eligible for the In-Store Pickup feature to list an item that is eligible for In-Store Pickup. At this time, the In-Store Pickup feature is generally only available to large retail merchants, and can only be applied to multi-quantity, fixed-price listings.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.

Applicable values: See PickupMethodCodeType
TransactionArray.Transaction
  .PickupDetails.PickupOptions
  .PickupPriority
int Conditionally This integer value indicates the priority of the pickup method. The priority of each pickup method controls the order (relative to other pickup methods) in which the corresponding pickup method will appear in the View Item and Checkout page. With this initial version of In-Store Pickup, the only pickup method is 'InStorePickup'. This field is always returned with the PickupOptions container.

Note: A seller must be eligible for the In-Store Pickup feature to list an item that is eligible for In-Store Pickup. At this time, the In-Store Pickup feature is generally only available to large retail merchants, and can only be applied to multi-quantity, fixed-price listings.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .PickupMethodSelected
PickupMethodSelectedType Conditionally This container consists of details related to the selected In-Store pickup method, including the pickup method, the merchant's store ID, the status of the In-Store pickup, and the pickup reference code (if provided by merchant).

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .PickupMethodSelected
  .MerchantPickupCode
string Conditionally The unique reference number defined by the merchant to track In-Store Pickup orders. The MerchantPickupCode is picked up by eBay if it is set by the merchant through the payload of a notification sent to eBay through the Inbound Notifications API. This field is only returned with the PickupMethodSelected container if it set by the merchant.

Note: A seller must be eligible for the In-Store Pickup feature to list an item that is eligible for In-Store Pickup. At this time, the In-Store Pickup feature is generally only available to large retail merchants, and can only be applied to multi-quantity, fixed-price listings. Merchants/developers can test In-Store Pickup functionality in the Sandbox environment, including listing items enabled with the In-Store Pickup feature, creating store locations and adding inventory to these stores using the Inventory Management API, and informing eBay of In-Store Pickup status changes using the Inbound Notifications API.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .PickupMethodSelected
  .PickupFulfillmentTime
dateTime Conditionally Timestamp indicating the date/time when the order is expected to be fulfilled by the merchant and available for pick up by the buyer.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .PickupMethodSelected
  .PickupLocationUUID
string Conditionally The unique identifier of the merchant's store where the "Click and Collect" item will be picked up.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .PickupMethodSelected
  .PickupMethod
token Conditionally This value indicates the local pickup method that was selected by the buyer at checkout. This field is always returned with the PickupMethodSelected container.

Note: Merchants must be eligible for the In-Store Pickup or "Click and Collect" feature to list items that are eligible for these local pickup methods.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.

Applicable values: See PickupMethodCodeType
TransactionArray.Transaction
  .PickupMethodSelected
  .PickupStatus
PickupStatusCodeType Conditionally This field indicates the current status of the local pickup order. The value of the PickupStatus field can change during the lifecycle of the order based on the notifications that a merchant sends to eBay through the Inbound Notifications API. This field is always returned with the PickupMethodSelected container.

Note: A seller must be eligible for the In-Store Pickup feature to list an item that is eligible for In-Store Pickup. At this time, the In-Store Pickup feature is generally only available to large retail merchants, and can only be applied to multi-quantity, fixed-price listings. Merchants/developers can test In-Store Pickup functionality in the Sandbox environment, including listing items enabled with the In-Store Pickup feature, creating store locations and adding inventory to these stores using the Inventory Management API, and informing eBay of In-Store Pickup status changes using the Inbound Notifications API.

Applicable values:

•   CustomCode

(out) This value is reserved for internal or future use.

•   Invalid

(out) This value indicates that the current status value of the In-Store Pickup order is invalid.

•   NotApplicable

(out) This value indicates that the current status value of the In-Store Pickup order is not applicable.

•   PendingMerchantConfirmation

(out) This status indicates that the In-Store Pickup order has yet to be acknowledged by the merchant. This is typically the state before the merchant sends the ORDER.READY_FOR_PICKUP notification to eBay through the Inbound Notifications API.

•   Pickedup

(out) This status indicates that the In-Store Pickup order has been picked up by the buyer. This state occurs after the merchant sends the ORDER.PICKEDUP notification to eBay through the Inbound Notifications API.

•   PickupCancelled

(out) This status indicates that the In-Store Pickup order has been cancelled, and the exact reason is not available.

•   PickupCancelledBuyerNoShow

(out) This status indicates that the In-Store Pickup order has been cancelled by the merchant, because the buyer never showed up to pick up the item. This state occurs after the merchant sends the ORDER.PICKUP_CANCELED notification (with the CANCEL_TYPE parameter in the notification payload set to "BUYER_NO_SHOW") to eBay through the Inbound Notifications API.

•   PickupCancelledBuyerRejected

(out) This status indicates that the In-Store Pickup order has been cancelled by the merchant, because the buyer rejected the item. This state occurs after the merchant sends the ORDER.PICKUP_CANCELED notification (with the CANCEL_TYPE parameter in the notification payload set to "BUYER_REJECTED") to eBay through the Inbound Notifications API.

•   PickupCancelledOutOfStock

(out) This status indicates that the In-Store Pickup order has been cancelled by the merchant, because the product was out of stock. This state occurs after the merchant sends the ORDER.PICKUP_CANCELED notification (with the CANCEL_TYPE parameter in the notification payload set to "OUT_OF_STOCK") to eBay through the Inbound Notifications API.

•   ReadyToPickup

(out) This status indicates that the In-Store Pickup order is ready to be picked up by the buyer. This state occurs after the merchant sends the ORDER.READY_FOR_PICKUP notification to eBay through the Inbound Notifications API.




DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .PickupMethodSelected
  .PickupStoreID
string Conditionally The unique identifier of the merchant's store where the In-Store Pickup item will be picked up. The PickupStoreID is picked up by eBay based on the LocationID value that is set by the merchant in the Inventory Management API. This field is always returned with the PickupMethodSelected container.

Note: A seller must be eligible for the In-Store Pickup feature to list an item that is eligible for In-Store Pickup. At this time, the In-Store Pickup feature is generally only available to large retail merchants, and can only be applied to multi-quantity, fixed-price listings. Merchants/developers can test In-Store Pickup functionality in the Sandbox environment, including listing items enabled with the In-Store Pickup feature, creating store locations and adding inventory to these stores using the Inventory Management API, and informing eBay of In-Store Pickup status changes using the Inbound Notifications API.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .Platform
TransactionPlatformCodeType Always This value indicates from which site (eBay.com or Half.com) the order line item originated. If 'eBay' was set as the Platform value in the request, all retrieved order line items should have originated from eBay.com. If 'Half' was set as the Platform value in the request, all retrieved order line items should have originated from Half.com.

Applicable values:

•   CustomCode

(in/out) Reserved for future use.

•   eBay

(in/out) The order line item was created on the main eBay site.

•   Half

(in/out) The order line item was created on Half.com site.


(Not all values in TransactionPlatformCodeType apply to this field.)


DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .QuantityPurchased
int Conditionally This value indicates the number of identical items purchased at the same time by the same buyer from one listing. For auction listings, this value is always 1. For fixed-price, non-variation listings, this value can be greater than 1. In either case, this field is tied to the same order line item.

Applicable to Half.com (for GetOrders).

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .RefundArray
RefundArrayType Conditionally Container consisting of one or more refund transactions to Half.com buyers. Container consisting of one or more refund transactions for eBay's new payment process. This container is only returned if a refund to a Half.com buyer has occurred or an refund was issued through eBay's new payment process

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .RefundArray.Refund
RefundType Conditionally,
repeatable: [0..*]
This container consists of information about a Half.com refund. It is only returned for Half.com refund

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .RefundArray.Refund
  .EstimatedRefundCompletionTime
dateTime Conditionally The estimated date and time that the refund is expected to be completed. For eBay orders, Refund containers are only returned for DE/AT orders subject to the new eBay payment process.

Note:The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .RefundArray.Refund
  .ExternalReferenceID
string Conditionally The unique external reference ID that was passed by the seller when requesting the refund. This ID helps to prevent duplication of refund requests. For eBay orders, Refund containers are only returned for DE/AT orders subject to the new eBay payment process.

Note:The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .RefundArray.Refund
  .RefundAmount
AmountType (double) Conditionally The total amount of the refund requested. For eBay orders, Refund containers are only returned for DE/AT orders subject to the new eBay payment process.

Note:The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .RefundArray.Refund
  .RefundAmount
  [ attribute currencyID ]
CurrencyCodeType Always The total amount of the refund requested. For eBay orders, Refund containers are only returned for DE/AT orders subject to the new eBay payment process.

Note:The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice.

For a list of possible enumeration values, see CurrencyCodeType.
TransactionArray.Transaction
  .RefundArray.Refund
  .RefundCompletionTime
dateTime Conditionally The date and time that the refund was completed. For eBay orders, Refund containers are only returned for DE/AT orders subject to the new eBay payment process.

Note:The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .RefundArray.Refund
  .RefundFailureReason
RefundFailureReasonType Conditionally This describes the reason why a refund was not issued by the seller. For eBay orders, Refund containers are only returned for DE/AT orders subject to the new eBay payment process.

Note:The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .RefundArray.Refund
  .RefundFailureReason
  .RefundFailureCode
RefundFailureCodeType Conditionally An enumerated value indicating the reason why a German or Austrian seller's attempt to distribute a refund to a buyer through the Order Adjustment API's issueRefund call failed. This field is only applicable to orders subject to the new eBay payment process on the German and Austrian sites.

Note: The new eBay payment process for German and Austrian sites has been put on hold indefinitely.

Applicable values:

•   PaypalBillingAgreementCanceled

(out) The refund attempt failed because the seller's billing agreement with PayPal has been cancelled.

Note: The new eBay payment process for German and Austrian sites has been put on hold indefinitely.

•   PaypalRiskDeclinesTransaction

(out) The refund attempt failed because because the PayPayl Risk team declined the transaction. The seller should log in to their PayPal account to proceed with the refund request.

Note: The new eBay payment process for German and Austrian sites has been put on hold indefinitely.


(Not all values in RefundFailureCodeType apply to this field.)


DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .RefundArray.Refund
  .RefundFundingSourceArray
RefundFundingSourceArrayType Conditionally This container lists the funding sources for the refund. For eBay orders, Refund containers are only returned for DE/AT orders subject to the new eBay payment process.

Note:The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .RefundArray.Refund
  .RefundFundingSourceArray
  .RefundFundingSource
RefundFundingSourceType Conditionally,
repeatable: [0..*]
The funding source for the refund issued by the seller through the Order Adjusment API's issueRefund call. It is possible that more than one funding source may be used for this refund.

Note: The new eBay payment process on the German and Austrian sites has been put on hold indefinitely.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .RefundArray.Refund
  .RefundFundingSourceArray
  .RefundFundingSource
  .AccountNumber
string Conditionally The account number of the funding source.

Note: The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .RefundArray.Refund
  .RefundFundingSourceArray
  .RefundFundingSource
  .BuyerExternalTransactionID
string Conditionally The external transaction ID of the buyer's account.

Note: The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .RefundArray.Refund
  .RefundFundingSourceArray
  .RefundFundingSource
  .RefundAmount
AmountType (double) Conditionally The amount of the refund.

Note: The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .RefundArray.Refund
  .RefundFundingSourceArray
  .RefundFundingSource
  .RefundAmount
  [ attribute currencyID ]
CurrencyCodeType Always The amount of the refund.

Note: The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice.

For a list of possible enumeration values, see CurrencyCodeType.
TransactionArray.Transaction
  .RefundArray.Refund
  .RefundFundingSourceArray
  .RefundFundingSource
  .RefundingSourceType
RefundingSourceTypeCodeType Conditionally The source from which the refund was made.

Note: The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice.

Applicable values:

•   BankAccount

(out) The seller's bank account associated with the transaction.

Note: The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice.

•   CustomCode

(out) Reserved for internal or future use.

•   Paypal

(out) The seller's PayPal account associated with the transaction.

Note: The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice.

•   ScheduledPayout

(out) The seller's scheduled payout account with eBay. When a buyer pays for an item the purchase amount goes into this account. This value indicates that the refund has been issued from the seller's scheduled payout account.

Note: The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice.




DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .RefundArray.Refund
  .RefundFundingSourceArray
  .RefundFundingSource
  .SellerExternalTransactionID
string Conditionally The external transaction ID of the seller's account.

Note: The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .RefundArray.Refund.RefundID
string Conditionally The refund ID for this refund. For eBay orders, Refund containers are only returned for DE/AT orders subject to the new eBay payment process.


Note: The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .RefundArray.Refund
  .RefundRequestedTime
dateTime Conditionally The date and time when the refund was requested. For eBay orders, Refund containers are only returned for DE/AT orders subject to the new eBay payment process.

Note:The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .RefundArray.Refund
  .RefundStatus
RefundStatusCodeType Conditionally A code indicating the status of the refund request. For eBay orders, Refund containers are only returned for DE/AT orders subject to the new eBay payment process.

Note:The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice.

Applicable values:

•   CustomCode

(out) Reserved for internal or future use.

•   Failed

(out) The refund request was rejected.

Note: The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice.

•   Pending

(out) The refund request is being processed.

Note: The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice.

•   Successful

(out) The refund request was successful.

Note: The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice.




DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .RefundArray.Refund
  .RefundTransactionArray
RefundTransactionArrayType Conditionally A container consisting of details about an order line item against which the seller issued a refund. For eBay orders, Refund containers are only returned for DE/AT orders subject to the new eBay payment process.

Note:The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .RefundArray.Refund
  .RefundTransactionArray
  .RefundTransaction
RefundTransactionType Conditionally,
repeatable: [0..*]
A container consisting of details about an order line item against which the seller issued a refund.

Note: The new eBay payment process on the German and Austrian sites has been put on hold indefinitely.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .RefundArray.Refund
  .RefundTransactionArray
  .RefundTransaction.ItemID
string Conditionally The item against which the refund was issued. This value must be accompanied by a TransactionID value.

Note: The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .RefundArray.Refund
  .RefundTransactionArray
  .RefundTransaction.OrderID
string Conditionally The order against which the refund was issued. The presence of this value indicates that the refund was issued against the entire order.

Note: The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .RefundArray.Refund
  .RefundTransactionArray
  .RefundTransaction
  .RefundLineArray
RefundLineArrayType Conditionally An array of refund lines identifying the order line items against which the refund was issued.

Note: The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .RefundArray.Refund
  .RefundTransactionArray
  .RefundTransaction
  .RefundLineArray.RefundLine
RefundLineType (AmountType) Conditionally,
repeatable: [0..*]
This field indicates the type and amount of the refund to the buyer involved in an DE/AT order order subject to the new eBay payment process. The type attribute indicates whether the refund is being applied against the purchase price or the shipping price. Using the issueRefund call of the Order Adjustment API, the seller can also issue an optional/additional refund that does not apply to the purchase price or shipping price. The type values are defined in the RefundLineTypeCodeType enumeration type.



RefundLine fields will only be returned if a refund has been issued from the seller to the buyer for a DE/AT order going through the new eBay payment process.

Note: The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .RefundArray.Refund
  .RefundTransactionArray
  .RefundTransaction
  .RefundLineArray.RefundLine
  [ attribute type ]
RefundLineTypeCodeType Conditionally This field indicates the type and amount of the refund to the buyer involved in an DE/AT order order subject to the new eBay payment process. The type attribute indicates whether the refund is being applied against the purchase price or the shipping price. Using the issueRefund call of the Order Adjustment API, the seller can also issue an optional/additional refund that does not apply to the purchase price or shipping price. The type values are defined in the RefundLineTypeCodeType enumeration type.



RefundLine fields will only be returned if a refund has been issued from the seller to the buyer for a DE/AT order going through the new eBay payment process.

Note: The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice.

For a list of possible enumeration values, see RefundLineTypeCodeType.
TransactionArray.Transaction
  .RefundArray.Refund
  .RefundTransactionArray
  .RefundTransaction
  .RefundLineArray.RefundLine
  [ attribute currencyID ]
CurrencyCodeType Always This field indicates the type and amount of the refund to the buyer involved in an DE/AT order order subject to the new eBay payment process. The type attribute indicates whether the refund is being applied against the purchase price or the shipping price. Using the issueRefund call of the Order Adjustment API, the seller can also issue an optional/additional refund that does not apply to the purchase price or shipping price. The type values are defined in the RefundLineTypeCodeType enumeration type.



RefundLine fields will only be returned if a refund has been issued from the seller to the buyer for a DE/AT order going through the new eBay payment process.

Note: The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice.

For a list of possible enumeration values, see CurrencyCodeType.
TransactionArray.Transaction
  .RefundArray.Refund
  .RefundTransactionArray
  .RefundTransaction
  .TransactionID
string Conditionally The transaction against which the refund was issued. This value must be accompanied by an ItemID value.

Note: The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .RefundArray.Refund
  .SellerNoteToBuyer
string Conditionally Comments made by the the seller to the buyer. For eBay orders, Refund containers are only returned for DE/AT orders subject to the new eBay payment process.

Note:The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .SellerContactBuyerByEmail
boolean Conditionally Indicates whether the buyer has opted to accept emails from all the selling partners on Shopping.com. This field is only returned for order line items purchased through the Shopping.com shopping cart.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .SellerDiscounts
SellerDiscountsType Conditionally Seller Discounts

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .SellerDiscounts
  .OriginalItemPrice
AmountType (double) Conditionally The original purchase price of the order line item (before any seller discounts are applied).

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .SellerDiscounts
  .OriginalItemPrice
  [ attribute currencyID ]
CurrencyCodeType Always The original purchase price of the order line item (before any seller discounts are applied).

For a list of possible enumeration values, see CurrencyCodeType.
TransactionArray.Transaction
  .SellerDiscounts
  .OriginalItemShippingCost
AmountType (double) Conditionally The original shipping cost for the order line item. Note that shipping discounts have not yet been enabled for seller discount campaigns.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .SellerDiscounts
  .OriginalItemShippingCost
  [ attribute currencyID ]
CurrencyCodeType Always The original shipping cost for the order line item. Note that shipping discounts have not yet been enabled for seller discount campaigns.

For a list of possible enumeration values, see CurrencyCodeType.
TransactionArray.Transaction
  .SellerDiscounts
  .SellerDiscount
SellerDiscountType Conditionally,
repeatable: [0..*]
A container consisting of name and ID of the seller's discount campaign, as well as the discount amount that is being applied to the order line item. Note that shipping discounts have not yet been enabled for seller discount campaigns. Seller discount campaigns are created through the Order Size Discounts API.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.

See:
    Order Size Discounts API - createCampaigns call for for information on creating discount campaigns
    Related Items Management API - createBundles call for for information on creating product bundles

TransactionArray.Transaction
  .SellerDiscounts
  .SellerDiscount
  .CampaignDisplayName
string Conditionally The name of the seller discount campaign. A name can be associated with a seller discount campaign when the seller uses the createCampaigns or updateCampaigns calls of the Order Size Discounts API. The name for a discount campaign is optional, so this field will only be returned with the SellerDiscount container if defined for the seller discount campaign.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.

See campaign.name field in Order Size Discounts API.

TransactionArray.Transaction
  .SellerDiscounts
  .SellerDiscount.CampaignID
long Conditionally Unique identifier for a seller discount campaign. This ID is automatically created when the seller creates the discount campaign. This field is always returned with the SellerDiscount container.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.

See campaignId field in Order Size Discounts API.

TransactionArray.Transaction
  .SellerDiscounts
  .SellerDiscount
  .ItemDiscountAmount
AmountType (double) Conditionally The dollar amount of the order line item discount. The original purchase price (denoted in OriginalItemPrice) will be reduced by this value. The amount of the item discount will depend on the rules defined in the the seller discount campaign.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.

See campaign.offer container in Order Size Discounts API.

TransactionArray.Transaction
  .SellerDiscounts
  .SellerDiscount
  .ItemDiscountAmount
  [ attribute currencyID ]
CurrencyCodeType Always The dollar amount of the order line item discount. The original purchase price (denoted in OriginalItemPrice) will be reduced by this value. The amount of the item discount will depend on the rules defined in the the seller discount campaign.

For a list of possible enumeration values, see CurrencyCodeType.
TransactionArray.Transaction
  .SellerDiscounts
  .SellerDiscount
  .ShippingDiscountAmount
AmountType (double) Conditionally The dollar amount of the shipping discount applied to the order line item. Note that shipping discounts have not yet been enabled for seller discount campaigns, so this field will not be returned until shipping discounts are enabled.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .SellerDiscounts
  .SellerDiscount
  .ShippingDiscountAmount
  [ attribute currencyID ]
CurrencyCodeType Always The dollar amount of the shipping discount applied to the order line item. Note that shipping discounts have not yet been enabled for seller discount campaigns, so this field will not be returned until shipping discounts are enabled.

For a list of possible enumeration values, see CurrencyCodeType.
TransactionArray.Transaction
  .SellingManagerProductDetails
SellingManagerProductDetailsType Conditionally This container consists of Selling Manager product details and is only returned if the item was listed through Selling Manager.

Not applicable to Half.com.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .SellingManagerProductDetails
  .ProductName
string Conditionally The name of a Selling Manager product. The AddSellingManagerProduct call is used to create a Selling Manager product.
TransactionArray.Transaction
  .ShippedTime
dateTime Conditionally Indicates the time when the item(s) associated with the order were marked as shipped. This value will only be visible to the user on either side of the order. An order can be marked as shipped in My eBay or through Selling Manager Pro, or programmatically by the seller through the CompleteSale call.

Applicable to Half.com (for GetOrders only).

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ShippingConvenienceCharge
AmountType (double) Conditionally The dollar value in this field indicates the amount that the seller is being charged (at line item level) for the convenience of an eBay Now delivery. The standard minimum order amount for an eBay Now delivery is $25, with a "convenience fee" of $5. If the buyer meets the minimum order amount, this value will generally be '5.0'. However, it is also possible that the buyer's order only totals $15, so that buyer is required to pay a "convenience fee" of $10.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ShippingConvenienceCharge
  [ attribute currencyID ]
CurrencyCodeType Always The dollar value in this field indicates the amount that the seller is being charged (at line item level) for the convenience of an eBay Now delivery. The standard minimum order amount for an eBay Now delivery is $25, with a "convenience fee" of $5. If the buyer meets the minimum order amount, this value will generally be '5.0'. However, it is also possible that the buyer's order only totals $15, so that buyer is required to pay a "convenience fee" of $10.

For a list of possible enumeration values, see CurrencyCodeType.
TransactionArray.Transaction
  .ShippingDetails
ShippingDetailsType Conditionally Container consisting of shipping-related details for an order. Shipping details include shipping rates, package dimensions, handling costs, excluded shipping locations (if specified), shipping service options, shipping insurance information, sales tax information (if applicable), and shipment tracking details (if shipped).

For GetSellerTransactions and GetItemTransactions, the ShippingDetails container is returned in the Transaction container. For GetOrders and GetOrderTransactions, the ShippingDetails container is returned at the Order level.

Applicable to Half.com (for GetOrders only).

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.

See Shipping.

TransactionArray.Transaction
  .ShippingDetails
  .CalculatedShippingRate
CalculatedShippingRateType Conditionally 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. If your call specifies a large-dimension item listed with UPS, see Dimensional Weight limit on UPS shipping services results in failure of shipping calculator.

Not applicable to Half.com.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ShippingDetails
  .CalculatedShippingRate
  .InternationalPackagingHandlingCosts
AmountType (double) Conditionally Fees a seller might assess for the shipping of the item (in addition to whatever the shipping service might charge). Any packaging/handling cost specified on input is added to each shipping service on output. If domestic and international calculated shipping is offered for an item and if packaging/handling cost is specified only for domestic shipping, that cost will be applied by eBay as the international packaging/handling cost. (To specify a international packaging/handling cost, you must always specify a domestic packaging/handling cost, even if it is 0.) For international calculated shipping only.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ShippingDetails
  .CalculatedShippingRate
  .InternationalPackagingHandlingCosts
  [ attribute currencyID ]
CurrencyCodeType Always Fees a seller might assess for the shipping of the item (in addition to whatever the shipping service might charge). Any packaging/handling cost specified on input is added to each shipping service on output. If domestic and international calculated shipping is offered for an item and if packaging/handling cost is specified only for domestic shipping, that cost will be applied by eBay as the international packaging/handling cost. (To specify a international packaging/handling cost, you must always specify a domestic packaging/handling cost, even if it is 0.) For international calculated shipping only.

For a list of possible enumeration values, see CurrencyCodeType.
TransactionArray.Transaction
  .ShippingDetails
  .CalculatedShippingRate
  .OriginatingPostalCode
string Conditionally Postal code for the location from which the package will be shipped. Required for calculated shipping. Use Item.PostalCode to specify the location of the item used for searches by location.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ShippingDetails
  .CalculatedShippingRate
  .PackageDepth
MeasureType (decimal) Conditionally Depth of the package, in whole number of inches, needed to ship the item. This is validated against the selected shipping service. Upon mismatch, a message is returned, such as, "Package dimensions exceeds maximum allowable limit for service XXXXX," where XXXXX is the name of the shipping service. For calculated shipping only. Only returned if the seller specified the value for the item. (In many cases, the seller only specifies the weight fields.)

Developer impact: UPS requires dimensions for any Ground packages that are 3 cubic feet or larger and for all air packages, if they are to provide correct shipping cost. If package dimensions are not included for an item listed with calculated shipping, the shipping cost returned will be an estimate based on standard dimensions for the defined package type. eBay enforces a dimensions requirement on listings so that buyers receive accurate calculated shipping costs.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.

See Specifying Shipping Types and Costs.

TransactionArray.Transaction
  .ShippingDetails
  .CalculatedShippingRate
  .PackageDepth
  [ attribute unit ]
token Conditionally Depth of the package, in whole number of inches, needed to ship the item. This is validated against the selected shipping service. Upon mismatch, a message is returned, such as, "Package dimensions exceeds maximum allowable limit for service XXXXX," where XXXXX is the name of the shipping service. For calculated shipping only. Only returned if the seller specified the value for the item. (In many cases, the seller only specifies the weight fields.)

Developer impact: UPS requires dimensions for any Ground packages that are 3 cubic feet or larger and for all air packages, if they are to provide correct shipping cost. If package dimensions are not included for an item listed with calculated shipping, the shipping cost returned will be an estimate based on standard dimensions for the defined package type. eBay enforces a dimensions requirement on listings so that buyers receive accurate calculated shipping costs.
TransactionArray.Transaction
  .ShippingDetails
  .CalculatedShippingRate
  .PackageLength
MeasureType (decimal) Conditionally Length of the package, in whole number of inches, needed to ship the item. Upon mismatch, a message is returned, such as, "Package dimensions exceeds maximum allowable limit for service XXXXX," where XXXXX is the name of the shipping service. For calculated shipping only. Only returned if the seller specified the value for the item. (In many cases, the seller only specifies the weight fields.)

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.

See Specifying Shipping Types and Costs.

TransactionArray.Transaction
  .ShippingDetails
  .CalculatedShippingRate
  .PackageLength
  [ attribute unit ]
token Conditionally Length of the package, in whole number of inches, needed to ship the item. Upon mismatch, a message is returned, such as, "Package dimensions exceeds maximum allowable limit for service XXXXX," where XXXXX is the name of the shipping service. For calculated shipping only. Only returned if the seller specified the value for the item. (In many cases, the seller only specifies the weight fields.)
TransactionArray.Transaction
  .ShippingDetails
  .CalculatedShippingRate
  .PackageWidth
MeasureType (decimal) Conditionally Width of the package, in whole number of inches, needed to ship the item. Upon mismatch, a message is returned, such as, "Package dimensions exceeds maximum allowable limit for service XXXXX," where XXXXX is the name of the shipping service. For calculated shipping only. Only returned if the seller specified the value for the item. (In many cases, the seller only specifies the weight fields.)

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.

See Specifying Shipping Types and Costs.

TransactionArray.Transaction
  .ShippingDetails
  .CalculatedShippingRate
  .PackageWidth
  [ attribute unit ]
token Conditionally Width of the package, in whole number of inches, needed to ship the item. Upon mismatch, a message is returned, such as, "Package dimensions exceeds maximum allowable limit for service XXXXX," where XXXXX is the name of the shipping service. For calculated shipping only. Only returned if the seller specified the value for the item. (In many cases, the seller only specifies the weight fields.)
TransactionArray.Transaction
  .ShippingDetails
  .CalculatedShippingRate
  .PackagingHandlingCosts
AmountType (double) Conditionally Fees a seller might assess for the shipping of the item (in addition to whatever the shipping service might charge). Any packaging/handling cost specified on input is added to each shipping service on output. If domestic and international calculated shipping is offered for an item and if packaging/handling cost is specified only for domestic shipping, that cost will be applied by eBay as the international packaging/handling cost. (To specify a international packaging/handling cost, you must always specify a domestic packaging/handling cost, even if it is 0.) When UPS is one of the shipping services offered by the seller, package dimensions are required on list/relist/revise. For calculated shipping only.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ShippingDetails
  .CalculatedShippingRate
  .PackagingHandlingCosts
  [ attribute currencyID ]
CurrencyCodeType Always Fees a seller might assess for the shipping of the item (in addition to whatever the shipping service might charge). Any packaging/handling cost specified on input is added to each shipping service on output. If domestic and international calculated shipping is offered for an item and if packaging/handling cost is specified only for domestic shipping, that cost will be applied by eBay as the international packaging/handling cost. (To specify a international packaging/handling cost, you must always specify a domestic packaging/handling cost, even if it is 0.) When UPS is one of the shipping services offered by the seller, package dimensions are required on list/relist/revise. For calculated shipping only.

For a list of possible enumeration values, see CurrencyCodeType.
TransactionArray.Transaction
  .ShippingDetails
  .CalculatedShippingRate
  .ShippingIrregular
boolean Conditionally Whether a package is irregular and therefore cannot go through the stamping machine at the shipping service office and thus requires special or fragile handling. For calculated shipping only.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ShippingDetails
  .CalculatedShippingRate
  .ShippingPackage
ShippingPackageCodeType Conditionally The nature of the package used to ship the item(s). This is required for calculated shipping only. To get the applicable ShippingPackage values for your site, call GeteBayDetails with DetailName set to ShippingPackageDetails, and then look for the ShippingPackageDetails.ShippingPackage fields in the response.

Applicable values: See ShippingPackage.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ShippingDetails
  .CalculatedShippingRate
  .WeightMajor
MeasureType (decimal) Conditionally WeightMajor and WeightMinor are used to specify the weight of a shipping package. Here is how you would represent a package weight of 5 lbs 2 oz: <WeightMajor unit="lbs">5</WeightMajor> <WeightMinor unit="oz">2</WeightMinor>
See http://www.ups.com for the maximum weight allowed by UPS. Above this maximum, the shipping type becomes Freight, an option that can only be selected via the eBay Web site and not via API. The weight details are validated against the selected shipping service.

For flat rate shipping (only when shipping rate tables are specified and the shipping rate table uses weight surcharges), or for calculated shipping. Required on input when calculated shipping is used.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.

See Managing Rate Tables with the API for flat rate shipping that requires this field.

TransactionArray.Transaction
  .ShippingDetails
  .CalculatedShippingRate
  .WeightMajor
  [ attribute unit ]
token Conditionally WeightMajor and WeightMinor are used to specify the weight of a shipping package. Here is how you would represent a package weight of 5 lbs 2 oz: <WeightMajor unit="lbs">5</WeightMajor> <WeightMinor unit="oz">2</WeightMinor>
See http://www.ups.com for the maximum weight allowed by UPS. Above this maximum, the shipping type becomes Freight, an option that can only be selected via the eBay Web site and not via API. The weight details are validated against the selected shipping service.

For flat rate shipping (only when shipping rate tables are specified and the shipping rate table uses weight surcharges), or for calculated shipping. Required on input when calculated shipping is used.
TransactionArray.Transaction
  .ShippingDetails
  .CalculatedShippingRate
  .WeightMinor
MeasureType (decimal) Conditionally See the definition of WeightMajor.

For flat rate shipping (only when shipping rate tables are specified and the shipping rate table uses weight surcharges), or for calculated shipping. Required on input when calculated shipping is used.

Note: When used with the shipping rate tables with weight surcharge, any WeightMinor value greater than zero results in WeightMajor getting rounded up in the shipping cost calculation (for example, 1 lb, 2 oz is rounded up to 2 lbs).

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.

See Managing Rate Tables with the API for flat rate shipping that requires this field.

TransactionArray.Transaction
  .ShippingDetails
  .CalculatedShippingRate
  .WeightMinor
  [ attribute unit ]
token Conditionally See the definition of WeightMajor.

For flat rate shipping (only when shipping rate tables are specified and the shipping rate table uses weight surcharges), or for calculated shipping. Required on input when calculated shipping is used.

Note: When used with the shipping rate tables with weight surcharge, any WeightMinor value greater than zero results in WeightMajor getting rounded up in the shipping cost calculation (for example, 1 lb, 2 oz is rounded up to 2 lbs).
TransactionArray.Transaction
  .ShippingDetails
  .ChangePaymentInstructions
boolean Conditionally Whether the seller specified payment and shipping instructions during checkout (for example, to update the details of an order). Valid for flat and calculated shipping.

Not applicable to Half.com.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ShippingDetails.CODCost
AmountType (double) Conditionally This dollar value indicates the money due from the buyer upon delivery of the item.

This field should only be specified in the request if 'COD' (cash-on-delivery) is a valid payment method for the site and it is included as a PaymentMethods value in the same request.

This field is only returned if set for the listing.

To see if 'COD' is a supported payment method for a site, call GeteBayDetails with the DetailName field set to 'PaymentOptionDetails'. Look for a value of 'COD' in one of the PaymentOptionDetails.PaymentOption fields in the response.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.

See Other Shipping Features.

TransactionArray.Transaction
  .ShippingDetails.CODCost
  [ attribute currencyID ]
CurrencyCodeType Always This dollar value indicates the money due from the buyer upon delivery of the item.

This field should only be specified in the request if 'COD' (cash-on-delivery) is a valid payment method for the site and it is included as a PaymentMethods value in the same request.

This field is only returned if set for the listing.

To see if 'COD' is a supported payment method for a site, call GeteBayDetails with the DetailName field set to 'PaymentOptionDetails'. Look for a value of 'COD' in one of the PaymentOptionDetails.PaymentOption fields in the response.

For a list of possible enumeration values, see CurrencyCodeType.
TransactionArray.Transaction
  .ShippingDetails
  .ExcludeShipToLocation
string Conditionally,
repeatable: [0..*]
Use this field to specify an international country or region, or a special domestic location, such as 'PO Box' (in US) or 'Packstation' (in DE), to where you will not ship the associated item. Repeat this element in the call request for each location that you want to exclude as a shipping destination for your item.

Set ShipToRegistrationCountry to true to have your ExcludeShipToLocation settings applied to your listing. The locations you have excluded display in the Shipping and Handling section of your item listing.

If a buyer's primary ship-to location is a location that you have listed as an excluded ship-to location (or if the buyer does not have a primary ship-to location), they will receive an error message if they attempt to buy or place a bid on your item.

The exclude ship-to location values are eBay regions and countries. To see the valid exclude ship-to locations for a specified site, call GeteBayDetails with DetailName set to ExcludeShippingLocationDetails, and then look for the ExcludeShippingLocationDetails.Location fields in the response. Repeat GeteBayDetails for each site on which you list.

This field works in conjunction with Item.ShipToLocations to create a set of international countries and regions to where you will, and will not, ship. You can list a region in the ShipToLocations field, then exclude specific countries within that region with this field (for example, you can specify Africa in ShipToLocations, yet exclude Chad with a ExcludeShipToLocation setting). In addition, if your ShipToLocations is Worldwide, you can use this field to specify both regions and countries that you want to exclude from your shipping destinations.

You can specify a default set of locations to where you will not ship in My eBay. If you create an Exclude Ship-To List, it is, by default, in effect when you list items. However, if you specify any value in this field on input, it nullifies the default settings in your Exclude Ship-To List. (If you use ExcludeShipToLocation when you list an item, you will need to list all the locations to where you will not ship the associated item, regardless of the default settings in your Exclude Ship-To List.)

Specify NONE in this field to override the default Exclude Ship-To List you might have set up in My eBay and indicate that you do not want to exclude any shipping locations from the respective item listing.

Note: To enable your default Exclude Ship-To List, you must enable Exclude Shipping Locations and Buyer Requirements in your My eBay Site Preferences. For details, see the KnowledgeBase Article HowTo: ExcludeShipToLocation.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.

Applicable values: See CountryCodeType, ShippingRegionCodeType
TransactionArray.Transaction
  .ShippingDetails.GetItFast
boolean Conditionally 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.

Applicable to Half.com for GetOrders.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ShippingDetails.InsuranceFee
AmountType (double) Conditionally 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.

Valid only on the following sites: FR and IT
Applicable to Half.com for GetOrders.
Default: 0.00.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ShippingDetails.InsuranceFee
  [ attribute currencyID ]
CurrencyCodeType Always 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.

Valid only on the following sites: FR and IT
Applicable to Half.com for GetOrders.

For a list of possible enumeration values, see CurrencyCodeType.
TransactionArray.Transaction
  .ShippingDetails
  .InsuranceOption
InsuranceOptionCodeType Conditionally Whether the seller offers shipping insurance and, if so, whether the insurance is optional or required. Optional as input and only allowed if ChangePaymentInstructions is true. If this field is not included in the request, values specified in the InsuranceFee field will be ignored.

Note: Note that sellers are responsible for the items they sell until they safely arrive in their customers' hands, and that offering buyer-paid insurance (either as an optional or required service) infers that the buyer is somehow responsible for the safe delivery of the items they purchase. This notion can reduce buyer confidence in the marketplace and the practice of including buyer- paid shipping insurance in your item listings is discouraged.
This field is only returned if the value is other than NotOffered.

Valid only on the following sites: FR and IT
If you include buyer-paid shipping insurance for an item listed on one of the sites that supports this option, a buyer on a site that does not support buyer-paid shipping insurance can still purchase the item. In these cases, the buyer is responsible for all the shipping insurance terms that have been outlined in the item listing.

Applicable to Half.com

Applicable values:

•   CustomCode

(in/out) Reserved for internal or future use

•   IncludedInShippingHandling

(in/out) The seller is not charging separately for shipping insurance costs; any insurance is already included in the base shipping cost.

•   NotOffered

(in/out) The seller does not offer shipping insurance to the buyer.

•   NotOfferedOnSite

(out) Shipping insurance is not offered as a separate option on the site where the item is listed. (Some shipping services, such as DE_InsuredExpressOrCourier, include insurance as part of the service.) If another insurance option is specified in the listing request and the site does not support shipping insurance as a separate option, eBay will reset the insurance option to this value. At the time of this writing, this option is only meaningful for the eBay Germany, Austria, and Switzerland sites.

•   Optional

(in/out) The seller offers the buyer the choice of paying for shipping insurance or not.

•   Required

(in/out) The seller requires that the buyer pay for shipping insurance.




DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ShippingDetails
  .InsuranceWanted
boolean Conditionally Whether or not the buyer selected to pay for insurance as an option offered by the seller. This only has a value after the buyer has gone through checkout and selected the insurance preference.

Valid only on the following sites: FR and IT
Applicable to Half.com for GetOrders.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ShippingDetails.PaymentEdited
boolean Conditionally Whether the seller allows the buyer to edit the payment amount for the order. (Sellers enable this property in their My eBay user preferences on the eBay site.)

Not applicable to Half.com.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ShippingDetails
  .PaymentInstructions
string Conditionally Payment instructions (or 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, 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 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. Use DeletedField to remove this value when revising or relisting an item.

Applicable to eBay Motors (usually used to elaborate on the return policy).
Not applicable to Half.com.
Max length: 1000.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.

See:
    Offering a Clear Return Policy
    (AddItem) Item.AttributeSetArray
    (GetItem) Item.AttributeSetArray

TransactionArray.Transaction
  .ShippingDetails.SalesTax
SalesTaxType Conditionally Sales tax details. US and US Motors (site 0) sites only, excluding vehicle listings. Flat and calculated shipping.

Applicable to Half.com (for GetOrders).

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.

See Enabling Multi-jurisdiction Sales Tax.

TransactionArray.Transaction
  .ShippingDetails.SalesTax
  .SalesTaxAmount
AmountType (double) Conditionally The amount of sales tax, calculated for an order based on the SalesTaxPercent and pricing information. US and US Motors (site 0) sites only, excluding vehicle listings.

GetItemTransactions can return incorrect sales tax if the name of a state is not abbreviated (e.g. if the value is "Illinois" rather than "IL") in TransactionArray.Transaction.Buyer.BuyerInfo.ShippingAddress.StateOrProvince. If the name of a state is not abbreviated, sales tax should be obtained by using the OrderLineItemID to call GetOrderTransactions.

Applicable to Half.com (for GetOrders).

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ShippingDetails.SalesTax
  .SalesTaxAmount
  [ attribute currencyID ]
CurrencyCodeType Always The amount of sales tax, calculated for an order based on the SalesTaxPercent and pricing information. US and US Motors (site 0) sites only, excluding vehicle listings.

GetItemTransactions can return incorrect sales tax if the name of a state is not abbreviated (e.g. if the value is "Illinois" rather than "IL") in TransactionArray.Transaction.Buyer.BuyerInfo.ShippingAddress.StateOrProvince. If the name of a state is not abbreviated, sales tax should be obtained by using the OrderLineItemID to call GetOrderTransactions.

Applicable to Half.com (for GetOrders).

For a list of possible enumeration values, see CurrencyCodeType.
TransactionArray.Transaction
  .ShippingDetails.SalesTax
  .SalesTaxPercent
float Conditionally Percent of an item's price to be charged as the sales tax for the order. The value passed in is stored with a precision of 3 digits after the decimal point (##.###).

Applicable to Half.com (for GetOrders).

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ShippingDetails.SalesTax
  .SalesTaxState
string Conditionally State or jurisdiction for which the sales tax is being collected. Only returned if the seller specified a value.

To see the valid values for your site, call GeteBayDetails with DetailName set to TaxJurisdiction, and then look for the TaxJurisdiction.JurisdictionID fields in the response.

Applicable to Half.com (for GetOrders).

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ShippingDetails.SalesTax
  .ShippingIncludedInTax
boolean Conditionally (US only) Whether shipping costs were part of the base amount that was taxed. Flat or calculated shipping.

Applicable to Half.com (for GetOrders).

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ShippingDetails
  .SellingManagerSalesRecordNumber
int Conditionally The sale record ID. Applicable to Selling Manager users. When an item is sold, Selling Manager generates a sale record. A sale record contains buyer information, shipping, and other information. A sale record is displayed in the Sold view in Selling Manager. Each sale record has a sale record ID. In the following calls, the value for the sale record ID is in the SellingManagerSalesRecordNumber field: GetItemTransactions, GetSellerTransactions, GetOrders, GetOrderTransactions. In the Selling Manager calls, the value for the sale record ID is in the SaleRecordID field. The sale record ID can be for a single or a multiple line item order.
Applicable to Half.com (for GetOrders).

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ShippingDetails
  .ShipmentTrackingDetails
ShipmentTrackingDetailsType Conditionally,
repeatable: [0..*]
Container for the shipping carrier and tracking information associated with the shipment of an order.

As each package has a unique tracking number, this container should be repeated for each package in the order.

Note: Top-rated sellers must have a record of uploading shipment tracking information (through site or through API) for at least 90 percent of their order line items (purchased by U.S. buyers) to keep their status as Top-rated sellers. For more information on eBay's Top-rated seller program, see the Becoming a Top Rated Seller and qualifying for Top Rated Plus page.


DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ShippingDetails
  .ShipmentTrackingDetails
  .ShipmentTrackingNumber
string Conditionally Required if ShippingCarrierUsed is supplied. The tracking number assigned by the shipping carrier to the item shipment. The format of the tracking number must be consistent with the format used by the specified shipping carrier (ShippingCarrierUsed). Typically, you should avoid spaces and hyphens. Returned only if set. Returned for Half.com as well.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ShippingDetails
  .ShipmentTrackingDetails
  .ShippingCarrierUsed
string Conditionally Required if ShipmentTrackingNumber is supplied. Name of the shipping carrier used to ship the item. Although this value can be any value, since it is not checked by eBay, commonly used shipping carriers can be found by calling GeteBayDetails with DetailName set to ShippingCarrierDetails and examining the returned ShippingCarrierCodeTypes.

For those using UPS Mail Innovations, supply the value UPS-MI for UPS Mail Innnovations. Buyers will subsequently be sent to the UPS Mail Innovations website for tracking.

For those using FedEx SmartPost in a CompleteSale callsupply the value FedEx. Buyers will subsequently be sent to the appropriate web site for tracking status. (The buyer is sent to the UPS Mail Innovations website if UPS-MI is specified, or to the FedEx website if FedEx is specified.) Returned only if set. Returned for Half.com as well.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.

Applicable values: See ShippingCarrierCodeType
TransactionArray.Transaction
  .ShippingDetails
  .ShippingRateErrorMessage
string Conditionally 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.

The message text explains that a postal code is needed to calculate shipping. Only returned when ItemDetails is set to Fine.

Not applicable to Half.com or eBay Motors vehicle listings.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ShippingDetails
  .ShippingRateType
ShippingRateTypeCodeType Conditionally A shipping rate scale for shipping through USPS that affects the shipping cost calculated for USPS (lower if ShippingRateType is DailyPickup). ShippingRateType is returned only if the value of ShippingService is one of the USPS shipping services. For calculated shipping only.

Not applicable to Half.com or eBay Motors vehicle listings.

Applicable values:

•   CommercialPlus

(out) "Commercial Plus" shipping rate scale.

•   Counter

(out) "Counter" shipping rate scale.

•   CustomCode

(out) Reserved for internal or future use.

•   DailyPickup

(out) "Daily pickup" shipping rate scale.

•   Discounted

(out) "Discounted" shipping rate scale.

•   GoldSilver

(out) "Commercial Plus Discounted Rate1" shipping rate scale.

•   OnDemand

(out) "On-demand" shipping rate scale.

•   PlatTitanium

(out) "Commercial Plus Discounted Rate2" shipping rate scale.

•   StandardList

(out) "Standard List" shipping rate scale.




DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.

See Shipping.

TransactionArray.Transaction
  .ShippingDetails
  .ShippingServiceUsed
token Conditionally The shipping service actually used by the seller to ship the item(s) to the buyer.

Not applicable to Half.com.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.

Applicable values: See ShippingServiceCodeType
TransactionArray.Transaction
  .ShippingDetails.ShippingType
ShippingTypeCodeType Conditionally 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.

GetItemShipping and GetItemTransactions: If the type was a mix of flat and calculated services, this is set simply to Flat or Calculated because it is the buyer's selection that results in one of these.

GetMyeBayBuying: If the seller has set the ShipToLocation as 'Worldwide' for an item, but has not specified any international shipping service options, 'NotSpecified' is returned as the ShippingType value.

Not applicable to Half.com.

Applicable values:

•   Calculated

(in/out) Calculated shipping model: the cost of shipping is determined in large part by the seller-offered and buyer-selected shipping service. The seller might assess an additional fee via PackagingHandlingCosts.

•   CalculatedDomesticFlatInternational

(in/out) The seller specified one or more calculated domestic shipping services and one or more flat international shipping services.

•   CustomCode

(in/out) Reserved for future use.

•   Flat

(in/out) Flat shipping model: the seller establishes the cost of shipping and cost of shipping insurance, regardless of what any buyer-selected shipping service might charge the seller.

•   FlatDomesticCalculatedInternational

(in/out) The seller specified one or more flat domestic shipping services and one or more calculated international shipping services.

•   FreightFlat

(in/out) Freight shipping model: freight shipping may be used when flat or calculated shipping cannot be used due to the greater weight of the item.

Currently, FreightFlat is available only for the US, UK, AU, CA and CAFR sites, and only for domestic shipping. On the US site, FreightFlat applies to shipping with carriers that are not affiliated with eBay. For details about freight shipping, see "Specifying Freight Shipping" in the Shipping chapter of the User's Guide.

•   NotSpecified

(in/out) The seller did not specify the shipping type.


(Not all values in ShippingTypeCodeType apply to this field.)


DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ShippingDetails.TaxTable
TaxTableType Conditionally Tax details for a jurisdiction, such as a state or province. If no tax table is associated with the item, a tax table is not returned.

For GetItem, a tax table is returned if it exists when:
- DetailLevel is set to ReturnAll or ItemReturnDescription (in this case, the value of IncludeTaxTable does not matter).
- IncludeTaxTable is set to true and DetailLevel is not set or it is set to ItemReturnAttributes.

Not applicable to Half.com.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ShippingDetails.TaxTable
  .TaxJurisdiction
TaxJurisdictionType Conditionally,
repeatable: [0..*]
Sales tax details for zero or more jurisdictions (states, provinces, etc).

For GetTaxTable: If DetailLevel is not specified, information is returned only for the jurisdictions for which the user provided tax information. If DetailLevel is ReturnAll, tax information is returned for all possible jurisdictions, whether specified by the user or not. ShippingIncludedInTax and SalesTaxPercent are returned, but are empty.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ShippingDetails.TaxTable
  .TaxJurisdiction
  .JurisdictionID
string Conditionally Representative identifier for the jurisdiction. Typically an abbreviation (for example, CA for California).

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ShippingDetails.TaxTable
  .TaxJurisdiction
  .SalesTaxPercent
float Conditionally The tax percent to apply for a listing shipped to this jurisdiction. The value passed in is stored with a precision of 3 digits after the decimal point (##.###).
For GetTaxTable: this tag has no value if the user's tax table has not been set.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ShippingDetails.TaxTable
  .TaxJurisdiction
  .ShippingIncludedInTax
boolean Conditionally Whether shipping costs are to be part of the base amount that is taxed.
For GetTaxTable: This tag is empty if the user did not previously provide information.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ShippingServiceSelected
ShippingServiceOptionsType Conditionally The shipping service selected by the buyer from the services offered by the seller.

Not applicable to Half.com.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.

See Shipping.

TransactionArray.Transaction
  .ShippingServiceSelected
  .ExpeditedService
boolean Conditionally Indicates whether the service is an expedited shipping service. See Enabling Get It Fast. Not applicable to Half.com.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ShippingServiceSelected
  .ImportCharge
AmountType (double) Conditionally The total cost of customs and taxes for the international leg of an order shipped using the Global Shipping Program. This amount is calculated and supplied for each item by the international shipping provider when a buyer views the item properties.
Min: 0.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ShippingServiceSelected
  .ImportCharge
  [ attribute currencyID ]
CurrencyCodeType Conditionally The total cost of customs and taxes for the international leg of an order shipped using the Global Shipping Program. This amount is calculated and supplied for each item by the international shipping provider when a buyer views the item properties.

For a list of possible enumeration values, see CurrencyCodeType.
TransactionArray.Transaction
  .ShippingServiceSelected
  .LogisticPlanType
string Conditionally Reserved for internal or future use.
TransactionArray.Transaction
  .ShippingServiceSelected
  .ShippingInsuranceCost
AmountType (double) Conditionally 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).

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.

See Determining Shipping Costs for a Listing.

TransactionArray.Transaction
  .ShippingServiceSelected
  .ShippingInsuranceCost
  [ attribute currencyID ]
CurrencyCodeType Conditionally 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).

For a list of possible enumeration values, see CurrencyCodeType.
TransactionArray.Transaction
  .ShippingServiceSelected
  .ShippingPackageInfo
ShippingPackageInfoType Conditionally,
repeatable: [0..*]
This container is returned in order management calls.

If the order is being delivered through eBay Now, it contains information on the status of the order, the unique identifier of the store where the order is originating from, and the expected and actual delivery times.

For non-eBay Now orders, this container returns an estimated delivery window.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ShippingServiceSelected
  .ShippingPackageInfo
  .ActualDeliveryTime
dateTime Conditionally This timestamp indicates when the eBay Now order was actually delivered to the buyer. This field is only returned after the order has been delivered to the buyer.
Min: 0.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ShippingServiceSelected
  .ShippingPackageInfo
  .EstimatedDeliveryTimeMax
dateTime Conditionally For a non-eBay Now order, the EstimatedDeliveryTimeMin and EstimatedDeliveryTimeMax timestamps indicate the window during which the buyer can expect to take delivery. The EstimatedDeliveryTimeMax value indicates the latest date and time that the buyer can expect to receive the order.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ShippingServiceSelected
  .ShippingPackageInfo
  .EstimatedDeliveryTimeMin
dateTime Conditionally For a non-eBay Now order, the EstimatedDeliveryTimeMin and EstimatedDeliveryTimeMax timestamps indicate the window during which the buyer can expect to take delivery. The EstimatedDeliveryTimeMin value indicates the earliest date and time that the buyer can expect to receive the order.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ShippingServiceSelected
  .ShippingPackageInfo
  .ScheduledDeliveryTimeMax
dateTime Conditionally The ScheduledDeliveryTimeMin and ScheduledDeliveryTimeMax timestamps indicate the delivery window for which the buyer can expect to receive the eBay Now order. The ScheduledDeliveryTimeMax value indicates the latest time that the buyer can expect to receive the order.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ShippingServiceSelected
  .ShippingPackageInfo
  .ScheduledDeliveryTimeMin
dateTime Conditionally The ScheduledDeliveryTimeMin and ScheduledDeliveryTimeMax timestamps indicate the delivery window for which the buyer can expect to receive the eBay Now order. The ScheduledDeliveryTimeMin value indicates the earliest time that the buyer can expect to receive the order.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ShippingServiceSelected
  .ShippingPackageInfo
  .ShippingTrackingEvent
token Conditionally This enumeration value indicates whether or not the eBay Now valet has picked up the order from the store indicated by the StoreID value.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.

Applicable values: See ShippingTrackingEventCodeType
TransactionArray.Transaction
  .ShippingServiceSelected
  .ShippingPackageInfo.StoreID
string Conditionally The unique identifier of the store from where the eBay Now order will be delivered. The eBay Now valet picks up the order from this store and delivers it to the buyer.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ShippingServiceSelected
  .ShippingService
token Conditionally A shipping service option being offered by the seller to ship an item to a buyer. For a list of valid ShippingService values, GeteBayDetails with DetailName set to ShippingServiceDetails. The ShippingServiceDetails.ValidForSellingFlow flag must also be present. Otherwise, that particular shipping service option is no longer valid and cannot be offered to buyers through a listing.

To view the full list of domestic shipping service options in the response, look for the ShippingServiceDetails.ShippingService fields. Domestic shipping service options will not have a InternationalService=true field, as this indicates that the ShippingService value is an International shipping service option.

For flat and calculated shipping. Also applicable to Half.com (for GetOrders).

If there are two or more services and one is "pickup", "pickup" must not be specified as the first service.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.

See GeteBayDetails.



Applicable values: See ShippingServiceCodeType
TransactionArray.Transaction
  .ShippingServiceSelected
  .ShippingServiceAdditionalCost
AmountType (double) Conditionally The cost of shipping each additional item beyond the first item. For input, this is required if the listing is for multiple items. For single-item listings, it should be zero (or is defaulted to zero if not provided). For flat shipping only. Not applicable to Half.com.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.

See Determining Shipping Costs for a Listing.

TransactionArray.Transaction
  .ShippingServiceSelected
  .ShippingServiceAdditionalCost
  [ attribute currencyID ]
CurrencyCodeType Conditionally The cost of shipping each additional item beyond the first item. For input, this is required if the listing is for multiple items. For single-item listings, it should be zero (or is defaulted to zero if not provided). For flat shipping only. Not applicable to Half.com.

For a list of possible enumeration values, see CurrencyCodeType.
TransactionArray.Transaction
  .ShippingServiceSelected
  .ShippingServiceCost
AmountType (double) Conditionally 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.

If a shipping service has been specified (even LocalPickup), GetItem returns the shipping service cost, even if the cost is zero. Otherwise, cost is not returned.

If this is for calculated shipping for a listing that has not yet ended, note that the cost cannot be determined until the listing has ended and the buyer has specified a postal code.

For GetItemShipping, promotional shipping savings is reflected in the cost, if applicable. If the promotional shipping option is lower than other shipping services being offered, the savings is reflected in the returned shipping cost. The shipping service named Promotional Shipping Service (or whatever is the localized name for it) is included among the shipping services. If the promotional shipping cost is lower than the cost of other shipping services being offered, it is presented first in the list. (The LOWEST shipping service cost is always presented first, regardless of whether there is promotional shipping.)

For GetMyeBaySelling, ShippingServiceCost under the SoldList and DeletedFromSoldList containers returns the cost of the domestic leg of a Global Shipping Program shipment (to the international shipping provider's warehouse).

Also applicable to Half.com (for GetOrders).

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.

See Determining Shipping Costs for a Listing.

TransactionArray.Transaction
  .ShippingServiceSelected
  .ShippingServiceCost
  [ attribute currencyID ]
CurrencyCodeType Conditionally 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.

If a shipping service has been specified (even LocalPickup), GetItem returns the shipping service cost, even if the cost is zero. Otherwise, cost is not returned.

If this is for calculated shipping for a listing that has not yet ended, note that the cost cannot be determined until the listing has ended and the buyer has specified a postal code.

For GetItemShipping, promotional shipping savings is reflected in the cost, if applicable. If the promotional shipping option is lower than other shipping services being offered, the savings is reflected in the returned shipping cost. The shipping service named Promotional Shipping Service (or whatever is the localized name for it) is included among the shipping services. If the promotional shipping cost is lower than the cost of other shipping services being offered, it is presented first in the list. (The LOWEST shipping service cost is always presented first, regardless of whether there is promotional shipping.)

For GetMyeBaySelling, ShippingServiceCost under the SoldList and DeletedFromSoldList containers returns the cost of the domestic leg of a Global Shipping Program shipment (to the international shipping provider's warehouse).

Also applicable to Half.com (for GetOrders).

For a list of possible enumeration values, see CurrencyCodeType.
TransactionArray.Transaction
  .ShippingServiceSelected
  .ShippingServicePriority
int Conditionally This integer value controls the order (relative to other shipping services) in which the corresponding ShippingService will appear in the View Item and Checkout page. Sellers can specify up to four domestic shipping services (with four ShippingServiceOptions containers), so valid values are 1, 2, 3, and 4. A shipping service with a ShippingServicePriority value of 1 appears at the top. Conversely, a shipping service with a ShippingServicePriority value of 4 appears at the bottom of a list of four shipping service options.

This field is applicable to Flat and Calculated shipping. This field is not applicable to Half.com listings.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ShippingServiceSelected
  .ShippingSurcharge
AmountType (double) Conditionally An additional fee to charge US buyers who have the item shipped via UPS or FedEx to Alaska, Hawaii or Puerto Rico. Can only be assigned a value for the eBay US site and for items in the Parts and Accessories category of the eBay Motors site. Only returned if set. If some line items in an order have a surcharge, surcharge is added only for those line items. Flat rate shipping only.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ShippingServiceSelected
  .ShippingSurcharge
  [ attribute currencyID ]
CurrencyCodeType Conditionally An additional fee to charge US buyers who have the item shipped via UPS or FedEx to Alaska, Hawaii or Puerto Rico. Can only be assigned a value for the eBay US site and for items in the Parts and Accessories category of the eBay Motors site. Only returned if set. If some line items in an order have a surcharge, surcharge is added only for those line items. Flat rate shipping only.

For a list of possible enumeration values, see CurrencyCodeType.
TransactionArray.Transaction
  .ShippingServiceSelected
  .ShippingTimeMax
int Conditionally The maximum guaranteed number of days the shipping carrier will take to ship an item (not including the time it takes the seller to deliver the item to the shipping carrier). See Enabling Get It Fast. Not applicable to Half.com.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ShippingServiceSelected
  .ShippingTimeMin
int Conditionally The minimum guaranteed number of days in which the shipping carrier can ship an item (not including the time it takes the seller to deliver the item to the shipping carrier). See Enabling Get It Fast. Not applicable to Half.com.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .Status
TransactionStatusType Conditionally Container consisting of status details of an order line item, including payment information. Several of these fields change values during the checkout flow. See TransactionStatusType for its child elements.

For GetOrders, only the IntegratedMerchantCreditCardEnabled, PaymentHoldStatus, and PaymentMethodUsed child elements are returned. The fields indicating the status of the order are actually found in the OrderArray.Order.CheckoutStatus container.

Not applicable to Half.com.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .Status.BuyerSelectedShipping
boolean Conditionally Indicates whether the buyer has selected shipping details during checkout. False indicates that the shipping service was selected by eBay for the buyer. For example, if the buyer has not yet completed the Review Your Purchase page, he has not picked a shipping service. If it is false, the application should ignore ShippingServiceCost and ShippingServiceSelected (items whose values are defaulted by eBay).

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .Status.CheckoutStatus
CheckoutStatusCodeType Conditionally Indicates the current status of the checkout flow for the order.

Applicable values:

•   BuyerRequestsTotal

(out) Buyer requests total from seller.

•   CheckoutComplete

(out) Checkout complete.

•   CheckoutIncomplete

(out) Checkout incomplete.

•   CustomCode

(out) Reserved for future use.

•   SellerResponded

(out) Seller responded to buyer's request.




DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .Status.CompleteStatus
CompleteStatusCodeType Conditionally Indicates whether checkout is complete, incomplete, or pending for an order.

Applicable values:

•   Complete

(in/out) The order is complete. Generally speaking, an order is complete when payment from the buyer has been initiated and processed.

Note: If the PaymentMethodUsed is 'CashOnPickup', the CheckoutStatus.Status value in GetOrders will be 'Complete' right at Checkout, even though the seller may not have been officially paid yet. The CheckoutStatus.Status value in GetOrders will remain as 'Complete' even if the seller uses ReviseCheckoutStatus to change the checkout status to Pending. However, the eBayPaymentStatus value in GetOrders will change from 'NoPaymentFailure' to 'PaymentInProcess'.

•   CustomCode

(in/out) Reserved for internal or future use

•   Incomplete

(in/out) The order is incomplete. Generally speaking, an order is incomplete when payment from the buyer has yet to be initiated.

•   Pending

(in/out) The order is pending. Generally speaking, an order is pending when payment from the buyer has been initiated but has yet to be fully processed.

Note: If the PaymentMethod is CashOnPickup, the CheckoutStatus.Status value in GetOrders will read Complete right at Checkout, even though the seller may not have been officially paid yet. The CheckoutStatus.Status value in GetOrders will remain as Complete even if the seller uses ReviseCheckoutStatus to change the checkout status to Pending. However, the eBayPaymentStatus value in GetOrders will change from NoPaymentFailure to PaymentInProcess.




DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .Status
  .eBayPaymentMismatchDetails
eBayPaymentMismatchDetailsType Conditionally This container is returned when a buyer's payment does not match the total cost of an order going through the new eBay payment process. This container is only applicable for German and Austrian orders going through the new eBay payment process, and when the buyer has selected EFT as the payment method.

Note: The introduction of the new eBay payment process for the entire German and Austrian eBay marketplace has been delayed until further notice.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .Status
  .eBayPaymentMismatchDetails
  .ActionRequiredBy
dateTime Conditionally This dateTime value indicates the date by which the seller needs to accept or reject the overpayment/underpayment. If the seller doesn't take action by this date, eBay returns the payment to the buyer and essentially voids the sale. This field is always returned with the eBayPaymentMismatchDetails container.

Note: The introduction of the new eBay payment process for the entire German and Austrian eBay marketplace has been delayed until further notice.


DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .Status
  .eBayPaymentMismatchDetails
  .MismatchAmount
AmountType (double) Conditionally This value indicates the amount in which the buyer's payment was either over (MismatchType=OverPayment) or under (MismatchType=UnderPayment) the actual total cost of an order going through the new eBay payment process.

Note: The introduction of the new eBay payment process for the entire German and Austrian eBay marketplace has been delayed until further notice.


DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .Status
  .eBayPaymentMismatchDetails
  .MismatchAmount
  [ attribute currencyID ]
CurrencyCodeType Always This value indicates the amount in which the buyer's payment was either over (MismatchType=OverPayment) or under (MismatchType=UnderPayment) the actual total cost of an order going through the new eBay payment process.

Note: The introduction of the new eBay payment process for the entire German and Austrian eBay marketplace has been delayed until further notice.


For a list of possible enumeration values, see CurrencyCodeType.
TransactionArray.Transaction
  .Status
  .eBayPaymentMismatchDetails
  .MismatchType
MismatchTypeCodeType Conditionally This enumeration value indicates if the buyer has overpaid or underpaid for an order going through the new eBay payment process. This field is always returned with the eBayPaymentMismatchDetails container.

Note: The introduction of the new eBay payment process for the entire German and Austrian eBay marketplace has been delayed until further notice.


Applicable values:

•   CustomCode

(out) Reserved for internal or future use

•   OverPayment

(out) This value indicates that the buyer paid more than the required amount.

•   UnderPayment

(out) This value indicates that the buyer paid less than the required amount.




DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .Status.eBayPaymentStatus
PaymentStatusCodeType Conditionally Indicates the success or failure of the buyer's online payment for an order. Applicable for the payment method that the buyer chose for the order. If the payment failed, the value returned indicates the reason for the failure. Output only.

Applicable values:

•   BuyerCreditCardFailed

(out) This value indicates that the buyer's payment via a credit card failed. This value is only applicable if the seller accepts credit cards as a form of payment.

•   BuyerECheckBounced

(out) This value indicates that the buyer's eCheck bounced. This value is only applicable if the seller accepts eChecks as a form of payment.

•   BuyerFailedPaymentReportedBySeller

(out) This value indicates that the seller reported the buyer's payment as failed.

•   CustomCode

(out) Reserved for internal or future use.

•   NoPaymentFailure

(out) This value indicates that the buyer's payment for the order has cleared. A CheckoutStatus.eBayPaymentStatus value of 'NoPaymentFailure' and a CheckoutStatus.Status value of 'Complete' indicates that checkout is complete.

•   PaymentInProcess

(out) This value indicates that the buyer's non-PayPal payment is in process. This value is only applicable if the buyer has selected a payment method other than PayPal.

•   PayPalPaymentInProcess

(out) This value indicates that the buyer's PayPal payment is in process. This value is only applicable if the buyer has selected PayPal as the payment method.




DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .Status.InquiryStatus
InquiryStatusCodeType Conditionally This field gives the status of a buyer's request for shipment tracking information. This field is only returned if the buyer has requested tracking information from the seller, or has escalated an existing request.

Applicable values:

•   CustomCode

(out) Reserved for internal or future use.

•   Invalid

(out) This value indicates that the shipment tracking request is invalid.

•   NotApplicable

(out) This value indicates that the shipment tracking request is not applicable.

•   TrackInquiryClosedNoRefund

(out) This value indicates that a shipment tracking request was closed with no refund issued to the buyer.

•   TrackInquiryClosedWithRefund

(out) This value indicates that a shipment tracking request was closed with a refund issued to the buyer.

•   TrackInquiryEscalatedClosedNoRefund

(out) This value indicates that a shipment tracking request was escalated to an eBay Buyer Protection case, but it was closed with no refund issued to the buyer.

•   TrackInquiryEscalatedClosedWithRefund

(out) This value indicates that a shipment tracking request was escalated to an eBay Buyer Protection case, but it was closed with a refund issued to the buyer.

•   TrackInquiryEscalatedPendingBuyer

(out) This value indicates that a shipment tracking request was escalated to an eBay Buyer Protection case, and it is pending a response from the buyer.

•   TrackInquiryEscalatedPendingCS

(out) This value indicates that a shipment tracking request was escalated to an eBay Buyer Protection case, and it is pending a response from eBay Customer Support.

•   TrackInquiryEscalatedPendingSeller

(out) This value indicates that a shipment tracking request was escalated to an eBay Buyer Protection case, and it is pending a response from the buyer.

•   TrackInquiryPendingBuyerResponse

(out) This value indicates that the shipment tracking request is pending a response from the buyer.

•   TrackInquiryPendingSellerResponse

(out) This value indicates that the shipment tracking request is pending a response from the seller.




DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .Status
  .IntegratedMerchantCreditCardEnabled
boolean Conditionally Indicates whether the item can be paid for through a payment gateway account. If IntegratedMerchantCreditCardEnabled is true, then integrated merchant credit card (IMCC) is enabled for credit cards because the seller has a payment gateway (Payflow) account. Therefore, if IntegratedMerchantCreditCardEnabled is true, and AmEx, Discover, or VisaMC is returned for an item, then on checkout, an online credit-card payment is processed through a payment gateway account.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .Status.LastTimeModified
dateTime Conditionally Indicates date and time an order's status was last updated (in GMT).

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .Status.PaymentHoldStatus
PaymentHoldStatusCodeType Conditionally This field indicates the type and/or status of a payment hold on the item.

Applicable values:

•   CustomCode

(out) This value is reserved for internal or future use.

•   MerchantHold

(out) This value indicates a possible issue with a seller. If this value is returned, the TransactionArray.Transaction.SellerPaidStatus field is returned as PaidWithPayPal in GetMyeBaySelling, and the TransactionArray.Transaction.BuyerPaidStatus field is returned as PaidWithPayPal in GetMyeBayBuying.

•   NewSellerHold

(out) This value indicates that there is a "new seller hold" on the item. PayPal may hold payments to a new seller for up to 21 days. Sellers are considered "new" until they have met all three criteria below:

  • More than 90 days have passed since first successful sale
  • More than 25 domestic sales
  • More than $250.00 in total sales

•   None

(out) This value indicates that there is no payment hold on the item.

•   PaymentHold

(out) This value indicates that there is a payment hold on the item.

•   PaymentReview

(out) This value indicates a possible issue with a buyer. If this value is returned, the TransactionArray.Transaction.SellerPaidStatus field is returned as NotPaid in GetMyeBaySelling, and the TransactionArray.Transaction.BuyerPaidStatus field is returned as PaidWithPayPal in GetMyeBayBuying.

•   ReleaseConfirmed

(out) This value indicates that the funds are available in the seller's PayPal account.

•   Released

(out) This value indicates that a payment hold on the item has been released.

•   ReleasePending

(out) This value indicates that the process for the release of funds for the order has been initiated.




DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.

See Holds on PayPal Payments.

TransactionArray.Transaction
  .Status.PaymentMethodUsed
BuyerPaymentMethodCodeType Conditionally The payment method that the buyer selected to pay for the order. If checkout is not yet complete, PaymentMethodUsed is set to whatever the buyer selected as his or her preference on the Review Your Purchase page.

Applicable values: See PaymentMethodUsed.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .Status.ReturnStatus
ReturnStatusCodeType Conditionally This field gives the status of a buyer's return request. This field is only returned if the buyer has initiated a return, or has escalated an existing return.

Applicable values:

•   CustomCode

(out) Reserved for internal or future use.

•   Invalid

(out) This value indicates that the return request is invalid.

•   NotApplicable

(out) This value indicates that the return request is not applicable.

•   ReturnClosedEscalated

(out) This value indicates that a return was escalated to an eBay Buyer Protection case and closed.

•   ReturnClosedNoRefund

(out) This value indicates that a return request was closed with a refund issued to the buyer.

•   ReturnClosedWithRefund

(out) This value indicates that a return request was closed with no refund issued to the buyer.

•   ReturnDelivered

(out) This value indicates that the seller has received the item(s) that the buyer return shipped.

•   ReturnEscalatedClosedNoRefund

(out) This value indicates that a return was escalated to an eBay Buyer Protection case, but it was closed with no refund issued to the buyer.

•   ReturnEscalatedClosedWithRefund

(out) This value indicates that a return was escalated to an eBay Buyer Protection case, but it was closed with a refund issued to the buyer.

•   ReturnEscalatedPendingBuyer

(out) This value indicates that a return was escalated to an eBay Buyer Protection case, and it is pending a response from the buyer.

•   ReturnEscalatedPendingCS

(out) This value indicates that a return was escalated to an eBay Buyer Protection case, and it is pending a response from eBay Customer Support.

•   ReturnEscalatedPendingSeller

(out) This value indicates that a return was escalated to an eBay Buyer Protection case, and it is pending a response from the seller.

•   ReturnOpen

(out) This value indicates that a return request was successfully opened.

•   ReturnRequestPendingApproval

(out) This value indicates that the return request is pending approval.

•   ReturnRequestRejected

(out) This value indicates that the return request was rejected.

•   ReturnShipped

(out) This value indicates that the buyer has return shipped the item(s) in the return request back to the seller.




DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .Taxes
TaxesType Conditionally

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .Taxes.TaxDetails
TaxDetailsType Conditionally,
repeatable: [0..*]
Container consisting of detailed sales tax information for an order line item, including the tax type and description, sales tax on the item cost, and sales tax related to shipping and handling.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .Taxes.TaxDetails.Imposition
TaxTypeCodeType Conditionally This field indicates the sales tax type. A separate TaxDetails container is required for each unique imposition (tax type).

Applicable values:

•   CustomCode

(out) Reserved for internal or future use.

•   SalesTax

(out) A standard sales tax charge.

•   WasteRecyclingFee

(out) A charge for an electronic waste recycling fee.




DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .Taxes.TaxDetails.TaxAmount
AmountType (double) Conditionally This value is the total amount of sales tax for the order line item for the corresponding impositiion (tax type).

TaxAmount = TaxOnSubtotalAmount + TaxOnShippingAmount + TaxOnHandlingAmount

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .Taxes.TaxDetails.TaxAmount
  [ attribute currencyID ]
CurrencyCodeType Always This value is the total amount of sales tax for the order line item for the corresponding impositiion (tax type).

TaxAmount = TaxOnSubtotalAmount + TaxOnShippingAmount + TaxOnHandlingAmount

For a list of possible enumeration values, see CurrencyCodeType.
TransactionArray.Transaction
  .Taxes.TaxDetails.TaxCode
string Conditionally This value is the actual tax ID for the buyer. This field will generally only be returned if a seller on the Italy or Spain sites required that the buyer supply a tax ID during the checkout process. If the Order.BuyerTaxIdentifier container is returned, the type of tax ID can be found in the BuyerTaxIdentifier.Type field.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .Taxes.TaxDetails
  .TaxDescription
TaxDescriptionCodeType Conditionally This field indicates the description of the sales tax.

Applicable values:

•   CustomCode

(out) Reserved for internal or future use.

•   ElectronicWasteRecyclingFee

(out) A charge for an electronic waste recycling fee.

•   SalesTax

(out) A standard sales tax charge.

•   TireRecyclingFee

(out) A charge for a tire recycling fee.




DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .Taxes.TaxDetails
  .TaxOnHandlingAmount
AmountType (double) Conditionally This value is the amount of sales tax applied based on handling costs for the order line item for the corresponding impositiion (tax type).

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .Taxes.TaxDetails
  .TaxOnHandlingAmount
  [ attribute currencyID ]
CurrencyCodeType Always This value is the amount of sales tax applied based on handling costs for the order line item for the corresponding impositiion (tax type).

For a list of possible enumeration values, see CurrencyCodeType.
TransactionArray.Transaction
  .Taxes.TaxDetails
  .TaxOnShippingAmount
AmountType (double) Conditionally This value is the amount of sales tax applied based on shipping costs for the order line item for the corresponding impositiion (tax type).

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .Taxes.TaxDetails
  .TaxOnShippingAmount
  [ attribute currencyID ]
CurrencyCodeType Always This value is the amount of sales tax applied based on shipping costs for the order line item for the corresponding impositiion (tax type).

For a list of possible enumeration values, see CurrencyCodeType.
TransactionArray.Transaction
  .Taxes.TaxDetails
  .TaxOnSubtotalAmount
AmountType (double) Conditionally This value is the amount of sales tax applied based on the unit cost of the order line item for the corresponding impositiion (tax type).

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .Taxes.TaxDetails
  .TaxOnSubtotalAmount
  [ attribute currencyID ]
CurrencyCodeType Always This value is the amount of sales tax applied based on the unit cost of the order line item for the corresponding impositiion (tax type).

For a list of possible enumeration values, see CurrencyCodeType.
TransactionArray.Transaction
  .Taxes.TotalTaxAmount
AmountType (double) Conditionally This value indicates the total tax amount for the order line item, including the sales tax on the item, the sales tax on shipping and handling, and any electronic waste recycling fee.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .Taxes.TotalTaxAmount
  [ attribute currencyID ]
CurrencyCodeType Always This value indicates the total tax amount for the order line item, including the sales tax on the item, the sales tax on shipping and handling, and any electronic waste recycling fee.

For a list of possible enumeration values, see CurrencyCodeType.
TransactionArray.Transaction
  .TransactionID
string Always Unique identifier for an eBay order line item (transaction). An order line item is created once there is a commitment from a buyer to purchase an item. Since an auction listing can only have one order line item during the duration of the listing, the TransactionID for auction listings is always 0. Along with its corresponding ItemID, a TransactionID is used and referenced during an order checkout flow and after checkout has been completed.

Applicable to Half.com (for GetOrders only).
Max length: 19 (Note: The eBay database specifies 38. Transaction IDs are usually 9 to 12 digits.).

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .TransactionPrice
AmountType (double) Conditionally The price of the order line item (transaction). This amount does not take into account shipping, sales tax, and other costs related to the order line item. If multiple units were purchased through a non- variation, fixed-price listing, consider this value the per-unit price. In this case, the TransactionPrice would be multiplied by the Transaction.QuantityPurchased value.

For eBay Motors, TransactionPrice is the deposit amount. For Best Offers, this is the seller-accepted per-item price.

Applicable to Half.com (for GetOrders).

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .TransactionPrice
  [ attribute currencyID ]
CurrencyCodeType Always The price of the order line item (transaction). This amount does not take into account shipping, sales tax, and other costs related to the order line item. If multiple units were purchased through a non- variation, fixed-price listing, consider this value the per-unit price. In this case, the TransactionPrice would be multiplied by the Transaction.QuantityPurchased value.

For eBay Motors, TransactionPrice is the deposit amount. For Best Offers, this is the seller-accepted per-item price.

Applicable to Half.com (for GetOrders).

For a list of possible enumeration values, see CurrencyCodeType.
TransactionArray.Transaction
  .TransactionSiteID
SiteCodeType Conditionally The site upon which the order line item (transaction) was created.

Applicable values: See TransactionSiteID.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .UnpaidItem
UnpaidItemType Conditionally Unpaid Item Details.

DetailLevel: ReturnAll.
TransactionArray.Transaction
  .UnpaidItem.Status
UnpaidItemCaseStatusTypeCodeType Conditionally This field indicates the status of the Unpaid Item case. This field is always returned with the UnpaidItem container.

Applicable values:

•   ClosedWithoutPayment

(out) This value indicates that the Unpaid Item case is closed with no payment received from the buyer.

•   ClosedWithPayment

(out) This value indicates that the Unpaid Item case is closed with payment received from the buyer.

•   CustomCode

(out) This value is reserved for future or internal use.

•   Open

(out) This value indicates that the Unpaid Item case is open.




DetailLevel: ReturnAll.
TransactionArray.Transaction
  .UnpaidItem.Type
UnpaidItemCaseOpenTypeCodeType Conditionally This field indicates if the Unpaid Item case was opened manually by the customer or opened automatically by eBay's Unpaid Item Assistant feature. This field is always returned with the UnpaidItem container.

Applicable values:

•   Auto

(out) This value indicates that the Unpaid Item case was opened automatically through eBay's Unpaid Item Assistant feature.

•   CustomCode

(out) This value is reserved for future or internal use.

•   Manual

(out) This value indicates that the seller opened an Unpaid Item case manually through the Resolution Center or by using the Trading API's AddDispute call.




DetailLevel: ReturnAll.

See Using Unpaid Item Assistant for more information about managing the Unpaid Item Assistant feature.

TransactionArray.Transaction
  .Variation
VariationType Conditionally In a fixed-priced listing, a seller can offer variations of the same item. For example, the seller could create a fixed-priced listing for a t-shirt design and offer the shirt in different colors and sizes. In this case, each color and size combination is a separate variation. Each variation can have a different quantity and price. Due to the possible price differentiation, buyers can buy multiple items from this listing at the same time, but all of the items must be of the same variation. One order line item is created whether one or multiple items of the same variation are purchased.

The Variation node contains information about which variation was purchased. Therefore, applications that process orders should always check to see if this node is present.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .Variation.SKU
SKUType (string) Conditionally A SKU (stock keeping unit) is an identifier defined by a seller. It is only intended for the seller's use (not for buyers). Many sellers assign a SKU to an item of a specific type, size, and color. For the seller's convenience, eBay preserves the SKU on the variation, and also on corresponding order line items. This enables you (as a seller) use the SKU to reconcile your eBay inventory with your own inventory system instead of using the variation specifics. It is a good idea to track how many items of each type, size, and color are selling so that you can restock your shelves or update the variation quantity on eBay according to customer demand. (eBay does not use the SKU.)

If specified, all SKU values must be unique within the Variations node. That is, no two variations within the same listing can have the same SKU.

If you set Item.InventoryTrackingMethod to true, the variation SKU values are required and they must be unique across all the seller's active listings.

For GetItem and related calls: Only returned if the seller specified a SKU for the variation.
Max length: 80.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.

See Describing Variations in a Listing.

TransactionArray.Transaction
  .Variation.VariationSpecifics
NameValueListArrayType Conditionally,
repeatable: [2..5]
A list of name/value pairs that uniquely identify the variation within the listing. All variations must specify the same set of names, and each variation must provide a unique combination of values for those names. For example, if the items vary by color and size, then every variation must specify Color and Size as names, and no two variations can specify the same combination of color and size values.

When you revise a listing that includes variations, you can change names in variation specifics by using ModifyNameList. You can also add, delete, or replace individual variations as needed to match your current inventory. Use the Variation.Delete field to delete a variation that has no sales (order line items). If the variation has sales, then set the Quantity to 0.

For GetSellerEvents To keep the GetSellerEvents response smaller, variation specifics are not returned if the variation has a SKU. If the variation has no SKU, then variation specifics are returned instead. Optionally, you can pass IncludeVariationSpecifics as true in the request to force variation specifics to be returned, even when the SKU is returned.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.

See:
    Describing Variations in a Listing
    Revising and Relisting with Variations

TransactionArray.Transaction
  .Variation.VariationSpecifics
  .NameValueList
NameValueListType Conditionally,
repeatable: [0..*]
For the AddItem family of calls: Contains the name and value(s) for an Item Specific. Only required when the ItemSpecifics container is specified.

For the AddFixedPriceItem family of calls: The same NameValueList schema is used for the ItemSpecifics node, the VariationSpecifics node, and the VariationSpecifcsSet node.

If the listing has varations, any name that you use in the VariationSpecifics and VariationSpecificsSet nodes can't be used in the ItemSpecifics node.

When you list with Item Variations:
a) Specify shared Item Specifics (e.g., Brand) in the ItemSpecifics node.
b) Specify up to five VariationSpecifics in each Variation node.
c) Specify all applicable names with all their supported values in the VariationSpecificSet node.

See the Variation sample in the AddFixedPriceItem call reference for examples.

For PlaceOffer: Required if the item being purchased includes Item Variations.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .Variation.VariationSpecifics
  .NameValueList.Name
string Conditionally A name in a name/value pair.

For the AddItem and AddFixedPriceItem families of calls: In the Item.ItemSpecifics context, this can be any name that the seller wants to use. However, to help buyers find items more easily, it is a good idea to try to use a recommended name when possible (see GetCategorySpecifics or GetItemRecommendations). You can't specify the same name twice within the same listing.

For the AddFixedPriceItem family of calls: In the VariationSpecifics context, this can be any name that the seller wants to use, unless the VariationsEnabled flag is false for the name in the GetCategorySpecifics response. For example, for some categories eBay may recommend that you only use "Brand" as a shared name at the Item level, not in variations.

For GetCategorySpecifics and GetItemRecommendations: This is a recommended (popular) name to use for items in the specified category (e.g., "Brand" might be recommended, not "Manufacturer").

For PlaceOffer: Required if the item being purchased includes Item Variations.
Max length: 40.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .Variation.VariationSpecifics
  .NameValueList.Value
string Conditionally,
repeatable: [0..*]
A value associated with the name.

For the AddItem family of calls: If you specify multiple values for Item Specifics, eBay only stores the first one, unless GetCategorySpecifics or GetItemRecommendations indicates that the corresponding name supports multiple values.

For the AddFixedPriceItem family of calls: If you specify multiple values for Item Specifics or Variation Specifics, eBay only stores the first one, unless GetCategorySpecifics or GetItemRecommendations indicates that the corresponding name supports multiple values.

In VariationSpecificSet, you typically specify multiple Value fields for each name. For example, if Name=Size, you would specify all size values that you wan to offer in the listing.

For GetCategorySpecifics and GetItemRecommendations: The most highly recommended values are returned first. For these calls, Value is only returned when recommended values are available.

For PlaceOffer: Required if the item being purchased includes Item Variations.
Max length: 50.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .Variation.VariationTitle
string Conditionally The title of the variation. This is a concatenation of the listing title plus the values (no names) from the VariationSpecifics. For example, if the Title is "Polo Shirt" and the variation is for a medium pink shirt, the variation title could be "Polo Shirt[Pink,M]. PayPal may also use this value to identify item variations(for buyers and sellers).

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .Variation
  .VariationViewItemURL
anyURI Conditionally URL for the variation on eBay. This links to eBay's View Item page, with the page configured to show details of the specified variation. The syntax of this URL is similar to Item.ViewItemURL (not optimized for natural search).

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionsPerPage int Always This value indicates the number of order line items returned per page (per call) and is controlled by the Pagination.EntriesPerPage value passed in the call request. Unless it is the last (or possibly only) page of data (HasMoreTransactions=false), the TransactionsPerPage value should equal the Pagination.EntriesPerPage value passed in the call request.

Note: Due to the fact that item data on the eBay platform has a shorter retention period than order data, it is possible that some retrieved pages will contain no data. For pages that contain no data, the ReturnedTransactionCountActual value will be '0'. It is also possible that pages 2, 3, and 4 have no data, but pages 1 and 5 do have data. Therefore, we recommend that you scroll through each page of data (making subsequent GetSellerTransactions calls and incrementing the Pagination.PageNumber value by '1' each time) until you reach the last page, indicated by HasMoreTransactions=false.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
Standard Output Fields  
Ack AckCodeType Always A token representing the application-level acknowledgement code that indicates the response status (e.g., success). The AckCodeType list specifies the possible values for the Ack field.

Applicable values:

•   CustomCode

(out) Reserved for internal or future use.

•   Failure

(out) Request processing failed

•   Success

(out) Request processing succeeded

•   Warning

(out) Request processing completed with warning information being included in the response message


(Not all values in AckCodeType apply to this field.)
Build string Always This refers to the specific software build that eBay used when processing the request and generating the response. This includes the version number plus additional information. eBay Developer Support may request the build information when helping you resolve technical issues.
CorrelationID string Conditionally Most Trading API calls support a MessageID element in the request and a CorrelationID element in the response. If you pass in a MessageID in a request, the same value will be returned in the CorrelationID field in the response. Pairing these values can help you track and confirm that a response is returned for every request and to match specific responses to specific requests. If you do not pass a MessageID value in the request, CorrelationID is not returned.

Note: GetCategories is designed to retrieve very large sets of metadata that change once a day or less often. To improve performance, these calls return cached responses when you request all available data (with no filters). When this occurs, the MessageID and CorrelationID fields aren't applicable. However, if you specify an input filter to reduce the amount of data returned, the calls retrieve the latest data (not cached). When this occurs, MessageID and CorrelationID are applicable.
Errors ErrorType Conditionally,
repeatable: [0..*]
A list of application-level errors (if any) that occurred when eBay processed the request.

See Error Handling.

Errors.ErrorClassification ErrorClassificationCodeType Conditionally API errors are divided between two classes: system errors and request errors.

Applicable values:

•   CustomCode

(out) Reserved for internal or future use.

•   RequestError

(out) An error has occurred either as a result of a problem in the sending application or because the application's end-user has attempted to submit invalid data (or missing data). In these cases, do not retry the request. The problem must be corrected before the request can be made again. If the problem is due to something in the application (such as a missing required field), the application must be changed. If the problem is a result of end-user data, the application must alert the end-user to the problem and provide the means for the end-user to correct the data. Once the problem in the application or data is resolved, resend the request to eBay with the corrected data.

•   SystemError

(out) Indicates that an error has occurred on the eBay system side, such as a database or server down. An application can retry the request as-is a reasonable number of times (eBay recommends twice). If the error persists, contact Developer Technical Support. Once the problem has been resolved, the request may be resent in its original form.


Errors.ErrorCode token Conditionally A unique code that identifies the particular error condition that occurred. Your application can use error codes as identifiers in your customized error-handling algorithms. See the "Errors by Number" document.
Errors.ErrorParameters ErrorParameterType Conditionally,
repeatable: [0..*]
This optional element carries a list of context-specific error variables that indicate details about the error condition. These are useful when multiple instances of ErrorType are returned.
Errors.ErrorParameters
  [ attribute ParamID ]
string Conditionally This optional element carries a list of context-specific error variables that indicate details about the error condition. These are useful when multiple instances of ErrorType are returned.
Errors.ErrorParameters.Value string Conditionally The value of the variable (e.g., the attribute set ID)
Errors.LongMessage string Conditionally A more detailed description of the condition that raised the error.
Errors.SeverityCode SeverityCodeType Conditionally Indicates whether the error is a severe error (causing the request to fail) or an informational error (a warning) that should be communicated to the user.

Applicable values:

•   CustomCode

(out) Reserved for internal or future use.

•   Error

(out) The request that triggered the error was not processed successfully. When a serious application-level error occurs, the error is returned instead of the business data.

If the source of the problem is within the application (such as a missing required element), change the application before you retry the request.

  • If the problem is due to end-user input data, please alert the end-user to the problem and provide the means for them to correct the data. Once the problem in the application or data is resolved, you can attempt to re-send the request to eBay.
  • If the source of the problem is on eBay's side, An application can retry the request as-is a reasonable number of times (eBay recommends twice). If the error persists, contact Developer Technical Support. Once the problem has been resolved, the request may be resent in its original form.


See the Compatible Application Check section of the eBay Features Guide for more information.

•   Warning

(out) The request was processed successfully, but something occurred that may affect your application or the user. For example, eBay may have changed a value the user sent in. In this case, eBay returns a normal, successful response and also returns the warning.

When a warning occurs, the error is returned in addition to the business data. In this case, you do not need to retry the request (as the original request was successful). However, depending on the cause or nature of the warning, you might need to contact either the end user or eBay to effect a long term solution to the problem to prevent it from reoccurring in the future.


Errors.ShortMessage string Conditionally A brief description of the condition that raised the error.
HardExpirationWarning string Conditionally Expiration date of the user's authentication token. Only returned within the 7-day period prior to a token's expiration. To ensure that user authentication tokens are secure and to help avoid a user's token being compromised, tokens have a limited life span. A token is only valid for a period of time (set by eBay). After this amount of time has passed, the token expires and must be replaced with a new token.
Timestamp dateTime Always This value represents the date and time when eBay processed the request. The time zone of this value is GMT and the format is the ISO 8601 date and time format (YYYY-MM-DDTHH:MM:SS.SSSZ). See the Time Values section in the eBay Features Guide for information about this time format and converting to and from the GMT time zone.

Note: GetCategories and other Trading API calls are designed to retrieve very large sets of metadata that change once a day or less often. To improve performance, these calls return cached responses when you request all available data (with no filters). When this occurs, this time value reflects the time the cached response was created. Thus, this value is not necessarily when the request was processed. However, if you specify an input filter to reduce the amount of data returned, the calls retrieve the latest data (not cached). When this occurs, this time value does reflect when the request was processed.
Version string Always The version of the response payload schema. Indicates the version of the schema that eBay used to process the request. See the Standard Data for All Calls section in the eBay Features Guide for information on using the response version when troubleshooting CustomCode values that appear in the response.



Back to top

GetSellerTransactions Detail Controls


DetailLevel

The DetailLevel input field influences which call-specific fields may be returned. (All standard output fields are returned regardless of DetailLevel.)

The none column indicates the fields that are returned when you do not specify a DetailLevel.

YThe field is always returned.
(Y)The field is conditionally returned. See the field documentation for clarification of conditions.
-The field is not returned.

Output Field none ItemReturnDescription ReturnAll
HasMoreTransactionsYYY
PageNumberYYY
PaginationResultYYY
PaginationResult.TotalNumberOfEntriesYYY
PaginationResult.TotalNumberOfPagesYYY
PayPalPreferredYYY
ReturnedTransactionCountActualYYY
SellerY-Y
Seller.AboutMePageY-Y
Seller.CharityAffiliations(Y)-(Y)
Seller.CharityAffiliations.CharityID(Y)-(Y)
Seller.eBayGoodStandingY-Y
Seller.EIASTokenY-Y
Seller.EmailY-Y
Seller.FeedbackPrivateY-Y
Seller.FeedbackRatingStarY-Y
Seller.FeedbackScoreY-Y
Seller.IDVerifiedY-Y
Seller.NewUserY-Y
Seller.PositiveFeedbackPercent(Y)-(Y)
Seller.RegistrationAddress(Y)-(Y)
Seller.RegistrationAddress.AddressAttribute(Y)-(Y)
Seller.RegistrationAddress.AddressID(Y)-(Y)
Seller.RegistrationAddress.AddressUsage(Y)-(Y)
Seller.RegistrationAddress.ExternalAddressID(Y)-(Y)
Seller.RegistrationAddress.Name(Y)-(Y)
Seller.RegistrationDateY-Y
Seller.SellerInfoY-Y
Seller.SellerInfo.AllowPaymentEditY-Y
Seller.SellerInfo.CheckoutEnabledY-Y
Seller.SellerInfo.CIPBankAccountStoredY-Y
Seller.SellerInfo.GoodStandingY-Y
Seller.SellerInfo.MerchandizingPrefY-Y
Seller.SellerInfo.QualifiesForB2BVATY-Y
Seller.SellerInfo.SafePaymentExemptYYY
Seller.SellerInfo.SellereBayPaymentProcessConsent(Y)-(Y)
Seller.SellerInfo.SellereBayPaymentProcessConsent.PayoutMethod(Y)-(Y)
Seller.SellerInfo.SellereBayPaymentProcessConsent.PayoutMethodSet(Y)-(Y)
Seller.SellerInfo.SellereBayPaymentProcessConsent
  .UserAgreementInfo
(Y)-(Y)
Seller.SellerInfo.SellereBayPaymentProcessConsent
  .UserAgreementInfo.AcceptedTime
(Y)-(Y)
Seller.SellerInfo.SellereBayPaymentProcessConsent
  .UserAgreementInfo.SellereBayPaymentProcessEnableTime
(Y)-(Y)
Seller.SellerInfo.SellereBayPaymentProcessConsent
  .UserAgreementInfo.SellereBayPaymentProcessStatus
(Y)-(Y)
Seller.SellerInfo.SellereBayPaymentProcessConsent
  .UserAgreementInfo.Site
(Y)-(Y)
Seller.SellerInfo.SellereBayPaymentProcessConsent
  .UserAgreementInfo.UserAgreementURL
(Y)-(Y)
Seller.SellerInfo.SellereBayPaymentProcessStatus(Y)-(Y)
Seller.SellerInfo.SellerGuaranteeLevel(Y)-(Y)
Seller.SellerInfo.SellerLevelY-Y
Seller.SellerInfo.StoreOwnerY-Y
Seller.SellerInfo.StoreURLY-Y
Seller.SellerInfo.TopRatedSeller(Y)-(Y)
Seller.SiteY-Y
Seller.StatusY-Y
Seller.UserIDY-Y
Seller.UserIDChangedY-Y
Seller.UserIDLastChangedY-Y
Seller.VATStatusY-Y
TransactionArray(Y)-(Y)
TransactionArray.Transaction(Y)-(Y)
TransactionArray.Transaction.ActualHandlingCost(Y)(Y)(Y)
TransactionArray.Transaction.ActualShippingCost(Y)(Y)(Y)
TransactionArray.Transaction.AdjustmentAmount(Y)(Y)(Y)
TransactionArray.Transaction.AmountPaid(Y)(Y)(Y)
TransactionArray.Transaction.BestOfferSale(Y)(Y)(Y)
TransactionArray.Transaction.Buyer(Y)-(Y)
TransactionArray.Transaction.Buyer.AboutMePage(Y)-(Y)
TransactionArray.Transaction.Buyer.BuyerInfo(Y)-(Y)
TransactionArray.Transaction.Buyer.BuyerInfo.BuyerTaxIdentifier(Y)-(Y)
TransactionArray.Transaction.Buyer.BuyerInfo.BuyerTaxIdentifier
  .Attribute
(Y)(Y)(Y)
TransactionArray.Transaction.Buyer.BuyerInfo.BuyerTaxIdentifier
  .ID
(Y)-(Y)
TransactionArray.Transaction.Buyer.BuyerInfo.BuyerTaxIdentifier
  .Type
(Y)(Y)(Y)
TransactionArray.Transaction.Buyer.BuyerInfo.ShippingAddress(Y)-(Y)
TransactionArray.Transaction.Buyer.BuyerInfo.ShippingAddress
  .AddressAttribute
(Y)-(Y)
TransactionArray.Transaction.Buyer.BuyerInfo.ShippingAddress
  .AddressID
(Y)-(Y)
TransactionArray.Transaction.Buyer.BuyerInfo.ShippingAddress
  .AddressUsage
(Y)-(Y)
TransactionArray.Transaction.Buyer.BuyerInfo.ShippingAddress
  .CityName
(Y)-(Y)
TransactionArray.Transaction.Buyer.BuyerInfo.ShippingAddress
  .Country
(Y)-(Y)
TransactionArray.Transaction.Buyer.BuyerInfo.ShippingAddress
  .CountryName
(Y)-(Y)
TransactionArray.Transaction.Buyer.BuyerInfo.ShippingAddress
  .ExternalAddressID
(Y)-(Y)
TransactionArray.Transaction.Buyer.BuyerInfo.ShippingAddress.Name(Y)-(Y)
TransactionArray.Transaction.Buyer.BuyerInfo.ShippingAddress
  .Phone
(Y)-(Y)
TransactionArray.Transaction.Buyer.BuyerInfo.ShippingAddress
  .PostalCode
(Y)-(Y)
TransactionArray.Transaction.Buyer.BuyerInfo.ShippingAddress
  .StateOrProvince
(Y)-(Y)
TransactionArray.Transaction.Buyer.BuyerInfo.ShippingAddress
  .Street
(Y)-(Y)
TransactionArray.Transaction.Buyer.BuyerInfo.ShippingAddress
  .Street1
(Y)-(Y)
TransactionArray.Transaction.Buyer.BuyerInfo.ShippingAddress
  .Street2
(Y)-(Y)
TransactionArray.Transaction.Buyer.CharityAffiliations(Y)-(Y)
TransactionArray.Transaction.Buyer.CharityAffiliations.CharityID(Y)-(Y)
TransactionArray.Transaction.Buyer.eBayGoodStanding(Y)-(Y)
TransactionArray.Transaction.Buyer.EIASToken(Y)-(Y)
TransactionArray.Transaction.Buyer.Email(Y)-(Y)
TransactionArray.Transaction.Buyer.FeedbackPrivate(Y)-(Y)
TransactionArray.Transaction.Buyer.FeedbackRatingStar(Y)-(Y)
TransactionArray.Transaction.Buyer.FeedbackScore(Y)-(Y)
TransactionArray.Transaction.Buyer.IDVerified(Y)-(Y)
TransactionArray.Transaction.Buyer.NewUser(Y)-(Y)
TransactionArray.Transaction.Buyer.PositiveFeedbackPercent(Y)-(Y)
TransactionArray.Transaction.Buyer.RegistrationAddress(Y)-(Y)
TransactionArray.Transaction.Buyer.RegistrationAddress
  .AddressAttribute
(Y)-(Y)
TransactionArray.Transaction.Buyer.RegistrationAddress.AddressID(Y)-(Y)
TransactionArray.Transaction.Buyer.RegistrationAddress
  .AddressUsage
(Y)-(Y)
TransactionArray.Transaction.Buyer.RegistrationAddress
  .ExternalAddressID
(Y)-(Y)
TransactionArray.Transaction.Buyer.RegistrationAddress.Name(Y)-(Y)
TransactionArray.Transaction.Buyer.RegistrationDate(Y)-(Y)
TransactionArray.Transaction.Buyer.Site(Y)-(Y)
TransactionArray.Transaction.Buyer.StaticAlias(Y)-(Y)
TransactionArray.Transaction.Buyer.Status(Y)-(Y)
TransactionArray.Transaction.Buyer.UserID(Y)-(Y)
TransactionArray.Transaction.Buyer.UserIDChanged(Y)-(Y)
TransactionArray.Transaction.Buyer.UserIDLastChanged(Y)-(Y)
TransactionArray.Transaction.Buyer.VATStatus(Y)-(Y)
TransactionArray.Transaction.BuyerCheckoutMessage(Y)(Y)(Y)
TransactionArray.Transaction.BuyerGuaranteePrice(Y)(Y)(Y)
TransactionArray.Transaction.CartID(Y)(Y)(Y)
TransactionArray.Transaction.ContainingOrder(Y)-(Y)
TransactionArray.Transaction.ContainingOrder.BuyerTaxIdentifier(Y)-(Y)
TransactionArray.Transaction.ContainingOrder.BuyerTaxIdentifier
  .Attribute
(Y)(Y)(Y)
TransactionArray.Transaction.ContainingOrder.BuyerTaxIdentifier
  .ID
(Y)-(Y)
TransactionArray.Transaction.ContainingOrder.BuyerTaxIdentifier
  .Type
(Y)(Y)(Y)
TransactionArray.Transaction.ContainingOrder.CancelDetail(Y)(Y)(Y)
TransactionArray.Transaction.ContainingOrder.CancelDetail
  .CancelCompleteDate
(Y)(Y)(Y)
TransactionArray.Transaction.ContainingOrder.CancelDetail
  .CancelIntiationDate
(Y)(Y)(Y)
TransactionArray.Transaction.ContainingOrder.CancelDetail
  .CancelIntiator
(Y)(Y)(Y)
TransactionArray.Transaction.ContainingOrder.CancelDetail
  .CancelReason
(Y)(Y)(Y)
TransactionArray.Transaction.ContainingOrder.CancelDetail
  .CancelReasonDetails
(Y)(Y)(Y)
TransactionArray.Transaction.ContainingOrder.CancelReason(Y)(Y)(Y)
TransactionArray.Transaction.ContainingOrder.CancelReasonDetails(Y)(Y)(Y)
TransactionArray.Transaction.ContainingOrder.CancelStatus(Y)(Y)(Y)
TransactionArray.Transaction.ContainingOrder.CreatingUserRole(Y)(Y)(Y)
TransactionArray.Transaction.ContainingOrder
  .IntegratedMerchantCreditCardEnabled
(Y)-(Y)
TransactionArray.Transaction.ContainingOrder.IsMultiLegShipping(Y)-(Y)
TransactionArray.Transaction.ContainingOrder.LogisticsPlanType(Y)-(Y)
TransactionArray.Transaction.ContainingOrder.MonetaryDetails--(Y)
TransactionArray.Transaction.ContainingOrder.MonetaryDetails
  .Payments
(Y)-(Y)
TransactionArray.Transaction.ContainingOrder.MonetaryDetails
  .Payments.Payment
(Y)-(Y)
TransactionArray.Transaction.ContainingOrder.MonetaryDetails
  .Payments.Payment.FeeOrCreditAmount
(Y)-(Y)
TransactionArray.Transaction.ContainingOrder.MonetaryDetails
  .Payments.Payment.Payee
(Y)-(Y)
TransactionArray.Transaction.ContainingOrder.MonetaryDetails
  .Payments.Payment.Payer
(Y)-(Y)
TransactionArray.Transaction.ContainingOrder.MonetaryDetails
  .Payments.Payment.PaymentAmount
(Y)-(Y)
TransactionArray.Transaction.ContainingOrder.MonetaryDetails
  .Payments.Payment.PaymentReferenceID
(Y)-(Y)
TransactionArray.Transaction.ContainingOrder.MonetaryDetails
  .Payments.Payment.PaymentStatus
(Y)-(Y)
TransactionArray.Transaction.ContainingOrder.MonetaryDetails
  .Payments.Payment.PaymentTime
(Y)-(Y)
TransactionArray.Transaction.ContainingOrder.MonetaryDetails
  .Payments.Payment.ReferenceID
(Y)-(Y)
TransactionArray.Transaction.ContainingOrder.MonetaryDetails
  .Refunds
(Y)-(Y)
TransactionArray.Transaction.ContainingOrder.MonetaryDetails
  .Refunds.Refund
(Y)-(Y)
TransactionArray.Transaction.ContainingOrder.MonetaryDetails
  .Refunds.Refund.FeeOrCreditAmount
(Y)-(Y)
TransactionArray.Transaction.ContainingOrder.MonetaryDetails
  .Refunds.Refund.ReferenceID
(Y)-(Y)
TransactionArray.Transaction.ContainingOrder.MonetaryDetails
  .Refunds.Refund.RefundAmount
(Y)-(Y)
TransactionArray.Transaction.ContainingOrder.MonetaryDetails
  .Refunds.Refund.RefundStatus
(Y)-(Y)
TransactionArray.Transaction.ContainingOrder.MonetaryDetails
  .Refunds.Refund.RefundTime
(Y)-(Y)
TransactionArray.Transaction.ContainingOrder.MonetaryDetails
  .Refunds.Refund.RefundTo
(Y)-(Y)
TransactionArray.Transaction.ContainingOrder.MonetaryDetails
  .Refunds.Refund.RefundType
(Y)-(Y)
TransactionArray.Transaction.ContainingOrder
  .MultiLegShippingDetails
(Y)-(Y)
TransactionArray.Transaction.ContainingOrder
  .MultiLegShippingDetails.SellerShipmentToLogisticsProvider
(Y)-(Y)
TransactionArray.Transaction.ContainingOrder
  .MultiLegShippingDetails.SellerShipmentToLogisticsProvider
  .ShippingServiceDetails
(Y)-(Y)
TransactionArray.Transaction.ContainingOrder
  .MultiLegShippingDetails.SellerShipmentToLogisticsProvider
  .ShippingServiceDetails.ShippingService
(Y)-(Y)
TransactionArray.Transaction.ContainingOrder
  .MultiLegShippingDetails.SellerShipmentToLogisticsProvider
  .ShippingServiceDetails.TotalShippingCost
(Y)-(Y)
TransactionArray.Transaction.ContainingOrder
  .MultiLegShippingDetails.SellerShipmentToLogisticsProvider
  .ShippingTimeMax
(Y)-(Y)
TransactionArray.Transaction.ContainingOrder
  .MultiLegShippingDetails.SellerShipmentToLogisticsProvider
  .ShippingTimeMin
(Y)-(Y)
TransactionArray.Transaction.ContainingOrder
  .MultiLegShippingDetails.SellerShipmentToLogisticsProvider
  .ShipToAddress
(Y)-(Y)
TransactionArray.Transaction.ContainingOrder
  .MultiLegShippingDetails.SellerShipmentToLogisticsProvider
  .ShipToAddress.AddressAttribute
(Y)-(Y)
TransactionArray.Transaction.ContainingOrder
  .MultiLegShippingDetails.SellerShipmentToLogisticsProvider
  .ShipToAddress.AddressID
(Y)-(Y)
TransactionArray.Transaction.ContainingOrder
  .MultiLegShippingDetails.SellerShipmentToLogisticsProvider
  .ShipToAddress.AddressOwner
(Y)-(Y)
TransactionArray.Transaction.ContainingOrder
  .MultiLegShippingDetails.SellerShipmentToLogisticsProvider
  .ShipToAddress.AddressUsage
(Y)-(Y)
TransactionArray.Transaction.ContainingOrder
  .MultiLegShippingDetails.SellerShipmentToLogisticsProvider
  .ShipToAddress.CityName
(Y)-(Y)
TransactionArray.Transaction.ContainingOrder
  .MultiLegShippingDetails.SellerShipmentToLogisticsProvider
  .ShipToAddress.Country
(Y)-(Y)
TransactionArray.Transaction.ContainingOrder
  .MultiLegShippingDetails.SellerShipmentToLogisticsProvider
  .ShipToAddress.CountryName
(Y)-(Y)
TransactionArray.Transaction.ContainingOrder
  .MultiLegShippingDetails.SellerShipmentToLogisticsProvider
  .ShipToAddress.ExternalAddressID
(Y)-(Y)
TransactionArray.Transaction.ContainingOrder
  .MultiLegShippingDetails.SellerShipmentToLogisticsProvider
  .ShipToAddress.Name
(Y)-(Y)
TransactionArray.Transaction.ContainingOrder
  .MultiLegShippingDetails.SellerShipmentToLogisticsProvider
  .ShipToAddress.Phone
(Y)-(Y)
TransactionArray.Transaction.ContainingOrder
  .MultiLegShippingDetails.SellerShipmentToLogisticsProvider
  .ShipToAddress.PostalCode
(Y)-(Y)
TransactionArray.Transaction.ContainingOrder
  .MultiLegShippingDetails.SellerShipmentToLogisticsProvider
  .ShipToAddress.ReferenceID
(Y)-(Y)
TransactionArray.Transaction.ContainingOrder
  .MultiLegShippingDetails.SellerShipmentToLogisticsProvider
  .ShipToAddress.StateOrProvince
(Y)-(Y)
TransactionArray.Transaction.ContainingOrder
  .MultiLegShippingDetails.SellerShipmentToLogisticsProvider
  .ShipToAddress.Street1
(Y)-(Y)
TransactionArray.Transaction.ContainingOrder
  .MultiLegShippingDetails.SellerShipmentToLogisticsProvider
  .ShipToAddress.Street2
(Y)-(Y)
TransactionArray.Transaction.ContainingOrder.OrderID(Y)-(Y)
TransactionArray.Transaction.ContainingOrder.OrderStatus(Y)-(Y)
TransactionArray.Transaction.ContainingOrder.PaymentHoldDetails(Y)-(Y)
TransactionArray.Transaction.ContainingOrder.PaymentHoldDetails
  .ExpectedReleaseDate
(Y)(Y)(Y)
TransactionArray.Transaction.ContainingOrder.PaymentHoldDetails
  .NumOfReqSellerActions
(Y)(Y)(Y)
TransactionArray.Transaction.ContainingOrder.PaymentHoldDetails
  .PaymentHoldReason
(Y)(Y)(Y)
TransactionArray.Transaction.ContainingOrder.PaymentHoldDetails
  .RequiredSellerActionArray
(Y)(Y)(Y)
TransactionArray.Transaction.ContainingOrder.PaymentHoldDetails
  .RequiredSellerActionArray.RequiredSellerAction
(Y)(Y)(Y)
TransactionArray.Transaction.ContainingOrder.PaymentHoldStatus(Y)-(Y)
TransactionArray.Transaction.ContainingOrder.RefundArray(Y)-(Y)
TransactionArray.Transaction.ContainingOrder.RefundArray.Refund(Y)-(Y)
TransactionArray.Transaction.ContainingOrder.RefundArray.Refund
  .EstimatedRefundCompletionTime
(Y)-(Y)
TransactionArray.Transaction.ContainingOrder.RefundArray.Refund
  .ExternalReferenceID
(Y)-(Y)
TransactionArray.Transaction.ContainingOrder.RefundArray.Refund
  .RefundAmount
(Y)-(Y)
TransactionArray.Transaction.ContainingOrder.RefundArray.Refund
  .RefundCompletionTime
(Y)-(Y)
TransactionArray.Transaction.ContainingOrder.RefundArray.Refund
  .RefundFailureReason
(Y)-(Y)
TransactionArray.Transaction.ContainingOrder.RefundArray.Refund
  .RefundFailureReason.RefundFailureCode
(Y)-(Y)
TransactionArray.Transaction.ContainingOrder.RefundArray.Refund
  .RefundFundingSourceArray
(Y)-(Y)
TransactionArray.Transaction.ContainingOrder.RefundArray.Refund
  .RefundFundingSourceArray.RefundFundingSource
(Y)-(Y)
TransactionArray.Transaction.ContainingOrder.RefundArray.Refund
  .RefundFundingSourceArray.RefundFundingSource.AccountNumber
(Y)-(Y)
TransactionArray.Transaction.ContainingOrder.RefundArray.Refund
  .RefundFundingSourceArray.RefundFundingSource
  .BuyerExternalTransactionID
(Y)-(Y)
TransactionArray.Transaction.ContainingOrder.RefundArray.Refund
  .RefundFundingSourceArray.RefundFundingSource.RefundAmount
(Y)-(Y)
TransactionArray.Transaction.ContainingOrder.RefundArray.Refund
  .RefundFundingSourceArray.RefundFundingSource.RefundingSourceType
(Y)-(Y)
TransactionArray.Transaction.ContainingOrder.RefundArray.Refund
  .RefundFundingSourceArray.RefundFundingSource
  .SellerExternalTransactionID
(Y)-(Y)
TransactionArray.Transaction.ContainingOrder.RefundArray.Refund
  .RefundID
(Y)-(Y)
TransactionArray.Transaction.ContainingOrder.RefundArray.Refund
  .RefundRequestedTime
(Y)-(Y)
TransactionArray.Transaction.ContainingOrder.RefundArray.Refund
  .RefundStatus
(Y)-(Y)
TransactionArray.Transaction.ContainingOrder.RefundArray.Refund
  .RefundTransactionArray
(Y)-(Y)
TransactionArray.Transaction.ContainingOrder.RefundArray.Refund
  .RefundTransactionArray.RefundTransaction
(Y)-(Y)
TransactionArray.Transaction.ContainingOrder.RefundArray.Refund
  .RefundTransactionArray.RefundTransaction.ItemID
(Y)-(Y)
TransactionArray.Transaction.ContainingOrder.RefundArray.Refund
  .RefundTransactionArray.RefundTransaction.OrderID
(Y)-(Y)
TransactionArray.Transaction.ContainingOrder.RefundArray.Refund
  .RefundTransactionArray.RefundTransaction.RefundLineArray
(Y)-(Y)
TransactionArray.Transaction.ContainingOrder.RefundArray.Refund
  .RefundTransactionArray.RefundTransaction.RefundLineArray
  .RefundLine
(Y)-(Y)
TransactionArray.Transaction.ContainingOrder.RefundArray.Refund
  .RefundTransactionArray.RefundTransaction.TransactionID
(Y)-(Y)
TransactionArray.Transaction.ContainingOrder.RefundArray.Refund
  .SellerNoteToBuyer
(Y)-(Y)
TransactionArray.Transaction.ContainingOrder
  .ShippingConvenienceCharge
(Y)(Y)(Y)
TransactionArray.Transaction.ConvertedAdjustmentAmount(Y)(Y)(Y)
TransactionArray.Transaction.ConvertedAmountPaid(Y)(Y)(Y)
TransactionArray.Transaction.ConvertedTransactionPrice(Y)(Y)(Y)
TransactionArray.Transaction.CreatedDate(Y)(Y)(Y)
TransactionArray.Transaction.DepositType(Y)(Y)(Y)
TransactionArray.Transaction.ExternalTransaction--(Y)
TransactionArray.Transaction.ExternalTransaction
  .ExternalTransactionID
--(Y)
TransactionArray.Transaction.ExternalTransaction
  .ExternalTransactionStatus
--(Y)
TransactionArray.Transaction.ExternalTransaction
  .ExternalTransactionTime
--(Y)
TransactionArray.Transaction.ExternalTransaction
  .FeeOrCreditAmount
--(Y)
TransactionArray.Transaction.ExternalTransaction
  .PaymentOrRefundAmount
--(Y)
TransactionArray.Transaction.FinalValueFee(Y)(Y)(Y)
TransactionArray.Transaction.IntangibleItem(Y)(Y)(Y)
TransactionArray.Transaction.InvoiceSentTime--(Y)
TransactionArray.Transaction.IsMultiLegShipping(Y)(Y)(Y)
TransactionArray.Transaction.ItemYYY
TransactionArray.Transaction.Item.ApplicationData(Y)(Y)(Y)
TransactionArray.Transaction.Item.AutoPayYYY
TransactionArray.Transaction.Item.BuyerProtection(Y)(Y)(Y)
TransactionArray.Transaction.Item.BuyItNowPrice--(Y)
TransactionArray.Transaction.Item.Charity(Y)(Y)(Y)
TransactionArray.Transaction.Item.Charity.CharityListing(Y)(Y)(Y)
TransactionArray.Transaction.Item.Country(Y)(Y)(Y)
TransactionArray.Transaction.Item.CurrencyYYY
TransactionArray.Transaction.Item.GetItFast--(Y)
TransactionArray.Transaction.Item
  .IntegratedMerchantCreditCardEnabled
Y-Y
TransactionArray.Transaction.Item.InventoryTrackingMethod(Y)-(Y)
TransactionArray.Transaction.Item.ItemIDYYY
TransactionArray.Transaction.Item.ListingDetails--(Y)
TransactionArray.Transaction.Item.ListingDetails.Adult--(Y)
TransactionArray.Transaction.Item.ListingDetails.BindingAuction--(Y)
TransactionArray.Transaction.Item.ListingDetails.CheckoutEnabled--(Y)
TransactionArray.Transaction.Item.ListingDetails
  .ConvertedBuyItNowPrice
--(Y)
TransactionArray.Transaction.Item.ListingDetails
  .ConvertedReservePrice
--(Y)
TransactionArray.Transaction.Item.ListingDetails
  .ConvertedStartPrice
--(Y)
TransactionArray.Transaction.Item.ListingDetails.EndTime--(Y)
TransactionArray.Transaction.Item.ListingDetails
  .HasPublicMessages
--(Y)
TransactionArray.Transaction.Item.ListingDetails.HasReservePrice--(Y)
TransactionArray.Transaction.Item.ListingDetails
  .MinimumBestOfferPrice
--(Y)
TransactionArray.Transaction.Item.ListingDetails.RelistedItemID--(Y)
TransactionArray.Transaction.Item.ListingDetails.StartTime--(Y)
TransactionArray.Transaction.Item.ListingDetails
  .TCROriginalItemID
--(Y)
TransactionArray.Transaction.Item.ListingDetails.ViewItemURL--(Y)
TransactionArray.Transaction.Item.ListingDetails
  .ViewItemURLForNaturalSearch
--(Y)
TransactionArray.Transaction.Item.ListingTypeYYY
TransactionArray.Transaction.Item.LotSize--(Y)
TransactionArray.Transaction.Item.PaymentMethodsY-Y
TransactionArray.Transaction.Item.PrivateListingYYY
TransactionArray.Transaction.Item.Quantity--Y
TransactionArray.Transaction.Item.SellingStatusY-Y
TransactionArray.Transaction.Item.SellingStatus.BidCount(Y)(Y)(Y)
TransactionArray.Transaction.Item.SellingStatus
  .ConvertedCurrentPrice
(Y)(Y)(Y)
TransactionArray.Transaction.Item.SellingStatus.CurrentPriceYYY
TransactionArray.Transaction.Item.SellingStatus.FinalValueFee(Y)(Y)(Y)
TransactionArray.Transaction.Item.SellingStatus.ListingStatusYYY
TransactionArray.Transaction.Item.SellingStatus.QuantitySoldYYY
TransactionArray.Transaction.Item.SKU(Y)-(Y)
TransactionArray.Transaction.Item.StartPrice--(Y)
TransactionArray.Transaction.Item.Title--(Y)