eBay Trading APIVersion 1349
 

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.

Short-duration call rate limit: The GetSellerTransactions call is one of five Trading API calls where eBay has implemented a short-duration call rate limit to restrict bursts of very high traffic, and to protect eBay's infrastructure and servers from being overloaded and/or destabilized.

Per (seller) user ID, no more than 1000 GetSellerTransactions calls can be executed within any 15-second interval. If this call rate limit is exceeded at any time, the application making the called is blocked. Each time an application is blocked, the user/application must wait until the block is reset after 15 seconds. This short-duration call rate limit applies to all seller accounts, and sellers/developers cannot appeal or request for a higher limit.

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.

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 <b>Checkout</b> status of an order changes. The <b>Checkout</b> 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 the Pagination section below 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 Manage and fulfill orders.

See also the reference documentation for this call:



Input

See also Samples.

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 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>
  <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 this field is included in the call request and set to true, taxpayer identification information for the buyer is returned under the BuyerTaxIdentifier container.

Codice Fiscale is only applicable to buyers on the Italy and Spain sites. It is required that buyers on the Italy site provide their Codice Fiscale ID before buying an item, and sellers on the Spain site have the option of requiring buyers on the Spain site to provide their taxpayer ID.
Default: false.
IncludeContainingOrder boolean Optional This field is included and set to true if the user wants to view order-level details, including the unique identifier of the order and the status of the order. The order-level details will be shown in the ContainingOrder container in the response.

Default: false.
IncludeFinalValueFee boolean Optional This field is included and set to true if the user wants to view the Final Value Fee (FVF) for all order line items in the response. The Final Value Fee is returned in the Transaction.FinalValueFee field. The Final Value Fee is assessed right after the creation of an order line item.

See the Selling fees help page for more information about how Final Value Fees are calculated.
Default: false.
InventoryTrackingMethod InventoryTrackingMethodCodeType Conditional This filter is used if the seller wishes to set/change the inventory tracking method. When creating a listing with the AddFixedPriceItem call (or relisting with RelistFixedPriceItem call), sellers can decide whether to track their inventory by Item ID (generated by eBay at listing time) or by seller-defined SKU value.

This field is needed (and its value must be set to SKU) if the seller wishes to retrieve order line items based on specified SKU values (specified through SKUArray container) and the current inventory tracking method is set to Item ID.

A seller can use a GetItem call for a listing (and look for the Item.InventoryTrackingMethod in the response) to see which inventory tracking method is used for the listing/product.

Applicable values:

CustomCode
(in/out) Reserved for internal or future use.
ItemID
(in/out) Indicates the seller prefers to track the listing by its eBay item ID. This is the default for all listings.
SKU
(in/out) Indicates the seller prefers to track the listing by their own SKU.

When you track by SKU, it means you can pass in 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 are used to retrieve order line items that were created or modified within a specified date range. The ModTimeFrom field is the starting date range. All of the seller's order line items that were created or modified within this date range are returned in the output. The maximum date range that may be specified is 30 days. This value cannot be set back more than 90 days in the past, as this call cannot retrieve sales older than 90 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).
Note: Please note that for a multiple line item order, all line items of that order that meet the filter criteria may be returned in the responses, even the line item(s) that were not actually modified. In other words, if any part of the order was modified, all line items of that order may be returned.
ModTimeTo dateTime Optional The ModTimeFrom and ModTimeTo fields are used to retrieve order line items that were created or modified within a specified date range. The ModTimeTo field is the ending date range. All of the seller's order line items that were created or 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).
Note: Please note that for a multiple line item order, all line items of that order that meet the filter criteria may be returned in the responses, even the line item(s) that were not actually modified. In other words, if any part of the order was modified, all line items of that order may be returned.
NumberOfDays int Optional This field is used to specify how many days (24-hour periods) back in the past you wish to retrieve order line items. All order line items created (or last modified) within this period are retrieved. This value can be set between 1 (day) and 30 (days), and defaults to 30 (days) if omitted from the call.

If the NumberOfDays filter is used, ModTimeFrom and ModTimeTo date range filters are ignored (if included in the same request).

Min: 1. Max: 30. Default: 30.
Pagination PaginationType Optional If many order line items are available to retrieve, you may need to call GetSellerTransactions multiple times to retrieve all the data. Each result set is returned as a page of order line items. Use the Pagination filters to control the maximum number of order line items to retrieve per page (i.e., per call), and the page number to retrieve.
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.

The maximum and default values are not the same for all calls. For most Trading API calls, the maximum value is 200 and the default value is 25 entries per page.
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 the individual calls to determine the correct default value.

Min: 1. Default: 1.
SKUArray SKUArrayType Optional This container is used to search for order line items generated from one or more product SKU values. The response will only include order line items for the seller's product(s) that are represented by the specified SKU value(s).

If a user wants to retrieve order line items based on SKUs, the InventoryTrackingMethod must be set to SKU. The InventoryTrackingMethod value can be set when the seller lists the item through an AddFixedPriceItem call, or it can be set by including the InventoryTrackingMethod field in a GetSellerTransactions call and setting its value to SKU.
Note: SKU values must be defined for products in listings for this container to be applicable.
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 and 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 the 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. Below are some examples from different countries.

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
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 field(s) you specified in the request, as well as all of its child fields (if a field is a container) and its parent fields (if any). Note that it is possible that a field included through an OutputSelector field may still not be returned if it is not applicable, or if it is not found based on other criteria set up in the request payload.

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:

 If the following output selectors are used: 

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

...

...the response might look like the following

<Item>
<BuyItNowPrice currencyID="USD">0.0</BuyItNowPrice>
<ListingDetails>
<ViewItemURL>http://www.ebay.com/itm/Tag-Heuer-Mens-Watch/182879833261</ViewItemURL>
</ListingDetails>
</Item>

See OutputSelector.

Version string Conditional The version number of the API code that you are programming against (e.g., 1149). 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:
    HTTP headers
    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) The WarningLevel value is set to High if the user wishes to receive warnings when the application passes unrecognized or deprecated elements in an API call request. Setting the WarningLevel value to High is not recommended in a production environment. Instead, it should only be used during the development/debugging stage.
Low
(in) The WarningLevel value is set to Low if the user does not wish to receive warnings when the application passes unrecognized or deprecated elements in an API call request. This is the default value if WarningLevel is not specified in the call request.

See Warning Level.



Output

See also Samples.

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 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>
  <ReturnedTransactionCountActual> int </ReturnedTransactionCountActual>
  <Seller> UserType
    <eBayGoodStanding> boolean </eBayGoodStanding>
    <EIASToken> string </EIASToken>
    <Email> string </Email>
    <FeedbackPrivate> boolean </FeedbackPrivate>
    <FeedbackScore> int </FeedbackScore>
    <NewUser> boolean </NewUser>
    <PositiveFeedbackPercent> float </PositiveFeedbackPercent>
    <RegistrationDate> dateTime </RegistrationDate>
    <Site> SiteCodeType </Site>
    <Status> UserStatusCodeType </Status>
    <UserID> UserIDType (string) </UserID>
    <UserIDChanged> boolean </UserIDChanged>
    <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
        <BuyerInfo> BuyerType
          <BuyerTaxIdentifier> TaxIdentifierType
            <Attribute name="TaxIdentifierAttributeCodeType"> TaxIdentifierAttributeType (string) </Attribute>
            <!-- ... more Attribute values allowed here ... -->
            <ID> string </ID>
            <Type> ValueTypeCodeType </Type>
          </BuyerTaxIdentifier>
          <!-- ... more BuyerTaxIdentifier nodes allowed here ... -->
          <ShippingAddress> AddressType
            <CityName> string </CityName>
            <Country> CountryCodeType </Country>
            <CountryName> string </CountryName>
            <Phone> string </Phone>
            <PostalCode> string </PostalCode>
            <StateOrProvince> string </StateOrProvince>
            <Street> string </Street>
            <Street1> string </Street1>
            <Street2> string </Street2>
          </ShippingAddress>
        </BuyerInfo>
        <EIASToken> string </EIASToken>
        <Email> string </Email>
        <FeedbackPrivate> boolean </FeedbackPrivate>
        <FeedbackScore> int </FeedbackScore>
        <PositiveFeedbackPercent> float </PositiveFeedbackPercent>
        <RegistrationDate> dateTime </RegistrationDate>
        <Site> SiteCodeType </Site>
        <Status> UserStatusCodeType </Status>
        <UserID> UserIDType (string) </UserID>
        <UserIDChanged> boolean </UserIDChanged>
        <VATStatus> VATStatusCodeType </VATStatus>
      </Buyer>
      <BuyerCheckoutMessage> string </BuyerCheckoutMessage>
      <BuyerPackageEnclosures> BuyerPackageEnclosuresType
        <BuyerPackageEnclosure type="PaymentInstructionCodeType"> BuyerPackageEnclosureType (string) </BuyerPackageEnclosure>
        <!-- ... more BuyerPackageEnclosure values allowed here ... -->
      </BuyerPackageEnclosures>
      <CodiceFiscale> string </CodiceFiscale>
      <ContainingOrder> OrderType
        <CancelReason> token </CancelReason>
        <CancelStatus> CancelStatusCodeType </CancelStatus>
        <ContainseBayPlusTransaction> boolean </ContainseBayPlusTransaction>
        <CreatingUserRole> TradingRoleCodeType </CreatingUserRole>
        <ExtendedOrderID> string </ExtendedOrderID>
        <OrderID> OrderIDType (string) </OrderID>
        <OrderLineItemCount> long </OrderLineItemCount>
        <OrderStatus> OrderStatusCodeType </OrderStatus>
      </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>
      <DigitalDeliverySelected> DigitalDeliverySelectedType
        <DeliveryDetails> DeliveryDetailsType
          <Recipient> DigitalDeliveryUserType
            <Email> string </Email>
            <Name> string </Name>
          </Recipient>
          <Sender> DigitalDeliveryUserType
            <Email> string </Email>
            <Name> string </Name>
          </Sender>
        </DeliveryDetails>
        <DeliveryMethod> token </DeliveryMethod>
        <DeliveryStatus> DeliveryStatusType
          <Email> token </Email>
        </DeliveryStatus>
      </DigitalDeliverySelected>
      <eBayCollectAndRemitTax> boolean </eBayCollectAndRemitTax>
      <eBayCollectAndRemitTaxes> TaxesType
        <eBayReference name="string"> eBayTaxReferenceValue (string) </eBayReference>
        <TaxDetails> TaxDetailsType
          <CollectionMethod> CollectionMethodCodeType </CollectionMethod>
          <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>
      </eBayCollectAndRemitTaxes>
      <eBayPaymentID> string </eBayPaymentID>
      <eBayPlusTransaction> boolean </eBayPlusTransaction>
      <ExtendedOrderID> string </ExtendedOrderID>
      <FinalValueFee currencyID="CurrencyCodeType"> AmountType (double) </FinalValueFee>
      <Gift> boolean </Gift>
      <GiftSummary> GiftSummaryType
        <Message> string </Message>
      </GiftSummary>
      <GuaranteedDelivery> boolean </GuaranteedDelivery>
      <GuaranteedShipping> boolean </GuaranteedShipping>
      <IntangibleItem> boolean </IntangibleItem>
      <InventoryReservationID> string </InventoryReservationID>
      <InvoiceSentTime> dateTime </InvoiceSentTime>
      <IsMultiLegShipping> boolean </IsMultiLegShipping>
      <Item> ItemType
        <ApplicationData> string </ApplicationData>
        <AutoPay> boolean </AutoPay>
        <BuyItNowPrice currencyID="CurrencyCodeType"> AmountType (double) </BuyItNowPrice>
        <Charity> CharityType
          <CharityListing> boolean </CharityListing>
        </Charity>
        <Country> CountryCodeType </Country>
        <Currency> CurrencyCodeType </Currency>
        <InventoryTrackingMethod> InventoryTrackingMethodCodeType </InventoryTrackingMethod>
        <ItemID> ItemIDType (string) </ItemID>
        <ListingDetails> ListingDetailsType
          <EndTime> dateTime </EndTime>
          <StartTime> dateTime </StartTime>
        </ListingDetails>
        <ListingType> ListingTypeCodeType </ListingType>
        <LotSize> int </LotSize>
        <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>
      <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 values allowed here ... -->
            <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>
            <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
            <AddressOwner> AddressOwnerCodeType </AddressOwner>
            <CityName> string </CityName>
            <Country> CountryCodeType </Country>
            <CountryName> string </CountryName>
            <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>
      <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>
      <Program> TransactionProgramType
        <AuthenticityVerification> AuthenticityVerificationType
          <OutcomeReason> string </OutcomeReason>
          <ServiceCost> ServiceCostType
            <Amount currencyID="CurrencyCodeType"> AmountType (double) </Amount>
            <ConvertedFromAmount currencyID="CurrencyCodeType"> AmountType (double) </ConvertedFromAmount>
          </ServiceCost>
          <Status> string </Status>
        </AuthenticityVerification>
        <Fulfillment> FulfillmentType
          <FulfillmentBy> string </FulfillmentBy>
          <FulfillmentRefId> string </FulfillmentRefId>
        </Fulfillment>
      </Program>
      <QuantityPurchased> int </QuantityPurchased>
      <SellerDiscounts> SellerDiscountsType
        <OriginalItemPrice currencyID="CurrencyCodeType"> AmountType (double) </OriginalItemPrice>
        <OriginalItemShippingCost currencyID="CurrencyCodeType"> AmountType (double) </OriginalItemShippingCost>
        <OriginalShippingService> token </OriginalShippingService>
        <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>
      <ShippedTime> dateTime </ShippedTime>
      <ShippingDetails> ShippingDetailsType
        <CalculatedShippingRate> CalculatedShippingRateType
          <InternationalPackagingHandlingCosts currencyID="CurrencyCodeType"> AmountType (double) </InternationalPackagingHandlingCosts>
          <PackagingHandlingCosts currencyID="CurrencyCodeType"> AmountType (double) </PackagingHandlingCosts>
        </CalculatedShippingRate>
        <eBayEstimatedLabelCost currencyID="CurrencyCodeType"> AmountType (double) </eBayEstimatedLabelCost>
        <PaymentEdited> boolean </PaymentEdited>
        <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 ... -->
        <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>
        <ShippingPackageInfo> ShippingPackageInfoType
          <ActualDeliveryTime> dateTime </ActualDeliveryTime>
          <EstimatedDeliveryTimeMax> dateTime </EstimatedDeliveryTimeMax>
          <EstimatedDeliveryTimeMin> dateTime </EstimatedDeliveryTimeMin>
          <HandleByTime> dateTime </HandleByTime>
          <MaxNativeEstimatedDeliveryTime> dateTime </MaxNativeEstimatedDeliveryTime>
          <MinNativeEstimatedDeliveryTime> dateTime </MinNativeEstimatedDeliveryTime>
          <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>
        <ShippingTimeMax> int </ShippingTimeMax>
        <ShippingTimeMin> int </ShippingTimeMin>
      </ShippingServiceSelected>
      <Status> TransactionStatusType
        <BuyerSelectedShipping> boolean </BuyerSelectedShipping>
        <CheckoutStatus> CheckoutStatusCodeType </CheckoutStatus>
        <CompleteStatus> CompleteStatusCodeType </CompleteStatus>
        <DigitalStatus> DigitalStatusCodeType </DigitalStatus>
        <eBayPaymentStatus> PaymentStatusCodeType </eBayPaymentStatus>
        <InquiryStatus> InquiryStatusCodeType </InquiryStatus>
        <LastTimeModified> dateTime </LastTimeModified>
        <PaymentHoldStatus> PaymentHoldStatusCodeType </PaymentHoldStatus>
        <PaymentInstrument> BuyerPaymentInstrumentCodeType </PaymentInstrument>
        <PaymentMethodUsed> BuyerPaymentMethodCodeType </PaymentMethodUsed>
        <ReturnStatus> ReturnStatusCodeType </ReturnStatus>
      </Status>
      <Taxes> TaxesType
        <eBayReference name="string"> eBayTaxReferenceValue (string) </eBayReference>
        <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>
      <Variation> VariationType
        <SKU> SKUType (string) </SKU>
        <VariationSpecifics> NameValueListArrayType
          <NameValueList> NameValueListType
            <Name> string </Name>
          </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.
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.eBayGoodStanding boolean Always
This boolean field is returned as true if the eBay user is in good standing with eBay.
Note: This field will stop being returned in GetItemTransactions and GetSellerTransactions on January 31, 2024.

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 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 GetOrders call, the buyer's email address will be returned (to the seller only) for orders less than two weeks old, but for orders that occurred more than two weeks in the past, the buyer's email address will no longer be returned. This Email field will still be returned, but 'dummy data', such as Invalid Request will replace the actual email address.

Note: For the GetItemTransactions call, this field is only returned to the seller of the order; this field is not returned for the buyer or third party.
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:
    Anonymous user information
    Member communications

Seller.FeedbackPrivate boolean Always Indicates whether the user has chosen to make their feedback score and feedback details private (hidden from other users). 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 Anonymous user information.

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.

For GetOrders and GetItemTransactions only: If using Trading WSDL Version 1019 or above, this field will only be returned to the buyer or seller, and no longer returned at all to third parties. If using a Trading WSDL older than Version 1019, the accurate Feedback Score for the user is returned to the buyer or seller, but a dummy value of 0 will be returned to all third parties.

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

See Anonymous user information.

Seller.NewUser boolean Always This boolean is returned as true if the eBay user has been registered on eBay for 30 days or less.
Note: The Buyer.NewUser field will stop being returned in GetItemTransactions and GetSellerTransactions on January 31, 2024.

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.

For GetOrders and GetItemTransactions only: If using Trading WSDL Version 1019 or above, this field will only be returned to the buyer or seller, and no longer returned at all to third parties. If using a Trading WSDL older than Version 1019, the accurate Positive Feedback Percentage value for the user is returned to the buyer or seller, but a dummy value of 0.0 will be returned to all third parties.

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 Anonymous user information.

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.
Code so that your app gracefully handles any future changes to this list.

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

See Anonymous user information.

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

Applicable values: See Status.
Code so that your app gracefully handles any future changes to this list.

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".

Important: 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 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 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.

Note: For the GetItemTransactions call, this field is only returned to the seller of the order; this field is not returned for the buyer or third party.

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

See 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

Code so that your app gracefully handles any future changes to this list.

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

See Vat-exempt sellers.

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..*]
A Transaction container is returned for each line item in the order. This container consists of detailed information on one order line item.

For the AddOrder call, a Transaction container is used to identified the unpaid order line items that are being combined into one Combined Invoice order.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
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) Always This value indicates the dollar amount by which the buyer has adjusted the the total cost of the sales transaction. Adjustments to sales transaction costs may include shipping and handling, buyer discounts, or added services. 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.

This field is always returned, even if there was no cost adjustment to the sales transaction. Its value will just be '0.0' if there was no cost adjustment.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .AdjustmentAmount
  [ attribute currencyID ]
CurrencyCodeType Always This value indicates the dollar amount by which the buyer has adjusted the the total cost of the sales transaction. Adjustments to sales transaction costs may include shipping and handling, buyer discounts, or added services. 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.

This field is always returned, even if there was no cost adjustment to the sales transaction. Its value will just be '0.0' if there was no cost adjustment.

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 item cost, shipping/handling charges, and sales tax that is applied to the order by the seller. 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 for each line item in the order reflects the total amount paid for the entire order, and not for the individual order line item. In a GetItemTransactions or GetSellerTransactions call, you can determine which order line items belong to the same 'Combined Invoice' order by checking to see if the ContainingOrder.OrderID value is the same.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
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 item cost, shipping/handling charges, and sales tax that is applied to the order by the seller. 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 for each line item in the order reflects the total amount paid for the entire order, and not for the individual order line item. In a GetItemTransactions or GetSellerTransactions call, you can determine which order line items belong to the same 'Combined Invoice' order by checking to see if the ContainingOrder.OrderID value is the same.

For a list of possible enumeration values, see CurrencyCodeType.
TransactionArray.Transaction
  .BestOfferSale
boolean Always Indicates whether or not the sales transaction resulted from the seller accepting a Best Offer (or Counter Offer) from a buyer.

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 order's buyer. To be returned by GetItemsAwaitingFeedback the seller must be the one making the request.

For GetOrders and GetItemTransactions only: If using Trading WSDL Version 1019 or above, this container will only be returned to the buyer or seller, and no longer returned at all to third parties. If using a Trading WSDL older than Version 1019, real data is only returned to the buyer or seller, and dummy/masked data will be returned to all third parties.

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 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.

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: See Type.
Code so that your app gracefully handles any future changes to this list.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .Buyer.BuyerInfo
  .ShippingAddress
AddressType Conditionally This container shows the buyer's shipping address.

Note: For an Authenticity Guarantee program order returned in GetItemTransactions or GetSellerTransactions, this is the address of the authenticator's warehouse. The authenticator is responsible for delivery to the buyer's shipping address.

Note: For In-Store Pickup and Click and Collect orders, this is the address of the merchant's store where the buyer will pick up the order. This is only applicable for GetItemTransactions and GetSellerTransactions calls.

Note: For eBay Vault scenarios: GetItemTransactions calls, and GetSellerTransactions calls (Seller View only), mock address details are returned for:

- Vault to vault orders: Buyer and Seller View

- Ship to vault orders: Mock addresses are returned for the Buyer View (only); the address returned for the Seller View will be the authenticator&apos;s address.

- Vault in-hand submission orders: the address returned for the Buyer View will be the authenticator's address (GetItemTransactions only).

The following address details are returned for mock addresses:

 <ShippingAddress> 
 <Name>eBay Vault</Name>
 <AddressID>Invalid Request</AddressID>
 <AddressOwner>eBay</AddressOwner>
 <AddressUsage>Invalid</AddressUsage>
 <CityName>Invalid Request</CityName>
 <Country>US</Country>
 <CountryName>Invalid Request</CountryName>
 <ExternalAddressID>Invalid Request</ExternalAddressID>
 <Phone>Invalid Request</Phone>
 <PostalCode>Invalid Request</PostalCode>
 <StateOrProvince>Invalid Request</StateOrProvince>
 <Street1>Invalid Request</Street1>
 <Street2></Street2>
</ShippingAddress>



DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .Buyer.BuyerInfo
  .ShippingAddress.CityName
string Conditionally The city associated with an address on file with eBay. Most addresses include a city name, but not all. For example, Singapore is an island city-state, so SG would appear in the Country field, and 'Singapore' or 'Republic of Singapore' would appear in the CountryName field, but the CityName field is not applicable.

Max length: GB, DE - 35; US, CA - 40; AU - 80; Other countries - 50.

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.



Applicable values: See Country.
Code so that your app gracefully handles any future changes to this list.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .Buyer.BuyerInfo
  .ShippingAddress.CountryName
string Conditionally The full name of the country associated with an address on file with eBay.

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.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.

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.

Max length: GB, DE - 35; US, CA - 40; AU - 80; Other countries - 50.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .Buyer.BuyerInfo
  .ShippingAddress
  .StateOrProvince
string Conditionally The state or province associated with an address on file with eBay. Whether it's a state or a province will depend on the region and/or country. This field should only be passed in or returned if applicable/defined.

Max length: GB, DE - 35; US, CA - 40; AU - 80; Other countries - 50.

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 used for a registration address.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .Buyer.BuyerInfo
  .ShippingAddress.Street1
string Conditionally The first line of the user's street address.

Note: Note the different maximum lengths noted below for different countries. If a street name exceeds the maximum length for the applicable country, the full street name may be expressed through both the Street1 and Street2 fields.
Max length: GB, DE - 35; US, CA - 40; AU - 80; Other countries - 50.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .Buyer.BuyerInfo
  .ShippingAddress.Street2
string Conditionally The second line of the user's street address (such as an apartment number or suite number).

Returned if the user specified a second street value for their address.
Note: In case of Item.SellerContactDetails, Street2 can be used to provide City, Address, State, and Zip code (if applicable). Note: Note the different maximum lengths noted below for different countries. If a street name exceeds the maximum length for the applicable country, the full street name may be expressed through both the Street1 and Street2 fields. Note: In the case of TransactionArray.Transaction.MultiLegShippingDetails.SellerShipmentToLogisticsProvider.ShipToAddress, if the item is being shipped through eBay International Shipping and this address refers to an intermediated warehouse address, the eBay Virtual Tracking number (eVTN) that is used for the domestic leg of the shipment is appended to Street2. This value is generated by eBay when the order is completed. Example:"Reference #1234567890123456"
Max length: GB, DE - 35; US, CA - 40; AU - 80; Other countries - 50.

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 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 GetOrders call, the buyer's email address will be returned (to the seller only) for orders less than two weeks old, but for orders that occurred more than two weeks in the past, the buyer's email address will no longer be returned. This Email field will still be returned, but 'dummy data', such as Invalid Request will replace the actual email address.

Note: For the GetItemTransactions call, this field is only returned to the seller of the order; this field is not returned for the buyer or third party.
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:
    Anonymous user information
    Member communications

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). 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 Anonymous user information.

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.

For GetOrders and GetItemTransactions only: If using Trading WSDL Version 1019 or above, this field will only be returned to the buyer or seller, and no longer returned at all to third parties. If using a Trading WSDL older than Version 1019, the accurate Feedback Score for the user is returned to the buyer or seller, but a dummy value of 0 will be returned to all third parties.

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

See Anonymous user information.

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.

For GetOrders and GetItemTransactions only: If using Trading WSDL Version 1019 or above, this field will only be returned to the buyer or seller, and no longer returned at all to third parties. If using a Trading WSDL older than Version 1019, the accurate Positive Feedback Percentage value for the user is returned to the buyer or seller, but a dummy value of 0.0 will be returned to all third parties.

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 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.
Code so that your app gracefully handles any future changes to this list.

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

See Anonymous user information.

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

Applicable values: See Status.
Code so that your app gracefully handles any future changes to this list.

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".

Important: 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 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 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.

Note: For the GetItemTransactions call, this field is only returned to the seller of the order; this field is not returned for the buyer or third party.

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

See 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

Code so that your app gracefully handles any future changes to this list.

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

See Vat-exempt sellers.

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.

For GetItemTransactions only: If using Trading WSDL Version 1019 or above, this field will only be returned to the buyer or seller, and no longer returned at all to third parties. If using a Trading WSDL older than Version 1019, real data is only returned to the buyer or seller, and a string value of Unavailable will be returned to all third parties.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .BuyerPackageEnclosures
BuyerPackageEnclosuresType Conditionally This container is returned in GetOrders (and other order management calls) if the 'Pay Upon Invoice' option is being offered to the buyer, and the seller is including payment instructions in the shipping package(s) for the order. The 'Pay Upon Invoice' option is only available on the Germany site.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .BuyerPackageEnclosures
  .BuyerPackageEnclosure
BuyerPackageEnclosureType (string) Conditionally,
repeatable: [0..*]
A BuyerPackageEnclosure container will be returned for each shipping package containing payment instructions. The 'Pay Upon Invoice' option is only available on the German site.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .BuyerPackageEnclosures
  .BuyerPackageEnclosure
  [ attribute type ]
PaymentInstructionCodeType Conditionally A BuyerPackageEnclosure container will be returned for each shipping package containing payment instructions. The 'Pay Upon Invoice' option is only available on the German site.

For a list of possible enumeration values, see PaymentInstructionCodeType.
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 buyers on the Italy and Spain sites. The Codice Fiscale number is unique for each Italian and Spanish citizen and is used for tax purposes.
TransactionArray.Transaction
  .ContainingOrder
OrderType Conditionally This container is returned in a GetItemTransactions or GetSellerTransactions response if the IncludeContainingOrder field is included in the call request payload and set to 'true'. This container will be returned whether the order line item is the only line item in the order, or if the order has multiple line items.

Note: The new OrderLineItemCount field is automatically returned if the user is using Version 1113 of the Trading WSDL (or newer, as versions roll out). If the user is using Versions 1107 or 1111 of the Trading WSDL, the OrderLineItemCount field will only be returned if the user includes the X-EBAY-API-COMPATIBILITY-LEVEL HTTP header and sets its value to 1113. If a user is using a Trading WSDL older than 1107, the OrderLineItemCount field will not be returned.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ContainingOrder.CancelReason
token Conditionally This value indicates the reason why the order cancellation was initiated. This field is only returned if an order cancellation has been initiated by the buyer or seller. Typical buyer-initiated cancellation reasons include 'OrderPlacedByMistake', 'WontArriveInTime', or 'FoundCheaperPrice'. Sellers may initiate an order cancellation on behalf of the buyer. In this scenario, the seller should state the cancellation reason as 'BuyerCancelOrder'. If the seller is cancelling an order because he/she is out of stock on an item, the seller should state the cancellation reason as 'OutOfStock'. Unfortunately, in this scenario, the seller will receive a seller defect for this cancellation reason. See CancelReasonCodeType for the complete list of enumeration values that can be returned in this field.

