GetOrderTransactions - Call Reference - eBay Trading Web Services

GetOrderTransactions

Retrieves information about one or more orders or one or more transactions (or both). If you have both orderIDs and itemIDs/transactionIDs, you may find this "combined call" more convenient than calling GetOrders and GetItemTransactions separately. Note that every transaction is nested within an Order node, even if the transaction does not belong to an order.

Note: OrderID is not returned when the GetOrderTransactions request includes ItemTransactionID, even if the transaction is part of an order. To get the OrderID for a transaction, call GetItemTransaction with IncludeContainingOrder = true.

Does not retrieve Express orders, even when the explicit Express OrderID found on the eBay Express site is included in the request.

GetOrderTransactions 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"?>
<GetOrderTransactionsRequest 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 -->
  <IncludeFinalValueFees> boolean </IncludeFinalValueFees>
  <ItemTransactionIDArray> ItemTransactionIDArrayType 
    <ItemTransactionID> ItemTransactionIDType 
      <ItemID> ItemIDType (string) </ItemID>
      <TransactionID> string </TransactionID>
    </ItemTransactionID>
    <!-- ... more ItemTransactionID nodes here ... -->
  </ItemTransactionIDArray>
  <OrderIDArray> OrderIDArrayType 
    <OrderID> OrderIDType (string) </OrderID>
    <!-- ... more OrderID nodes here ... -->
  </OrderIDArray>
  <Platform> TransactionPlatformCodeType </Platform>
</GetOrderTransactionsRequest>

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
IncludeFinalValueFees	boolean	Optional	Indicates whether to include the final value fee in the following field of the response: Transaction.FinalValueFee. 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 the following field regardless of what you specify in the IncludeFinalValueFees field: 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 (not Buy It Now purchases), the Final Value Fee is returned when the listing status is Completed.
ItemTransactionIDArray	ItemTransactionIDArrayType	Conditional	An array of ItemTransactionIDs.
ItemTransactionIDArray .ItemTransactionID	ItemTransactionIDType (repeatable)	Conditional	An ItemID-TransactionID container. Note: OrderID is not returned when the GetOrderTransactions request includes ItemTransactionID, even if the transaction is part of an order. To get the OrderID for a transaction, call GetItemTransaction with IncludeContainingOrder = true.
ItemTransactionIDArray .ItemTransactionID.ItemID	ItemIDType (string)	Conditional	The ID of an item. Max length: 19 (Note: The eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits).
ItemTransactionIDArray .ItemTransactionID .TransactionID	string	Conditional	The ID of a transaction. Max length: 19 (Note: The eBay database specifies 38. Currently, transaction IDs are usually 9 to 12 digits.).
OrderIDArray	OrderIDArrayType	Conditional	An array of OrderIDs. You can specify, at most, twenty OrderIDs.
OrderIDArray.OrderID	OrderIDType (string) (repeatable)	Conditional	A unique identifier for an order.
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.

