eBay Trading APIVersion 1031

GetItemTransactions

Use this call to retrieve order line item (transaction) information for a specified listing. The call returns zero, one, or multiple order line items, depending on the number of items sold from the specified listing.

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

Usage Details

GetItemTransactions returns the item's order line items in a TransactionArray object. This container has zero, one, or multiple order line items associated with the respective ItemID, with each order line item contained in a Transaction object.

In addition to order line item data, the call returns an Item object that contains the item details needed to process the orders. Because all order line items returned by this call are for the same item, the Item object is returned at the root level. (Be aware that the Item object returned by this call does not contain all possible details about an item. If you need more detailed item information, use GetSellerList or GetItem.)

Note: If you are a seller, and want to view all of your own order line items from all item listings, use GetSellerTransactions.

See also Integrating PayPal With Your eBay Applications.

Some listings can return many order line items. In these cases, it can be desirable to control the amount of data returned from your 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 items to return per call (page). 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.

Filtering by Time

It can be useful to specify a time range so only the order line items whose status was modified within a certain time range are returned. 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.

When you use the NumberOfDays time filter, the eBay database is queried to determine when order line items were last modified. Note that the modification status is updated each time the TransactionArray.Transaction.Status.CheckoutStatus value of an order line item changes. The checkout status can change any time (i.e., in seconds, minutes, or days) after the order line item is created. See Processing Checkouts in the Features Guide for more information.

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

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

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

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. If you do not specify pagination fields, GetItemTransactions returns a maximum of 100 order line items per call.

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.

For example, if 100 order line items were generated for an item within the time that you specified, you could make one call for all 100 order line items, or ten calls with 10 order line items each (ten pages). Pagination is controlled by specifying the number of order line items to return in each page of data (i.e., for each call) and the page number to return.

The first call would return page 1 of the item's order line items.The HasMoreTransactions flag in the call response will indicate whether there are additional pages of order line items to retrieve. If there are additional pages to retrieve, you will see HasMoreTransactions=1. The application can use that information to determine whether additional calls are needed and, based on the page size (the number of order line items per page), how many additional calls need to be made for all of the order line items to be retrieved. If additional calls are needed, each subsequent call would specify an incrementally higher page number to retrieve each succeeding page of order line items. If the Pagination container with the EntriesPerPage and PageNumber fields are not specified on input, no pagination occurs and all order line items (up to 100 maximum) are returned on a single page.

Pertinent Response Data

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

Optimizing Your Calls

Always store the order line item data retrieved, and then only retrieve updates since the last date range specified.

Only use GetItemTransactions when you cannot use GetSellerTransactions. That is, if you are interested in only the order line items in which you are a party to, use GetSellerTransactions. GetSellerTransactions retrieves all the caller's order line items that have been created or modified within a particular date range, so it is more efficient than GetItemTransactions.

However, you must use GetItemTransactions when the application's user needs to retrieve order line items for an item that was listed by someone else (another seller). A user can only use GetSellerTransactions to retrieve their own order line item data.

Working with the Response

GetItemTransactions returns the order line items for the specified listing 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.

Testing GetItemTransactions

You can test GetItemTransactions in the Sandbox. However, an order line item must exist before you can call GetItemTransactions. If necessary, add a new item using AddItem, have another test user bid on the item in the Sandbox UI (or by use PlaceOffer), then complete the sale. You can use EndItem to end the listing early without canceling current bids.

Below are some test case scenarios to consider:

Related Information

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

See also the reference documentation for these calls:



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"?>
<GetItemTransactionsRequest xmlns="urn:ebay:apis:eBLBaseComponents">
  <!-- Call-specific Input Fields -->
  <IncludeContainingOrder> boolean </IncludeContainingOrder>
  <IncludeFinalValueFee> boolean </IncludeFinalValueFee>
  <IncludeVariations> boolean </IncludeVariations>
  <ItemID> ItemIDType (string) </ItemID>
  <ModTimeFrom> dateTime </ModTimeFrom>
  <ModTimeTo> dateTime </ModTimeTo>
  <NumberOfDays> int </NumberOfDays>
  <OrderLineItemID> string </OrderLineItemID>
  <Pagination> PaginationType
    <EntriesPerPage> int </EntriesPerPage>
    <PageNumber> int </PageNumber>
  </Pagination>
  <Platform> TransactionPlatformCodeType </Platform>
  <TransactionID> string </TransactionID>
  <!-- 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>
</GetItemTransactionsRequest>
Argument Type Occurrence Meaning
Call-specific Input Fields [Jump to standard fields]
IncludeContainingOrder boolean Optional Include this field and set it to True if you want the ContainingOrder container to be returned in the response under each Transaction node. For single line item orders, the ContainingOrder.OrderID value takes the value of the OrderLineItemID value for the order line item. For Combined Invoice orders, the ContainingOrder.OrderID value will be shared by at least two order line items (transactions) that are part of the same order.
Default: false.
IncludeFinalValueFee boolean Optional Indicates whether to include 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.
IncludeVariations boolean Optional If included in the request and set to True, all variations defined for the item are returned at the root level, including variations that have no sales. If not included in the request or set to false, the variations with sales are still returned in separate Transaction nodes. This information is intended to help sellers to reconcile their local inventory with eBay's records, while processing order line items (without requiring a separate call to GetItem).
Default: false.
ItemID ItemIDType (string) Required Unique identifier for an eBay item listing. A listing can have multiple order line items (transactions), but only one ItemID. When you use ItemID alone, eBay returns all order line items that are associated with the ItemID (listing). If you pair ItemID with a specific TransactionID, data on a specific order line item is returned. If OrderLineItemID is specified in the request, any ItemID/TransactionID pair specified in the same request will be ignored.

Note: GetItemTransactions doesn't support SKU as an input because this call requires an identifier that is unique across your active and ended listings. Even when InventoryTrackingMethod is set to SKU in a listing, the SKU is only unique across your active listings (not your ended listings). To retrieve order line items by SKU, use GetSellerTransactions or GetOrderTransactions instead.
Max length: 19 (Note: ItemIDs are usually 9 to 12 digits).
ModTimeFrom dateTime Optional The ModTimeFrom and ModTimeTo fields specify a date range for retrieving order line items associated with the specified ItemID. The ModTimeFrom field is the starting date range. All of the listing's order line items that were last modified within this date range are returned in the output. The maximum date range that may be specified is 30 days. This value cannot be set back more than 90 days in the past, as this call cannot retrieve sales older than 90 days old. The maximum date range that may be specified is 30 days. This field is not applicable if a specific TransactionID or OrderLineItemID is included in the request or if the NumberOfDays date filter is used.

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

If you don't specify a ModTimeFrom/ModTimeTo filter, the NumberOfDays time filter is used and it defaults to 30 (days).
NumberOfDays int Optional This time filter specifies the number of days (24-hour periods) in the past to search for order line items. All eBay order line items that were either created or modified within this period are returned in the response. If specified, NumberOfDays will override any date range specified with the ModTimeFrom/ModTimeTo time filters. This field is not applicable if a specific TransactionID or OrderLineItemID is included in the request.
Min: 1. Max: 30. Default: 30.
OrderLineItemID string Optional A unique identifier for an eBay order line item. This field is created as soon as there is a commitment to buy from the seller, and its value is based upon the concatenation of ItemID and TransactionID, with a hyphen in between these two IDs. If you want to retrieve data on a specific order line item, you can use an OrderLineItemID value in the request instead of the ItemID/TransactionID pair. If an OrderLineItemID is provided, any specified time filter is ignored.
Max length: 100.
Pagination PaginationType Optional Child elements control pagination of the output. Use the EntriesPerPage property to control the number of order line items to return per call and the PageNumber property to specify the specific page of data to return. If multiple pages of order line items are returned based on input criteria and Pagination properties, GetItemTransactions will need to be called multiple times (with the PageNumber value being increased by 1 each time) to scroll through all results.
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.
Platform TransactionPlatformCodeType Optional Note: This field's purpose is to allow the seller to retrieve only eBay listings or only Half.com listings instead of both order types. Since API support for Half.com listings is being deprecated, this field is no longer necessary to use since eBay orders will be the only orders that are retrieved. The default behavior of GetItemTransactions is to retrieve all order line items originating from eBay.com and Half.com. If the user wants to retrieve only eBay.com order line items or only Half.com order line items, this filter can be used to perform that function. Inserting eBay into this field will restrict retrieved order line items to those originating on eBay.com, and inserting Half into this field will restrict retrieved order line items to those originating on Half.com.

Applicable values:

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

(Not all values in TransactionPlatformCodeType apply to this field.)
TransactionID string Optional Include a TransactionID field in the request if you want to retrieve the data for a specific order line item (transaction). If a TransactionID is provided, any specified time filter is ignored.
Max length: 19 (Note: TransactionIDs are usually 9 to 12 digits.).
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. Specify the standard RFC 3066 language identification tag (e.g., en_US).

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

See Tags for the Identification of Languages.

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

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

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

...

See Selecting Fields to Retrieve.

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

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

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

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

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

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

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

Applicable values:

High
(in) 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"?>
<GetItemTransactionsResponse xmlns="urn:ebay:apis:eBLBaseComponents">
  <!-- Call-specific Output Fields -->
  <HasMoreTransactions> boolean </HasMoreTransactions>
  <Item> ItemType
    <ApplicationData> string </ApplicationData>
    <AutoPay> boolean </AutoPay>
    <BuyerProtection> BuyerProtectionCodeType </BuyerProtection>
    <BuyItNowPrice currencyID="CurrencyCodeType"> AmountType (double) </BuyItNowPrice>
    <Charity> CharityType
      <CharityListing> boolean </CharityListing>
    </Charity>
    <Currency> CurrencyCodeType </Currency>
    <IntegratedMerchantCreditCardEnabled> boolean </IntegratedMerchantCreditCardEnabled>
    <InventoryTrackingMethod> InventoryTrackingMethodCodeType </InventoryTrackingMethod>
    <ItemID> ItemIDType (string) </ItemID>
    <ListingDetails> ListingDetailsType
      <Adult> boolean </Adult>
      <BindingAuction> boolean </BindingAuction>
      <CheckoutEnabled> boolean </CheckoutEnabled>
      <ConvertedBuyItNowPrice currencyID="CurrencyCodeType"> AmountType (double) </ConvertedBuyItNowPrice>
      <ConvertedReservePrice currencyID="CurrencyCodeType"> AmountType (double) </ConvertedReservePrice>
      <ConvertedStartPrice currencyID="CurrencyCodeType"> AmountType (double) </ConvertedStartPrice>
      <EndTime> dateTime </EndTime>
      <HasPublicMessages> boolean </HasPublicMessages>
      <HasReservePrice> boolean </HasReservePrice>
      <HasUnansweredQuestions> boolean </HasUnansweredQuestions>
      <MinimumBestOfferPrice currencyID="CurrencyCodeType"> AmountType (double) </MinimumBestOfferPrice>
      <RelistedItemID> ItemIDType (string) </RelistedItemID>
      <StartTime> dateTime </StartTime>
      <TCROriginalItemID> ItemIDType (string) </TCROriginalItemID>
      <ViewItemURL> anyURI </ViewItemURL>
      <ViewItemURLForNaturalSearch> anyURI </ViewItemURLForNaturalSearch>
    </ListingDetails>
    <ListingType> ListingTypeCodeType </ListingType>
    <LotSize> int </LotSize>
    <PaymentMethods> BuyerPaymentMethodCodeType </PaymentMethods>
    <!-- ... more PaymentMethods values allowed here ... -->
    <PrivateListing> boolean </PrivateListing>
    <Quantity> int </Quantity>
    <Seller> UserType
      <AboutMePage> boolean </AboutMePage>
      <eBayGoodStanding> boolean </eBayGoodStanding>
      <EIASToken> string </EIASToken>
      <Email> string </Email>
      <FeedbackPrivate> boolean </FeedbackPrivate>
      <FeedbackRatingStar> FeedbackRatingStarCodeType </FeedbackRatingStar>
      <FeedbackScore> int </FeedbackScore>
      <IDVerified> boolean </IDVerified>
      <NewUser> boolean </NewUser>
      <PositiveFeedbackPercent> float </PositiveFeedbackPercent>
      <RegistrationDate> dateTime </RegistrationDate>
      <SellerInfo> SellerType
        <AllowPaymentEdit> boolean </AllowPaymentEdit>
        <CheckoutEnabled> boolean </CheckoutEnabled>
        <CIPBankAccountStored> boolean </CIPBankAccountStored>
        <GoodStanding> boolean </GoodStanding>
        <QualifiesForB2BVAT> boolean </QualifiesForB2BVAT>
        <SafePaymentExempt> boolean </SafePaymentExempt>
        <SellerLevel> SellerLevelCodeType </SellerLevel>
        <StoreOwner> boolean </StoreOwner>
        <StoreURL> anyURI </StoreURL>
        <TopRatedSeller> boolean </TopRatedSeller>
      </SellerInfo>
      <Site> SiteCodeType </Site>
      <Status> UserStatusCodeType </Status>
      <UserFirstName> string </UserFirstName>
      <UserID> UserIDType (string) </UserID>
      <UserIDChanged> boolean </UserIDChanged>
      <UserIDLastChanged> dateTime </UserIDLastChanged>
      <UserLastName> string </UserLastName>
      <VATStatus> VATStatusCodeType </VATStatus>
    </Seller>
    <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>
    <Variations> VariationsType
      <Variation> VariationType
        <Quantity> int </Quantity>
        <SellingStatus> SellingStatusType
          <QuantitySold> int </QuantitySold>
        </SellingStatus>
        <SKU> SKUType (string) </SKU>
        <StartPrice currencyID="CurrencyCodeType"> AmountType (double) </StartPrice>
        <VariationSpecifics> NameValueListArrayType
          <NameValueList> NameValueListType
            <Name> string </Name>
            <Value> string </Value>
            <!-- ... more Value values allowed here ... -->
          </NameValueList>
          <!-- ... more NameValueList nodes allowed here ... -->
        </VariationSpecifics>
        <!-- ... more VariationSpecifics nodes allowed here ... -->
      </Variation>
      <!-- ... more Variation nodes allowed here ... -->
    </Variations>
  </Item>
  <PageNumber> int </PageNumber>
  <PaginationResult> PaginationResultType
    <TotalNumberOfEntries> int </TotalNumberOfEntries>
    <TotalNumberOfPages> int </TotalNumberOfPages>
  </PaginationResult>
  <PayPalPreferred> boolean </PayPalPreferred>
  <ReturnedTransactionCountActual> int </ReturnedTransactionCountActual>
  <TransactionArray> TransactionArrayType
    <Transaction> TransactionType
      <ActualHandlingCost currencyID="CurrencyCodeType"> AmountType (double) </ActualHandlingCost>
      <ActualShippingCost currencyID="CurrencyCodeType"> AmountType (double) </ActualShippingCost>
      <AdjustmentAmount currencyID="CurrencyCodeType"> AmountType (double) </AdjustmentAmount>
      <AmountPaid currencyID="CurrencyCodeType"> AmountType (double) </AmountPaid>
      <BestOfferSale> boolean </BestOfferSale>
      <Buyer> UserType
        <AboutMePage> boolean </AboutMePage>
        <BuyerInfo> BuyerType
          <BuyerTaxIdentifier> TaxIdentifierType
            <Attribute name="TaxIdentifierAttributeCodeType"> TaxIdentifierAttributeType (string) </Attribute>
            <!-- ... more Attribute values allowed here ... -->
            <ID> string </ID>
            <Type> ValueTypeCodeType </Type>
          </BuyerTaxIdentifier>
          <!-- ... more BuyerTaxIdentifier nodes allowed here ... -->
          <ShippingAddress> AddressType
            <AddressAttribute type="AddressAttributeCodeType"> AddressAttributeType (string) </AddressAttribute>
            <!-- ... more AddressAttribute values allowed here ... -->
            <AddressID> string </AddressID>
            <AddressUsage> AddressUsageCodeType </AddressUsage>
            <CityName> string </CityName>
            <Country> CountryCodeType </Country>
            <CountryName> string </CountryName>
            <ExternalAddressID> string </ExternalAddressID>
            <Name> string </Name>
            <Phone> string </Phone>
            <PostalCode> string </PostalCode>
            <StateOrProvince> string </StateOrProvince>
            <Street> string </Street>
            <Street1> string </Street1>
            <Street2> string </Street2>
          </ShippingAddress>
        </BuyerInfo>
        <eBayGoodStanding> boolean </eBayGoodStanding>
        <EIASToken> string </EIASToken>
        <Email> string </Email>
        <FeedbackPrivate> boolean </FeedbackPrivate>
        <FeedbackRatingStar> FeedbackRatingStarCodeType </FeedbackRatingStar>
        <FeedbackScore> int </FeedbackScore>
        <IDVerified> boolean </IDVerified>
        <NewUser> boolean </NewUser>
        <PositiveFeedbackPercent> float </PositiveFeedbackPercent>
        <RegistrationDate> dateTime </RegistrationDate>
        <Site> SiteCodeType </Site>
        <StaticAlias> string </StaticAlias>
        <Status> UserStatusCodeType </Status>
        <UserFirstName> string </UserFirstName>
        <UserID> UserIDType (string) </UserID>
        <UserIDChanged> boolean </UserIDChanged>
        <UserIDLastChanged> dateTime </UserIDLastChanged>
        <UserLastName> string </UserLastName>
        <VATStatus> VATStatusCodeType </VATStatus>
      </Buyer>
      <BuyerCheckoutMessage> string </BuyerCheckoutMessage>
      <BuyerGuaranteePrice currencyID="CurrencyCodeType"> AmountType (double) </BuyerGuaranteePrice>
      <BuyerPackageEnclosures> BuyerPackageEnclosuresType
        <BuyerPackageEnclosure type="PaymentInstructionCodeType"> BuyerPackageEnclosureType (string) </BuyerPackageEnclosure>
        <!-- ... more BuyerPackageEnclosure values allowed here ... -->
      </BuyerPackageEnclosures>
      <CartID> string </CartID>
      <ContainingOrder> OrderType
        <BuyerPackageEnclosures> BuyerPackageEnclosuresType
          <BuyerPackageEnclosure type="PaymentInstructionCodeType"> BuyerPackageEnclosureType (string) </BuyerPackageEnclosure>
          <!-- ... more BuyerPackageEnclosure values allowed here ... -->
        </BuyerPackageEnclosures>
        <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 ... -->
        <CancelDetail> CancelDetailType
          <CancelCompleteDate> dateTime </CancelCompleteDate>
          <CancelIntiationDate> dateTime </CancelIntiationDate>
          <CancelIntiator> token </CancelIntiator>
          <CancelReason> token </CancelReason>
          <CancelReasonDetails> string </CancelReasonDetails>
        </CancelDetail>
        <!-- ... more CancelDetail nodes allowed here ... -->
        <CancelReason> token </CancelReason>
        <CancelReasonDetails> string </CancelReasonDetails>
        <CancelStatus> CancelStatusCodeType </CancelStatus>
        <ContainseBayPlusTransaction> boolean </ContainseBayPlusTransaction>
        <CreatingUserRole> TradingRoleCodeType </CreatingUserRole>
        <ExtendedOrderID> string </ExtendedOrderID>
        <IntegratedMerchantCreditCardEnabled> boolean </IntegratedMerchantCreditCardEnabled>
        <IsMultiLegShipping> boolean </IsMultiLegShipping>
        <LogisticsPlanType> token </LogisticsPlanType>
        <MonetaryDetails> PaymentsInformationType
          <Payments> PaymentInformationType
            <Payment> PaymentTransactionType
              <FeeOrCreditAmount currencyID="CurrencyCodeType"> AmountType (double) </FeeOrCreditAmount>
              <Payee type="UserIdentityCodeType"> UserIdentityType (string) </Payee>
              <Payer type="UserIdentityCodeType"> UserIdentityType (string) </Payer>
              <PaymentAmount currencyID="CurrencyCodeType"> AmountType (double) </PaymentAmount>
              <PaymentReferenceID type="TransactionReferenceCodeType"> TransactionReferenceType (string) </PaymentReferenceID>
              <!-- ... more PaymentReferenceID values allowed here ... -->
              <PaymentStatus> PaymentTransactionStatusCodeType </PaymentStatus>
              <PaymentTime> dateTime </PaymentTime>
              <ReferenceID type="TransactionReferenceCodeType"> TransactionReferenceType (string) </ReferenceID>
            </Payment>
            <!-- ... more Payment nodes allowed here ... -->
          </Payments>
          <Refunds> RefundInformationType
            <Refund> RefundTransactionInfoType
              <FeeOrCreditAmount currencyID="CurrencyCodeType"> AmountType (double) </FeeOrCreditAmount>
              <ReferenceID type="TransactionReferenceCodeType"> TransactionReferenceType (string) </ReferenceID>
              <RefundAmount currencyID="CurrencyCodeType"> AmountType (double) </RefundAmount>
              <RefundStatus> PaymentTransactionStatusCodeType </RefundStatus>
              <RefundTime> dateTime </RefundTime>
              <RefundTo type="UserIdentityCodeType"> UserIdentityType (string) </RefundTo>
              <RefundType> RefundSourceTypeCodeType </RefundType>
            </Refund>
            <!-- ... more Refund nodes allowed here ... -->
          </Refunds>
        </MonetaryDetails>
        <MultiLegShippingDetails> MultiLegShippingDetailsType
          <SellerShipmentToLogisticsProvider> MultiLegShipmentType
            <ShippingServiceDetails> MultiLegShippingServiceType
              <ShippingService> token </ShippingService>
              <TotalShippingCost currencyID="CurrencyCodeType"> AmountType (double) </TotalShippingCost>
            </ShippingServiceDetails>
            <ShippingTimeMax> int </ShippingTimeMax>
            <ShippingTimeMin> int </ShippingTimeMin>
            <ShipToAddress> AddressType
              <AddressAttribute type="AddressAttributeCodeType"> AddressAttributeType (string) </AddressAttribute>
              <!-- ... more AddressAttribute values allowed here ... -->
              <AddressID> string </AddressID>
              <AddressOwner> AddressOwnerCodeType </AddressOwner>
              <AddressUsage> AddressUsageCodeType </AddressUsage>
              <CityName> string </CityName>
              <Country> CountryCodeType </Country>
              <CountryName> string </CountryName>
              <ExternalAddressID> string </ExternalAddressID>
              <Name> string </Name>
              <Phone> string </Phone>
              <PostalCode> string </PostalCode>
              <ReferenceID> string </ReferenceID>
              <StateOrProvince> string </StateOrProvince>
              <Street1> string </Street1>
              <Street2> string </Street2>
            </ShipToAddress>
          </SellerShipmentToLogisticsProvider>
        </MultiLegShippingDetails>
        <OrderID> OrderIDType (string) </OrderID>
        <OrderStatus> OrderStatusCodeType </OrderStatus>
        <PaymentHoldDetails> PaymentHoldDetailType
          <ExpectedReleaseDate> dateTime </ExpectedReleaseDate>
          <NumOfReqSellerActions> int </NumOfReqSellerActions>
          <PaymentHoldReason> PaymentHoldReasonCodeType </PaymentHoldReason>
          <RequiredSellerActionArray> RequiredSellerActionArrayType
            <RequiredSellerAction> RequiredSellerActionCodeType </RequiredSellerAction>
            <!-- ... more RequiredSellerAction values allowed here ... -->
          </RequiredSellerActionArray>
        </PaymentHoldDetails>
        <PaymentHoldStatus> PaymentHoldStatusCodeType </PaymentHoldStatus>
        <ShippingConvenienceCharge currencyID="CurrencyCodeType"> AmountType (double) </ShippingConvenienceCharge>
      </ContainingOrder>
      <ConvertedAdjustmentAmount currencyID="CurrencyCodeType"> AmountType (double) </ConvertedAdjustmentAmount>
      <ConvertedAmountPaid currencyID="CurrencyCodeType"> AmountType (double) </ConvertedAmountPaid>
      <ConvertedTransactionPrice currencyID="CurrencyCodeType"> AmountType (double) </ConvertedTransactionPrice>
      <CreatedDate> dateTime </CreatedDate>
      <DepositType> DepositTypeCodeType </DepositType>
      <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>
      <eBayPlusTransaction> boolean </eBayPlusTransaction>
      <ExtendedOrderID> string </ExtendedOrderID>
      <ExternalTransaction> ExternalTransactionType
        <ExternalTransactionID> string </ExternalTransactionID>
        <ExternalTransactionStatus> PaymentTransactionStatusCodeType </ExternalTransactionStatus>
        <ExternalTransactionTime> dateTime </ExternalTransactionTime>
        <FeeOrCreditAmount currencyID="CurrencyCodeType"> AmountType (double) </FeeOrCreditAmount>
        <PaymentOrRefundAmount currencyID="CurrencyCodeType"> AmountType (double) </PaymentOrRefundAmount>
      </ExternalTransaction>
      <!-- ... more ExternalTransaction nodes allowed here ... -->
      <FinalValueFee currencyID="CurrencyCodeType"> AmountType (double) </FinalValueFee>
      <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>
      <ListingCheckoutRedirectPreference> ListingCheckoutRedirectPreferenceType </ListingCheckoutRedirectPreference>
      <LogisticsPlanType> token </LogisticsPlanType>
      <MonetaryDetails> PaymentsInformationType
        <Payments> PaymentInformationType
          <Payment> PaymentTransactionType
            <FeeOrCreditAmount currencyID="CurrencyCodeType"> AmountType (double) </FeeOrCreditAmount>
            <Payee type="UserIdentityCodeType"> UserIdentityType (string) </Payee>
            <Payer type="UserIdentityCodeType"> UserIdentityType (string) </Payer>
            <PaymentAmount currencyID="CurrencyCodeType"> AmountType (double) </PaymentAmount>
            <PaymentReferenceID type="TransactionReferenceCodeType"> TransactionReferenceType (string) </PaymentReferenceID>
            <!-- ... more PaymentReferenceID values allowed here ... -->
            <PaymentStatus> PaymentTransactionStatusCodeType </PaymentStatus>
            <PaymentTime> dateTime </PaymentTime>
            <ReferenceID type="TransactionReferenceCodeType"> TransactionReferenceType (string) </ReferenceID>
          </Payment>
          <!-- ... more Payment nodes allowed here ... -->
        </Payments>
        <Refunds> RefundInformationType
          <Refund> RefundTransactionInfoType
            <FeeOrCreditAmount currencyID="CurrencyCodeType"> AmountType (double) </FeeOrCreditAmount>
            <ReferenceID type="TransactionReferenceCodeType"> TransactionReferenceType (string) </ReferenceID>
            <RefundAmount currencyID="CurrencyCodeType"> AmountType (double) </RefundAmount>
            <RefundStatus> PaymentTransactionStatusCodeType </RefundStatus>
            <RefundTime> dateTime </RefundTime>
            <RefundTo type="UserIdentityCodeType"> UserIdentityType (string) </RefundTo>
            <RefundType> RefundSourceTypeCodeType </RefundType>
          </Refund>
          <!-- ... more Refund nodes allowed here ... -->
        </Refunds>
      </MonetaryDetails>
      <MultiLegShippingDetails> MultiLegShippingDetailsType
        <SellerShipmentToLogisticsProvider> MultiLegShipmentType
          <ShippingServiceDetails> MultiLegShippingServiceType
            <ShippingService> token </ShippingService>
            <TotalShippingCost currencyID="CurrencyCodeType"> AmountType (double) </TotalShippingCost>
          </ShippingServiceDetails>
          <ShippingTimeMax> int </ShippingTimeMax>
          <ShippingTimeMin> int </ShippingTimeMin>
          <ShipToAddress> AddressType
            <AddressAttribute type="AddressAttributeCodeType"> AddressAttributeType (string) </AddressAttribute>
            <!-- ... more AddressAttribute values allowed here ... -->
            <AddressID> string </AddressID>
            <AddressOwner> AddressOwnerCodeType </AddressOwner>
            <AddressUsage> AddressUsageCodeType </AddressUsage>
            <CityName> string </CityName>
            <Country> CountryCodeType </Country>
            <CountryName> string </CountryName>
            <ExternalAddressID> string </ExternalAddressID>
            <Name> string </Name>
            <Phone> string </Phone>
            <PostalCode> string </PostalCode>
            <ReferenceID> string </ReferenceID>
            <StateOrProvince> string </StateOrProvince>
            <Street1> string </Street1>
            <Street2> string </Street2>
          </ShipToAddress>
        </SellerShipmentToLogisticsProvider>
      </MultiLegShippingDetails>
      <OrderLineItemID> string </OrderLineItemID>
      <PaidTime> dateTime </PaidTime>
      <PaymentHoldDetails> PaymentHoldDetailType
        <ExpectedReleaseDate> dateTime </ExpectedReleaseDate>
        <NumOfReqSellerActions> int </NumOfReqSellerActions>
        <PaymentHoldReason> PaymentHoldReasonCodeType </PaymentHoldReason>
        <RequiredSellerActionArray> RequiredSellerActionArrayType
          <RequiredSellerAction> RequiredSellerActionCodeType </RequiredSellerAction>
          <!-- ... more RequiredSellerAction values allowed here ... -->
        </RequiredSellerActionArray>
      </PaymentHoldDetails>
      <PayPalEmailAddress> string </PayPalEmailAddress>
      <PickupDetails> PickupDetailsType
        <PickupOptions> PickupOptionsType
          <PickupMethod> token </PickupMethod>
          <PickupPriority> int </PickupPriority>
        </PickupOptions>
        <!-- ... more PickupOptions nodes allowed here ... -->
      </PickupDetails>
      <PickupMethodSelected> PickupMethodSelectedType
        <MerchantPickupCode> string </MerchantPickupCode>
        <PickupFulfillmentTime> dateTime </PickupFulfillmentTime>
        <PickupLocationUUID> string </PickupLocationUUID>
        <PickupMethod> token </PickupMethod>
        <PickupStatus> PickupStatusCodeType </PickupStatus>
        <PickupStoreID> string </PickupStoreID>
      </PickupMethodSelected>
      <Platform> TransactionPlatformCodeType </Platform>
      <QuantityPurchased> int </QuantityPurchased>
      <SellerContactBuyerByEmail> boolean </SellerContactBuyerByEmail>
      <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>
      <SellingManagerProductDetails> SellingManagerProductDetailsType
        <ProductName> string </ProductName>
      </SellingManagerProductDetails>
      <ShippedTime> dateTime </ShippedTime>
      <ShippingConvenienceCharge currencyID="CurrencyCodeType"> AmountType (double) </ShippingConvenienceCharge>
      <ShippingDetails> ShippingDetailsType
        <CalculatedShippingRate> CalculatedShippingRateType
          <InternationalPackagingHandlingCosts currencyID="CurrencyCodeType"> AmountType (double) </InternationalPackagingHandlingCosts>
          <OriginatingPostalCode> string </OriginatingPostalCode>
          <PackagingHandlingCosts currencyID="CurrencyCodeType"> AmountType (double) </PackagingHandlingCosts>
          <ShippingIrregular> boolean </ShippingIrregular>
        </CalculatedShippingRate>
        <ChangePaymentInstructions> boolean </ChangePaymentInstructions>
        <CODCost currencyID="CurrencyCodeType"> AmountType (double) </CODCost>
        <ExcludeShipToLocation> string </ExcludeShipToLocation>
        <!-- ... more ExcludeShipToLocation values allowed here ... -->
        <InsuranceWanted> boolean </InsuranceWanted>
        <InternationalShippingServiceOption> InternationalShippingServiceOptionsType
          <ImportCharge> AmountType (double) </ImportCharge>
          <ShippingInsuranceCost> AmountType (double) </ShippingInsuranceCost>
          <ShippingService> token </ShippingService>
          <ShippingServiceAdditionalCost> AmountType (double) </ShippingServiceAdditionalCost>
          <ShippingServiceCost> AmountType (double) </ShippingServiceCost>
          <ShippingServicePriority> int </ShippingServicePriority>
          <ShipToLocation> string </ShipToLocation>
          <!-- ... more ShipToLocation values allowed here ... -->
        </InternationalShippingServiceOption>
        <!-- ... more InternationalShippingServiceOption nodes allowed here ... -->
        <PaymentEdited> boolean </PaymentEdited>
        <PaymentInstructions> string </PaymentInstructions>
        <SalesTax> SalesTaxType
          <SalesTaxAmount currencyID="CurrencyCodeType"> AmountType (double) </SalesTaxAmount>
          <SalesTaxPercent> float </SalesTaxPercent>
          <SalesTaxState> string </SalesTaxState>
          <ShippingIncludedInTax> boolean </ShippingIncludedInTax>
        </SalesTax>
        <SellingManagerSalesRecordNumber> int </SellingManagerSalesRecordNumber>
        <ShipmentTrackingDetails> ShipmentTrackingDetailsType
          <ShipmentTrackingNumber> string </ShipmentTrackingNumber>
          <ShippingCarrierUsed> string </ShippingCarrierUsed>
        </ShipmentTrackingDetails>
        <!-- ... more ShipmentTrackingDetails nodes allowed here ... -->
        <ShippingRateErrorMessage> string </ShippingRateErrorMessage>
        <ShippingRateType> ShippingRateTypeCodeType </ShippingRateType>
        <ShippingServiceOptions> ShippingServiceOptionsType
          <ExpeditedService> boolean </ExpeditedService>
          <ImportCharge> AmountType (double) </ImportCharge>
          <LogisticPlanType> string </LogisticPlanType>
          <ShippingInsuranceCost> AmountType (double) </ShippingInsuranceCost>
          <ShippingPackageInfo> ShippingPackageInfoType
            <ActualDeliveryTime> dateTime </ActualDeliveryTime>
            <ScheduledDeliveryTimeMax> dateTime </ScheduledDeliveryTimeMax>
            <ScheduledDeliveryTimeMin> dateTime </ScheduledDeliveryTimeMin>
            <ShippingTrackingEvent> token </ShippingTrackingEvent>
            <StoreID> string </StoreID>
          </ShippingPackageInfo>
          <!-- ... more ShippingPackageInfo nodes allowed here ... -->
          <ShippingService> token </ShippingService>
          <ShippingServiceAdditionalCost> AmountType (double) </ShippingServiceAdditionalCost>
          <ShippingServiceCost> AmountType (double) </ShippingServiceCost>
          <ShippingServicePriority> int </ShippingServicePriority>
          <ShippingSurcharge> AmountType (double) </ShippingSurcharge>
          <ShippingTimeMax> int </ShippingTimeMax>
          <ShippingTimeMin> int </ShippingTimeMin>
        </ShippingServiceOptions>
        <!-- ... more ShippingServiceOptions nodes allowed here ... -->
        <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> AmountType (double) </ImportCharge>
        <LogisticPlanType> string </LogisticPlanType>
        <ShippingInsuranceCost> AmountType (double) </ShippingInsuranceCost>
        <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> AmountType (double) </ShippingServiceAdditionalCost>
        <ShippingServiceCost> AmountType (double) </ShippingServiceCost>
        <ShippingServicePriority> int </ShippingServicePriority>
        <ShippingSurcharge> AmountType (double) </ShippingSurcharge>
        <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>
        <IntegratedMerchantCreditCardEnabled> boolean </IntegratedMerchantCreditCardEnabled>
        <LastTimeModified> dateTime </LastTimeModified>
        <PaymentHoldStatus> PaymentHoldStatusCodeType </PaymentHoldStatus>
        <PaymentInstrument> BuyerPaymentInstrumentCodeType </PaymentInstrument>
        <PaymentMethodUsed> BuyerPaymentMethodCodeType </PaymentMethodUsed>
        <ReturnStatus> ReturnStatusCodeType </ReturnStatus>
      </Status>
      <Taxes> TaxesType
        <TaxDetails> TaxDetailsType
          <Imposition> TaxTypeCodeType </Imposition>
          <TaxAmount currencyID="CurrencyCodeType"> AmountType (double) </TaxAmount>
          <TaxCode> string </TaxCode>
          <TaxDescription> TaxDescriptionCodeType </TaxDescription>
          <TaxOnHandlingAmount currencyID="CurrencyCodeType"> AmountType (double) </TaxOnHandlingAmount>
          <TaxOnShippingAmount currencyID="CurrencyCodeType"> AmountType (double) </TaxOnShippingAmount>
          <TaxOnSubtotalAmount currencyID="CurrencyCodeType"> AmountType (double) </TaxOnSubtotalAmount>
        </TaxDetails>
        <!-- ... more TaxDetails nodes allowed here ... -->
        <TotalTaxAmount currencyID="CurrencyCodeType"> AmountType (double) </TotalTaxAmount>
      </Taxes>
      <TransactionID> string </TransactionID>
      <TransactionPrice currencyID="CurrencyCodeType"> AmountType (double) </TransactionPrice>
      <TransactionSiteID> SiteCodeType </TransactionSiteID>
      <UnpaidItem> UnpaidItemType
        <Status> UnpaidItemCaseStatusTypeCodeType </Status>
        <Type> UnpaidItemCaseOpenTypeCodeType </Type>
      </UnpaidItem>
      <Variation> VariationType
        <SKU> SKUType (string) </SKU>
        <VariationSpecifics> NameValueListArrayType
          <NameValueList> NameValueListType
            <Name> string </Name>
            <Value> string </Value>
            <!-- ... more Value values allowed here ... -->
          </NameValueList>
          <!-- ... more NameValueList nodes allowed here ... -->
        </VariationSpecifics>
        <!-- ... more VariationSpecifics nodes allowed here ... -->
        <VariationTitle> string </VariationTitle>
        <VariationViewItemURL> anyURI </VariationViewItemURL>
      </Variation>
    </Transaction>
    <!-- ... more Transaction nodes allowed here ... -->
  </TransactionArray>
  <TransactionsPerPage> int </TransactionsPerPage>
  <!-- Standard Output Fields -->
  <Ack> AckCodeType </Ack>
  <Build> string </Build>
  <CorrelationID> string </CorrelationID>
  <Errors> ErrorType
    <ErrorClassification> ErrorClassificationCodeType </ErrorClassification>
    <ErrorCode> token </ErrorCode>
    <ErrorParameters ParamID="string"> ErrorParameterType
      <Value> string </Value>
    </ErrorParameters>
    <!-- ... more ErrorParameters nodes allowed here ... -->
    <LongMessage> string </LongMessage>
    <SeverityCode> SeverityCodeType </SeverityCode>
    <ShortMessage> string </ShortMessage>
  </Errors>
  <!-- ... more Errors nodes allowed here ... -->
  <HardExpirationWarning> string </HardExpirationWarning>
  <Timestamp> dateTime </Timestamp>
  <Version> string </Version>