Note: Only the CancelReason and CancelStatus fields are returned. The CancelDetail container and the CancelReasonDetails field are no longer returned. A seller can use the Search Cancellations method of the Post-Order API to retrieve more details on a cancelled order. If the seller does use this method, they can use the Order ID or Item ID as a filter in the request to retrieve the correct cancellation request.

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

Applicable values: See CancelReasonCodeType
TransactionArray.Transaction
  .ContainingOrder.CancelStatus
CancelStatusCodeType Conditionally The current status for the order cancellation request (if it exists for the order). This field is only returned if a cancellation request has been made on the order, or if the order is currently going through the cancellation process, or if the order has already been cancelled.

Note: Only the CancelReason and CancelStatus fields are returned. The CancelDetail container and the CancelReasonDetails field are no longer returned. A seller can use the Search Cancellations method of the Post-Order API to retrieve more details on a cancelled order. If the seller does use this method, they can use the Order ID or Item ID as a filter in the request to retrieve the correct cancellation request.

Applicable values: See CancelStatus.
Code so that your app gracefully handles any future changes to this list.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ContainingOrder
  .ContainseBayPlusTransaction
boolean Conditionally If true, the order contains a transaction for an item that was purchased under the eBay Plus program. eBay Plus is a premium account option for buyers, which provides benefits such as fast free domestic shipping and free returns on selected items. Top-Rated eBay sellers must opt in to eBay Plus to be able offer the program on qualifying listings. Sellers must commit to next-day delivery of those items.

Note: Currently, eBay Plus is available only to buyers in Germany and Australia.

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

See eBay Plus for more details.

TransactionArray.Transaction
  .ContainingOrder
  .CreatingUserRole
TradingRoleCodeType Conditionally This value indicates whether a 'Combined Invoice' order was initiated/created by the buyer or by the seller. This field is only returned for Combined Invoice orders.

An AddOrder call can be used by a seller or buyer to combine two or more unpaid order line items into a 'Combined Invoice' order. Once two or more line items are successfully combined into one order, the buyer only needs to make one payment (instead of multiple payments - one for each order line item). The CreatingUserRole field is required in the AddOrder call request.

Note: Except for listings that required immediate payment, buyers also may have the opportunity to combine multiple line items (from the same seller) into a 'Combined Invoice' order through the buy/checkout flow. This may include accepted Best Offers or auctions that the buyer wins.

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.

Code so that your app gracefully handles any future changes to this list.

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

See Combined Invoice.

TransactionArray.Transaction
  .ContainingOrder
  .ExtendedOrderID
string Conditionally A unique identifier for an eBay order in the eBay REST API model. ExtendedOrderID values will be used to identify orders in REST-based APIs, including the Post-Order API and the Fulfillment API.

For GetOrders and GetItemTransactions only: If using Trading WSDL Version 1019 or above, this field will only be returned to the buyer or seller, and no longer returned at all to third parties. If using a Trading WSDL older than Version 1019, the correct Order ID is returned to the buyer or seller, but a dummy Order ID value of 1000000000000 will be returned to all third parties.

Note: As of June 2019, eBay has changed the format of order identifier values, and this new format is relevant to both legacy and REST API-based order ID fields. The new format is a non-parsable string, globally unique across all eBay marketplaces, and consistent for both single line item and multiple line item orders. Unlike in the past, instead of just being known and exposed to the seller, these unique order identifiers will also be known and used/referenced by the buyer and eBay customer support.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ContainingOrder.OrderID
OrderIDType (string) Conditionally A unique identifier for a single or multiple line item eBay order. In the ContainingOrder container of a GetItemTransactions or GetSellerTransactions response, this identifier identifies the parent order of the order line item. A single buyer payment is made for each order.

For order management calls only: This field is returned with the correct order ID only to the buyer and the seller. For third parties:
  • If using Trading WSDL version 1019 or newer (or Compatibility Level is set to '1019' or newer), the Order ID will be returned to third parties as an empty field (<OrderID/>).
  • If using a Trading WSDL older than version 1019, the Order ID will be returned to third parties as dummy data in the form of 1000000000000 or 1000000000000-1000000000000.

Note: The unique identifier of a 'non-immediate payment' order will change as it goes from an unpaid order to a paid order. Due to this scenario, all calls that accept Order ID values as filters in the request payload, including GetOrders calls, will support the identifiers for both unpaid and paid orders. The revised order ID format (introduced in June 2019) is a non-parsable string, globally unique across all eBay marketplaces, and consistent for both single line item and multiple line item orders. Unlike in the past, instead of just being known and exposed to the seller, these unique order identifiers will also be known and used/referenced by the buyer and eBay customer support.

Sellers can check to see if an order has been paid by looking for a value of 'Complete' in the CheckoutStatus.Status field in the response of GetOrders calls, or in the Status.CompleteStatus field in the response of GetItemTransactions or GetSellerTransactions call. Sellers should not fulfill orders until buyer has made payment.

Max length: 40.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ContainingOrder
  .OrderLineItemCount
long Conditionally
This field indicates the total number of line items in the order. This field is returned under the ContainingOrder container of a GetItemTransactions or GetSellerTransactions call. In order for the ContainingOrder container to be returned, a user must include the IncludeContainingOrder field in the call request and set its value to true.

Note: This field is automatically returned if the user is using Version 1113 of the Trading WSDL (or newer), or if the user includes the X-EBAY-API-COMPATIBILITY-LEVEL HTTP header and sets its value to 1113 (or newer). If a user is using a Trading WSDL older than 1113 (or is not setting the X-EBAY-API-COMPATIBILITY-LEVEL HTTP header value to 1113 or newer), this field will not be returned.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ContainingOrder.OrderStatus
OrderStatusCodeType Conditionally This enumeration value indicates the current status of the order.

Applicable values: See OrderStatus.
Code so that your app gracefully handles any future changes to this list.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ConvertedAdjustmentAmount
AmountType (double) Conditionally This field shows the 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.

This field is always returned, even if there was no cost adjustment to the sales transaction. Its value will just be '0.0' if there was no cost adjustment. This value should be the same as the value in AdjustmentAmount if the eBay listing site and the site that returned the response are the same, or use the same currency.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ConvertedAdjustmentAmount
  [ attribute currencyID ]
CurrencyCodeType Always This field shows the 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.

This field is always returned, even if there was no cost adjustment to the sales transaction. Its value will just be '0.0' if there was no cost adjustment. This value should be the same as the value in AdjustmentAmount if the eBay listing site and the site that returned the response are the same, or use the same currency.

For a list of possible enumeration values, see CurrencyCodeType.
TransactionArray.Transaction
  .ConvertedAmountPaid
AmountType (double) Conditionally This field shows the 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.

This field is always returned for paid orders. This value should be the same as the value in AmountPaid if the eBay listing site and the site that returned the response are the same, or use the same currency.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ConvertedAmountPaid
  [ attribute currencyID ]
CurrencyCodeType Always This field shows the 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.

This field is always returned for paid orders. This value should be the same as the value in AmountPaid if the eBay listing site and the site that returned the response are the same, or use the same currency.

For a list of possible enumeration values, see CurrencyCodeType.
TransactionArray.Transaction
  .ConvertedTransactionPrice
AmountType (double) Conditionally This field shows the 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.

This field is always returned for sales transactions. This value should be the same as the value in TransactionPrice if the eBay listing site and the site that returned the response are the same, or use the same currency.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ConvertedTransactionPrice
  [ attribute currencyID ]
CurrencyCodeType Always This field shows the 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.

This field is always returned for sales transactions. This value should be the same as the value in TransactionPrice if the eBay listing site and the site that returned the response are the same, or use the same currency.

For a list of possible enumeration values, see CurrencyCodeType.
TransactionArray.Transaction
  .CreatedDate
dateTime Conditionally This timestamp indicates date/time when the sales transaction occurred. A sales transaction is created when there is a commitment to buy, or when the buyer purchases the item through a 'Buy it Now' option. For auction listings, a sales transaction 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, a sales transaction is created once the buyer clicks the Buy button.

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 purchase of a motor vehicle. This field is only applicable to motor vehicle listings that require an initial deposit. A value of 'OtherMethod' will be returned if the motor vehicle listing requires an initial deposit, or a value of 'None' if an initial deposit is not required.

Applicable values:

None
(in/out) This value indicates that no deposit is required.
OtherMethod
(in/out) This value indicates that a deposit is required from the buyer when purchasing a motor vehicle. Deposits for a motor vehicle are either due in 24, 48, or 72 hours after commitment to purchase. Or, in the case of a motor vehicle listing that is requiring immediate payment, the deposit it due immediately after commitment to purchase.

This value should be used in an Add/Revise call if the seller is requiring a deposit for a motor vehicle listing.

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

Code so that your app gracefully handles any future changes to this list.

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

See eBay motors offline payment methods.

TransactionArray.Transaction
  .DigitalDeliverySelected
DigitalDeliverySelectedType Conditionally This container is only returned by GetOrders and other order management calls if the buyer purchased a digital gift card for themselves, or is giving the digital gift card to someone else as a gift (in this case, the Gift boolean field will be returned with a value of true). The DigitalDeliverySelected container consists of information related to the digital gift card order line item, including the delivery method, delivery status, and recipient of the gift card (either the buyer, or another individual that is receiving the gift card as a gift from the buyer.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .DigitalDeliverySelected
  .DeliveryDetails
DeliveryDetailsType Conditionally This container is returned by GetOrders and other order management calls to provide details on the recipient of a digital gift card that was purchased. The DeliveryDetails container is only returned if the buyer is buying a digital gift card and giving that gift card to another person.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .DigitalDeliverySelected
  .DeliveryDetails.Recipient
DigitalDeliveryUserType Conditionally This container consists of the name and email of the person who is receiving the digital gift card. If the buyer has purchased the gift card for themselves, the buyer's name and email will appear in this container. If the buyer is giving the gift card to another individual, that individual's name and email will appear in this container. This container is always returned for a digital gift card line item.

For GetOrders and GetItemTransactions only: If using Trading WSDL Version 1019 or above, this container will only be returned to the buyer or seller, and no longer returned at all to third parties. If using a Trading WSDL older than Version 1019, real data is only returned to the buyer or seller, and dummy/masked data will be returned to all third parties.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .DigitalDeliverySelected
  .DeliveryDetails.Recipient
  .Email
string Conditionally This field displays the email address of the sender/purchaser of the digital gift card (applicable for the Sender container) or the email address of the recipient of the digital gift card (applicable for the Recipient container). Both the sender and recipient email address is provided by the purchaser of the digital gift card at time of purchase.

For GetItemTransactions only: If using Trading WSDL Version 1019 or above, this field will only be returned to the buyer or seller, and no longer returned at all to third parties. If using a Trading WSDL older than Version 1019, real data is only returned to the buyer or seller, and a string value of Unavailable will be returned to all third parties.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .DigitalDeliverySelected
  .DeliveryDetails.Recipient
  .Name
string Conditionally This field displays the actual name (not the eBay user ID) of the sender/purchaser of the digital gift card (applicable for the Sender container) or the actual name of the recipient of the digital gift card (applicable for the Recipient container). Both the sender and recipient name is provided by the purchaser of the digital gift card at time of purchase.

For GetItemTransactions only: If using Trading WSDL Version 1019 or above, this field will only be returned to the buyer or seller, and no longer returned at all to third parties. If using a Trading WSDL older than Version 1019, real data is only returned to the buyer or seller, and a string value of Unavailable will be returned to all third parties.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .DigitalDeliverySelected
  .DeliveryDetails.Sender
DigitalDeliveryUserType Conditionally This container consists of the name and email of the person who purchased the digital gift card. This container is only returned if the purchaser of the digital gift card is giving the gift card to someone else, and that individual's name and email will appear in the Recipient container.

For GetOrders and GetItemTransactions only: If using Trading WSDL Version 1019 or above, this container will only be returned to the buyer or seller, and no longer returned at all to third parties. If using a Trading WSDL older than Version 1019, real data is only returned to the buyer or seller, and dummy/masked data will be returned to all third parties.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .DigitalDeliverySelected
  .DeliveryDetails.Sender.Email
string Conditionally This field displays the email address of the sender/purchaser of the digital gift card (applicable for the Sender container) or the email address of the recipient of the digital gift card (applicable for the Recipient container). Both the sender and recipient email address is provided by the purchaser of the digital gift card at time of purchase.

For GetItemTransactions only: If using Trading WSDL Version 1019 or above, this field will only be returned to the buyer or seller, and no longer returned at all to third parties. If using a Trading WSDL older than Version 1019, real data is only returned to the buyer or seller, and a string value of Unavailable will be returned to all third parties.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .DigitalDeliverySelected
  .DeliveryDetails.Sender.Name
string Conditionally This field displays the actual name (not the eBay user ID) of the sender/purchaser of the digital gift card (applicable for the Sender container) or the actual name of the recipient of the digital gift card (applicable for the Recipient container). Both the sender and recipient name is provided by the purchaser of the digital gift card at time of purchase.

For GetItemTransactions only: If using Trading WSDL Version 1019 or above, this field will only be returned to the buyer or seller, and no longer returned at all to third parties. If using a Trading WSDL older than Version 1019, real data is only returned to the buyer or seller, and a string value of Unavailable will be returned to all third parties.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .DigitalDeliverySelected
  .DeliveryMethod
token Conditionally This value indicates the method in which the digital gift card will be delivered to the buyer or to the person whom the purchaser is giving the digital gift card to. Currently, the only supported delivery method is by email.

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

Applicable values: See DeliveryMethodCodeType
TransactionArray.Transaction
  .DigitalDeliverySelected
  .DeliveryStatus
DeliveryStatusType Conditionally This container consists of the current status of whatever delivery method is being used (indicated in the DigitalDeliverySelected.DeliveryMethod field). Currently, the only supported delivery method is by email.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .DigitalDeliverySelected
  .DeliveryStatus.Email
token Conditionally This value indicates the current delivery status for the digital gift card that is being delivered by email. Currently, the only supported delivery status value is 'Notified', which indicates that the link to download the digital gift card has been sent to the recipient by email.

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

Applicable values: See DeliveryStatusEmailCodeType
TransactionArray.Transaction
  .eBayCollectAndRemitTax
boolean Conditionally This boolean field is returned as true if the line item is subject to a tax (US sales tax or Australian Goods and Services tax) that eBay will collect and remit to the proper taxing authority on the buyer's behalf. This field is also returned if false (not subject to eBay Collect and Remit). An eBayCollectAndRemitTaxes container is returned if the order line item is subject to such a tax, and the type and amount of this tax is displayed in the eBayCollectAndRemitTaxes.TaxDetails container.

Australian 'Goods and Services' tax (GST) is automatically charged to buyers outside of Australia when they purchase items on the eBay Australia site. Sellers on the Australia site do not have to take any extra steps to enable the collection of GST, as this tax is collected by eBay and remitted to the Australian government. For more information about Australian GST, see the Taxes and import charges help topic.

As of January 2023, buyers in all US states will automatically be charged sales tax for purchases, and the seller does not set this rate. eBay will collect and remit this sales tax to the proper taxing authority on the buyer's behalf. For more US state-level information on sales tax, see the eBay sales tax collection help topic.
TransactionArray.Transaction
  .eBayCollectAndRemitTaxes
TaxesType Conditionally This container is returned if the order line item is subject to a tax (US sales tax or Australian Goods and Services tax) that eBay will collect and remit to the proper taxing authority on the buyer's behalf. The type of tax will be shown in the TaxDetails.Imposition and TaxDetails.TaxDescription fields, and the amount of this tax will be displayed in the TaxDetails.TaxAmount field.

Australian 'Goods and Services' tax (GST) is automatically charged to buyers outside of Australia when they purchase items on the eBay Australia site. Sellers on the Australia site do not have to take any extra steps to enable the collection of GST, as this tax is collected by eBay and remitted to the Australian government. For more information about Australian GST, see the Taxes and import charges help topic.

As of January 2023, buyers in all US states will automatically be charged sales tax for purchases, and the seller does not set this rate. eBay will collect and remit this sales tax to the proper taxing authority on the buyer's behalf. For more US state-level information on sales tax, see the eBay sales tax collection help topic.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .eBayCollectAndRemitTaxes
  .eBayReference
eBayTaxReferenceValue (string) Conditionally The value returned in this field is the VAT ID for eBay, and this value may vary based on the region or country. The eBayReference field's name attribute will show the type of VAT ID, such as IOSS, OSS, or ABN. This field will be returned if VAT tax is applicable for the order. See the eBayTaxReferenceValue type page for more information on the VAT tax type strings that may appear for the name attribute.

Note: For all VAT ID/VATIN values to be returned (except for France), developers will need to use a Trading WSDL with a version number of 1211 (or newer). For French VAT ID/VATIN values to be returned, developers will need to use a Trading WSDL with a version number of 1225 (or newer). Otherwise, the VAT information will be returned in the Order.ShippingAddress.Street2 field. Developers will also have the option of using older version, but setting the X-EBAY-API-COMPATIBILITY-LEVEL header value to 1211 or 1225 or higher.

On January 31, 2022, the Order.ShippingAddress.Street2 will stop being used to return VAT information regardless of WSDL version or compatibility level.



DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .eBayCollectAndRemitTaxes
  .eBayReference
  [ attribute name ]
string Conditionally The value returned in this field is the VAT ID for eBay, and this value may vary based on the region or country. The eBayReference field's name attribute will show the type of VAT ID, such as IOSS, OSS, or ABN. This field will be returned if VAT tax is applicable for the order. See the eBayTaxReferenceValue type page for more information on the VAT tax type strings that may appear for the name attribute.

Note: For all VAT ID/VATIN values to be returned (except for France), developers will need to use a Trading WSDL with a version number of 1211 (or newer). For French VAT ID/VATIN values to be returned, developers will need to use a Trading WSDL with a version number of 1225 (or newer). Otherwise, the VAT information will be returned in the Order.ShippingAddress.Street2 field. Developers will also have the option of using older version, but setting the X-EBAY-API-COMPATIBILITY-LEVEL header value to 1211 or 1225 or higher.

On January 31, 2022, the Order.ShippingAddress.Street2 will stop being used to return VAT information regardless of WSDL version or compatibility level.

TransactionArray.Transaction
  .eBayCollectAndRemitTaxes
  .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
  .eBayCollectAndRemitTaxes
  .TaxDetails.CollectionMethod
CollectionMethodCodeType Conditionally This field indicates the collection method used to collect the 'eBay Collect and Remit' or 'Good and Services' tax for the order. This field is always returned for orders subject to 'Collect and Remit' or 'Good and Services' tax, and its value is always NET.

Note: Although the CollectionMethod field is returned for all orders subject to 'Collect and Remit' sales tax or 'Good and Services' tax, the CollectionMethod field and CollectionMethodCodeType are not currently of any practical use, although this field may have use in the future. If and when the logic of this field is changed, this note will be updated and a note will also be added to the Release Notes.

Applicable values:

NET
(out) This value is always returned, but because the CollectionMethod field and CollectionMethodCodeType are not currently applicable, this value does not have any purpose at this time.

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

Code so that your app gracefully handles any future changes to this list.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .eBayCollectAndRemitTaxes
  .TaxDetails.Imposition
TaxTypeCodeType Conditionally This field indicates the tax type. A separate TaxDetails container is returned for each unique imposition (tax type).

Applicable values: See Imposition.
Code so that your app gracefully handles any future changes to this list.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .eBayCollectAndRemitTaxes
  .TaxDetails.TaxAmount
AmountType (double) Conditionally This value is the total amount of tax charges for the order line item for the corresponding tax type (see Imposition value).

TaxAmount = TaxOnSubtotalAmount + TaxOnShippingAmount + TaxOnHandlingAmount

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .eBayCollectAndRemitTaxes
  .TaxDetails.TaxAmount
  [ attribute currencyID ]
CurrencyCodeType Always This value is the total amount of tax charges for the order line item for the corresponding tax type (see Imposition value).

TaxAmount = TaxOnSubtotalAmount + TaxOnShippingAmount + TaxOnHandlingAmount

For a list of possible enumeration values, see CurrencyCodeType.
TransactionArray.Transaction
  .eBayCollectAndRemitTaxes
  .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
  .eBayCollectAndRemitTaxes
  .TaxDetails.TaxDescription
TaxDescriptionCodeType Conditionally This enumeration value indicates the type of tax charged against the item.

Applicable values:

CustomCode
(out) Reserved for internal or future use.
ElectronicWasteRecyclingFee
(out) This enumeration value indicates that an electronic waste recycling fee was charged to the buyer against the order line item.
GST
(out) This enumeration value indicates that a Goods and Services import tax was charged to the buyer against the order line item.

Note: At this time, this tax type is only applicable to the Australia site.
SalesTax
(out) This enumeration value indicates that standard sales tax was charged to the buyer against the order line item.
TireRecyclingFee
(out) This enumeration value indicates that a tire recycling fee was charged to the buyer against the order line item.

Code so that your app gracefully handles any future changes to this list.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .eBayCollectAndRemitTaxes
  .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
  .eBayCollectAndRemitTaxes
  .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
  .eBayCollectAndRemitTaxes
  .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
  .eBayCollectAndRemitTaxes
  .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
  .eBayCollectAndRemitTaxes
  .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
  .eBayCollectAndRemitTaxes
  .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
  .eBayCollectAndRemitTaxes
  .TotalTaxAmount
AmountType (double) Conditionally This value indicates the total tax amount for the order line item, for all tax types, which may include sales tax (seller-applied or 'eBay Collect and Remit'), 'Goods and Services' tax (for Australian or New Zealand sellers), or other fees like an electronic waste recycling fee.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .eBayCollectAndRemitTaxes
  .TotalTaxAmount
  [ attribute currencyID ]
CurrencyCodeType Always This value indicates the total tax amount for the order line item, for all tax types, which may include sales tax (seller-applied or 'eBay Collect and Remit'), 'Goods and Services' tax (for Australian or New Zealand sellers), or other fees like an electronic waste recycling fee.

For a list of possible enumeration values, see CurrencyCodeType.
TransactionArray.Transaction
  .eBayPaymentID
string Conditionally The generated eBay payment ID used by the buyer when he/she chooses electronic transfer as payment method for paying the seller. This field is only applicable to the eBay Germany site (Site ID 77).
TransactionArray.Transaction
  .eBayPlusTransaction
boolean Conditionally If true, the buyer of the order line item has a eBay Plus program subscription, and is eligible to receive the benefits of this program, such as fast, free shipping and free returns. Top-Rated eBay sellers must opt in to eBay Plus to be able offer the program on qualifying listings. Sellers must commit to next-day delivery of those items.

Note: Currently, eBay Plus is available only to buyers in Germany and Australia.

See eBay Plus for more details.

TransactionArray.Transaction
  .ExtendedOrderID
string Conditionally A unique identifier for an eBay order. This field is only returned for paid orders, and not unpaid orders.
Note: ExtendedOrderID was first created when eBay changed the format of Order IDs back in June 2019. For a short period, the OrderID field showed the old Order ID format and the ExtendedOrderID field showed the new Order ID format. For paid orders, both OrderID and ExtendedOrderID now show the same Order ID value.
For GetOrders and GetItemTransactions only: If using Trading WSDL Version 1019 or above, this field will only be returned to the buyer or seller, and no longer returned at all to third parties. If using a Trading WSDL older than Version 1019, the correct Order ID is returned to the buyer or seller, but a dummy Order ID value of 1000000000000 will be returned to all third parties.

Max length: 40.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
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. As long as the IncludeFinalValueFee field is included in the call request and set to 'true', the Final Value Fee for each order line item is returned, 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.

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. As long as the IncludeFinalValueFee field is included in the call request and set to 'true', the Final Value Fee for each order line item is returned, 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.

For a list of possible enumeration values, see CurrencyCodeType.
TransactionArray.Transaction
  .Gift
boolean Conditionally This boolean field is returned as true if the seller is giving a digital gift card to another individual as a gift. This field is only applicable for digital gift card order line items.
TransactionArray.Transaction
  .GiftSummary
GiftSummaryType Conditionally This container is returned in GetOrders and other order management calls if a buyer has purchased a digital gift card but has sent it to another individual as a gift, and has left a message for the recipient. The GiftSummary container consists of the message that the buyer wrote for the recipient of the digital gift card. A digital gift card line item is indicated if the DigitalDeliverySelected container is returned in the response, and if the digital gift card is sent to another individual as a gift, the Gift boolean field will be returned with a value of true.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .GiftSummary.Message
string Conditionally This free-form text contains the message that the purchaser of the digital gift card left for the recipient of the gift card.

For GetItemTransactions only: If using Trading WSDL Version 1019 or above, this field will only be returned to the buyer or seller, and no longer returned at all to third parties. If using a Trading WSDL older than Version 1019, real data is only returned to the buyer or seller, and a string value of Unavailable will be returned to all third parties.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .GuaranteedDelivery
boolean Always This field is deprecated, and can be ignored if returned. The Guaranteed Delivery program is no longer supported on any eBay marketplace.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .GuaranteedShipping
boolean Conditionally Note: This field is for future use, as the eBay Guaranteed Shipping feature has been put on hold. eBay Guaranteed Shipping should not be confused with eBay Guaranteed Delivery, which is a completely different feature. This field is returned as true if the seller chose to use eBay's Guaranteed Shipping feature at listing time. With eBay's Guaranteed Shipping, the seller will never pay more for shipping than what is charged to the buyer. eBay recommends the shipping service option for the seller to use based on the dimensions and weight of the shipping package.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .IntangibleItem
boolean Always This flag indicates whether or not the order line item is an intangible good, such as an MP3 track or a mobile phone ringtone.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .InventoryReservationID
string Conditionally The unique identifier of the inventory reservation.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .InvoiceSentTime
dateTime Conditionally This field indicates the date/time that an order invoice was sent from the seller to the buyer. This field is only returned if an invoice (containing the order line item) was sent to the buyer.

DetailLevel: ReturnAll.
TransactionArray.Transaction
  .IsMultiLegShipping
boolean Conditionally Order line items requiring multiple shipping legs include items being shipped through the Global Shipping Program or through eBay International Shipping, as well as order line items subject to/eligible for the Authenticity Guarantee program. For both international shipping options, the address of the shipping logistics provider is shown in the MultiLegShippingDetails.SellerShipmentToLogisticsProvider.ShipToAddress container. Similarly, for Authenticity Guarantee orders, the authentication partner's shipping address is shown in the same container.

If an order line item is subject to the Authenticity Guarantee service, the Transaction.Program container will be returned.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .Item
ItemType Always This container consists of relevant details about the listing associated with the sales transaction. Which listing fields are returned under this container will depend on the listing, the eBay marketplace, and the API call.

In an AddOrder call, only the unique identifier of the listing (ItemID) is needed to help identify the sales transaction to combine into a 'Combined Invoice' order.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .Item.ApplicationData
string Conditionally Return 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.

Max length: 32.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .Item.AutoPay
boolean Always This field is included and set to if true in an Add/Revise/Relist call if the seller wants to require immediate payment from the buyer. If this field is set to false or not included, the seller is not requesting immediate payment.

Note that this field may be set to true, but that does not necessarily mean that the buyer will be required to pay right away. For example, immediate payment is not currently applicable to auctions items won in a competitive bidding process or to items where the buyer and seller negotiated the price through the Best Offer feature. Immediate payment is also not applicable to listings where the payment happens offline between the buyer and seller.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .Item.BuyItNowPrice
AmountType (double) Conditionally This field is only applicable for auction listings. By specifying a 'Buy It Now' price, a seller is allowing prospective buyers the opportunity to purchase the item in the auction listing at this price immediately. When a buyer uses the 'Buy It Now' option to purchase the item, the auction listing will end immediately.

By including this field and specifying a 'Buy It Now' price, the seller is enabling the 'Buy It Now' feature on the auction listing. If the seller includes this field for any other listing type other than an auction, this field and its price will just be ignored.

The price in this field must be at least 30 percent higher than the starting bid price (which is specified in an Add call through the Item.StartPrice field). Once a bid is made on an auction listing, and the bid meets or exceeds the Item.ReservePrice value (if set), the 'Buy It Now' option becomes unavailable, and this field will no longer be applicable. If there is no Reserve Price, the first bid will nullify the 'Buy It Now' option.

Keep in mind that GetItem (and other 'Get' calls that retrieve the Item details) may still return the BuyItNowPrice field for an auction item even if the 'Buy It Now' option is no longer available. Instead, a user should look for the ListingDetails.BuyItNowAvailable boolean field in the GetItem response to determine if the 'Buy It Now' option is still available for the auction item.

Note: For the US site, new eBay sellers are subject to Seller Limits, which limit the quantity of items that may be listed and/or the total cumulative value of these listings. While subject to these selling limits, an eBay seller can use the GetMyeBaySelling call to retrieve both the remaining number of listings they can create and the remaining cumulative value of these listings. These values are shown in the Summary.QuantityLimitRemaining and Summary.AmountLimitRemaining fields in the GetMyeBaySelling response. 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. These fields will only be returned if the seller is subject to seller limits.

DetailLevel: ReturnAll.
TransactionArray.Transaction
  .Item.BuyItNowPrice
  [ attribute currencyID ]
CurrencyCodeType Always This field is only applicable for auction listings. By specifying a 'Buy It Now' price, a seller is allowing prospective buyers the opportunity to purchase the item in the auction listing at this price immediately. When a buyer uses the 'Buy It Now' option to purchase the item, the auction listing will end immediately.

By including this field and specifying a 'Buy It Now' price, the seller is enabling the 'Buy It Now' feature on the auction listing. If the seller includes this field for any other listing type other than an auction, this field and its price will just be ignored.

The price in this field must be at least 30 percent higher than the starting bid price (which is specified in an Add call through the Item.StartPrice field). Once a bid is made on an auction listing, and the bid meets or exceeds the Item.ReservePrice value (if set), the 'Buy It Now' option becomes unavailable, and this field will no longer be applicable. If there is no Reserve Price, the first bid will nullify the 'Buy It Now' option.

Keep in mind that GetItem (and other 'Get' calls that retrieve the Item details) may still return the BuyItNowPrice field for an auction item even if the 'Buy It Now' option is no longer available. Instead, a user should look for the ListingDetails.BuyItNowAvailable boolean field in the GetItem response to determine if the 'Buy It Now' option is still available for the auction item.

Note: For the US site, new eBay sellers are subject to Seller Limits, which limit the quantity of items that may be listed and/or the total cumulative value of these listings. While subject to these selling limits, an eBay seller can use the GetMyeBaySelling call to retrieve both the remaining number of listings they can create and the remaining cumulative value of these listings. These values are shown in the Summary.QuantityLimitRemaining and Summary.AmountLimitRemaining fields in the GetMyeBaySelling response. 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. These fields will only be returned if the seller is subject to seller limits.

For a list of possible enumeration values, see CurrencyCodeType.
TransactionArray.Transaction
  .Item.Charity
CharityType Conditionally This container identifies the nonprofit organization that will benefit with a percentage of the proceeds from each sale of an item through an auction or fixed-price listing. Charity names and IDs can be found by going to eBay for Charity page and doing a search. The donation percentage can be set in 5 percent increments from 10 percent to 100 percent.

When it comes to revising an auction or fixed-price listing, you can add a benefitting charity (as long as there is at least 12 hours left before end of listing/close of auction), but you cannot remove or change a nonprofit company once one is already established in the original listing.

For Revise calls: The non-profit organization and donation percentage can now be modified in a Revise call as long as there are no active bids on an auction listing, or no pending Best Offers/Counter Offers on a listing.

This container will only be returned in Get calls for charitable listings. Charitable listings are only supported in the US and UK marketplaces.

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

See:
    Buying and selling on eBay to benefit nonprofit organizations
    Charitable listings

TransactionArray.Transaction
  .Item.Charity.CharityListing
boolean Conditionally If this field is returned as true, a percentage of order line item's purchase price will be donated to a nonprofit organization.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .Item.Country
CountryCodeType Conditionally This two-digit enumeration value indicates the country of the seller's registration address. CountryCodeType defines the supported values. The GeteBayDetails call can also be used (include the DetailName field and set its value to CountryDetails) to see the full list of supported country codes.

In an Add/Revise/Relist/Verify call, this field is required.

Applicable values: See Country.
Code so that your app gracefully handles any future changes to this list.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .Item.Currency
CurrencyCodeType Always In an Add/Revise/Relist/Verify call, this required three-digit enumeration value defines the currency associated with the listing site. The item price and all costs passed in the call request will be using this currency. Similarly, the listing fees and other cost-related data will be using this currency. Since the Trading API can only be used for a select number of eBay sites, only a subset of values are supporting when adding/revising/relisting an item. These supported values are discussed in the top section of CurrencyCodeType.

In 'Get' calls, it is possible that any of the values in CurrencyCodeType may appear, as some cost-related fields will show the buyer's currency type.

Applicable values: See Currency.
Code so that your app gracefully handles any future changes to this list.

DetailLevel: ItemReturnDescription, 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 a seller will be converting an existing eBay listing into the new Inventory model using the bulkMigrateListings call of the Inventory API, the InventoryTrackingMethod value must be set to ItemID (default value), but the item must also have a SKU value (Item.SKU or Variation.SKU) associated with it. For GetItem and related calls: Only returned when the value is SKU; not returned when the value is ItemID.


Applicable values:

CustomCode
(in/out) Reserved for internal or future use.
ItemID
(in/out) Indicates the seller prefers to track the listing by its eBay item ID. This is the default for all listings.
SKU
(in/out) Indicates the seller prefers to track the listing by their own SKU.

When you track by SKU, it means you can pass in 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.

Code so that your app gracefully handles any future changes to this list.

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 unique identifier of the eBay listing. This identifier is generated by eBay and returned in the response of an Add call if an item is successfully listed. Once an item is successfully created, the ItemID cannot be modified.

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. Your code should be prepared to handle IDs of up to 19 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.

In an Add/Revise/Relist call, this container is used to set the Best Offer Auto-Accept and Best Offer Auto-Decline threshold values.

DetailLevel: ReturnAll.
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.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.ListingType
ListingTypeCodeType Always The selling format of the eBay listing, such as auction (indicated with Chinese value), fixed-price (indicated with FixedPriceItem value), or classified ad (indicated with AdType value).

If this field is not included in an AddItem, AddItems, or VerifyAddItem call, the listing type defaults to auction

For AddFixedPriceItem, RelistFixedPriceItem, or VerifyAddFixedPriceItem call, this field must be included and set to FixedPriceItem, since these calls only work with fixed-price listings.

This field is not applicable to Revise calls because the selling format of active listings cannot be changed.

Applicable values: See ListingType.
Code so that your app gracefully handles any future changes to this list.

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

See Listing types.

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.

Max: 450,000.

DetailLevel: ReturnAll.
TransactionArray.Transaction
  .Item.PrivateListing
boolean Always A true value in this field indicates that the listing is private. Sellers may want to use this option when they believe that a listing's potential bidders/buyers would not want their obfuscated user IDs (and feedback scores) exposed to other users.

For ReviseItem/ReviseFixedPriceItem: The seller will not be able change this setting if the listing has any pending bids, any pending best offers, previous sales (for multiple-quantity, fixed-price listing), or if the listing will end within 12 hours.


DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .Item.Quantity
int Always For AddItem family of calls: The Quantity value for auction listings must always be 1. For a fixed-price listing, the Quantity value indicates the number of identical items the seller has available for sale in the listing. If this field is not included when creating a new fixed-price listing, quantity defaults to '1'. If variations are specified in AddFixedPriceItem or VerifyAddFixedPriceItem, the Item.Quantity is not required since the quantity of variations is specified in Variation.Quantity instead. See the Creating a listing with variations eBay Help page for more information on variations.

For ReviseItem and ReviseFixedPriceItem: This value can only be changed for a fixed-price listing with no variations. The quantity of variations is controlled in the Variation.Quantity field and the Item.Quantity value for an auction listing should always be 1.

For RelistItem and RelistFixedPriceItem: Like most fields, when you use RelistItem or RelistFixedPriceItem, Quantity retains its original value unless you specifically change it. This means that the item is relisted with the value that was already in Quantity, not with the remaining quantity available. For example, if the original Quantity value was 10, and three items have been sold, eBay sets the relisted item's Quantity to 10 by default, and not 7. So, we strongly recommend that you always set Quantity to the correct value (your actual quantity available) in your relist requests.

When eBay auto-renews a GTC listing (ListingDuration = GTC) on your behalf, eBay relists with correct quantity available.

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.

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).