GetOrderTransactions 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"?>
<GetOrderTransactionsResponse 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 -->
  <OrderArray> OrderArrayType 
    <Order> OrderType 
      <AdjustmentAmount> AmountType (double) </AdjustmentAmount>
      <AmountPaid> AmountType (double) </AmountPaid>
      <AmountSaved> AmountType (double) </AmountSaved>
      <BuyerUserID> UserIDType (string) </BuyerUserID>
      <CheckoutStatus> CheckoutStatusType 
        <eBayPaymentStatus> PaymentStatusCodeType </eBayPaymentStatus>
        <LastModifiedTime> dateTime </LastModifiedTime>
        <PaymentMethod> BuyerPaymentMethodCodeType </PaymentMethod>
        <Status> CompleteStatusCodeType </Status>
      </CheckoutStatus>
      <CreatedTime> dateTime </CreatedTime>
      <CreatingUserRole> TradingRoleCodeType </CreatingUserRole>
      <ExternalTransaction> ExternalTransactionType 
        <ExternalTransactionID> string </ExternalTransactionID>
        <ExternalTransactionTime> dateTime </ExternalTransactionTime>
        <FeeOrCreditAmount> AmountType (double) </FeeOrCreditAmount>
        <PaymentOrRefundAmount> AmountType (double) </PaymentOrRefundAmount>
      </ExternalTransaction>
      <!-- ... more ExternalTransaction nodes here ... -->
      <OrderID> OrderIDType (string) </OrderID>
      <OrderStatus> OrderStatusCodeType </OrderStatus>
      <PaidTime> dateTime </PaidTime>
      <PaymentMethods> BuyerPaymentMethodCodeType </PaymentMethods>
      <!-- ... more PaymentMethods nodes here ... -->
      <ShippedTime> dateTime </ShippedTime>
      <ShippingAddress> AddressType 
        <AddressID> string </AddressID>
        <AddressOwner> AddressOwnerCodeType </AddressOwner>
        <CityName> string </CityName>
        <Country> CountryCodeType </Country>
        <CountryName> string </CountryName>
        <ExternalAddressID> string </ExternalAddressID>
        <Name> string </Name>
        <Phone> string </Phone>
        <PostalCode> string </PostalCode>
        <StateOrProvince> string </StateOrProvince>
        <Street1> string </Street1>
        <Street2> string </Street2>
      </ShippingAddress>
      <ShippingDetails> ShippingDetailsType 
        <AllowPaymentEdit> boolean </AllowPaymentEdit>
        <ChangePaymentInstructions> boolean </ChangePaymentInstructions>
        <CODCost> AmountType (double) </CODCost>
        <GetItFast> boolean </GetItFast>
        <InsuranceFee> AmountType (double) </InsuranceFee>
        <InsuranceOption> InsuranceOptionCodeType </InsuranceOption>
        <InsuranceWanted> boolean </InsuranceWanted>
        <InternationalShippingServiceOption> InternationalShippingServiceOptionsType 
          <ShippingInsuranceCost currencyID="CurrencyCodeType"> AmountType (double) </ShippingInsuranceCost>
          <ShippingService> token </ShippingService>
          <ShippingServiceAdditionalCost currencyID="CurrencyCodeType"> AmountType (double) </ShippingServiceAdditionalCost>
          <ShippingServiceCost currencyID="CurrencyCodeType"> AmountType (double) </ShippingServiceCost>
          <ShippingServicePriority> int </ShippingServicePriority>
          <ShipToLocation> string </ShipToLocation>
          <!-- ... more ShipToLocation nodes here ... -->
        </InternationalShippingServiceOption>
        <!-- ... more InternationalShippingServiceOption nodes here ... -->
        <SalesTax> SalesTaxType 
          <SalesTaxAmount> AmountType (double) </SalesTaxAmount>
          <SalesTaxPercent> float </SalesTaxPercent>
          <SalesTaxState> string </SalesTaxState>
          <ShippingIncludedInTax> boolean </ShippingIncludedInTax>
        </SalesTax>
        <SellingManagerSalesRecordNumber> int </SellingManagerSalesRecordNumber>
        <ShippingServiceOptions> ShippingServiceOptionsType 
          <ExpeditedService> boolean </ExpeditedService>
          <ShippingInsuranceCost currencyID="CurrencyCodeType"> AmountType (double) </ShippingInsuranceCost>
          <ShippingService> token </ShippingService>
          <ShippingServiceAdditionalCost currencyID="CurrencyCodeType"> AmountType (double) </ShippingServiceAdditionalCost>
          <ShippingServiceCost currencyID="CurrencyCodeType"> AmountType (double) </ShippingServiceCost>
          <ShippingServicePriority> int </ShippingServicePriority>
          <ShippingSurcharge currencyID="CurrencyCodeType"> AmountType (double) </ShippingSurcharge>
        </ShippingServiceOptions>
        <!-- ... more ShippingServiceOptions nodes here ... -->
        <TaxTable> TaxTableType 
          <TaxJurisdiction> TaxJurisdictionType 
            <JurisdictionID> string </JurisdictionID>
            <SalesTaxPercent> float </SalesTaxPercent>
            <ShippingIncludedInTax> boolean </ShippingIncludedInTax>
          </TaxJurisdiction>
          <!-- ... more TaxJurisdiction nodes here ... -->
        </TaxTable>
      </ShippingDetails>
      <ShippingServiceSelected> ShippingServiceOptionsType 
        <ExpeditedService> boolean </ExpeditedService>
        <ShippingInsuranceCost currencyID="CurrencyCodeType"> AmountType (double) </ShippingInsuranceCost>
        <ShippingService> token </ShippingService>
        <ShippingServiceAdditionalCost currencyID="CurrencyCodeType"> AmountType (double) </ShippingServiceAdditionalCost>
        <ShippingServiceCost currencyID="CurrencyCodeType"> AmountType (double) </ShippingServiceCost>
        <ShippingServicePriority> int </ShippingServicePriority>
        <ShippingSurcharge currencyID="CurrencyCodeType"> AmountType (double) </ShippingSurcharge>
      </ShippingServiceSelected>
      <Subtotal> AmountType (double) </Subtotal>
      <Total> AmountType (double) </Total>
      <TransactionArray> TransactionArrayType 
        <Transaction> TransactionType 
          <AdjustmentAmount> AmountType (double) </AdjustmentAmount>
          <AmountPaid> AmountType (double) </AmountPaid>
          <BestOfferSale> boolean </BestOfferSale>
          <Buyer> UserType 
            <AboutMePage> boolean </AboutMePage>
            <BuyerInfo> BuyerType 
              <ShippingAddress> AddressType 
                <AddressID> string </AddressID>
                <AddressOwner> AddressOwnerCodeType </AddressOwner>
                <CityName> string </CityName>
                <Country> CountryCodeType </Country>
                <CountryName> string </CountryName>
                <ExternalAddressID> string </ExternalAddressID>
                <Name> string </Name>
                <Phone> string </Phone>
                <PostalCode> string </PostalCode>
                <StateOrProvince> string </StateOrProvince>
                <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>
            <RegistrationDate> dateTime </RegistrationDate>
            <Site> SiteCodeType </Site>
            <Status> UserStatusCodeType </Status>
            <UserAnonymized> boolean </UserAnonymized>
            <UserID> UserIDType (string) </UserID>
            <UserIDChanged> boolean </UserIDChanged>
            <UserIDLastChanged> dateTime </UserIDLastChanged>
            <VATStatus> VATStatusCodeType </VATStatus>
          </Buyer>
          <BuyerGuaranteePrice> AmountType (double) </BuyerGuaranteePrice>
          <CartID> string </CartID>
          <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>
          <Item> ItemType 
            <ApplicationData> string </ApplicationData>
            <AutoPay> boolean </AutoPay>
            <BuyerProtection> BuyerProtectionCodeType </BuyerProtection>
            <BuyItNowPrice> AmountType (double) </BuyItNowPrice>
            <Charity> CharityType 
              <CharityID> string </CharityID>
              <CharityListing> boolean </CharityListing>
              <CharityName> string </CharityName>
              <CharityNumber> int </CharityNumber>
              <DonationPercent> float </DonationPercent>
            </Charity>
            <GetItFast> boolean </GetItFast>
            <ItemID> ItemIDType (string) </ItemID>
            <ListingType> ListingTypeCodeType </ListingType>
            <PrivateListing> boolean </PrivateListing>
            <SellingStatus> SellingStatusType 
              <ConvertedCurrentPrice> AmountType (double) </ConvertedCurrentPrice>
              <CurrentPrice> AmountType (double) </CurrentPrice>
              <FinalValueFee> AmountType (double) </FinalValueFee>
              <ListingStatus> ListingStatusCodeType </ListingStatus>
            </SellingStatus>
          </Item>
          <PayPalEmailAddress> string </PayPalEmailAddress>
          <Platform> TransactionPlatformCodeType </Platform>
          <QuantityPurchased> int </QuantityPurchased>
          <SellerContactBuyerByEmail> boolean </SellerContactBuyerByEmail>
          <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>
    </Order>
    <!-- ... more Order nodes here ... -->
  </OrderArray>