</GetItemTransactionsResponse>
Return Value Type Occurrence Meaning
Call-specific Output Fields [Jump to standard fields]
HasMoreTransactions boolean Always Indicates whether there are additional order line items (transactions) to retrieve. That is, indicates whether more pages of data are available to be returned, given the filters that were specified in the request. Returns false for the last page of data.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
Item ItemType Always Item object that spawned the order line item. It is a purchase from this item's listing that the order line item represents.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
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.
Item.AutoPay boolean Always If true, the seller requests immediate payment for the item. If false or not specified, immediate payment is not requested. (In responses, does not indicate whether the item is actually still a candidate for purchase via immediate payment.)

Only applicable to items listed on PayPal-enabled sites in categories that support immediate payment (see AutoPayEnabled in GetCategories), when seller has a Premier or Business PayPal account (see PayPalAccountType in GetUser).

To create an Immediate Payment listing, AutoPay must be true, PayPalEmailAddress must be a valid PayPal email address for the seller, and the only included PaymentMethods value must be PayPal.

For a non-Immediate Payment listing, the AutoPay flag is not required.


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

See:
    Requiring Immediate Payment
    Listing US and CA eBay Motors Items

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

Applicable values: See BuyerProtection.
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 Miscellaneous Item Field Differences.

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.
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.
Item.Charity CharityType Conditionally This container identifies the nonprofit organization that will benefit with a percentage of the proceeds from the 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 for a charity registered with the PayPal Giving Fund. The donation percentage can be set in 5 percent increments from 10 percent to 100 percent. If a benefitting charity is specified, the seller must also accept PayPal as a payment method for the item (see Item.PaymentMethods).

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.

This container will only be returned in Get calls for listings that will benefit a nonprofit organization if the item sells.

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

See:
    Miscellaneous Item Field Differences
    Identifying Listings that Benefit Nonprofits

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

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

See Field Differences for eBay Sites.

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

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

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.
Max length: 19 (Note: the eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits).

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

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

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

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

DetailLevel: ReturnAll.

See Checkout.

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

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

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

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

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

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

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

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

For a list of possible enumeration values, see CurrencyCodeType.
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.
Item.ListingDetails
  .HasPublicMessages
boolean Conditionally Indicates whether the item has any publicly displayed messages. Use GetMemberMessages to retrieve public messages for the item if this flag indicates that there are any.

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

DetailLevel: ReturnAll.
Item.ListingDetails
  .HasUnansweredQuestions
boolean Conditionally Indicates whether the item has any unanswered questions. Use GetMemberMessages to retrieve unanswered questions for the item if this flag indicates that there are any.

DetailLevel: ReturnAll.
Item.ListingDetails
  .MinimumBestOfferPrice
AmountType (double) Conditionally Specifies the minimum acceptable Best Offer price. If a buyer submits a Best Offer that is below this value, the offer is automatically declined by the seller. This applies only to items listed in categories that support the Best Offer Auto-Decline feature.

Best Offer must be enabled for the item, and only the seller who listed the item can see this value. For a ReviseItem or ReviseFixedPriceItem call on US eBay Motors site, prior use of a minimum Best Offer price on eBay.com is ignored.

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

If the price for a fixed-price item (set in the StartPrice field) is changed with a Revise call, the MinimumBestOfferPrice and BestOfferAutoAcceptPrice values will be dropped (if they were set for the listing before the Revise call). 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: Historically, the Best Offer feature has not been available for auction listings, but beginning with Version 1027, scheduled to roll out the first week in August 2017, sellers in the US, UK, and DE sites will be able to offer the Best Offer feature in auction listings. Once this new capability rolls out, the seller can offer Buy It Now or Best Offer in an auction listing, but not both.

DetailLevel: ReturnAll.
Item.ListingDetails
  .MinimumBestOfferPrice
  [ attribute currencyID ]
CurrencyCodeType Always Specifies the minimum acceptable Best Offer price. If a buyer submits a Best Offer that is below this value, the offer is automatically declined by the seller. This applies only to items listed in categories that support the Best Offer Auto-Decline feature.

Best Offer must be enabled for the item, and only the seller who listed the item can see this value. For a ReviseItem or ReviseFixedPriceItem call on US eBay Motors site, prior use of a minimum Best Offer price on eBay.com is ignored.

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

If the price for a fixed-price item (set in the StartPrice field) is changed with a Revise call, the MinimumBestOfferPrice and BestOfferAutoAcceptPrice values will be dropped (if they were set for the listing before the Revise call). 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: Historically, the Best Offer feature has not been available for auction listings, but beginning with Version 1027, scheduled to roll out the first week in August 2017, sellers in the US, UK, and DE sites will be able to offer the Best Offer feature in auction listings. Once this new capability rolls out, the seller can offer Buy It Now or Best Offer in an auction listing, but not both.

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

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

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

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

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

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

DetailLevel: ReturnAll.
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, AddSellingManagerTemplate, 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:
    Different Ways of Selling
    Basic Building Blocks
    GetCategoryFeatures
    Fees per Site

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

DetailLevel: ReturnAll.
Item.PaymentMethods BuyerPaymentMethodCodeType Always,
repeatable: [1..*]
Identifies the payment method (such as PayPal) that the seller will accept when the buyer pays for the item. For Add/Revise/Relist calls, at least one payment method must be specified.

Use GetCategoryFeatures to determine the payment methods that are allowed for a category on a site. For example, the response data of GetCategoryFeatures will show that on the US site, most categories only allow electronic payments. Also use GetCategoryFeatures to determine the default payment methods for a site.

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

If you specify multiple PaymentMethods fields, the repeating fields must be contiguous. For example, you can specify PayPalEmailAddress after a list of repeating PaymentMethods fields, but not between them:

<PaymentMethods>VisaMC</PaymentMethods>
<PaymentMethods>PayPal</PaymentMethods>
<PayPalEmailAddress>mypaypalemail@ebay.com</PayPalEmailAddress>


In general, if you separate repeating instances of a field, the results will be unpredictable. This rule applies to all repeating fields (maxOccurs="unbounded" or greater than 1) in the schema. See Overview of the API Schema in the eBay Features Guide.

Note: Required or allowed payment methods vary by site and category. Refer to Determining the Payment Methods Allowed for a Category in the eBay Features Guide to help you determine which payment methods you are required or allowed to specify.
Payment methods are not applicable to any classified ad listings, as any agreement and payment is handled off of the eBay platform.

For ReviseItem and RelistItem only: A listing must have at least one valid payment method. When you revise or relist an item and you specify a payment method that is invalid for the target site, eBay ignores the invalid payment method, applies the other valid changes, and returns a warning to indicate that the invalid payment method was ignored.

If multiple payment methods were invalid, the warning indicates that they were all ignored. If you modify the listing so that it includes no valid payment methods, an error is returned. This situation could occur when the seller removes all valid payment methods or when all the payment methods specified for the item are no longer valid on the target site.

Applicable values: See PaymentMethods.
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:
    Specifying a Payment Method
    Listing an Item
    (SetUserPreferences) SellerPaymentPreferences
    Overview of the API Schema for rules regarding repeating nodes

Item.PrivateListing boolean Always A true value in this field indicates the listing is private. In a private listing, a buyer's User ID will not appear in an auction listing's bid history. Sellers may want to use this option when they believe that potential bidders for an auction item would not want their User IDs exposed to others. This setting is only applicable to auction listings.

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

See:
    Listing Policies
    Selecting a Selling Format

Item.Seller UserType Conditionally Container for information about this listing's seller.

Returned by GetItemsAwaitingFeedback if Buyer is making the request.

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

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

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

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

See Working with Anonymous User Information.

Item.Seller.Email string Always Email address for the user. Please see the links below to the topics related to anonymous user information and static email addresses. You cannot retrieve an email address for any user with whom you do not have an order relationship, regardless of site.