Note: For the US site, new eBay sellers are subject to Seller Limits, which limit the quantity of items that may be listed and/or the total cumulative value of these listings. While subject to these selling limits, an eBay seller can use the GetMyeBaySelling call to retrieve both the remaining number of listings they can create and the remaining cumulative value of these listings. These values are shown in the Summary.QuantityLimitRemaining and Summary.AmountLimitRemaining fields in the GetMyeBaySelling response. 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. These fields will only be returned if the seller is subject to seller limits.

DetailLevel: ReturnAll.
TransactionArray.Transaction
  .Item.SellingStatus
SellingStatusType Always Various details about the current status of the listing, such as the current number of bids, the current high bidder, quantity sold, current price, and listing status.

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, and GetOrders, 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.

See the Selling fees help page for more information about how Final Value Fees are calculated.

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, and GetOrders, 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.

See the Selling fees help page for more information about how Final Value Fees are calculated.

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 transaction fees. This processing can take several minutes.
  • If you retrieve a sold item and no details about the buyer/high bidder are returned or no transaction fees are 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. 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 should be considered accurate and complete. In this state, all transaction fees should be calculated.
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 should be considered accurate and complete. However, the transaction fees are not yet available.

Code so that your app gracefully handles any future changes to this list.

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 eBay listing site. 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 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 site, the visibility of the item in some types of searches (e.g., GetCategoryListings), 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).

Applicable values: See Site.
Code so that your app gracefully handles any future changes to this list.

DetailLevel: ReturnAll.
TransactionArray.Transaction
  .Item.SKU
SKUType (string) Conditionally A SKU (Stock Keeping Unit) value is a seller-defined identifier for a product. Each product within a seller's inventory should be unique. Most large-volume sellers use SKUs, but eBay only requires a SKU value if the InventoryTrackingMethod field is included in an AddFixedPriceItem call and its value is set to SKU. Setting the InventoryTrackingMethod field to SKU allows the seller to use a SKU value instead of an ItemID value as a unique identifier in calls such as GetItem and ReviseInventoryStatus

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.)

If both ItemID and SKU are specified in calls that support the use of SKU as a unique identifier, the ItemID value takes precedence.

If a seller wants to use SKUs for multiple-variation listings, the SKU value for each product variation is actually specified at the variation level (Item.Variations.Variation.SKU) field, and the Item.SKU) field should not be included in the call request.

Note: The eBay site 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 GetItem, GetMyeBaySelling, and other 'Get' call, the SKU value will only be returned if defined for the listing.

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 The original price of the item at listing or re-listing time. If this value changes when the item is revised, the new value becomes the original price.

For auction listings: Competitive bidding starts at this value. Once at least one bid has been placed, StartPrice remains the same but CurrentPrice is incremented to the amount of each succeeding bid. If ReservePrice is also specified, the value of StartPrice must be lower than the value of ReservePrice.

For input on fixed-price listings (FixedPriceItem): This is the constant price at which a buyer may purchase the item.

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.

For Revise calls: If the StartPrice value for a fixed-price item is changed with a Revise call, the MinimumBestOfferPrice and BestOfferAutoAcceptPrice fields in the ListingDetails container will be dropped (if set), basically turning off the Best Offer Auto Accept and/or Auto Decline features. If the seller wanted to reintroduce either of these Best Offer threshold values in the listing again, an additional Revise call would have to be made, passing in the desired threshold values.

Note: For the US site, new eBay sellers are subject to Seller Limits, which limit the quantity of items that may be listed and/or the total cumulative value of these listings. While subject to these selling limits, an eBay seller can use the GetMyeBaySelling call to retrieve both the remaining number of listings they can create and the remaining cumulative value of these listings. These values are shown in the Summary.QuantityLimitRemaining and Summary.AmountLimitRemaining fields in the GetMyeBaySelling response. 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. These fields will only be returned if the seller is subject to seller limits.

DetailLevel: ReturnAll.

See Listing Policies.

TransactionArray.Transaction
  .Item.StartPrice
  [ attribute currencyID ]
CurrencyCodeType Always The original price of the item at listing or re-listing time. If this value changes when the item is revised, the new value becomes the original price.

For auction listings: Competitive bidding starts at this value. Once at least one bid has been placed, StartPrice remains the same but CurrentPrice is incremented to the amount of each succeeding bid. If ReservePrice is also specified, the value of StartPrice must be lower than the value of ReservePrice.

For input on fixed-price listings (FixedPriceItem): This is the constant price at which a buyer may purchase the item.

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.

For Revise calls: If the StartPrice value for a fixed-price item is changed with a Revise call, the MinimumBestOfferPrice and BestOfferAutoAcceptPrice fields in the ListingDetails container will be dropped (if set), basically turning off the Best Offer Auto Accept and/or Auto Decline features. If the seller wanted to reintroduce either of these Best Offer threshold values in the listing again, an additional Revise call would have to be made, passing in the desired threshold values.

Note: For the US site, new eBay sellers are subject to Seller Limits, which limit the quantity of items that may be listed and/or the total cumulative value of these listings. While subject to these selling limits, an eBay seller can use the GetMyeBaySelling call to retrieve both the remaining number of listings they can create and the remaining cumulative value of these listings. These values are shown in the Summary.QuantityLimitRemaining and Summary.AmountLimitRemaining fields in the GetMyeBaySelling response. 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. These fields will only be returned if the seller is subject to seller limits.

For a list of possible enumeration values, see CurrencyCodeType.
TransactionArray.Transaction
  .Item.Title
string Conditionally This field is used to specify the title of the listing. This field is conditionally required in an Add call unless the seller successfully uses the ProductListingDetails container to find an eBay catalog product match. When the seller successfully uses an eBay catalog product to create a listing, the listing title, listing description, Item Specifics, and stock photo defined in the catalog product are used to create the listing.

You cannot use HTML or JavaScript in the Title. (HTML characters will be interpreted literally as plain text.)

The listing title can only be changed if the active listing has yet to have any bids or sales, and the listing does not end within 12 hours.
Note: When making a GetSellerEvents call, this field will be returned masked as ***************** for on-hold listings. Note: When making a GetSellerTransactions or GetMyeBaySelling call, the item ID value of the listing will be returned in this field to indicate that the listing is on hold.
Max length: 80.

DetailLevel: ReturnAll.
TransactionArray.Transaction
  .LogisticsPlanType
token Conditionally This field will be returned at the order line item level only if the buyer purchased a digital gift card, which is delivered by email, or if the buyer purchased an item that is enabled with the 'Click and Collect' feature.

Currently, LogisticsPlanType has two applicable values: PickUpDropOff, which indicates that the buyer selected the 'Click and Collect' option. With Click and Collect, buyers are able to purchase from thousands of sellers on the eBay UK and Australia sites, and then pick up their order from the nearest 'eBay Collection Point', including over 750 Argos stores in the UK. The Click and Collect feature is only available on the eBay UK and Australia sites; or, DigitalDelivery, which indicates that the order line item is a digital gift card that will be delivered to the buyer or recipient of the gift card by email.

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

Applicable values: See LogisticsPlanCodeType
TransactionArray.Transaction
  .MonetaryDetails
PaymentsInformationType Conditionally Contains information about each monetary transaction that occurs for the order line item, including order payment, any refund, a credit, etc. Both the payer and payee are shown in this container.

Note: MonetaryDetails can already be used instead of the older ExternalTransaction container, and the ExternalTransaction container may eventually get deprecated. Due to this possibility, you are encouraged to start using MonetaryDetails as soon as it is convenient.

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..*]
This container consists of detailed information about each payment made by the buyer to pay for an order. In many cases, there may be only one payment - the payment made from the buyer to the seller, but in the case of an order going through the Global Shipping Program, one payment goes to the seller for the price of the order, and then an import charge and a portion of the shipping charges may go to eBay Global Shipping Program partner. In the case of an order that is subject to Australia import tax, one payment goes to the seller for the total price of the order, and the import tax goes to eBay for remittance to the Australian government.

Note: Australia import tax is only applicable to the Australia site.

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 This field indicates the eBay user or eBay partner who submitted the payment.

For GetOrders and GetItemTransactions only: If using Trading WSDL Version 1019 or above, this field will only be returned to the buyer or seller, and no longer returned at all to third parties. If using a Trading WSDL older than Version 1019, the correct payer is returned to the buyer or seller, but the identity of the payer will be masked to all third parties.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .MonetaryDetails.Payments
  .Payment.Payer
  [ attribute type ]
UserIdentityCodeType Conditionally This field indicates the eBay user or eBay partner who submitted the payment.

For GetOrders and GetItemTransactions only: If using Trading WSDL Version 1019 or above, this field will only be returned to the buyer or seller, and no longer returned at all to third parties. If using a Trading WSDL older than Version 1019, the correct payer is returned to the buyer or seller, but the identity of the payer will be masked to all third parties.

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.

For GetOrders and GetItemTransactions only: If using Trading WSDL Version 1019 or above, this field will only be returned to the buyer or seller, and no longer returned at all to third parties. If using a Trading WSDL older than Version 1019, the correct payment identifier is returned to the buyer or seller, but the payment identifier will be masked to all third parties.

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 GetOrders and GetItemTransactions only: If using Trading WSDL Version 1019 or above, this field will only be returned to the buyer or seller, and no longer returned at all to third parties. If using a Trading WSDL older than Version 1019, the correct payment identifier is returned to the buyer or seller, but the payment identifier will be masked to all third parties.

For a list of possible enumeration values, see TransactionReferenceCodeType.
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.

For GetOrders and GetItemTransactions only: If using Trading WSDL Version 1019 or above, this field will only be returned to the buyer or seller, and no longer returned at all to third parties. If using a Trading WSDL older than Version 1019, the correct payment identifier is returned to the buyer or seller, but the payment identifier will be masked to all third parties.

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 GetOrders and GetItemTransactions only: If using Trading WSDL Version 1019 or above, this field will only be returned to the buyer or seller, and no longer returned at all to third parties. If using a Trading WSDL older than Version 1019, the correct payment identifier is returned to the buyer or seller, but the payment identifier will be masked to all third parties.

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 on the US site, and can only be applied to multi-quantity, fixed-price listings. Eligible 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 in US, 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 in US, 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.

For GetOrders and GetItemTransactions only: If using Trading WSDL Version 1019 or above, this field will only be returned to the buyer or seller, and no longer returned at all to third parties. If using a Trading WSDL older than Version 1019, the correct payment identifier is returned to the buyer or seller, but the payment identifier will be masked to all third parties.

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 in US, 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.

For GetOrders and GetItemTransactions only: If using Trading WSDL Version 1019 or above, this field will only be returned to the buyer or seller, and no longer returned at all to third parties. If using a Trading WSDL older than Version 1019, the correct payment identifier is returned to the buyer or seller, but the payment identifier will be masked to all third parties.

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 in US, 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 for In-Store Pick or Click and Collect orders where the merchant issued the buyer a store credit instead of a refund (RefundType=STORE_CREDIT).
Note: For GetItemTransactions and GetSellerTransactions, the final value fee amount deducted from the seller's payout funds for the sale is not included in this field, which means that the amount in this field may not reflect the buyer's actual refund amount.

The logic will remain the same for GetItemTransactions and GetSellerTransactions, but the GetOrders call will be updated to include the the seller's final value fee amount in this field, so the amount in this field should match the buyer's actual refund amount. To pick up this new logic in GetOrders responses, a Trading WSDL version of 1311 or above must be used, or the user can use an older Trading WSDL version but include and set the X-EBAY-API-COMPATIBILITY-LEVEL header value to 1311 or above.


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 for In-Store Pick or Click and Collect orders where the merchant issued the buyer a store credit instead of a refund (RefundType=STORE_CREDIT).
Note: For GetItemTransactions and GetSellerTransactions, the final value fee amount deducted from the seller's payout funds for the sale is not included in this field, which means that the amount in this field may not reflect the buyer's actual refund amount.

The logic will remain the same for GetItemTransactions and GetSellerTransactions, but the GetOrders call will be updated to include the the seller's final value fee amount in this field, so the amount in this field should match the buyer's actual refund amount. To pick up this new logic in GetOrders responses, a Trading WSDL version of 1311 or above must be used, or the user can use an older Trading WSDL version but include and set the X-EBAY-API-COMPATIBILITY-LEVEL header value to 1311 or above.


For a list of possible enumeration values, see CurrencyCodeType.
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 in US, 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.

For GetOrders and GetItemTransactions only: If using Trading WSDL Version 1019 or above, this field will only be returned to the buyer or seller, and no longer returned at all to third parties. If using a Trading WSDL older than Version 1019, the correct refund recipient is returned to the buyer or seller, but the refund recipient will be masked to all third parties.

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 in US, 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.

For GetOrders and GetItemTransactions only: If using Trading WSDL Version 1019 or above, this field will only be returned to the buyer or seller, and no longer returned at all to third parties. If using a Trading WSDL older than Version 1019, the correct refund recipient is returned to the buyer or seller, but the refund recipient will be masked to all third parties.

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 in US, 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 in US, 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).

Code so that your app gracefully handles any future changes to this list.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .MultiLegShippingDetails
MultiLegShippingDetailsType Conditionally This container consists of details related to the first leg of an order requiring multiple shipping legs. Types of orders that require multiple shipping legs include international orders going through the Global Shipping Program or through eBay International Shipping, as well as orders subject to/eligible for the Authenticity Guarantee program.

If the item is subject to the Authenticity Guarantee service program, the seller ships the item to the authentication partner, and if the item passes an authentication inspection, the authentication partner ships it directly to the buyer.

This container is only returned if the order has one or more order line items requiring multiple shipping legs.

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 international order being shipped through the Global Shipping Program or eBay International Shipping, including the 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 or an eBay International Shipping 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 or an eBay International Shipping 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 or an eBay International Shipping shipment.

For a list of possible enumeration values, see CurrencyCodeType.
TransactionArray.Transaction
  .MultiLegShippingDetails
  .SellerShipmentToLogisticsProvider
  .ShippingTimeMax
int Conditionally The integer value returned here indicates the maximum number of business days that the corresponding shipping service (indicated in ShippingServiceDetails.ShippingService field) will take to be delivered to eBay's domestic shipping partner.

This maximum shipping time does not include the seller's handling time, and the clock starts on the shipping time only after the seller has delivered the item to the shipping carrier for shipment to eBay's domestic shipping partner. 'Business days' can vary by shipping carrier and by country, but 'business days' are generally Monday through Friday, excluding holidays. This field is returned if defined for that particular shipping service option.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .MultiLegShippingDetails
  .SellerShipmentToLogisticsProvider
  .ShippingTimeMin
int Conditionally The integer value returned here indicates the minimum number of business days that the corresponding shipping service (indicated in ShippingServiceDetails.ShippingService field) will take to be delivered to eBay's domestic shipping partner.

This minimum shipping time does not include the seller's handling time, and the clock starts on the shipping time only after the seller has delivered the item to the shipping carrier for shipment to eBay's domestic shipping partner. 'Business days' can vary by shipping carrier and by country, but 'business days' are generally Monday through Friday, excluding holidays. This field is returned if defined for that particular shipping service option.

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 or an eBay International Shipping shipment. For 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. For an eBay International Shipping shipment, the eBay Virtual Tracking Number is returned in the field.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .MultiLegShippingDetails
  .SellerShipmentToLogisticsProvider
  .ShipToAddress.AddressOwner
AddressOwnerCodeType Conditionally This enumeration value returned here indicates the company that has the address on file. The value returned here should always be eBay.

Applicable values:

CustomCode
(out) Reserved for internal or future use.
eBay
(out) This value indicates that the buyer's shipping address being referenced is on file with eBay.

Code so that your app gracefully handles any future changes to this list.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .MultiLegShippingDetails
  .SellerShipmentToLogisticsProvider
  .ShipToAddress.CityName
string Conditionally The city associated with an address on file with eBay. Most addresses include a city name, but not all. For example, Singapore is an island city-state, so SG would appear in the Country field, and 'Singapore' or 'Republic of Singapore' would appear in the CountryName field, but the CityName field is not applicable.

Max length: GB, DE - 35; US, CA - 40; AU - 80; Other countries - 50.

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.



Applicable values: See Country.
Code so that your app gracefully handles any future changes to this list.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .MultiLegShippingDetails
  .SellerShipmentToLogisticsProvider
  .ShipToAddress.CountryName
string Conditionally The full name of the country associated with an address on file with eBay.

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.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.

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.

Max length: GB, DE - 35; US, CA - 40; AU - 80; Other countries - 50.

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" Note: International orders being sent through eBay International Shipping also contain reference IDs, but reference IDs for eBay International Shipping will be returned in the Street2 field instead.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .MultiLegShippingDetails
  .SellerShipmentToLogisticsProvider
  .ShipToAddress.StateOrProvince
string Conditionally The state or province associated with an address on file with eBay. Whether it's a state or a province will depend on the region and/or country. This field should only be passed in or returned if applicable/defined.

Max length: GB, DE - 35; US, CA - 40; AU - 80; Other countries - 50.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .MultiLegShippingDetails
  .SellerShipmentToLogisticsProvider
  .ShipToAddress.Street1
string Conditionally The first line of the user's street address.

Note: Note the different maximum lengths noted below for different countries. If a street name exceeds the maximum length for the applicable country, the full street name may be expressed through both the Street1 and Street2 fields.
Max length: GB, DE - 35; US, CA - 40; AU - 80; Other countries - 50.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .MultiLegShippingDetails
  .SellerShipmentToLogisticsProvider
  .ShipToAddress.Street2
string Conditionally The second line of the user's street address (such as an apartment number or suite number).

Returned if the user specified a second street value for their address.
Note: In case of Item.SellerContactDetails, Street2 can be used to provide City, Address, State, and Zip code (if applicable). Note: Note the different maximum lengths noted below for different countries. If a street name exceeds the maximum length for the applicable country, the full street name may be expressed through both the Street1 and Street2 fields. Note: In the case of TransactionArray.Transaction.MultiLegShippingDetails.SellerShipmentToLogisticsProvider.ShipToAddress, if the item is being shipped through eBay International Shipping and this address refers to an intermediated warehouse address, the eBay Virtual Tracking number (eVTN) that is used for the domestic leg of the shipment is appended to Street2. This value is generated by eBay when the order is completed. Example:"Reference #1234567890123456"
Max length: GB, DE - 35; US, CA - 40; AU - 80; Other countries - 50.

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 identifier is created as soon as there is a commitment to buy from the seller, or the buyer actually purchases the item using a 'Buy it Now' option.

For GetOrders and GetItemTransactions only: If using Trading WSDL Version 1019 or above, this field will only be returned to the buyer or seller, and no longer returned at all to third parties. If using a Trading WSDL older than Version 1019, order line item ID is only returned to the buyer or seller, and a dummy value of 10000000000000 will be returned to all third parties.


DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .PaidTime
dateTime Conditionally Indicates the time when the buyer paid for the order and/or order was marked as 'Paid' by the seller. This field is returned once payment has been made by the buyer.

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 through eBay's system
  • Seller marks the item as paid in My eBay or through Selling Manager Pro
  • Programmatically by the seller through the CompleteSale call.


DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .PickupDetails
PickupDetailsType Conditionally Container consisting of an array of PickupOptions containers. Each PickupOptions container consists of the pickup method and its priority. 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.

This container is always returned prior to order payment if the seller created/revised/relisted the item with the EligibleForPickupInStore and/or EligibleForPickupDropOff flag in the call request set to 'true'. If and when the In-Store pickup method (US only) or 'Click and Collect' pickup method (UK and Australia only) 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: A seller must be eligible for the In-Store Pickup feature or Click and Collect feature to list an item that is eligible for In-Store Pickup or Click and Collect. At this time, the In-Store Pickup and Click and Collect features are generally only available to large retail merchants, and can only be applied to multiple-quantity, fixed-price listings.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .PickupDetails.PickupOptions
PickupOptionsType Conditionally,
repeatable: [0..*]
Container consisting of a 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.

This container is always returned prior to order payment if the seller created/revised/relisted the item with the EligibleForPickupInStore and/or EligibleForPickupDropOff flag in the call request set to 'true'. If and when the In-Store pickup method (US only) or 'Click and Collect' pickup method (UK and Australia only) 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 and Click and Collect features are generally only available to large retail merchants, and can only be applied to multi-quantity, fixed-price listings. In-Store Pickup is only applicable to the US site, and Click and Collect is only applicable to the UK, Germany, and Australia sites.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .PickupDetails.PickupOptions
  .PickupMethod
token Conditionally This value indicates an available pickup method. This field is always returned with the PickupOptions container.

Note: At this time, 'InStorePickup' and 'PickUpDropOff' are the only available pickup methods; however, additional pickup methods may be added to the list in future releases.
Note: A seller must be eligible for the In-Store Pickup or Click and Collect feature to list an item that is eligible for In-Store Pickup or Click and Collect. At this time, In-Store Pickup is generally only available to large retail merchants in US, and the 'Click and Collect' feature is only available to large merchants on the eBay UK (site ID - 3), eBay Australia (Site ID - 15), and eBay Germany (Site ID - 77) sites.

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. This field is always returned with the PickupOptions container.