</GetOrderTransactionsResponse>

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
OrderArray	OrderArrayType	Always	An array of Orders. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order	OrderType (repeatable)	Always	Also applicable to Half.com. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. See Working with Combined Payment.
OrderArray.Order .AdjustmentAmount	AmountType (double)	Always	Amount by which the buyer is adjusting the order total. Used when the seller has not supplied payment details such as shipping and handling or insurance fee. Also applicable to Half.com (for GetOrders). DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order.AmountPaid	AmountType (double)	Always	Amount the buyer has paid the seller for the order. For GetOrders, applies only to Half.com. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order.AmountSaved	AmountType (double)	Always	Amount the buyer saved by having multiple items combined into a single order, versus purchasing the items separately. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order.BuyerUserID	UserIDType (string)	Always	User ID of the order's buyer. Not applicable to Half.com. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order .CheckoutStatus	CheckoutStatusType	Always	The current checkout status of the order. Also applicable to Half.com (for GetOrders). DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order .CheckoutStatus .eBayPaymentStatus	PaymentStatusCodeType	Always	Indicates the success or failure of a buyer's online payment. Also applicable to Half.com (for GetOrders). Applicable values: • BuyerCreditCardFailed (out) The buyer's credit card failed. • BuyerECheckBounced (out) The buyer's eCheck bounced. • BuyerFailedPaymentReportedBySeller (out) The seller reports that the buyer's payment failed. • CustomCode (out) Reserved for internal or future use. • NoPaymentFailure (out) No payment failure. • PaymentInProcess (out) Currently for eBay Germany only. • PayPalPaymentInProcess (out) The payment from buyer to seller is in PayPal process, but has not yet been completed. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order .CheckoutStatus .LastModifiedTime	dateTime	Always	The time the status was last modified. Also applicable to Half.com (for GetOrders). DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order .CheckoutStatus.PaymentMethod	BuyerPaymentMethodCodeType	Always	The payment method the buyer uses to purchase the item. Also applicable to Half.com (for GetOrders). Applicable values: See PaymentMethod. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order .CheckoutStatus.Status	CompleteStatusCodeType	Always	The status of the order. Also applicable to Half.com (for GetOrders). Applicable values: • Complete (in/out) Transaction is complete. • CustomCode (in/out) Reserved for internal or future use • Incomplete (in/out) Transaction is incomplete. • Pending (in/out) Transaction is pending. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order.CreatedTime	dateTime	Always	Date and time the order was created. Also applicable to Half.com (for GetOrders). DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order .CreatingUserRole	TradingRoleCodeType	Always	Indicates whether the order is created by the buyer or by the seller. Applicable values: • Buyer (in/out) Acting as buyer. • CustomCode (in/out) Reserved for future use. • Seller (in/out) Acting as seller. For GetOrders, you can use this value to limit orders to those where the calling user is the seller. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order .ExternalTransaction	ExternalTransactionType (repeatable)	Conditionally	Not applicable to Half.com. A PayPal transaction that relates to this eBay transaction. Returned only if there is at least one PayPal transaction related to this eBay transaction. DetailLevel: ReturnAll.
OrderArray.Order .ExternalTransaction .ExternalTransactionID	string	Conditionally	Unique payment transaction ID. DetailLevel: ReturnAll.
OrderArray.Order .ExternalTransaction .ExternalTransactionTime	dateTime	Conditionally	Date on which transaction occurs in PayPal. DetailLevel: ReturnAll.
OrderArray.Order .ExternalTransaction .FeeOrCreditAmount	AmountType (double)	Conditionally	DetailLevel: ReturnAll.
OrderArray.Order .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.
OrderArray.Order.OrderID	OrderIDType (string)	Always	Unique identifier that eBay generates for the order. For calls like GetItemTransactions (and the Checkout notification), no OrderID will appear when only 1 item is purchased in a single end-to-end checkout flow (because the transaction would not be part of an order in this case). Also applicable to Half.com (for GetOrders). DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order.OrderStatus	OrderStatusCodeType	Always	The current status of the order. For transaction calls (like GetItemTransactions), please use the TransactionPlatform element to determine whether an item was purchased on Express on eBay. Also applicable to Half.com (for GetOrders). Applicable values: • Active (in/out) The cart is active. Items can only be added, deleted, or updated in the cart when status is Active. • Authenticated (out) The cart was authenticated. • Cancelled (out) The cart was cancelled. • Completed (in/out) The order is completed. • CustomCode (out) Reserved for internal or future use. • Default (out) Default status. • Inactive (out) The cart is invalid; it does not exist. An example is a cart that has expired. • InProcess (out) After placing the order and before completion of checkout, the card is "in process." • Invalid (out) Invalid. • Shipped (in/out) The order was shipped. Half.com users can specify this in the GetOrders input. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order.PaidTime	dateTime	Conditionally	Date and time the order was paid. This time is specified in GMT (not Pacific time). See "Time Values" in the eBay Web Services guide for information about converting between GMT and other time zones. Also applicable to Half.com (for GetOrders). DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order .PaymentMethods	BuyerPaymentMethodCodeType (repeatable)	Always	The payment methods the buyer uses to pay for the order. An order can have multiple payment methods if the buyer combines several transactions into one order. Also applicable to Half.com (for GetOrders). Applicable values: See PaymentMethods. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order.ShippedTime	dateTime	Conditionally	Date and time the order was shipped. This time is specified in GMT (not Pacific time). See "Time Values" in the eBay Web Services guide for information about converting between GMT and other time zones. Also applicable to Half.com (for GetOrders). DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order .ShippingAddress	AddressType	Always	Shipping address the order has been or will be sent to. Also applicable to Half.com (for GetOrders). DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order .ShippingAddress.AddressID	string	Conditionally	ID assigned to the address in the eBay database. For GetOrders, applies only to Half.com. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
OrderArray.Order .ShippingAddress.AddressOwner	AddressOwnerCodeType	Conditionally	The realm to which the address belongs (e.g. eBay vs PayPal). For GetOrders, applies only to Half.com. Applicable values: • CustomCode (out) Reserved for internal or future use. • eBay (out) eBay owns the address. • PayPal (out) PayPal owns the address. DetailLe

eBay Trading API Call Reference Version 577

eBay Trading API
Call Reference Version 577