An email address of another user is only returned if you and the other user are in an order relationship, within a certain time of order line item creation (although this limitation isn't applicable to the GetAllBidders call in the case of motor vehicles categories.) Based on Trust and Safety policies, the time is unspecified and can vary by site.

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

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

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

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

Item.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 Working with Anonymous User Information.

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

For GetOrders, GetOrderTransactions, 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 Rating Star value for the user is returned to the buyer or seller, but a dummy value of None will be returned to all third parties.

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

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
Item.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, GetOrderTransactions, 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 Working with Anonymous User Information.

Item.Seller.IDVerified boolean Always Indicates whether the user has been verified. For more information about the ID Verify program, see: Protecting your account

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

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
Item.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, GetOrderTransactions, 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.
Item.Seller.RegistrationDate dateTime Always Indicates the date the specified user originally registered with eBay.

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

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

See Working with Anonymous User Information.

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

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

See SellerType or SellerBusinessCodeType for the child elements.

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

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

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

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

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

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

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

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

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

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

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
Item.Seller.SellerInfo
  .TopRatedSeller
boolean Conditionally This boolean field indicates if the seller is certified as a Top Rated Seller. Only Top Rated Sellers can qualify for Top Rated Plus listings, which receive the Top Rated Plus seal, and will help those listings stand out. Top Rated Plus listings also receive a 20 percent discount on the Final Value Fee.

This field is only returned for the following sites: US (EBAY-US), Motors (EBAY-MOTOR), AT (EBAY-AT), CH (EBAY-CH), DE (EBAY-DE), IE (EBAY-IE), UK (EBAY-GB), and AU (EBAY-AU). The Top Rated Seller and Top Rated Plus listing requirements will differ by site. Below are some links to Help pages that discusss these requirements: Top Rated Sellers, registered in the US, can qualify for Top Rated Seller programs in other countries as long as they meet the selling requirments in those countries. However, even if US sellers qualify for programs in other countries, they will not receive the Final Value Fee discount on sales in those countries. For more information, see the Qualifying for Top Rated Seller status on other eBay sites help topic.

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

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

Item.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 Working with Anonymous User Information.

Item.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.
Item.Seller.UserFirstName string Conditionally The first name of the buyer who purchased the order.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
Item.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 the Philippines site: UserID is replaced with the value "Bidder X" where X is a number indicating the order of that user's first bid. For example, if the user was the third bidder, UserID = Bidder 3. Note that in this Philippines site format, the anonymous bidder ID stays the same for a given auction, but is different for different auctions. For example, a bidder who is the third and then the seventh bidder in an auction will be listed for both bids as "Bidder 3". However, if that same bidder is the first bidder on a different auction, the bidder will be listed for that auction as "Bidder 1", not "Bidder 3".

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

For PlaceOffer, see also SellingStatus.HighBidder.

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

See Working with Anonymous User Information.

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

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

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

See Working with Anonymous User Information.

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

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

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

See Working with Anonymous User Information.

Item.Seller.UserLastName string Conditionally The last name of the buyer who purchased the order.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
Item.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 Value-Added Tax (VAT).

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.
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.
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.
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.
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.
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.
Item.SellingStatus
  .FinalValueFee
AmountType (double) Conditionally A seller is changed a Final Value Fee (FVF) when the item is sold, ends with a winning bid, or is purchased. This fee applies whether or not the sale is completed with the buyer and is generated before the buyer makes a payment.

The FVF is calculated using a percentage. This percentage is based on whether the seller has a Store subscription or not. If a seller does have a Store subscription, the FVF is calculated based on the level of that plan. For complete information about selling fees and eBay Store subscription plans, see the Fee Center Home Page.

The Final Value Fee for each order line item is returned by GetSellerTransactions, GetItemTransactions, GetOrders, and GetOrderTransactions, regardless of the checkout status.

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

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
Item.SellingStatus
  .FinalValueFee
  [ attribute currencyID ]
CurrencyCodeType Always A seller is changed a Final Value Fee (FVF) when the item is sold, ends with a winning bid, or is purchased. This fee applies whether or not the sale is completed with the buyer and is generated before the buyer makes a payment.

The FVF is calculated using a percentage. This percentage is based on whether the seller has a Store subscription or not. If a seller does have a Store subscription, the FVF is calculated based on the level of that plan. For complete information about selling fees and eBay Store subscription plans, see the Fee Center Home Page.

The Final Value Fee for each order line item is returned by GetSellerTransactions, GetItemTransactions, GetOrders, and GetOrderTransactions, regardless of the checkout status.

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

For a list of possible enumeration values, see CurrencyCodeType.
Item.SellingStatus
  .ListingStatus
ListingStatusCodeType Always Specifies an active or ended listing's status in eBay's processing workflow.
  • If a listing ends with a sale (or sales), eBay needs to update the sale details (e.g., total price and buyer/high bidder) and the final value fee. This processing can take several minutes.
  • If you retrieve a sold item and no details about the buyer/high bidder are returned or no final value fee is available, use this listing status information to determine whether eBay has finished processing the listing.


Applicable values:

Active
(out) The listing is still active or the listing has ended with a sale but eBay has not completed processing the sale details (e.g., total price and high bidder). A multi-item listing is considered active until all items have winning bids or purchases or the listing ends with at least one winning bid or purchase. If the listing has ended with a sale but this Active status is returned, please allow several minutes for eBay to finish processing the listing.
Completed
(out) The listing has closed and eBay has completed processing the sale. All sale information returned from eBay (e.g., total price and high bidder) should be considered accurate and complete. Although the Final Value Fee (FVF) for FixedPriceItem and StoresFixedPrice items is returned by GetSellerTransactions and GetItemTransactions, all other listing types (excluding Buy It Now purchases) require the listing status to be Completed before the Final Value Fee is returned.
Custom
(out) Reserved for internal or future use.
CustomCode
(out) Reserved for internal or future use.
Ended
(out) The listing has ended. If the listing ended with a sale, eBay has completed processing of the sale. All sale information returned from eBay (e.g., total price and high bidder) should be considered accurate and complete. However, the final value fee is not yet available.

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.
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.
Item.Site SiteCodeType Conditionally The name of the site on which the item is listed. The listing site affects the business logic and validation rules that are applied to the request, which in turn affect the values that are returned in the response, as well as values that appear on the eBay 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.

See:
    eBay Sites and Environments
    Specifying the Target Site
    Field Differences for eBay Sites

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.

For multiple-variation listings, a SKU value is actually required for each product variation within the listing. However, 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.

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.

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.
Item.Title string Conditionally Name of the item as it appears in the listing or search results. Required for most items. Optional if you list in Books, Music, Movies, or Video Games categories and you use Pre-filled Item Information (as the title can be pre-filled based on the catalog product title). That is, optional if you specify Item.ProductListingDetails.

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.
Max length: 80.

DetailLevel: ReturnAll.
Item.Variations VariationsType Conditionally Variations are multiple similar (but not identical) items in a single fixed-price listing. For example, a T-shirt listing could contain multiple items of the same brand that vary by color and size (like "Blue, Large" and "Black, Medium"). Each variation specifies a combination of one of these colors and sizes. Each variation can have a different quantity and price. You can buy multiple items from one variation at the same time. (That is, one order line item can contain multiple items from a single variation.)

If you list in two categories, both categories must support listing with variations. See VariationsEnabled in GetCategoryFeatures to determine applicable categories.

For ReviseFixedPriceItem and RelistFixedPriceItem: Once a listing has been submitted with variations, you can't delete all the variations when you revise or relist the listing (because it would be considered a different listing). You also can't add or change variation specifics (because they are unique identifiers). However, you can delete or replace individual variations as needed to match your current inventory. If a variation has no purchases, use the Variation.Delete field to delete the variation. If it has inventory, set the Quantity to 0.

As a best practice, if you want to revise multiple variations in the same listing at the same time (i.e., within a very short period), use a single ReviseFixedPriceItem request and include all the variation revisions in the same request. If your application design requires you to revise each variation individually, then avoid using multiple parallel threads. Instead, use a serial, synchronous process. That is, wait until each revision has been processed by eBay before submitting the next revision request for another variation in the same listing.

For GetItem and related calls Only returned when a listing has variations.

For GetSellerList: Only returned when a listing has variations, IncludeVariations was set to true in the request, the DetailLevel was set to ReturnAll, and an applicable pagination value and time range were specified.

For GetItemTransactions Only returned in Item when a listing has variations and IncludeVariations was set to true in the request. (Also see Variation returned in Transaction for information about which variation was actually purchased.)

For GetSellerEvents, GetMyeBayBuying, and GetMyeBaySelling: Only returned when a listing has variations and HideVariations was set to false or not specified in the request.

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

See Multi-Variation Listings.

Item.Variations.Variation VariationType Conditionally,
repeatable: [0..*]
Contains data that distinguishes one item variation from another. For example, if an item varies by color and size, each Variation node specifies a combination of one of those colors and sizes.

When listing or relisting an item, you are allowed to create a listing with only one item variation, and you might have a plan to add more item variations to the listing in the future. However, if you don't plan to add other item variations in the future, we recommend that you avoid listing with only one variation, so that you avoid confusing buyers.

If you specify multiple Variation containers in an add/revise/relist/verify add call to define multiple item variations, the Variation containers must be contiguous or an error will occur. This means that you would not want to input a Pictures or a VariationSpecificsSet container in between Variation containers in an API call.

When you modify an item variation with a ReviseFixedPriceItem call, the best practice is to include all applicable fields under the Variation container, even if some of the values/settings are not being modified. The StartPrice and VariationSpecifics must be included when modifying an existing item variation, even if these values are not being changed. If a SKU value is defined for the item variation, it is strongly recommended that you include the SKU field, regardless of whether the SKU value is changing or not. If the SKU field is not included, any existing SKU value will be removed from the item variation. It is also strongly recommended that you include the Quantity field and input an accurate value, because if the Quantity field is omitted in the API call, the quantity for the item variation is set to 0.

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

See Multi-Variation Listings.

Item.Variations.Variation
  .Quantity
int Conditionally This value indicates the quantity of items in the specific variation that are available for purchase. If you set Variation.Quantity to 0 when you create, revise, or relist an item listing, the variation is dropped from the listing. To prevent this, you can set SetUserPreferences.OutOfStockControlPreference to true.

For GetItem (and other related calls that retrieve the Item object), the Variation.Quantity value indicates the total number of items associated with the variation, including the quantity available and the quantity sold. To calculate the quantity available for sale, subtract SellingStatus.QuantitySold from this value.

For RelistFixedPriceItem:
  • For an item variation that had an available quantity greater than 0 when the listing ended, the Quantity value of the item variation for the newly relisted item is set to the actual quantity available. For item variations, there is actually no QuantityAvailable field, but this value may be derived if you look at the corresponding item variation in a GetMyeBaySelling) response and subtract the Variation.QuantitySold value from the Variation.Quantity value, which represents the original Variation.Quantity value at creation time of the previous listing.
  • For item variations with an available quantity of 0 when the listing ended, the relisted item will retain the Variaton.Quantity value that was passed in at creation time of the previous listing.
So, if you are relisting an item that had one or more item variations with an available quantity of 0 when the listing ended, we strongly recommend that you pass in the correct available quantity through the corresponding Variation.Quantity field of a relist call. Alternatively, you can update the correct quantity available by using a ReviseInventoryStatus call and passing in a Quantity value, while also making sure to pass in the correct SKU value(s) to identify the correct item variation. A ReviseInventoryStatus call can be used to revise the quantity of up to four single item listings and/or item variations (from the same or different listings).

For ReviseFixedPriceItem: You can revise a variation's quantity at any time, even if it has purchases. However, unless you set the OutOfStockControlPreference boolean field of the SetUserPreferences call to true, at least one variation must remain with a non-zero quantity in order for the listing to remain active. If you set the OutOfStockControlPreference field to true, a multiple-variation listing will remain active but hidden from search even if the quantity of all variations in the listing is set to 0. When you modify a variation during revise or relist, you need to include both its StartPrice and Quantity. If you revise the Quantity value for a variation after items have already sold, specify the quantity available for sale. (eBay will automatically add the quantity sold to the value you specify.) If you set the quantity to 0 and the variation has no purchases, the variation may be dropped from the listing.

For GetSellerTransactions: See Item.Quantityinstead.

See the eBay Features Guide for more details about setting and modifying a variation's quantity.

Note: The number in the Variation.Quantity field represents the current quantity of the item variation that is available using the "Ship to home" fulfillment method. This number does not take into account any quantity of the item variation that is available through "local" fulfillment methods such as In-Store Pickup, eBay Now, or Click and Collect. This is due to the fact that there is no current implementation (or API field) where the seller informs eBay about the quantity of item variations available through each local fulfillment method. In the case where a listing is only offering the item variations through a local fulfillment method, this value should default to 0, and the Item.IgnoreQuantity will also be returned as True.


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

See:
    Describing Variations in a Listing
    Using the Out-of-Stock Feature for more details

Item.Variations.Variation
  .SellingStatus
SellingStatusType Conditionally Contains the variation's quantity sold. Always returned when variations are present.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
Item.Variations.Variation
  .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.
Item.Variations.Variation.SKU SKUType (string) Conditionally A SKU (stock keeping unit) is an identifier defined by a seller. It is only intended for the seller's use (not for buyers). Many sellers assign a SKU to an item of a specific type, size, and color. For the seller's convenience, eBay preserves the SKU on the variation, and also on corresponding order line items. This enables you (as a seller) use the SKU to reconcile your eBay inventory with your own inventory system instead of using the variation specifics. It is a good idea to track how many items of each type, size, and color are selling so that you can restock your shelves or update the variation quantity on eBay according to customer demand. (eBay does not use the SKU.)

If specified, all SKU values must be unique within the Variations node. That is, no two variations within the same listing can have the same SKU.

If you set Item.InventoryTrackingMethod to true, the variation SKU values are required and they must be unique across all the seller's active listings.

For GetItem and related calls: Only returned if the seller specified a SKU for the variation.
Max length: 80.

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

See Describing Variations in a Listing.

Item.Variations.Variation
  .StartPrice
AmountType (double) Conditionally The fixed price of all items identified by this variation. For example, a "Blue, Large" variation price could be USD 10.00, and a "Black, Medium" variation price could be USD 5.00.

Each variation requires its own price, and the prices can be different for each variation. This enables sellers to provide discounts on certain variations without affecting the price of others. Required (and always returned) for listings with variations.

You can revise a variation's price at any time (even if it has purchases). When you modify a variation during revise or relist, you need to include both its StartPrice and Quantity.

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

See Describing Variations in a Listing.

Item.Variations.Variation
  .StartPrice
  [ attribute currencyID ]
CurrencyCodeType Always The fixed price of all items identified by this variation. For example, a "Blue, Large" variation price could be USD 10.00, and a "Black, Medium" variation price could be USD 5.00.

Each variation requires its own price, and the prices can be different for each variation. This enables sellers to provide discounts on certain variations without affecting the price of others. Required (and always returned) for listings with variations.

You can revise a variation's price at any time (even if it has purchases). When you modify a variation during revise or relist, you need to include both its StartPrice and Quantity.

For a list of possible enumeration values, see CurrencyCodeType.
Item.Variations.Variation
  .VariationSpecifics
NameValueListArrayType Conditionally,
repeatable: [2..5]
A list of name/value pairs that uniquely identify the variation within the listing. All variations must specify the same set of names, and each variation must provide a unique combination of values for those names. For example, if the items vary by color and size, then every variation must specify Color and Size as names, and no two variations can specify the same combination of color and size values.

When you revise a listing that includes variations, you can change names in variation specifics by using ModifyNameList. You can also add, delete, or replace individual variations as needed to match your current inventory. Use the Variation.Delete field to delete a variation that has no sales (order line items). If the variation has sales, then set the Quantity to 0.

For GetSellerEvents To keep the GetSellerEvents response smaller, variation specifics are not returned if the variation has a SKU. If the variation has no SKU, then variation specifics are returned instead. Optionally, you can pass IncludeVariationSpecifics as true in the request to force variation specifics to be returned, even when the SKU is returned.

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

See:
    Describing Variations in a Listing
    Revising and Relisting with Variations

Item.Variations.Variation
  .VariationSpecifics
  .NameValueList
NameValueListType Conditionally,
repeatable: [0..*]
For the AddItem family of calls: Contains the name and value(s) for an Item Specific. Only required when the ItemSpecifics container is specified.

For the AddFixedPriceItem family of calls: The same NameValueList schema is used for the ItemSpecifics node, the VariationSpecifics node, and the VariationSpecifcsSet node.

If the listing has varations, any name that you use in the VariationSpecifics and VariationSpecificsSet nodes can't be used in the ItemSpecifics node.
When you list with Item Variations:
  • 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 more details, see Requiring Product Identifiers Mandate

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

For the AddItem and AddFixedPriceItem families of calls: In the ProductListingDetails.NameValueList (single-variation listing) and VariationProductListingDetails.NameValueList (multiple-variation listing) context, this value is the product identifier type, such as ISBN or UPC. Product identifier types that are supported/required for a specific category can be retrieved using the GetCategorySpecifics call.

For the AddItem and AddFixedPriceItem families of calls: In the Item.ItemSpecifics context, this can be any name that the seller wants to use. However, to help buyers find items more easily, it is a good idea to try to use a recommended name when possible (see GetCategorySpecifics). You can't specify the same name twice within the same listing.

For the AddFixedPriceItem family of calls: In the VariationSpecifics context, this can be any name that the seller wants to use, unless the VariationsEnabled flag is false for the name in the GetCategorySpecifics response. For example, for some categories eBay may recommend that you only use "Brand" as a shared name at the Item level, not in variations.

For 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 GetCategorySpecifics: This is a recommended (popular) name to use for items in the specified category (e.g., "Brand" might be recommended, not "Manufacturer").

For PlaceOffer: Required if the item being purchased includes Item Variations.

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.
Item.Variations.Variation
  .VariationSpecifics
  .NameValueList.Value
string Conditionally,
repeatable: [0..*]
Depending on the call and context, this value is either the value of an Item/Category/Variation Specific, a Parts Compatibility value, or a product identifier.

For the AddItem family of calls: If you specify multiple values for Item Specifics, eBay only stores the first one, unless GetCategorySpecifics indicates that the corresponding name supports multiple values.

For the AddItem and AddFixedPriceItem families of calls: In the ProductListingDetails.NameValueList (single-variation listing) and VariationProductListingDetails.NameValueList (multiple-variation listing) context, this value is the product identifier, such as ISBN or UPC. Product identifier types that are supported/required for a specific category can be retrieved using the GetCategorySpecifics call.

For the AddFixedPriceItem family of calls: If you specify multiple values for Item Specifics or Variation Specifics, eBay only stores the first one, unless GetCategorySpecifics indicates that the corresponding name supports multiple values.

In VariationSpecificSet, you typically specify multiple Value fields for each name. For example, if Name = Size, you would specify all size values that you wan to offer in the listing.

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

For GetCategorySpecifics: The most highly recommended values are returned first. For these calls, Value is only returned when recommended values are available.

For PlaceOffer: Required if the item being purchased includes Item Variations.


Max length: 65.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
PageNumber int Always Page number for the page of order line items the response returned.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
PaginationResult PaginationResultType Always Contains the total number of pages (TotalNumberOfPages) and the total number of entries (TotalNumberOfEntries) that could be returned given repeated calls that use the same selection criteria as the call that returned this response.

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

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

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

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
ReturnedTransactionCountActual int Always Number of order line items retrieved in the current page of results just returned. May be a lower value than TransactionsPerPage if the page returned is the last page and more than one page of data exists.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray TransactionArrayType Conditionally List of Transaction objects representing the order line items resulting from the listing. Each Transaction object contains the data for one purchase (of one or more items in the same listing). The Transaction.Item field is not returned because the Item object is returned at the root level of the response. See the reference guide for more information about the fields that are returned.

DetailLevel: ItemReturnDescription, 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.

See Listing an Item.

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

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

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

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

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

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

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

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

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

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

See Combined Invoice.

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

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

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

For GetOrders, GetOrderTransactions, 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.AboutMePage
boolean Conditionally If true, indicates that the user has set up an About Me page.

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

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

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

See Working with Anonymous User Information.

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

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

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

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

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 uses AddressType, and each call that uses BuyerType uses the ShippingAddress container a little differently. See the Call Reference documentation for each call to see what fields of AddressType are used by each call. Output only.

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

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

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

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

Applicable values:

CustomCode
(out) Reserved for internal or future use.
DefaultShipping
(out) This value indicates that the shipping address provided by the buyer at checkout time is the buyer's default/primary shipping address.
Invalid
(out) This value indicates that the address is not valid, and an alternative address will have to be provided before the order is shipped.
Shipping
(out) This value indicates that the shipping address provided by the buyer at checkout time is one of the buyer's secondary shipping addresses 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
  .Buyer.BuyerInfo
  .ShippingAddress.CityName
string Conditionally The name of the user's city.
Max length: This varies based on the user's country. Currently, the maximum length is 64 for the US. Note: The eBay database allocates up to 128 characters for this field. .

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

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

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

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 name of the user's country.
Max length: eBay validates the content, but not the length for this field. Note: The eBay database allocates up to 128 characters for this field. .

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .Buyer.BuyerInfo
  .ShippingAddress
  .ExternalAddressID
string Conditionally This is a unique identifier assigned to the customer address if the address is on file with PayPal. The AddressOwner field will indicate if the address is on file with eBay or PayPal. This field will only be applicable/returned if it is a PayPal-owned address. The ID changes if a user changes their address.
Max length: 20.

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

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

In the US, the area code (3 digits), the prefix (3 digits), the line number (4 digits), and phone extension (if specified by the user) are returned in this field. The extension can be one or more digits. Non-breaking spaces are used as delimiters between these phone number components.
Max length: eBay validates the content (should only be integer values and delimiters), but not the length for this field. Note: The eBay database allocates up to 128 characters for this field. .

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

For a Global Shipping Program order, GetSellerList and GetMyeBaySelling return the postal code of the buyer, not that of the international shipping provider.
Max length: This varies based on the user's country. Currently, the maximum length is 9 (not counting delimiter characters) for the US. Note: The eBay database allocates up to 24 characters for this field. .

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .Buyer.BuyerInfo
  .ShippingAddress
  .StateOrProvince
string Conditionally The state or province of the user's address. Whether it's a state or a province will depend on the region and/or country.
Max length: This varies based on the user's country. Currently, the maximum length is 64 for the US. Note: The eBay database allocates up to 128 characters for this field. .

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .Buyer.BuyerInfo
  .ShippingAddress.Street
string Conditionally A concatenation of Street1 and Street2, primarily 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.
Max length: This varies based on the user's country. Currently, the maximum length is 180 for the US. Note: The eBay database allocates up to 512 characters for this field. .

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .Buyer.BuyerInfo
  .ShippingAddress.Street2
string Conditionally 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. In case of Item.SellerContactDetails, Street2 can be used to provide City, Address, State, and Zip code (if applicable).
Max length: This varies based on the user's country. Currently, the maximum length is 180 for the US. Note: The eBay database allocates up to 512 characters for this field. .

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

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

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

See Working with Anonymous User Information.

TransactionArray.Transaction
  .Buyer.Email
string Conditionally Email address for the user. Please see the links below to the topics related to anonymous user information and static email addresses. You cannot retrieve an email address for any user with whom you do not have an order relationship, regardless of site.