Note: A seller must be eligible for the In-Store Pickup or Click and Collect features to list an item that is eligible for In-Store Pickup or Click and Collect. At this time, In-Store Pickup is generally only available to large retail merchants in US, and the 'Click and Collect' feature is only available to large merchants on the eBay UK (site ID - 3), eBay Australia (Site ID - 15), and eBay Germany (Site ID - 77) sites.

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.

For GetOrders and GetItemTransactions only: If using Trading WSDL Version 1019 or above, this field will only be returned to the buyer or seller, and no longer returned at all to third parties. If using a Trading WSDL older than Version 1019, the real reference number is only returned to the buyer or seller, and a string value of Unavailable will be returned to all third parties.

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 in US, 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. This field will only be returned if supplied by the merchant.

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 or Click and Collect features to list an item that is eligible for these features. At this time, these features are generally only available to large retail merchants in US, 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: See PickupStatus.
Code so that your app gracefully handles any future changes to this list.

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 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 in US, 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 the site on which the sales transaction originated.

Note: Currently, the only value that should be returned in this field is eBay, as the Half.com marketplace no longer exists.

Applicable values:

eBay
(out) This value indicates the purchase occurred on an eBay marketplace site.

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

Code so that your app gracefully handles any future changes to this list.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .Program
TransactionProgramType Conditionally This container gives the status of an order line item going through the Authenticity Guarantee service process. In the Authenticity Guarantee service program, a third-party authenticator must verify the authenticity of the item before it can be sent to the buyer.

This container is only returned for order line items subject to the Authenticity Guarantee service process, and if it is returned, the seller must make sure to send the item to the third-party authenticator's address (shown in the MultiLegShippingDetails.SellerShipmentToLogisticsProvider.ShipToAddress field), and not to the buyer's shipping address. If the item is successfully authenticated, the authenticator will ship the item to the buyer.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .Program
  .AuthenticityVerification
AuthenticityVerificationType Conditionally This container gives status on whether the order line item has passed or failed the authenticity inspection.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .Program
  .AuthenticityVerification
  .OutcomeReason
string Conditionally This field is returned after the third-party authenticator has performed the authentication inspection on the order line item.

Different values will be returned based on whether the item passed or failed the authentication inspection. This field is not returned when the status value of the order line item is PENDING or PASSED. The possible values returned here are CUSTOMIZED, MISCATEGORIZED, NOT_AUTHENTIC, NOT_AS_DESCRIBED, or NOT_AUTHENTIC_NO_RETURN.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .Program
  .AuthenticityVerification
  .ServiceCost
ServiceCostType Conditionally This container shows service cost to the buyer for an item that will go through the Authenticity Guarantee process.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .Program
  .AuthenticityVerification
  .ServiceCost.Amount
AmountType (double) Conditionally The amount charged to the buyer for any service cost related to an item going through the Authenticity Guarantee process. This amount is given in the currency of the listing site.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .Program
  .AuthenticityVerification
  .ServiceCost.Amount
  [ attribute currencyID ]
CurrencyCodeType Always The amount charged to the buyer for any service cost related to an item going through the Authenticity Guarantee process. This amount is given in the currency of the listing site.

For a list of possible enumeration values, see CurrencyCodeType.
TransactionArray.Transaction
  .Program
  .AuthenticityVerification
  .ServiceCost
  .ConvertedFromAmount
AmountType (double) Conditionally The amount (in the buyer's currency) charged to the buyer for any service cost related to an item going through the Authenticity Guarantee process. This amount is only applicable if the buyer resides in another country that uses a different currency than the currency of the listing site.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .Program
  .AuthenticityVerification
  .ServiceCost
  .ConvertedFromAmount
  [ attribute currencyID ]
CurrencyCodeType Always The amount (in the buyer's currency) charged to the buyer for any service cost related to an item going through the Authenticity Guarantee process. This amount is only applicable if the buyer resides in another country that uses a different currency than the currency of the listing site.

For a list of possible enumeration values, see CurrencyCodeType.
TransactionArray.Transaction
  .Program
  .AuthenticityVerification
  .Status
string Conditionally The value in this field indicates whether the order line item has passed or failed the authenticity inspection, or if the test and/or results are still pending. The possible values returned here are PENDING, PASSED, PASSED_WITH_EXCEPTION, PASSED_WITH_PARTIAL_FAILURE, or FAILED.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .Program.Fulfillment
FulfillmentType Conditionally This container provides details about an order line item being handled by eBay fulfillment. It is only returned for paid orders being fulfilled by eBay or an eBay fulfillment partner.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .Program.Fulfillment
  .FulfillmentBy
string Conditionally The value returned in this field indicates the party that is handling fulfillment of the order line item.

For eBay Vault scenarios, for the GetOrders GetItemTransactions, and GetSellerTransactions calls, this value is returned as EBAY for either of the following fulfillment options:
  • Vault to Vault
  • Vault to Buyer


DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .Program.Fulfillment
  .FulfillmentRefId
string Conditionally The value in this field identifies the warehouse where the order line item is located.

For eBay Vault scenarios: GetOrders and GetSellerTransactions calls, if FulfillmentBy is returned as EBAY, FulfillmentRefId is not returned.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .QuantityPurchased
int Conditionally This value indicates the quantity of the line item 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.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .SellerDiscounts
SellerDiscountsType Conditionally 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. This container is only returned if the order line item is eligible for 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 (before any seller discounts are applied).

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 (before any seller discounts are applied).

For a list of possible enumeration values, see CurrencyCodeType.
TransactionArray.Transaction
  .SellerDiscounts
  .OriginalShippingService
token Conditionally The original shipping service offered by the seller to ship an item to a buyer.

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

Applicable values: See ShippingServiceCodeType
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.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .SellerDiscounts
  .SellerDiscount
  .CampaignDisplayName
string Conditionally The name of the seller discount campaign. 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.
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.
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.

Note: Prior to Version 895, this field worked a little differently. Instead of this field showing the amount of the discount, it was actually showing the final item price after the discount was applied. So, if an item price is 10.0 dollars and the discount is 2.0 dollars, someone using Version 895 (and going forward) will see a value of '2.0' (amount of the discount) in this field, but anyone using Version 893 or lower will see a value of '8.0' (item price after discount) in this field.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
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.

Note: Prior to Version 895, this field worked a little differently. Instead of this field showing the amount of the discount, it was actually showing the final item price after the discount was applied. So, if an item price is 10.0 dollars and the discount is 2.0 dollars, someone using Version 895 (and going forward) will see a value of '2.0' (amount of the discount) in this field, but anyone using Version 893 or lower will see a value of '8.0' (item price after discount) in this field.

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.

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.

For a list of possible enumeration values, see CurrencyCodeType.
TransactionArray.Transaction
  .ShippedTime
dateTime Conditionally Indicates the time when the line item was 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' by purchasing an eBay shipping label, providing shipment tracking in My eBay or through Selling Manager Pro, or programmatically by the seller through the CompleteSale call.

Note: This field does not appear in Merchant Data API's OrderReport responses, because once shipment tracking information is provided to the buyer (or marked as shipped), the order/order line item is considered acknowledged, and acknowledged orders do not show up in OrderReport responses.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ShippingDetails
ShippingDetailsType Conditionally Container consisting of shipping-related details for a sales transaction. Shipping details may include shipping rates, package dimensions, handling costs, excluded shipping locations (if specified), shipping service options, sales tax information (if applicable), and shipment tracking details (if shipped).

Note: For GetOrders, a ShippingDetails container is returned at the order at line item level.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
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.

Note: The CalculatedShippingRate container should only be used to specify values for the InternationalPackagingHandlingCosts and/or PackagingHandlingCosts fields. The rest of the fields in the CalculatedShippingRate container are used to specify package dimensions and package weight, and these values should now be specified in the ShippingPackageDetails container instead.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ShippingDetails
  .CalculatedShippingRate
  .InternationalPackagingHandlingCosts
AmountType (double) Conditionally This field shows any package handling cost applied to international shipping. This cost will be in addition to any shipping cost applicable to each international shipping service option.

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 This field shows any package handling cost applied to international shipping. This cost will be in addition to any shipping cost applicable to each international shipping service option.

For international calculated shipping only.

For a list of possible enumeration values, see CurrencyCodeType.
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. Note: If the listing only has one domestic shipping service and it is free shipping, the domestic package handling cost will be ignored and will not be applied to the listing.

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. Note: If the listing only has one domestic shipping service and it is free shipping, the domestic package handling cost will be ignored and will not be applied to the listing.

For a list of possible enumeration values, see CurrencyCodeType.
TransactionArray.Transaction
  .ShippingDetails
  .eBayEstimatedLabelCost
AmountType (double) Conditionally This dollar value indicates the cost to buy the shipping label from eBay. Presently, this field is only returned for orders that will go through eBay shipping and its value will be 0.0. With eBay shipping, a free shipping label by eBay is downloadable by the seller via the eBay website.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ShippingDetails
  .eBayEstimatedLabelCost
  [ attribute currencyID ]
CurrencyCodeType Always This dollar value indicates the cost to buy the shipping label from eBay. Presently, this field is only returned for orders that will go through eBay shipping and its value will be 0.0. With eBay shipping, a free shipping label by eBay is downloadable by the seller via the eBay website.

For a list of possible enumeration values, see CurrencyCodeType.
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.)

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ShippingDetails.SalesTax
SalesTaxType Conditionally This container shows sales tax information for an item in a specific tax jurisdiction. The concept of 'sales tax' is only applicable to eBay US and Canada (English and French) sites.

This container can be used in an Add/Revise/Relist/Verify call to set sales tax settings for a specific tax jurisdiction, but it is actually a better practice if a user sets up sales tax rates through the Sales Tax Table tool in My eBay (or by using the SetTaxTable call). A seller's Sales Tax Table is applied to the listing by including the UseTaxTable field in the request and setting its value to true. The GetTaxTable call can be used to retrieve the current sales tax rates for different tax jurisdictions.

This container is only returned in order management 'Get' calls if sales tax is applicable to the order line item. For eBay Collect and Remit states, the sales tax information is displayed in the Transaction.Taxes container instead.

Note: Buyers in all 50 US states and DC are automatically charged sales tax for eBay purchases, and eBay collects and remits this sales tax to the proper taxing authority on the buyer's behalf. Because of this, if a sales tax percentage rate is applied to a listing by a seller in one of these states, this field will be ignored during the checkout process.

Currently, sales tax percentage rates can only be specified by sellers in Canada and 5 US territories, including American Samoa (AS), Guam (GU), Northern Mariana Islands (MP), Palau (PW), and Virgin Islands (VI).


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

See Multi-jurisdiction sales tax.

TransactionArray.Transaction
  .ShippingDetails.SalesTax
  .SalesTaxAmount
AmountType (double) Conditionally The amount of sales tax calculated for an order line item based on the sale price and the sales tax rate for the buyer's tax jurisdiction. For a multiple line item order, the SalesTaxAmount returned at the order level will be the cumulative amount for all line items in the order.

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.

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 line item based on the sale price and the sales tax rate for the buyer's tax jurisdiction. For a multiple line item order, the SalesTaxAmount returned at the order level will be the cumulative amount for all line items in the order.

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.

For a list of possible enumeration values, see CurrencyCodeType.
TransactionArray.Transaction
  .ShippingDetails.SalesTax
  .SalesTaxPercent
float Conditionally This float value is the sales tax percentage rate applicable to the corresponding tax jurisdiction (US state or Canadian province). Sellers are responsible for providing accurate sales tax rates for each jurisdiction. This sales tax rate comes into play when a buyer from that tax jurisdiction makes a purchase from the seller. The value passed in is stored with a precision of 3 digits after the decimal point (##.###).

This field is only returned in order management calls if sales tax applies to the order line item, and is only in GetItem (and other 'Get' calls) if sales tax is applicable to the listing or order line item, and the seller is the person making the call.

Although this field will be returned at the order level in order management calls for a single line item order, sales tax is applied at the line item level and not order level. For multiple line item orders, this field will not be returned at all at the order level.

Note: Buyers in all 50 US states and DC are automatically charged sales tax for eBay purchases, and eBay collects and remits this sales tax to the proper taxing authority on the buyer's behalf. Because of this, if a sales tax percentage rate is applied to a listing by a seller in one of these states, this field will be ignored during the checkout process.

Currently, sales tax percentage rates can only be specified by sellers in Canada and 5 US territories, including American Samoa (AS), Guam (GU), Northern Mariana Islands (MP), Palau (PW), and Virgin Islands (VI).


DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ShippingDetails.SalesTax
  .SalesTaxState
string Conditionally This is the unique, two-digit identifier of the tax jurisdiction (such as 'CA' for California). To retrieve all two-digit identifiers for all states/territories/provinces for a site, a seller can either use a GetTaxTable call with DetailLevel set to ReturnAll, or they can use the GeteBayDetails call with DetailLevel name set to TaxJurisdiction. Please note that both GetTaxTable and GeteBayDetails calls use a JurisdictionID field to express these tax jurisdiction identifiers instead of SalesTaxState, but the values used in these fields are the same.

The SalesTaxState field is conditionally required in an Add/Revise/Relist/Verify call if the seller is applying sales tax to a listing for a particular jurisdiction, and is returned with each SalesTax container to identify the tax jurisdiction.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ShippingDetails.SalesTax
  .ShippingIncludedInTax
boolean Conditionally This field is included in an Add/Revise/Relist/Verify call and set to true if the seller wants sales tax for the jurisdiction to apply to the cumulative amount of item cost and shipping charges. This value defaults to false if not specified.

This field is always returned with the SalesTax container (whether true or false).

Note: Buyers in all 50 US states and DC are automatically charged sales tax for eBay purchases, and eBay collects and remits this sales tax to the proper taxing authority on the buyer's behalf. Because of this, if a sales tax percentage rate is applied to a listing by a seller in one of these states, this field will be ignored during the checkout process.

Currently, sales tax percentage rates can only be specified by sellers in Canada and 5 US territories, including American Samoa (AS), Guam (GU), Northern Mariana Islands (MP), Palau (PW), and Virgin Islands (VI).


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, and GetOrders.

For GetOrders and GetItemTransactions only: If using Trading WSDL Version 1019 or above, this field will only be returned to the buyer or seller, and no longer returned at all to third parties. If using a Trading WSDL older than Version 1019, the real record number is only returned to the buyer or seller, and a dummy value of 0 will be returned to all third parties.

The sale record ID can be for a single or a multiple line item order.

Note: For the GetItemTransactions and GetOrderscalls, this field is only returned to the seller of the order; this field is not returned for the buyer or third party.

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.
Note: Shipment tracking information does not appear in Merchant Data API's OrderReport responses, because once shipment tracking information is provided to the buyer, the order/order line item is considered acknowledged, and acknowledged orders do not show up in OrderReport responses.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ShippingDetails
  .ShipmentTrackingDetails
  .ShipmentTrackingNumber
string Conditionally The tracking number assigned by the shipping carrier to the item shipment. This field and the ShippingCarrierUsed field are mutually dependent. When you submit ShipmentTrackingNumber, you must also supply a value for ShippingCarrierUsed. When you submit ShippingCarrierUsed, you must also supply a value for ShipmentTrackingNumber.

The seller is responsible for the accuracy of the shipment tracking number, as eBay only verifies that the tracking number is consistent with the numbering scheme used by the specified shipping carrier, but cannot verify the accuracy of the tracking number. For order management calls,

For GetOrders, GetSellerTransactions, and GetItemTransactions only: This field is only returned if a valid tracking number is set. With the exception of the GetSellerTransactions (where it is only returned to the seller and not buyer), the tracking number will only be returned to the seller or buyer. If a user is using a Trading WSDL Version 1019 or above, this field will only be returned to the buyer or seller, and no longer returned at all to third parties. If using a Trading WSDL older than Version 1019, this field is returned to third parties, but the string value returned in the field will be Unavailable.

Note: The Trading API only supports alphanumeric characters for shipment tracking numbers, and any other characters are not supported, including spaces, hyphens, and all other special characters. Users should not enter spaces even if spaces are shown for the tracking number on the shipping label.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ShippingDetails
  .ShipmentTrackingDetails
  .ShippingCarrierUsed
string Conditionally The name of the shipping carrier used to ship the item. This field and the ShipmentTrackingNumber field are mutually dependent. When you submit ShippingCarrierUsed, you must also supply a value for ShipmentTrackingNumber. When you submit ShipmentTrackingNumber, you must also supply a value for ShippingCarrierUsed.

When the site ID is Austria, Poland, or UK, ShippingCarrierUsed can be any value, because it is not checked by eBay. For all other sites, only the following characters are allowed: letters (a-z, A-Z), numbers (0-9), space, and dash (-). The site ID is specified in the CompleteSale request header.

Note: Commonly used shipping carriers can be found by calling GeteBayDetails with DetailName set to ShippingCarrierDetails and examining the returned ShippingCarrierDetails.ShippingCarrier field. ShippingCarrierCodeType also has a list of valid shipping carriers, but eBay cannot guarantee that this enumerated type contains a full, updated list of shipping carriers. For the CompleteSale call:
  • This field is not case sensitive in the CompleteSale request.
  • When using UPS Mail Innovations, supply the value UPS-MI. Buyers will subsequently be sent to the UPS Mail Innovations website for tracking status.
  • When using FedEx SmartPost, supply the value FedEx. Buyers will subsequently be sent to the FedEx web site for tracking status.
For the Get calls: When using the Global Shipping Program, this field returns a value of PBI.

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

Applicable values: See ShippingCarrierCodeType
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.

Applicable values: See ShippingRateType.
Code so that your app gracefully handles any future changes to this list.

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

See UPS rate scales.

TransactionArray.Transaction
  .ShippingDetails
  .ShippingServiceUsed
token Conditionally The shipping service actually used by the seller to ship the item(s) to the buyer.

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 to Worldwide for an item, but has not specified any international shipping service options, NotSpecified is returned as the ShippingType value.

Applicable values: See ShippingType.
Code so that your app gracefully handles any future changes to this list.

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


DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ShippingDetails.TaxTable
  .TaxJurisdiction
TaxJurisdictionType Conditionally,
repeatable: [0..*]
In a SetTaxTable, a TaxJurisdiction container is required for each tax jurisdiction that the seller wishes to make additions/changes. Sales tax details for zero or more jurisdictions (states, provinces, etc). This can be just one jurisdiction, up to all jurisdictions defined for the site's country. Any values specified through a TaxJurisdiction container will override any existing values defined in the seller's Sales Tax Table.

If GetTaxTable is called without the DetailLevel field, only tax jurisdictions where sales tax rates have been set up are returned. However, if the DetailLevel field is included in the request and set to ReturnAll, all tax jurisdictions are returned, regardless of whether or not the seller has modified settings for any/all of these jurisdictions.

This container is only returned in order-related 'Get' calls if sales tax is applicable to the order line item.

Note: Buyers in all 50 US states and DC are automatically charged sales tax for eBay purchases, and eBay collects and remits this sales tax to the proper taxing authority on the buyer's behalf. Because of this, if a sales tax percentage rate is applied to a listing by a seller in one of these states, this field will be ignored during the checkout process.

Currently, sales tax percentage rates can only be specified by sellers in Canada and 5 US territories, including American Samoa (AS), Guam (GU), Northern Mariana Islands (MP), Palau (PW), and Virgin Islands (VI).


DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ShippingDetails.TaxTable
  .TaxJurisdiction
  .JurisdictionID
string Conditionally This is the unique, two-digit identifier of the tax jurisdiction (such as 'CA' for California). To retrieve all JurisdictionID values for a site, a seller can either use a GetTaxTable call with DetailLevel set to ReturnAll, or they can use the GeteBayDetails call with DetailLevel name set to TaxJurisdiction.

The JurisdictionID field is always required in a SetTaxTable call, and always returned with each TaxJurisdiction container to identify the tax jurisdiction.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ShippingDetails.TaxTable
  .TaxJurisdiction
  .SalesTaxPercent
float Conditionally This float value is the sales tax percentage rate applicable to the corresponding tax jurisdiction. Sellers are responsible for providing accurate sales tax rates for each jurisdiction. This sales tax rate comes into play when a buyer from that tax jurisdiction makes a purchase from the seller. The value passed in is stored with a precision of 3 digits after the decimal point (##.###).

This field is only returned in GetTaxTable (and other 'Get' calls) if a sales tax percentage rate has been set.

Note: Buyers in all 50 US states and DC are automatically charged sales tax for eBay purchases, and eBay collects and remits this sales tax to the proper taxing authority on the buyer's behalf. Because of this, if a sales tax percentage rate is applied to a listing by a seller in one of these states, this field will be ignored during the checkout process.

Currently, sales tax percentage rates can only be specified by sellers in Canada and 5 US territories, including American Samoa (AS), Guam (GU), Northern Mariana Islands (MP), Palau (PW), and Virgin Islands (VI).


DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ShippingDetails.TaxTable
  .TaxJurisdiction
  .ShippingIncludedInTax
boolean Conditionally This field is included in a SetTaxTable call and set to true if the seller wants sales tax for the jurisdiction to apply to the cumulative amount of item cost and shipping charges. This value defaults to false if not specified.

This field is always returned with each TaxJurisdiction container (whether true or false).

Note: Buyers in all 50 US states and DC are automatically charged sales tax for eBay purchases, and eBay collects and remits this sales tax to the proper taxing authority on the buyer's behalf. Because of this, if a sales tax percentage rate is applied to a listing by a seller in one of these states, this field will be ignored during the checkout process.

Currently, sales tax percentage rates can only be specified by sellers in Canada and 5 US territories, including American Samoa (AS), Guam (GU), Northern Mariana Islands (MP), Palau (PW), and Virgin Islands (VI).


DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ShippingServiceSelected
ShippingServiceOptionsType Conditionally The shipping service actually selected by the buyer from the shipping services offered by the seller. The buyer typically selects the shipping service at checkout/payment time.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ShippingServiceSelected
  .ExpeditedService
boolean Conditionally This field is returned as true if the domestic shipping service is considered an expedited shipping service. An expedited service is typically a shipping service that can ship an order that will arrive at the buyer's location within one to two business days.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ShippingServiceSelected
  .ImportCharge
AmountType (double) Conditionally For orders using eBay International Shipping, when using the GetOrders call, the OrderArray.Order.ShippingServiceSelected.ImportCharge field contains only customs charges.

For the Global Shipping Program, which is only supported in the UK, this field contains 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.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ShippingServiceSelected
  .ImportCharge
  [ attribute currencyID ]
CurrencyCodeType Conditionally For orders using eBay International Shipping, when using the GetOrders call, the OrderArray.Order.ShippingServiceSelected.ImportCharge field contains only customs charges.

For the Global Shipping Program, which is only supported in the UK, this field contains 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
  .ShippingPackageInfo
ShippingPackageInfoType Conditionally,
repeatable: [0..*]
This container is no longer applicable, and it was only applicable to eBay Now and 'eBay On Demand Delivery' orders, and neither of these features are available any longer.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ShippingServiceSelected
  .ShippingPackageInfo
  .ActualDeliveryTime
dateTime Conditionally This timestamp indicates when the order was actually delivered to the buyer. This field is only returned after the order has been delivered to the buyer.

Note: This field does not appear in Merchant Data API's OrderReport responses, because once shipment tracking information is provided to the buyer (or marked as shipped), the order/order line item is considered acknowledged, and acknowledged orders do not show up in OrderReport responses.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ShippingServiceSelected
  .ShippingPackageInfo
  .EstimatedDeliveryTimeMax
dateTime Conditionally The EstimatedDeliveryTimeMin and EstimatedDeliveryTimeMax timestamps indicate the window during which the buyer can expect delivery. The EstimatedDeliveryTimeMax value indicates the latest date and time that the buyer can expect to receive the order.

The EstimatedDeliveryTimeMin and EstimatedDeliveryTimeMax dates are only estimates made by eBay, and their accuracy will depend on the seller meeting the handling time deadline. Once the seller ships the order, and marks it as shipped/provides tracking information, the more accurate delivery dates can be found in the the ScheduledDeliveryTimeMin and ScheduledDeliveryTimeMax fields.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ShippingServiceSelected
  .ShippingPackageInfo
  .EstimatedDeliveryTimeMin
dateTime Conditionally The EstimatedDeliveryTimeMin and EstimatedDeliveryTimeMax timestamps indicate the window during which the buyer can expect delivery. The EstimatedDeliveryTimeMin value indicates the earliest date and time that the buyer can expect to receive the order.

The EstimatedDeliveryTimeMin and EstimatedDeliveryTimeMax dates are only estimates made by eBay, and their accuracy will depend on the seller meeting the handling time deadline. Once the seller ships the order, and marks it as shipped/provides tracking information, the more accurate delivery dates can be found in the the ScheduledDeliveryTimeMin and ScheduledDeliveryTimeMax fields.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ShippingServiceSelected
  .ShippingPackageInfo
  .HandleByTime
dateTime Conditionally This timestamp indicates the latest date/time that the seller should ship the package to ensure that the package arrives to the buyer within the estimated delivery window. This date/time is calculated by adding the handling time (in days) to the purchase time.

This field is applicable for domestic shipping services, and for Click and Collect orders in the UK and Australia.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ShippingServiceSelected
  .ShippingPackageInfo
  .MaxNativeEstimatedDeliveryTime
dateTime Conditionally The MinNativeEstimatedDeliveryTime and MaxNativeEstimatedDeliveryTime timestamps indicate the window during which the buyer can expect delivery based on the seller's handling time and selected shipping service. The MaxNativeEstimatedDeliveryTime value indicates the latest date and time that the buyer can expect to receive the order.

This field is applicable for domestic shipping services, and for Click and Collect orders in the UK and Australia.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ShippingServiceSelected
  .ShippingPackageInfo
  .MinNativeEstimatedDeliveryTime
dateTime Conditionally The MinNativeEstimatedDeliveryTime and MaxNativeEstimatedDeliveryTime timestamps indicate the window during which the buyer can expect delivery based on the seller's handling time and selected shipping service. The MinNativeEstimatedDeliveryTime value indicates the earliest date and time that the buyer can expect to receive the order.

This field is applicable for domestic shipping services, and for Click and Collect orders in the UK and Australia.

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 order. The ScheduledDeliveryTimeMax value indicates the latest time that the buyer can expect to receive the order.

The ScheduledDeliveryTimeMin and ScheduledDeliveryTimeMax fields will start being returned once the seller marks the order as shipped/provides tracking information. Until then, the EstimatedDeliveryTimeMin and EstimatedDeliveryTimeMax dates are returned instead.

Note: This field does not appear in Merchant Data API's OrderReport responses, because once shipment tracking information is provided to the buyer, the order/order line item is considered acknowledged, and acknowledged orders do not show up in OrderReport responses.

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 order. The ScheduledDeliveryTimeMin value indicates the earliest time that the buyer can expect to receive the order.

The ScheduledDeliveryTimeMin and ScheduledDeliveryTimeMax fields will start being returned once the seller marks the order as shipped/provides tracking information. Until then, the EstimatedDeliveryTimeMin and EstimatedDeliveryTimeMax dates are returned instead.

Note: This field does not appear in Merchant Data API's OrderReport responses, because once shipment tracking information is provided to the buyer, the order/order line item is considered acknowledged, and acknowledged orders do not show up in OrderReport responses.

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 order has been picked up from the store indicated by the StoreID value. This field is only applicable to 'In-Store Pickup' and 'Click and Collect' orders.

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 order will be delivered. This field is only applicable to 'In-Store Pickup' and 'Click and Collect' orders.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ShippingServiceSelected
  .ShippingService
token Conditionally This enumeration value indicates a specific domestic shipping service option being offered by the seller to ship an item to a buyer who is located within the same country as the item. This field is required to identify each domestic shipping service option that is specified with a ShippingServiceOptions container.

For a list of valid ShippingService values, call 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.

Note: The eBay standard envelope (eSE) is a domestic envelope service with tracking through eBay. This service applies to specific sub-categories of Trading Cards, and to coins & paper money, postcards, stamps, patches, and similar eligible categories, and is only available on the US marketplace. See eBay standard envelope for details, restrictions, and an envelope size template. To use this service, send envelopes using the USPS mail and set the ShippingService field to US_eBayStandardEnvelope.

For the REST equivalent, see Using the eBay standard envelope (eSE) 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 if the same buyer purchases multiple quantity of the same line item. This field is required when creating a multiple-quantity, fixed-price listing. Generally, the seller will give the buyer a shipping discount if that buyer purchases multiple quantity of the item, so this value should usually be less than the value set for ShippingServiceCost.

The value of this field can even be set to 0 if the seller wants to encourage buyers to buy multiple quantity of the item, or it could be that the seller can fit multiple quantities of the line item in a single shipping package, so the seller is just passing this shipping savings onto the buyer. This field is not applicable for single-quantity listings.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ShippingServiceSelected
  .ShippingServiceAdditionalCost
  [ attribute currencyID ]
CurrencyCodeType Conditionally The cost of shipping each additional item if the same buyer purchases multiple quantity of the same line item. This field is required when creating a multiple-quantity, fixed-price listing. Generally, the seller will give the buyer a shipping discount if that buyer purchases multiple quantity of the item, so this value should usually be less than the value set for ShippingServiceCost.

The value of this field can even be set to 0 if the seller wants to encourage buyers to buy multiple quantity of the item, or it could be that the seller can fit multiple quantities of the line item in a single shipping package, so the seller is just passing this shipping savings onto the buyer. This field is not applicable for single-quantity listings.

For a list of possible enumeration values, see CurrencyCodeType.
TransactionArray.Transaction
  .ShippingServiceSelected
  .ShippingServiceCost
AmountType (double) Conditionally The base cost of shipping one unit of the item using the shipping service specified in the corresponding ShippingService field.

In the case of a multiple-quantity, fixed-price listing, the ShippingServiceAdditionalCost field also becomes applicable, and shows the cost to ship each additional unit of the item if the buyer purchases multiple quantity of the same line item.

Note: If the corresponding shipping service option is set as a 'free shipping' option (FreeShipping=true), the seller still needs to include this ShippingServiceCost field and set its value to 0.0, as eBay will not do this automatically. When returned by GetItemShipping, it includes the packaging and handling cost.

Note that if ShippingService is set to LocalPickup, ShippingServiceCost must be set to 0.0. Also, if a shipping service has been specified (even LocalPickup), GetItem returns the shipping service cost, even if the cost is zero.

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.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ShippingServiceSelected
  .ShippingServiceCost
  [ attribute currencyID ]
CurrencyCodeType Conditionally The base cost of shipping one unit of the item using the shipping service specified in the corresponding ShippingService field.

In the case of a multiple-quantity, fixed-price listing, the ShippingServiceAdditionalCost field also becomes applicable, and shows the cost to ship each additional unit of the item if the buyer purchases multiple quantity of the same line item.

Note: If the corresponding shipping service option is set as a 'free shipping' option (FreeShipping=true), the seller still needs to include this ShippingServiceCost field and set its value to 0.0, as eBay will not do this automatically. When returned by GetItemShipping, it includes the packaging and handling cost.

Note that if ShippingService is set to LocalPickup, ShippingServiceCost must be set to 0.0. Also, if a shipping service has been specified (even LocalPickup), GetItem returns the shipping service cost, even if the cost is zero.

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 a list of possible enumeration values, see CurrencyCodeType.
TransactionArray.Transaction
  .ShippingServiceSelected
  .ShippingServicePriority
int Conditionally 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.

If this field is omitted from domestic shipping service options, the order of the shipping service options in View Item and Checkout pages will be determined by the order that these shipping service options are presented in the request payload of an Add/Revise/Relist call.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ShippingServiceSelected
  .ShippingTimeMax
int Conditionally The integer value returned here indicates the maximum number of business days that the shipping service (indicated in the corresponding ShippingService field) will take to be delivered to the buyer.

This maximum shipping time does not include the seller's handling time, and the clock starts on the shipping time only after the seller has delivered the item to the shipping carrier for shipment to the buyer. 'Business days' can vary by shipping carrier and by country, but 'business days' are generally Monday through Friday, excluding holidays. This field is returned if defined for that particular shipping service option.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ShippingServiceSelected
  .ShippingTimeMin
int Conditionally The integer value returned here indicates the minimum number of business days that the shipping service (indicated in the corresponding ShippingService field) will take to be delivered to the buyer.

This minimum shipping time does not include the seller's handling time, and the clock starts on the shipping time only after the seller has delivered the item to the shipping carrier for shipment to the buyer. 'Business days' can vary by shipping carrier and by country, but 'business days' are generally Monday through Friday, excluding holidays. This field is returned if defined for that particular shipping service option.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .Status
TransactionStatusType Conditionally Container consisting of checkout/payment status details for an order line item. Several of these fields change values during the checkout flow.

For GetOrders, only a limited number of applicable fields are returned at the order line item level. The fields indicating the status of the order are actually found in the OrderArray.Order.CheckoutStatus container.

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. If the payment was successfuly processed, a value of CheckoutComplete will be returned.

Applicable values:

BuyerRequestsTotal
(out) This value indicates that the buyer wants to confirm the total price of the order line item before making a payment.
CheckoutComplete
(out) This value indicates that the buyer has paid and checkout is complete.
CheckoutIncomplete
(out) This value indicates that checkout is incomplete, generally because the buyer has not paid yet.
CustomCode
(out) Reserved for future use.
SellerResponded
(out) This value indicates that the seller has just responded to the buyer concerning the total price of the order line item.

Code so that your app gracefully handles any future changes to this list.

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
(out) This value indicates that the order or order line item is complete. Generally speaking, an order or order line item is complete when payment from the buyer has been initiated and has been processed.

Note: If the PaymentMethodUsed is CashOnPickup, the CheckoutStatus.Status value in GetOrders will be Complete at checkout time, 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 changes the checkout status to Pending. However, the eBayPaymentStatus value in GetOrders will change from NoPaymentFailure to PaymentInProcess.
CustomCode
(out) Reserved for internal or future use
Incomplete
(out) This value indicates that the order or order line item is in the incomplete state. Generally speaking, an order or order line item is considered incomplete when payment from the buyer has yet to be initiated.
Pending
(out) This value indicates that the order or order line item is in the pending state. Generally speaking, an order is considered pending when payment from the buyer has been initiated but has yet to be fully processed.

Note: If the payment method is CashOnPickup, the CheckoutStatus.Status value in GetOrders will read Complete at checkout time, 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 changes the checkout status to Pending. However, the eBayPaymentStatus value in GetOrders will change from NoPaymentFailure to PaymentInProcess.

Code so that your app gracefully handles any future changes to this list.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .Status.DigitalStatus
DigitalStatusCodeType Conditionally This enumeration value indicates the current state of a purchased digital gift card. The normal flow is for the buyer (or other recipient of the gift card) to download the gift card from the delivered email after purchase, and then to activate the card for use. This field is only applicable and returned for digital gift card order line items.

Applicable values:

Activated
(out) This enumeration value indicates that the digital gift card has been activated by the buyer or recipient of gift card.
CustomCode
(out) This value is reserved for internal or future use.
Deactivated
(out) This enumeration value indicates that the digital gift card has been deactivated.
Downloaded
(out) This enumeration value indicates that the digital gift card has been downloaded by the buyer or recipient of gift card. The next step would be to activate the gift card.
Inactive
(out) This enumeration value indicates that the digital gift card has yet to be activated by the buyer or recipient of gift card.

Code so that your app gracefully handles any future changes to this list.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .Status.eBayPaymentStatus
PaymentStatusCodeType Conditionally Indicates the status of the buyer's payment for an order. If the payment was successfuly processed, a value of NoPaymentFailure will be returned.

Applicable values:

BuyerFailedPaymentReportedBySeller
(out) This value indicates that the seller reported the buyer's offline payment as failed. This enumeration value would only be applicable for a sales transaction that occurred off of eBay's platform.
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 payment is in process, but has not yet cleared.

Note: This value may also get returned for a sales transaction that occurred off of eBay's platform, and the payment status may stay in this state unless the seller marks the order as paid.

Code so that your app gracefully handles any future changes to this list.

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 Item Not Received (INR) Inquiry. This field is only returned if the buyer has created an INR Inquiry through the site or through the Post-Order API.

Applicable values: See InquiryStatus.
Code so that your app gracefully handles any future changes to this list.

DetailLevel: 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).
Note: Please note that for a multiple line item order, if any part of the order was modified, all line items of that order may be returned in the response, and each line item of that order should have the same timestamp value in this field.

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.
Note: For the GetItemTransactions and GetOrders, calls, this field is only returned to the seller of the order; this field is not returned for the buyer or third party.

Applicable values: See PaymentHoldStatus.
Code so that your app gracefully handles any future changes to this list.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .Status.PaymentInstrument
BuyerPaymentInstrumentCodeType Conditionally The enumeration value in this field indicates which payment method was used by the German buyer who was offered the 'Pay Upon Invoice' option. This field will only be returned if a German buyer was offered the 'Pay Upon Invoice' option. Otherwise, the buyer's selected payment method is returned in the PaymentMethodUsed field by the GetItemTransactions call.

Applicable values: See PaymentInstrument.
Code so that your app gracefully handles any future changes to this list.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .Status.PaymentMethodUsed
BuyerPaymentMethodCodeType Conditionally The payment method that the buyer selected to pay for the order.
Note: Sellers no longer have to specify any electronic payment methods at listing time, but this field is still returned. The value returned in this field will generally be CreditCard, unless an eBay gift card was used by the buyer to pay a partial or full balance of the order. If this is the case, the value returned in this field will be CCAccepted. Either of these two values will be returned, but neither accurately reflects the actual payment method that the buyer used. If the order was paid for off of eBay's platform using an 'offline' payment method such as 'CashOnPickup' or 'MOCC' (money order or cashier's check), and the seller marked the order as paid, either of those values may get returned here.

Applicable values:

CashOnPickup
(in/out) This enumeration value indicates that cash on pickup is accepted for payment. This value is only applicable for offline payments.
CustomCode
(in/out) Reserved for internal or future use.
MOCC
(in/out) This enumeration value indicates that a money order or cashiers check is accepted for payment. This value is only applicable for offline payments and is not supported on all marketplaces.
PersonalCheck
(in/out) This enumeration value indicates that a personal check is accepted for payment. This value is only applicable for offline payments and is not supported on all marketplaces.

Code so that your app gracefully handles any future changes to this list.

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 request, or has escalated an existing return request into a return case.

Applicable values: See ReturnStatus.
Code so that your app gracefully handles any future changes to this list.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .Taxes
TaxesType Conditionally A container consisting of detailed tax information (sales tax, Goods and Services tax, or VAT) for a sales transaction. The Taxes container is returned if the order line item is subject to any taxes on the buyer's purchase. The information in this container supercedes/overrides any sales tax information in the ShippingDetails.SalesTax container.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .Taxes.eBayReference
eBayTaxReferenceValue (string) Conditionally The value returned in this field is the VAT ID for eBay, and this value may vary based on the region or country. The eBayReference field's name attribute will show the type of VAT ID, such as IOSS, OSS, or ABN. This field will be returned if VAT tax is applicable for the order. See the eBayTaxReferenceValue type page for more information on the VAT tax type strings that may appear for the name attribute.

Note: For all VAT ID/VATIN values to be returned (except for France), developers will need to use a Trading WSDL with a version number of 1211 (or newer). For French VAT ID/VATIN values to be returned, developers will need to use a Trading WSDL with a version number of 1225 (or newer). Otherwise, the VAT information will be returned in the Order.ShippingAddress.Street2 field. Developers will also have the option of using older version, but setting the X-EBAY-API-COMPATIBILITY-LEVEL header value to 1211 or 1225 or higher.

On January 31, 2022, the Order.ShippingAddress.Street2 will stop being used to return VAT information regardless of WSDL version or compatibility level.



DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .Taxes.eBayReference
  [ attribute name ]
string Conditionally The value returned in this field is the VAT ID for eBay, and this value may vary based on the region or country. The eBayReference field's name attribute will show the type of VAT ID, such as IOSS, OSS, or ABN. This field will be returned if VAT tax is applicable for the order. See the eBayTaxReferenceValue type page for more information on the VAT tax type strings that may appear for the name attribute.

Note: For all VAT ID/VATIN values to be returned (except for France), developers will need to use a Trading WSDL with a version number of 1211 (or newer). For French VAT ID/VATIN values to be returned, developers will need to use a Trading WSDL with a version number of 1225 (or newer). Otherwise, the VAT information will be returned in the Order.ShippingAddress.Street2 field. Developers will also have the option of using older version, but setting the X-EBAY-API-COMPATIBILITY-LEVEL header value to 1211 or 1225 or higher.

On January 31, 2022, the Order.ShippingAddress.Street2 will stop being used to return VAT information regardless of WSDL version or compatibility level.

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 tax type. A separate TaxDetails container is returned for each unique imposition (tax type).

Applicable values: See Imposition.
Code so that your app gracefully handles any future changes to this list.

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 tax charges for the order line item for the corresponding tax type (see Imposition value).

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 tax charges for the order line item for the corresponding tax type (see Imposition value).

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 enumeration value indicates the type of tax charged against the item.

Applicable values:

CustomCode
(out) Reserved for internal or future use.
ElectronicWasteRecyclingFee
(out) This enumeration value indicates that an electronic waste recycling fee was charged to the buyer against the order line item.
GST
(out) This enumeration value indicates that a Goods and Services import tax was charged to the buyer against the order line item.

Note: At this time, this tax type is only applicable to the Australia site.
SalesTax
(out) This enumeration value indicates that standard sales tax was charged to the buyer against the order line item.
TireRecyclingFee
(out) This enumeration value indicates that a tire recycling fee was charged to the buyer against the order line item.

Code so that your app gracefully handles any future changes to this list.

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, for all tax types, which may include sales tax (seller-applied or 'eBay Collect and Remit'), 'Goods and Services' tax (for Australian or New Zealand sellers), or other fees like an 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, for all tax types, which may include sales tax (seller-applied or 'eBay Collect and Remit'), 'Goods and Services' tax (for Australian or New Zealand sellers), or other fees like an electronic waste recycling fee.

For a list of possible enumeration values, see CurrencyCodeType.
TransactionArray.Transaction
  .TransactionID
string Always Unique identifier for an eBay sales transaction. This identifier is created once there is a commitment from a buyer to purchase an item, or if/when the buyer actually purchases the line item through a 'Buy it Now' option. An ItemID/TransactionID pair can be used and referenced during an order checkout flow to identify a line item.

The TransactionID value for auction listings is always 0 since there can be only one winning bidder/one sale for an auction listing.

For GetOrders and GetItemTransactions only: If using Trading WSDL Version 1019 or above, this field will only be returned to the buyer and seller, and no longer returned at all to third parties. If using a Trading WSDL older than Version 1019, transaction ID is only returned to the buyer and seller, and a dummy value of 10000000000000 will be returned to all third parties.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .TransactionPrice
AmountType (double) Always The sale price for one unit of the line item. This price does not include any other costs like shipping charges or sales tax, and its value will remain the same before and after payment. If multiple units were purchased through a single-variation, fixed-price listing, to get the subtotal of the units purchased, the TransactionPrice value would have to be multiplied by the Transaction.QuantityPurchased value.

For a motor vehicle listing that required a deposit/down payment, the amount in the TransactionPrice is actually the deposit amount.

For GetMyeBaySelling: this field is only returned if the transaction came as a result of a buyer's Best Offer accepted by the seller. Otherwise, the Transaction.TotalPrice field should be viewed instead.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .TransactionPrice
  [ attribute currencyID ]
CurrencyCodeType Always The sale price for one unit of the line item. This price does not include any other costs like shipping charges or sales tax, and its value will remain the same before and after payment. If multiple units were purchased through a single-variation, fixed-price listing, to get the subtotal of the units purchased, the TransactionPrice value would have to be multiplied by the Transaction.QuantityPurchased value.

For a motor vehicle listing that required a deposit/down payment, the amount in the TransactionPrice is actually the deposit amount.

For GetMyeBaySelling: this field is only returned if the transaction came as a result of a buyer's Best Offer accepted by the seller. Otherwise, the Transaction.TotalPrice field should be viewed instead.

For a list of possible enumeration values, see CurrencyCodeType.
TransactionArray.Transaction
  .TransactionSiteID
SiteCodeType Conditionally The site upon which the line item was purchased.

Applicable values: See TransactionSiteID.
Code so that your app gracefully handles any future changes to this list.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
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 quanity 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 a seller-defined identifier. It is only intended for the seller's use (not for buyers). A SKU value is not required, but many large sellers like to add SKU value to their listings. If defined on a listing, a SKU value can be used by sellers to reconcile their eBay inventory with your own inventory system, instead of using the VariationSpecifics identifying values.

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 include the Item.InventoryTrackingMethod field in an 'FixedPriceItem' call and set its value to SKU, the Variation.SKU values become required for each variation..

For GetItem, GetOrders and other 'Get' calls: Only returned if the seller specified a SKU for the variation.
Note: The Item.Variations container and its child fields will stop being returned in GetItemTransactions on January 31, 2024.
Max length: 80.

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

See SKU identifiers.

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 Item Specific names, but each variation must provide a unique combination of values for those Item Specific names. For example, if the items vary by color and size, then every variation must specify 'Color' and 'Size' as Item Specific names, but 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 of Variationpecifics by using the Variations.ModifyNameList container. 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, Variationpecifics are not returned if the variation has a SKU. If the variation has no SKU, then Variationpecifics are returned instead. Optionally, you can pass IncludeVariationSpecifics as true in the request to force Variationpecifics to be returned, even when the SKU is returned.
Note: The Item.Variations container and its child fields will stop being returned in GetItemTransactions on January 31, 2024.

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

See:
    Configure variation-selection widgets for buyers (View Item)
    Revise and relist 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.

Note: The maximum number of item specifics that may be defined for a listing has increased from 30 to 45.
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 variations, 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:
  • Specify shared Item Specifics (e.g., Brand) in the ItemSpecifics node.
  • Specify up to five VariationSpecifics in each Variation node.
  • 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.

For AddToWatchList and RemoveFromWatchList: The ItemID value of the multiple-variation listing and the name-value pair to identify each variation in the listing are required.

Note: As of August 30, 2018, California will require sellers to display a Proposition 65 warning on online retail sites if products contain chemicals and/or substances that may impact the health of California buyers. This requirement is applicable to most eBay US categories, including eBay Motors, Motors Parts & Accessories, and catalog-enabled categories. The warning message can be customized by the seller, but should contain the following basic information:
  • The name of at least one listed chemical that prompted the warning
  • Text stating that the product 'can expose you to' the chemical(s) in the product
  • The URL for OEHHA's new Proposition 65 warnings website, which is www.P65Warnings.ca.gov
Unlike standard item specifics that allow a maximum of 65 characters in the Value field, the matching value for the 'California Prop 65 Warning' item specific allows up to 800 characters of text. When a seller passes in this item specific, eBay will automatically insert a warning symbol icon for the listing.



DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .Variation.VariationSpecifics
  .NameValueList.Name
string Conditionally Depending on the call and context, this value is either a name of an Item/Variation Specific, or a Parts Compatibility name.

For the AddItem and AddFixedPriceItem families of calls: In the Item.ItemSpecifics context, the value in this field will either be the name of a required/recommended/optional item specific name for the category, or it may be a seller's customized item specific name.

For the AddFixedPriceItem family of calls: In the Compatibility.NameValueList context, this value is a motor vehicle aspect such as Year, Make, and Model. A Compatibility.NameValueList container is applicable for motor vehicle parts and accessories listings.

For PlaceOffer: Required if the line item being purchased is an item variation within a multiple-variation listing.

Note: For required and recommended item specifics that are returned in the getItemAspectsForCategory method of the Taxonomy API, the seller should pass in the name of these item specifics just as they are shown in the getItemAspectsForCategory response. Similarly, for catalog-enabled categories, the seller should pass in the name of instance aspects just as they are shown in the getItemAspectsForCategory response. Instance aspects are additional details unique to a specific item or listing that a seller can include along with the product aspects that are already defined in the eBay catalog product associated with the listing. Instance aspects common to many catalog-enabled categories include 'Bundle Description' and 'Modification Description'. eBay US sellers who ship to California are required to pass in a 'California Prop 65 Warning' item specific if the item in the listing contains one or more chemicals known to be harmful to human health. This item specific is passed at the listing level for both single-variation and multiple-variation listings. The 'California Prop 65 Warning' is considered an instance specific because it will be retained on the listing even when the seller lists using an eBay catalog product. The 'California Prop 65 Warning' may be applicable in most eBay US categories, including eBay Motors, Motors Parts & Accessories, and catalog-enabled categories. Note: If Brand and MPN (Manufacturer Part Number) are being used to identify product variations in a multiple-variation listing, the Brand must be specified at the item level (ItemSpecifics container) and the MPN for each product variation must be specified at the variation level (VariationSpecifics container). The Brand name must be the same for all variations within a single listing.
Max length: 65.

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 Variationpecifics. 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].
Note: The Item.Variations container and its child fields will stop being returned in GetItemTransactions on January 31, 2024.
Max length: 120.

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) This value indicates that the call request processing failed.
Success
(out) This value indicates that the call request was processed successfully without any issues.
Warning
(out) This value indicates that the call request was successful, but processing was not without any issues. These issues can be checked in the Errors container, that will also be returned when one or more known issues occur with the call request.

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

