GetItemTransactions - Call Reference - eBay Trading Web Services

GetItemTransactions

GetItemTransactions retrieves transaction information for a specified item ID.

You can specify a time range for the transactions retrieved. For example, the NumberOfDays field enables you to specify the number of days' worth of new and modified transactions that you want to retrieve.

GetItemTransactions returns zero, one or multiple transactions, depending on whether the listing contains one item or multiple items, and depending on whether anything was sold in the listing. Often, GetSellerTransactions is more efficient than GetItemTransactions.

Some listings can return many transactions, so use a time filter to retrieve only the transactions whose status was modified in a certain time range. Optionally, configure the request to retrieve one page of data at a time (where each page contains a more manageable number of transactions).

In general, only fields relevant to transactions are returned. For example, reserve price information is not returned because it is irrelevant after the agreement to purchase the item has occurred. Also, fields that are not logically applicable are not returned. For example, TransactionArray.Transaction.Buyer.SellerInfo is not returned because the buyer is not acting in the role of a seller for the transaction.

Since all transactions returned by this call are for the same item, Item is returned at the root level and is not returned as an element of each transaction.

Notes:
- In the TransactionArray.Transaction.ShippingDetails object, only one of the following is returned: FlatShippingRate or CalculatedRate. Whether FlatShippingRate or CalculatedRate is returned depends on which of these the seller set.
- In the Item.Buyer and Item.Seller objects, email and address data is only returned under certain conditions.
- The Item.ListingDetails.RelistedItemID object is only returned if the item was re-listed.

See:
Email and Address Privacy Policy for the conditions under which buyer and seller email and address are returned
Retrieving the Transactions for a Single Item

Related calls:

GetSellerTransactions - Retrieves transaction information for the user for which the call is made (and not for any other user), where a transaction is the information about the sale of one or more items by one buyer from a single listing. (To retrieve transactions for another seller's listing, use GetItemTransactions.)
GetOrderTransactions - Retrieves information about one or more orders or one or more transactions (or both).

GetItemTransactions Input

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

See also Samples.

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

The XML prototype may be missing some XML fields and attributes. This is a documentation limitation only (see Limitations of This Document).

<?xml version="1.0" encoding="utf-8"?>
<GetItemTransactionsRequest xmlns="urn:ebay:apis:eBLBaseComponents">
  <!-- Standard Input Fields -->
  <DetailLevel> DetailLevelCodeType </DetailLevel>
  <!-- ... more DetailLevel nodes here ... -->
  <ErrorLanguage> string </ErrorLanguage>
  <MessageID> string </MessageID>
  <OutputSelector> string </OutputSelector>
  <!-- ... more OutputSelector nodes here ... -->
  <Version> string </Version>
  <WarningLevel> WarningLevelCodeType </WarningLevel>
  <!-- Call-specific Input Fields -->
  <IncludeContainingOrder> boolean </IncludeContainingOrder>
  <IncludeFinalValueFee> boolean </IncludeFinalValueFee>
  <ItemID> ItemIDType (string) </ItemID>
  <ModTimeFrom> dateTime </ModTimeFrom>
  <ModTimeTo> dateTime </ModTimeTo>
  <NumberOfDays> int </NumberOfDays>
  <Pagination> PaginationType 
    <EntriesPerPage> int </EntriesPerPage>
    <PageNumber> int </PageNumber>
  </Pagination>
  <Platform> TransactionPlatformCodeType </Platform>
  <TransactionID> string </TransactionID>
</GetItemTransactionsRequest>

Argument	Type	Reqd?	Meaning
Standard Input Fields [Jump to call-specific fields]
DetailLevel	DetailLevelCodeType (repeatable)	Optional	Detail levels are instructions that define standard subsets of data to return for particular data components (e.g., each Item, Transaction, or User) within the response payload. For example, a particular detail level might cause the response to include buyer-related data in every result (e.g., for every Item), but no seller-related data. Specifying a detail level is like using a predefined attribute list in the SELECT clause of an SQL query. Use the DetailLevel element to specify the required detail level that the client application needs pertaining to the data components that are applicable to the request. The DetailLevelCodeType defines the global list of available detail levels for all request types. Most request types support certain detail levels or none at all. If you pass a detail level that exists in the schema but that isn't valid for a particular request, eBay ignores it processes the request without it. For each request type, see the detail level tables in the Input/Output Reference to determine which detail levels are applicable and which elements are returned for each applicable detail level. (Some detail level tables are still in the eBay Web Services guide. They will be moved to the Input/Output Reference in a future release.) 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 a GranularityLevel or use the GetSellerEvents call instead. If you do use ReturnAll with GetSellerList, use a small EntriesPerPage value and a short EndTimeFrom/EndTimeTo range for better performance. Applicable values: • ItemReturnDescription (in) Returns Description, plus the ListingDesigner node and some additional information if applicable • ReturnAll (in) Returns all available data. With GetSellerList and other calls that retrieve large data sets, please avoid using ReturnAll when possible. For example, if you use GetSellerList, use a GranularityLevel or use the GetSellerEvents call instead. If you use ReturnAll with GetSellerList, use a small EntriesPerPage value and a short EndTimeFrom/EndTimeTo range for better performance. (Not all values in DetailLevelCodeType apply to this field.)
ErrorLanguage	string	Optional	Use ErrorLanguage to return error strings for the call in a different language from the language commonly associated with the site that the requesting user is registered with. Specify the standard RFC 3066 language identification tag (e.g., en_US). ID--- country ----- ----- de_AT Austria de_CH Switzerland de_DE Germany en_AU Australia en_CA Canada en_GB United Kingdom en_SG Singapore en_US United States es_ES Spain fr_BE Belgium (French) fr_CA Canada (French) fr_FR France it_IT Italy nl_BE Belgium (Dutch) nl_NL Netherlands zh_CN China en_IN India en_IE Ireland zh_HK Hong Kong See Tags for the Identification of Languages.
MessageID	string	Optional	In most cases, all calls support a MessageID element in the request and a CorrelationID element in the response. If you pass a message ID in a request, we will return the same value in CorrelationID in the response. You can use this for tracking that a response is returned for every request and to match particular responses to particular requests. If you do not pass MessageID in the request, CorrelationID is not returned. Note: GetCategories, GetAttributesCS, GetCategory2CS, GetAttributesXSL, GetProductFinder, GetProductFinderXSL, and GetProductSearchPage 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, 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 (repeatable)	Optional	You can use the OutputSelector field to restrict the data returned by this call. When you make a call such as GetItem that retrieves data from eBay, the OutputSelector field is useful for restricting the data returned. This field makes the call response easier to use, especially when a large payload would be returned. If you use the OutputSelector field, the output data will include only the fields you specified in the request. For example, if you are using GetItem and you want the item data in the response to be restricted to the ViewItemURL (the URL where a user can view the listing) and BuyItNowPrice, then within the GetItem request, specify those output fields. To use this field, see the information at the following link. See Selecting Fields to Retrieve.
Version	string	Conditional	The version number of the API code that you are programming against (e.g., 549). The version you specify for a call has these basic effects: - It indicates the version of the code lists and other data that eBay should use to process your request. - It indicates the schema version you are using. You need to use a version that is greater than or equal to the lowest supported version. For the SOAP API: If you are using the SOAP API, this field is required. Specify the version of the WSDL your application is using. For the XML API: If you are using the XML API, this field has no effect. Instead, specify the version in the X-EBAY-API-COMPATIBILITY-LEVEL HTTP header. (If you specify Version in the body of an XML API request and it is different from the value in the HTTP header, eBay returns an informational warning that the value in the HTTP header was used instead.) See: HTTP Headers (XML API Only) 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 in your production code. Applicable values: • High (in) Return warnings when the application passes unrecognized or deprecated elements in a request. • Low (in) Do not return warnings when the application passes unrecognized or deprecated elements in a request. This is the default value if WarningLevel is not specified. See Warning Level.
Call-specific Input Fields
IncludeContainingOrder	boolean	Optional	Whether to retrieve the order information. Default is false. Will not return the ContainingOrder information for an Express transaction that was part of an Express order.
IncludeFinalValueFee	boolean	Optional	Indicates whether to include final value fees in the response. For most listing types, the fee is returned in Transaction.FinalValueFee. For Dutch auctions that end with bids (not Buy It Now purchases), the fee is returned in Item.SellingStatus.FinalValueFee. The Final Value Fee for FixedPriceItem, StoresFixedPrice, and Buy It Now Dutch listing types is returned on a transaction by transaction basis. For all other listing types, including Chinese and Dutch (no Buy It Now purchases), the Final Value Fee is returned when the listing status is Completed.
ItemID	ItemIDType (string)	Required	Unique item ID for the item for which to retrieve transactions. Max length: 19 (Note: The eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits).
ModTimeFrom	dateTime	Optional	Also see NumberOfDays which, if used, takes precedence over ModTimeFrom and ModTimeTo. If you prefer to use ModTimeFrom and ModTimeTo, you specify the time range within which retrieved transactions' statuses were modified. ModTimeFrom is the earlier (older) date and ModTimeTo is the later (more recent) date. If you specify this value, and do not specify the other end of the range, then the time range is 30 days. The time range between ModTimeFrom to ModTimeTo cannot be greater than 30 days.
ModTimeTo	dateTime	Optional	Also see NumberOfDays which, if used, takes precedence over ModTimeFrom and ModTimeTo. If you prefer to use ModTimeFrom and ModTimeTo, you specify the time range within which retrieved transactions' statuses were modified. ModTimeFrom is the earlier (older) date and ModTimeTo is the later (more recent) date. If you specify this value, and do not specify the other end of the range, then the time range is 30 days. The time range between ModTimeFrom to ModTimeTo cannot be greater than 30 days.
NumberOfDays	int	Optional	NumberOfDays enables you to specify the number of days' worth of new and modified transactions that you want to retrieve. The call response contains the transactions whose status was modified within the specified number of days since the API call was made. NumberOfDays is often preferable to using the ModTimeFrom and ModTimeTo filters because you only need to specify one value. If you use NumberOfDays, then ModTimeFrom and ModTimeTo are ignored. For this field, one day is defined as 24 hours. Max: 30.
Pagination	PaginationType	Optional	Child elements control pagination of the output. Use its EntriesPerPage property to control the number of transactions to return per call and its PageNumber property to specify the page of data to return.
Pagination.EntriesPerPage	int	Optional	Specifies the maximum number of entries to return in a single call. If the number of entries that can be returned is less than the value in EntriesPerPage, then the lower number is returned. For most calls, the max is 200 and the default is 25. For GetUserDisputes, the value is hard-coded at 200, and any input is ignored. For GetProducts, the maximum is 20 (and higher values are ignored). See the annotations for other individual calls to determine the correct max and default values. For GetOrders, not applicable to eBay.com (but applicable to Half.com for GetOrders).
Pagination.PageNumber	int	Optional	Specifies the number of the page of data to return in the current call. Default is 1 for most calls. For some calls, the default is 0. Specify a positive value equal to or lower than the number of pages available (which you determine by examining the results of your initial request). See the documentation for other individual calls to determine the correct default value. For GetOrders, not applicable to eBay.com (for GetOrders, applicable to Half.com). Min: 0. Max: 2147483647. Default: 0.
Platform	TransactionPlatformCodeType	Optional	Name of the eBay co-branded site upon which the transaction was made. This will serve as a filter for the transactions to get emitted in the response. Applicable values: • CustomCode (in/out) Reserved for future use. • eBay (in/out) The transaction was created (i.e., the purchase was made) on the main eBay site. • Express (in/out) The transaction was created on the eBay Express site. • Half (in/out) The transaction was created on Half.com site. • Shopping (in/out) The transaction was created on the Shopping.com site.
TransactionID	string	Optional	Identifies one transaction for a listing. For Chinese auctions listings (single-item listings for which there can be only one transaction), TransactionID is always 0, and for multi-quantity listings (for which there can be multiple transactions), TransactionID has a non-0 value. To determine the valid transaction IDs for a listing, you typically need to have previously executed GetItemTransactionsCall or GetSellerTransactionsCall and stored all the listing's transactions. Max length: 19 (Note: The eBay database specifies 38. Currently, transaction IDs are usually 9 to 12 digits.).

GetItemTransactions Output

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

See also Samples.

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

The XML prototype may be missing some XML fields and attributes. This is a documentation limitation only (see Limitations of This Document).

<?xml version="1.0" encoding="utf-8"?>
<GetItemTransactionsResponse xmlns="urn:ebay:apis:eBLBaseComponents">
  <!-- 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 here ... -->
    <LongMessage> string </LongMessage>
    <SeverityCode> SeverityCodeType </SeverityCode>
    <ShortMessage> string </ShortMessage>
  </Errors>
  <!-- ... more Errors nodes here ... -->
  <HardExpirationWarning> string </HardExpirationWarning>
  <Timestamp> dateTime </Timestamp>
  <Version> string </Version>
  <!-- Call-specific Output Fields -->
  <HasMoreTransactions> boolean </HasMoreTransactions>
  <Item> ItemType 
    <ApplicationData> string </ApplicationData>
    <AutoPay> boolean </AutoPay>
    <BuyerProtection> BuyerProtectionCodeType </BuyerProtection>
    <BuyItNowPrice> AmountType (double) </BuyItNowPrice>
    <Charity> CharityType 
      <CharityListing> boolean </CharityListing>
    </Charity>
    <Currency> CurrencyCodeType </Currency>
    <GetItFast> boolean </GetItFast>
    <ItemID> ItemIDType (string) </ItemID>
    <ListingDetails> ListingDetailsType 
      <Adult> boolean </Adult>
      <BindingAuction> boolean </BindingAuction>
      <CheckoutEnabled> boolean </CheckoutEnabled>
      <ConvertedBuyItNowPrice> AmountType (double) </ConvertedBuyItNowPrice>
      <ConvertedReservePrice> AmountType (double) </ConvertedReservePrice>
      <ConvertedStartPrice> AmountType (double) </ConvertedStartPrice>
      <EndTime> dateTime </EndTime>
      <HasPublicMessages> boolean </HasPublicMessages>
      <HasReservePrice> boolean </HasReservePrice>
      <HasUnansweredQuestions> boolean </HasUnansweredQuestions>
      <MinimumBestOfferMessage> string </MinimumBestOfferMessage>
      <MinimumBestOfferPrice> 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 nodes here ... -->
    <PrivateListing> boolean </PrivateListing>
    <Quantity> int </Quantity>
    <Seller> UserType 
      <AboutMePage> boolean </AboutMePage>
      <CharityAffiliations> CharityAffiliationsType 
        <CharityID> CharityIDType (string) </CharityID>
        <!-- ... more CharityID nodes here ... -->
      </CharityAffiliations>
      <eBayGoodStanding> boolean </eBayGoodStanding>
      <EIASToken> string </EIASToken>
      <Email> string </Email>
      <FeedbackPrivate> boolean </FeedbackPrivate>
      <FeedbackRatingStar> FeedbackRatingStarCodeType </FeedbackRatingStar>
      <FeedbackScore> int </FeedbackScore>
      <IDVerified> boolean </IDVerified>
      <NewUser> boolean </NewUser>
      <PositiveFeedbackPercent> float </PositiveFeedbackPercent>
      <RegistrationDate> dateTime </RegistrationDate>
      <SellerInfo> SellerType 
        <AllowPaymentEdit> boolean </AllowPaymentEdit>
        <CheckoutEnabled> boolean </CheckoutEnabled>
        <CIPBankAccountStored> boolean </CIPBankAccountStored>
        <GoodStanding> boolean </GoodStanding>
        <LiveAuctionAuthorized> boolean </LiveAuctionAuthorized>
        <MerchandizingPref> MerchandizingPrefCodeType </MerchandizingPref>
        <QualifiesForB2BVAT> boolean </QualifiesForB2BVAT>
        <SafePaymentExempt> boolean </SafePaymentExempt>
        <SellerGuaranteeLevel> SellerGuaranteeLevelCodeType </SellerGuaranteeLevel>
        <SellerLevel> SellerLevelCodeType </SellerLevel>
        <StoreOwner> boolean </StoreOwner>
        <StoreURL> anyURI </StoreURL>
      </SellerInfo>
      <Site> SiteCodeType </Site>
      <Status> UserStatusCodeType </Status>
      <UserID> UserIDType (string) </UserID>
      <UserIDChanged> boolean </UserIDChanged>
      <UserIDLastChanged> dateTime </UserIDLastChanged>
      <VATStatus> VATStatusCodeType </VATStatus>
    </Seller>
    <SellingStatus> SellingStatusType 
      <BidCount> int </BidCount>
      <ConvertedCurrentPrice> AmountType (double) </ConvertedCurrentPrice>
      <CurrentPrice> AmountType (double) </CurrentPrice>
      <FinalValueFee> AmountType (double) </FinalValueFee>
      <ListingStatus> ListingStatusCodeType </ListingStatus>
      <QuantitySold> int </QuantitySold>
    </SellingStatus>
    <Site> SiteCodeType </Site>
    <SKU> SKUType (string) </SKU>
    <StartPrice> AmountType (double) </StartPrice>
    <Title> string </Title>
  </Item>
  <PageNumber> int </PageNumber>
  <PaginationResult> PaginationResultType 
    <TotalNumberOfEntries> int </TotalNumberOfEntries>
    <TotalNumberOfPages> int </TotalNumberOfPages>
  </PaginationResult>
  <PayPalPreferred> boolean </PayPalPreferred>
  <ReturnedTransactionCountActual> int </ReturnedTransactionCountActual>
  <TransactionArray> TransactionArrayType 
    <Transaction> TransactionType 
      <AdjustmentAmount> AmountType (double) </AdjustmentAmount>
      <AmountPaid> AmountType (double) </AmountPaid>
      <BestOfferSale> boolean </BestOfferSale>
      <Buyer> UserType 
        <AboutMePage> boolean </AboutMePage>
        <BuyerInfo> BuyerType 
          <ShippingAddress> AddressType 
            <CityName> string </CityName>
            <Country> CountryCodeType </Country>
            <CountryName> string </CountryName>
            <ExternalAddressID> string </ExternalAddressID>
            <Name> string </Name>
            <Phone> string </Phone>
            <PostalCode> string </PostalCode>
            <StateOrProvince> string </StateOrProvince>
            <Street> string </Street>
            <Street1> string </Street1>
            <Street2> string </Street2>
          </ShippingAddress>
        </BuyerInfo>
        <CharityAffiliations> CharityAffiliationsType 
          <CharityID> CharityIDType (string) </CharityID>
          <!-- ... more CharityID nodes here ... -->
        </CharityAffiliations>
        <eBayGoodStanding> boolean </eBayGoodStanding>
        <EIASToken> string </EIASToken>
        <Email> string </Email>
        <FeedbackPrivate> boolean </FeedbackPrivate>
        <FeedbackRatingStar> FeedbackRatingStarCodeType </FeedbackRatingStar>
        <FeedbackScore> int </FeedbackScore>
        <IDVerified> boolean </IDVerified>
        <NewUser> boolean </NewUser>
        <PositiveFeedbackPercent> float </PositiveFeedbackPercent>
        <RegistrationDate> dateTime </RegistrationDate>
        <Site> SiteCodeType </Site>
        <Status> UserStatusCodeType </Status>
        <UserID> UserIDType (string) </UserID>
        <UserIDChanged> boolean </UserIDChanged>
        <UserIDLastChanged> dateTime </UserIDLastChanged>
        <VATStatus> VATStatusCodeType </VATStatus>
      </Buyer>
      <BuyerGuaranteePrice> AmountType (double) </BuyerGuaranteePrice>
      <CartID> string </CartID>
      <ContainingOrder> OrderType 
        <CreatingUserRole> TradingRoleCodeType </CreatingUserRole>
        <OrderID> OrderIDType (string) </OrderID>
        <OrderStatus> OrderStatusCodeType </OrderStatus>
      </ContainingOrder>
      <ConvertedAdjustmentAmount> AmountType (double) </ConvertedAdjustmentAmount>
      <ConvertedAmountPaid> AmountType (double) </ConvertedAmountPaid>
      <ConvertedTransactionPrice> AmountType (double) </ConvertedTransactionPrice>
      <CreatedDate> dateTime </CreatedDate>
      <DepositType> DepositTypeCodeType </DepositType>
      <ExternalTransaction> ExternalTransactionType 
        <ExternalTransactionID> string </ExternalTransactionID>
        <ExternalTransactionTime> dateTime </ExternalTransactionTime>
        <FeeOrCreditAmount> AmountType (double) </FeeOrCreditAmount>
        <PaymentOrRefundAmount> AmountType (double) </PaymentOrRefundAmount>
      </ExternalTransaction>
      <!-- ... more ExternalTransaction nodes here ... -->
      <FinalValueFee> AmountType (double) </FinalValueFee>
      <ListingCheckoutRedirectPreference> ListingCheckoutRedirectPreferenceType 
        <SellerThirdPartyUsername> string </SellerThirdPartyUsername>
      </ListingCheckoutRedirectPreference>
      <PaidTime> dateTime </PaidTime>
      <PayPalEmailAddress> string </PayPalEmailAddress>
      <Platform> TransactionPlatformCodeType </Platform>
      <QuantityPurchased> int </QuantityPurchased>
      <SellerContactBuyerByEmail> boolean </SellerContactBuyerByEmail>
      <SellingManagerProductDetails> SellingManagerProductDetailsType 
        <PartNumber> int </PartNumber>
        <ProductName> string </ProductName>
        <ProductPartNumber> string </ProductPartNumber>
      </SellingManagerProductDetails>
      <ShippedTime> dateTime </ShippedTime>
      <ShippingDetails> ShippingDetailsType 
        <CalculatedShippingRate> CalculatedShippingRateType 
          <InternationalPackagingHandlingCosts> AmountType (double) </InternationalPackagingHandlingCosts>
          <OriginatingPostalCode> string </OriginatingPostalCode>
          <PackageDepth> MeasureType (decimal) </PackageDepth>
          <PackageLength> MeasureType (decimal) </PackageLength>
          <PackageWidth> MeasureType (decimal) </PackageWidth>
          <PackagingHandlingCosts> AmountType (double) </PackagingHandlingCosts>
          <ShippingIrregular> boolean </ShippingIrregular>
          <ShippingPackage> ShippingPackageCodeType </ShippingPackage>
          <WeightMajor> MeasureType (decimal) </WeightMajor>
          <WeightMinor> MeasureType (decimal) </WeightMinor>
        </CalculatedShippingRate>
        <ChangePaymentInstructions> boolean </ChangePaymentInstructions>
        <CODCost> AmountType (double) </CODCost>
        <GetItFast> boolean </GetItFast>
        <InsuranceFee> AmountType (double) </InsuranceFee>
        <InsuranceOption> InsuranceOptionCodeType </InsuranceOption>
        <InsuranceWanted> boolean </InsuranceWanted>
        <InternationalShippingServiceOption> InternationalShippingServiceOptionsType 
          <ShippingInsuranceCost> AmountType (double) </ShippingInsuranceCost>
          <ShippingService> token </ShippingService>
          <ShippingServiceAdditionalCost> AmountType (double) </ShippingServiceAdditionalCost>
          <ShippingServiceCost> AmountType (double) </ShippingServiceCost>
          <ShippingServicePriority> int </ShippingServicePriority>
          <ShipToLocation> string </ShipToLocation>
          <!-- ... more ShipToLocation nodes here ... -->
        </InternationalShippingServiceOption>
        <!-- ... more InternationalShippingServiceOption nodes here ... -->
        <PaymentEdited> boolean </PaymentEdited>
        <PaymentInstructions> string </PaymentInstructions>
        <SalesTax> SalesTaxType 
          <SalesTaxAmount> AmountType (double) </SalesTaxAmount>
          <SalesTaxPercent> float </SalesTaxPercent>
          <SalesTaxState> string </SalesTaxState>
          <ShippingIncludedInTax> boolean </ShippingIncludedInTax>
        </SalesTax>
        <SellingManagerSalesRecordNumber> int </SellingManagerSalesRecordNumber>
        <ShipmentTrackingNumber> string </ShipmentTrackingNumber>
        <ShippingRateErrorMessage> string </ShippingRateErrorMessage>
        <ShippingRateType> ShippingRateTypeCodeType </ShippingRateType>
        <ShippingServiceOptions> ShippingServiceOptionsType 
          <ExpeditedService> boolean </ExpeditedService>
          <ShippingInsuranceCost> AmountType (double) </ShippingInsuranceCost>
          <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 here ... -->
        <ShippingServiceUsed> token </ShippingServiceUsed>
        <ShippingType> ShippingTypeCodeType </ShippingType>
        <TaxTable> TaxTableType 
          <TaxJurisdiction> TaxJurisdictionType 
            <JurisdictionID> string </JurisdictionID>
            <SalesTaxPercent> float </SalesTaxPercent>
            <ShippingIncludedInTax> boolean </ShippingIncludedInTax>
          </TaxJurisdiction>
          <!-- ... more TaxJurisdiction nodes here ... -->
        </TaxTable>
        <ThirdPartyCheckout> boolean </ThirdPartyCheckout>
      </ShippingDetails>
      <ShippingServiceSelected> ShippingServiceOptionsType 
        <ExpeditedService> boolean </ExpeditedService>
        <ShippingInsuranceCost> AmountType (double) </ShippingInsuranceCost>
        <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>
        <eBayPaymentStatus> PaymentStatusCodeType </eBayPaymentStatus>
        <LastTimeModified> dateTime </LastTimeModified>
        <PaymentHoldStatus> PaymentHoldStatusCodeType </PaymentHoldStatus>
        <PaymentMethodUsed> BuyerPaymentMethodCodeType </PaymentMethodUsed>
      </Status>
      <TransactionID> string </TransactionID>
      <TransactionPlatform> TransactionPlatformCodeType </TransactionPlatform>
      <TransactionPrice> AmountType (double) </TransactionPrice>
      <TransactionSiteID> SiteCodeType </TransactionSiteID>
    </Transaction>
    <!-- ... more Transaction nodes here ... -->
  </TransactionArray>
  <TransactionsPerPage> int </TransactionsPerPage>
</GetItemTransactionsResponse>

Return Value	Type	Returned?	Meaning
Standard Output Fields [Jump to call-specific 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 Ack. Applicable values: • CustomCode (out) Reserved for internal or future use. • Failure (out) Request processing failed • Success (out) Request processing succeeded • Warning (out) Request processing completed with warning information being included in the response message (Not all values in AckCodeType apply to this field.)
Build	string	Always	This refers to the specific software build that eBay used when processing the request and generating the response. This includes the version number plus additional information. eBay Developer Support may request the build information when helping you resolve technical issues.
CorrelationID	string	Conditionally	In most cases, all calls support a MessageID element in the request and a CorrelationID element in the response. If you pass a message ID in a request, we will return the same value in CorrelationID in the response. You can use this for tracking that a response is returned for every request and to match particular responses to particular requests. If you do not pass MessageID in the request, CorrelationID is not returned. Note: GetCategories, GetAttributesCS, GetCategory2CS, GetAttributesXSL, GetProductFinder, GetProductFinderXSL, and GetProductSearchPage 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, 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 (repeatable)	Conditionally	A list of application-level errors (if any) that occurred when eBay processed the request. See Error Handling.
Errors.ErrorClassification	ErrorClassificationCodeType	Conditionally	API errors are divided between two classes: system errors and request errors. Applicable values: • CustomCode (out) Reserved for internal or future use. • RequestError (out) An error has occurred either as a result of a problem in the sending application or because the application's end-user has attempted to submit invalid data (or missing data). In these cases, do not retry the request. The problem must be corrected before the request can be made again. If the problem is due to something in the application (such as a missing required field), the application must be changed. If the problem is a result of end-user data, the application must alert the end-user to the problem and provide the means for the end-user to correct the data. Once the problem in the application or data is resolved, resend the request to eBay with the corrected data. • SystemError (out) Indicates that an error has occurred on the eBay system side, such as a database or server down. An application can retry the request as-is a reasonable number of times (eBay recommends twice). If the error persists, contact Developer Technical Support. Once the problem has been resolved, the request may be resent in its original form.
Errors.ErrorCode	token	Conditionally	A unique code that identifies the particular error condition that occurred. Your application can use error codes as identifiers in your customized error-handling algorithms.
Errors.ErrorParameters	ErrorParameterType (repeatable)	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 [ attribute ParamID ]	string	Conditionally	The index of the parameter in the list of parameter types returned within the error type.
Errors.ErrorParameters.Value	string	Conditionally	The value of the variable (e.g., the attribute set ID)
Errors.LongMessage	string	Conditionally	A more detailed description of the condition that raised the error.
Errors.SeverityCode	SeverityCodeType	Conditionally	Indicates whether the error is a severe error (causing the request to fail) or an informational error (a warning) that should be communicated to the user. Applicable values: • CustomCode (out) Reserved for internal or future use • Error (out) Application-level error • Warning (out) Warning or informational error
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 Time Values in the eBay Web Services guide for information about this time format and converting to and from the GMT time zone. Note: GetCategories, GetAttributesCS, GetCategory2CS, GetAttributesXSL, GetProductFinder, GetProductFinderXSL, and GetProductSearchPage 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 "Standard Data for All Calls" in the eBay Web Services Guide for information on using the response version when troubleshooting "CustomCode" values that appear in the response.
Call-specific Output Fields
HasMoreTransactions	boolean	Always	Indicates whether there are additional 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.

eBay Trading API Call Reference Version 579

eBay Trading API
Call Reference Version 579