An email address of another user is only returned if you and the other user are in an order relationship, within a certain time of order line item creation (although this limitation isn't applicable to the GetAllBidders call in the case of motor vehicles categories.) Based on Trust and Safety policies, the time is unspecified and can vary by site.

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

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

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

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

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

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

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

See Working with Anonymous User Information.

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

For GetOrders, GetOrderTransactions, 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 Rating Star value for the user is returned to the buyer or seller, but a dummy value of None will be returned to all third parties.

Applicable values: See FeedbackRatingStar.
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.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, GetOrderTransactions, 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 Working with Anonymous User Information.

TransactionArray.Transaction
  .Buyer.IDVerified
boolean Conditionally Indicates whether the user has been verified. For more information about the ID Verify program, see: Protecting your account

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

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

For GetOrders, GetOrderTransactions, 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 Working with Anonymous User Information.

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

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

Applicable values: See Site.
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 Working with Anonymous User Information.

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

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

See Static Email Addresses in Trading API Calls.

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

Applicable values: 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.UserFirstName
string Conditionally The first name of the buyer who purchased the order.

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 the Philippines site: UserID is replaced with the value "Bidder X" where X is a number indicating the order of that user's first bid. For example, if the user was the third bidder, UserID = Bidder 3. Note that in this Philippines site format, the anonymous bidder ID stays the same for a given auction, but is different for different auctions. For example, a bidder who is the third and then the seventh bidder in an auction will be listed for both bids as "Bidder 3". However, if that same bidder is the first bidder on a different auction, the bidder will be listed for that auction as "Bidder 1", not "Bidder 3".

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

For PlaceOffer, see also SellingStatus.HighBidder.

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

See Working with Anonymous User Information.

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

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

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

See Working with Anonymous User Information.

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

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

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

See Working with Anonymous User Information.

TransactionArray.Transaction
  .Buyer.UserLastName
string Conditionally The last name of the buyer who purchased the order.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
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 Value-Added Tax (VAT).

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

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
  .BuyerGuaranteePrice
AmountType (double) Conditionally For the Australia site, BuyerGuaranteePrice is the PayPal Buyer Protection coverage, offered for the item at the time of purchase. Details of coverage are in the following sections of the View Item page: the Buy Safely section and the Payment Details section.

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

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

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ContainingOrder
OrderType Conditionally The Combined Invoice order to which the order line item belongs. This container is only returned if IncludeContainingOrder is included and set to true in a GetItemTransactions or GetSellerTransactions request.

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

See Combined Invoice.

TransactionArray.Transaction
  .ContainingOrder
  .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 German site.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ContainingOrder
  .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
  .ContainingOrder
  .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
  .ContainingOrder
  .BuyerTaxIdentifier
TaxIdentifierType Conditionally,
repeatable: [0..*]
This container consists of taxpayer identification for the buyer. Although this container may be used for other purposes at a later date, it is currently used by sellers selling on the Italy or Spain site to retrieve the taxpayer ID of the buyer.

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

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

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

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

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

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

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

Applicable values: 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
  .ContainingOrder.CancelDetail
CancelDetailType Conditionally,
repeatable: [0..*]
This container consists of details related to an eBay order that has been cancelled or is in the process of possibly being cancelled. Order cancellation requests can be viewed and managed with the cancellation API calls that are available in the Post Order API.

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

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

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ContainingOrder.CancelDetail
  .CancelIntiator
token Conditionally This value indicates which party initiated the cancellation of the eBay order. It will usually be Buyer or Seller, but it can also be CS (eBay Customer Support). See CancelInitiatorCodeType for the complete list of enumeration values that can be returned in this field. This field is always returned with the CancelDetail container.

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

Applicable values: See CancelInitiatorCodeType
TransactionArray.Transaction
  .ContainingOrder.CancelDetail
  .CancelReason
token Conditionally This value indicates the reason why the order cancellation was initiated. This field is always returned with the CancelDetail container. 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. Other order cancellation reasons are specific to eBay Scheduled Delivery orders. eBay Scheduled Delivery is similar to the eBay Now service in the US (now retired), and is only available in the UK. See CancelReasonCodeType for the complete list of enumeration values that can be returned in this field.

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

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

Applicable values: See CancelReasonCodeType
TransactionArray.Transaction
  .ContainingOrder.CancelDetail
  .CancelReasonDetails
string Conditionally The detailed reason of why the order cancellation was initiated. This field is only returned if it is available for an order that has been cancelled, or if an order is going through the cancellation process.

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

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ContainingOrder.CancelReason
token Conditionally This value indicates the reason why the 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. Other order cancellation reasons are specific to eBay Scheduled Delivery orders. eBay Scheduled Delivery is similar to the eBay Now service in the US (now retired), and is only available in the UK. See for the complete list of enumeration values that can be returned in this field.

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

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

Applicable values: See CancelReasonCodeType
TransactionArray.Transaction
  .ContainingOrder
  .CancelReasonDetails
string Conditionally The detailed reason for the cancellation of an eBay order. This field is only returned if it is available when 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: Currently, the CancelReasonDetails field is being returned under the Order container and under the CancelDetail container. However, there are plans to deprecate this field from OrderType in the future.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ContainingOrder.CancelStatus
CancelStatusCodeType Conditionally The current status for the order cancellation request if it exists. 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.

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

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

See Offering eBay Plus for more details.

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

Applicable values:

Buyer
(in/out) The eBay user is acting as the buyer for the order(s). In GetOrders, this value should be passed into the OrderRole field in the request to retrieve orders in which the calling eBay user is the buyer in the order.
CustomCode
(in/out) This value is reserved for future or internal use.
Seller
(in/out) The eBay user is acting as the seller for the order(s). In GetOrders, this value should be passed into the OrderRole field in the request to retrieve orders in which the calling eBay user is the seller in the order.

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. Unlike the OrderID field, the format for this field is the same for both single and multiple line item orders. ExtendedOrderID values will be used to identify orders in the Post-Order APIs. For Trading API Get calls, OrderID values should still be used.

For GetOrders, GetOrderTransactions, 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.

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

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

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

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ContainingOrder
  .LogisticsPlanType
token Conditionally This field will be returned at the order 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 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
  .ContainingOrder
  .MonetaryDetails
PaymentsInformationType Conditionally Contains information about how funds exchanged for an order are allocated to payees.

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

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

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

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

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

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

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

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

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

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

For a list of possible enumeration values, see UserIdentityCodeType.
TransactionArray.Transaction
  .ContainingOrder
  .MonetaryDetails.Payments
  .Payment.Payer
UserIdentityType (string) Conditionally This field indicates the eBay user or eBay partner who submitted the payment.

For GetOrders, GetOrderTransactions, 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
  .ContainingOrder
  .MonetaryDetails.Payments
  .Payment.Payer
  [ attribute type ]
UserIdentityCodeType Conditionally This field indicates the eBay user or eBay partner who submitted the payment.

For GetOrders, GetOrderTransactions, 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
  .ContainingOrder
  .MonetaryDetails.Payments
  .Payment.PaymentAmount
AmountType (double) Conditionally The amount of the payment that is allocated to the payee.

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

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

For GetOrders, GetOrderTransactions, 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
  .ContainingOrder
  .MonetaryDetails.Payments
  .Payment.PaymentReferenceID
  [ attribute type ]
TransactionReferenceCodeType Conditionally The payment transaction ID.

For GetOrders, GetOrderTransactions, 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
  .ContainingOrder
  .MonetaryDetails.Payments
  .Payment.PaymentStatus
PaymentTransactionStatusCodeType Conditionally The current status of a buyer payment that is allocated to a specified payee.

Applicable values:

CustomCode
(out) Reserved for internal or future use.
Failed
(out) This value indicates that the payment transaction failed.
Pending
(out) This value indicates that the payment transaction is pending.
Succeeded
(out) This value indicates that the payment transaction succeeded.

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
  .ContainingOrder
  .MonetaryDetails.Payments
  .Payment.PaymentTime
dateTime Conditionally The date and time when the payment is received by the payee.

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

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

For GetOrders, GetOrderTransactions, 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
  .ContainingOrder
  .MonetaryDetails.Payments
  .Payment.ReferenceID
  [ attribute type ]
TransactionReferenceCodeType Conditionally A unique transaction ID for the payment.

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

For GetOrders, GetOrderTransactions, 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
  .ContainingOrder
  .MonetaryDetails.Refunds
RefundInformationType Conditionally This container consists of an array of one or more Refund containers, and each Refund container consists of detailed information about a merchant's refund (or store credit) to a buyer who has returned an In-Store Pickup item.

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

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

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

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

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

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

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

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

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

For GetOrders, GetOrderTransactions, 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, and can only be applied to multi-quantity, fixed-price listings. Merchants/developers can test In-Store Pickup functionality in the Sandbox environment, including listing items enabled with the In-Store Pickup feature, creating store locations and adding inventory to these stores using the Inventory Management API, and informing eBay of In-Store Pickup status changes using the Inbound Notifications API.

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

For GetOrders, GetOrderTransactions, 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, and can only be applied to multi-quantity, fixed-price listings. Merchants/developers can test In-Store Pickup functionality in the Sandbox environment, including listing items enabled with the In-Store Pickup feature, creating store locations and adding inventory to these stores using the Inventory Management API, and informing eBay of In-Store Pickup status changes using the Inbound Notifications API.

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

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

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

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

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

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

Applicable values:

CustomCode
(out) Reserved for internal or future use.
Failed
(out) This value indicates that the payment transaction failed.
Pending
(out) This value indicates that the payment transaction is pending.
Succeeded
(out) This value indicates that the payment transaction succeeded.

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
  .ContainingOrder
  .MonetaryDetails.Refunds
  .Refund.RefundTime
dateTime Conditionally This date/time value is the timestamp for the refund transaction. This field is not returned if the refund was not successful (RefundStatus=FAILED).

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

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

For GetOrders, GetOrderTransactions, 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, and can only be applied to multi-quantity, fixed-price listings. Merchants/developers can test In-Store Pickup functionality in the Sandbox environment, including listing items enabled with the In-Store Pickup feature, creating store locations and adding inventory to these stores using the Inventory Management API, and informing eBay of In-Store Pickup status changes using the Inbound Notifications API.

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

For GetOrders, GetOrderTransactions, 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, and can only be applied to multi-quantity, fixed-price listings. Merchants/developers can test In-Store Pickup functionality in the Sandbox environment, including listing items enabled with the In-Store Pickup feature, creating store locations and adding inventory to these stores using the Inventory Management API, and informing eBay of In-Store Pickup status changes using the Inbound Notifications API.

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

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

Applicable values:

CustomCode
(out) This value is reserved for internal or future use.
PaymentRefund
(out) This value indicates that the merchant issued a cash refund (or debit card/credit card reversal) to the buyer for the amount of the returned item(s).
StoreCredit
(out) This value indicates that the merchant issued a store credit to the buyer for the amount of the returned item(s).

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
  .ContainingOrder
  .MultiLegShippingDetails
MultiLegShippingDetailsType Conditionally Contains details about the domestic leg of a Global Shipping Program shipment.

This information is not returned if IsMultilegShipping is false.

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

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

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

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

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

For a list of possible enumeration values, see CurrencyCodeType.
TransactionArray.Transaction
  .ContainingOrder
  .MultiLegShippingDetails
  .SellerShipmentToLogisticsProvider
  .ShippingTimeMax
int Conditionally The 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
  .ContainingOrder
  .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
  .ContainingOrder
  .MultiLegShippingDetails
  .SellerShipmentToLogisticsProvider
  .ShipToAddress
AddressType Conditionally Contains shipping address information for the domestic leg of a Global Shipping Program shipment. This container includes the ReferenceID field, which can be printed on the package to give the international shipping provider a unique identifier for the order.

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

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

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

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

Applicable values:

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

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
  .ContainingOrder
  .MultiLegShippingDetails
  .SellerShipmentToLogisticsProvider
  .ShipToAddress.AddressUsage
AddressUsageCodeType Conditionally This tag tells whether current address is a default shipping address or one of the shipping addresses in address book.

Applicable values:

CustomCode
(out) Reserved for internal or future use.
DefaultShipping
(out) This value indicates that the shipping address provided by the buyer at checkout time is the buyer's default/primary shipping address.
Invalid
(out) This value indicates that the address is not valid, and an alternative address will have to be provided before the order is shipped.
Shipping
(out) This value indicates that the shipping address provided by the buyer at checkout time is one of the buyer's secondary shipping addresses 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
  .ContainingOrder
  .MultiLegShippingDetails
  .SellerShipmentToLogisticsProvider
  .ShipToAddress.CityName
string Conditionally The name of the user's city.
Max length: This varies based on the user's country. Currently, the maximum length is 64 for the US. Note: The eBay database allocates up to 128 characters for this field. .

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

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

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

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
  .ContainingOrder
  .MultiLegShippingDetails
  .SellerShipmentToLogisticsProvider
  .ShipToAddress.CountryName
string Conditionally The name of the user's country.
Max length: eBay validates the content, but not the length for this field. Note: The eBay database allocates up to 128 characters for this field. .

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ContainingOrder
  .MultiLegShippingDetails
  .SellerShipmentToLogisticsProvider
  .ShipToAddress
  .ExternalAddressID
string Conditionally This is a unique identifier assigned to the customer address if the address is on file with PayPal. The AddressOwner field will indicate if the address is on file with eBay or PayPal. This field will only be applicable/returned if it is a PayPal-owned address. The ID changes if a user changes their address.
Max length: 20.

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

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

In the US, the area code (3 digits), the prefix (3 digits), the line number (4 digits), and phone extension (if specified by the user) are returned in this field. The extension can be one or more digits. Non-breaking spaces are used as delimiters between these phone number components.
Max length: eBay validates the content (should only be integer values and delimiters), but not the length for this field. Note: The eBay database allocates up to 128 characters for this field. .

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

For a Global Shipping Program order, GetSellerList and GetMyeBaySelling return the postal code of the buyer, not that of the international shipping provider.
Max length: This varies based on the user's country. Currently, the maximum length is 9 (not counting delimiter characters) for the US. Note: The eBay database allocates up to 24 characters for this field. .

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

Example: "Reference #1234567890123456"

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ContainingOrder
  .MultiLegShippingDetails
  .SellerShipmentToLogisticsProvider
  .ShipToAddress.StateOrProvince
string Conditionally The state or province of the user's address. Whether it's a state or a province will depend on the region and/or country.
Max length: This varies based on the user's country. Currently, the maximum length is 64 for the US. Note: The eBay database allocates up to 128 characters for this field. .

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

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ContainingOrder
  .MultiLegShippingDetails
  .SellerShipmentToLogisticsProvider
  .ShipToAddress.Street2
string Conditionally 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. In case of Item.SellerContactDetails, Street2 can be used to provide City, Address, State, and Zip code (if applicable).
Max length: This varies based on the user's country. Currently, the maximum length is 180 for the US. Note: The eBay database allocates up to 512 characters for this field. .

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

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

For GetOrders, GetOrderTransactions, and GetItemTransactions only: If using Trading WSDL Version 1019 or above, this field will only be returned to the buyer, seller, or PayPal (if PayPal is the payment method), and no longer returned at all to third parties (except for PayPal). If using a Trading WSDL older than Version 1019, the correct Order ID is returned to the buyer, seller or PayPal, but the Order ID will be returned as dummy data in the form of 1000000000000 or 1000000000000-1000000000000 to all third parties (except for PayPal).

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

See Combined Invoice.

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

Applicable values: 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
  .ContainingOrder
  .PaymentHoldDetails
PaymentHoldDetailType Conditionally This container consists of information related to the payment hold on the order, including the reason why the buyer's payment for the order is being held, the expected release date of the funds into the seller's account, and possible action(s) the seller can take to expedite the payout of funds into their account. This container is only returned if PayPal has placed a payment hold on the order.

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

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

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

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

Applicable values: See PaymentHoldReason.
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
  .PaymentHoldDetails
  .RequiredSellerActionArray
RequiredSellerActionArrayType Conditionally Container consisting of one or more RequiredSellerAction fields. RequiredSellerAction fields provide possible actions that a seller can take to expedite the release of funds into their account.

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

Applicable values: See RequiredSellerAction.
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
  .PaymentHoldStatus
PaymentHoldStatusCodeType Conditionally This field indicates the type and/or status of a payment hold on the item.

Applicable values: See PaymentHoldStatus.
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
  .ContainingOrder
  .ShippingConvenienceCharge
AmountType (double) Conditionally The dollar value in this field indicates the amount that the seller is being charged (at order level) for the convenience of an eBay Now delivery. The standard minimum order amount for an eBay Now delivery is $25, with a "convenience fee" of $5. If the buyer meets the minimum order amount, this value will generally be '5.0'. However, it is also possible that the buyer's order only totals $15, so that buyer is required to pay a "convenience fee" of $10.

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

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

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

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

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

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

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

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

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

Applicable values:

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

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

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 US and CA eBay Motors Items.

TransactionArray.Transaction
  .DigitalDeliverySelected
DigitalDeliverySelectedType Conditionally Note: This container was enabled with version 935. For those using versions older than 935, this container will not be returned.
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, GetOrderTransactions, 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, GetOrderTransactions, 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
  .eBayPlusTransaction
boolean Conditionally If true, this 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. 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 (DE).

See Offering eBay Plus for more details.

TransactionArray.Transaction
  .ExtendedOrderID
string Conditionally A unique identifier for an eBay order line item. ExtendedOrderID values will be used to identify order line items in the Post-Order API. For Trading API Get calls, OrderLineItemID values should still be used.

For GetOrders, GetOrderTransactions, 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.

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

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, the real transaction identifier is only returned to the buyer or seller, and a string value of Unavailable will be returned to all third parties.

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

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

Applicable values:

CustomCode
(out) Reserved for internal or future use.
Failed
(out) This value indicates that the payment transaction failed.
Pending
(out) This value indicates that the payment transaction is pending.
Succeeded
(out) This value indicates that the payment transaction succeeded.

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

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

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

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

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

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

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

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

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

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

For a list of possible enumeration values, see CurrencyCodeType.
TransactionArray.Transaction
  .Gift
boolean Conditionally Note: This field was enabled with version 935. For those using versions older than 935, this field will not be returned.
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 Note: This container was enabled with version 935. For those using versions older than 935, this container will not be returned.
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 returned as true if the order line item is qualified for eBay Guaranteed Delivery, or false if it is not eligible.Only domestic shipments are available for eBay Guaranteed Delivery. For an order line item to be qualified for eBay Guaranteed Delivery, the following must be true:
  • The eBay Guaranteed Delivery feature must be available to the seller
  • That seller must be opted in to one of the two eBay Guaranteed Delivery programs
  • A one-day shipping service option that serves the buyer's location must be set on the listing
  • The listing must have a return policy
  • If the seller is opted into the "Door-to-Door" program, a domestic shipping rate table must be applied to the listing, and that shipping rate table must include the buyer's location with a transit time (handling + shipping time) of 3 days or less;
  • If the seller is opted into the "Handling Time" program, the handling time must be set to 0 or 1 day, and that shipping rate table must include the buyer's location with a transit time (handling + shipping time) of 3 days or less
With eBay Guaranteed Delivery, the sellers are committed to getting the order line item to the buyer within three business days. The seller's defined "Order Cutoff" time will control what is considered three business days. If a buyer wanted to get an order by Thursday, that buyer would have to purchase that item on Monday before the seller's "Order Cutoff" time. The seller's "Order Cutoff" time is generally set in their timezone, so the buyer should take this into account before the purchase.

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 Guarantee 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 Conditionally This flag indicates whether or not the order line item is an intangible good such as an MP3 track or a mobile phone ringtone. Intangible items are not eligible for PayPal's Seller Protection program, so the seller will not be able to open an Unpaid Item case against the buyer.

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 If IsMultilegShipping is true, the Global Shipping Program (GSP) will be used to ship the order line item to an international buyer. A GSP shipment has a domestic leg and an international leg. The buyer's shipping address is in a country other than the country where the item was listed, and the seller has specified 'InternationalPriorityShipping' as the default international shipping service in the listing.

If IsMultilegShipping is false, the order line item will not be shipped with the Global Shipping Program.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ListingCheckoutRedirectPreference
ListingCheckoutRedirectPreferenceType Conditionally ProStores listing level preferences regarding the store to which checkout should be redirected for the listing if Item.ThirdPartyCheckout is true.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .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 how funds exchanged for an order line item are allocated to payees.

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

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

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

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

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

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

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

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

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

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

For a list of possible enumeration values, see UserIdentityCodeType.
TransactionArray.Transaction
  .MonetaryDetails.Payments
  .Payment.Payer
UserIdentityType (string) Conditionally This field indicates the eBay user or eBay partner who submitted the payment.

For GetOrders, GetOrderTransactions, 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, GetOrderTransactions, 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, GetOrderTransactions, 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, GetOrderTransactions, 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.PaymentStatus
PaymentTransactionStatusCodeType Conditionally The current status of a buyer payment that is allocated to a specified payee.

Applicable values:

CustomCode
(out) Reserved for internal or future use.
Failed
(out) This value indicates that the payment transaction failed.
Pending
(out) This value indicates that the payment transaction is pending.
Succeeded
(out) This value indicates that the payment transaction succeeded.

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
  .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, GetOrderTransactions, 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, GetOrderTransactions, 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, and can only be applied to multi-quantity, fixed-price listings. Merchants/developers can test In-Store Pickup functionality in the Sandbox environment, including listing items enabled with the In-Store Pickup feature, creating store locations and adding inventory to these stores using the Inventory Management API, and informing eBay of In-Store Pickup status changes using the Inbound Notifications API.

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

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

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

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

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

For GetOrders, GetOrderTransactions, 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, 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, GetOrderTransactions, 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, and can only be applied to multi-quantity, fixed-price listings. Merchants/developers can test In-Store Pickup functionality in the Sandbox environment, including listing items enabled with the In-Store Pickup feature, creating store locations and adding inventory to these stores using the Inventory Management API, and informing eBay of In-Store Pickup status changes using the Inbound Notifications API.

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

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

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

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

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

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

Applicable values:

CustomCode
(out) Reserved for internal or future use.
Failed
(out) This value indicates that the payment transaction failed.
Pending
(out) This value indicates that the payment transaction is pending.
Succeeded
(out) This value indicates that the payment transaction succeeded.

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
  .MonetaryDetails.Refunds
  .Refund.RefundTime
dateTime Conditionally This date/time value is the timestamp for the refund transaction. This field is not returned if the refund was not successful (RefundStatus=FAILED).

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

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

For GetOrders, GetOrderTransactions, 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, 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, GetOrderTransactions, 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, and can only be applied to multi-quantity, fixed-price listings. Merchants/developers can test In-Store Pickup functionality in the Sandbox environment, including listing items enabled with the In-Store Pickup feature, creating store locations and adding inventory to these stores using the Inventory Management API, and informing eBay of In-Store Pickup status changes using the Inbound Notifications API.

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

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

Applicable values:

CustomCode
(out) This value is reserved for internal or future use.
PaymentRefund
(out) This value indicates that the merchant issued a cash refund (or debit card/credit card reversal) to the buyer for the amount of the returned item(s).
StoreCredit
(out) This value indicates that the merchant issued a store credit to the buyer for the amount of the returned item(s).

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 Contains details about the domestic leg of a Global Shipping Program shipment.

This container is not returned if IsMultilegShipping is false.

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

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

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

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

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

For a list of possible enumeration values, see CurrencyCodeType.
TransactionArray.Transaction
  .MultiLegShippingDetails
  .SellerShipmentToLogisticsProvider
  .ShippingTimeMax
int Conditionally The 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. This container includes the ReferenceID field, which can be printed on the package to give the international shipping provider a unique identifier for the order.

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

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

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

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

Applicable values:

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

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.AddressUsage
AddressUsageCodeType Conditionally This tag tells whether current address is a default shipping address or one of the shipping addresses in address book.

Applicable values:

CustomCode
(out) Reserved for internal or future use.
DefaultShipping
(out) This value indicates that the shipping address provided by the buyer at checkout time is the buyer's default/primary shipping address.
Invalid
(out) This value indicates that the address is not valid, and an alternative address will have to be provided before the order is shipped.
Shipping
(out) This value indicates that the shipping address provided by the buyer at checkout time is one of the buyer's secondary shipping addresses 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 name of the user's city.
Max length: This varies based on the user's country. Currently, the maximum length is 64 for the US. Note: The eBay database allocates up to 128 characters for this field. .

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

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

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

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 name of the user's country.
Max length: eBay validates the content, but not the length for this field. Note: The eBay database allocates up to 128 characters for this field. .

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .MultiLegShippingDetails
  .SellerShipmentToLogisticsProvider
  .ShipToAddress
  .ExternalAddressID
string Conditionally This is a unique identifier assigned to the customer address if the address is on file with PayPal. The AddressOwner field will indicate if the address is on file with eBay or PayPal. This field will only be applicable/returned if it is a PayPal-owned address. The ID changes if a user changes their address.
Max length: 20.

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

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

In the US, the area code (3 digits), the prefix (3 digits), the line number (4 digits), and phone extension (if specified by the user) are returned in this field. The extension can be one or more digits. Non-breaking spaces are used as delimiters between these phone number components.
Max length: eBay validates the content (should only be integer values and delimiters), but not the length for this field. Note: The eBay database allocates up to 128 characters for this field. .

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

For a Global Shipping Program order, GetSellerList and GetMyeBaySelling return the postal code of the buyer, not that of the international shipping provider.
Max length: This varies based on the user's country. Currently, the maximum length is 9 (not counting delimiter characters) for the US. Note: The eBay database allocates up to 24 characters for this field. .

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

Example: "Reference #1234567890123456"

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .MultiLegShippingDetails
  .SellerShipmentToLogisticsProvider
  .ShipToAddress.StateOrProvince
string Conditionally The state or province of the user's address. Whether it's a state or a province will depend on the region and/or country.
Max length: This varies based on the user's country. Currently, the maximum length is 64 for the US. Note: The eBay database allocates up to 128 characters for this field. .

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

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .MultiLegShippingDetails
  .SellerShipmentToLogisticsProvider
  .ShipToAddress.Street2
string Conditionally 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. In case of Item.SellerContactDetails, Street2 can be used to provide City, Address, State, and Zip code (if applicable).
Max length: This varies based on the user's country. Currently, the maximum length is 180 for the US. Note: The eBay database allocates up to 512 characters for this field. .

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .OrderLineItemID
string Always A unique identifier for an eBay order line item. This field is created as soon as there is a commitment to buy from the seller, and its value is based upon the concatenation of ItemID and TransactionID, with a hyphen in between these two IDs.

For GetOrders, GetOrderTransactions, 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.
Max length: 50 (Note: ItemIDs and TransactionIDs usually consist of 9 to 12 digits.).

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .PaidTime
dateTime Conditionally Indicates the time when the order was marked paid. This field is not returned until payment has been made by the buyer. This field will not be returned for orders where the buyer has received partial or full refunds.

This value will only be visible to the user on either side of the order. An order can be marked as paid in the following ways:
  • Automatically when a payment is made via PayPal
  • Seller marks the item as paid in My eBay or through Selling Manager Pro
  • Programmatically by the seller through the ReviseCheckoutStatus or CompleteSale calls.


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

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

DetailLevel: ReturnAll.
TransactionArray.Transaction
  .PaymentHoldDetails
  .ExpectedReleaseDate
dateTime Conditionally Timestamp that indicates the expected date in which eBay/PayPal will distribute the funds to the seller's account. This is not a firm date and is subject to change. This field is only returned after checkout is complete and if the PaymentHoldStatus indicates a hold has been placed on payment.

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

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

Applicable values: See PaymentHoldReason.
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
  .PaymentHoldDetails
  .RequiredSellerActionArray
RequiredSellerActionArrayType Conditionally Container consisting of one or more RequiredSellerAction fields. RequiredSellerAction fields provide possible actions that a seller can take to expedite the release of funds into their account.

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

Applicable values: See RequiredSellerAction.
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
  .PayPalEmailAddress
string Conditionally The seller's PayPal email address. This value is only revealed if it is the seller making the call.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .PickupDetails
PickupDetailsType Conditionally 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. With this initial version of In-Store Pickup, the only pickup method is 'InStorePickup'.

For GetOrders and GetOrderTransactions, this container is always returned prior to order payment if the seller created/revised/relisted the item with the EligibleForPickupInStore flag in the call request set to 'true'. If and when the In-Store pickup method is selected by the buyer and payment for the order is made, this container will no longer be returned in the response, and will essentially be replaced by the PickupMethodSelected container.

Note: A seller must be eligible for the In-Store Pickup feature to list an item that is eligible for In-Store Pickup. At this time, the In-Store Pickup feature is generally only available to large retail merchants, and can only be applied to multi-quantity, fixed-price listings.

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

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, these features are generally only available to large retail merchants, and can only be applied to multi-quantity, fixed-price listings.

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

Applicable values: See PickupMethodCodeType
TransactionArray.Transaction
  .PickupDetails.PickupOptions
  .PickupPriority
int Conditionally This integer value indicates the priority of the pickup method. The priority of each pickup method controls the order (relative to other pickup methods) in which the corresponding pickup method will appear in the View Item and Checkout page. 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, these features are generally only available to large retail merchants, and can only be applied to multi-quantity, fixed-price listings.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .PickupMethodSelected
PickupMethodSelectedType Conditionally This container consists of details related to the selected In-Store pickup method, including the pickup method, the merchant's store ID, the status of the In-Store pickup, and the pickup reference code (if provided by merchant).

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .PickupMethodSelected
  .MerchantPickupCode
string Conditionally The unique reference number defined by the merchant to track In-Store Pickup orders. The MerchantPickupCode is picked up by eBay if it is set by the merchant through the payload of a notification sent to eBay through the Inbound Notifications API. This field is only returned with the PickupMethodSelected container if it set by the merchant.

For GetOrders, GetOrderTransactions, 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, 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, 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, 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 order line item originated.

Note: Currently, the only value that should be returned in this field is eBay, as Half.com listings will no longer be supported in APIs.

Applicable values:

eBay
(in/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
  .QuantityPurchased
int Conditionally This value indicates the number of identical items purchased at the same time by the same buyer from one listing. For auction listings, this value is always 1. For fixed-price, non-variation listings, this value can be greater than 1. In either case, this field is tied to the same order line item.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .SellerContactBuyerByEmail
boolean Conditionally Indicates whether the buyer has opted to accept emails from all the selling partners on Shopping.com. This field is only returned for order line items purchased through the Shopping.com shopping cart.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .SellerDiscounts
SellerDiscountsType Conditionally 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
  .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
  .SellingManagerProductDetails
SellingManagerProductDetailsType Conditionally This container consists of Selling Manager product details and is only returned if the item was listed through Selling Manager.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .SellingManagerProductDetails
  .ProductName
string Conditionally The name of a Selling Manager product. The AddSellingManagerProduct call is used to create a Selling Manager product.
TransactionArray.Transaction
  .ShippedTime
dateTime Conditionally Indicates the time when the item(s) associated with the order were marked as shipped. This value will only be visible to the user on either side of the order. An order can be marked as shipped in My eBay or through Selling Manager Pro, or programmatically by the seller through the CompleteSale call.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ShippingConvenienceCharge
AmountType (double) Conditionally The dollar value in this field indicates the amount that the seller is being charged (at line item level) for the convenience of an eBay Scheduled Delivery. eBay Scheduled Delivery is currently only available in the London (UK) area.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ShippingConvenienceCharge
  [ attribute currencyID ]
CurrencyCodeType Always The dollar value in this field indicates the amount that the seller is being charged (at line item level) for the convenience of an eBay Scheduled Delivery. eBay Scheduled Delivery is currently only available in the London (UK) area.

For a list of possible enumeration values, see CurrencyCodeType.
TransactionArray.Transaction
  .ShippingDetails
ShippingDetailsType Conditionally Container consisting of shipping-related details for an order. Shipping details include shipping rates, package dimensions, handling costs, excluded shipping locations (if specified), shipping service options, shipping insurance information, sales tax information (if applicable), and shipment tracking details (if shipped).

For GetSellerTransactions and GetItemTransactions, the ShippingDetails container is returned in the Transaction container. For GetOrders and GetOrderTransactions, the ShippingDetails container is returned at the Order level.

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

See Shipping.

TransactionArray.Transaction
  .ShippingDetails
  .CalculatedShippingRate
CalculatedShippingRateType Conditionally Details pertinent to one or more items for which calculated shipping has been offered by the seller, such as package dimension and weight and packaging/handling costs. If your call specifies a large-dimension item listed with UPS, see Dimensional Weight limit on UPS shipping services results in failure of shipping calculator.

Note: The CalculatedShippingRate container should only be used to specify values for the InternationalPackagingHandlingCosts, OriginatingPostalCode, 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 Fees a seller might assess for the shipping of the item (in addition to whatever the shipping service might charge). Any packaging/handling cost specified on input is added to each shipping service on output.

If domestic and international calculated shipping is offered for an item and if packaging/handling cost is specified only for domestic shipping, that cost will be applied by eBay as the international packaging/handling cost. (To specify a international packaging/handling cost, you must always specify a domestic packaging/handling cost, even if it is 0.) For international calculated shipping only.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ShippingDetails
  .CalculatedShippingRate
  .InternationalPackagingHandlingCosts
  [ attribute currencyID ]
CurrencyCodeType Always Fees a seller might assess for the shipping of the item (in addition to whatever the shipping service might charge). Any packaging/handling cost specified on input is added to each shipping service on output.

If domestic and international calculated shipping is offered for an item and if packaging/handling cost is specified only for domestic shipping, that cost will be applied by eBay as the international packaging/handling cost. (To specify a international packaging/handling cost, you must always specify a domestic packaging/handling cost, even if it is 0.) For international calculated shipping only.

For a list of possible enumeration values, see CurrencyCodeType.
TransactionArray.Transaction
  .ShippingDetails
  .CalculatedShippingRate
  .OriginatingPostalCode
string Conditionally Postal code for the location from which the package will be shipped. Required for calculated shipping. Use Item.PostalCode to specify the location of the item used for searches by location.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ShippingDetails
  .CalculatedShippingRate
  .PackagingHandlingCosts
AmountType (double) Conditionally Fees a seller might assess for the shipping of the item (in addition to whatever the shipping service might charge). Any packaging/handling cost specified on input is added to each shipping service on output.

If domestic and international calculated shipping is offered for an item and if packaging/handling cost is specified only for domestic shipping, that cost will be applied by eBay as the international packaging/handling cost. (To specify a international packaging/handling cost, you must always specify a domestic packaging/handling cost, even if it is 0.) When UPS is one of the shipping services offered by the seller, package dimensions are required on list/relist/revise. For calculated shipping only.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ShippingDetails
  .CalculatedShippingRate
  .PackagingHandlingCosts
  [ attribute currencyID ]
CurrencyCodeType Always Fees a seller might assess for the shipping of the item (in addition to whatever the shipping service might charge). Any packaging/handling cost specified on input is added to each shipping service on output.

If domestic and international calculated shipping is offered for an item and if packaging/handling cost is specified only for domestic shipping, that cost will be applied by eBay as the international packaging/handling cost. (To specify a international packaging/handling cost, you must always specify a domestic packaging/handling cost, even if it is 0.) When UPS is one of the shipping services offered by the seller, package dimensions are required on list/relist/revise. For calculated shipping only.

For a list of possible enumeration values, see CurrencyCodeType.
TransactionArray.Transaction
  .ShippingDetails
  .CalculatedShippingRate
  .ShippingIrregular
boolean Conditionally Note: The value for ShippingIrregular should now be specified in the ShippingPackageDetails container instead. If the ShippingIrregular field is passed in the CalculatedShippingRate container and in the ShippingPackageDetails container, the value in the ShippingPackageDetails container will take precedence. This field may be deprecated in the future.
This boolean field indicates that the shipping package is considered an irregular shape and/or size by the shipping carrier, and thus requires special handling. For calculated shipping only.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ShippingDetails
  .ChangePaymentInstructions
boolean Conditionally Whether the seller specified payment and shipping instructions during checkout (for example, to update the details of an order). Valid for flat and calculated shipping.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ShippingDetails.CODCost
AmountType (double) Conditionally This dollar value indicates the money due from the buyer upon delivery of the item.

This field should only be specified in the request if 'COD' (cash-on-delivery) is a valid payment method for the site and it is included as a PaymentMethods value in the same request.

This field is only returned if set for the listing.

To see if 'COD' is a supported payment method for a site, call GetCategoryFeatures, specifying the listing category ID, and including the FeatureID field set to PaymentMethods. Look for a value of 'CashOnPickup' in one of the Category.PaymentMethod fields in the response.

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

See Other Shipping Features.

TransactionArray.Transaction
  .ShippingDetails.CODCost
  [ attribute currencyID ]
CurrencyCodeType Always This dollar value indicates the money due from the buyer upon delivery of the item.

This field should only be specified in the request if 'COD' (cash-on-delivery) is a valid payment method for the site and it is included as a PaymentMethods value in the same request.

This field is only returned if set for the listing.

To see if 'COD' is a supported payment method for a site, call GetCategoryFeatures, specifying the listing category ID, and including the FeatureID field set to PaymentMethods. Look for a value of 'CashOnPickup' in one of the Category.PaymentMethod fields in the response.

For a list of possible enumeration values, see CurrencyCodeType.
TransactionArray.Transaction
  .ShippingDetails
  .ExcludeShipToLocation
string Conditionally,
repeatable: [0..*]
Use this field to specify an international country or region, or a special domestic location, such as 'PO Box' (in US) or 'Packstation' (in DE), to where you will not ship the associated item. Repeat this element in the call request for each location that you want to exclude as a shipping destination for your item.

Set ShipToRegistrationCountry to true to have your ExcludeShipToLocation settings applied to your listing. The locations you have excluded display in the Shipping and Handling section of your item listing.

If a buyer's primary ship-to location is a location that you have listed as an excluded ship-to location (or if the buyer does not have a primary ship-to location), they will receive an error message if they attempt to buy or place a bid on your item.

The exclude ship-to location values are eBay regions and countries. To see the valid exclude ship-to locations for a specified site, call GeteBayDetails with DetailName set to ExcludeShippingLocationDetails, and then look for the ExcludeShippingLocationDetails.Location fields in the response. Repeat GeteBayDetails for each site on which you list.

This field works in conjunction with Item.ShipToLocations to create a set of international countries and regions to where you will, and will not, ship. You can list a region in the ShipToLocations field, then exclude specific countries within that region with this field (for example, you can specify Africa in ShipToLocations, yet exclude Chad with a ExcludeShipToLocation setting). In addition, if your ShipToLocations is Worldwide, you can use this field to specify both regions and countries that you want to exclude from your shipping destinations.

You can specify a default set of locations to where you will not ship in My eBay. If you create an Exclude Ship-To List, it is, by default, in effect when you list items. However, if you specify any value in this field on input, it nullifies the default settings in your Exclude Ship-To List. (If you use ExcludeShipToLocation when you list an item, you will need to list all the locations to where you will not ship the associated item, regardless of the default settings in your Exclude Ship-To List.)

Specify none in this field to override the default Exclude Ship-To List you might have set up in My eBay and indicate that you do not want to exclude any shipping locations from the respective item listing.

Note: To enable your default Exclude Ship-To List, you must enable Exclude Shipping Locations and Buyer Requirements in your My eBay Site Preferences. For details, see the KnowledgeBase Article HowTo: ExcludeShipToLocation.

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

Applicable values: See CountryCodeType, ShippingRegionCodeType
TransactionArray.Transaction
  .ShippingDetails
  .InsuranceWanted
boolean Conditionally Whether or not the buyer selected to pay for insurance as an option offered by the seller. This only has a value after the buyer has gone through checkout and selected the insurance preference.

Valid only on the following sites: FR and IT

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ShippingDetails
  .InternationalShippingServiceOption
InternationalShippingServiceOptionsType Conditionally,
repeatable: [0..*]
Shipping costs and options related to an international shipping service. If used, at least one domestic shipping service must also be provided in ShippingServiceOptions.

If you specify multiple InternationalShippingServiceOption nodes, the repeating nodes must be contiguous. That is, you cannot insert other nodes between InternationalShippingServiceOption nodes.

All specified domestic and international shipping services must be the same shipping type (for example, Flat versus Calculated).

A seller can offer up to four domestic shipping services and up to five international shipping services. However, if the seller is opted in to the Global Shipping Program, only four other international shipping services may be offered (regardless of whether or not Global Shipping is offered for the listing).

If you specify ShippingDetails when you revise or relist an item but you omit InternationalShippingServiceOption, eBay will drop the international shipping services (except the Global Shipping Program) from the listing. This may also have unintended side effects, as other fields that depend on this data may be dropped as well. To retain the shipping services and dependent fields when you modify other shipping details, it may be simplest to specify all ShippingDetails that you still want to include in the listing.

For GetItemShipping, results are filtered: if any service is not available in the buyer's region, it is removed. If no services remain after this filtering, a warning is returned.

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

See Overview of the API Schema for rules regarding repeating instances of a nodes (nodes for which maxOccurs is "unbounded" or is greater than 1).

TransactionArray.Transaction
  .ShippingDetails
  .InternationalShippingServiceOption
  .ImportCharge
AmountType (double) Conditionally The total cost of customs and taxes for the international leg of an order shipped using the Global Shipping Program. This amount is calculated and supplied for each item by the international shipping provider when a buyer views the item properties.
Min: 0.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ShippingDetails
  .InternationalShippingServiceOption
  .ShippingInsuranceCost
AmountType (double) Conditionally The insurance cost associated with shipping a single item with this shipping service. Exception: for GetItemShipping, this is proportional to QuantitySold. If the item has not yet been sold, insurance information cannot be calculated and the value is 0.00. For calculated shipping only.

Valid only on the following sites: AU, FR, and IT

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

See Shipping.

TransactionArray.Transaction
  .ShippingDetails
  .InternationalShippingServiceOption
  .ShippingService
token Conditionally An international shipping service being offered by the seller to ship an item to a buyer. For a list of valid values, call GeteBayDetails with DetailName set to ShippingServiceDetails.

To view the full list of International shipping service options in the response, look for the ShippingService fields in the ShippingServiceDetails containers that contain a InternationalService = true field, as this indicates that the ShippingService value is an International shipping service option.

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.

For flat and calculated shipping.

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

See GeteBayDetails.



Applicable values: See ShippingServiceCodeType
TransactionArray.Transaction
  .ShippingDetails
  .InternationalShippingServiceOption
  .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
  .ShippingDetails
  .InternationalShippingServiceOption
  .ShippingServiceCost
AmountType (double) Conditionally The base cost of shipping the item using the shipping service specified in the ShippingService field. In the case of a multiple-quantity, fixed-price listing, the ShippingServiceAdditionalCost field shows the cost to ship each additional item if the buyer purchases multiple quantity of the same line item.

When returned by GetItemShipping, it includes the packaging and handling cost. For flat and calculated shipping.

If a shipping service has been specified (even LocalPickup), GetItem returns the shipping service cost, even if the cost is zero. Otherwise, cost is not returned.

If this is for calculated shipping for a listing that has not yet ended, note that the cost cannot be determined until the listing has ended and the buyer has specified a postal code.

For GetItemShipping, promotional shipping savings is reflected in the cost, if applicable. If the promotional shipping option is lower than other shipping services being offered, the savings is reflected in the returned shipping cost. The shipping service named Promotional Shipping Service (or whatever is the localized name for it) is included among the shipping services. If the promotional shipping cost is lower than the cost of other shipping services being offered, it is presented first in the list. (The LOWEST shipping service cost is always presented first, regardless of whether there is promotional shipping.)

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

See Shipping.

TransactionArray.Transaction
  .ShippingDetails
  .InternationalShippingServiceOption
  .ShippingServicePriority
int Conditionally This integer value controls the order (relative to other shipping services) in which the corresponding ShippingService will appear in the View Item and Checkout page. Sellers can specify up to five international shipping services (with five InternationalShippingServiceOption containers), so valid values are 1, 2, 3, 4, and 5. A shipping service with a ShippingServicePriority value of 1 appears at the top. Conversely, a shipping service with a ShippingServicePriority value of 5 appears at the bottom of a list of five shipping service options. If the Global Shipping Program is enabled on the listing for international shipping, only four additional shipping services may be specified.

This field is applicable to Flat and Calculated shipping.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ShippingDetails
  .InternationalShippingServiceOption
  .ShipToLocation
string Conditionally,
repeatable: [0..*]
An international location or region to where the item seller will ship the item.

Use GeteBayDetails with DetailName set to ShippingLocationDetails to determine which locations are valid per site. In the GeteBayDetails response, look for the ShippingLocationDetails.ShippingLocation fields.

For the AddItem family of calls, this field is required if any international shipping service is specified.

For GetOrders, GetOrderTransactions, and GetItemTransactions only: If using Trading WSDL Version 1019 or above, ShipToLocation fields 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, ShipToLocation fields are 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.

See Specifying Locations to Where You Ship.



Applicable values: See CountryCodeType, ShippingRegionCodeType
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
  .PaymentInstructions
string Conditionally Payment instructions (or message) from the seller to the buyer. These instructions appear on eBay's View Item page and on eBay's checkout page when the buyer pays for the item.

Sellers usually use this field to specify payment instructions, how soon the item will shipped, feedback instructions, and other reminders that the buyer should be aware of when they bid on or buy an item.

This field can be specified regardless of the shipping type eBay only allows 500 characters as input, but due to the way the eBay Web site UI treats characters, this field can return more than 500 characters in the response. Characters like & and ' (apostrophe/single quote) count as 5 characters each. Use DeletedField to remove this value when revising or relisting an item.

Applicable to eBay Motors (usually used to elaborate on the return policy).
Max length: 1000.

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

See:
    Offering a Clear Return Policy
    (AddItem) Item.AttributeSetArray
    (GetItem) Item.AttributeSetArray

TransactionArray.Transaction
  .ShippingDetails.SalesTax
SalesTaxType Conditionally Sales tax details. US and US Motors (site 0) sites only, excluding vehicle listings. Flat and calculated shipping.

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

See Enabling Multi-jurisdiction Sales Tax.

TransactionArray.Transaction
  .ShippingDetails.SalesTax
  .SalesTaxAmount
AmountType (double) Conditionally The amount of sales tax, calculated for an order based on the SalesTaxPercent and pricing information. US and US Motors (site 0) sites only, excluding vehicle listings.

GetItemTransactions can return incorrect sales tax if the name of a state is not abbreviated (e.g. if the value is "Illinois" rather than "IL") in TransactionArray.Transaction.Buyer.BuyerInfo.ShippingAddress.StateOrProvince. If the name of a state is not abbreviated, sales tax should be obtained by using the OrderLineItemID to call GetOrderTransactions.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ShippingDetails.SalesTax
  .SalesTaxAmount
  [ attribute currencyID ]
CurrencyCodeType Always The amount of sales tax, calculated for an order based on the SalesTaxPercent and pricing information. US and US Motors (site 0) sites only, excluding vehicle listings.

GetItemTransactions can return incorrect sales tax if the name of a state is not abbreviated (e.g. if the value is "Illinois" rather than "IL") in TransactionArray.Transaction.Buyer.BuyerInfo.ShippingAddress.StateOrProvince. If the name of a state is not abbreviated, sales tax should be obtained by using the OrderLineItemID to call GetOrderTransactions.

For a list of possible enumeration values, see CurrencyCodeType.
TransactionArray.Transaction
  .ShippingDetails.SalesTax
  .SalesTaxPercent
float Conditionally Percent of an item's price to be charged as the sales tax for the order. The value passed in is stored with a precision of 3 digits after the decimal point (##.###).

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ShippingDetails.SalesTax
  .SalesTaxState
string Conditionally State or jurisdiction for which the sales tax is being collected. Only returned if the seller specified a value.

To see the valid values for your site, call GeteBayDetails with DetailName set to TaxJurisdiction, and then look for the TaxJurisdiction.JurisdictionID fields in the response.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ShippingDetails.SalesTax
  .ShippingIncludedInTax
boolean Conditionally (US only) Whether shipping costs were part of the base amount that was taxed. Flat or calculated shipping.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ShippingDetails
  .SellingManagerSalesRecordNumber
int Conditionally The sale record ID. Applicable to Selling Manager users. When an item is sold, Selling Manager generates a sale record. A sale record contains buyer information, shipping, and other information. A sale record is displayed in the Sold view in Selling Manager. Each sale record has a sale record ID.

In the following calls, the value for the sale record ID is in the SellingManagerSalesRecordNumber field: GetItemTransactions, GetSellerTransactions, GetOrders, GetOrderTransactions. In the Selling Manager calls, the value for the sale record ID is in the SaleRecordID field.

For GetOrders, GetOrderTransactions, 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.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ShippingDetails
  .ShipmentTrackingDetails
ShipmentTrackingDetailsType Conditionally,
repeatable: [0..*]
Container for the shipping carrier and tracking information associated with the shipment of an order.

As each package has a unique tracking number, this container should be repeated for each package in the order.

Note: Top-rated sellers must have a record of uploading shipment tracking information (through site or through API) for at least 90 percent of their order line items (purchased by U.S. buyers) to keep their status as Top-rated sellers. For more information on eBay's Top-rated seller program, see the Becoming a Top Rated Seller and qualifying for Top Rated Plus page.


DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ShippingDetails
  .ShipmentTrackingDetails
  .ShipmentTrackingNumber
string Conditionally 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 format of the tracking number must be consistent with the format used by the specified shipping carrier (ShippingCarrierUsed). Typically, you should avoid spaces and hyphens. Returned only if set.

For GetOrders, GetOrderTransactions, 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 tracking number 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
  .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. However, as of release 961, ShippingCarrierCodeType contains the most current list of shipping carriers and the countries served by each carrier. The GeteBayDetails call is being updated to provide the same information more conveniently in an upcoming release. 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.

Returned only if set.

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

Applicable values: See ShippingCarrierCodeType
TransactionArray.Transaction
  .ShippingDetails
  .ShippingRateErrorMessage
string Conditionally For most applicable calls, returns the words No Error or returns an error message related to an attempt to calculate shipping rates. For calculated shipping only.

The message text explains that a postal code is needed to calculate shipping. Only returned when ItemDetails is set to Fine.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ShippingDetails
  .ShippingRateType
ShippingRateTypeCodeType Conditionally A shipping rate scale for shipping through USPS that affects the shipping cost calculated for USPS (lower if ShippingRateType is DailyPickup). ShippingRateType is returned only if the value of ShippingService is one of the USPS shipping services. For calculated shipping only.

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

TransactionArray.Transaction
  .ShippingDetails
  .ShippingServiceOptions
ShippingServiceOptionsType Conditionally,
repeatable: [0..*]
Shipping costs and options related to domestic shipping services offered by the seller. Flat and calculated shipping. Required if InternationalShippingServiceOption is specified.

For flat shipping, a maximum shipping cost may apply when listing. See Shipping documentation for details about Maximum Flat Rate Shipping Costs.

If you specify multiple ShippingServiceOptions nodes, the repeating nodes must be contiguous. For example, you can insert InternationalShippingServiceOption nodes after a list of repeating ShippingServiceOptions nodes, but not between them:

<ShippingServiceOptions>...</ShippingServiceOptions>
<ShippingServiceOptions>...</ShippingServiceOptions>
<ShippingServiceOptions>...</ShippingServiceOptions>
<InternationalShippingServiceOption>...</InternationalShippingServiceOption>
<InternationalShippingServiceOption>...</InternationalShippingServiceOption>


If you specify ShippingDetails when you revise or relist an item but you omit ShippingServiceOptions, eBay will drop the domestic shipping services from the listing. This may also have unintended side effects, as other fields that depend on this data may be dropped as well.

To retain the shipping services and dependent fields when you modify other shipping details, it may be simplest to specify all ShippingDetails that you still want to include in the listing.

A seller can offer up to four domestic shipping services and up to five international shipping services. However, if the seller is opted in to the Global Shipping Program, only four other international shipping services may be offered (regardless of whether or not Global Shipping is offered for the listing). All specified domestic and international shipping services must be the same shipping type (for example, Flat versus Calculated).

For GetItemShipping, results are filtered: if any service is not available in the buyer's region, it is removed. If no services remain after this filtering, a warning is returned.

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

See Overview of the API Schema for rules regarding repeating instances of a nodes (nodes for which maxOccurs is "unbounded" or is greater than 1).

TransactionArray.Transaction
  .ShippingDetails
  .ShippingServiceOptions
  .ExpeditedService
boolean Conditionally Indicates whether the service is an expedited shipping service.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ShippingDetails
  .ShippingServiceOptions
  .ImportCharge
AmountType (double) Conditionally The total cost of customs and taxes for the international leg of an order shipped using the Global Shipping Program. This amount is calculated and supplied for each item by the international shipping provider when a buyer views the item properties.
Min: 0.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ShippingDetails
  .ShippingServiceOptions
  .LogisticPlanType
string Conditionally Reserved for internal or future use.
TransactionArray.Transaction
  .ShippingDetails
  .ShippingServiceOptions
  .ShippingInsuranceCost
AmountType (double) Conditionally The insurance cost associated with shipping a single item with this shipping service.

Exception: For GetItemShipping, this is proportional to QuantitySold. If the item has not yet been sold, insurance information cannot be calculated and the value is 0.00. For calculated shipping only.

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

See Determining Shipping Costs for a Listing.

TransactionArray.Transaction
  .ShippingDetails
  .ShippingServiceOptions
  .ShippingPackageInfo
ShippingPackageInfoType Conditionally,
repeatable: [0..*]
This container is returned in order management calls.

If the order is being delivered through eBay Now, it contains information on the status of the order, the unique identifier of the store where the order is originating from, and the expected and actual delivery times.

For non-eBay Now orders, this container returns an estimated delivery window.

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

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

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

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

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

Applicable values: See ShippingTrackingEventCodeType
TransactionArray.Transaction
  .ShippingDetails
  .ShippingServiceOptions
  .ShippingPackageInfo.StoreID
string Conditionally The unique identifier of the store from where the order will be delivered.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ShippingDetails
  .ShippingServiceOptions
  .ShippingService
token Conditionally A shipping service option being offered by the seller to ship an item to a buyer. For a list of valid ShippingService values, 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.

For flat and calculated shipping.

If there are two or more services and one is "pickup", "pickup" must not be specified as the first service.

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

See GeteBayDetails.



Applicable values: See ShippingServiceCodeType
TransactionArray.Transaction
  .ShippingDetails
  .ShippingServiceOptions
  .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.

See Determining Shipping Costs for a Listing.

TransactionArray.Transaction
  .ShippingDetails
  .ShippingServiceOptions
  .ShippingServiceCost
AmountType (double) Conditionally The base cost of shipping the item using the shipping service specified in the ShippingService field. In the case of a multiple-quantity, fixed-price listing, the ShippingServiceAdditionalCost field shows the cost to ship each additional item if the buyer purchases multiple quantity of the same line item.

When returned by GetItemShipping, it includes the packaging and handling cost. For flat and calculated shipping.

If a shipping service has been specified (even LocalPickup), GetItem returns the shipping service cost, even if the cost is zero. Otherwise, cost is not returned.

If this is for calculated shipping for a listing that has not yet ended, note that the cost cannot be determined until the listing has ended and the buyer has specified a postal code.

For GetItemShipping, promotional shipping savings is reflected in the cost, if applicable.
  • If the promotional shipping option is lower than other shipping services being offered, the savings is reflected in the returned shipping cost. The shipping service named Promotional Shipping Service (or whatever is the localized name for it) is included among the shipping services.
  • If the promotional shipping cost is lower than the cost of other shipping services being offered, it is presented first in the list. (The LOWEST shipping service cost is always presented first, regardless of whether there is promotional shipping.)


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

See Determining Shipping Costs for a Listing.

TransactionArray.Transaction
  .ShippingDetails
  .ShippingServiceOptions
  .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.

This field is applicable to Flat and Calculated shipping.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ShippingDetails
  .ShippingServiceOptions
  .ShippingSurcharge
AmountType (double) Conditionally An additional fee to charge US buyers who have the item shipped via UPS or FedEx to Alaska, Hawaii or Puerto Rico. Can only be assigned a value for the eBay US site and for items in the Parts and Accessories category of the eBay Motors site. Only returned if set. If some line items in an order have a surcharge, surcharge is added only for those line items. Flat rate shipping only.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ShippingDetails
  .ShippingServiceOptions
  .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
  .ShippingDetails
  .ShippingServiceOptions
  .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
  .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..*]
Sales tax details for zero or more jurisdictions (states, provinces, etc).

For GetTaxTable: If DetailLevel is not specified, information is returned only for the jurisdictions for which the user provided tax information. If DetailLevel is ReturnAll, tax information is returned for all possible jurisdictions, whether specified by the user or not. ShippingIncludedInTax and SalesTaxPercent are returned, but are empty.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ShippingDetails.TaxTable
  .TaxJurisdiction
  .JurisdictionID
string Conditionally Representative identifier for the jurisdiction. Typically an abbreviation (for example, CA for California).

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ShippingDetails.TaxTable
  .TaxJurisdiction
  .SalesTaxPercent
float Conditionally The tax percent to apply for a listing shipped to this jurisdiction. The value passed in is stored with a precision of 3 digits after the decimal point (##.###).
For GetTaxTable: this tag has no value if the user's tax table has not been set.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ShippingDetails.TaxTable
  .TaxJurisdiction
  .ShippingIncludedInTax
boolean Conditionally Whether shipping costs are to be part of the base amount that is taxed.
For GetTaxTable: This tag is empty if the user did not previously provide information.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ShippingServiceSelected
ShippingServiceOptionsType Conditionally The shipping service selected by the buyer from the services offered by the seller.

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

See Shipping.

TransactionArray.Transaction
  .ShippingServiceSelected
  .ExpeditedService
boolean Conditionally Indicates whether the service is an expedited shipping service.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ShippingServiceSelected
  .ImportCharge
AmountType (double) Conditionally The total cost of customs and taxes for the international leg of an order shipped using the Global Shipping Program. This amount is calculated and supplied for each item by the international shipping provider when a buyer views the item properties.
Min: 0.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ShippingServiceSelected
  .LogisticPlanType
string Conditionally Reserved for internal or future use.
TransactionArray.Transaction
  .ShippingServiceSelected
  .ShippingInsuranceCost
AmountType (double) Conditionally The insurance cost associated with shipping a single item with this shipping service.

Exception: For GetItemShipping, this is proportional to QuantitySold. If the item has not yet been sold, insurance information cannot be calculated and the value is 0.00. For calculated shipping only.

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

See Determining Shipping Costs for a Listing.

TransactionArray.Transaction
  .ShippingServiceSelected
  .ShippingPackageInfo
ShippingPackageInfoType Conditionally,
repeatable: [0..*]
This container is returned in order management calls.

If the order is being delivered through eBay Now, it contains information on the status of the order, the unique identifier of the store where the order is originating from, and the expected and actual delivery times.

For non-eBay Now orders, this container returns an estimated delivery window.

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

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.

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.

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.

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.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ShippingServiceSelected
  .ShippingService
token Conditionally A shipping service option being offered by the seller to ship an item to a buyer. For a list of valid ShippingService values, 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.

For flat and calculated shipping.

If there are two or more services and one is "pickup", "pickup" must not be specified as the first service.

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

See GeteBayDetails.



Applicable values: See ShippingServiceCodeType
TransactionArray.Transaction
  .ShippingServiceSelected
  .ShippingServiceAdditionalCost
AmountType (double) Conditionally The cost of shipping each additional item 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.

See Determining Shipping Costs for a Listing.

TransactionArray.Transaction
  .ShippingServiceSelected
  .ShippingServiceCost
AmountType (double) Conditionally The base cost of shipping the item using the shipping service specified in the ShippingService field. In the case of a multiple-quantity, fixed-price listing, the ShippingServiceAdditionalCost field shows the cost to ship each additional item if the buyer purchases multiple quantity of the same line item.

When returned by GetItemShipping, it includes the packaging and handling cost. For flat and calculated shipping.

If a shipping service has been specified (even LocalPickup), GetItem returns the shipping service cost, even if the cost is zero. Otherwise, cost is not returned.

If this is for calculated shipping for a listing that has not yet ended, note that the cost cannot be determined until the listing has ended and the buyer has specified a postal code.

For GetItemShipping, promotional shipping savings is reflected in the cost, if applicable.
  • If the promotional shipping option is lower than other shipping services being offered, the savings is reflected in the returned shipping cost. The shipping service named Promotional Shipping Service (or whatever is the localized name for it) is included among the shipping services.
  • If the promotional shipping cost is lower than the cost of other shipping services being offered, it is presented first in the list. (The LOWEST shipping service cost is always presented first, regardless of whether there is promotional shipping.)


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

See Determining Shipping Costs for a Listing.

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.

This field is applicable to Flat and Calculated shipping.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ShippingServiceSelected
  .ShippingSurcharge
AmountType (double) Conditionally An additional fee to charge US buyers who have the item shipped via UPS or FedEx to Alaska, Hawaii or Puerto Rico. Can only be assigned a value for the eBay US site and for items in the Parts and Accessories category of the eBay Motors site. Only returned if set. If some line items in an order have a surcharge, surcharge is added only for those line items. Flat rate shipping only.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .ShippingServiceSelected
  .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 status details of an order line item, including payment information. Several of these fields change values during the checkout flow. See TransactionStatusType for its child elements.

For GetOrders, only the IntegratedMerchantCreditCardEnabled, and PaymentHoldStatus child elements are returned. 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.

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
(in/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 uses ReviseCheckoutStatus to change the checkout status to Pending. However, the eBayPaymentStatus value in GetOrders will change from NoPaymentFailure to PaymentInProcess.
CustomCode
(in/out) Reserved for internal or future use
Incomplete
(in/out) 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
(in/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 uses ReviseCheckoutStatus to change 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 success or failure of the buyer's online payment for an order. Applicable for the payment method that the buyer chose for the order. If the payment failed, the value returned indicates the reason for the failure. Output only.

Applicable values: See eBayPaymentStatus.
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
  .IntegratedMerchantCreditCardEnabled
boolean Conditionally Indicates whether the item can be paid for through a payment gateway account. If IntegratedMerchantCreditCardEnabled is true, then integrated merchant credit card (IMCC) is enabled for credit cards because the seller has a payment gateway (Payflow) account. Therefore, if IntegratedMerchantCreditCardEnabled is true, and AmEx, Discover, or VisaMC is returned for an item, then on checkout, an online credit-card payment is processed through a payment gateway account.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .Status.LastTimeModified
dateTime Conditionally Indicates date and time an order's status was last updated (in GMT).

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

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

See Holds on PayPal Payments.

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. If checkout is not yet complete, PaymentMethodUsed, which is returned by the GetItemTransactions call, is set to whatever the buyer selected as his or her preference on the Review Your Purchase page.

Applicable values: See PaymentMethodUsed.
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 sales tax information for an order line item. The Taxes container is only returned if the seller is using the Vertex-based Premium Sales Tax Engine solution. The information in this container supercedes/overrides the sales tax information in the ShippingDetails.SalesTax container.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .Taxes.TaxDetails
TaxDetailsType Conditionally,
repeatable: [0..*]
Container consisting of detailed sales tax information for an order line item, including the tax type and description, sales tax on the item cost, and sales tax related to shipping and handling.

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

Applicable values:

CustomCode
(out) Reserved for internal or future use.
SalesTax
(out) A standard sales tax charge.
WasteRecyclingFee
(out) A charge for an electronic waste recycling fee.

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 sales tax for the order line item for the corresponding impositiion (tax type).

TaxAmount = TaxOnSubtotalAmount + TaxOnShippingAmount + TaxOnHandlingAmount

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

TaxAmount = TaxOnSubtotalAmount + TaxOnShippingAmount + TaxOnHandlingAmount

For a list of possible enumeration values, see CurrencyCodeType.
TransactionArray.Transaction
  .Taxes.TaxDetails.TaxCode
string Conditionally This value is the actual tax ID for the buyer. This field will generally only be returned if a seller on the Italy or Spain sites required that the buyer supply a tax ID during the checkout process. If the Order.BuyerTaxIdentifier container is returned, the type of tax ID can be found in the BuyerTaxIdentifier.Type field.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .Taxes.TaxDetails
  .TaxDescription
TaxDescriptionCodeType Conditionally This field indicates the description of the sales tax.

Applicable values:

CustomCode
(out) Reserved for internal or future use.
ElectronicWasteRecyclingFee
(out) A charge for an electronic waste recycling fee.
SalesTax
(out) A standard sales tax charge.
TireRecyclingFee
(out) A charge for a tire recycling fee.

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, including the sales tax on the item, the sales tax on shipping and handling, and any electronic waste recycling fee.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .Taxes.TotalTaxAmount
  [ attribute currencyID ]
CurrencyCodeType Always This value indicates the total tax amount for the order line item, including the sales tax on the item, the sales tax on shipping and handling, and any electronic waste recycling fee.

For a list of possible enumeration values, see CurrencyCodeType.
TransactionArray.Transaction
  .TransactionID
string Always Unique identifier for an eBay order line item (transaction). An order line item is created once there is a commitment from a buyer to purchase an item. Since an auction listing can only have one order line item during the duration of the listing, the TransactionID for auction listings is always 0. Along with its corresponding ItemID, a TransactionID is used and referenced during an order checkout flow and after checkout has been completed.

For GetOrders, GetOrderTransactions, and GetItemTransactions only: If using Trading WSDL Version 1019 or above, this field will only be returned to the buyer, seller, or PayPal (if payment method is PayPal), and no longer returned at all to third parties (except for PayPal). If using a Trading WSDL older than Version 1019, transaction ID is only returned to the buyer, seller or PayPal, and a dummy value of 10000000000000 will be returned to all third parties (except for PayPal).
Max length: 19 (Note: The eBay database specifies 38. Transaction IDs are usually 9 to 12 digits.).

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .TransactionPrice
AmountType (double) Conditionally The price of the order line item. The amount in this field is subject to change based on the shipping service option that is selected by the buyer when the buyer pays. Before payment, the dollar value in this field will only reflect the price of the item. After payment, the dollar value in this field will reflect the price of the item plus shipping charges, and any applicable sales tax or handling charges. If multiple units were purchased through a non- variation, fixed-price listing, consider this value the per-unit price. In this case, to get the subtotal of the transaction, 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 price of the order line item. The amount in this field is subject to change based on the shipping service option that is selected by the buyer when the buyer pays. Before payment, the dollar value in this field will only reflect the price of the item. After payment, the dollar value in this field will reflect the price of the item plus shipping charges, and any applicable sales tax or handling charges. If multiple units were purchased through a non- variation, fixed-price listing, consider this value the per-unit price. In this case, to get the subtotal of the transaction, 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 order line item (transaction) was created.

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
  .UnpaidItem
UnpaidItemType Conditionally Container consisting of details related to the type and status of an Unpaid Item case. This container is only returned if there is an open or closed Unpaid Item case associated with the order line item.

DetailLevel: ReturnAll.
TransactionArray.Transaction
  .UnpaidItem.Status
UnpaidItemCaseStatusTypeCodeType Conditionally This field indicates the status of the Unpaid Item case. This field is always returned with the UnpaidItem container.

Applicable values:

ClosedWithoutPayment
(out) This value indicates that the Unpaid Item case is closed with no payment received from the buyer.
ClosedWithPayment
(out) This value indicates that the Unpaid Item case is closed with payment received from the buyer.
CustomCode
(out) This value is reserved for future or internal use.
Open
(out) This value indicates that the Unpaid Item case is open.

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

DetailLevel: ReturnAll.
TransactionArray.Transaction
  .UnpaidItem.Type
UnpaidItemCaseOpenTypeCodeType Conditionally This field indicates if the Unpaid Item case was opened manually by the customer or opened automatically by eBay's Unpaid Item Assistant feature. This field is always returned with the UnpaidItem container.

Applicable values:

Auto
(out) This value indicates that the Unpaid Item case was opened automatically through eBay's Unpaid Item Assistant feature.
CustomCode
(out) This value is reserved for future or internal use.
Manual
(out) This value indicates that the seller opened an Unpaid Item case manually through the Resolution Center or by using the Trading API's AddDispute call.

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

DetailLevel: ReturnAll.

See Using Unpaid Item Assistant for more information about managing the Unpaid Item Assistant feature.

TransactionArray.Transaction
  .Variation
VariationType Conditionally In a fixed-priced listing, a seller can offer variations of the same item. For example, the seller could create a fixed-priced listing for a t-shirt design and offer the shirt in different colors and sizes. In this case, each color and size combination is a separate variation. Each variation can have a different quantity and price. Due to the possible price differentiation, buyers can buy multiple items from this listing at the same time, but all of the items must be of the same variation. One order line item is created whether one or multiple items of the same variation are purchased.

The Variation node contains information about which variation was purchased. Therefore, applications that process orders should always check to see if this node is present.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .Variation.SKU
SKUType (string) Conditionally A SKU (stock keeping unit) is an identifier defined by a seller. It is only intended for the seller's use (not for buyers). Many sellers assign a SKU to an item of a specific type, size, and color. For the seller's convenience, eBay preserves the SKU on the variation, and also on corresponding order line items. This enables you (as a seller) use the SKU to reconcile your eBay inventory with your own inventory system instead of using the variation specifics. It is a good idea to track how many items of each type, size, and color are selling so that you can restock your shelves or update the variation quantity on eBay according to customer demand. (eBay does not use the SKU.)

If specified, all SKU values must be unique within the Variations node. That is, no two variations within the same listing can have the same SKU.

If you set Item.InventoryTrackingMethod to true, the variation SKU values are required and they must be unique across all the seller's active listings.

For GetItem and related calls: Only returned if the seller specified a SKU for the variation.
Max length: 80.

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

See Describing Variations in a Listing.

TransactionArray.Transaction
  .Variation.VariationSpecifics
NameValueListArrayType Conditionally,
repeatable: [2..5]
A list of name/value pairs that uniquely identify the variation within the listing. All variations must specify the same set of names, and each variation must provide a unique combination of values for those names. For example, if the items vary by color and size, then every variation must specify Color and Size as names, and no two variations can specify the same combination of color and size values.

When you revise a listing that includes variations, you can change names in variation specifics by using ModifyNameList. You can also add, delete, or replace individual variations as needed to match your current inventory. Use the Variation.Delete field to delete a variation that has no sales (order line items). If the variation has sales, then set the Quantity to 0.

For GetSellerEvents To keep the GetSellerEvents response smaller, variation specifics are not returned if the variation has a SKU. If the variation has no SKU, then variation specifics are returned instead. Optionally, you can pass IncludeVariationSpecifics as true in the request to force variation specifics to be returned, even when the SKU is returned.

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

See:
    Describing Variations in a Listing
    Revising and Relisting with Variations

TransactionArray.Transaction
  .Variation.VariationSpecifics
  .NameValueList
NameValueListType Conditionally,
repeatable: [0..*]
For the AddItem family of calls: Contains the name and value(s) for an Item Specific. Only required when the ItemSpecifics container is specified.

For the AddFixedPriceItem family of calls: The same NameValueList schema is used for the ItemSpecifics node, the VariationSpecifics node, and the VariationSpecifcsSet node.

If the listing has varations, any name that you use in the VariationSpecifics and VariationSpecificsSet nodes can't be used in the ItemSpecifics node.
When you list with Item Variations:
  • 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 more details, see Requiring Product Identifiers Mandate

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/Category/Variation Specific, a Parts Compatibility name, or a product identifier type.

For the AddItem and AddFixedPriceItem families of calls: In the ProductListingDetails.NameValueList (single-variation listing) and VariationProductListingDetails.NameValueList (multiple-variation listing) context, this value is the product identifier type, such as ISBN or UPC. Product identifier types that are supported/required for a specific category can be retrieved using the GetCategorySpecifics call.

For the AddItem and AddFixedPriceItem families of calls: In the Item.ItemSpecifics context, this can be any name that the seller wants to use. However, to help buyers find items more easily, it is a good idea to try to use a recommended name when possible (see GetCategorySpecifics). You can't specify the same name twice within the same listing.

For the AddFixedPriceItem family of calls: In the VariationSpecifics context, this can be any name that the seller wants to use, unless the VariationsEnabled flag is false for the name in the GetCategorySpecifics response. For example, for some categories eBay may recommend that you only use "Brand" as a shared name at the Item level, not in variations.

For 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 GetCategorySpecifics: This is a recommended (popular) name to use for items in the specified category (e.g., "Brand" might be recommended, not "Manufacturer").

For PlaceOffer: Required if the item being purchased includes Item Variations.

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.VariationSpecifics
  .NameValueList.Value
string Conditionally,
repeatable: [0..*]
Depending on the call and context, this value is either the value of an Item/Category/Variation Specific, a Parts Compatibility value, or a product identifier.

For the AddItem family of calls: If you specify multiple values for Item Specifics, eBay only stores the first one, unless GetCategorySpecifics indicates that the corresponding name supports multiple values.

For the AddItem and AddFixedPriceItem families of calls: In the ProductListingDetails.NameValueList (single-variation listing) and VariationProductListingDetails.NameValueList (multiple-variation listing) context, this value is the product identifier, such as ISBN or UPC. Product identifier types that are supported/required for a specific category can be retrieved using the GetCategorySpecifics call.

For the AddFixedPriceItem family of calls: If you specify multiple values for Item Specifics or Variation Specifics, eBay only stores the first one, unless GetCategorySpecifics indicates that the corresponding name supports multiple values.

In VariationSpecificSet, you typically specify multiple Value fields for each name. For example, if Name = Size, you would specify all size values that you wan to offer in the listing.

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

For GetCategorySpecifics: The most highly recommended values are returned first. For these calls, Value is only returned when recommended values are available.

For PlaceOffer: Required if the item being purchased includes Item Variations.


Max length: 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 the VariationSpecifics. For example, if the Title is "Polo Shirt" and the variation is for a medium pink shirt, the variation title could be "Polo Shirt[Pink,M]. PayPal may also use this value to identify item variations(for buyers and sellers).

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionArray.Transaction
  .Variation
  .VariationViewItemURL
anyURI Conditionally URL for the variation on eBay. This links to eBay's View Item page, with the page configured to show details of the specified variation. The syntax of this URL is similar to Item.ViewItemURL (not optimized for natural search).

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
TransactionsPerPage int Always Number of order line items (transactions) returned per page (per call). May be a higher value than ReturnedTransactionCountActual if the page returned is the last page and more than one page of data exists.

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.

See Error Handling.

Errors.ErrorClassification ErrorClassificationCodeType Conditionally API errors are divided between two classes: system errors and request errors.

Applicable values:

CustomCode
(out) Reserved for internal or future use.
RequestError
(out) An error has occurred either as a result of a problem in the sending application or because the application's end-user has attempted to submit invalid data (or missing data). In these cases, do not retry the request. The problem must be corrected before the request can be made again. If the problem is due to something in the application (such as a missing required field), the application must be changed. If the problem is a result of end-user data, the application must alert the end-user to the problem and provide the means for the end-user to correct the data. Once the problem in the application or data is resolved, resend the request to eBay with the corrected data.
SystemError
(out) Indicates that an error has occurred on the eBay system side, such as a database or server down. An application can retry the request as-is a reasonable number of times (eBay recommends twice). If the error persists, contact Developer Technical Support. Once the problem has been resolved, the request may be resent in its original form.

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 the "Errors by Number" document.
Errors.ErrorParameters ErrorParameterType Conditionally,
repeatable: [0..*]
This optional element carries a list of context-specific error variables that indicate details about the error condition. These are useful when multiple instances of ErrorType are returned.
Errors.ErrorParameters
  [ attribute ParamID ]
string Conditionally This optional element carries a list of context-specific error variables that indicate details about the error condition. These are useful when multiple instances of ErrorType are returned.
Errors.ErrorParameters.Value string Conditionally 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 Compatible Application Check section of the eBay Features Guide for more information.
Warning
(out) The request was processed successfully, but something occurred that may affect your application or the user. For example, eBay may have changed a value the user sent in. In this case, eBay returns a normal, successful response and also returns the warning.

When a warning occurs, the error is returned in addition to the business data. In this case, you do not need to retry the request (as the original request was successful). However, depending on the cause or nature of the warning, you might need to contact either the end user or eBay to effect a long term solution to the problem to prevent it from reoccurring in the future.

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
ItemYYY
Item.ApplicationData(Y)(Y)(Y)
Item.AutoPayYYY
Item.BuyerProtection(Y)(Y)(Y)
Item.BuyItNowPrice--(Y)
Item.Charity(Y)(Y)(Y)
Item.Charity.CharityListing(Y)(Y)(Y)
Item.CurrencyYYY
Item.IntegratedMerchantCreditCardEnabledY-Y
Item.InventoryTrackingMethod(Y)-(Y)
Item.ItemIDYYY
Item.ListingDetails--(Y)
Item.ListingDetails.Adult--(Y)
Item.ListingDetails.BindingAuction--(Y)
Item.ListingDetails.CheckoutEnabled--(Y)
Item.ListingDetails.ConvertedBuyItNowPrice--(Y)
Item.ListingDetails.ConvertedReservePrice--(Y)
Item.ListingDetails.ConvertedStartPrice--(Y)
Item.ListingDetails.EndTime--(Y)
Item.ListingDetails.HasPublicMessages--(Y)
Item.ListingDetails.HasReservePrice--(Y)
Item.ListingDetails.HasUnansweredQuestions--(Y)
Item.ListingDetails.MinimumBestOfferPrice--(Y)
Item.ListingDetails.RelistedItemID--(Y)
Item.ListingDetails.StartTime--(Y)
Item.ListingDetails.TCROriginalItemID--(Y)
Item.ListingDetails.ViewItemURL--(Y)
Item.ListingDetails.ViewItemURLForNaturalSearch--(Y)
Item.ListingTypeYYY
Item.LotSize--(Y)
Item.PaymentMethodsY-Y
Item.PrivateListingYYY
Item.Quantity--Y
Item.Seller(Y)-(Y)
Item.Seller.AboutMePageY-Y
Item.Seller.eBayGoodStandingY-Y
Item.Seller.EIASTokenY-Y
Item.Seller.EmailY-Y
Item.Seller.FeedbackPrivateY-Y
Item.Seller.FeedbackRatingStarY-Y
Item.Seller.FeedbackScoreY-Y
Item.Seller.IDVerifiedY-Y
Item.Seller.NewUserY-Y
Item.Seller.PositiveFeedbackPercent(Y)-(Y)
Item.Seller.RegistrationDateY-Y
Item.Seller.SellerInfoY-Y
Item.Seller.SellerInfo.AllowPaymentEditY-Y
Item.Seller.SellerInfo.CheckoutEnabledY-Y
Item.Seller.SellerInfo.CIPBankAccountStoredY-Y
Item.Seller.SellerInfo.GoodStandingY-Y
Item.Seller.SellerInfo.QualifiesForB2BVATY-Y
Item.Seller.SellerInfo.SafePaymentExemptYYY
Item.Seller.SellerInfo.SellerLevelY-Y
Item.Seller.SellerInfo.StoreOwnerY-Y
Item.Seller.SellerInfo.StoreURLY-Y
Item.Seller.SellerInfo.TopRatedSeller(Y)-(Y)
Item.Seller.SiteY-Y
Item.Seller.StatusY-Y
Item.Seller.UserFirstName(Y)-(Y)
Item.Seller.UserIDY-Y
Item.Seller.UserIDChangedY-Y
Item.Seller.UserIDLastChangedY-Y
Item.Seller.UserLastName(Y)-(Y)
Item.Seller.VATStatusY-Y
Item.SellingStatusY-Y
Item.SellingStatus.BidCount(Y)(Y)(Y)
Item.SellingStatus.ConvertedCurrentPrice(Y)(Y)(Y)
Item.SellingStatus.CurrentPriceYYY
Item.SellingStatus.FinalValueFee(Y)(Y)(Y)
Item.SellingStatus.ListingStatusYYY
Item.SellingStatus.QuantitySoldYYY
Item.Site--(Y)
Item.SKU(Y)-(Y)
Item.StartPrice--(Y)
Item.Title--(Y)
Item.Variations(Y)(Y)(Y)
Item.Variations.Variation(Y)(Y)(Y)
Item.Variations.Variation.Quantity(Y)(Y)(Y)
Item.Variations.Variation.SellingStatus(Y)(Y)(Y)
Item.Variations.Variation.SellingStatus.QuantitySoldYYY
Item.Variations.Variation.SKU(Y)(Y)(Y)
Item.Variations.Variation.StartPrice(Y)(Y)(Y)
Item.Variations.Variation.VariationSpecifics(Y)(Y)(Y)
Item.Variations.Variation.VariationSpecifics.NameValueList(Y)(Y)(Y)
Item.Variations.Variation.VariationSpecifics.NameValueList.Name(Y)(Y)(Y)
Item.Variations.Variation.VariationSpecifics.NameValueList.Value(Y)(Y)(Y)
PageNumberYYY
PaginationResultYYY
PaginationResult.TotalNumberOfEntriesYYY
PaginationResult.TotalNumberOfPagesYYY
PayPalPreferredYYY
ReturnedTransactionCountActualYYY
TransactionArray(Y)(Y)(Y)
TransactionArray.Transaction(Y)-(Y)
TransactionArray.Transaction.ActualHandlingCost(Y)(Y)(Y)
TransactionArray.Transaction.ActualShippingCost(Y)(Y)(Y)
TransactionArray.Transaction.AdjustmentAmount(Y)(Y)(Y)
TransactionArray.Transaction.AmountPaid(Y)(Y)(Y)
TransactionArray.Transaction.BestOfferSale(Y)(Y)(Y)
TransactionArray.Transaction.Buyer(Y)-(Y)
TransactionArray.Transaction.Buyer.AboutMePage(Y)-(Y)
TransactionArray.Transaction.Buyer.BuyerInfo(Y)-(Y)
TransactionArray.Transaction.Buyer.BuyerInfo.BuyerTaxIdentifier(Y)-(Y)
TransactionArray.Transaction.Buyer.BuyerInfo.BuyerTaxIdentifier
  .Attribute
(Y)(Y)(Y)
TransactionArray.Transaction.Buyer.BuyerInfo.BuyerTaxIdentifier
  .ID
(Y)-(Y)
TransactionArray.Transaction.Buyer.BuyerInfo.BuyerTaxIdentifier
  .Type
(Y)(Y)(Y)
TransactionArray.Transaction.Buyer.BuyerInfo.ShippingAddress(Y)-(Y)
TransactionArray.Transaction.Buyer.BuyerInfo.ShippingAddress
  .AddressAttribute
(Y)-(Y)
TransactionArray.Transaction.Buyer.BuyerInfo.ShippingAddress
  .AddressID
(Y)-(Y)
TransactionArray.Transaction.Buyer.BuyerInfo.ShippingAddress
  .AddressUsage
(Y)-(Y)
TransactionArray.Transaction.Buyer.BuyerInfo.ShippingAddress
  .CityName
(Y)-(Y)
TransactionArray.Transaction.Buyer.BuyerInfo.ShippingAddress
  .Country
(Y)-(Y)
TransactionArray.Transaction.Buyer.BuyerInfo.ShippingAddress
  .CountryName
(Y)-(Y)
TransactionArray.Transaction.Buyer.BuyerInfo.ShippingAddress
  .ExternalAddressID
(Y)-(Y)
TransactionArray.Transaction.Buyer.BuyerInfo.ShippingAddress.Name(Y)-(Y)
TransactionArray.Transaction.Buyer.BuyerInfo.ShippingAddress
  .Phone
(Y)-(Y)
TransactionArray.Transaction.Buyer.BuyerInfo.ShippingAddress
  .PostalCode
(Y)-(Y)
TransactionArray.Transaction.Buyer.BuyerInfo.ShippingAddress
  .StateOrProvince
(Y)-(Y)
TransactionArray.Transaction.Buyer.BuyerInfo.ShippingAddress
  .Street
(Y)-(Y)
TransactionArray.Transaction.Buyer.BuyerInfo.ShippingAddress
  .Street1
(Y)-(Y)
TransactionArray.Transaction.Buyer.BuyerInfo.ShippingAddress
  .Street2
(Y)-(Y)
TransactionArray.Transaction.Buyer.eBayGoodStanding(Y)-(Y)
TransactionArray.Transaction.Buyer.EIASToken(Y)-(Y)
TransactionArray.Transaction.Buyer.Email(Y)-(Y)
TransactionArray.Transaction.Buyer.FeedbackPrivate(Y)-(Y)
TransactionArray.Transaction.Buyer.FeedbackRatingStar(Y)-(Y)
TransactionArray.Transaction.Buyer.FeedbackScore(Y)-(Y)
TransactionArray.Transaction.Buyer.IDVerified(Y)-(Y)
TransactionArray.Transaction.Buyer.NewUserY-Y
TransactionArray.Transaction.Buyer.PositiveFeedbackPercent(Y)-(Y)
TransactionArray.Transaction.Buyer.RegistrationDate(Y)-(Y)
TransactionArray.Transaction.Buyer.Site(Y)-(Y)
TransactionArray.Transaction.Buyer.StaticAlias(Y)-(Y)
TransactionArray.Transaction.Buyer.Status(Y)-(Y)
TransactionArray.Transaction.Buyer.UserFirstName(Y)-(Y)
TransactionArray.Transaction.Buyer.UserID(Y)-(Y)
TransactionArray.Transaction.Buyer.UserIDChanged(Y)-(Y)
TransactionArray.Transaction.Buyer.UserIDLastChanged(Y)-(Y)
TransactionArray.Transaction.Buyer.UserLastName(Y)-(Y)
TransactionArray.Transaction.Buyer.VATStatus(Y)-(Y)
TransactionArray.Transaction.BuyerCheckoutMessage(Y)(Y)(Y)
TransactionArray.Transaction.BuyerGuaranteePrice(Y)(Y)(Y)
TransactionArray.Transaction.BuyerPackageEnclosures(Y)(Y)(Y)
TransactionArray.Transaction.BuyerPackageEnclosures
  .BuyerPackageEnclosure
(Y)(Y)(Y)
TransactionArray.Transaction.CartID(Y)(Y)(Y)
TransactionArray.Transaction.ContainingOrder(Y)-(Y)
TransactionArray.Transaction.ContainingOrder
  .BuyerPackageEnclosures
(Y)-(Y)
TransactionArray.Transaction.ContainingOrder
  .BuyerPackageEnclosures.BuyerPackageEnclosure
(Y)(Y)(Y)
TransactionArray.Transaction.ContainingOrder.BuyerTaxIdentifier(Y)-(Y)
TransactionArray.Transaction.ContainingOrder.BuyerTaxIdentifier
  .Attribute
(Y)(Y)(Y)
TransactionArray.Transaction.ContainingOrder.BuyerTaxIdentifier
  .ID
(Y)-(Y)
TransactionArray.Transaction.ContainingOrder.BuyerTaxIdentifier
  .Type
(Y)(Y)(Y)
TransactionArray.Transaction.ContainingOrder.CancelDetail(Y)(Y)(Y)
TransactionArray.Transaction.ContainingOrder.CancelDetail
  .CancelCompleteDate
(Y)(Y)(Y)
TransactionArray.Transaction.ContainingOrder.CancelDetail
  .CancelIntiationDate
(Y)(Y)(Y)
TransactionArray.Transaction.ContainingOrder.CancelDetail
  .CancelIntiator
(Y)(Y)(Y)
TransactionArray.Transaction.ContainingOrder.CancelDetail
  .CancelReason
(Y)(Y)(Y)
TransactionArray.Transaction.ContainingOrder.CancelDetail
  .CancelReasonDetails
(Y)(Y)(Y)
TransactionArray.Transaction.ContainingOrder.CancelReason(Y)(Y)(Y)
TransactionArray.Transaction.ContainingOrder.CancelReasonDetails(Y)(Y)(Y)
TransactionArray.Transaction.ContainingOrder.CancelStatus(Y)(Y)(Y)
TransactionArray.Transaction.ContainingOrder
  .ContainseBayPlusTransaction
(Y)(Y)(Y)
TransactionArray.Transaction.ContainingOrder.CreatingUserRole(Y)(Y)(Y)
TransactionArray.Transaction.ContainingOrder.ExtendedOrderID(Y)(Y)(Y)
TransactionArray.Transaction.ContainingOrder
  .IntegratedMerchantCreditCardEnabled
(Y)-(Y)
TransactionArray.Transaction.ContainingOrder.IsMultiLegShipping(Y)-(Y)
TransactionArray.Transaction.ContainingOrder.LogisticsPlanType(Y)-(Y)
TransactionArray.Transaction.ContainingOrder.MonetaryDetails--(Y)
TransactionArray.Transaction.ContainingOrder.MonetaryDetails
  .Payments
(Y)-(Y)
TransactionArray.Transaction.ContainingOrder.MonetaryDetails
  .Payments.Payment
(Y)-(Y)
TransactionArray.Transaction.ContainingOrder.MonetaryDetails
  .Payments.Payment.FeeOrCreditAmount
(Y)-(Y)
TransactionArray.Transaction.ContainingOrder.MonetaryDetails
  .Payments.Payment.Payee
(Y)-(Y)
TransactionArray.Transaction.ContainingOrder.MonetaryDetails
  .Payments.Payment.Payer
(Y)-(Y)
TransactionArray.Transaction.ContainingOrder.MonetaryDetails
  .Payments.Payment.PaymentAmount
(Y)-(Y)
TransactionArray.Transaction.ContainingOrder.MonetaryDetails
  .Payments.Payment.PaymentReferenceID
(Y)-(Y)
TransactionArray.Transaction.ContainingOrder.MonetaryDetails
  .Payments.Payment.PaymentStatus
(Y)-(Y)
TransactionArray.Transaction.ContainingOrder.MonetaryDetails
  .Payments.Payment.PaymentTime
(Y)-(Y)
TransactionArray.Transaction.ContainingOrder.MonetaryDetails
  .Payments.Payment.ReferenceID
(Y)-(Y)
TransactionArray.Transaction.ContainingOrder.MonetaryDetails
  .Refunds
(Y)-(Y)
TransactionArray.Transaction.ContainingOrder.MonetaryDetails
  .Refunds.Refund
(Y)-(Y)
TransactionArray.Transaction.ContainingOrder.MonetaryDetails
  .Refunds.Refund.FeeOrCreditAmount
(Y)-(Y)
TransactionArray.Transaction.ContainingOrder.MonetaryDetails
  .Refunds.Refund.ReferenceID
(Y)-(Y)
TransactionArray.Transaction.ContainingOrder.MonetaryDetails
  .Refunds.Refund.RefundAmount
(Y)-(Y)
TransactionArray.Transaction.ContainingOrder.MonetaryDetails
  .Refunds.Refund.RefundStatus
(Y)-(Y)
TransactionArray.Transaction.ContainingOrder.MonetaryDetails
  .Refunds.Refund.RefundTime
(Y)-(Y)
TransactionArray.Transaction.ContainingOrder.MonetaryDetails
  .Refunds.Refund.RefundTo
(Y)-(Y)
TransactionArray.Transaction.ContainingOrder.MonetaryDetails
  .Refunds.Refund.RefundType
(Y)-(Y)
TransactionArray.Transaction.ContainingOrder
  .MultiLegShippingDetails
(Y)-(Y)
TransactionArray.Transaction.ContainingOrder
  .MultiLegShippingDetails.SellerShipmentToLogisticsProvider
(Y)-(Y)
TransactionArray.Transaction.ContainingOrder
  .MultiLegShippingDetails.SellerShipmentToLogisticsProvider
  .ShippingServiceDetails
(Y)-(Y)
TransactionArray.Transaction.ContainingOrder
  .MultiLegShippingDetails.SellerShipmentToLogisticsProvider
  .ShippingServiceDetails.ShippingService
(Y)-(Y)
TransactionArray.Transaction.ContainingOrder
  .MultiLegShippingDetails.SellerShipmentToLogisticsProvider
  .ShippingServiceDetails.TotalShippingCost
(Y)-(Y)
TransactionArray.Transaction.ContainingOrder
  .MultiLegShippingDetails.SellerShipmentToLogisticsProvider
  .ShippingTimeMax
(Y)-(Y)
TransactionArray.Transaction.ContainingOrder
  .MultiLegShippingDetails.SellerShipmentToLogisticsProvider
  .ShippingTimeMin
(Y)-(Y)
TransactionArray.Transaction.ContainingOrder
  .MultiLegShippingDetails.SellerShipmentToLogisticsProvider
  .ShipToAddress
(Y)-(Y)
TransactionArray.Transaction.ContainingOrder
  .MultiLegShippingDetails.SellerShipmentToLogisticsProvider
  .ShipToAddress.AddressAttribute
(Y)-(Y)
TransactionArray.Transaction.ContainingOrder
  .MultiLegShippingDetails.SellerShipmentToLogisticsProvider
  .ShipToAddress.AddressID
(Y)-(Y)
TransactionArray.Transaction.ContainingOrder
  .MultiLegShippingDetails.SellerShipmentToLogisticsProvider
  .ShipToAddress.AddressOwner
(Y)-(Y)
TransactionArray.Transaction.ContainingOrder
  .MultiLegShippingDetails.SellerShipmentToLogisticsProvider
  .ShipToAddress.AddressUsage
(Y)-(Y)
TransactionArray.Transaction.ContainingOrder
  .MultiLegShippingDetails.SellerShipmentToLogisticsProvider
  .ShipToAddress.CityName
(Y)-(Y)
TransactionArray.Transaction.ContainingOrder
  .MultiLegShippingDetails.SellerShipmentToLogisticsProvider
  .ShipToAddress.Country
(Y)-(Y)
TransactionArray.Transaction.ContainingOrder
  .MultiLegShippingDetails.SellerShipmentToLogisticsProvider
  .ShipToAddress.CountryName
(Y)-(Y)
TransactionArray.Transaction.ContainingOrder
  .MultiLegShippingDetails.SellerShipmentToLogisticsProvider
  .ShipToAddress.ExternalAddressID
(Y)-(Y)
TransactionArray.Transaction.ContainingOrder
  .MultiLegShippingDetails.SellerShipmentToLogisticsProvider
  .ShipToAddress.Name
(Y)-(Y)
TransactionArray.Transaction.ContainingOrder
  .MultiLegShippingDetails.SellerShipmentToLogisticsProvider
  .ShipToAddress.Phone
(Y)-(Y)
TransactionArray.Transaction.ContainingOrder
  .MultiLegShippingDetails.SellerShipmentToLogisticsProvider
  .ShipToAddress.PostalCode
(Y)-(Y)
TransactionArray.Transaction.ContainingOrder
  .MultiLegShippingDetails.SellerShipmentToLogisticsProvider
  .ShipToAddress.ReferenceID
(Y)-(Y)
TransactionArray.Transaction.ContainingOrder
  .MultiLegShippingDetails.SellerShipmentToLogisticsProvider
  .ShipToAddress.StateOrProvince
(Y)-(Y)
TransactionArray.Transaction.ContainingOrder
  .MultiLegShippingDetails.SellerShipmentToLogisticsProvider
  .ShipToAddress.Street1
(Y)-(Y)
TransactionArray.Transaction.ContainingOrder
  .MultiLegShippingDetails.SellerShipmentToLogisticsProvider
  .ShipToAddress.Street2
(Y)-(Y)
TransactionArray.Transaction.ContainingOrder.OrderID(Y)-(Y)
TransactionArray.Transaction.ContainingOrder.OrderStatus(Y)-(Y)
TransactionArray.Transaction.ContainingOrder.PaymentHoldDetails(Y)-(Y)
TransactionArray.Transaction.ContainingOrder.PaymentHoldDetails
  .ExpectedReleaseDate
(Y)(Y)(Y)
TransactionArray.Transaction.ContainingOrder.PaymentHoldDetails
  .NumOfReqSellerActions
(Y)(Y)(Y)
TransactionArray.Transaction.ContainingOrder.PaymentHoldDetails
  .PaymentHoldReason
(Y)(Y)(Y)
TransactionArray.Transaction.ContainingOrder.PaymentHoldDetails
  .RequiredSellerActionArray
(Y)(Y)(Y)
TransactionArray.Transaction.ContainingOrder.PaymentHoldDetails
  .RequiredSellerActionArray.RequiredSellerAction
(Y)(Y)(Y)
TransactionArray.Transaction.ContainingOrder.PaymentHoldStatus(Y)-(Y)
TransactionArray.Transaction.ContainingOrder
  .ShippingConvenienceCharge
(Y)(Y)(Y)
TransactionArray.Transaction.ConvertedAdjustmentAmount(Y)(Y)(Y)
TransactionArray.Transaction.ConvertedAmountPaid(Y)(Y)(Y)
TransactionArray.Transaction.ConvertedTransactionPrice(Y)(Y)(Y)
TransactionArray.Transaction.CreatedDate(Y)(Y)(Y)
TransactionArray.Transaction.DepositType(Y)(Y)(Y)
TransactionArray.Transaction.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.ExtendedOrderID(Y)(Y)(Y)
TransactionArray.Transaction.ExternalTransaction--(Y)
TransactionArray.Transaction.ExternalTransaction
  .ExternalTransactionID
--(Y)
TransactionArray.Transaction.ExternalTransaction
  .ExternalTransactionStatus
--(Y)
TransactionArray.Transaction.ExternalTransaction
  .ExternalTransactionTime
--(Y)
TransactionArray.Transaction.ExternalTransaction
  .FeeOrCreditAmount
--(Y)
TransactionArray.Transaction.ExternalTransaction
  .PaymentOrRefundAmount
--(Y)
TransactionArray.Transaction.FinalValueFee(Y)(Y)(Y)
TransactionArray.Transaction.GiftSummary(Y)(Y)(Y)
TransactionArray.Transaction.GiftSummary.Message(Y)-(Y)
TransactionArray.Transaction.GuaranteedDeliveryYYY
TransactionArray.Transaction.GuaranteedShipping(Y)(Y)(Y)
TransactionArray.Transaction.IntangibleItem(Y)(Y)(Y)
TransactionArray.Transaction.InventoryReservationID(Y)-(Y)
TransactionArray.Transaction.InvoiceSentTime--(Y)
TransactionArray.Transaction.IsMultiLegShipping(Y)(Y)(Y)
TransactionArray.Transaction.ListingCheckoutRedirectPreference(Y)(Y)(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
  .PaymentStatus
(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
  .RefundStatus
(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.AddressAttribute
(Y)-(Y)
TransactionArray.Transaction.MultiLegShippingDetails
  .SellerShipmentToLogisticsProvider.ShipToAddress.AddressID
(Y)-(Y)
TransactionArray.Transaction.MultiLegShippingDetails
  .SellerShipmentToLogisticsProvider.ShipToAddress.AddressOwner
(Y)-(Y)
TransactionArray.Transaction.MultiLegShippingDetails
  .SellerShipmentToLogisticsProvider.ShipToAddress.AddressUsage
(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
  .ExternalAddressID
(Y)-(Y)
TransactionArray.Transaction.MultiLegShippingDetails
  .SellerShipmentToLogisticsProvider.ShipToAddress.Name
(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.PaymentHoldDetails--(Y)
TransactionArray.Transaction.PaymentHoldDetails
  .ExpectedReleaseDate
(Y)(Y)(Y)
TransactionArray.Transaction.PaymentHoldDetails
  .NumOfReqSellerActions
(Y)(Y)(Y)
TransactionArray.Transaction.PaymentHoldDetails.PaymentHoldReason(Y)(Y)(Y)
TransactionArray.Transaction.PaymentHoldDetails
  .RequiredSellerActionArray
(Y)(Y)(Y)
TransactionArray.Transaction.PaymentHoldDetails
  .RequiredSellerActionArray.RequiredSellerAction
(Y)(Y)(Y)
TransactionArray.Transaction.PayPalEmailAddress(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.QuantityPurchased(Y)(Y)(Y)
TransactionArray.Transaction.SellerContactBuyerByEmail(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.SellingManagerProductDetails(Y)(Y)(Y)
TransactionArray.Transaction.ShippedTime(Y)(Y)(Y)
TransactionArray.Transaction.ShippingConvenienceCharge(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.OriginatingPostalCode
(Y)-(Y)
TransactionArray.Transaction.ShippingDetails
  .CalculatedShippingRate.PackagingHandlingCosts
(Y)-(Y)
TransactionArray.Transaction.ShippingDetails
  .CalculatedShippingRate.ShippingIrregular
(Y)-(Y)
TransactionArray.Transaction.ShippingDetails
  .ChangePaymentInstructions
(Y)(Y)(Y)
TransactionArray.Transaction.ShippingDetails.CODCost(Y)(Y)(Y)
TransactionArray.Transaction.ShippingDetails
  .ExcludeShipToLocation
(Y)(Y)(Y)
TransactionArray.Transaction.ShippingDetails.InsuranceWanted(Y)(Y)(Y)
TransactionArray.Transaction.ShippingDetails
  .InternationalShippingServiceOption
(Y)-(Y)
TransactionArray.Transaction.ShippingDetails
  .InternationalShippingServiceOption.ImportCharge
(Y)-(Y)
TransactionArray.Transaction.ShippingDetails
  .InternationalShippingServiceOption.ShippingInsuranceCost
(Y)-(Y)
TransactionArray.Transaction.ShippingDetails
  .InternationalShippingServiceOption.ShippingService
(Y)-(Y)
TransactionArray.Transaction.ShippingDetails
  .InternationalShippingServiceOption.ShippingServiceAdditionalCost
(Y)-(Y)
TransactionArray.Transaction.ShippingDetails
  .InternationalShippingServiceOption.ShippingServiceCost
(Y)-(Y)
TransactionArray.Transaction.ShippingDetails
  .InternationalShippingServiceOption.ShippingServicePriority
(Y)-(Y)
TransactionArray.Transaction.ShippingDetails
  .InternationalShippingServiceOption.ShipToLocation
(Y)-(Y)
TransactionArray.Transaction.ShippingDetails.PaymentEdited(Y)(Y)(Y)
TransactionArray.Transaction.ShippingDetails.PaymentInstructions(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
  .ShippingRateErrorMessage
(Y)-(Y)
TransactionArray.Transaction.ShippingDetails.ShippingRateType(Y)(Y)(Y)
TransactionArray.Transaction.ShippingDetails
  .ShippingServiceOptions
(Y)-(Y)
TransactionArray.Transaction.ShippingDetails
  .ShippingServiceOptions.ExpeditedService
(Y)-(Y)
TransactionArray.Transaction.ShippingDetails
  .ShippingServiceOptions.ImportCharge
(Y)-(Y)
TransactionArray.Transaction.ShippingDetails
  .ShippingServiceOptions.ShippingInsuranceCost
(Y)-(Y)
TransactionArray.Transaction.ShippingDetails
  .ShippingServiceOptions.ShippingPackageInfo
(Y)-(Y)
TransactionArray.Transaction.ShippingDetails
  .ShippingServiceOptions.ShippingPackageInfo.ActualDeliveryTime
(Y)-(Y)
TransactionArray.Transaction.ShippingDetails
  .ShippingServiceOptions.ShippingPackageInfo
  .ScheduledDeliveryTimeMax
(Y)-(Y)
TransactionArray.Transaction.ShippingDetails
  .ShippingServiceOptions.ShippingPackageInfo
  .ScheduledDeliveryTimeMin
(Y)-(Y)
TransactionArray.Transaction.ShippingDetails
  .ShippingServiceOptions.ShippingPackageInfo.ShippingTrackingEvent
(Y)-(Y)
TransactionArray.Transaction.ShippingDetails
  .ShippingServiceOptions.ShippingPackageInfo.StoreID
(Y)-(Y)
TransactionArray.Transaction.ShippingDetails
  .ShippingServiceOptions.ShippingService
(Y)-(Y)
TransactionArray.Transaction.ShippingDetails
  .ShippingServiceOptions.ShippingServiceAdditionalCost
(Y)-(Y)
TransactionArray.Transaction.ShippingDetails
  .ShippingServiceOptions.ShippingServiceCost
(Y)-(Y)
TransactionArray.Transaction.ShippingDetails
  .ShippingServiceOptions.ShippingServicePriority
(Y)-(Y)
TransactionArray.Transaction.ShippingDetails
  .ShippingServiceOptions.ShippingSurcharge
(Y)-(Y)
TransactionArray.Transaction.ShippingDetails
  .ShippingServiceOptions.ShippingTimeMax
(Y)-(Y)
TransactionArray.Transaction.ShippingDetails
  .ShippingServiceOptions.ShippingTimeMin
(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
  .ShippingInsuranceCost
(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
  .ShippingSurcharge
(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
  .IntegratedMerchantCreditCardEnabled
(Y)(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.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.TransactionPrice(Y)(Y)(Y)
TransactionArray.Transaction.TransactionSiteID(Y)-(Y)
TransactionArray.Transaction.UnpaidItem--(Y)
TransactionArray.Transaction.UnpaidItem.Status--(Y)
TransactionArray.Transaction.UnpaidItem.Type--(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.VariationSpecifics
  .NameValueList.Value
(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

Determines the TransactionID for an item that was sold.

Description

An order line item is created as soon as a listing ends and there is a winning bidder or buyer (regardless of whether payment has been made).

User magicalbookseller sold an item and wants to review the order line item details. She can gather information needed to complete the sale, including payment status, the FinalValueFee assessments, and the TransactionID.

Input

The key input for this call is ItemID.

XML format.

<GetItemTransactionsRequest xmlns="urn:ebay:apis:eBLBaseComponents">
  <ItemID>110048746230</ItemID>
  <RequesterCredentials>
    <eBayAuthToken>ABC...123</eBayAuthToken>
  </RequesterCredentials>
</GetItemTransactionsRequest>

Output

The key output is TransactionID.

XML format.
<GetItemTransactionsResponse xmlns="urn:ebay:apis:eBLBaseComponents">
  <Timestamp>2015-07-02T00:09:03.273Z</Timestamp>
  <Ack>Success</Ack>
  <Version>967</Version>
  <Build>E967_CORE_BUNDLED_11481347_R1</Build>
  <PaginationResult>
    <TotalNumberOfPages>1</TotalNumberOfPages>
    <TotalNumberOfEntries>1</TotalNumberOfEntries>
  </PaginationResult>
  <HasMoreTransactions>false</HasMoreTransactions>
  <TransactionsPerPage>100</TransactionsPerPage>
  <PageNumber>1</PageNumber>
  <ReturnedTransactionCountActual>1</ReturnedTransactionCountActual>
  <Item>
    <AutoPay>false</AutoPay>
    <Currency>USD</Currency>
    <ItemID>110048746230</ItemID>
    <ListingDetails>
      <ViewItemURL>http://cgi.sandbox.ebay.com/ws/eBayISAPI.dll?ViewItem&Item=110048746230</ViewItemURL>
      <ViewItemURLForNaturalSearch>http://cgi.sandbox.ebay.com/ws/eBayISAPI.dll?ViewItem&item=110048746230&category=0</ViewItemURLForNaturalSearch>
    </ListingDetails>
    <ListingType>Chinese</ListingType>
    <PaymentMethods>PayPal</PaymentMethods>
    <PrivateListing>false</PrivateListing>
    <Quantity>1</Quantity>
    <Seller>
      <AboutMePage>false</AboutMePage>
      <EIASToken>nY+sHZ2PrBmdj6wVnY+sEZ2PrA2dj6wFk4CpDZSLpwqdj6x9nY+seQ==</EIASToken>
      <Email>testuser_magicalbookseller@yahoo.com</Email>
      <FeedbackScore>7</FeedbackScore>
      <PositiveFeedbackPercent>100.0</PositiveFeedbackPercent>
      <FeedbackPrivate>false</FeedbackPrivate>
      <FeedbackRatingStar>None</FeedbackRatingStar>
      <IDVerified>false</IDVerified>
      <eBayGoodStanding>true</eBayGoodStanding>
      <NewUser>false</NewUser>
      <RegistrationDate>2004-05-27T00:00:00.000Z</RegistrationDate>
      <Site>US</Site>
      <Status>Confirmed</Status>
      <UserID>testuser_magicalbookseller</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>
        <SellerLevel>None</SellerLevel>
        <StoreOwner>true</StoreOwner>
        <StoreURL>http://www.stores.sandbox.ebay.com/id=132854966</StoreURL>
        <SafePaymentExempt>true</SafePaymentExempt>
      </SellerInfo>
    </Seller>
    <SellingStatus>
      <BidCount>1</BidCount>
      <ConvertedCurrentPrice currencyID="USD">1.0</ConvertedCurrentPrice>
      <CurrentPrice currencyID="USD">1.0</CurrentPrice>
      <QuantitySold>1</QuantitySold>
      <ListingStatus>Ended</ListingStatus>
    </SellingStatus>
    <Site>US</Site>
    <Title>Harry Potter and the Philosopher's Stone</Title>
    <IntegratedMerchantCreditCardEnabled>false</IntegratedMerchantCreditCardEnabled>
  </Item>
  <TransactionArray>
    <Transaction>
      <AmountPaid currencyID="USD">3.5</AmountPaid>
      <AdjustmentAmount currencyID="USD">0.0</AdjustmentAmount>
      <ConvertedAdjustmentAmount currencyID="USD">0.0</ConvertedAdjustmentAmount>
      <Buyer>
        <AboutMePage>false</AboutMePage>
        <EIASToken>nY+sHZ2PrBmdj6wVnY+sEZ2PrA2dj6wFk4CoDZKDpQqdj6x9nY+seQ==</EIASToken>
        <Email>bountifulbuyer@gmail.com</Email>
        <FeedbackScore>6</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>testuser_bountifulbuyer</UserID>
        <UserIDChanged>false</UserIDChanged>
        <UserIDLastChanged>2009-02-12T05:01:49.000Z</UserIDLastChanged>
        <VATStatus>NoVATTax</VATStatus>
        <BuyerInfo>
          <ShippingAddress>
            <Name>Bountiful Buyer</Name>
            <Street1>123 Gharky Lane</Street1>
            <CityName>Walla Walla</CityName>
            <StateOrProvince>WA</StateOrProvince>
            <Country>US</Country>
            <CountryName>United States</CountryName>
            <Phone>(408) 123-2344</Phone>
            <PostalCode>99362</PostalCode>
            <AddressID>5244731</AddressID>
            <AddressOwner>eBay</AddressOwner>
          </ShippingAddress>
        </BuyerInfo>
        <UserAnonymized>false</UserAnonymized>
      </Buyer>
      <ShippingDetails>
        <ChangePaymentInstructions>true</ChangePaymentInstructions>
        <InsuranceFee currencyID="USD">0.0</InsuranceFee>
        <InsuranceOption>NotOffered</InsuranceOption>
        <InsuranceWanted>false</InsuranceWanted>
        <PaymentEdited>false</PaymentEdited>
        <SalesTax>
          <SalesTaxPercent>0.0</SalesTaxPercent>
          <ShippingIncludedInTax>false</ShippingIncludedInTax>
          <SalesTaxAmount currencyID="USD">0.0</SalesTaxAmount>
        </SalesTax>
        <ShippingServiceOptions>
          <ShippingService>USPSMedia</ShippingService>
          <ShippingServiceCost currencyID="USD">2.5</ShippingServiceCost>
          <ShippingServicePriority>1</ShippingServicePriority>
          <ExpeditedService>false</ExpeditedService>
          <ShippingTimeMin>2</ShippingTimeMin>
          <ShippingTimeMax>9</ShippingTimeMax>
        </ShippingServiceOptions>
        <ShippingType>Flat</ShippingType>
        <SellingManagerSalesRecordNumber>374</SellingManagerSalesRecordNumber>
      </ShippingDetails>
      <ConvertedAmountPaid currencyID="USD">3.5</ConvertedAmountPaid>
      <ConvertedTransactionPrice currencyID="USD">1.0</ConvertedTransactionPrice>
      <CreatedDate>2015-07-02T00:08:58.000Z</CreatedDate>
      <QuantityPurchased>1</QuantityPurchased>
      <Status>
        <eBayPaymentStatus>NoPaymentFailure</eBayPaymentStatus>
        <CheckoutStatus>CheckoutIncomplete</CheckoutStatus>
        <LastTimeModified>2015-07-02T00:08:58.000Z</LastTimeModified>
        <PaymentMethodUsed>None</PaymentMethodUsed>
        <CompleteStatus>Incomplete</CompleteStatus>
        <BuyerSelectedShipping>false</BuyerSelectedShipping>
        <PaymentHoldStatus>None</PaymentHoldStatus>
        <IntegratedMerchantCreditCardEnabled>false</IntegratedMerchantCreditCardEnabled>
      </Status>
      <TransactionID>0</TransactionID>
      <TransactionPrice currencyID="USD">1.0</TransactionPrice>
      <BestOfferSale>false</BestOfferSale>
      <ShippingServiceSelected>
        <ShippingInsuranceCost currencyID="USD">0.0</ShippingInsuranceCost>
        <ShippingService>USPSMedia</ShippingService>
        <ShippingServiceCost currencyID="USD">2.5</ShippingServiceCost>
      </ShippingServiceSelected>
      <TransactionSiteID>US</TransactionSiteID>
      <Platform>eBay</Platform>
      <PayPalEmailAddress>magicalbookseller@yahoo.com</PayPalEmailAddress>
      <BuyerGuaranteePrice currencyID="USD">20000.0</BuyerGuaranteePrice>
      <IntangibleItem>false</IntangibleItem>
    </Transaction>
  </TransactionArray>
  <PayPalPreferred>true</PayPalPreferred>
</GetItemTransactionsResponse>


Back to list of samples

Sample: Retrieve details for a completed item

Retrieves the data for a completed single line item order.

Description

Magical Bookseller has completed the sale of her rare Harry Potter book, received payment, and shipped it off. She now wants to review the order details to ensure things are correctly represented in the eBay database.

Input

The call takes a simple ItemID value as input.

XML format.

<?xml version="1.0" encoding="utf-8"?>
<GetItemTransactionsRequest xmlns="urn:ebay:apis:eBLBaseComponents">
  <RequesterCredentials>
    <eBayAuthToken>ABC...123</eBayAuthToken>
  </RequesterCredentials>
  <ItemID>110043547115</ItemID>
</GetItemTransactionsRequest>

Output

The output contains many useful data values, including the following:
- ItemID
- ListingType
- ListingStatus
- QuantitySold
- AmountPaid
- ShippingServiceCost
- ConvertedAmountPaid

XML format.
<GetItemTransactionsResponse xmlns="urn:ebay:apis:eBLBaseComponents">
  <Timestamp>2010-02-10T22:04:20.826Z</Timestamp>
  <Ack>Success</Ack>
  <Version>653</Version>
  <Build>E653_CORE_BUNDLED_10549562_R1</Build>
  <PaginationResult>
    <TotalNumberOfPages>1</TotalNumberOfPages>
    <TotalNumberOfEntries>1</TotalNumberOfEntries>
  </PaginationResult>
  <HasMoreTransactions>false</HasMoreTransactions>
  <TransactionsPerPage>100</TransactionsPerPage>
  <PageNumber>1</PageNumber>
  <ReturnedTransactionCountActual>1</ReturnedTransactionCountActual>
  <Item>
    <AutoPay>false</AutoPay>
    <Currency>USD</Currency>
    <ItemID>110043547115</ItemID>
    <ListingDetails>
      <ViewItemURL>http://cgi.sandbox.ebay.com/ws/eBayISAPI.dll?ViewItem&Item=110043547115</ViewItemURL>
      <ViewItemURLForNaturalSearch>http://cgi.sandbox.ebay.com/ws/eBayISAPI.dll?ViewItem&item=110043547115&category=0</ViewItemURLForNaturalSearch>
    </ListingDetails>
    <ListingType>Chinese</ListingType>
    <PaymentMethods>PayPal</PaymentMethods>
    <PrivateListing>false</PrivateListing>
    <Quantity>1</Quantity>
    <Seller>
      <AboutMePage>false</AboutMePage>
      <EIASToken>nY+sHZ2PrBmdj6wVnY+sEZ2PrA2dj6wFk4CpDZSLpwqdj6x9nY+seQ==</EIASToken>
      <Email>magicalbookseller@yahoo.com</Email>
      <FeedbackScore>1</FeedbackScore>
      <PositiveFeedbackPercent>66.7</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>magicalbookseller</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>
        <LiveAuctionAuthorized>false</LiveAuctionAuthorized>
        <MerchandizingPref>OptIn</MerchandizingPref>
        <QualifiesForB2BVAT>false</QualifiesForB2BVAT>
        <StoreOwner>true</StoreOwner>
        <StoreURL>http://www.stores.sandbox.ebay.com/id=132854966</StoreURL>
        <ExpressEligible>false</ExpressEligible>
        <ExpressWallet>false</ExpressWallet>
        <SafePaymentExempt>true</SafePaymentExempt>
      </SellerInfo>
    </Seller>
    <SellingStatus>
      <BidCount>1</BidCount>
      <ConvertedCurrentPrice currencyID="USD">1750.0</ConvertedCurrentPrice>
      <CurrentPrice currencyID="USD">1750.0</CurrentPrice>
      <QuantitySold>1</QuantitySold>
      <ListingStatus>Completed</ListingStatus>
    </SellingStatus>
    <Site>US</Site>
    <Title>Harry Potter and the Philosopher's Stone</Title>
    <GetItFast>false</GetItFast>
    <IntegratedMerchantCreditCardEnabled>false</IntegratedMerchantCreditCardEnabled>
  </Item>
  <TransactionArray>
    <Transaction>
      <AmountPaid currencyID="USD">1754.0</AmountPaid>
      <AdjustmentAmount currencyID="USD">0.0</AdjustmentAmount>
      <ConvertedAdjustmentAmount currencyID="USD">0.0</ConvertedAdjustmentAmount>
      <Buyer>
        <AboutMePage>false</AboutMePage>
        <EIASToken>nY+sHZ2PrBmdj6wVnY+sEZ2PrA2dj6wFk4CoDZKDpQqdj6x9nY+seQ==</EIASToken>
        <Email>bountifulbuyer@gmail.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>bountifulbuyer</UserID>
        <UserIDChanged>false</UserIDChanged>
        <UserIDLastChanged>2009-02-12T05:01:49.000Z</UserIDLastChanged>
        <VATStatus>NoVATTax</VATStatus>
        <BuyerInfo>
          <ShippingAddress>
            <Name>Bountiful Buyer</Name>
            <Street1>123 Gharky Lane</Street1>
            <CityName>Walla Walla</CityName>
            <StateOrProvince>WA</StateOrProvince>
            <Country>US</Country>
            <CountryName>United States</CountryName>
            <Phone>(408) 123-2344</Phone>
            <PostalCode>99362</PostalCode>
            <AddressID>5244731</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>
        <ShippingServiceOptions>
          <ShippingService>USPSMedia</ShippingService>
          <ShippingServiceCost currencyID="USD">4.0</ShippingServiceCost>
          <ShippingServicePriority>1</ShippingServicePriority>
          <ExpeditedService>false</ExpeditedService>
          <ShippingTimeMin>2</ShippingTimeMin>
          <ShippingTimeMax>9</ShippingTimeMax>
        </ShippingServiceOptions>
        <ShippingType>Flat</ShippingType>
        <SellingManagerSalesRecordNumber>145</SellingManagerSalesRecordNumber>
        <ThirdPartyCheckout>false</ThirdPartyCheckout>
        <TaxTable/>
        <GetItFast>false</GetItFast>
      </ShippingDetails>
      <ConvertedAmountPaid currencyID="USD">1754.0</ConvertedAmountPaid>
      <ConvertedTransactionPrice currencyID="USD">1750.0</ConvertedTransactionPrice>
      <CreatedDate>2010-02-10T20:49:45.000Z</CreatedDate>
      <DepositType>None</DepositType>
      <QuantityPurchased>1</QuantityPurchased>
      <Status>
        <eBayPaymentStatus>NoPaymentFailure</eBayPaymentStatus>
        <CheckoutStatus>CheckoutIncomplete</CheckoutStatus>
        <LastTimeModified>2010-02-10T21:30:13.000Z</LastTimeModified>
        <PaymentMethodUsed>None</PaymentMethodUsed>
        <CompleteStatus>Incomplete</CompleteStatus>
        <BuyerSelectedShipping>false</BuyerSelectedShipping>
        <PaymentHoldStatus>None</PaymentHoldStatus>
        <IntegratedMerchantCreditCardEnabled>false</IntegratedMerchantCreditCardEnabled>
      </Status>
      <TransactionID>0</TransactionID>
      <TransactionPrice currencyID="USD">1750.0</TransactionPrice>
      <BestOfferSale>false</BestOfferSale>
      <ShippingServiceSelected>
        <ShippingService>USPSMedia</ShippingService>
        <ShippingServiceCost currencyID="USD">4.0</ShippingServiceCost>
      </ShippingServiceSelected>
      <PaidTime>2010-02-10T21:29:29.000Z</PaidTime>
      <ShippedTime>2010-02-10T21:30:13.000Z</ShippedTime>
      <TransactionSiteID>US</TransactionSiteID>
      <Platform>eBay</Platform>
      <PayPalEmailAddress>magicalbookseller@yahoo.com</PayPalEmailAddress>
      <BuyerGuaranteePrice currencyID="USD">20000.0</BuyerGuaranteePrice>
      <IntangibleItem>false</IntangibleItem>
    </Transaction>
  </TransactionArray>
  <PayPalPreferred>true</PayPalPreferred>
</GetItemTransactionsResponse>

Back to list of samples

Sample: Order with Item Variations (Buyer View)

Retrieves the details for Item Variations that were purchased.

Description

User bountifulbuyer just bought two medium pink tops and a medium black top from megaonlinemerchant. She knows the item ID, and she wants to retrieve the order line item details so she can verify the details of her purchase.

Input

The request specifies the ItemID that uniquely identifies the listing.

XML format.

<?xml version="1.0" encoding="utf-8"?>
<GetItemTransactionsRequest xmlns="urn:ebay:apis:eBLBaseComponents">
  <ItemID>110039490209</ItemID>
  <RequesterCredentials>
    <eBayAuthToken>ABC...123</eBayAuthToken>
  </RequesterCredentials>
</GetItemTransactionsRequest>

Output

The response contains two order line items (one for the pink tops and one for the black top). For each order line item, she's interested in the TransactionID (in case she needs to refer to that in the future). She checks the Transaction.AmountPaid, Transaction.TransactionPrice, Transaction.QuantityPurchased, and the VariationSpecifics to confirm that she bought two medium pink tops for $35.98 ($17.99 each) in one order line item and one medium black top for $20.00 in the other.

XML format.
<?xml version="1.0" encoding="utf-8"?>
<GetItemTransactionsResponse xmlns="urn:ebay:apis:eBLBaseComponents">
  <Timestamp>2009-06-12T14:33:08.757Z</Timestamp>
  <Ack>Success</Ack>
  <Version>619</Version>
  <Build>e619__Bundled_9183565_R1</Build>
  <PaginationResult>
    <TotalNumberOfPages>1</TotalNumberOfPages>
    <TotalNumberOfEntries>1</TotalNumberOfEntries>
  </PaginationResult>
  <HasMoreTransactions>false</HasMoreTransactions>
  <TransactionsPerPage>100</TransactionsPerPage>
  <PageNumber>1</PageNumber>
  <ReturnedTransactionCountActual>1</ReturnedTransactionCountActual>
  <Item>
    <AutoPay>false</AutoPay>
    <Currency>USD</Currency>
    <ItemID>110039490209</ItemID>
    <ListingDetails>
      <ViewItemURL>http://cgi.sandbox.ebay.com/ws/eBayISAPI.dll?ViewItem&Item=110039490209</ViewItemURL>
      <ViewItemURLForNaturalSearch>http://cgi.sandbox.ebay.com/ws/eBayISAPI.dll?ViewItem&item=110039490209&category=0</ViewItemURLForNaturalSearch>
    </ListingDetails>
    <ListingType>FixedPriceItem</ListingType>
    <PaymentMethods>PayPal</PaymentMethods>
    <PrivateListing>false</PrivateListing>
    <Quantity>52</Quantity>
    <Seller>
      <AboutMePage>false</AboutMePage>
      <EIASToken>nY+sHZ2PrBmdj6wVnY+sEZ2PrA2dj6wJnY+lDZWHqAidj6x9nY+seQ==</EIASToken>
      <Email>megaonlinemerchant@unicorn.qa.ebay.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>megaonlinemerchant</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>
        <LiveAuctionAuthorized>false</LiveAuctionAuthorized>
        <MerchandizingPref>OptIn</MerchandizingPref>
        <QualifiesForB2BVAT>false</QualifiesForB2BVAT>
        <SellerLevel>None</SellerLevel>
        <StoreOwner>false</StoreOwner>
        <ExpressEligible>false</ExpressEligible>
        <ExpressWallet>false</ExpressWallet>
        <SafePaymentExempt>false</SafePaymentExempt>
      </SellerInfo>
      <eBayUnilateralEmail>true</eBayUnilateralEmail>
    </Seller>
    <SellingStatus>
      <ConvertedCurrentPrice currencyID="USD">17.99</ConvertedCurrentPrice>
      <CurrentPrice currencyID="USD">17.99</CurrentPrice>
      <QuantitySold>2</QuantitySold>
      <ListingStatus>Active</ListingStatus>
    </SellingStatus>
    <Site>US</Site>
    <Title>New Ralph Lauren Polo shirt Pink Black Blue Yellow</Title>
    <GetItFast>false</GetItFast>
    <IntegratedMerchantCreditCardEnabled>false</IntegratedMerchantCreditCardEnabled>
  </Item>
  <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>nY+sHZ2PrBmdj6wVnY+sEZ2PrA2dj6wJnY+iAZeEqQ2dj6x9nY+seQ==</EIASToken>
        <Email>tuser1@unicorn.qa.ebay.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>testuser_bountifulbuyer</UserID>
        <UserIDChanged>false</UserIDChanged>
        <UserIDLastChanged>2001-08-29T21:52:58.000Z</UserIDLastChanged>
        <VATStatus>NoVATTax</VATStatus>
        <BuyerInfo>
          <ShippingAddress>
            <Name>testuser_bountifulbuyer</Name>
            <Street1>2145 Hamilton</Street1>
            <CityName>San Jose</CityName>
            <StateOrProvince>CA</StateOrProvince>
            <Country>US</Country>
            <CountryName>United States</CountryName>
            <PostalCode>95125</PostalCode>
            <AddressID>122205</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>
        <PaymentInstructions>Payment must be received within 7 business days of purchase.</PaymentInstructions>
        <SalesTax>
          <SalesTaxPercent>8.75</SalesTaxPercent>
          <SalesTaxState>CA</SalesTaxState>
          <ShippingIncludedInTax>false</ShippingIncludedInTax>
          <SalesTaxAmount currencyID="USD">3.15</SalesTaxAmount>
        </SalesTax>
        <ShippingServiceOptions>
          <ShippingService>USPSPriority</ShippingService>
          <ShippingServicePriority>1</ShippingServicePriority>
          <ExpeditedService>false</ExpeditedService>
          <ShippingTimeMin>2</ShippingTimeMin>
          <ShippingTimeMax>3</ShippingTimeMax>
        </ShippingServiceOptions>
        <ShippingServiceOptions>
          <ShippingService>UPSGround</ShippingService>
          <ShippingServicePriority>2</ShippingServicePriority>
          <ExpeditedService>false</ExpeditedService>
          <ShippingTimeMin>1</ShippingTimeMin>
          <ShippingTimeMax>6</ShippingTimeMax>
        </ShippingServiceOptions>
        <ShippingServiceOptions>
          <ShippingService>UPSNextDay</ShippingService>
          <ShippingServicePriority>3</ShippingServicePriority>
          <ExpeditedService>true</ExpeditedService>
          <ShippingTimeMin>1</ShippingTimeMin>
          <ShippingTimeMax>1</ShippingTimeMax>
        </ShippingServiceOptions>
        <ShippingType>Calculated</ShippingType>
        <ThirdPartyCheckout>false</ThirdPartyCheckout>
        <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>2009-06-12T14:26:17.000Z</CreatedDate>
      <DepositType>None</DepositType>
      <QuantityPurchased>2</QuantityPurchased>
      <Status>
        <eBayPaymentStatus>NoPaymentFailure</eBayPaymentStatus>
        <CheckoutStatus>CheckoutIncomplete</CheckoutStatus>
        <LastTimeModified>2009-06-12T14:26:18.000Z</LastTimeModified>
        <PaymentMethodUsed>None</PaymentMethodUsed>
        <CompleteStatus>Incomplete</CompleteStatus>
        <BuyerSelectedShipping>false</BuyerSelectedShipping>
        <PaymentHoldStatus>CustomCode</PaymentHoldStatus>
        <IntegratedMerchantCreditCardEnabled>false</IntegratedMerchantCreditCardEnabled>
      </Status>
      <TransactionID>24005469001</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>
      <PayPalEmailAddress>Invalid Request</PayPalEmailAddress>
      <BuyerGuaranteePrice currencyID="USD">20000.0</BuyerGuaranteePrice>
      <IntangibleItem>false</IntangibleItem>
      <Variation>
        <SKU>RLauren_Wom_TShirt_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=110039490209&vti=Color%09Pink%0ASize%09M</VariationViewItemURL>
      </Variation>
    </Transaction>
  </TransactionArray>
</GetItemTransactionsResponse>

Back to list of samples



Change History

Change Date Description
997
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 a