Code so that your app gracefully handles any future changes to this list.
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.
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.

Code so that your app gracefully handles any future changes to this list.
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 Errors By Number.

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 This is the value of the request parameter noted in the ParamID attribute. So, if the ParamID value was ItemID, the value in this field would be the actual value of that ItemID.
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 Error handling section of the Making a Trading API call 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.

Code so that your app gracefully handles any future changes to this list.
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.



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
ReturnedTransactionCountActualYYY
SellerY-Y
Seller.eBayGoodStandingY-Y
Seller.EIASTokenY-Y
Seller.EmailY-Y
Seller.FeedbackPrivateY-Y
Seller.FeedbackScoreY-Y
Seller.NewUserY-Y
Seller.PositiveFeedbackPercent(Y)-(Y)
Seller.RegistrationDateY-Y
Seller.SiteY-Y
Seller.StatusY-Y
Seller.UserIDY-Y
Seller.UserIDChangedY-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.AdjustmentAmountYYY
TransactionArray.Transaction.AmountPaid(Y)(Y)(Y)
TransactionArray.Transaction.BestOfferSaleYYY
TransactionArray.Transaction.Buyer(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
  .CityName
(Y)-(Y)
TransactionArray.Transaction.Buyer.BuyerInfo.ShippingAddress
  .Country
(Y)-(Y)
TransactionArray.Transaction.Buyer.BuyerInfo.ShippingAddress
  .CountryName
(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.EIASToken(Y)-(Y)
TransactionArray.Transaction.Buyer.Email(Y)-(Y)
TransactionArray.Transaction.Buyer.FeedbackPrivate(Y)-(Y)
TransactionArray.Transaction.Buyer.FeedbackScore(Y)-(Y)
TransactionArray.Transaction.Buyer.PositiveFeedbackPercent(Y)-(Y)
TransactionArray.Transaction.Buyer.RegistrationDate(Y)-(Y)
TransactionArray.Transaction.Buyer.Site(Y)-(Y)
TransactionArray.Transaction.Buyer.Status(Y)-(Y)
TransactionArray.Transaction.Buyer.UserID(Y)-(Y)
TransactionArray.Transaction.Buyer.UserIDChanged(Y)-(Y)
TransactionArray.Transaction.Buyer.VATStatus(Y)-(Y)
TransactionArray.Transaction.BuyerCheckoutMessage(Y)(Y)(Y)
TransactionArray.Transaction.BuyerPackageEnclosures(Y)(Y)(Y)
TransactionArray.Transaction.BuyerPackageEnclosures
  .BuyerPackageEnclosure
(Y)(Y)(Y)
TransactionArray.Transaction.ContainingOrder(Y)-(Y)
TransactionArray.Transaction.ContainingOrder.CancelReason(Y)(Y)(Y)
TransactionArray.Transaction.ContainingOrder.CancelStatus(Y)(Y)(Y)
TransactionArray.Transaction.ContainingOrder
  .ContainseBayPlusTransaction
(Y)(Y)(Y)
TransactionArray.Transaction.ContainingOrder.CreatingUserRole(Y)(Y)(Y)
TransactionArray.Transaction.ContainingOrder.ExtendedOrderID(Y)(Y)(Y)
TransactionArray.Transaction.ContainingOrder.OrderID(Y)-(Y)
TransactionArray.Transaction.ContainingOrder.OrderLineItemCount(Y)-(Y)
TransactionArray.Transaction.ContainingOrder.OrderStatus(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.DigitalDeliverySelected(Y)(Y)(Y)
TransactionArray.Transaction.DigitalDeliverySelected
  .DeliveryDetails
(Y)-(Y)
TransactionArray.Transaction.DigitalDeliverySelected
  .DeliveryDetails.Recipient
(Y)(Y)(Y)
TransactionArray.Transaction.DigitalDeliverySelected
  .DeliveryDetails.Recipient.Email
(Y)-(Y)
TransactionArray.Transaction.DigitalDeliverySelected
  .DeliveryDetails.Recipient.Name
(Y)-(Y)
TransactionArray.Transaction.DigitalDeliverySelected
  .DeliveryDetails.Sender
(Y)(Y)(Y)
TransactionArray.Transaction.DigitalDeliverySelected
  .DeliveryDetails.Sender.Email
(Y)-(Y)
TransactionArray.Transaction.DigitalDeliverySelected
  .DeliveryDetails.Sender.Name
(Y)-(Y)
TransactionArray.Transaction.DigitalDeliverySelected
  .DeliveryMethod
(Y)(Y)(Y)
TransactionArray.Transaction.DigitalDeliverySelected
  .DeliveryStatus
(Y)-(Y)
TransactionArray.Transaction.DigitalDeliverySelected
  .DeliveryStatus.Email
(Y)(Y)(Y)
TransactionArray.Transaction.eBayCollectAndRemitTaxes(Y)-(Y)
TransactionArray.Transaction.eBayCollectAndRemitTaxes
  .eBayReference
(Y)-(Y)
TransactionArray.Transaction.eBayCollectAndRemitTaxes.TaxDetails(Y)-(Y)
TransactionArray.Transaction.eBayCollectAndRemitTaxes.TaxDetails
  .CollectionMethod
(Y)-(Y)
TransactionArray.Transaction.eBayCollectAndRemitTaxes.TaxDetails
  .Imposition
(Y)-(Y)
TransactionArray.Transaction.eBayCollectAndRemitTaxes.TaxDetails
  .TaxAmount
(Y)-(Y)
TransactionArray.Transaction.eBayCollectAndRemitTaxes.TaxDetails
  .TaxCode
(Y)-(Y)
TransactionArray.Transaction.eBayCollectAndRemitTaxes.TaxDetails
  .TaxDescription
(Y)-(Y)
TransactionArray.Transaction.eBayCollectAndRemitTaxes.TaxDetails
  .TaxOnHandlingAmount
(Y)-(Y)
TransactionArray.Transaction.eBayCollectAndRemitTaxes.TaxDetails
  .TaxOnShippingAmount
(Y)-(Y)
TransactionArray.Transaction.eBayCollectAndRemitTaxes.TaxDetails
  .TaxOnSubtotalAmount
(Y)-(Y)
TransactionArray.Transaction.eBayCollectAndRemitTaxes
  .TotalTaxAmount
(Y)-(Y)
TransactionArray.Transaction.eBayPaymentID(Y)--
TransactionArray.Transaction.ExtendedOrderID(Y)(Y)(Y)
TransactionArray.Transaction.FinalValueFee(Y)(Y)(Y)
TransactionArray.Transaction.GiftSummary(Y)(Y)(Y)
TransactionArray.Transaction.GiftSummary.Message(Y)-(Y)
TransactionArray.Transaction.GuaranteedDeliveryYYY
TransactionArray.Transaction.GuaranteedShipping(Y)(Y)(Y)
TransactionArray.Transaction.IntangibleItemYYY
TransactionArray.Transaction.InventoryReservationID(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.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.InventoryTrackingMethod(Y)-(Y)
TransactionArray.Transaction.Item.ItemIDYYY
TransactionArray.Transaction.Item.ListingDetails--(Y)
TransactionArray.Transaction.Item.ListingDetails.EndTime--(Y)
TransactionArray.Transaction.Item.ListingDetails.StartTime--(Y)
TransactionArray.Transaction.Item.ListingTypeYYY
TransactionArray.Transaction.Item.LotSize--(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.Site--(Y)
TransactionArray.Transaction.Item.SKU(Y)-(Y)
TransactionArray.Transaction.Item.StartPrice--(Y)
TransactionArray.Transaction.Item.Title--(Y)
TransactionArray.Transaction.LogisticsPlanType(Y)-(Y)
TransactionArray.Transaction.MonetaryDetails--(Y)
TransactionArray.Transaction.MonetaryDetails.Payments(Y)-(Y)
TransactionArray.Transaction.MonetaryDetails.Payments.Payment(Y)-(Y)
TransactionArray.Transaction.MonetaryDetails.Payments.Payment
  .FeeOrCreditAmount
(Y)-(Y)
TransactionArray.Transaction.MonetaryDetails.Payments.Payment
  .Payee
(Y)-(Y)
TransactionArray.Transaction.MonetaryDetails.Payments.Payment
  .Payer
(Y)-(Y)
TransactionArray.Transaction.MonetaryDetails.Payments.Payment
  .PaymentAmount
(Y)-(Y)
TransactionArray.Transaction.MonetaryDetails.Payments.Payment
  .PaymentReferenceID
(Y)-(Y)
TransactionArray.Transaction.MonetaryDetails.Payments.Payment
  .PaymentTime
(Y)-(Y)
TransactionArray.Transaction.MonetaryDetails.Payments.Payment
  .ReferenceID
(Y)-(Y)
TransactionArray.Transaction.MonetaryDetails.Refunds(Y)-(Y)
TransactionArray.Transaction.MonetaryDetails.Refunds.Refund(Y)-(Y)
TransactionArray.Transaction.MonetaryDetails.Refunds.Refund
  .FeeOrCreditAmount
(Y)-(Y)
TransactionArray.Transaction.MonetaryDetails.Refunds.Refund
  .ReferenceID
(Y)-(Y)
TransactionArray.Transaction.MonetaryDetails.Refunds.Refund
  .RefundAmount
(Y)-(Y)
TransactionArray.Transaction.MonetaryDetails.Refunds.Refund
  .RefundTime
(Y)-(Y)
TransactionArray.Transaction.MonetaryDetails.Refunds.Refund
  .RefundTo
(Y)-(Y)
TransactionArray.Transaction.MonetaryDetails.Refunds.Refund
  .RefundType
(Y)-(Y)
TransactionArray.Transaction.MultiLegShippingDetails(Y)-(Y)
TransactionArray.Transaction.MultiLegShippingDetails
  .SellerShipmentToLogisticsProvider
(Y)-(Y)
TransactionArray.Transaction.MultiLegShippingDetails
  .SellerShipmentToLogisticsProvider.ShippingServiceDetails
(Y)-(Y)
TransactionArray.Transaction.MultiLegShippingDetails
  .SellerShipmentToLogisticsProvider.ShippingServiceDetails
  .ShippingService
(Y)-(Y)
TransactionArray.Transaction.MultiLegShippingDetails
  .SellerShipmentToLogisticsProvider.ShippingServiceDetails
  .TotalShippingCost
(Y)-(Y)
TransactionArray.Transaction.MultiLegShippingDetails
  .SellerShipmentToLogisticsProvider.ShippingTimeMax
(Y)-(Y)
TransactionArray.Transaction.MultiLegShippingDetails
  .SellerShipmentToLogisticsProvider.ShippingTimeMin
(Y)-(Y)
TransactionArray.Transaction.MultiLegShippingDetails
  .SellerShipmentToLogisticsProvider.ShipToAddress
(Y)-(Y)
TransactionArray.Transaction.MultiLegShippingDetails
  .SellerShipmentToLogisticsProvider.ShipToAddress.AddressOwner
(Y)-(Y)
TransactionArray.Transaction.MultiLegShippingDetails
  .SellerShipmentToLogisticsProvider.ShipToAddress.CityName
(Y)-(Y)
TransactionArray.Transaction.MultiLegShippingDetails
  .SellerShipmentToLogisticsProvider.ShipToAddress.Country
(Y)-(Y)
TransactionArray.Transaction.MultiLegShippingDetails
  .SellerShipmentToLogisticsProvider.ShipToAddress.CountryName
(Y)-(Y)
TransactionArray.Transaction.MultiLegShippingDetails
  .SellerShipmentToLogisticsProvider.ShipToAddress.Phone
(Y)-(Y)
TransactionArray.Transaction.MultiLegShippingDetails
  .SellerShipmentToLogisticsProvider.ShipToAddress.PostalCode
(Y)-(Y)
TransactionArray.Transaction.MultiLegShippingDetails
  .SellerShipmentToLogisticsProvider.ShipToAddress.ReferenceID
(Y)-(Y)
TransactionArray.Transaction.MultiLegShippingDetails
  .SellerShipmentToLogisticsProvider.ShipToAddress.StateOrProvince
(Y)-(Y)
TransactionArray.Transaction.MultiLegShippingDetails
  .SellerShipmentToLogisticsProvider.ShipToAddress.Street1
(Y)-(Y)
TransactionArray.Transaction.MultiLegShippingDetails
  .SellerShipmentToLogisticsProvider.ShipToAddress.Street2
(Y)-(Y)
TransactionArray.Transaction.OrderLineItemIDYYY
TransactionArray.Transaction.PaidTime(Y)(Y)(Y)
TransactionArray.Transaction.PickupDetails(Y)(Y)(Y)
TransactionArray.Transaction.PickupDetails.PickupOptions(Y)(Y)(Y)
TransactionArray.Transaction.PickupDetails.PickupOptions
  .PickupMethod
(Y)(Y)(Y)
TransactionArray.Transaction.PickupDetails.PickupOptions
  .PickupPriority
(Y)(Y)(Y)
TransactionArray.Transaction.PickupMethodSelected(Y)(Y)(Y)
TransactionArray.Transaction.PickupMethodSelected
  .MerchantPickupCode
(Y)(Y)(Y)
TransactionArray.Transaction.PickupMethodSelected
  .PickupFulfillmentTime
(Y)(Y)(Y)
TransactionArray.Transaction.PickupMethodSelected
  .PickupLocationUUID
(Y)(Y)(Y)
TransactionArray.Transaction.PickupMethodSelected.PickupMethod(Y)(Y)(Y)
TransactionArray.Transaction.PickupMethodSelected.PickupStatus(Y)(Y)(Y)
TransactionArray.Transaction.PickupMethodSelected.PickupStoreID(Y)(Y)(Y)
TransactionArray.Transaction.PlatformY-Y
TransactionArray.Transaction.Program(Y)(Y)(Y)
TransactionArray.Transaction.Program.AuthenticityVerification(Y)(Y)(Y)
TransactionArray.Transaction.Program.AuthenticityVerification
  .OutcomeReason
(Y)(Y)(Y)
TransactionArray.Transaction.Program.AuthenticityVerification
  .ServiceCost
(Y)(Y)(Y)
TransactionArray.Transaction.Program.AuthenticityVerification
  .ServiceCost.Amount
(Y)(Y)(Y)
TransactionArray.Transaction.Program.AuthenticityVerification
  .ServiceCost.ConvertedFromAmount
(Y)(Y)(Y)
TransactionArray.Transaction.Program.AuthenticityVerification
  .Status
(Y)(Y)(Y)
TransactionArray.Transaction.Program.Fulfillment(Y)(Y)(Y)
TransactionArray.Transaction.Program.Fulfillment.FulfillmentBy(Y)(Y)(Y)
TransactionArray.Transaction.Program.Fulfillment.FulfillmentRefId(Y)(Y)(Y)
TransactionArray.Transaction.QuantityPurchased(Y)(Y)(Y)
TransactionArray.Transaction.SellerDiscounts(Y)-(Y)
TransactionArray.Transaction.SellerDiscounts.OriginalItemPrice(Y)-(Y)
TransactionArray.Transaction.SellerDiscounts
  .OriginalItemShippingCost
(Y)-(Y)
TransactionArray.Transaction.SellerDiscounts
  .OriginalShippingService
(Y)-(Y)
TransactionArray.Transaction.SellerDiscounts.SellerDiscount(Y)-(Y)
TransactionArray.Transaction.SellerDiscounts.SellerDiscount
  .CampaignDisplayName
(Y)-(Y)
TransactionArray.Transaction.SellerDiscounts.SellerDiscount
  .CampaignID
(Y)-(Y)
TransactionArray.Transaction.SellerDiscounts.SellerDiscount
  .ItemDiscountAmount
(Y)-(Y)
TransactionArray.Transaction.SellerDiscounts.SellerDiscount
  .ShippingDiscountAmount
(Y)-(Y)
TransactionArray.Transaction.ShippedTime(Y)(Y)(Y)
TransactionArray.Transaction.ShippingDetails(Y)-(Y)
TransactionArray.Transaction.ShippingDetails
  .CalculatedShippingRate
(Y)-(Y)
TransactionArray.Transaction.ShippingDetails
  .CalculatedShippingRate.InternationalPackagingHandlingCosts
(Y)-(Y)
TransactionArray.Transaction.ShippingDetails
  .CalculatedShippingRate.PackagingHandlingCosts
(Y)-(Y)
TransactionArray.Transaction.ShippingDetails
  .eBayEstimatedLabelCost
(Y)(Y)(Y)
TransactionArray.Transaction.ShippingDetails.PaymentEdited(Y)(Y)(Y)
TransactionArray.Transaction.ShippingDetails.SalesTax(Y)(Y)(Y)
TransactionArray.Transaction.ShippingDetails.SalesTax
  .SalesTaxAmount
(Y)(Y)(Y)
TransactionArray.Transaction.ShippingDetails.SalesTax
  .SalesTaxPercent
(Y)(Y)(Y)
TransactionArray.Transaction.ShippingDetails.SalesTax
  .SalesTaxState
(Y)(Y)(Y)
TransactionArray.Transaction.ShippingDetails.SalesTax
  .ShippingIncludedInTax
(Y)(Y)(Y)
TransactionArray.Transaction.ShippingDetails
  .SellingManagerSalesRecordNumber
(Y)(Y)(Y)
TransactionArray.Transaction.ShippingDetails
  .ShipmentTrackingDetails
(Y)(Y)(Y)
TransactionArray.Transaction.ShippingDetails
  .ShipmentTrackingDetails.ShipmentTrackingNumber
(Y)(Y)(Y)
TransactionArray.Transaction.ShippingDetails
  .ShipmentTrackingDetails.ShippingCarrierUsed
(Y)(Y)(Y)
TransactionArray.Transaction.ShippingDetails.ShippingRateType(Y)(Y)(Y)
TransactionArray.Transaction.ShippingDetails.ShippingServiceUsed(Y)(Y)(Y)
TransactionArray.Transaction.ShippingDetails.ShippingType(Y)(Y)(Y)
TransactionArray.Transaction.ShippingDetails.TaxTable(Y)-(Y)
TransactionArray.Transaction.ShippingDetails.TaxTable
  .TaxJurisdiction
(Y)(Y)(Y)
TransactionArray.Transaction.ShippingDetails.TaxTable
  .TaxJurisdiction.JurisdictionID
(Y)(Y)(Y)
TransactionArray.Transaction.ShippingDetails.TaxTable
  .TaxJurisdiction.SalesTaxPercent
(Y)(Y)(Y)
TransactionArray.Transaction.ShippingDetails.TaxTable
  .TaxJurisdiction.ShippingIncludedInTax
(Y)(Y)(Y)
TransactionArray.Transaction.ShippingServiceSelected(Y)(Y)(Y)
TransactionArray.Transaction.ShippingServiceSelected
  .ExpeditedService
(Y)-(Y)
TransactionArray.Transaction.ShippingServiceSelected.ImportCharge(Y)-(Y)
TransactionArray.Transaction.ShippingServiceSelected
  .ShippingPackageInfo
(Y)-(Y)
TransactionArray.Transaction.ShippingServiceSelected
  .ShippingPackageInfo.ActualDeliveryTime
(Y)-(Y)
TransactionArray.Transaction.ShippingServiceSelected
  .ShippingPackageInfo.EstimatedDeliveryTimeMax
(Y)-(Y)
TransactionArray.Transaction.ShippingServiceSelected
  .ShippingPackageInfo.EstimatedDeliveryTimeMin
(Y)-(Y)
TransactionArray.Transaction.ShippingServiceSelected
  .ShippingPackageInfo.HandleByTime
(Y)-(Y)
TransactionArray.Transaction.ShippingServiceSelected
  .ShippingPackageInfo.MaxNativeEstimatedDeliveryTime
(Y)-(Y)
TransactionArray.Transaction.ShippingServiceSelected
  .ShippingPackageInfo.MinNativeEstimatedDeliveryTime
(Y)-(Y)
TransactionArray.Transaction.ShippingServiceSelected
  .ShippingPackageInfo.ScheduledDeliveryTimeMax
(Y)-(Y)
TransactionArray.Transaction.ShippingServiceSelected
  .ShippingPackageInfo.ScheduledDeliveryTimeMin
(Y)-(Y)
TransactionArray.Transaction.ShippingServiceSelected
  .ShippingPackageInfo.ShippingTrackingEvent
(Y)-(Y)
TransactionArray.Transaction.ShippingServiceSelected
  .ShippingPackageInfo.StoreID
(Y)-(Y)
TransactionArray.Transaction.ShippingServiceSelected
  .ShippingService
(Y)-(Y)
TransactionArray.Transaction.ShippingServiceSelected
  .ShippingServiceAdditionalCost
(Y)-(Y)
TransactionArray.Transaction.ShippingServiceSelected
  .ShippingServiceCost
(Y)-(Y)
TransactionArray.Transaction.ShippingServiceSelected
  .ShippingServicePriority
(Y)-(Y)
TransactionArray.Transaction.ShippingServiceSelected
  .ShippingTimeMax
(Y)-(Y)
TransactionArray.Transaction.ShippingServiceSelected
  .ShippingTimeMin
(Y)-(Y)
TransactionArray.Transaction.Status(Y)(Y)(Y)
TransactionArray.Transaction.Status.BuyerSelectedShipping(Y)(Y)(Y)
TransactionArray.Transaction.Status.CheckoutStatus(Y)(Y)(Y)
TransactionArray.Transaction.Status.CompleteStatus(Y)(Y)(Y)
TransactionArray.Transaction.Status.DigitalStatus(Y)-(Y)
TransactionArray.Transaction.Status.eBayPaymentStatus(Y)(Y)(Y)
TransactionArray.Transaction.Status.InquiryStatus(Y)-(Y)
TransactionArray.Transaction.Status.LastTimeModified(Y)(Y)(Y)
TransactionArray.Transaction.Status.PaymentHoldStatus(Y)(Y)(Y)
TransactionArray.Transaction.Status.PaymentInstrument(Y)-(Y)
TransactionArray.Transaction.Status.PaymentMethodUsed(Y)(Y)(Y)
TransactionArray.Transaction.Status.ReturnStatus(Y)-(Y)
TransactionArray.Transaction.Taxes(Y)-(Y)
TransactionArray.Transaction.Taxes.eBayReference(Y)-(Y)
TransactionArray.Transaction.Taxes.TaxDetails(Y)-(Y)
TransactionArray.Transaction.Taxes.TaxDetails.Imposition(Y)-(Y)
TransactionArray.Transaction.Taxes.TaxDetails.TaxAmount(Y)-(Y)
TransactionArray.Transaction.Taxes.TaxDetails.TaxCode(Y)-(Y)
TransactionArray.Transaction.Taxes.TaxDetails.TaxDescription(Y)-(Y)
TransactionArray.Transaction.Taxes.TaxDetails.TaxOnHandlingAmount(Y)-(Y)
TransactionArray.Transaction.Taxes.TaxDetails.TaxOnShippingAmount(Y)-(Y)
TransactionArray.Transaction.Taxes.TaxDetails.TaxOnSubtotalAmount(Y)-(Y)
TransactionArray.Transaction.Taxes.TotalTaxAmount(Y)-(Y)
TransactionArray.Transaction.TransactionIDYYY
TransactionArray.Transaction.TransactionPriceYYY
TransactionArray.Transaction.TransactionSiteID(Y)-(Y)
TransactionArray.Transaction.Variation(Y)(Y)(Y)
TransactionArray.Transaction.Variation.SKU(Y)(Y)(Y)
TransactionArray.Transaction.Variation.VariationSpecifics(Y)(Y)(Y)
TransactionArray.Transaction.Variation.VariationSpecifics
  .NameValueList
(Y)(Y)(Y)
TransactionArray.Transaction.Variation.VariationSpecifics
  .NameValueList.Name
(Y)(Y)(Y)
TransactionArray.Transaction.Variation.VariationTitle(Y)(Y)(Y)
TransactionArray.Transaction.Variation.VariationViewItemURL(Y)(Y)(Y)
TransactionsPerPageYYY



Samples

New to making API calls? Please see Making a Call.

Note: Some item IDs, user IDs, or other data in these samples might no longer be active on eBay. If necessary, you can substitute current eBay data in your requests.

Available samples:

Sample: Basic Call

Returns all transactions for a particular seller.

Description

A transaction is created as soon as an item has a winning bidder or buyer (regardless of whether or not the buyer has fully paid for the item). In the response, all transactions are returned in a TransactionArray, with each transaction detailed in its own Transaction container.

In this example, the seller wants to get basic transaction information for her auction items. She is particularly interested in the Harry Potter book she just sold. She can find the payment status, shipping address, and other auction details by searching for the Transaction container that has ItemID value of the associated item.

Input

For this basic call, no input filters are used; the RequestorCredentials value establishes which user's transactions to return.

XML format.

<?xml version="1.0" encoding="utf-8"?>
<GetSellerTransactionsRequest xmlns="urn:ebay:apis:eBLBaseComponents">
  <RequesterCredentials>
    <eBayAuthToken>A*******3</eBayAuthToken>
  </RequesterCredentials>
</GetSellerTransactionsRequest>

Output

The response shows all the transactions for which the user is the selling party.

XML format.
<GetSellerTransactionsResponse xmlns="urn:ebay:apis:eBLBaseComponents">
  <Timestamp>2019-11-05T18:34:23.093Z</Timestamp>
  <Ack>Success</Ack>
  <Version>1131</Version>
  <Build>E1131_CORE_APISELLING_19099826_R1</Build>
  <PaginationResult>
    <TotalNumberOfPages>1</TotalNumberOfPages>
    <TotalNumberOfEntries>2</TotalNumberOfEntries>
  </PaginationResult>
  <HasMoreTransactions>false</HasMoreTransactions>
  <TransactionsPerPage>100</TransactionsPerPage>
  <PageNumber>1</PageNumber>
  <ReturnedTransactionCountActual>2</ReturnedTransactionCountActual>
  <Seller>
    <AboutMePage>false</AboutMePage>
    <EIASToken>n******************************************************=</EIASToken>
    <Email>m********@*****.com</Email>
    <FeedbackScore>2</FeedbackScore>
    <PositiveFeedbackPercent>75.0</PositiveFeedbackPercent>
    <FeedbackPrivate>false</FeedbackPrivate>
    <FeedbackRatingStar>None</FeedbackRatingStar>
    <IDVerified>true</IDVerified>
    <eBayGoodStanding>true</eBayGoodStanding>
    <NewUser>false</NewUser>
    <RegistrationDate>2004-05-27T00:00:00.000Z</RegistrationDate>
    <Site>US</Site>
    <Status>Confirmed</Status>
    <UserID>m***************r</UserID>
    <UserIDChanged>false</UserIDChanged>
    <UserIDLastChanged>2007-11-29T18:43:54.000Z</UserIDLastChanged>
    <VATStatus>NoVATTax</VATStatus>
    <SellerInfo>
      <AllowPaymentEdit>true</AllowPaymentEdit>
      <CheckoutEnabled>true</CheckoutEnabled>
      <CIPBankAccountStored>false</CIPBankAccountStored>
      <GoodStanding>true</GoodStanding>
      <QualifiesForB2BVAT>false</QualifiesForB2BVAT>
      <StoreOwner>true</StoreOwner>
      <StoreURL>http://www.stores.sandbox.ebay.com/id=1*******6</StoreURL>
      <SafePaymentExempt>true</SafePaymentExempt>
    </SellerInfo>
  </Seller>
  <TransactionArray>
    <Transaction>
      <AmountPaid currencyID="USD">22.5</AmountPaid>
      <AdjustmentAmount currencyID="USD">0.0</AdjustmentAmount>
      <ConvertedAdjustmentAmount currencyID="USD">0.0</ConvertedAdjustmentAmount>
      <Buyer>
        <AboutMePage>false</AboutMePage>
        <EIASToken>n******************************************************=</EIASToken>
        <Email>Invalid Request</Email>
        <FeedbackScore>1</FeedbackScore>
        <PositiveFeedbackPercent>100.0</PositiveFeedbackPercent>
        <FeedbackPrivate>false</FeedbackPrivate>
        <FeedbackRatingStar>None</FeedbackRatingStar>
        <IDVerified>false</IDVerified>
        <eBayGoodStanding>true</eBayGoodStanding>
        <NewUser>false</NewUser>
        <RegistrationDate>1995-01-01T00:00:00.000Z</RegistrationDate>
        <Site>US</Site>
        <Status>Confirmed</Status>
        <UserID>b********r</UserID>
        <UserIDChanged>false</UserIDChanged>
        <UserIDLastChanged>2009-02-12T05:01:49.000Z</UserIDLastChanged>
        <VATStatus>NoVATTax</VATStatus>
        <BuyerInfo>
          <ShippingAddress>
            <Name>B*******r</Name>
            <Street1>2** ***** *****t</Street1>
            <CityName>Hana</CityName>
            <StateOrProvince>HA</StateOrProvince>
            <Country>US</Country>
            <CountryName>United States</CountryName>
            <Phone>1-***-***-***4</Phone>
            <PostalCode>96713</PostalCode>
            <AddressID>4*****3</AddressID>
            <AddressOwner>eBay</AddressOwner>
          </ShippingAddress>
        </BuyerInfo>
        <UserAnonymized>false</UserAnonymized>
      </Buyer>
      <ShippingDetails>
        <ChangePaymentInstructions>true</ChangePaymentInstructions>
        <PaymentEdited>false</PaymentEdited>
        <SalesTax>
          <SalesTaxPercent>8.25</SalesTaxPercent>
          <SalesTaxState>CA</SalesTaxState>
          <ShippingIncludedInTax>true</ShippingIncludedInTax>
          <SalesTaxAmount currencyID="USD">0.0</SalesTaxAmount>
        </SalesTax>
        <ShippingType>Flat</ShippingType>
        <SellingManagerSalesRecordNumber>1*4</SellingManagerSalesRecordNumber>
        <TaxTable>
          <TaxJurisdiction>
            <JurisdictionID>CA</JurisdictionID>
            <SalesTaxPercent>8.25</SalesTaxPercent>
            <ShippingIncludedInTax>true</ShippingIncludedInTax>
          </TaxJurisdiction>
        </TaxTable>
      </ShippingDetails>
      <ConvertedAmountPaid currencyID="USD">22.5</ConvertedAmountPaid>
      <ConvertedTransactionPrice currencyID="USD">20.0</ConvertedTransactionPrice>
      <CreatedDate>2019-10-27T19:40:31.000Z</CreatedDate>
      <DepositType>None</DepositType>
      <Item>
        <AutoPay>false</AutoPay>
        <Currency>USD</Currency>
        <ItemID>1**********5</ItemID>
        <ListingType>Chinese</ListingType>
        <PaymentMethods>PayPal</PaymentMethods>
        <PrivateListing>false</PrivateListing>
        <Quantity>1</Quantity>
        <SellingStatus>
          <BidCount>1</BidCount>
          <CurrentPrice currencyID="USD">20.0</CurrentPrice>
          <QuantitySold>1</QuantitySold>
          <ListingStatus>Completed</ListingStatus>
        </SellingStatus>
        <IntegratedMerchantCreditCardEnabled>false</IntegratedMerchantCreditCardEnabled>
      </Item>
      <QuantityPurchased>1</QuantityPurchased>
      <Status>
        <eBayPaymentStatus>NoPaymentFailure</eBayPaymentStatus>
        <CheckoutStatus>SellerResponded</CheckoutStatus>
        <LastTimeModified>2019-10-27T20:41:59.000Z</LastTimeModified>
        <PaymentMethodUsed>None</PaymentMethodUsed>
        <CompleteStatus>Incomplete</CompleteStatus>
        <BuyerSelectedShipping>false</BuyerSelectedShipping>
        <PaymentHoldStatus>None</PaymentHoldStatus>
        <IntegratedMerchantCreditCardEnabled>false</IntegratedMerchantCreditCardEnabled>
      </Status>
      <TransactionID>0</TransactionID>
      <TransactionPrice currencyID="USD">20.0</TransactionPrice>
      <BestOfferSale>false</BestOfferSale>
      <ShippingServiceSelected>
        <ShippingService>USPSMedia</ShippingService>
        <ShippingServiceCost currencyID="USD">2.5</ShippingServiceCost>
      </ShippingServiceSelected>
      <TransactionSiteID>US</TransactionSiteID>
      <Platform>eBay</Platform>
      <IntangibleItem>false</IntangibleItem>
    </Transaction>
    <Transaction>
      <AmountPaid currencyID="USD">3.5</AmountPaid>
      <AdjustmentAmount currencyID="USD">0.0</AdjustmentAmount>
      <ConvertedAdjustmentAmount currencyID="USD">0.0</ConvertedAdjustmentAmount>
      <Buyer>
        <AboutMePage>false</AboutMePage>
        <EIASToken>n******************************************************=</EIASToken>
        <Email>b********@*****.com</Email>
        <FeedbackScore>1</FeedbackScore>
        <PositiveFeedbackPercent>100.0</PositiveFeedbackPercent>
        <FeedbackPrivate>false</FeedbackPrivate>
        <FeedbackRatingStar>None</FeedbackRatingStar>
        <IDVerified>false</IDVerified>
        <eBayGoodStanding>true</eBayGoodStanding>
        <NewUser>false</NewUser>
        <RegistrationDate>1995-01-01T00:00:00.000Z</RegistrationDate>
        <Site>US</Site>
        <Status>Confirmed</Status>
        <UserID>b********r</UserID>
        <UserIDChanged>false</UserIDChanged>
        <UserIDLastChanged>2009-02-12T05:01:49.000Z</UserIDLastChanged>
        <VATStatus>NoVATTax</VATStatus>
        <BuyerInfo>
          <ShippingAddress>
            <Name>B*******l B***r</Name>
            <Street1>1** ****** ***e</Street1>
            <CityName>Walla Walla</CityName>
            <StateOrProvince>WA</StateOrProvince>
            <Country>US</Country>
            <CountryName>United States</CountryName>
            <Phone>1-***-***-***4</Phone>
            <PostalCode>99362</PostalCode>
            <AddressID>5*****1</AddressID>
            <AddressOwner>eBay</AddressOwner>
          </ShippingAddress>
        </BuyerInfo>
        <UserAnonymized>false</UserAnonymized>
      </Buyer>
      <ShippingDetails>
        <ChangePaymentInstructions>true</ChangePaymentInstructions>
        <PaymentEdited>false</PaymentEdited>
        <SalesTax>
          <SalesTaxPercent>0.0</SalesTaxPercent>
          <ShippingIncludedInTax>false</ShippingIncludedInTax>
          <SalesTaxAmount currencyID="USD">0.0</SalesTaxAmount>
        </SalesTax>
        <ShippingType>Flat</ShippingType>
        <SellingManagerSalesRecordNumber>1*9</SellingManagerSalesRecordNumber>
      </ShippingDetails>
      <ConvertedAmountPaid currencyID="USD">3.5</ConvertedAmountPaid>
      <ConvertedTransactionPrice currencyID="USD">1.0</ConvertedTransactionPrice>
      <CreatedDate>2019-10-17T17:32:40.000Z</CreatedDate>
      <Item>
        <AutoPay>false</AutoPay>
        <Currency>USD</Currency>
        <ItemID>1**********2</ItemID>
        <ListingType>Chinese</ListingType>
        <PaymentMethods>PayPal</PaymentMethods>
        <PrivateListing>false</PrivateListing>
        <Quantity>1</Quantity>
        <SellingStatus>
          <BidCount>1</BidCount>
          <CurrentPrice currencyID="USD">1.0</CurrentPrice>
          <QuantitySold>1</QuantitySold>
          <ListingStatus>Completed</ListingStatus>
        </SellingStatus>
        <IntegratedMerchantCreditCardEnabled>false</IntegratedMerchantCreditCardEnabled>
      </Item>
      <QuantityPurchased>1</QuantityPurchased>
      <Status>
        <eBayPaymentStatus>NoPaymentFailure</eBayPaymentStatus>
        <CheckoutStatus>CheckoutComplete</CheckoutStatus>
        <LastTimeModified>2019-10-17T17:32:40.000Z</LastTimeModified>
        <PaymentMethodUsed>PayPal</PaymentMethodUsed>
        <CompleteStatus>Complete</CompleteStatus>
        <BuyerSelectedShipping>false</BuyerSelectedShipping>
        <PaymentHoldStatus>None</PaymentHoldStatus>
        <IntegratedMerchantCreditCardEnabled>false</IntegratedMerchantCreditCardEnabled>
      </Status>
      <TransactionID>0</TransactionID>
      <TransactionPrice currencyID="USD">1.0</TransactionPrice>
      <BestOfferSale>false</BestOfferSale>
      <ShippingServiceSelected>
        <ShippingService>USPSMedia</ShippingService>
        <ShippingServiceCost currencyID="USD">2.5</ShippingServiceCost>
      </ShippingServiceSelected>
      <TransactionSiteID>US</TransactionSiteID>
      <Platform>eBay</Platform>
      <IntangibleItem>false</IntangibleItem>
    </Transaction>
  </TransactionArray>
  <PayPalPreferred>true</PayPalPreferred>
</GetSellerTransactionsResponse>

Back to list of samples

Sample: Transactions with Item Variations

Retrieves the transaction details for Item Variations that were sold.

Description

A salesperson from m****************t was informed that some of their items have sold. He wants to retrieve the transactions so he can prepare the items for shipment.

Input

The request specifies a time range from the last time he retrieved m****************t's transactions to the current time.

XML format.

<?xml version="1.0" encoding="utf-8"?>
<GetSellerTransactionsRequest xmlns="urn:ebay:apis:eBLBaseComponents">
  <DetailLevel>ReturnAll</DetailLevel>
  <ModTimeFrom>2019-10-12T13:33:08.757Z</ModTimeFrom>
  <ModTimeTo>2019-10-12T14:33:08.757Z</ModTimeTo>
  <RequesterCredentials>
    <eBayAuthToken>A*******3</eBayAuthToken>
  </RequesterCredentials>
</GetSellerTransactionsRequest>

Output

In the response, the fields of particular interest for each transaction are:
- TransactionID
- TransactionPrice
- Transaction.AmountPaid
- Transaction.QuantityPurchased

The salesman knows that m****************t often lists with item variations, so he also checks for variation nodes in each transaction. In this case, he finds them and is able to see which variations buyers have purchased.

XML format.
<?xml version="1.0" encoding="utf-8"?>
<GetSellerTransactionsResponse xmlns="urn:ebay:apis:eBLBaseComponents">
  <Timestamp>2019-11-05T18:34:23.093Z</Timestamp>
    <Ack>Success</Ack>
    <Version>1131</Version>
  <Build>E1131_CORE_APISELLING_19099826_R1</Build>
  <PaginationResult>
    <TotalNumberOfPages>1</TotalNumberOfPages>
    <TotalNumberOfEntries>1</TotalNumberOfEntries>
  </PaginationResult>
  <HasMoreTransactions>false</HasMoreTransactions>
  <TransactionsPerPage>100</TransactionsPerPage>
  <PageNumber>1</PageNumber>
  <ReturnedTransactionCountActual>1</ReturnedTransactionCountActual>
  <Seller>
    <AboutMePage>false</AboutMePage>
    <EIASToken>n******************************************************=</EIASToken>
    <Email>t********@*****.com</Email>
    <FeedbackScore>500</FeedbackScore>
    <PositiveFeedbackPercent>0.0</PositiveFeedbackPercent>
    <FeedbackPrivate>false</FeedbackPrivate>
    <FeedbackRatingStar>Purple</FeedbackRatingStar>
    <IDVerified>true</IDVerified>
    <eBayGoodStanding>true</eBayGoodStanding>
    <NewUser>false</NewUser>
    <RegistrationDate>2008-12-11T00:00:00.000Z</RegistrationDate>
    <Site>US</Site>
    <Status>Confirmed</Status>
    <UserID>m********t</UserID>
    <UserIDChanged>false</UserIDChanged>
    <UserIDLastChanged>2006-02-08T21:55:29.000Z</UserIDLastChanged>
    <VATStatus>NoVATTax</VATStatus>
    <SellerInfo>
      <AllowPaymentEdit>true</AllowPaymentEdit>
      <CheckoutEnabled>true</CheckoutEnabled>
      <CIPBankAccountStored>false</CIPBankAccountStored>
      <GoodStanding>true</GoodStanding>
      <QualifiesForB2BVAT>false</QualifiesForB2BVAT>
      <SellerLevel>None</SellerLevel>
      <StoreOwner>false</StoreOwner>
      <SafePaymentExempt>false</SafePaymentExempt>
    </SellerInfo>
  </Seller>
  <TransactionArray>
    <Transaction>
      <AmountPaid currencyID="USD">39.13</AmountPaid>
      <AdjustmentAmount currencyID="USD">0.0</AdjustmentAmount>
      <ConvertedAdjustmentAmount currencyID="USD">0.0</ConvertedAdjustmentAmount>
      <Buyer>
        <AboutMePage>false</AboutMePage>
        <EIASToken>n******************************************************=</EIASToken>
        <Email>t********@*****.com</Email>
        <FeedbackScore>155</FeedbackScore>
        <PositiveFeedbackPercent>100.0</PositiveFeedbackPercent>
        <FeedbackPrivate>false</FeedbackPrivate>
        <FeedbackRatingStar>Turquoise</FeedbackRatingStar>
        <IDVerified>true</IDVerified>
        <eBayGoodStanding>true</eBayGoodStanding>
        <NewUser>false</NewUser>
        <RegistrationDate>2004-04-04T00:02:13.000Z</RegistrationDate>
        <Site>US</Site>
        <Status>Confirmed</Status>
        <UserID>t********r</UserID>
        <UserIDChanged>false</UserIDChanged>
        <UserIDLastChanged>2001-08-29T21:52:58.000Z</UserIDLastChanged>
        <VATStatus>NoVATTax</VATStatus>
        <BuyerInfo>
          <ShippingAddress>
            <Name>t*********************r</Name>
            <Street1>2*** *******n</Street1>
            <CityName>San Jose</CityName>
            <StateOrProvince>CA</StateOrProvince>
            <Country>US</Country>
            <CountryName>United States</CountryName>
            <PostalCode>95125</PostalCode>
            <AddressID>1****5</AddressID>
            <AddressOwner>ebay</AddressOwner>
          </ShippingAddress>
        </BuyerInfo>
        <UserAnonymized>false</UserAnonymized>
      </Buyer>
      <ShippingDetails>
        <CalculatedShippingRate>
          <OriginatingPostalCode>95125</OriginatingPostalCode>
          <PackageDepth measurementSystem="English" unit="inches">6</PackageDepth>
          <PackageLength measurementSystem="English" unit="inches">7</PackageLength>
          <PackageWidth measurementSystem="English" unit="inches">7</PackageWidth>
          <PackagingHandlingCosts currencyID="USD">0.0</PackagingHandlingCosts>
          <ShippingIrregular>false</ShippingIrregular>
          <ShippingPackage>PackageThickEnvelope</ShippingPackage>
          <WeightMajor measurementSystem="English" unit="lbs">2</WeightMajor>
          <WeightMinor measurementSystem="English" unit="oz">0</WeightMinor>
        </CalculatedShippingRate>
        <ChangePaymentInstructions>true</ChangePaymentInstructions>
        <PaymentEdited>false</PaymentEdited>
        <SalesTax>
          <SalesTaxPercent>8.75</SalesTaxPercent>
          <SalesTaxState>CA</SalesTaxState>
          <ShippingIncludedInTax>false</ShippingIncludedInTax>
          <SalesTaxAmount currencyID="USD">3.15</SalesTaxAmount>
        </SalesTax>
        <ShippingType>Calculated</ShippingType>
        <SellingManagerSalesRecordNumber>1*6</SellingManagerSalesRecordNumber>
        <TaxTable>
          <TaxJurisdiction>
            <JurisdictionID>CA</JurisdictionID>
            <SalesTaxPercent>8.75</SalesTaxPercent>
            <ShippingIncludedInTax>false</ShippingIncludedInTax>
          </TaxJurisdiction>
        </TaxTable>
        <GetItFast>false</GetItFast>
      </ShippingDetails>
      <ConvertedAmountPaid currencyID="USD">39.13</ConvertedAmountPaid>
      <ConvertedTransactionPrice currencyID="USD">17.99</ConvertedTransactionPrice>
      <CreatedDate>2019-10-12T14:26:17.000Z</CreatedDate>
      <DepositType>None</DepositType>
      <Item>
        <AutoPay>false</AutoPay>
        <BuyItNowPrice currencyID="USD">0.0</BuyItNowPrice>
        <Currency>USD</Currency>
        <ItemID>1**********9</ItemID>
        <ListingDetails>
          <StartTime>2019-10-12T14:16:25.000Z</StartTime>
          <EndTime>2019-10-12T14:16:25.000Z</EndTime>
          <ExpressListing>false</ExpressListing>
        </ListingDetails>
        <ListingType>FixedPriceItem</ListingType>
        <PaymentMethods>PayPal</PaymentMethods>
        <PrimaryCategory>
          <CategoryID>37565</CategoryID>
        </PrimaryCategory>
        <PrivateListing>false</PrivateListing>
        <Quantity>8</Quantity>
        <SecondaryCategory>
          <CategoryID>0</CategoryID>
        </SecondaryCategory>
        <SellingStatus>
          <CurrentPrice currencyID="USD">17.99</CurrentPrice>
          <QuantitySold>2</QuantitySold>
          <ListingStatus>Active</ListingStatus>
        </SellingStatus>
        <Site>US</Site>
        <StartPrice currencyID="USD">17.99</StartPrice>
        <Title>New Ralph Lauren Polo shirt Pink Black Blue Yellow</Title>
        <IntegratedMerchantCreditCardEnabled>false</IntegratedMerchantCreditCardEnabled>
      </Item>
      <QuantityPurchased>2</QuantityPurchased>
      <Status>
        <eBayPaymentStatus>NoPaymentFailure</eBayPaymentStatus>
        <CheckoutStatus>CheckoutIncomplete</CheckoutStatus>
        <LastTimeModified>2019-10-12T14:26:18.000Z</LastTimeModified>
        <PaymentMethodUsed>None</PaymentMethodUsed>
        <CompleteStatus>Incomplete</CompleteStatus>
        <BuyerSelectedShipping>false</BuyerSelectedShipping>
        <PaymentHoldStatus>None</PaymentHoldStatus>
        <IntegratedMerchantCreditCardEnabled>false</IntegratedMerchantCreditCardEnabled>
      </Status>
      <TransactionID>2***********1</TransactionID>
      <TransactionPrice currencyID="USD">17.99</TransactionPrice>
      <BestOfferSale>false</BestOfferSale>
      <ShippingServiceSelected>
        <ShippingService>USPSPriority</ShippingService>
        <ShippingServiceCost currencyID="USD">0.0</ShippingServiceCost>
      </ShippingServiceSelected>
      <TransactionSiteID>US</TransactionSiteID>
      <Platform>eBay</Platform>
      <IntangibleItem>false</IntangibleItem>
      <Variation>
        <SKU>R******************Pnk_M</SKU>
        <VariationSpecifics>
          <NameValueList>
            <Name>Color</Name>
            <Value>Pink</Value>
          </NameValueList>
          <NameValueList>
            <Name>Size</Name>
            <Value>M</Value>
          </NameValueList>
        </VariationSpecifics>
        <VariationTitle>New Ralph Lauren Polo shirt Pink Black Blue Yellow[Pink,M]</VariationTitle>
        <VariationViewItemURL>http://cgi.sandbox.ebay.com/ws/eBayISAPI.dll?ViewItem&item=1**********9&vti=Color%09Pink%0ASize%09M</VariationViewItemURL>
      </Variation>
    </Transaction>
  </TransactionArray>
</GetSellerTransactionsResponse>

Back to list of samples



Change History

Change Date Description
1349
2024-02-26
  • CalculatedShippingRate (modified): The OriginatingPostalCode field has been decommissioned and removed from CalculatedShippingRateType. Use Item.PostalCode instead.
1323
2023-08-25
  • SiteCodeType (modified): Czechia and Cyprus have been added to SiteCodeType as enumeration values. These sites cannot be set in the X-EBAY-API-SITEID header, nor in the Site field of a request payload.
  • CalculatedShippingRate (modified): The OriginatingPostalCode field has been deprecated and is not usable. Currently ignored. Use Item.PostalCode instead.
1321
2023-07-17
  • ShippingDetails.CODCost (deprecated): This field has been removed from the Trading WSDL.
1315
2023-06-16
  • ShippingDetails.CODCost (deprecated): CODCost has been deprecated since COD is no longer a supported payment method on any marketplace.
1313
2023-06-02
  • Transaction.Status.LastTimeModified (modified): For multiple line item orders, the LastTimeModified timestamp will reflect any change to the order, and not necessarily a modification to that specific line item.
1279
2022-10-07
  • ShippingDetails.eBayEstimatedLabelCost (added): The eBayEstimatedLabelCost field was added under the ShippingDetails container. This new field indicates the cost to buy the shipping label from eBay.
1225
2021-09-24
  • AuthenticityVerification.ServiceCost (added): The ServiceCost container was added under the AuthenticityVerification container. This new container shows the service cost to the buyer for an item that will go through the Authenticity Guarantee process.
  • TaxTypeCodeType (modified): ImportVAT and VAT enums added to indicate when VAT tax is being applied to an order line item.
  • eBayTaxReferenceValue (modified): VAT_ID added as a possible value for the Name attribute. This value is used for French VAT tax.
1209
2021-06-04
  • eBayCollectAndRemitTaxes.eBayReference (added): New field provides eBay's VAT tax ID.
  • eBayTaxReferenceValue (added): New type contains an attribute that indicates which type of VAT tax ID is returned in the eBayCollectAndRemitTaxes.eBayReference field.
  • ValueTypeCodeType (modified): A new VATIN value was added to support the use case when a buyer's VAT Identification Number is returned in the Order.BuyerTaxIdentifier.ID.
1201
2021-04-09
  • Variation.VariationTitle (doc change): Added max length constraint value of 120 characters to field description. The constraint value has always existed, but it was not documented until now.
1193
2021-02-12
  • FulfillmentType (added): New type provides details about an order line item being fulfilled by eBay or an eBay fulfillment partner.
  • Program.Fulfillment (added): New container provides details about an order line item being handled by eBay fulfillment.
1177
2020-10-23
  • AuthenticityVerificationType (modified): New enumeration values added. Values account for order line items that fail authentication and are not able to be returned to the seller because of legal constraints, and for order line items that are passed with exception.
1165
2020-07-31
  • AuthenticityVerificationType (added): New type gives status on whether the order line item has passed or failed the authenticity inspection, or if the test is still pending.
  • TransactionProgramType (added): New type provides details on whether the order line item has passed or failed the authenticity inspection.
  • Transaction.Program (added): New container gives the status of an order line item going through the authentication verification process.
1161
2020-07-06
  • Transaction.FinalValueFee (modified): The calculation of the Final Value Fee is changing for managed payments sellers, so the value returned in this field should only be considered as an estimated value.
  • SellingStatus.FinalValueFee (modified): The calculation of the Final Value Fee is changing for managed payments sellers, so the value returned in this field should only be considered as an estimated value.
  • IncludeFinalValueFee (doc change): A note was added to this boolean request field that talks about the new behavior of Final Value Fees for managed payments sellers.
1157
2020-06-05
  • ContainingOrder.OrderID (modified): Beginning in June 2020, only the new order ID format will be returned in response payloads for paid orders, regardless of the WSDL version number or compatibility level.
1145
2020-03-13
  • ContainingOrder.OrderID (doc change): Updated OrderID field description to state that beginning in April 2020, users will no longer be able to control whether returned order ID values for paid orders are in the old or new format, regardless of the WSDL version number and/or compatibility level. Previously, when the new order ID format was introduced in June 2019, the user could control whether they wanted to see the new or old order ID format in response payloads.
  • PaymentTransactionStatusCodeType (modified): Modified the behavior of how the Succeeded and Pending enumeration values work for off-eBay platform payment transactions. As of March 2020, the Pending value will get returned instead of the Succeeded value for order payment transactions occurring off of eBay's platform. The seller can use the CompleteSale call to mark the order as paid, and then the payment status will change from Pending to Succeeded.
1129
2019-10-11
  • eBayCollectAndRemitTaxes.TaxDetails.CollectionMethod (added): This new field is returned for transactions that are subject to 'eBay Collect and Remit' taxes, which include US state-mandated sales tax or 'Goods and Services' tax applicable to Australian and New Zealand sellers. Although this field will always be returned under the eBayCollectAndRemitTaxes.TaxDetails container, it currently does not have any practical use, but may be used in the future.
  • Transaction.AmountPaid, Transaction.ConvertedAmountPaid (modified): For orders subject to 'eBay Collect and Remit' tax (mandated US state sales tax or 'Goods and Services' tax in Australia and New Zealand), the 'eBay Collect and Remit' tax amount will be included in the AmountPaid and ConvertedAmountPaid amounts. This logic change is not applicable to sellers opted in to eBay managed payments.
  • ExternalTransaction.PaymentOrRefundAmount, Payment.PaymentAmount (modified): For orders subject to 'eBay Collect and Remit' tax (mandated US state sales tax or 'Goods and Services' tax in Australia and New Zealand), the 'eBay Collect and Remit' tax amount will be included in the ExternalTransaction.PaymentOrRefundAmount and Payment.PaymentAmount amounts (if these monetary transactions are corresponding to a buyer's payment for an order). This logic change is not applicable to sellers opted in to eBay managed payments.
1119
2019-08-02
  • ShippingServiceSelected.ShippingSurcharge (deprecated): The ShippingSurcharge field in ShippingServiceOptionsType has been removed from the Trading WSDL. For the next 18 months, this field will still be supported if used in a Add/Revise/Relist call, but it is recommended that sellers configure shipping surcharges in Shipping rate tables instead. Shipping rate tables can be added and modified through the Shipping Preferences in My eBay. Note that this field may still get returned in 'Get' calls if configured through Shipping rate tables.
1113
2019-06-21
  • ContainingOrder.OrderID (modified): The new format of order identifier values was rolled out. Both the new and old order ID format will be accepted in request payloads to identify an eBay order. The format (old or new) that is returned in response payloads is dependent on the WSDL version and/or compatibility level. See the 1113 Release Notes for more details.
  • ContainingOrder.ExtendedOrderID, Transaction.ExtendedOrderID (modified): The new order ID format will now be returned in all cases, regardless of the WSDL version number or compatibility level. The ExtendedOrderID field was previously created to distinguish between legacy and REST API-based order identifiers. Now, with the rollout of the new order ID format, the same order identifiers will be used for both legacy and REST-based APIs, although the legacy APIs will support both the old and the new formats until 2020. Once a Trading API user is integrated with the new order ID format, the values shown in the ExtendedOrderID and OrderID fields will be the same for each order.
  • ContainingOrder.OrderLineItemCount (modified): As long as the IncludeContainingOrder boolean field is included in the request and set to true, the OrderLineItemCount field is returned for WSDL Version 1113 (or newer as versions roll out) or if WSDL Version 1107 or 1111 is used and the compatibility level request header is included and set to '1113'.
1107
2019-05-10
  • ContainingOrder.OrderLineItemCount (added): New field added to indicate the total number of line items in the order. The IncludeContainingOrder boolean field must be included in the request and set to true for this field to be returned.
  • ContainingOrder.OrderID (modified): Starting in June 2019, eBay will start changing the format of order identifier values. The new format will be a non-parsable string, globally unique across all eBay marketplaces, and consistent for both single line item and multiple line item orders. To enable and use the new format, the user will need to use the 1107 WSDL (or newer as versions roll out) and set the compatibility level to 1113. There will be a nine-month transition period where the old format will still be supported.
1101
2019-03-29
  • Transaction.Status.PaymentMethodUsed (modified): For sellers opted in to the eBay Managed Payments program, the enumeration value returned in this field will be 'CreditCard', regardless of the actual payment method used by the buyer to pay for the order.
  • ShippingAddress.AddressID (modified): For orders subject to Australian 'Goods and Services' tax (GST), in addition to the unique identifier for the address, the last two digits of the user's Australian Business Number (ABN) will also appear in this field. Australian 'Goods and Services' tax (GST) is automatically charged to buyers outside of Australia when they purchase items on the eBay Australia site.
1091
2019-01-18
  • ListingDetails.MinimumBestOfferPrice (modified): Sellers accepting Best Offers for an auction listing can now set the Best Offer Auto Reject threshold price to a dollar value higher than the auction starting price.
1085
2018-10-26
  • Transaction.eBayCollectAndRemitTax, Transaction.eBayCollectAndRemitTaxes (doc change): Provided a little more detail to the 'eBay Collect and Remit Taxes' field descriptions and added links to the Australian 'Good and Service Tax' and US Sales Tax Collection help topics.
  • ShippingDetails.SalesTax (doc change): Added a note to state that the Sales Tax rate for a US tax jurisdiction that is subject to the 'eBay Collect and Remit Tax' program will be ignored during the checkout process, since eBay will be collecting and remitting this tax to the tax authorities without the seller's involvement.
  • Item.AutoPay (modified): The immediate payment feature is also available for sellers enrolled in the new eBay Managed Payments program. In the past, this feature was only available to sellers who were offering PayPal as the only available payment method.
  • Transaction.ExtendedOrderID, ContainingOrder.ExtendedOrderID, (doc change): Provided an example of an actual ExtendedOrderID value and added note that these values are used in the Post-Order and Fulfillment APIs to retrieve orders.
1081
2018-09-28
  • ShippingDetails.PaymentInstructions (doc change): The maximum length for this field was inaccurately documented as 1000, when the maximum length is actually 500 characters.
1073
2018-08-03
  • Transaction.TransactionPrice (doc change): Made a correction to the field description. This field was inaccurately described as including shipping charge and sales tax, when it accurately only indicates the sales price of one unit of the item.
1067
2018-06-22
  • OrderType.eBayCollectAndRemitTax (added): This boolean field is returned as true if the order was subject to Australian import tax charged to the buyer. This field is not returned if false. Australian import tax charged to the buyer is collected by eBay and remitted to the Australian government.
  • TransactionType.eBayCollectAndRemitTax (added): This boolean field is returned as true if the order line item was subject to Australian import tax charged to the buyer. This field is not returned if false. Australian import tax charged to the buyer is collected by eBay and remitted to the Australian government.
  • TransactionType.eBayCollectAndRemitTaxes (added): This container will be returned for any order line items subject to the import tax charged to the buyer, and the amount of this tax will be displayed in the TaxDetails.TaxAmount field under this container.
  • TaxDescriptionCodeType (modified): GST added as an enumeration value, and indicates that a Goods and Services import tax was charged to the buyer against the order line item.
  • TaxTypeCodeType (modified): GST added as an enumeration value, and indicates that a Goods and Services import tax was charged to the buyer against the order line item.
1027
2017-08-04
  • GetSellerTransactionsRequestType.Platform (doc change): The Platform field marked as no longer applicable since this field was only used to retrieve Half.com orders, and API support for Half.com listings is being deprecated.
  • ListingTypeCodeType (modified): The Half enumeration value is being deprecated, as API support for Half.com listings is being deprecated.
  • OrderStatusCodeType (modified): The Shipped enumeration value is being deprecated, as this value is only applicable to Half.com orders, and API support for Half.com listings is being deprecated.
  • Order.RefundArray, Transaction.RefundArray (deprecated): This container is being deprecated, as this container is only applicable to Half.com refunds, and API support for Half.com orders is being deprecated.
  • TransactionPlatformCodeType (modified): The Half enumeration value is being deprecated, as this value is only applicable to Half.com orders, and API support for Half.com listings is being deprecated.
  • UserStatusCodeType (modified): The CreditCardVerifyHalfOptIn and UnconfirmedHalfOptIn enumeration values are being deprecated, as API support for Half.com listings is being deprecated.
1019
2017-06-09
  • Transaction.GuaranteedDelivery (added): New field added to indicate whether or not the seller has committed to Guaranteed Delivery (delivered within four business days after purchase) for the order line item.
0997
2017-01-20
  • CalculatedShippingRate.PackageDepth (deprecated): This field is being deprecated. It will still be supported for 18 additional months, but for it to be available, the user will have to use Version 995 or older.
  • CalculatedShippingRate.PackageLength (deprecated): This field is being deprecated. It will still be supported for 18 additional months, but for it to be available, the user will have to use Version 995 or older.
  • CalculatedShippingRate.PackageWidth (deprecated): This field is being deprecated. It will still be supported for 18 additional months, but for it to be available, the user will have to use Version 995 or older.
  • CalculatedShippingRate.ShippingPackage (deprecated): This field is being deprecated. It will still be supported for 18 additional months, but for it to be available, the user will have to use Version 995 or older.
  • CalculatedShippingRate.WeightMajor (deprecated): This field is being deprecated. It will still be supported for 18 additional months, but for it to be available, the user will have to use Version 995 or older.
  • CalculatedShippingRate.WeightMinor (deprecated): This field is being deprecated. It will still be supported for 18 additional months, but for it to be available, the user will have to use Version 995 or older.
  • Item.ListingCheckoutRedirectPreference (deprecated): This field is being deprecated. Third-party checkout has been deprecated.
  • ShippingDetails.InsuranceFee (deprecated): This field is being deprecated.
  • ShippingDetails.InsuranceOption (deprecated): This field is being deprecated.
0995
2017-01-06
  • ShippingPackageInfo.HandleByTime (added): New field returned to indicate to sellers when they must ship an order to ensure that the package arrives at the buyer's destination within the Estimated Delivery Date window.
  • ShippingPackageInfo.MaxNativeEstimatedDeliveryTime (added): New field returned to indicate the latest expected delivery date based on the seller's handling time and the selected shipping service option.
  • ShippingPackageInfo.MinNativeEstimatedDeliveryTime (added): New field returned to indicate the earliest expected delivery date based on the seller's handling time and the selected shipping service option.
0981
2016-08-12
  • Transaction.GuaranteedShipping (added): New field returned for order line items where the seller chose to use eBay's Guaranteed Shipping feature. This field is for future use, as this feature will not be available until October 2016.
0979
2016-07-29
  • ModTimeFrom (doc change): Added a note in the field description that mentioned that this dateTime value cannot be set more than 90 days in the past because order management calls cannot retrieve any sales dating back more than 90 days.
0955
2016-02-12
  • BuyerPaymentMethodCodeType (modified): The Moneybookers, ProPay, and Paymate enumeration values have been deprecated, and will no longer be returned in any calls.
0945
2015-10-15
  • BuyerPaymentMethodCodeType (modified): Moneybookers, ProPay, or Paymate will no longer be accepted as valid PaymentMethods for new listings. However, these payment methods will still be allowed for existing listings, so these values may still get returned until these payment methods are completely removed from all listings.
0933
2015-07-24
  • eBayPlusTransaction (added): This new field returns a boolean value that indicates whether a transaction is for an item that was purchased under the eBay Plus program. eBay Plus is a premium account option for buyers, which provides benefits such as fast free domestic shipping and free returns on selected items. Sellers must commit to two-day delivery of eBay Plus items. Currently available only in Germany.
  • ContainseBayPlusTransaction (added): This new field returns a boolean value that indicates whether an order contains a transaction for an item that was purchased under the eBay Plus program. eBay Plus is a premium account option for buyers, which provides benefits such as fast free domestic shipping and free returns on selected items. Sellers must commit to two-day delivery of eBay Plus items. Currently available only in Germany.
  • DigitalDeliverySelectedType (added): This new type is used by the DigitalDeliverySelected container that is returned if the buyer purchased a digital gift card for themselves, or is giving the digital gift card to someone else as a gift. This container consists of information related to the digital gift card order line item, including the delivery method, delivery status, and recipient of the gift card (either the buyer, or another individual that is receiving the gift card as a gift from the buyer.
  • GiftSummaryType (added): This new type is used by the GiftSummary container that is returned if a buyer has purchased a digital gift card but has sent it to another individual as a gift, and has left a message for the recipient.
  • Transaction.Gift (added): This new boolean field is returned as true if the seller is giving a digital gift card to another individual as a gift. This field is only applicable for digital gift card order line items.
  • Transaction.Status.DigitalStatus (added): The enumeration in this new field indicates the current state of a purchased digital gift card. This field is only applicable and returned for digital gift card order line items.
  • LogisticsPlanCodeType (modified): New DigitalDelivery enumeration value added to type to indicate that the order or order line item is a digital gift card that will be delivered to the buyer, or the recipient of the gift card by email.
0911
2015-02-20
  • ShipmentTrackingDetails.ShippingCarrierUsed (doc change): Previous Trading API documentation incorrectly stated that the shipping carrier name returned for the international leg of a Global Shipping Program shipment was GlobalShipping_MultiCarrier. The value actually returned in the ShippingCarrierUsed field for Global Shipping is PBI.
0909
2015-02-16
  • Transaction.PaidTime (doc change): Clarified in the docs that this field is not returned for orders where the buyer has received a partial or full refund.
0899
2014-11-04
  • BuyerPaymentMethodCodeType (modified): 'QIWI' added as enumeration value. This payment method can only be specified on the US site and is only applicable to Russian buyers.
0897
2014-10-21
  • SiteCodeType (modified): 'Russia' added as enumeration value to support selling on the new Russia site.
0895
2014-10-07
  • Order.ExtendedOrderID (doc change): Added more content to the field description.
  • Transaction.ExtendedOrderID (doc change): Added more content to the field description.
  • SellerDiscount.ItemDiscountAmount (doc change): Field description updated to fit new behavior of this field.
0893
2014-09-23
  • Order.ExtendedOrderID (added): This field is for internal or future use.
  • Transaction.ExtendedOrderID (added): This field is for internal or future use.
0891
2014-09-09
  • Transaction.InventoryReservationID (added): A unique identifier used by the merchant to identify reserved merchandise.
  • Buyer.UserFirstName, Buyer.UserLastName (added): The first and last name of the buyer who purchased the order.
  • SellerDiscounts.OriginalShippingService (added): The original shipping service offered by the seller to ship an item to a buyer.
  • ValueTypeCodeType (modified): 'DriverLicense' and 'CNPJ' added as new enum values.
0887
2014-07-15
  • ContainingOrder.BuyerPackageEnclosures, Transaction.BuyerPackageEnclosures (added): A BuyerPackageEnclosures container, containing one or more BuyerPackageEnclosure containers, is returned if a buyer on the Germany site is being offered the 'Pay Upon Invoice' option, and the seller has provided payment instructions to the buyer in the shipping package(s). Payment instructions are provided through the type attribute of BuyerPackageEnclosureType. The BuyerPackageEnclosures container is returned at the order level for single line item orders, and at the transaction level for multiple line item orders. The 'Pay Upon Invoice' option will become available on the Germany site with the rollout of Progressive Checkout in October 2014.
  • ContainingOrder.CheckoutStatus.PaymentInstument, Transaction.Status.PaymentInstrument (added): A PaymentInstrument field is returned if a buyer on the Germany site is using the 'Pay Upon Invoice' option. The enumeration value in this field indicates the type of payment method that the buyer selected to pay for the 'Pay Upon Invoice' order. The PaymentInstrument field is returned at the order level for single line item orders, and at the transaction level for multiple line item orders. The 'Pay Upon Invoice' option will become available on the Germany site with the rollout of Progressive Checkout in October 2014.
  • CancelReasonCodeType (modified): 'BuyerCancelOrAddressIssue' and 'OutOfStockOrCannotFulfill' added as new enum values.
  • ReturnStatusCodeType (modified): 'ReturnEscalated', 'ReturnRequestPending', 'ReturnRequestClosedWithRefund', and 'ReturnRequestClosedNoRefund' added as new enum values.
0883
2014-07-15
  • EstimatedDeliveryTimeMin, EstimatedDeliveryTimeMax (added): EstimatedDeliveryTimeMin and EstimatedDeliveryTimeMax are new dateTime fields in the ShippingPackageInfo container, indicating the earliest and latest times, respectively, that the buyer can expect to take delivery of an order not being delivered via eBay Now.
  • BuyerPaymentMethodCodeType (modified): The 'PayUponInvoice' enumeration value was added. This buyer payment method is for future use and will become available to the Germany site with the rollout of Progressive Checkout in October 2014. eBay/PayPal makes the determination (based on several factors) during checkout whether the buyer is eligible for 'Pay Upon Invoice'. If the buyer is offered the 'Pay Upon Invoice' option, that buyer is not required to pay for the order until an order invoice is sent by the seller.
  • TaxDetails.TaxCode (added): 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.
0879
2014-06-17
  • AddressType.AddressAttribute (added): New field that shows an attribute for the address, and its corresponding value.
  • AddressType.ReferenceID (added): New field that shows an attribute for the address, and its corresponding value.
  • AddressAttributeType (added): New type that is used to display the value of the type attribute of the AddressAttribute field.
  • AddressAttributeCodeType (added): New enumerated type that contains the possible values that can be returned in AddressAttribute field.
  • ContainingOrder.BuyerTaxIdentifier (added): New container consists of taxpayer identification for the buyer. This container is returned at the order level to sellers on the Italy or Spain site if a tax ID has been provided by the buyer during the checkout flow.
  • BuyerInfo.BuyerTaxIdentifier (added): New container consists of taxpayer identification for the buyer. This container is returned at the order line item level to sellers on the Italy or Spain site if a tax ID has been provided by the buyer during the checkout flow.
  • TaxIdentifierType (added): New type that defines the BuyerTaxIdentifier container.
  • ValueTypeCodeType (modified): This existing enumerated type is now used by order management calls to indicate what type of tax ID was provided by the buyer.
  • TaxIdentifierAttributeType (added): New type that is used to display the value of the name attribute of the BuyerTaxIdentifier.Attribute field.
  • TaxIdentifierAttributeCodeType (added): New enumerated type that contains the possible values that can be returned in the name attribute of the BuyerTaxIdentifier.Attribute field.
  • CancelStatusCodeType (modified): The following values were added to handle more order cancellation states: 'Invalid', 'NotApplicable', 'CancelRequested', 'CancelRejected', 'CancelClosedNoRefund', 'CancelClosedWithRefund', 'CancelClosedUnknownRefund', and 'CancelClosedForCommitment'.
  • Transaction.Status.ReturnStatus (added): New field gives the status of a buyer's return request.
  • Transaction.Status.InquiryStatus (added): New field gives the status of a buyer's request for shipment tracking information.
  • ReturnStatusCodeType (added): New enumerated type that contains the possible values that can be returned in the Transaction.Status.ReturnStatus field.
  • InquiryStatusCodeType (added): New enumerated type that contains the possible values that can be returned in the Transaction.Status.InquiryStatus field.
  • PickuMethodCodeType (modified): 'PickUpDropOff' value added to handle the use case when the buyer selects "Click and Collect" as the pickup method. The "Click and Collect" feature is currently only available on the eBay UK site.
  • PickupMethodSelectedType (modified): 'PickupLocationUUID' value added to identify the store where the "Click and Collect" item will be picked up.
0877
2014-06-03
  • ContainingOrder.LogisticsPlanType (added): New field that 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.
  • Transaction.LogisticsPlanType (added): New field that 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 a package is transported from the seller to the buyer.
0867
2014-03-25
  • CancelDetailType (added): New type that provides details on the cancellation of an eBay Now Order.
  • CancelInitiatorCodeType (added): New type that defines the parties who can initiate the cancellation of an eBay Now Order.
  • CancelStatusCodeType (added): New type that defines the states of an eBay Now order cancellation.
  • PickupMethodSelected.PickupFulfillmentTime (added): Timestamp indicating when an In-Store Pickup order is available to be picked up by the buyer.
  • Transaction.ShippingConvenienceCharge (added): The convenience fee charged to the buyer for one order line item in an eBay Now order.
  • CancelReasonCodeType (modified): 'OrderPlacedByMistake', 'PriceTooHigh', 'FoundCheaperPrice', and 'WontArriveInTime' added as new enum values.
  • OrderStatusCodeType (modified): 'CancelPending' added as new enum value.
  • PickupStatusCodeType (modified): 'PickupCancelled' added as new enum value.
0849
2013-11-05
  • ShippingServiceOptions.ShippingPackageInfo (added): New container consisting of details related to an eBay Now delivery. This container will only be returned for eBay Now-eligible orders. Once a buyer selects 'eBayNowImmediateDelivery' as the delivery/shipping option, this container will be replaced by the ShippingServiceSelected.ShippingPackageInfo container.
  • ShippingServiceSelected.ShippingPackageInfo (added): New container consisting of details related to an eBay Now delivery. This container will only be returned for eBay Now orders.
  • MonetaryDetails.Payments.Payment.PaymentReferenceID (added): New field added to support buyer payment for an eBay Now order. The value in this field will be the unique identifier of the eBay Now payment transaction, and the value of this field's type attribute will be 'MandateReferenceNumber' for eBay Now payment transactions.
  • Item.PaymentMethods (modified): 'CreditCard' and 'DirectDebit' added as acceptable buyer payment methods. These two values will only be returned for eBay Now orders.
  • ShippingServiceOptions.ShippingService (modified): 'eBayNowImmediateDelivery' added as an acceptable value in the ShippingService field. This value will only be returned for eBay Now orders.
0833
2013-07-25
  • ShippingDetails.ShippingRateType (modified): Three new enumeration values can be returned in ShippingRateType, which indicates the USPS shipping rate scale being used for the shipment. CommercialPlus specifies the "Commercial Plus" shipping rate scale; GoldSilver specifies the "Commercial Plus Discounted Rate1" shipping rate scale; and PlatTitanium specifies the "Commercial Plus Discounted Rate2" shipping rate scale.
0831
2013-07-03
  • Transaction.MonetaryDetails.Refunds (added): 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. 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.
  • Transaction.PickupDetails (added): This container consists of an array of PickupOptions containers. Each PickupOptions container consists of the pickup method and its priority. 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. 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 any 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. 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. 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.
  • Transaction.PickupMethodSelected (added): Container consisting 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). This container is only returned when the buyer has selected the In-Store Pickup option and has paid for the order. All fields in the PickupMethodSelected container are static, except for the PickupStatus field, which can change states based on the notifications that a merchant sends to eBay through the Inbound Notifications API. 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. 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.
0827
2013-06-05
  • MonetaryDetails (added): This container and its child fields (Payments, Payment, FeeOrCreditAmount, Payee, Payer, PaymentAmount, PaymentStatus, PaymentTime and ReferenceID) provide 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.
  • ExternalTransactionStatus (added): Enumerated value that indicates the current processing status of a PayPal payment for an eBay order.
0825
2013-05-22
  • ShippingDetails.ShippingRateType (modified): A new enumeration value, Discounted, can be returned in ShippingRateType. Discounted indicates that the USPS Discounted shipping rate scale is being used for the transaction.
0821
2013-04-24
  • TransactionArray.Transaction.PaymentHoldDetails.RequiredSellerActionArray.RequiredSellerAction (modified): 'ResolveReturn' added as a value for RequiredSellerActionCodeType. 'ResolveReturn' will be returned if the buyer is returning the item through eBay's managed return process. The seller will have to resolve the return case and issue a refund to the buyer before the Final Value Fee for the original sale is credited back to the seller's account.
  • TransactionArray.Transaction.ContainingOrder.PaymentHoldDetails.RequiredSellerActionArray.RequiredSellerAction (modified): 'ResolveReturn' added as a value for RequiredSellerActionCodeType. 'ResolveReturn' will be returned if the buyer is returning the item through eBay's managed return process. The seller will have to resolve the return case and issue a refund to the buyer before the Final Value Fee for the original sale is credited back to the seller's account.
0811
2013-02-13
  • PaymentHoldDetails.PaymentHoldReason (added): 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.
  • PaymentHoldDetails.RequiredSellerAction.ResolveBuyerMessageInr (added): A RequiredSellerAction value that 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.
  • PaymentHoldDetails.RequiredSellerAction.ResolveBuyerMessageSnad (added): A RequiredSellerAction value that 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.
  • PaymentHoldDetails.RequiredSellerAction.UploadTrackingInfo (added): A RequiredSellerAction value that 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.
0807
2013-01-23
  • TransactionPrice (doc change): The description of this field was incorrect. TransactionPrice is the price of one order line item. This price is returned only for Best Offer items. 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 Best Offer, this value is the per-unit price.
  • Transaction.ActualShippingCost (doc change): Clarified that Transaction.ActualShippingCost is the shipping cost charged to the buyer for an order line item. This is different from the field of the same name returned by GetSellingManagerSaleRecord and ReviseSellingManagerSaleRecord, which contains the actual shipping cost paid by the seller.
0795
2012-10-10
  • Transaction.ShippingServiceSelected (doc change): Added a note to explain that for GetItemTransactions and GetSellerTransactions, this container does not return accurate shipping service and cost information for multiple line item orders. Use GetOrders instead, and provide the order's combined OrderID to retrieve this information.
0793
2012-09-26
  • MultiLegShippingDetails (modified): This container was previously returned at both the transaction and order levels; it is now returned at only the transaction level (TransactionArray.Transaction.MultiLegShippingDetails).
0791
2012-09-12
  • InternationalShippingServiceOption.ShippingService (modified): New International shipping services added for UK and DE sites as part of the EU delivery estimate project. For UK, these new enumeration values are UK_ParcelForceIntlExpress, UK_ParcelForceIntlValue, and UK_ParcelForceIntlEconomy. For DE, these new enumeration values are DE_DeutschePostBriefIntlEcon and DE_DeutschePostBriefIntlPriority.
0789
2012-08-29
  • Transaction.IntangibleItem (added): This flag indicates whether or not the order line item is an intangible good such as an MP3 track or a mobile phone ringtone. This value is primarily used by PayPal to see if the item qualifies for PayPal's Seller Protection program.
  • Transaction.InvoiceSentTime (added): This field indicates the date/time that an order invoice was sent from the seller to the buyer.
  • Transaction.UnpaidItem (added): This container consists of details related to the type and status of an Unpaid Item case.
0783
2012-07-18
  • TransactionArray.Transaction.ShippingServiceSelected.ImportCharge (added): Thyis field provides the total cost of customs and taxes that will be applied to a item shipped internationally 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.
  • LogisticsProviderShipmentToBuyer (doc change): LogisticsProviderShipmentToBuyer and its child fields (including ShippingServiceDetails) were incorrectly documented. They are not part of this call.
  • ShipmentLineItem (doc change): ShipmentLineItem and its child fields (including LineItem and CountryOfOrigin) were incorrectly documented. They are not part of this call.
0781
2012-07-04
  • ReferenceID (modified): This field appears only in SellerShipmentToLogisticsProvider.ShipToAddress.
  • ShippingServiceCodeType (modified): AU_StandardDeliveryFromOutsideAU added as a shipping service option. This option can be specified by sellers on the AU site if the item is being shipped from a location outside of Australia using standard delivery.
0777
2012-06-06
  • IsMultiLegShipping (added): IsMultiLegShipping is returned in TransactionArray.Transaction and TransactionArray.Transaction.ContainingOrder, and indicates whether the order or transaction uses the Global Exchange program, in which the shipment has a domestic leg and an international leg.
  • MultiLegShippingDetails (added): MultiLegShippingDetails is returned in TransactionArray.Transaction and TransactionArray.Transaction.ContainingOrder, and contains information about the domestic and international legs of a Global Exchange program shipment.
    The two legs are represented by child containers: LogisticsProviderShipmentToBuyer and SellerShipmentToLogisticsProvider.
  • MultiLegShippingDetails.LogisticsProviderShipmentToBuyer (added): This container provides information about the shipping service, cost, address, and delivery estimates for the international leg of a Global Exchange shipment. The ShippingServiceDetails child container provides the name of the shipping service and the total shipping cost.
  • MultiLegShippingDetails.SellerShipmentToLogisticsProvider (added): This container provides information about the shipping service, cost, address, and delivery estimates for the domestic leg of a Global Exchange shipment. The ShippingServiceDetails child container provides the name of the shipping service and the total shipping cost.
  • ReferenceID (added): ReferenceID is returned in LogisticsProviderShipmentToBuyer.ShipToAddress, SellerShipmentToLogisticsProvider.ShipToAddress and TransactionArray.Transaction.Buyer.BuyerInfo.ShippingAddress. Its value is generated by eBay when the order is completed, and it uniquely identifies an order shipped using the Global Exchange program. It must appear on the shipping label.
  • ShipmentLineItem (added): Contains information about one or more order line items in a Global Exchange package. ShipmentLineItem is returned in TransactionArray.Transaction.ShippingDetails.ShipmentTrackingDetails.
  • ShipmentLineItem.LineItem (added): Contains information about one order line item in a Global Exchange package, including the Country of Manufacture and the number of units of the order line item in the package, both of which are required for customs. The package can contain multiple order line items.
0771
2012-04-25
  • eBayPaymentMismatchDetails.MismatchAmount (added): This value indicates the amount that the buyer's payment was either over or under the actual order cost.
  • RequiredSellerActionCodeType.ContacteBayCS (added): This value indicates that the DE/AT seller should contact eBay Customer Support to discover the next required action.
  • RequiredSellerActionCodeType.ResolvePPPICase (added): This value indicates that the DE/AT seller must resolve PayPal Buyer Protection case.
  • RequiredSellerActionCodeType.SetupPayoutMethod (added): This value indicates that the DE/AT seller must set up a valid payout account in order to receive seller payouts.
  • RequiredSellerActionCodeType.UpdatePayoutMethod (added): This value indicates that the DE/AT seller must update to a valid payout account in order to receive seller payouts.
0765
2012-03-14
  • Refund (modified): 11 new fields added to support refunds in eBay's new payment process.
    The new fields are: EstimatedRefundCompletionTime, ExternalReferenceId, RefundAmount, RefundCompletionTime, RefundFailureReason, RefundFundingSourceArray, RefundID, RefundRequestedTime, RefundStatus, RefundTransactionArray and SellerNoteToBuyer.
  • RefundFailureReason (added): A container for the RefundFailureCode.
  • RefundFailureCode (added): A code indicating the reason why a refund was not issued by the seller.
    The enumeration values are: PaypalBillingAgreementCanceled and PaypalRiskDeclinesTransaction.
  • RefundFundingSourceArray (added): Container consisting of zero or more RefundFundingSource containers.
  • RefundFundingSource (added): Contains information about the funding source for the refund.
    The fields are: AccountNumber, BuyerExternalTransactionID, RefundAmount, RefundingSourceType and SellerExternalTransactionID.
  • RefundingSourceType (added): A code indicating the source from which the refund was made.
    The enumeration values are: BankAccount, PayPal and ScheduledPayout.
  • RefundStatus (added): A code indicating the status of the refund request.
    The enumeration values are: Failed, Pending and Successful.
  • RefundTransactionArray (added): A container consisting of zero or more RefundTransaction containers.
  • RefundTransaction (added): A container consisting of details about the transaction against which the seller issued a refund.
    The fields are: ItemID, OrderID, RefundLineArray and TransactionID.
  • RefundLineArray (added): A container consisting of zero or more refund lines.
  • RefundLine (added): The order line item to which the refund was applied.
    The RefundLine attribute, Type, has these enumeration values: Additional, PurchasePrice and ShippingPrice.
  • Transaction.Status.eBayPaymentMismatchDetails (added): This response container is returned to DE/AT sellers (ramped up in the new eBay payment process) if the buyer underpaid or overpaid for an order going through the new eBay payment process flow. This container consists of the payment mismatch type and a date by which the seller must either accept or reject the over/under payment.
  • Seller.SellerInfo.SellereBayPaymentProcessConsent (added): This response container is returned to DE/AT sellers ramped up in the new eBay payment process. This container consists of information related to the seller's signing of the supplemental user agreement and payout preferences.
  • Seller.SellerInfo.SellereBayPaymentProcessStatus (added): This response field contains an enumeration value that indicates the current status of a DE or AT seller's account related to the new eBay payment process.
0741
2011-09-28
  • eBayPaymentStatus.Paid (added): New enum value that indicates that the buyer has paid for an order.
0739
2011-09-14
  • TransactionArray.Transaction.SellerDiscounts (added): A container consisting of one or more SellerDiscount nodes, as well as the original item and shipping cost.
0735
2011-08-17
  • TransactionArray.Transaction.Status.PaymentMethodUsed (deprecated): StandardPaymentMethod is no longer returned.
0731
2011-07-20
  • PaymentHoldStatusCodeType (modified): ReleaseConfirmed, ReleaseFailed, and ReleasePending added as enumeration values to capture the status of the release of funds to a seller's account.
0719
2011-04-27
  • ShippingServiceCodeType (modified): 15 new shipping services added for the Australia and Canada sites. The nine new Australia carrier-specific shipping services include AU_AusPostRegisteredPostInternationalPaddedBag1kg, AU_AusPostRegisteredPostInternationalPaddedBag500g, AU_AusPostRegisteredPostInternationalParcel, AU_AustralianAirExpressFlatRate1kg, AU_AustralianAirExpressFlatRate3kg, AU_AustralianAirExpressFlatRate5kg, AU_AustralianAirExpressMetro15kg, AU_eBayAusPost3kgFlatRateSatchel, and AU_eBayAusPost500gFlatRateSatchel. The nine new Australia generic service level shipping services include AU_EconomyDeliveryFromOutsideAU, AU_ExpeditedDeliveryFromOutsideAU, AU_ExpressDelivery, AU_Freight, and AU_StandardDelivery. The new Canada shipping service is CA_Freight.
  • Item.ShippingDetails.ShippingServiceOptions (modified): '4' has been added as a valid integer value to account for the additional international shipping service that may be specified by the seller.
  • Item.ShippingDetails.InternationalShippingServiceOption (modified): '4' and '5' have been added as valid integer values to account for the additional international shipping services that may be specified by the seller.
  • TransactionType.FinalValueFee (modified): For non-store, auction listings on North America sites, the FinalValueFee value may change upon checkout based on all costs associated with Shipping, including handling and shipping insurance charges.
  • RequiredSellerActionArrayType (added): A container consisting of zero or more actions (returned in RequiredSellerAction fields) that a seller may take to possibly expedite the release of a payment hold on an order line item.
  • RequiredSellerActionCodeType (added): MarkAsShipped and ResolveeBPCase added as actions that a seller may take to possibly expedite the release of a payment hold on an order line item.
  • TransactionType.PaymentHoldDetails (added): Starting in June 2011, this container will be returned if a seller's funds are placed in hold status. This container consists of the expected release date of the payment hold, as well as possible actions that a seller can take to expedite the release of the payment hold.
  • PaymentHoldStatusCodeType (added): New code type that indicates the type and/or status of a payment hold.
0705
2011-01-19
  • OrderLineItemID (modified): The OrderLineItemID value is now returned in Production under each Transaction node.
0693
2010-10-27
  • OrderLineItemID (added): A unique identifier for an eBay transaction, which is based upon the concatenation of ItemID and TransactionID with a hyphen in between these two IDs. OrderLineItemID is only returned if you set your request version to 705.
0689
2010-09-20
  • Item.ApplyShippingDiscount (deprecated): As of version 689, Item.ApplyShippingDiscount is deprecated and removed from the schema.
0675
2010-06-23
  • Transaction.Taxes (added): Reserved for future use.
0673
2010-06-09
  • StaticAlias (added): The StaticAlias field contains the static email address of an eBay member. As of summer 2010, the StaticAlias field is returned by this call as an addition to the existing Email field.
0663
2010-03-31
  • Item.ApplyShippingDiscount (deprecated): This tag is no longer being used. It will be officially deprecated later in 2010.
  • PaymentHoldStatus (modified): If a new seller hold applies to the buyer's payment, a PaymentHoldStatus of NewSellerHold is returned.
0639
2009-10-14
  • ShippingDetails (modified): The ShipmentTrackingNumber element has been moved into the new ShipmentTrackingDetails container, which is returned as a node within the ShippingDetails container. ShipmentTrackingDetails contains both ShippingCarrierUsed and ShipmentTrackingNumber, and is a repeatable container that can provide details for multiple packages shipped for a single item. With this refinement, ShipmentTrackingNumber is no longer returned as individual child element of ShippingDetails.
0635
2009-09-16
  • ExcludeShipToLocation (added): Sellers can now exclude specific regions and countries from where they will ship items.
  • InsuranceDetails, InsuranceFee, InsuranceOption, InternationalInsuranceDetails, InsuranceWanted, ShippingInsuranceCost (modified): Sellers can no longer give buyers the option to purchase shipping insurance for either domestic or international items. The buyer-paid shipping insurance option has been removed from the following sites:
    BEFR, BENL, CA, CAFR, HK, IE, IN, MY, Motors, NL, PH, PL, SG, UK, US
    Insurance tags are returned only when the associated item has buyer-paid shipping insurance values.
0615
2008-04-29
  • Variation (added): Identifies a variation that was purchased from a multi-variation listing.
  • Quantity, StartPrice, CurrentPrice (modified): Item.Quantity returns the total quantity across all variations, when variations are present. Item.StartPrice and other price fields return the price of the lowest-priced variation. TransactionPrice returns the actual price of the transaction (based on the variation purchased).
0603
2009-02-04
  • Item.IntegratedMerchantCreditCardEnabled (added): Indicates that the IntegratedMerchantCreditCard payment method applies to the item.
  • TransactionArray.Transaction.Status.IntegratedMerchantCreditCardEnabled (added): Indicates that the IntegratedMerchantCreditCard payment method applies.
  • TransactionArray.Transaction.ContainingOrder.IntegratedMerchantCreditCardEnabled (added): Indicates that the IntegratedMerchantCreditCard payment method applies.
0587
2008-10-15
  • TransactionPlatformCodeType.WorldOfGood (added): The WorldOfGood site will now show up as a transaction platform.
0581
2008-09-03
  • Item.ListingType.StoresFixedPrice, Item.ListingType.FixedPriceItem (modified): Listing duration for fixed price items has expanded to include Days_30 and GTC.
0573
2008-07-09
  • TransactionArray.Transaction.Item.DigitalDeliveryDetails (deprecated): The digital delivery feature is disabled as of March 28, 2008. GetSellerTransactions no longer returns digital delivery details for digital download items.
0563
2008-04-30
  • Transaction.BuyerGuaranteePrice (added): On the Australia site, by early June 2008, 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.
  • BuyerProtection.NoCoverage (added): On the Australia site, by early June 2008, indicates that there is no PayPal Buyer Protection coverage.
0561
2008-04-16
  • Item.ListingType.Express (deprecated): Due to the shutdown of UK and Germany eBay Express sites Item.ListingType.Express has been deprecated.
0555
2008-03-05
  • ShippingDetails.CODCost (added): Applicable beginning in April. Applies to the Italy site (site ID 101). Contains the cost of cash-on-delivery shipping.
0551
2008-02-06
  • NumberOfDays (added): Enables you to specify the number of days' worth of new and modified transactions that you want to retrieve.
  • PaymentHoldStatus (added): Returned in the case of a PayPal payment by the buyer. Provides a status value related to the occurrence of a payment review hold or merchant hold.
0537
2007-10-31
  • Item.PaymentMethods.PaisaPayEscrow, Item.PaymentMethods.PaisaPayEscrowEMI (added): These enum will be returned for items offering PaisaPayEscrow and PaisaPayEscrowEMI payment methods.
0535
2007-10-17
  • Status.Guest (added): The Guest enum can be returned in TransactionArray.Transaction.Buyer.Status.
0519
2007-06-27
  • TransactionPrice (doc change): TransactionPrice is the per-item price for the transaction; transactions with QuantityPurchased of more than 1 have the same value for TransactionPrice as transactions with QuantityPurchased of 1.
0503
2007-03-07
  • SellerType.SafePaymentExcempt (added): This field indicates whether a seller is exempt from providing a safe payment method. If a seller is exempt, any safe payment restrictions for a site or a category do not apply.
0491
2006-12-13
  • TransactionArray.Transaction.ShippingDetails.PaymentInstructions (doc change): PaymentInstructions can return values longer than 500 characters, and it can be used without other shipping details (e.g., for eBay Motors vehicles).
0483
2006-10-18
  • TransactionArray.Transaction.Status.PaymentInProcess, TransactionArray.Transaction.Status.PaymentFailure (added): New payment status values have been added for future use.
0477
2006-09-06
  • ShippingTypes: CalculatedDomesticFlatInternational, FlatDomesticCalculatedInternational (added): Two more shipping types were introduced to enable a seller to use flat rate shipping for the domestic services and calculated shipping for the international shipping services, or vice versa. See the Managing Shipping documentation for details.
  • BuyerPaymentMethodCodeType.ELV (added): Now supports a new payment method, enabling Express Germany to introduce bank payments through Elektronisches Lastschriftverfahren (direct debit). With ELV, a purchase amount is automatically deducted from a buyer's bank account, after the buyer has provided his or her bank details and agreed to the deduction.
0475
2006-08-23
  • Item.SellingStatus.BidCount (modified): BidCount is now returned for items that allow competitive-bidding (Chinese and Dutch auctions).
0467
2006-06-28
  • TransactionArray.Transaction.Item.DigitalDeliveryDetails (added): Returns empty for digital listing transactions.
0459
2006-05-03
  • TransactionArray.Transaction.TransactionPlatform (added): The platform (eBay or Express) on which the transaction was created.
0427
2005-09-21
  • IncludeFinalValueFee (added): Retrieves the final value fee, if any.
  • Transaction.Item.SellingStatus.FinalValueFee (added): The final value fee of a Dutch auction that ended with bids (not purchases).
  • Transaction.Item.SellingStatus.ListingStatus (added): Specifies an active or ended listing's status in eBay's processing workflow. For items that have sold, this to determine whether eBay has finished processing total price, winning bidder/buyer, and Final Value Fee details.
  • Transaction.FinalValueFee (added): The final value fee of a listing (except Dutch auctions that end with bids but not purchases).
  • TransactionStatus.PaymentMethodUsed (modified): Before this release, if checkout was not yet complete, PaymentMethodUsed was set to None. Now, 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.
0415
2005-06-29
  • ShippingDetails.GetItFast (added): This tag has been added to support the new Get It Fast feature.
0411
2005-6-1
  • ShippingPackage (modified): A new value, ExtraLargePack, has been added.
  • Transaction.Status (added): A new value, BuyerSelectedShipping, has been added.
  • ShippingRegion (modified): New values Worldwide and WillNotShip have been added.
0403
2005-4-6
  • SellingManagerProductDetailsType (modified): ProductPartNumber is now returned as part of the SellingManagerProductDetailsType for part numbers that are strings.